mirror of
https://github.com/openclaw/openclaw.git
synced 2026-03-12 07:20:45 +00:00
Reimplements and consolidates related work: - #24339 stale disconnect/destroyed session guards - #25312 voice listener cleanup on stop - #23036 restore @snazzah/davey runtime dependency Adds Discord voice DAVE config passthrough, repeated decrypt failure rejoin recovery, regression tests, docs, and changelog updates. Co-authored-by: Frank Yang <frank.ekn@gmail.com> Co-authored-by: Do Cao Hieu <admin@docaohieu.com>
269 lines
8.1 KiB
TypeScript
269 lines
8.1 KiB
TypeScript
import { ChannelType } from "@buape/carbon";
|
|
import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const {
|
|
createConnectionMock,
|
|
joinVoiceChannelMock,
|
|
entersStateMock,
|
|
createAudioPlayerMock,
|
|
resolveAgentRouteMock,
|
|
} = vi.hoisted(() => {
|
|
type EventHandler = (...args: unknown[]) => unknown;
|
|
type MockConnection = {
|
|
destroy: ReturnType<typeof vi.fn>;
|
|
subscribe: ReturnType<typeof vi.fn>;
|
|
on: ReturnType<typeof vi.fn>;
|
|
off: ReturnType<typeof vi.fn>;
|
|
receiver: {
|
|
speaking: {
|
|
on: ReturnType<typeof vi.fn>;
|
|
off: ReturnType<typeof vi.fn>;
|
|
};
|
|
subscribe: ReturnType<typeof vi.fn>;
|
|
};
|
|
handlers: Map<string, EventHandler>;
|
|
};
|
|
|
|
const createConnectionMock = (): MockConnection => {
|
|
const handlers = new Map<string, EventHandler>();
|
|
const connection: MockConnection = {
|
|
destroy: vi.fn(),
|
|
subscribe: vi.fn(),
|
|
on: vi.fn((event: string, handler: EventHandler) => {
|
|
handlers.set(event, handler);
|
|
}),
|
|
off: vi.fn(),
|
|
receiver: {
|
|
speaking: {
|
|
on: vi.fn(),
|
|
off: vi.fn(),
|
|
},
|
|
subscribe: vi.fn(() => ({
|
|
on: vi.fn(),
|
|
[Symbol.asyncIterator]: async function* () {},
|
|
})),
|
|
},
|
|
handlers,
|
|
};
|
|
return connection;
|
|
};
|
|
|
|
return {
|
|
createConnectionMock,
|
|
joinVoiceChannelMock: vi.fn(() => createConnectionMock()),
|
|
entersStateMock: vi.fn(async (_target?: unknown, _state?: string, _timeoutMs?: number) => {
|
|
return undefined;
|
|
}),
|
|
createAudioPlayerMock: vi.fn(() => ({
|
|
on: vi.fn(),
|
|
off: vi.fn(),
|
|
stop: vi.fn(),
|
|
play: vi.fn(),
|
|
state: { status: "idle" },
|
|
})),
|
|
resolveAgentRouteMock: vi.fn(() => ({ agentId: "agent-1", sessionKey: "discord:g1:c1" })),
|
|
};
|
|
});
|
|
|
|
vi.mock("@discordjs/voice", () => ({
|
|
AudioPlayerStatus: { Playing: "playing", Idle: "idle" },
|
|
EndBehaviorType: { AfterSilence: "AfterSilence" },
|
|
VoiceConnectionStatus: {
|
|
Ready: "ready",
|
|
Disconnected: "disconnected",
|
|
Destroyed: "destroyed",
|
|
Signalling: "signalling",
|
|
Connecting: "connecting",
|
|
},
|
|
createAudioPlayer: createAudioPlayerMock,
|
|
createAudioResource: vi.fn(),
|
|
entersState: entersStateMock,
|
|
joinVoiceChannel: joinVoiceChannelMock,
|
|
}));
|
|
|
|
vi.mock("../../routing/resolve-route.js", () => ({
|
|
resolveAgentRoute: resolveAgentRouteMock,
|
|
}));
|
|
|
|
let managerModule: typeof import("./manager.js");
|
|
|
|
function createClient() {
|
|
return {
|
|
fetchChannel: vi.fn(async (channelId: string) => ({
|
|
id: channelId,
|
|
guildId: "g1",
|
|
type: ChannelType.GuildVoice,
|
|
})),
|
|
getPlugin: vi.fn(() => ({
|
|
getGatewayAdapterCreator: vi.fn(() => vi.fn()),
|
|
})),
|
|
fetchMember: vi.fn(),
|
|
fetchUser: vi.fn(),
|
|
};
|
|
}
|
|
|
|
function createRuntime() {
|
|
return {
|
|
log: vi.fn(),
|
|
error: vi.fn(),
|
|
exit: vi.fn(),
|
|
};
|
|
}
|
|
|
|
describe("DiscordVoiceManager", () => {
|
|
beforeAll(async () => {
|
|
managerModule = await import("./manager.js");
|
|
});
|
|
|
|
beforeEach(() => {
|
|
joinVoiceChannelMock.mockReset();
|
|
joinVoiceChannelMock.mockImplementation(() => createConnectionMock());
|
|
entersStateMock.mockReset();
|
|
entersStateMock.mockResolvedValue(undefined);
|
|
createAudioPlayerMock.mockClear();
|
|
resolveAgentRouteMock.mockClear();
|
|
});
|
|
|
|
it("keeps the new session when an old disconnected handler fires", async () => {
|
|
const oldConnection = createConnectionMock();
|
|
const newConnection = createConnectionMock();
|
|
joinVoiceChannelMock.mockReturnValueOnce(oldConnection).mockReturnValueOnce(newConnection);
|
|
entersStateMock.mockImplementation(async (target: unknown, status?: string) => {
|
|
if (target === oldConnection && (status === "signalling" || status === "connecting")) {
|
|
throw new Error("old disconnected");
|
|
}
|
|
return undefined;
|
|
});
|
|
|
|
const manager = new managerModule.DiscordVoiceManager({
|
|
client: createClient() as never,
|
|
cfg: {},
|
|
discordConfig: {},
|
|
accountId: "default",
|
|
runtime: createRuntime(),
|
|
});
|
|
|
|
await manager.join({ guildId: "g1", channelId: "c1" });
|
|
await manager.join({ guildId: "g1", channelId: "c2" });
|
|
|
|
const oldDisconnected = oldConnection.handlers.get("disconnected");
|
|
expect(oldDisconnected).toBeTypeOf("function");
|
|
await oldDisconnected?.();
|
|
|
|
expect(manager.status()).toEqual([
|
|
{
|
|
ok: true,
|
|
message: "connected: guild g1 channel c2",
|
|
guildId: "g1",
|
|
channelId: "c2",
|
|
},
|
|
]);
|
|
});
|
|
|
|
it("keeps the new session when an old destroyed handler fires", async () => {
|
|
const oldConnection = createConnectionMock();
|
|
const newConnection = createConnectionMock();
|
|
joinVoiceChannelMock.mockReturnValueOnce(oldConnection).mockReturnValueOnce(newConnection);
|
|
|
|
const manager = new managerModule.DiscordVoiceManager({
|
|
client: createClient() as never,
|
|
cfg: {},
|
|
discordConfig: {},
|
|
accountId: "default",
|
|
runtime: createRuntime(),
|
|
});
|
|
|
|
await manager.join({ guildId: "g1", channelId: "c1" });
|
|
await manager.join({ guildId: "g1", channelId: "c2" });
|
|
|
|
const oldDestroyed = oldConnection.handlers.get("destroyed");
|
|
expect(oldDestroyed).toBeTypeOf("function");
|
|
oldDestroyed?.();
|
|
|
|
expect(manager.status()).toEqual([
|
|
{
|
|
ok: true,
|
|
message: "connected: guild g1 channel c2",
|
|
guildId: "g1",
|
|
channelId: "c2",
|
|
},
|
|
]);
|
|
});
|
|
|
|
it("removes voice listeners on leave", async () => {
|
|
const connection = createConnectionMock();
|
|
joinVoiceChannelMock.mockReturnValueOnce(connection);
|
|
const manager = new managerModule.DiscordVoiceManager({
|
|
client: createClient() as never,
|
|
cfg: {},
|
|
discordConfig: {},
|
|
accountId: "default",
|
|
runtime: createRuntime(),
|
|
});
|
|
|
|
await manager.join({ guildId: "g1", channelId: "c1" });
|
|
await manager.leave({ guildId: "g1" });
|
|
|
|
const player = createAudioPlayerMock.mock.results[0]?.value;
|
|
expect(connection.receiver.speaking.off).toHaveBeenCalledWith("start", expect.any(Function));
|
|
expect(connection.off).toHaveBeenCalledWith("disconnected", expect.any(Function));
|
|
expect(connection.off).toHaveBeenCalledWith("destroyed", expect.any(Function));
|
|
expect(player.off).toHaveBeenCalledWith("error", expect.any(Function));
|
|
});
|
|
|
|
it("passes DAVE options to joinVoiceChannel", async () => {
|
|
const manager = new managerModule.DiscordVoiceManager({
|
|
client: createClient() as never,
|
|
cfg: {},
|
|
discordConfig: {
|
|
voice: {
|
|
daveEncryption: false,
|
|
decryptionFailureTolerance: 8,
|
|
},
|
|
},
|
|
accountId: "default",
|
|
runtime: createRuntime(),
|
|
});
|
|
|
|
await manager.join({ guildId: "g1", channelId: "c1" });
|
|
|
|
expect(joinVoiceChannelMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
daveEncryption: false,
|
|
decryptionFailureTolerance: 8,
|
|
}),
|
|
);
|
|
});
|
|
|
|
it("attempts rejoin after repeated decrypt failures", async () => {
|
|
const manager = new managerModule.DiscordVoiceManager({
|
|
client: createClient() as never,
|
|
cfg: {},
|
|
discordConfig: {},
|
|
accountId: "default",
|
|
runtime: createRuntime(),
|
|
});
|
|
|
|
await manager.join({ guildId: "g1", channelId: "c1" });
|
|
|
|
const entry = (manager as { sessions: Map<string, unknown> }).sessions.get("g1");
|
|
expect(entry).toBeDefined();
|
|
(manager as { handleReceiveError: (e: unknown, err: unknown) => void }).handleReceiveError(
|
|
entry,
|
|
new Error("Failed to decrypt: DecryptionFailed(UnencryptedWhenPassthroughDisabled)"),
|
|
);
|
|
(manager as { handleReceiveError: (e: unknown, err: unknown) => void }).handleReceiveError(
|
|
entry,
|
|
new Error("Failed to decrypt: DecryptionFailed(UnencryptedWhenPassthroughDisabled)"),
|
|
);
|
|
(manager as { handleReceiveError: (e: unknown, err: unknown) => void }).handleReceiveError(
|
|
entry,
|
|
new Error("Failed to decrypt: DecryptionFailed(UnencryptedWhenPassthroughDisabled)"),
|
|
);
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
|
|
expect(joinVoiceChannelMock).toHaveBeenCalledTimes(2);
|
|
});
|
|
});
|