feat: implement media echo fix and YouTube screenshare design
- Introduced a new `ScreenShareController` to manage YouTube screenshare functionality. - Updated `DiscordPlayer` to track ownership of audio streams, preventing conflicts between music playback and screenshare. - Added error handling for various states including voice connection checks and media busy states. - Created unit tests for `ScreenShareController` and `DiscordPlayer` ownership rules to ensure correct functionality. - Added documentation for the new media echo fix and screenshare design.
This commit is contained in:
94
tests/media/screenShareController.test.ts
Normal file
94
tests/media/screenShareController.test.ts
Normal file
@@ -0,0 +1,94 @@
|
||||
import { PassThrough } from "node:stream";
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
import { AppError } from "../../src/errors";
|
||||
import type { DiscordPlayerOwner } from "../../src/media/mediaTypes";
|
||||
import { createScreenShareController } from "../../src/media/screenShareController";
|
||||
|
||||
function createDependencies() {
|
||||
const output = new PassThrough();
|
||||
return {
|
||||
getVoiceStatus: vi.fn(() => ({
|
||||
connected: true,
|
||||
activeGuildId: "guild-1" as string | null,
|
||||
activeChannelId: "channel-1" as string | null,
|
||||
})),
|
||||
getPlayerOwner: vi.fn((): DiscordPlayerOwner => "none"),
|
||||
getDirectVideoUrl: vi.fn(async () => "https://cdn.example.com/video.mp4"),
|
||||
prepareStream: vi.fn(() => ({
|
||||
command: { kill: vi.fn() },
|
||||
output,
|
||||
})),
|
||||
playStream: vi.fn(() => new Promise<void>(() => {})),
|
||||
streamer: { id: "streamer" },
|
||||
};
|
||||
}
|
||||
|
||||
describe("createScreenShareController", () => {
|
||||
it("starts a YouTube Go Live stream", async () => {
|
||||
const dependencies = createDependencies();
|
||||
const controller = createScreenShareController(dependencies);
|
||||
|
||||
const playback = await controller.start("https://youtu.be/video");
|
||||
|
||||
expect(dependencies.getDirectVideoUrl).toHaveBeenCalledWith(
|
||||
"https://youtu.be/video",
|
||||
);
|
||||
expect(dependencies.prepareStream).toHaveBeenCalledWith(
|
||||
"https://cdn.example.com/video.mp4",
|
||||
expect.objectContaining({ includeAudio: true }),
|
||||
);
|
||||
expect(dependencies.playStream).toHaveBeenCalledWith(
|
||||
dependencies.prepareStream.mock.results[0].value.output,
|
||||
dependencies.streamer,
|
||||
{ type: "go-live" },
|
||||
);
|
||||
expect(controller.isActive()).toBe(true);
|
||||
playback.stop();
|
||||
expect(controller.isActive()).toBe(false);
|
||||
});
|
||||
|
||||
it("rejects when voice is not connected", async () => {
|
||||
const dependencies = createDependencies();
|
||||
dependencies.getVoiceStatus.mockReturnValue({
|
||||
connected: false,
|
||||
activeGuildId: null,
|
||||
activeChannelId: null,
|
||||
});
|
||||
const controller = createScreenShareController(dependencies);
|
||||
|
||||
await expect(
|
||||
controller.start("https://youtu.be/video"),
|
||||
).rejects.toMatchObject({
|
||||
code: "VOICE_NOT_CONNECTED",
|
||||
statusCode: 409,
|
||||
} satisfies Partial<AppError>);
|
||||
});
|
||||
|
||||
it("rejects when music owns the shared player", async () => {
|
||||
const dependencies = createDependencies();
|
||||
dependencies.getPlayerOwner.mockReturnValue("music");
|
||||
const controller = createScreenShareController(dependencies);
|
||||
|
||||
await expect(
|
||||
controller.start("https://youtu.be/video"),
|
||||
).rejects.toMatchObject({
|
||||
code: "MEDIA_BUSY",
|
||||
statusCode: 409,
|
||||
} satisfies Partial<AppError>);
|
||||
});
|
||||
|
||||
it("wraps stream startup failures", async () => {
|
||||
const dependencies = createDependencies();
|
||||
dependencies.playStream.mockImplementation(() => {
|
||||
throw new Error("go live failed");
|
||||
});
|
||||
const controller = createScreenShareController(dependencies);
|
||||
|
||||
await expect(
|
||||
controller.start("https://youtu.be/video"),
|
||||
).rejects.toMatchObject({
|
||||
code: "SCREEN_STREAM_FAILED",
|
||||
statusCode: 500,
|
||||
} satisfies Partial<AppError>);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user