hyperframes/packages/studio/vite.adapter.signature.test.ts

import { describe, expect, it } from "vitest";
import { resolve } from "node:path";
import { createProjectSignatureCache } from "./vite.adapter";

const PROJECT = resolve("/projects/demo");

/** A compute that changes every call, so a stale read is visible as a repeat. */
function countingCompute() {
  let calls = 0;
  return {
    compute: () => `sig-${++calls}`,
    get calls() {
      return calls;
    },
  };
}

describe("createProjectSignatureCache", () => {
  it("memoises a project's signature", () => {
    const source = countingCompute();
    const cache = createProjectSignatureCache({ compute: source.compute });

    expect(cache.get(PROJECT)).toBe("sig-1");
    expect(cache.get(PROJECT)).toBe("sig-1");
    expect(source.calls).toBe(1);
  });

  it("recomputes after a file inside the project changes", () => {
    const source = countingCompute();
    const cache = createProjectSignatureCache({ compute: source.compute });

    expect(cache.get(PROJECT)).toBe("sig-1");
    cache.invalidate(resolve(PROJECT, "index.html"));

    // The preview ETag is this string. Serving "sig-1" again answers the
    // browser's revalidation with a 304 and the pre-edit composition is what
    // renders — which is how a thumbnail taken after an edit showed the old frame.
    expect(cache.get(PROJECT)).toBe("sig-2");
  });

  it("recomputes for an asset added or removed, not only one edited", () => {
    const source = countingCompute();
    const cache = createProjectSignatureCache({ compute: source.compute });

    cache.get(PROJECT);
    cache.invalidate(resolve(PROJECT, "assets/new-clip.mp4"));
    expect(cache.get(PROJECT)).toBe("sig-2");

    cache.invalidate(resolve(PROJECT, "compositions/scene.html"));
    expect(cache.get(PROJECT)).toBe("sig-3");
  });

  it("leaves other projects alone", () => {
    const signatures = new Map([
      [PROJECT, "demo"],
      [resolve("/projects/other"), "other"],
    ]);
    let bumped = 0;
    const cache = createProjectSignatureCache({
      compute: (dir) => `${signatures.get(dir)}-${bumped}`,
    });

    expect(cache.get(PROJECT)).toBe("demo-0");
    expect(cache.get(resolve("/projects/other"))).toBe("other-0");

    bumped = 1;
    cache.invalidate(resolve(PROJECT, "index.html"));

    expect(cache.get(PROJECT)).toBe("demo-1");
    expect(cache.get(resolve("/projects/other"))).toBe("other-0");
  });

  it("asks for a project directory to be watched once, on first use", () => {
    const watched: string[] = [];
    const cache = createProjectSignatureCache({
      compute: () => "sig",
      watch: (dir) => watched.push(dir),
    });

    cache.get(PROJECT);
    cache.get(PROJECT);
    cache.invalidate(resolve(PROJECT, "index.html"));
    cache.get(PROJECT);

    // Re-registering on every recompute would stack duplicate chokidar entries.
    expect(watched).toEqual([PROJECT]);
  });

  it("normalises the directory it is asked about", () => {
    const source = countingCompute();
    const cache = createProjectSignatureCache({ compute: source.compute });

    expect(cache.get(PROJECT)).toBe("sig-1");
    expect(cache.get(`${PROJECT}/`)).toBe("sig-1");
    expect(cache.get(resolve(PROJECT, "nested/.."))).toBe("sig-1");
    expect(source.calls).toBe(1);
  });

  it("does not invalidate on a write the signature cannot see", () => {
    const source = countingCompute();
    const cache = createProjectSignatureCache({ compute: source.compute });

    cache.get(PROJECT);
    // Each thumbnail capture writes here and then reads the preview, so an
    // unfiltered watcher discards the memo on roughly every request of the one
    // workload the memo exists for.
    cache.invalidate(resolve(PROJECT, ".thumbnails/frame-0.jpg"));

    expect(cache.get(PROJECT)).toBe("sig-1");
    expect(source.calls).toBe(1);
  });

  it("invalidates on a motion-state save, which lives under an otherwise-skipped dir", () => {
    const source = countingCompute();
    const cache = createProjectSignatureCache({ compute: source.compute });

    cache.get(PROJECT);
    cache.invalidate(resolve(PROJECT, ".hyperframes/studio-motion.json"));

    expect(cache.get(PROJECT)).toBe("sig-2");
  });
});