File size: 22,432 Bytes
5cb63c1 | 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 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 | // Message lifecycle tests cover channel message state transitions and notifications.
import { describe, expect, it, vi } from "vitest";
import {
createLiveMessageState,
defineFinalizableLivePreviewAdapter,
deliverFinalizableLivePreview,
deliverWithFinalizableLivePreviewAdapter,
markLiveMessagePreviewUpdated,
} from "./live.js";
import { createMessageReceiveContext } from "./receive.js";
type LivePreviewMediaPayload = { text?: string; mediaUrl: string };
type LivePreviewMediaEdit = { text?: string };
function requireMockCall(
mock: { mock: { calls: unknown[][] } },
callIndex: number,
label: string,
): unknown[] {
const resolvedIndex = callIndex < 0 ? mock.mock.calls.length + callIndex : callIndex;
const call = mock.mock.calls[resolvedIndex];
if (!call) {
throw new Error(`expected ${label} call ${callIndex}`);
}
return call;
}
describe("message lifecycle primitives", () => {
it("tracks live preview rendered batch updates", () => {
const preview = createLiveMessageState();
const rendered = {
payloads: [{ text: "draft" }],
plan: {
payloadCount: 1,
textCount: 1,
mediaCount: 0,
voiceCount: 0,
presentationCount: 0,
interactiveCount: 0,
channelDataCount: 0,
items: [{ index: 0, kinds: ["text"] as const, text: "draft", mediaUrls: [] }],
},
};
const updated = markLiveMessagePreviewUpdated(preview, rendered);
expect(updated.phase).toBe("previewing");
expect(updated.lastRendered).toBe(rendered);
});
it("finalizes live previews in place with preview receipts", async () => {
const editFinal = vi.fn(async () => undefined);
const deliverNormally = vi.fn(async () => undefined);
const onPreviewFinalized = vi.fn(async () => undefined);
const result = await deliverFinalizableLivePreview({
kind: "final",
payload: { text: "done" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-1",
seal: vi.fn(async () => undefined),
clear: vi.fn(async () => undefined),
},
buildFinalEdit: (payload) => ({ text: payload.text }),
editFinal,
deliverNormally,
onPreviewFinalized,
});
expect(result.kind).toBe("preview-finalized");
expect(editFinal).toHaveBeenCalledWith("preview-1", { text: "done" });
expect(deliverNormally).not.toHaveBeenCalled();
const liveState = result.liveState;
if (!liveState) {
throw new Error("expected finalized live state");
}
expect(liveState.phase).toBe("finalized");
expect(liveState.canFinalizeInPlace).toBe(false);
expect(liveState.receipt?.primaryPlatformMessageId).toBe("preview-1");
expect(liveState.receipt?.platformMessageIds).toEqual(["preview-1"]);
expect(onPreviewFinalized).toHaveBeenCalledTimes(1);
const [previewId, receiptArg, stateArg] = requireMockCall(
onPreviewFinalized,
0,
"preview finalized",
) as [string, { primaryPlatformMessageId?: string }, unknown];
expect(previewId).toBe("preview-1");
expect(receiptArg.primaryPlatformMessageId).toBe("preview-1");
expect(stateArg).toBe(liveState);
});
it("delivers supplemental payloads after finalizing live previews", async () => {
const editFinal = vi.fn(async () => undefined);
const deliverNormally = vi.fn(async () => undefined);
const deliverSupplemental = vi.fn(async () => true);
const result = await deliverFinalizableLivePreview<
LivePreviewMediaPayload,
string,
LivePreviewMediaEdit
>({
kind: "final",
payload: { text: "done", mediaUrl: "file:///tmp/reply.mp3" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-1",
seal: vi.fn(async () => undefined),
clear: vi.fn(async () => undefined),
},
buildFinalEdit: (payload) => ({ text: payload.text }),
buildSupplementalPayload: (payload) => ({ mediaUrl: payload.mediaUrl }),
editFinal,
deliverNormally,
deliverSupplemental,
});
expect(result.kind).toBe("preview-finalized");
expect(editFinal).toHaveBeenCalledWith("preview-1", { text: "done" });
expect(deliverNormally).not.toHaveBeenCalled();
expect(deliverSupplemental).toHaveBeenCalledWith({ mediaUrl: "file:///tmp/reply.mp3" });
});
it("falls back to normal supplemental delivery when its dedicated sender reports no send", async () => {
const deliverNormally = vi.fn(async () => true);
const deliverSupplemental = vi.fn(async () => false);
const result = await deliverFinalizableLivePreview<
LivePreviewMediaPayload,
string,
LivePreviewMediaEdit
>({
kind: "final",
payload: { text: "done", mediaUrl: "file:///tmp/reply.mp3" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-supplement-fallback",
clear: vi.fn(async () => undefined),
},
buildFinalEdit: (payload) => ({ text: payload.text }),
editFinal: vi.fn(async () => undefined),
buildSupplementalPayload: (payload) => ({ mediaUrl: payload.mediaUrl }),
deliverSupplemental,
deliverNormally,
});
expect(result.kind).toBe("preview-finalized");
expect(deliverSupplemental).toHaveBeenCalledWith({ mediaUrl: "file:///tmp/reply.mp3" });
expect(deliverNormally).toHaveBeenCalledWith({ mediaUrl: "file:///tmp/reply.mp3" });
});
it("uses normal delivery when a finalized preview has no supplemental sender", async () => {
const deliverNormally = vi.fn(async () => true);
const result = await deliverFinalizableLivePreview<
LivePreviewMediaPayload,
string,
LivePreviewMediaEdit
>({
kind: "final",
payload: { text: "done", mediaUrl: "file:///tmp/reply.mp3" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-no-supplement-sender",
clear: vi.fn(async () => undefined),
},
buildFinalEdit: (payload) => ({ text: payload.text }),
editFinal: vi.fn(async () => undefined),
buildSupplementalPayload: (payload) => ({ mediaUrl: payload.mediaUrl }),
deliverNormally,
});
expect(result.kind).toBe("preview-finalized");
expect(deliverNormally).toHaveBeenCalledWith({ mediaUrl: "file:///tmp/reply.mp3" });
});
it("surfaces supplemental delivery failure after both sender paths report no send", async () => {
await expect(
deliverFinalizableLivePreview<LivePreviewMediaPayload, string, LivePreviewMediaEdit>({
kind: "final",
payload: { text: "done", mediaUrl: "file:///tmp/reply.mp3" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-supplement-unsent",
clear: vi.fn(async () => undefined),
},
buildFinalEdit: (payload) => ({ text: payload.text }),
editFinal: vi.fn(async () => undefined),
buildSupplementalPayload: (payload) => ({ mediaUrl: payload.mediaUrl }),
deliverSupplemental: vi.fn(async () => false),
deliverNormally: vi.fn(async () => false),
}),
).rejects.toThrow("Live preview supplemental payload was not delivered");
});
it("treats live preview fallback delivery as terminal state", async () => {
const discardPending = vi.fn(async () => undefined);
const clear = vi.fn(async () => undefined);
const deliverNormally = vi.fn(async () => true);
const onNormalDelivered = vi.fn(async () => undefined);
const result = await deliverFinalizableLivePreview({
kind: "final",
payload: { text: "with media" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-2",
discardPending,
clear,
},
buildFinalEdit: () => undefined,
editFinal: vi.fn(async () => undefined),
deliverNormally,
onNormalDelivered,
});
expect(result.kind).toBe("normal-delivered");
expect(discardPending).toHaveBeenCalledTimes(1);
expect(deliverNormally).toHaveBeenCalledWith({ text: "with media" });
expect(onNormalDelivered).toHaveBeenCalledTimes(1);
expect(clear).toHaveBeenCalledTimes(1);
const liveState = result.liveState;
if (!liveState) {
throw new Error("expected fallback live state");
}
expect(liveState.phase).toBe("cancelled");
expect(liveState.canFinalizeInPlace).toBe(false);
});
it.each(["shared finalizer", "exported adapter"] as const)(
"preserves committed normal delivery when preview cleanup fails through the %s",
async (entrypoint) => {
const events: string[] = [];
const cleanupError = new Error("recipient text and fake-secret must stay private");
const draft = {
flush: vi.fn(async () => undefined),
id: () => "preview-cleanup-failure",
discardPending: vi.fn(async () => {
events.push("discard");
}),
clear: vi.fn(async () => {
events.push("clear");
throw cleanupError;
}),
};
const deliverNormally = vi.fn(async () => {
events.push("deliver");
return true;
});
const onNormalDelivered = vi.fn(async () => {
events.push("commit");
});
const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
try {
const result =
entrypoint === "shared finalizer"
? await deliverFinalizableLivePreview({
kind: "final",
payload: { text: "already delivered" },
draft,
buildFinalEdit: () => undefined,
editFinal: vi.fn(async () => undefined),
deliverNormally,
onNormalDelivered,
})
: await deliverWithFinalizableLivePreviewAdapter({
kind: "final",
payload: { text: "already delivered" },
adapter: defineFinalizableLivePreviewAdapter({
draft,
buildFinalEdit: () => undefined,
editFinal: vi.fn(async () => undefined),
}),
deliverNormally,
onNormalDelivered,
});
expect(result.kind).toBe("normal-delivered");
expect(events).toEqual(["discard", "deliver", "commit", "clear"]);
expect(deliverNormally).toHaveBeenCalledTimes(1);
expect(onNormalDelivered).toHaveBeenCalledTimes(1);
expect(warn).toHaveBeenCalledExactlyOnceWith(
"Live preview cleanup failed after delivery; a stale preview may remain",
);
} finally {
warn.mockRestore();
}
},
);
it("keeps intentionally suppressed fallback delivery skipped without post-delivery cleanup", async () => {
const clear = vi.fn(async () => {
throw new Error("suppressed reply must not be cleaned up as delivered");
});
const onNormalDelivered = vi.fn(async () => undefined);
const result = await deliverFinalizableLivePreview({
kind: "final",
payload: { text: "suppressed" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "suppressed-preview",
discardPending: vi.fn(async () => undefined),
clear,
},
buildFinalEdit: () => undefined,
editFinal: vi.fn(async () => undefined),
deliverNormally: vi.fn(async () => false),
onNormalDelivered,
});
expect(result.kind).toBe("normal-skipped");
expect(onNormalDelivered).not.toHaveBeenCalled();
expect(clear).not.toHaveBeenCalled();
});
it("keeps preview cleanup failures fatal before normal delivery starts", async () => {
const deliverNormally = vi.fn(async () => true);
const onNormalDelivered = vi.fn(async () => undefined);
const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
try {
await expect(
deliverFinalizableLivePreview({
kind: "final",
payload: { text: "not delivered" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "pre-delivery-preview",
clear: vi.fn(async () => {
throw new Error("pre-delivery cleanup failed");
}),
},
buildFinalEdit: () => undefined,
editFinal: vi.fn(async () => undefined),
deliverNormally,
onNormalDelivered,
}),
).rejects.toThrow("pre-delivery cleanup failed");
expect(deliverNormally).not.toHaveBeenCalled();
expect(onNormalDelivered).not.toHaveBeenCalled();
expect(warn).not.toHaveBeenCalled();
} finally {
warn.mockRestore();
}
});
it("preserves a delivery-commit failure when later preview cleanup also fails", async () => {
const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
try {
await expect(
deliverFinalizableLivePreview({
kind: "final",
payload: { text: "already accepted" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "commit-failure-preview",
discardPending: vi.fn(async () => undefined),
clear: vi.fn(async () => {
throw new Error("preview cleanup must not replace delivery failure");
}),
},
buildFinalEdit: () => undefined,
editFinal: vi.fn(async () => undefined),
deliverNormally: vi.fn(async () => true),
onNormalDelivered: vi.fn(async () => {
throw new Error("delivery commit failed");
}),
}),
).rejects.toThrow("delivery commit failed");
expect(warn).toHaveBeenCalledTimes(1);
} finally {
warn.mockRestore();
}
});
it("does not complete live preview fallback state when normal delivery throws", async () => {
const discardPending = vi.fn(async () => undefined);
const clear = vi.fn(async () => undefined);
const onNormalDelivered = vi.fn(async () => undefined);
await expect(
deliverFinalizableLivePreview({
kind: "final",
payload: { text: "with media" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-2",
discardPending,
clear,
},
buildFinalEdit: () => undefined,
editFinal: vi.fn(async () => undefined),
deliverNormally: vi.fn(async () => {
throw new Error("send failed");
}),
onNormalDelivered,
}),
).rejects.toThrow("send failed");
expect(discardPending).toHaveBeenCalledTimes(1);
expect(onNormalDelivered).not.toHaveBeenCalled();
expect(clear).not.toHaveBeenCalled();
});
it("delivers through finalizable live preview adapters", async () => {
const editFinal = vi.fn(async () => undefined);
const adapter = defineFinalizableLivePreviewAdapter({
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-adapter-1",
clear: vi.fn(async () => undefined),
},
buildFinalEdit: (payload: { text: string }) => ({ text: payload.text.toUpperCase() }),
editFinal,
});
const result = await deliverWithFinalizableLivePreviewAdapter({
kind: "final",
payload: { text: "done" },
adapter,
deliverNormally: vi.fn(async () => undefined),
});
expect(result.kind).toBe("preview-finalized");
expect(editFinal).toHaveBeenCalledWith("preview-adapter-1", { text: "DONE" });
});
it("lets live preview adapters resolve the committed platform id after final edit", async () => {
const adapter = defineFinalizableLivePreviewAdapter({
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-before-edit",
clear: vi.fn(async () => undefined),
},
buildFinalEdit: (payload: { text: string }) => ({ text: payload.text }),
editFinal: vi.fn(async () => undefined),
resolveFinalizedId: () => "message-after-edit",
});
const result = await deliverWithFinalizableLivePreviewAdapter({
kind: "final",
payload: { text: "done" },
adapter,
deliverNormally: vi.fn(async () => undefined),
});
expect(result.liveState?.receipt?.primaryPlatformMessageId).toBe("message-after-edit");
});
it("falls back to normal delivery when no live preview adapter is available", async () => {
const deliverNormally = vi.fn(async () => undefined);
const result = await deliverWithFinalizableLivePreviewAdapter({
kind: "final",
payload: { text: "plain" },
deliverNormally,
});
expect(result.kind).toBe("normal-delivered");
expect(deliverNormally).toHaveBeenCalledWith({ text: "plain" });
});
it("lets live preview adapters retain ambiguous failed final edits without fallback send", async () => {
const deliverNormally = vi.fn(async () => undefined);
const handlePreviewEditError = vi.fn(() => "retain" as const);
const editError = new Error("timeout after request");
const adapter = defineFinalizableLivePreviewAdapter({
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-maybe-final",
clear: vi.fn(async () => undefined),
},
buildFinalEdit: (payload: { text: string }) => ({ text: payload.text }),
editFinal: vi.fn(async () => {
throw editError;
}),
handlePreviewEditError,
});
const result = await deliverWithFinalizableLivePreviewAdapter({
kind: "final",
payload: { text: "done" },
adapter,
deliverNormally,
});
expect(result.kind).toBe("preview-retained");
expect(result.liveState?.phase).toBe("previewing");
expect(deliverNormally).not.toHaveBeenCalled();
expect(handlePreviewEditError).toHaveBeenCalledTimes(1);
const [editErrorContext] = requireMockCall(handlePreviewEditError, 0, "preview edit error") as [
{ error: unknown; id?: string; edit?: unknown; payload?: unknown },
];
expect(editErrorContext.error).toBe(editError);
expect(editErrorContext.id).toBe("preview-maybe-final");
expect(editErrorContext.edit).toEqual({ text: "done" });
expect(editErrorContext.payload).toEqual({ text: "done" });
});
it("does not fallback-send after a successful preview edit when finalization hooks fail", async () => {
const deliverNormally = vi.fn(async () => undefined);
const onPreviewFinalized = vi.fn(async () => {
throw new Error("receipt side effect failed");
});
const editFinal = vi.fn(async () => undefined);
await expect(
deliverFinalizableLivePreview({
kind: "final",
payload: { text: "done" },
draft: {
flush: vi.fn(async () => undefined),
id: () => "preview-finalized-before-hook",
seal: vi.fn(async () => undefined),
clear: vi.fn(async () => undefined),
},
buildFinalEdit: (payload) => ({ text: payload.text }),
editFinal,
deliverNormally,
onPreviewFinalized,
}),
).rejects.toThrow("receipt side effect failed");
expect(editFinal).toHaveBeenCalledWith("preview-finalized-before-hook", { text: "done" });
expect(deliverNormally).not.toHaveBeenCalled();
});
it("creates receive contexts with explicit ack policy defaults", () => {
const ctx = createMessageReceiveContext({
id: "rx-1",
channel: "telegram",
message: { text: "hello" },
receivedAt: 123,
});
expect(ctx.id).toBe("rx-1");
expect(ctx.channel).toBe("telegram");
expect(ctx.message).toEqual({ text: "hello" });
expect(ctx.ackPolicy).toBe("after_receive_record");
expect(ctx.ackState).toBe("pending");
expect(ctx.receivedAt).toBe(123);
});
it("acks and nacks receive contexts through explicit hooks", async () => {
const onAck = vi.fn(async () => undefined);
const onNack = vi.fn(async () => undefined);
const ctx = createMessageReceiveContext({
id: "rx-ack",
channel: "telegram",
message: { text: "hello" },
ackPolicy: "after_durable_send",
onAck,
onNack,
});
expect(ctx.shouldAckAfter("receive_record")).toBe(false);
expect(ctx.shouldAckAfter("durable_send")).toBe(true);
const beforeAck = Date.now();
await ctx.ack();
await ctx.ack();
expect(onAck).toHaveBeenCalledTimes(1);
expect(ctx.ackState).toBe("acked");
expect(ctx.ackedAt).toBeGreaterThanOrEqual(beforeAck);
const nackError = new Error("offset failed");
await ctx.nack(nackError);
await ctx.nack(new Error("duplicate failure"));
expect(onNack).toHaveBeenCalledTimes(1);
expect(onNack).toHaveBeenCalledWith(nackError);
expect(ctx.ackState).toBe("nacked");
expect(ctx.nackErrorMessage).toBe("offset failed");
});
it("retries nack callbacks after a failed attempt", async () => {
const onNack = vi
.fn<(error: unknown) => Promise<void>>()
.mockRejectedValueOnce(new Error("temporary failure"))
.mockResolvedValueOnce();
const ctx = createMessageReceiveContext({
id: "rx-nack-retry",
channel: "telegram",
message: { text: "hello" },
onNack,
});
await expect(ctx.nack(new Error("first failure"))).rejects.toThrow("temporary failure");
expect(ctx.ackState).toBe("pending");
const retryError = new Error("retry failure");
await ctx.nack(retryError);
expect(onNack).toHaveBeenCalledTimes(2);
expect(ctx.ackState).toBe("nacked");
expect(ctx.nackErrorMessage).toBe("retry failure");
});
it("coalesces overlapping nack callbacks and retains the first error", async () => {
let resolveNack: (() => void) | undefined;
const onNack = vi.fn(
() =>
new Promise<void>((resolve) => {
resolveNack = resolve;
}),
);
const ctx = createMessageReceiveContext({
id: "rx-nack-overlap",
channel: "telegram",
message: { text: "hello" },
onNack,
});
const firstError = new Error("first failure");
const first = ctx.nack(firstError);
const duplicate = ctx.nack(new Error("duplicate failure"));
await vi.waitFor(() => expect(onNack).toHaveBeenCalledOnce());
resolveNack?.();
await Promise.all([first, duplicate]);
expect(onNack).toHaveBeenCalledWith(firstError);
expect(ctx.ackState).toBe("nacked");
expect(ctx.nackErrorMessage).toBe("first failure");
});
});
|