@hyperframes/studio 0.7.90 → 0.7.93

package/src/hooks/useEditorSave.test.tsx

@@ -0,0 +1,131 @@
+// @vitest-environment happy-dom
+import { act } from "react";
+import { createRoot } from "react-dom/client";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { useEditorSave, type EditorSaveHandle } from "./useEditorSave";
+import { StudioFileConflictError } from "../utils/studioSaveDiagnostics";
+
+(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
+
+type WriteProjectFile = (path: string, content: string, expectedContent?: string) => Promise<void>;
+
+async function mountEditorSave(writeProjectFile: WriteProjectFile) {
+  const captured: { handle: EditorSaveHandle | null } = { handle: null };
+
+  function Probe() {
+    captured.handle = useEditorSave({
+      editingPathRef: { current: "index.html" },
+      projectIdRef: { current: "project-a" },
+      readProjectFile: vi.fn(async () => "before"),
+      writeProjectFile,
+      recordEdit: vi.fn(async () => undefined),
+      domEditSaveTimestampRef: { current: 0 },
+      setRefreshKey: vi.fn(),
+      showToast: vi.fn(),
+    });
+    return null;
+  }
+
+  const root = createRoot(document.createElement("div"));
+  await act(async () => root.render(<Probe />));
+  if (!captured.handle) throw new Error("Editor save handle was not mounted");
+
+  return {
+    handle: captured.handle,
+    unmount: () => act(async () => root.unmount()),
+  };
+}
+
+describe("useEditorSave pending work", () => {
+  beforeEach(() => {
+    vi.stubGlobal(
+      "requestAnimationFrame",
+      vi.fn(() => 41),
+    );
+    vi.stubGlobal("cancelAnimationFrame", vi.fn());
+  });
+
+  afterEach(() => vi.unstubAllGlobals());
+
+  it("exposes and flushes the latest rAF-buffered source candidate", async () => {
+    const writeProjectFile = vi.fn(async () => undefined);
+    const mounted = await mountEditorSave(writeProjectFile);
+    act(() => mounted.handle.handleContentChange("studio candidate"));
+
+    expect(mounted.handle.getPendingCandidate()).toEqual({
+      projectId: "project-a",
+      path: "index.html",
+      content: "studio candidate",
+    });
+    await expect(mounted.handle.flushPendingSave()).resolves.toEqual({ status: "clean" });
+    expect(writeProjectFile).toHaveBeenCalledWith("index.html", "studio candidate", "before");
+
+    await mounted.unmount();
+  });
+
+  it("joins an in-flight source save instead of writing the frozen candidate twice", async () => {
+    let frame: FrameRequestCallback | null = null;
+    vi.stubGlobal(
+      "requestAnimationFrame",
+      vi.fn((callback: FrameRequestCallback) => {
+        frame = callback;
+        return 42;
+      }),
+    );
+    let finishWrite!: () => void;
+    const writeProjectFile = vi
+      .fn()
+      .mockImplementationOnce(
+        () =>
+          new Promise<void>((resolve) => {
+            finishWrite = resolve;
+          }),
+      )
+      .mockResolvedValue(undefined);
+    const mounted = await mountEditorSave(writeProjectFile);
+    act(() => mounted.handle.handleContentChange("candidate"));
+    act(() => frame?.(0));
+    await vi.waitFor(() => expect(writeProjectFile).toHaveBeenCalledOnce());
+
+    const drained = mounted.handle.flushPendingSave();
+    expect(writeProjectFile).toHaveBeenCalledOnce();
+    finishWrite();
+    await expect(drained).resolves.toEqual({ status: "clean" });
+    expect(writeProjectFile).toHaveBeenCalledOnce();
+    await mounted.unmount();
+  });
+
+  it("preserves conflict details when flushing a buffered source candidate", async () => {
+    const conflict = new StudioFileConflictError({
+      filePath: "index.html",
+      currentVersion: "external-v2",
+      currentContent: "external",
+      attemptedContent: "studio candidate",
+    });
+    const mounted = await mountEditorSave(async () => {
+      throw conflict;
+    });
+    act(() => mounted.handle.handleContentChange("studio candidate"));
+
+    await expect(mounted.handle.flushPendingSave()).resolves.toEqual({
+      status: "conflict",
+      error: conflict,
+    });
+
+    await mounted.unmount();
+  });
+
+  it("discards an rAF-buffered candidate without persisting it", async () => {
+    const writeProjectFile = vi.fn(async () => undefined);
+    const mounted = await mountEditorSave(writeProjectFile);
+    act(() => mounted.handle.handleContentChange("discard me"));
+    act(() => mounted.handle.discardPendingSave());
+
+    expect(mounted.handle.getPendingCandidate()).toBeNull();
+    await expect(mounted.handle.flushPendingSave()).resolves.toEqual({ status: "clean" });
+    expect(writeProjectFile).not.toHaveBeenCalled();
+    expect(cancelAnimationFrame).toHaveBeenCalledWith(41);
+
+    await mounted.unmount();
+  });
+});

package/src/hooks/useEditorSave.ts

@@ -2,6 +2,10 @@ import { useCallback, useRef } from "react";
 import { saveProjectFilesWithHistory } from "../utils/studioFileHistory";
 import type { EditHistoryKind } from "../utils/editHistory";
 import { trackStudioEvent } from "../utils/studioTelemetry";
+import {
+  StudioFileConflictError,
+  type StudioSaveDrainResult,
+} from "../utils/studioSaveDiagnostics";
 
 interface RecordEditInput {
   label: string;
@@ -21,6 +25,25 @@ interface UseEditorSaveOptions {
   showToast: (message: string, tone?: "error" | "info") => void;
 }
 
+export interface EditorSaveCandidate {
+  projectId: string;
+  path: string;
+  content: string;
+}
+
+export type EditorSaveDrainResult = StudioSaveDrainResult;
+
+export interface EditorSaveHandle {
+  saveRafRef: React.MutableRefObject<number | null>;
+  handleContentChange: (content: string) => void;
+  /** Read by the external-reload reconciliation introduced in stack PR #2993. */
+  getPendingCandidate: () => EditorSaveCandidate | null;
+  /** Wired into the external-reload drain by stack PR #2993. */
+  flushPendingSave: () => Promise<EditorSaveDrainResult>;
+  /** Used by PR #2993 when the external version wins. */
+  discardPendingSave: () => void;
+}
+
 export function useEditorSave({
   editingPathRef,
   projectIdRef,
@@ -30,12 +53,70 @@ export function useEditorSave({
   domEditSaveTimestampRef,
   setRefreshKey,
   showToast,
-}: UseEditorSaveOptions) {
+}: UseEditorSaveOptions): EditorSaveHandle {
   const saveRafRef = useRef<number | null>(null);
   const refreshRafRef = useRef<number | null>(null);
   // One error toast per burst of failures — every keystroke retries the save,
   // and error toasts persist until dismissed, so don't stack duplicates.
   const lastFailureToastAtRef = useRef(0);
+  const pendingCandidateRef = useRef<EditorSaveCandidate | null>(null);
+  const inFlightRef = useRef<Promise<EditorSaveDrainResult> | null>(null);
+  const inFlightCandidateRef = useRef<EditorSaveCandidate | null>(null);
+
+  const reportFailure = useCallback(
+    (path: string, error: unknown) => {
+      trackStudioEvent("save_failure", {
+        source: "code_editor",
+        error_message: error instanceof Error ? error.message : "unknown",
+      });
+      const now = Date.now();
+      if (now - lastFailureToastAtRef.current > 5000) {
+        lastFailureToastAtRef.current = now;
+        showToast(
+          `Couldn't save ${path} — your latest edits are NOT persisted. Check the preview server; editing again retries the save.`,
+          "error",
+        );
+      }
+    },
+    [showToast],
+  );
+
+  const persistCandidate = useCallback(
+    (candidate: EditorSaveCandidate): Promise<EditorSaveDrainResult> => {
+      const task = saveProjectFilesWithHistory({
+        projectId: candidate.projectId,
+        label: "Edit source",
+        kind: "source",
+        coalesceKey: `source:${candidate.path}`,
+        files: { [candidate.path]: candidate.content },
+        readFile: readProjectFile,
+        writeFile: writeProjectFile,
+        recordEdit,
+      })
+        .then<EditorSaveDrainResult>(() => {
+          if (pendingCandidateRef.current === candidate) pendingCandidateRef.current = null;
+          if (refreshRafRef.current != null) cancelAnimationFrame(refreshRafRef.current);
+          refreshRafRef.current = requestAnimationFrame(() => setRefreshKey((k) => k + 1));
+          return { status: "clean" };
+        })
+        .catch<EditorSaveDrainResult>((error: unknown) => {
+          reportFailure(candidate.path, error);
+          return error instanceof StudioFileConflictError
+            ? { status: "conflict", error }
+            : { status: "failed", error };
+        })
+        .finally(() => {
+          if (inFlightRef.current === task) {
+            inFlightRef.current = null;
+            inFlightCandidateRef.current = null;
+          }
+        });
+      inFlightRef.current = task;
+      inFlightCandidateRef.current = candidate;
+      return task;
+    },
+    [readProjectFile, recordEdit, reportFailure, setRefreshKey, writeProjectFile],
+  );
 
   const handleContentChange = useCallback(
     (content: string) => {
@@ -44,53 +125,46 @@ export function useEditorSave({
       const path = editingPathRef.current;
       if (!path) return;
 
+      const candidate = { projectId: pid, path, content };
+      pendingCandidateRef.current = candidate;
+
       if (saveRafRef.current != null) cancelAnimationFrame(saveRafRef.current);
       saveRafRef.current = requestAnimationFrame(() => {
+        saveRafRef.current = null;
         domEditSaveTimestampRef.current = Date.now();
-        saveProjectFilesWithHistory({
-          projectId: pid,
-          label: "Edit source",
-          kind: "source",
-          coalesceKey: `source:${path}`,
-          files: { [path]: content },
-          readFile: readProjectFile,
-          writeFile: writeProjectFile,
-          recordEdit,
-        })
-          .then(() => {
-            if (refreshRafRef.current != null) cancelAnimationFrame(refreshRafRef.current);
-            refreshRafRef.current = requestAnimationFrame(() => setRefreshKey((k) => k + 1));
-          })
-          .catch((error) => {
-            trackStudioEvent("save_failure", {
-              source: "code_editor",
-              error_message: error instanceof Error ? error.message : "unknown",
-            });
-            const now = Date.now();
-            if (now - lastFailureToastAtRef.current > 5000) {
-              lastFailureToastAtRef.current = now;
-              showToast(
-                `Couldn't save ${path} — your latest edits are NOT persisted. Check the preview server; editing again retries the save.`,
-                "error",
-              );
-            }
-          });
+        void persistCandidate(candidate);
       });
     },
-    [
-      domEditSaveTimestampRef,
-      editingPathRef,
-      projectIdRef,
-      readProjectFile,
-      recordEdit,
-      setRefreshKey,
-      showToast,
-      writeProjectFile,
-    ],
+    [domEditSaveTimestampRef, editingPathRef, projectIdRef, persistCandidate],
   );
 
+  const flushPendingSave = useCallback(async (): Promise<EditorSaveDrainResult> => {
+    if (saveRafRef.current != null) {
+      cancelAnimationFrame(saveRafRef.current);
+      saveRafRef.current = null;
+    }
+    const candidate = pendingCandidateRef.current;
+    if (candidate && candidate === inFlightCandidateRef.current && inFlightRef.current) {
+      return inFlightRef.current;
+    }
+    if (candidate) {
+      domEditSaveTimestampRef.current = Date.now();
+      return persistCandidate(candidate);
+    }
+    return (await inFlightRef.current) ?? { status: "clean" };
+  }, [domEditSaveTimestampRef, persistCandidate]);
+
+  const discardPendingSave = useCallback(() => {
+    if (saveRafRef.current != null) cancelAnimationFrame(saveRafRef.current);
+    saveRafRef.current = null;
+    pendingCandidateRef.current = null;
+  }, []);
+
   return {
     saveRafRef,
     handleContentChange,
+    getPendingCandidate: () => pendingCandidateRef.current,
+    flushPendingSave,
+    discardPendingSave,
   };
 }

package/src/hooks/useExternalFileChangeCoordinator.test.tsx

@@ -0,0 +1,221 @@
+// @vitest-environment happy-dom
+import { act } from "react";
+import { createRoot } from "react-dom/client";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { StudioFileConflictError } from "../utils/studioSaveDiagnostics";
+import { markStudioWriteToken, resetStudioWriteTokens } from "../utils/studioFileVersion";
+import {
+  useExternalFileChangeCoordinator,
+  type ExternalFileChangeCoordinatorHandle,
+} from "./useExternalFileChangeCoordinator";
+
+(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
+
+type HotHandler = (payload?: unknown) => void;
+type CoordinatorOptions = Parameters<typeof useExternalFileChangeCoordinator>[0];
+const roots: Array<ReturnType<typeof createRoot>> = [];
+let handler: HotHandler | null;
+
+async function mountCoordinator(overrides: Partial<CoordinatorOptions> = {}) {
+  const captured: { handle: ExternalFileChangeCoordinatorHandle | null } = { handle: null };
+  const defaults: CoordinatorOptions = {
+    projectId: "project-a",
+    activeCompPath: "index.html",
+    pendingTimelineEditPathRef: { current: new Set() },
+    drainPendingChanges: vi.fn(async () => ({ status: "clean" as const })),
+    reloadPreview: vi.fn(),
+    reloadSdkSession: vi.fn(),
+    persistConflictSnapshot: vi.fn(async () => undefined),
+    discardPendingChanges: vi.fn(),
+    overwriteConflict: vi.fn(async () => undefined),
+    readProjectFile: vi.fn(async () => "external"),
+  };
+  const options = { ...defaults, ...overrides };
+  const root = createRoot(document.createElement("div"));
+  roots.push(root);
+  function Probe() {
+    captured.handle = useExternalFileChangeCoordinator(options);
+    return null;
+  }
+  await act(async () => root.render(<Probe />));
+  return { captured, options };
+}
+
+describe("external file change coordinator", () => {
+  beforeEach(() => {
+    handler = null;
+    resetStudioWriteTokens();
+    vi.stubGlobal("__HF_STUDIO_HOT_TEST_ADAPTER__", {
+      on: (_event: string, next: HotHandler) => {
+        handler = next;
+      },
+      off: () => {
+        handler = null;
+      },
+    });
+  });
+
+  afterEach(async () => {
+    while (roots.length > 0) await act(async () => roots.pop()?.unmount());
+    vi.unstubAllGlobals();
+  });
+
+  it("drains before reloading Preview and SDK exactly once", async () => {
+    const order: string[] = [];
+    const { captured } = await mountCoordinator({
+      drainPendingChanges: async () => {
+        order.push("drain");
+        return { status: "clean" };
+      },
+      reloadPreview: () => order.push("preview"),
+      reloadSdkSession: () => order.push("sdk"),
+    });
+    await act(async () => handler?.({ path: "index.html", content: "external", version: "v2" }));
+    expect(order).toEqual(["drain", "preview", "sdk"]);
+    expect(captured.handle?.blocked).toBeNull();
+  });
+
+  it("suppresses an exact Studio write receipt", async () => {
+    const drainPendingChanges = vi.fn(async () => ({ status: "clean" as const }));
+    const reloadPreview = vi.fn();
+    const reloadSdkSession = vi.fn();
+    await mountCoordinator({ drainPendingChanges, reloadPreview, reloadSdkSession });
+    markStudioWriteToken("studio-write-1");
+    await act(async () =>
+      handler?.({ path: "index.html", content: "studio", writeToken: "studio-write-1" }),
+    );
+    expect(drainPendingChanges).not.toHaveBeenCalled();
+    expect(reloadPreview).not.toHaveBeenCalled();
+    expect(reloadSdkSession).not.toHaveBeenCalled();
+  });
+
+  it("does not suppress a racing external write by path alone", async () => {
+    const pendingTimelineEditPathRef = { current: new Set(["index.html"]) };
+    const drainPendingChanges = vi.fn(async () => ({ status: "clean" as const }));
+    const reloadPreview = vi.fn();
+    const reloadSdkSession = vi.fn();
+    await mountCoordinator({
+      pendingTimelineEditPathRef,
+      drainPendingChanges,
+      reloadPreview,
+      reloadSdkSession,
+    });
+    await act(async () => handler?.({ path: "index.html", content: "agent edit", version: "v2" }));
+    expect(pendingTimelineEditPathRef.current).not.toContain("index.html");
+    expect(drainPendingChanges).toHaveBeenCalledOnce();
+    expect(reloadPreview).toHaveBeenCalledOnce();
+    expect(reloadSdkSession).toHaveBeenCalledOnce();
+  });
+
+  it("blocks both reloads and retains a complete conflict", async () => {
+    const conflict = new StudioFileConflictError({
+      filePath: "index.html",
+      currentVersion: "v2",
+      currentContent: "external",
+      attemptedContent: "studio",
+    });
+    const persistConflictSnapshot = vi.fn(async () => undefined);
+    const { captured, options } = await mountCoordinator({
+      drainPendingChanges: async () => ({ status: "conflict", error: conflict }),
+      persistConflictSnapshot,
+    });
+    await act(async () => handler?.({ path: "index.html", content: "external", version: "v2" }));
+    expect(persistConflictSnapshot).toHaveBeenCalledWith("project-a", conflict);
+    expect(captured.handle?.blocked).toMatchObject({ status: "conflict", error: conflict });
+    expect(options.reloadPreview).not.toHaveBeenCalled();
+    expect(options.reloadSdkSession).not.toHaveBeenCalled();
+  });
+
+  it("ignores stale drain completion after a newer generation", async () => {
+    const drains: Array<(result: { status: "clean" }) => void> = [];
+    const { options } = await mountCoordinator({
+      drainPendingChanges: () => new Promise((resolve) => drains.push(resolve)),
+    });
+    act(() => {
+      handler?.({ path: "index.html", content: "first", version: "v2" });
+      handler?.({ path: "index.html", content: "second", version: "v3" });
+    });
+    await act(async () => drains[0]?.({ status: "clean" }));
+    expect(options.reloadPreview).not.toHaveBeenCalled();
+    await act(async () => drains[1]?.({ status: "clean" }));
+    expect(options.reloadPreview).toHaveBeenCalledOnce();
+    expect(options.reloadSdkSession).toHaveBeenCalledOnce();
+  });
+
+  it("restores a durable unresolved conflict after remount", async () => {
+    const { captured } = await mountCoordinator({
+      recoveryFilePath: "index.html",
+      loadConflictSnapshot: vi.fn(async () => ({
+        kind: "conflict" as const,
+        projectId: "project-a",
+        filePath: "index.html",
+        externalVersion: "v2",
+        externalContent: "external",
+        studioContent: "studio",
+        createdAt: 100,
+      })),
+    });
+    await vi.waitFor(() => expect(captured.handle?.blocked?.status).toBe("conflict"));
+    expect(captured.handle?.blocked).toMatchObject({
+      error: { currentContent: "external", attemptedContent: "studio" },
+    });
+  });
+
+  it("retains the final local candidate when a drain fails", async () => {
+    const failure = new Error("network unavailable");
+    const persistFailureSnapshot = vi.fn(async () => undefined);
+    const deleteConflictSnapshot = vi.fn(async () => undefined);
+    const { captured } = await mountCoordinator({
+      drainPendingChanges: vi
+        .fn()
+        .mockResolvedValueOnce({ status: "failed" as const, error: failure })
+        .mockResolvedValueOnce({ status: "clean" as const }),
+      getPendingCandidate: () => ({ path: "index.html", content: "final local candidate" }),
+      persistFailureSnapshot,
+      deleteConflictSnapshot,
+    });
+    await act(async () => handler?.({ path: "index.html" }));
+    expect(captured.handle?.blocked).toMatchObject({
+      status: "failed",
+      error: failure,
+      studioContent: "final local candidate",
+    });
+    expect(persistFailureSnapshot).toHaveBeenCalledWith(
+      "project-a",
+      "index.html",
+      "final local candidate",
+      null,
+      null,
+      failure,
+    );
+    await act(async () => captured.handle?.retry());
+    expect(deleteConflictSnapshot).toHaveBeenCalledWith("project-a", "index.html");
+  });
+
+  it("restores and overwrites from a durable failed draft", async () => {
+    const overwriteConflict = vi.fn(async () => undefined);
+    const { captured } = await mountCoordinator({
+      recoveryFilePath: "index.html",
+      overwriteConflict,
+      loadConflictSnapshot: vi.fn(async () => ({
+        kind: "failed" as const,
+        projectId: "project-a",
+        filePath: "index.html",
+        externalVersion: "v2",
+        externalContent: "external",
+        studioContent: "recover me",
+        failureMessage: "network unavailable",
+        createdAt: 100,
+      })),
+    });
+    await vi.waitFor(() => expect(captured.handle?.blocked?.status).toBe("failed"));
+    expect(captured.handle?.blocked).toMatchObject({
+      studioContent: "recover me",
+      recovered: true,
+    });
+    await act(async () => captured.handle?.keepStudioFile());
+    expect(overwriteConflict).toHaveBeenCalledWith(
+      expect.objectContaining({ attemptedContent: "recover me", currentVersion: "v2" }),
+    );
+  });
+});