Skip to content

Write HTML. Render video. Built for agents.

12.8 KB
Raw Blame
// @vitest-environment happy-dom

import { beforeEach, describe, expect, it, vi } from "vitest";
import type { DomEditSelection } from "../components/editor/domEditingTypes";
import { trackStudioEvent } from "../utils/studioTelemetry";
import type { CommitMutation } from "./gsapScriptCommitTypes";
import { isGestureTransactionCommit, runGestureTransaction } from "./gestureTransaction";

vi.mock("../utils/studioTelemetry", () => ({ trackStudioEvent: vi.fn() }));

const trackStudioEventMock = vi.mocked(trackStudioEvent);

function rect(x: number, y: number, width: number, height: number): DOMRect {
  return { x, y, width, height } as DOMRect;
}

function runTwoMutationTransaction(
  underlying: CommitMutation,
  firstSelection: DomEditSelection,
  secondSelection = firstSelection,
): Promise<void> {
  return runGestureTransaction({
    element: firstSelection.element,
    label: "Resize layer",
    settle: vi.fn(),
    persist: async (commit) => {
      const commitMutation = commit(underlying);
      await commitMutation(firstSelection, { type: "first" }, { label: "First" });
      await commitMutation(secondSelection, { type: "last" }, { label: "Last", softReload: true });
    },
    restore: vi.fn(),
    skipPixelAssert: true,
  });
}

