File size: 7,640 Bytes
87dab07 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | // Tests pairing challenge creation, validation, and reply formatting.
import { afterEach, describe, expect, it, vi } from "vitest";
import {
initializeGlobalHookRunner,
resetGlobalHookRunner,
} from "../plugins/hook-runner-global.js";
import { createMockPluginRegistry } from "../plugins/hooks.test-fixtures.js";
import { issuePairingChallenge } from "./pairing-challenge.js";
describe("issuePairingChallenge", () => {
afterEach(() => {
resetGlobalHookRunner();
});
function createBaseChallengeParams() {
return {
channel: "forum",
senderId: "123",
senderIdLine: "Your forum user id: 123",
} as const;
}
async function issueChallengeAndCaptureReply(
params: Omit<Parameters<typeof issuePairingChallenge>[0], "sendPairingReply">,
) {
const sent: string[] = [];
const result = await issuePairingChallenge({
...params,
sendPairingReply: async (text) => {
sent.push(text);
},
});
return { result, sent };
}
function expectReplyTexts(sent: string[], expectedTexts: readonly string[]) {
expect(sent).toEqual([...expectedTexts]);
}
function expectReplyContaining(sent: string[], expectedText: string) {
expect(sent).toHaveLength(1);
expect(sent[0]).toContain(expectedText);
}
async function expectIssuedChallengeCase(params: {
issueParams: Omit<Parameters<typeof issuePairingChallenge>[0], "sendPairingReply">;
expectedResult: Awaited<ReturnType<typeof issuePairingChallenge>>;
assertReply?: (sent: string[]) => void;
sendPairingReply?: Parameters<typeof issuePairingChallenge>[0]["sendPairingReply"];
assertResult?: () => void;
}) {
if (params.sendPairingReply) {
const result = await issuePairingChallenge({
...params.issueParams,
sendPairingReply: params.sendPairingReply,
});
expect(result).toEqual(params.expectedResult);
params.assertResult?.();
return;
}
const { result, sent } = await issueChallengeAndCaptureReply(params.issueParams);
expect(result).toEqual(params.expectedResult);
params.assertReply?.(sent);
params.assertResult?.();
}
it.each([
{
name: "creates and sends a pairing reply when request is newly created",
issueParams: {
...createBaseChallengeParams(),
upsertPairingRequest: async () => ({ code: "ABCD", created: true }),
},
expectedResult: { created: true, code: "ABCD" },
assertReply: (sent: string[]) => {
expectReplyContaining(sent, "ABCD");
},
},
{
name: "supports custom reply text builder",
issueParams: {
channel: "line",
senderId: "u1",
senderIdLine: "Your line id: u1",
upsertPairingRequest: async () => ({ code: "ZXCV", created: true }),
buildReplyText: ({ code }: { code: string }) => `custom ${code}`,
},
expectedResult: { created: true, code: "ZXCV" },
assertReply: (sent: string[]) => {
expectReplyTexts(sent, ["custom ZXCV"]);
},
},
] as const)("$name", async ({ issueParams, expectedResult, assertReply }) => {
await expectIssuedChallengeCase({
issueParams,
expectedResult,
assertReply,
});
});
it.each([
{
name: "does not send a reply when request already exists",
setup: () => {
const sendPairingReply = vi.fn(async () => {});
return {
issueParams: {
...createBaseChallengeParams(),
upsertPairingRequest: async () => ({ code: "ABCD", created: false }),
},
sendPairingReply,
expectedResult: { created: false },
assertResult: () => {
expect(sendPairingReply).not.toHaveBeenCalled();
},
};
},
},
{
name: "calls onCreated and forwards meta to upsert",
setup: () => {
const onCreated = vi.fn();
const upsert = vi.fn(async () => ({ code: "1111", created: true }));
return {
issueParams: {
channel: "guildchat",
senderId: "42",
senderIdLine: "Your guildchat user id: 42",
meta: { name: "alice" },
upsertPairingRequest: upsert,
onCreated,
},
sendPairingReply: async () => {},
expectedResult: { created: true, code: "1111" },
assertResult: () => {
expect(upsert).toHaveBeenCalledWith({ id: "42", meta: { name: "alice" } });
expect(onCreated).toHaveBeenCalledWith({ code: "1111" });
},
};
},
},
{
name: "captures reply errors through onReplyError",
setup: () => {
const onReplyError = vi.fn();
return {
issueParams: {
channel: "quietchat",
senderId: "+1555",
senderIdLine: "Your quietchat sender id: +1555",
upsertPairingRequest: async () => ({ code: "9999", created: true }),
onReplyError,
},
sendPairingReply: async () => {
throw new Error("send failed");
},
expectedResult: { created: true, code: "9999" },
assertResult: () => {
expect(onReplyError).toHaveBeenCalledTimes(1);
},
};
},
},
] as const)("$name", async ({ setup }) => {
await expectIssuedChallengeCase(setup());
});
it("fires channel_pairing_requested only for newly created requests", async () => {
const handler = vi.fn(async () => {});
initializeGlobalHookRunner(
createMockPluginRegistry([
{
hookName: "channel_pairing_requested",
handler,
},
]),
);
await issuePairingChallenge({
...createBaseChallengeParams(),
accountId: "alerts",
meta: { username: "alice" },
upsertPairingRequest: async () => ({ code: "HOOK1234", created: true }),
sendPairingReply: async () => {},
});
await issuePairingChallenge({
...createBaseChallengeParams(),
accountId: "alerts",
upsertPairingRequest: async () => ({ code: "EXISTS12", created: false }),
sendPairingReply: async () => {},
});
expect(handler).toHaveBeenCalledTimes(1);
expect(handler).toHaveBeenCalledWith(
{
channel: "forum",
accountId: "alerts",
senderId: "123",
code: "HOOK1234",
metadata: { username: "alice" },
},
{
channelId: "forum",
accountId: "alerts",
senderId: "123",
},
);
});
it("does not block pairing replies when pairing-request hooks fail or stall", async () => {
const throwingHook = vi.fn(() => {
throw new Error("notification failed");
});
const stallingHook = vi.fn(() => new Promise<void>(() => {}));
initializeGlobalHookRunner(
createMockPluginRegistry([
{
hookName: "channel_pairing_requested",
handler: throwingHook,
pluginId: "throwing",
},
{
hookName: "channel_pairing_requested",
handler: stallingHook,
pluginId: "stalling",
},
]),
);
const sendPairingReply = vi.fn(async () => {});
const result = await issuePairingChallenge({
...createBaseChallengeParams(),
upsertPairingRequest: async () => ({ code: "FAST1234", created: true }),
sendPairingReply,
});
expect(result).toEqual({ created: true, code: "FAST1234" });
expect(throwingHook).toHaveBeenCalledTimes(1);
expect(stallingHook).toHaveBeenCalledTimes(1);
expect(sendPairingReply).toHaveBeenCalledTimes(1);
});
});
|