mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-16 22:58:02 +00:00
175 lines
5.0 KiB
TypeScript
175 lines
5.0 KiB
TypeScript
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
import { createDomEditSaveQueue } from "./domEditSaveQueue";
|
|
import { StudioFileConflictError, StudioSaveHttpError } from "./studioSaveDiagnostics";
|
|
|
|
describe("dom edit save queue", () => {
|
|
afterEach(() => {
|
|
vi.useRealTimers();
|
|
});
|
|
|
|
it("opens the breaker after consecutive failures and rejects new work until reset", async () => {
|
|
const onOpen = vi.fn();
|
|
const onReset = vi.fn();
|
|
const queue = createDomEditSaveQueue({
|
|
failureThreshold: 2,
|
|
onOpen,
|
|
onReset,
|
|
});
|
|
|
|
await expect(
|
|
queue.enqueue(async () => {
|
|
throw new StudioSaveHttpError("Server down", 503);
|
|
}),
|
|
).rejects.toThrow("Server down");
|
|
await expect(
|
|
queue.enqueue(async () => {
|
|
throw new StudioSaveHttpError("Still down", 503);
|
|
}),
|
|
).rejects.toThrow("Still down");
|
|
|
|
expect(onOpen).toHaveBeenCalledWith({
|
|
consecutiveFailures: 2,
|
|
errorMessage: "Still down",
|
|
statusCode: 503,
|
|
});
|
|
|
|
let thirdRan = false;
|
|
await expect(
|
|
queue.enqueue(async () => {
|
|
thirdRan = true;
|
|
}),
|
|
).rejects.toThrow("Auto-save is paused");
|
|
expect(thirdRan).toBe(false);
|
|
|
|
queue.reset();
|
|
expect(onReset).toHaveBeenCalledOnce();
|
|
|
|
await queue.enqueue(async () => {
|
|
thirdRan = true;
|
|
});
|
|
expect(thirdRan).toBe(true);
|
|
queue.destroy();
|
|
});
|
|
|
|
it("stops already queued work when the preceding save opens the breaker", async () => {
|
|
const onOpen = vi.fn();
|
|
const onReset = vi.fn();
|
|
const queue = createDomEditSaveQueue({
|
|
failureThreshold: 1,
|
|
onOpen,
|
|
onReset,
|
|
});
|
|
|
|
let rejectFirst: ((error: Error) => void) | null = null;
|
|
let resolveFirstStarted: (() => void) | null = null;
|
|
const firstStarted = new Promise<void>((resolve) => {
|
|
resolveFirstStarted = resolve;
|
|
});
|
|
const first = queue.enqueue(
|
|
() =>
|
|
new Promise<void>((_resolve, reject) => {
|
|
rejectFirst = reject;
|
|
resolveFirstStarted?.();
|
|
}),
|
|
);
|
|
const secondSave = vi.fn(async () => undefined);
|
|
const second = queue.enqueue(secondSave);
|
|
|
|
await firstStarted;
|
|
expect(rejectFirst).toBeTypeOf("function");
|
|
rejectFirst?.(new StudioSaveHttpError("Server down", 503));
|
|
await expect(first).rejects.toThrow("Server down");
|
|
await expect(second).rejects.toThrow("Auto-save is paused");
|
|
expect(secondSave).not.toHaveBeenCalled();
|
|
|
|
expect(onOpen).toHaveBeenCalledOnce();
|
|
expect(onReset).not.toHaveBeenCalled();
|
|
|
|
await expect(queue.enqueue(async () => {})).rejects.toThrow("Auto-save is paused");
|
|
|
|
queue.reset();
|
|
expect(onReset).toHaveBeenCalledOnce();
|
|
queue.destroy();
|
|
});
|
|
|
|
it("resets consecutive failures after a successful save", async () => {
|
|
const onOpen = vi.fn();
|
|
const queue = createDomEditSaveQueue({
|
|
failureThreshold: 2,
|
|
onOpen,
|
|
});
|
|
|
|
await expect(
|
|
queue.enqueue(async () => {
|
|
throw new Error("first failure");
|
|
}),
|
|
).rejects.toThrow("first failure");
|
|
|
|
await queue.enqueue(async () => {});
|
|
|
|
await expect(
|
|
queue.enqueue(async () => {
|
|
throw new Error("second failure after success");
|
|
}),
|
|
).rejects.toThrow("second failure after success");
|
|
|
|
expect(onOpen).not.toHaveBeenCalled();
|
|
queue.destroy();
|
|
});
|
|
|
|
it("clears a stale drain failure after a successful save", async () => {
|
|
const failure = new Error("temporary failure");
|
|
const queue = createDomEditSaveQueue();
|
|
|
|
await expect(
|
|
queue.enqueue(async () => {
|
|
throw failure;
|
|
}),
|
|
).rejects.toBe(failure);
|
|
await expect(queue.waitForIdle()).resolves.toEqual({ status: "failed", error: failure });
|
|
|
|
await queue.enqueue(async () => undefined);
|
|
|
|
await expect(queue.waitForIdle()).resolves.toEqual({ status: "clean" });
|
|
queue.destroy();
|
|
});
|
|
|
|
it("pauses immediately on a file conflict instead of retrying stale work", async () => {
|
|
const onOpen = vi.fn();
|
|
const queue = createDomEditSaveQueue({ failureThreshold: 5, onOpen });
|
|
|
|
await expect(
|
|
queue.enqueue(async () => {
|
|
throw new StudioSaveHttpError("File changed elsewhere", 409);
|
|
}),
|
|
).rejects.toThrow("File changed elsewhere");
|
|
|
|
expect(onOpen).toHaveBeenCalledWith({
|
|
consecutiveFailures: 1,
|
|
errorMessage: "File changed elsewhere",
|
|
statusCode: 409,
|
|
});
|
|
await expect(queue.enqueue(async () => {})).rejects.toThrow("Auto-save is paused");
|
|
queue.destroy();
|
|
});
|
|
|
|
it("returns the original conflict from a drain instead of erasing it", async () => {
|
|
const conflict = new StudioFileConflictError({
|
|
filePath: "index.html",
|
|
currentVersion: "external-v2",
|
|
currentContent: "external",
|
|
attemptedContent: "studio",
|
|
});
|
|
const queue = createDomEditSaveQueue();
|
|
|
|
await expect(
|
|
queue.enqueue(async () => {
|
|
throw conflict;
|
|
}),
|
|
).rejects.toBe(conflict);
|
|
|
|
await expect(queue.waitForIdle()).resolves.toEqual({ status: "conflict", error: conflict });
|
|
queue.destroy();
|
|
});
|
|
});
|