describe("runGestureTransaction", () => {
  beforeEach(() => {
    trackStudioEventMock.mockReset();
    localStorage.clear();
  });

  it("settles synchronously before persist reaches its first await", async () => {
    const order: string[] = [];
    let release!: () => void;
    const gate = new Promise<void>((resolve) => {
      release = resolve;
    });

    const transaction = runGestureTransaction({
      element: document.createElement("div"),
      label: "Resize layer",
      settle: () => order.push("settle"),
      persist: async () => {
        order.push("persist");
        await gate;
        order.push("persisted");
      },
      restore: vi.fn(),
      skipPixelAssert: true,
    });

    expect(order).toEqual(["settle", "persist"]);
    release();
    await transaction;
    expect(order).toEqual(["settle", "persist", "persisted"]);
  });

  it("injects one coalesce key and reloads only the final mutation", async () => {
    const element = document.createElement("div");
    const selection = { element, id: "clip" } as DomEditSelection;
    const underlying = vi.fn<CommitMutation>().mockResolvedValue(undefined);
    const batch = vi.fn<NonNullable<CommitMutation["batch"]>>().mockResolvedValue(undefined);
    underlying.batch = batch;
    const now = vi.spyOn(performance, "now").mockReturnValueOnce(100).mockReturnValueOnce(112.6);

    await runTwoMutationTransaction(underlying, selection);

    expect(underlying).not.toHaveBeenCalled();
    expect(batch).toHaveBeenCalledTimes(1);
    const [calls, mergedOptions] = batch.mock.calls[0]!;
    const firstOptions = calls[0]!.options;
    const lastOptions = calls[1]!.options;
    expect(calls.map(({ mutation }) => mutation)).toEqual([{ type: "first" }, { type: "last" }]);
    expect(firstOptions.coalesceKey).toBe(lastOptions.coalesceKey);
    expect(firstOptions.coalesceKey).toMatch(/^tx:Resize layer:\d+$/);
    expect(firstOptions.coalesceMs).toBe(Number.POSITIVE_INFINITY);
    expect(lastOptions.coalesceMs).toBe(Number.POSITIVE_INFINITY);
    expect(firstOptions).toMatchObject({ skipReload: true });
    expect(firstOptions.softReload).toBeUndefined();
    expect(lastOptions).toMatchObject({ softReload: true });
    expect(lastOptions.skipReload).toBeUndefined();
    // The transaction owns the undo label — the per-mutation "First"/"Last"
    // labels are overridden so the coalesced entry reads "Resize layer".
    expect(firstOptions.label).toBe("Resize layer");
    expect(lastOptions.label).toBe("Resize layer");
    expect(mergedOptions).toMatchObject({
      label: "Resize layer",
      coalesceKey: firstOptions.coalesceKey,
      coalesceMs: Number.POSITIVE_INFINITY,
      softReload: true,
    });
    expect(mergedOptions.skipReload).toBeUndefined();
    expect(trackStudioEventMock).toHaveBeenCalledWith("commit_transaction", {
      label: "Resize layer",
      mutation_count: 2,
      reload_count: 1,
      duration_ms: 13,
      pixel_asserted: false,
    });
    now.mockRestore();
  });

  it("reports one reload when a batch collapses two softReload commits", async () => {
    const element = document.createElement("div");
    const selection = { element, id: "clip", sourceFile: "index.html" } as DomEditSelection;
    const underlying = vi.fn<CommitMutation>().mockResolvedValue(undefined);
    underlying.batch = vi.fn<NonNullable<CommitMutation["batch"]>>().mockResolvedValue(undefined);

    // Both a resize's size and offset persists request softReload; the batch is
    // one write and one reload, so telemetry must report reload_count 1, not 2.
    await runGestureTransaction({
      element,
      label: "Resize layer",
      settle: vi.fn(),
      persist: async (commit) => {
        const commitMutation = commit(underlying);
        await commitMutation(selection, { type: "size" }, { label: "Resize", softReload: true });
        await commitMutation(selection, { type: "offset" }, { label: "Move", softReload: true });
      },
      restore: vi.fn(),
      skipPixelAssert: true,
    });

    expect(underlying.batch).toHaveBeenCalledTimes(1);
    expect(trackStudioEventMock).toHaveBeenCalledWith(
      "commit_transaction",
      expect.objectContaining({ mutation_count: 2, reload_count: 1 }),
    );
  });

  it("falls back to sequential dispatch when the commit has no batch capability", async () => {
    const element = document.createElement("div");
    const selection = { element, id: "clip" } as DomEditSelection;
    const underlying = vi.fn<CommitMutation>().mockResolvedValue(undefined);

    await runTwoMutationTransaction(underlying, selection);

    expect(underlying).toHaveBeenCalledTimes(2);
    expect(underlying.mock.calls[0]![2]).toMatchObject({ skipReload: true });
    expect(underlying.mock.calls[1]![2]).toMatchObject({ softReload: true });
  });

  it("keeps a single mutation on the original commit path", async () => {
    const element = document.createElement("div");
    const selection = { element, id: "clip" } as DomEditSelection;
    const underlying = vi.fn<CommitMutation>().mockResolvedValue(undefined);
    const batch = vi.fn<NonNullable<CommitMutation["batch"]>>().mockResolvedValue(undefined);
    underlying.batch = batch;

    await runGestureTransaction({
      element,
      label: "Move layer",
      settle: vi.fn(),
      persist: async (commit) => {
        await commit(underlying)(
          selection,
          { type: "update-property" },
          { label: "Move", softReload: true },
        );
      },
      restore: vi.fn(),
      skipPixelAssert: true,
    });

    expect(underlying).toHaveBeenCalledTimes(1);
    expect(batch).not.toHaveBeenCalled();
  });

  it("does not batch mutations for different source files", async () => {
    const element = document.createElement("div");
    const firstSelection = { element, id: "a", sourceFile: "a.html" } as DomEditSelection;
    const secondSelection = { element, id: "b", sourceFile: "b.html" } as DomEditSelection;
    const underlying = vi.fn<CommitMutation>().mockResolvedValue(undefined);
    const batch = vi.fn<NonNullable<CommitMutation["batch"]>>().mockResolvedValue(undefined);
    underlying.batch = batch;

    await runTwoMutationTransaction(underlying, firstSelection, secondSelection);

    expect(batch).not.toHaveBeenCalled();
    expect(underlying).toHaveBeenCalledTimes(2);
  });

  it("identifies transaction-owned commit wrappers without marking their underlying commit", async () => {
    const underlying = vi.fn<CommitMutation>().mockResolvedValue(undefined);
    let wrapped: CommitMutation | null = null;

    await runGestureTransaction({
      element: document.createElement("div"),
      label: "Move layer",
      settle: vi.fn(),
      persist: async (commit) => {
        wrapped = commit(underlying);
      },
      restore: vi.fn(),
      skipPixelAssert: true,
    });

    expect(isGestureTransactionCommit(underlying)).toBe(false);
    expect(isGestureTransactionCommit(wrapped!)).toBe(true);
  });

  it("restores exactly once and rethrows a persist failure", async () => {
    const error = new Error("persist failed with secret selector #private-layer");
    error.name = "PersistenceError";
    const restore = vi.fn();
    const element = document.createElement("div");
    const selection = { element, id: "clip" } as DomEditSelection;
    const underlying = vi.fn<CommitMutation>().mockResolvedValue(undefined);

    await expect(
      runGestureTransaction({
        element,
        label: "Resize layer",
        settle: vi.fn(),
        persist: async (commit) => {
          await commit(underlying)(selection, { type: "position" }, { label: "Position" });
          throw error;
        },
        restore,
        skipPixelAssert: true,
      }),
    ).rejects.toBe(error);
    expect(restore).toHaveBeenCalledTimes(1);
    expect(trackStudioEventMock).toHaveBeenCalledWith("commit_transaction_failed", {
      label: "Resize layer",
      mutation_count: 1,
      error_name: "PersistenceError",
      restore_ran: true,
    });
    const failureProperties = trackStudioEventMock.mock.calls.find(
      ([event]) => event === "commit_transaction_failed",
    )?.[1];
    expect(JSON.stringify(failureProperties)).not.toContain(error.message);
    expect(JSON.stringify(failureProperties)).not.toContain("#private-layer");
  });

  it("reports when persistence changes pixels", async () => {
    const element = document.createElement("div");
    const getRect = vi
      .spyOn(element, "getBoundingClientRect")
      .mockReturnValueOnce(rect(10.04, 20.05, 100.05, 80.05))
      .mockReturnValueOnce(rect(11.19, 17.89, 100.29, 78.99));
    const log = vi.spyOn(console, "log").mockImplementation(() => undefined);
    const now = vi.spyOn(performance, "now").mockReturnValueOnce(50).mockReturnValueOnce(58.44);

    await runGestureTransaction({
      element,
      label: "Resize layer",
      settle: vi.fn(),
      persist: async () => undefined,
      restore: vi.fn(),
    });

    expect(getRect).toHaveBeenCalledTimes(2);
    expect(log).not.toHaveBeenCalled();
    expect(trackStudioEventMock).toHaveBeenCalledWith("commit_invariant_violation", {
      label: "Resize layer",
      delta_x: 1.2,
      delta_y: -2.2,
      delta_w: 0.2,
      delta_h: -1.1,
      mutation_count: 0,
      reload_count: 0,
      duration_ms: 8,
    });
    expect(trackStudioEventMock).toHaveBeenCalledWith(
      "commit_transaction",
      expect.objectContaining({ pixel_asserted: true }),
    );
    now.mockRestore();
    log.mockRestore();
  });

  it("measures a box undo painted back mid-save as the edit drew it, so it reports no change", async () => {
    const element = document.createElement("div");
    let undone = false;
    vi.spyOn(element, "getBoundingClientRect").mockImplementation(() =>
      undone ? rect(0, 0, 50, 40) : rect(10, 20, 100, 80),
    );
    const draw = <T>(run: () => T): T => {
      undone = false;
      try {
        return run();
      } finally {
        undone = true;
      }
    };

    await runGestureTransaction({
      element,
      label: "Resize layer",
      settle: vi.fn(),
      persist: async () => void (undone = true),
      restore: vi.fn(),
      draw,
    });

    expect(trackStudioEventMock).not.toHaveBeenCalledWith(
      "commit_invariant_violation",
      expect.anything(),
    );
  });

  it("measures as the edit drew it when undo painted the box back before the transaction began", async () => {
    const element = document.createElement("div");
    let undone = true;
    vi.spyOn(element, "getBoundingClientRect").mockImplementation(() =>
      undone ? rect(0, 0, 50, 40) : rect(10, 20, 100, 80),
    );
    const draw = <T>(run: () => T): T => {
      undone = false;
      try {
        return run();
      } finally {
        undone = true;
      }
    };

    await runGestureTransaction({
      element,
      label: "Resize layer",
      settle: vi.fn(),
      persist: async () => undefined,
      restore: vi.fn(),
      draw,
    });

    expect(trackStudioEventMock).not.toHaveBeenCalledWith(
      "commit_invariant_violation",
      expect.anything(),
    );
  });

  it("skips the pixel assertion for live position tweens", async () => {
    const element = document.createElement("div");
    const getRect = vi.spyOn(element, "getBoundingClientRect");
    const log = vi.spyOn(console, "log").mockImplementation(() => undefined);

    await runGestureTransaction({
      element,
      label: "Resize layer",
      settle: vi.fn(),
      persist: async () => undefined,
      restore: vi.fn(),
      skipPixelAssert: true,
    });

    expect(getRect).not.toHaveBeenCalled();
    expect(log).not.toHaveBeenCalled();
    expect(trackStudioEventMock).not.toHaveBeenCalledWith(
      "commit_invariant_violation",
      expect.anything(),
    );
    log.mockRestore();
  });
});