File size: 12,618 Bytes
3144483 | 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 | // Draft stream control tests cover pause, resume, and cancellation handling for channel drafts.
import { setImmediate as nextMacrotask } from "node:timers/promises";
import { describe, expect, it, vi } from "vitest";
import { createDeferred } from "../../test/helpers/promise.js";
import {
clearFinalizableDraftMessage,
createFinalizableDraftLifecycle,
createFinalizableDraftStreamControlsForState,
takeMessageIdAfterStop,
} from "./draft-stream-controls.js";
describe("draft-stream-controls", () => {
it("takeMessageIdAfterStop stops, reads, and clears message id", async () => {
const events: string[] = [];
let messageId: string | undefined = "m-1";
const result = await takeMessageIdAfterStop({
stopForClear: async () => {
events.push("stop");
},
readMessageId: () => {
events.push("read");
return messageId;
},
clearMessageId: () => {
events.push("clear");
messageId = undefined;
},
});
expect(result).toBe("m-1");
expect(messageId).toBeUndefined();
expect(events).toEqual(["stop", "read", "clear"]);
});
it("clearFinalizableDraftMessage deletes valid message ids", async () => {
const deleteMessage = vi.fn(async () => {});
const onDeleteSuccess = vi.fn();
await clearFinalizableDraftMessage({
stopForClear: async () => {},
readMessageId: () => "m-2",
clearMessageId: () => {},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
onDeleteSuccess,
warnPrefix: "cleanup failed",
});
expect(deleteMessage).toHaveBeenCalledWith("m-2");
expect(onDeleteSuccess).toHaveBeenCalledWith("m-2");
});
it("clearFinalizableDraftMessage skips invalid message ids", async () => {
const deleteMessage = vi.fn(async () => {});
await clearFinalizableDraftMessage<unknown>({
stopForClear: async () => {},
readMessageId: () => 123,
clearMessageId: () => {},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
warnPrefix: "cleanup failed",
});
expect(deleteMessage).not.toHaveBeenCalled();
});
it("clearFinalizableDraftMessage claims a failed delete and reports its retry target", async () => {
const warn = vi.fn();
let messageId: string | undefined = "m-3";
const onDeleteFailure = vi.fn();
const deleteMessage = vi.fn(async () => {
throw new Error("boom");
});
await clearFinalizableDraftMessage({
stopForClear: async () => {},
readMessageId: () => messageId,
clearMessageId: () => {
messageId = undefined;
},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
onDeleteFailure,
warn,
warnPrefix: "cleanup failed",
});
expect(messageId).toBeUndefined();
expect(onDeleteFailure).toHaveBeenCalledWith("m-3");
expect(warn).toHaveBeenCalledWith("cleanup failed: boom");
});
it("clearFinalizableDraftMessage claims an id before concurrent clears", async () => {
let messageId: string | undefined = "m-3";
const pendingDelete = createDeferred();
const deleteMessage = vi.fn(() => pendingDelete.promise);
const clear = () =>
clearFinalizableDraftMessage({
stopForClear: async () => {},
readMessageId: () => messageId,
clearMessageId: () => {
messageId = undefined;
},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
warnPrefix: "cleanup failed",
});
const firstClear = clear();
await vi.waitFor(() => expect(deleteMessage).toHaveBeenCalledWith("m-3"));
await clear();
pendingDelete.resolve();
await firstClear;
expect(deleteMessage).toHaveBeenCalledTimes(1);
});
it("clearFinalizableDraftMessage preserves a replacement id while delete is in flight", async () => {
let messageId: string | undefined = "preview-old";
const pendingDelete = createDeferred();
const deleteMessage = vi.fn(() => pendingDelete.promise);
const clearPromise = clearFinalizableDraftMessage({
stopForClear: async () => {},
readMessageId: () => messageId,
clearMessageId: () => {
messageId = undefined;
},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
warnPrefix: "cleanup failed",
});
await vi.waitFor(() => expect(deleteMessage).toHaveBeenCalledWith("preview-old"));
messageId = "preview-new";
pendingDelete.resolve();
await clearPromise;
expect(messageId).toBe("preview-new");
});
it("clearFinalizableDraftMessage reports the failed target after its id is replaced", async () => {
let messageId: string | undefined = "preview-old";
const pendingDelete = createDeferred();
const onDeleteFailure = vi.fn();
const deleteMessage = vi.fn(() => pendingDelete.promise);
const clearPromise = clearFinalizableDraftMessage({
stopForClear: async () => {},
readMessageId: () => messageId,
clearMessageId: () => {
messageId = undefined;
},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
onDeleteFailure,
warnPrefix: "cleanup failed",
});
await vi.waitFor(() => expect(deleteMessage).toHaveBeenCalledWith("preview-old"));
messageId = "preview-new";
pendingDelete.reject(new Error("boom"));
await clearPromise;
expect(onDeleteFailure).toHaveBeenCalledWith("preview-old");
expect(messageId).toBe("preview-new");
});
it("lifecycle retries a failed old deletion after the current id is replaced", async () => {
const state = { stopped: false, final: false };
let messageId: string | undefined = "preview-old";
const pendingDelete = createDeferred();
const warn = vi.fn();
const deleteMessage = vi
.fn<(messageId: string) => Promise<void>>()
.mockImplementationOnce(() => pendingDelete.promise)
.mockResolvedValue(undefined);
const lifecycle = createFinalizableDraftLifecycle({
throttleMs: 250,
state,
sendOrEditStreamMessage: async () => true,
readMessageId: () => messageId,
clearMessageId: () => {
messageId = undefined;
},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
warn,
warnPrefix: "cleanup failed",
});
const firstClear = lifecycle.clear();
await vi.waitFor(() => expect(deleteMessage).toHaveBeenCalledWith("preview-old"));
messageId = "preview-new";
pendingDelete.reject(new Error("boom"));
await firstClear;
expect(messageId).toBe("preview-new");
expect(warn).toHaveBeenCalledWith("cleanup failed: boom");
await lifecycle.clear();
expect(deleteMessage.mock.calls.map(([id]) => id)).toEqual([
"preview-old",
"preview-old",
"preview-new",
]);
expect(messageId).toBeUndefined();
});
it("lifecycle does not retry a successful delete when its success callback fails", async () => {
const state = { stopped: false, final: false };
let messageId: string | undefined = "preview-old";
const deleteMessage = vi.fn(async () => {});
const warn = vi.fn();
const lifecycle = createFinalizableDraftLifecycle({
throttleMs: 250,
state,
sendOrEditStreamMessage: async () => true,
readMessageId: () => messageId,
clearMessageId: () => {
messageId = undefined;
},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
onDeleteSuccess: () => {
throw new Error("callback boom");
},
warn,
warnPrefix: "cleanup failed",
});
await lifecycle.clear();
await lifecycle.clear();
expect(deleteMessage).toHaveBeenCalledTimes(1);
expect(messageId).toBeUndefined();
expect(warn).toHaveBeenCalledWith("cleanup failed after delete: callback boom");
});
it("keeps deletion serialized when stop rejects during an earlier clear", async () => {
const state = { stopped: false, final: false };
let messageId: string | undefined = "preview-old";
const deleteStarted = createDeferred();
const releaseDelete = createDeferred();
const pendingSend = createDeferred();
const stopError = new Error("flush failed");
const deletedIds: string[] = [];
let activeDeletes = 0;
let maxActiveDeletes = 0;
const lifecycle = createFinalizableDraftLifecycle({
throttleMs: 0,
state,
sendOrEditStreamMessage: () => pendingSend.promise,
readMessageId: () => messageId,
clearMessageId: () => {
messageId = undefined;
},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage: async (id) => {
deletedIds.push(id);
activeDeletes += 1;
maxActiveDeletes = Math.max(maxActiveDeletes, activeDeletes);
try {
if (id === "preview-old") {
deleteStarted.resolve();
await releaseDelete.promise;
}
} finally {
activeDeletes -= 1;
}
},
warnPrefix: "cleanup failed",
});
const firstClear = lifecycle.clearWithStop(async () => {});
let stopped: Promise<unknown> | undefined;
let secondClear: Promise<void> | undefined;
try {
await deleteStarted.promise;
messageId = "preview-new";
lifecycle.update("Pending update");
stopped = lifecycle.stop().catch((error: unknown) => error);
expect(state.final).toBe(true);
secondClear = lifecycle.clear();
pendingSend.reject(stopError);
// Let queued promise reactions run while the first physical deletion is still held.
await nextMacrotask();
expect(maxActiveDeletes).toBe(1);
releaseDelete.resolve();
await Promise.all([firstClear, secondClear]);
expect(await stopped).toBe(stopError);
expect(deletedIds).toEqual(["preview-old", "preview-new"]);
} finally {
pendingSend.resolve();
releaseDelete.resolve();
await Promise.allSettled([firstClear, stopped, secondClear]);
lifecycle.loop.stop();
}
});
it("controls ignore updates after final", async () => {
const sendOrEditStreamMessage = vi.fn(async () => true);
const controls = createFinalizableDraftStreamControlsForState({
throttleMs: 250,
state: { stopped: false, final: true },
sendOrEditStreamMessage,
});
controls.update("ignored");
await controls.loop.flush();
expect(sendOrEditStreamMessage).not.toHaveBeenCalled();
});
it("lifecycle clear marks stopped, clears id, and deletes preview message", async () => {
const state = { stopped: false, final: false };
let messageId: string | undefined = "m-4";
const deleteMessage = vi.fn(async () => {});
const lifecycle = createFinalizableDraftLifecycle({
throttleMs: 250,
state,
sendOrEditStreamMessage: async () => true,
readMessageId: () => messageId,
clearMessageId: () => {
messageId = undefined;
},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
warnPrefix: "cleanup failed",
});
await lifecycle.clear();
expect(state.stopped).toBe(true);
expect(messageId).toBeUndefined();
expect(deleteMessage).toHaveBeenCalledWith("m-4");
});
it("lifecycle seal ignores late updates without clearing the preview id", async () => {
const state = { stopped: false, final: false };
let messageId: string | undefined = "m-5";
const sendOrEditStreamMessage = vi.fn(async () => true);
const deleteMessage = vi.fn(async () => {});
const lifecycle = createFinalizableDraftLifecycle({
throttleMs: 250,
state,
sendOrEditStreamMessage,
readMessageId: () => messageId,
clearMessageId: () => {
messageId = undefined;
},
isValidMessageId: (value): value is string => typeof value === "string",
deleteMessage,
warnPrefix: "cleanup failed",
});
lifecycle.update("stale");
await lifecycle.seal();
lifecycle.update("late");
await lifecycle.loop.flush();
expect(state.final).toBe(true);
expect(messageId).toBe("m-5");
expect(sendOrEditStreamMessage).toHaveBeenCalledTimes(1);
expect(sendOrEditStreamMessage).toHaveBeenCalledWith("stale");
expect(deleteMessage).not.toHaveBeenCalled();
});
});
|