File size: 14,870 Bytes
fc93158 | 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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | import { describe, expect, it, vi } from "vitest";
import {
createDiscordMessageHandler,
preflightDiscordMessageMock,
processDiscordMessageMock,
} from "./message-handler.module-test-helpers.js";
import {
createDiscordHandlerParams,
createDiscordPreflightContext,
} from "./message-handler.test-helpers.js";
const eventualReplyDeliveredMock = vi.hoisted(() => vi.fn());
type SetStatusFn = (patch: Record<string, unknown>) => void;
function createDeferred<T = void>() {
let resolve: (value: T | PromiseLike<T>) => void = () => {};
const promise = new Promise<T>((innerResolve) => {
resolve = innerResolve;
});
return { promise, resolve };
}
function createMessageData(messageId: string, channelId = "ch-1") {
return {
channel_id: channelId,
author: { id: "user-1" },
message: {
id: messageId,
author: { id: "user-1", bot: false },
content: "hello",
channel_id: channelId,
attachments: [{ id: `att-${messageId}` }],
},
};
}
function createPreflightContext(channelId = "ch-1") {
return createDiscordPreflightContext(channelId);
}
function createHandlerWithDefaultPreflight(overrides?: {
setStatus?: SetStatusFn;
workerRunTimeoutMs?: number;
}) {
preflightDiscordMessageMock.mockImplementation(async (params: { data: { channel_id: string } }) =>
createPreflightContext(params.data.channel_id),
);
return createDiscordMessageHandler(createDiscordHandlerParams(overrides));
}
async function createLifecycleStopScenario(params: {
createHandler: (status: SetStatusFn) => {
handler: (data: never, opts: never) => Promise<void>;
stop: () => void;
};
}) {
preflightDiscordMessageMock.mockImplementation(
async (preflightParams: { data: { channel_id: string } }) =>
createPreflightContext(preflightParams.data.channel_id),
);
const runInFlight = createDeferred();
processDiscordMessageMock.mockImplementation(async () => {
await runInFlight.promise;
});
const setStatus = vi.fn<SetStatusFn>();
const { handler, stop } = params.createHandler(setStatus);
await expect(handler(createMessageData("m-1") as never, {} as never)).resolves.toBeUndefined();
await vi.waitFor(() => {
expect(processDiscordMessageMock).toHaveBeenCalledTimes(1);
});
const callsBeforeStop = setStatus.mock.calls.length;
stop();
return {
setStatus,
callsBeforeStop,
finish: async () => {
runInFlight.resolve();
await runInFlight.promise;
await Promise.resolve();
},
};
}
describe("createDiscordMessageHandler queue behavior", () => {
it("resets busy counters when the handler is created", () => {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
const setStatus = vi.fn();
createDiscordMessageHandler(createDiscordHandlerParams({ setStatus }));
expect(setStatus).toHaveBeenCalledWith(
expect.objectContaining({
activeRuns: 0,
busy: false,
}),
);
});
it("returns immediately and tracks busy status while queued runs execute", async () => {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
const firstRun = createDeferred();
const secondRun = createDeferred();
processDiscordMessageMock
.mockImplementationOnce(async () => {
await firstRun.promise;
})
.mockImplementationOnce(async () => {
await secondRun.promise;
});
const setStatus = vi.fn();
const handler = createHandlerWithDefaultPreflight({ setStatus });
await expect(handler(createMessageData("m-1") as never, {} as never)).resolves.toBeUndefined();
await vi.waitFor(() => {
expect(processDiscordMessageMock).toHaveBeenCalledTimes(1);
});
expect(setStatus).toHaveBeenCalledWith(
expect.objectContaining({
activeRuns: 1,
busy: true,
}),
);
await expect(handler(createMessageData("m-2") as never, {} as never)).resolves.toBeUndefined();
await vi.waitFor(() => {
expect(preflightDiscordMessageMock).toHaveBeenCalledTimes(2);
});
expect(processDiscordMessageMock).toHaveBeenCalledTimes(1);
firstRun.resolve();
await firstRun.promise;
await vi.waitFor(() => {
expect(processDiscordMessageMock).toHaveBeenCalledTimes(2);
});
secondRun.resolve();
await secondRun.promise;
await vi.waitFor(() => {
expect(setStatus).toHaveBeenLastCalledWith(
expect.objectContaining({
activeRuns: 0,
busy: false,
}),
);
});
});
it("applies explicit inbound worker timeout to queued runs so stalled runs do not block the queue", async () => {
vi.useFakeTimers();
try {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
processDiscordMessageMock
.mockImplementationOnce(async (ctx: { abortSignal?: AbortSignal }) => {
await new Promise<void>((resolve) => {
if (ctx.abortSignal?.aborted) {
resolve();
return;
}
ctx.abortSignal?.addEventListener("abort", () => resolve(), { once: true });
});
})
.mockImplementationOnce(async () => undefined);
const params = createDiscordHandlerParams({ workerRunTimeoutMs: 50 });
preflightDiscordMessageMock.mockImplementation(
async (preflightParams: { data: { channel_id: string } }) =>
createPreflightContext(preflightParams.data.channel_id),
);
const handler = createDiscordMessageHandler(params);
await expect(
handler(createMessageData("m-1") as never, {} as never),
).resolves.toBeUndefined();
await expect(
handler(createMessageData("m-2") as never, {} as never),
).resolves.toBeUndefined();
await vi.advanceTimersByTimeAsync(60);
await vi.waitFor(() => {
expect(processDiscordMessageMock).toHaveBeenCalledTimes(2);
});
const firstCtx = processDiscordMessageMock.mock.calls[0]?.[0] as
| { abortSignal?: AbortSignal }
| undefined;
expect(firstCtx?.abortSignal?.aborted).toBe(true);
expect(params.runtime.error).toHaveBeenCalledWith(
expect.stringContaining("discord inbound worker timed out after"),
);
} finally {
vi.useRealTimers();
}
});
it("does not time out queued runs when the inbound worker timeout is disabled", async () => {
vi.useFakeTimers();
try {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
eventualReplyDeliveredMock.mockReset();
processDiscordMessageMock.mockImplementationOnce(
async (ctx: { abortSignal?: AbortSignal }) => {
await new Promise<void>((resolve) => {
setTimeout(() => {
if (!ctx.abortSignal?.aborted) {
eventualReplyDeliveredMock();
}
resolve();
}, 80);
});
},
);
const params = createDiscordHandlerParams({ workerRunTimeoutMs: 0 });
const handler = createHandlerWithDefaultPreflight({ workerRunTimeoutMs: 0 });
await expect(
handler(createMessageData("m-1") as never, {} as never),
).resolves.toBeUndefined();
await vi.advanceTimersByTimeAsync(80);
await Promise.resolve();
expect(eventualReplyDeliveredMock).toHaveBeenCalledTimes(1);
expect(params.runtime.error).not.toHaveBeenCalledWith(
expect.stringContaining("discord inbound worker timed out after"),
);
} finally {
vi.useRealTimers();
}
});
it("refreshes run activity while active runs are in progress", async () => {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
const runInFlight = createDeferred();
processDiscordMessageMock.mockImplementation(async () => {
await runInFlight.promise;
});
preflightDiscordMessageMock.mockImplementation(
async (params: { data: { channel_id: string } }) =>
createPreflightContext(params.data.channel_id),
);
let heartbeatTick: () => void = () => {};
let capturedHeartbeat = false;
const setIntervalSpy = vi
.spyOn(globalThis, "setInterval")
.mockImplementation((callback: TimerHandler) => {
if (typeof callback === "function") {
heartbeatTick = () => {
callback();
};
capturedHeartbeat = true;
}
return 1 as unknown as ReturnType<typeof setInterval>;
});
const clearIntervalSpy = vi.spyOn(globalThis, "clearInterval");
try {
const setStatus = vi.fn();
const handler = createDiscordMessageHandler(createDiscordHandlerParams({ setStatus }));
await expect(
handler(createMessageData("m-1") as never, {} as never),
).resolves.toBeUndefined();
await vi.waitFor(() => {
expect(processDiscordMessageMock).toHaveBeenCalledTimes(1);
});
expect(capturedHeartbeat).toBe(true);
const busyCallsBefore = setStatus.mock.calls.filter(
([patch]) => (patch as { busy?: boolean }).busy === true,
).length;
heartbeatTick();
const busyCallsAfter = setStatus.mock.calls.filter(
([patch]) => (patch as { busy?: boolean }).busy === true,
).length;
expect(busyCallsAfter).toBeGreaterThan(busyCallsBefore);
runInFlight.resolve();
await runInFlight.promise;
await vi.waitFor(() => {
expect(clearIntervalSpy).toHaveBeenCalled();
});
} finally {
setIntervalSpy.mockRestore();
clearIntervalSpy.mockRestore();
}
});
it("stops status publishing after lifecycle abort", async () => {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
const { setStatus, callsBeforeStop, finish } = await createLifecycleStopScenario({
createHandler: (status) => {
const abortController = new AbortController();
const handler = createDiscordMessageHandler(
createDiscordHandlerParams({ setStatus: status, abortSignal: abortController.signal }),
);
return { handler, stop: () => abortController.abort() };
},
});
await finish();
expect(setStatus.mock.calls.length).toBe(callsBeforeStop);
});
it("stops status publishing after handler deactivation", async () => {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
const { setStatus, callsBeforeStop, finish } = await createLifecycleStopScenario({
createHandler: (status) => {
const handler = createDiscordMessageHandler(
createDiscordHandlerParams({ setStatus: status }),
);
return { handler, stop: () => handler.deactivate() };
},
});
await finish();
expect(setStatus.mock.calls.length).toBe(callsBeforeStop);
});
it("skips queued runs that have not started yet after deactivation", async () => {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
const firstRun = createDeferred();
processDiscordMessageMock
.mockImplementationOnce(async () => {
await firstRun.promise;
})
.mockImplementationOnce(async () => undefined);
preflightDiscordMessageMock.mockImplementation(
async (params: { data: { channel_id: string } }) =>
createPreflightContext(params.data.channel_id),
);
const handler = createDiscordMessageHandler(createDiscordHandlerParams());
await expect(handler(createMessageData("m-1") as never, {} as never)).resolves.toBeUndefined();
await vi.waitFor(() => {
expect(processDiscordMessageMock).toHaveBeenCalledTimes(1);
});
await expect(handler(createMessageData("m-2") as never, {} as never)).resolves.toBeUndefined();
handler.deactivate();
firstRun.resolve();
await firstRun.promise;
await Promise.resolve();
expect(processDiscordMessageMock).toHaveBeenCalledTimes(1);
});
it("preserves non-debounced message ordering by awaiting debouncer enqueue", async () => {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
const firstPreflight = createDeferred();
const processedMessageIds: string[] = [];
preflightDiscordMessageMock.mockImplementation(
async (params: { data: { channel_id: string; message?: { id?: string } } }) => {
const messageId = params.data.message?.id ?? "unknown";
if (messageId === "m-1") {
await firstPreflight.promise;
}
return {
...createPreflightContext(params.data.channel_id),
messageId,
};
},
);
processDiscordMessageMock.mockImplementation(async (ctx: { messageId?: string }) => {
processedMessageIds.push(ctx.messageId ?? "unknown");
});
const handler = createDiscordMessageHandler(createDiscordHandlerParams());
const sequentialDispatch = (async () => {
await handler(createMessageData("m-1") as never, {} as never);
await handler(createMessageData("m-2") as never, {} as never);
})();
await vi.waitFor(() => {
expect(preflightDiscordMessageMock).toHaveBeenCalledTimes(1);
});
await Promise.resolve();
expect(preflightDiscordMessageMock).toHaveBeenCalledTimes(1);
firstPreflight.resolve();
await sequentialDispatch;
await vi.waitFor(() => {
expect(processDiscordMessageMock).toHaveBeenCalledTimes(2);
});
expect(processedMessageIds).toEqual(["m-1", "m-2"]);
});
it("recovers queue progress after a run failure without leaving busy state stuck", async () => {
preflightDiscordMessageMock.mockReset();
processDiscordMessageMock.mockReset();
const firstRun = createDeferred();
processDiscordMessageMock
.mockImplementationOnce(async () => {
await firstRun.promise;
throw new Error("simulated run failure");
})
.mockImplementationOnce(async () => undefined);
preflightDiscordMessageMock.mockImplementation(
async (params: { data: { channel_id: string } }) =>
createPreflightContext(params.data.channel_id),
);
const setStatus = vi.fn();
const handler = createHandlerWithDefaultPreflight({ setStatus });
await expect(handler(createMessageData("m-1") as never, {} as never)).resolves.toBeUndefined();
await expect(handler(createMessageData("m-2") as never, {} as never)).resolves.toBeUndefined();
firstRun.resolve();
await firstRun.promise.catch(() => undefined);
await vi.waitFor(() => {
expect(processDiscordMessageMock).toHaveBeenCalledTimes(2);
});
await vi.waitFor(() => {
expect(setStatus).toHaveBeenCalledWith(
expect.objectContaining({ activeRuns: 0, busy: false }),
);
});
});
});
|