fix(studio): publish keyframe cache refresh atomically

Author: miguel-heygen

packages/studio/src/hooks/gsapKeyframeCacheHelpers.test.ts

@@ -5,6 +5,7 @@ import {
   clearKeyframeCacheForElement,
   clearKeyframeCacheForFile,
   pruneKeyframeCacheToFiles,
+  replaceKeyframeCacheForFile,
   updateKeyframeCacheFromParsed,
 } from "./gsapKeyframeCacheHelpers";
 
@@ -154,6 +155,61 @@ describe("pruneKeyframeCacheToFiles", () => {
   });
 });
 
+describe("replaceKeyframeCacheForFile", () => {
+  it("publishes complete keyframe and animation maps in one notification", () => {
+    const staleEntry = entry();
+    const otherEntry = entry();
+    const staleAnimation = animWithKeyframes("stale");
+    const freshAnimation = animWithKeyframes("fresh");
+    usePlayerStore.setState({
+      keyframeCache: new Map([
+        ["scene.html#stale", staleEntry],
+        ["index.html#stale", staleEntry],
+        ["stale", staleEntry],
+        ["other.html#other", otherEntry],
+        ["other", otherEntry],
+      ]),
+      gsapAnimations: new Map([
+        ["scene.html#stale", [staleAnimation]],
+        ["index.html#stale", [staleAnimation]],
+        ["stale", [staleAnimation]],
+        ["other.html#other", [staleAnimation]],
+        ["other", [staleAnimation]],
+      ]),
+    });
+    const snapshots: Array<{ cacheKeys: string[]; animationKeys: string[] }> = [];
+    const unsubscribe = usePlayerStore.subscribe((state) => {
+      snapshots.push({
+        cacheKeys: [...state.keyframeCache.keys()].sort(),
+        animationKeys: [...state.gsapAnimations.keys()].sort(),
+      });
+    });
+
+    replaceKeyframeCacheForFile(
+      "scene.html",
+      new Map([["fresh", entry()]]),
+      new Map([["fresh", [freshAnimation]]]),
+    );
+    unsubscribe();
+
+    expect(snapshots).toEqual([
+      {
+        cacheKeys: ["fresh", "index.html#fresh", "other", "other.html#other", "scene.html#fresh"],
+        animationKeys: [
+          "fresh",
+          "index.html#fresh",
+          "other",
+          "other.html#other",
+          "scene.html#fresh",
+        ],
+      },
+    ]);
+    expect(usePlayerStore.getState().gsapAnimations.get("scene.html#fresh")).toEqual([
+      freshAnimation,
+    ]);
+  });
+});
+
 describe("updateKeyframeCacheFromParsed", () => {
   it("records colliding animation targets with their own tween percentages", () => {
     const animation = (

packages/studio/src/hooks/gsapKeyframeCacheHelpers.ts

@@ -102,15 +102,24 @@ export function clearKeyframeCacheForElement(sourceFile: string, elementId: stri
  */
 export function clearKeyframeCacheForFile(sourceFile: string): void {
   const { keyframeCache, gsapAnimations } = usePlayerStore.getState();
+  const ids = cachedElementIdsForFile(sourceFile, keyframeCache, gsapAnimations);
+  for (const id of ids) {
+    clearKeyframeCacheForElement(sourceFile, id);
+  }
+}
+
+function cachedElementIdsForFile(
+  sourceFile: string,
+  keyframeCache: ReadonlyMap<string, KeyframeCacheEntry>,
+  gsapAnimations: ReadonlyMap<string, GsapAnimation[]>,
+): Set<string> {
   const sfPrefix = `${sourceFile}#`;
   const ids = new Set<string>();
   for (const key of [...keyframeCache.keys(), ...gsapAnimations.keys()]) {
     if (!key.startsWith(sfPrefix)) continue;
     ids.add(key.slice(sfPrefix.length));
   }
-  for (const id of ids) {
-    clearKeyframeCacheForElement(sourceFile, id);
-  }
+  return ids;
 }
 
 /**
@@ -148,6 +157,35 @@ export function elementCacheKeys(sourceFile: string, elementId: string): string[
     : [`${sourceFile}#${elementId}`, `index.html#${elementId}`, elementId];
 }
 
+/** Replace one file's complete cache snapshot with one atomic store publish. */
+export function replaceKeyframeCacheForFile(
+  sourceFile: string,
+  entries: ReadonlyMap<string, KeyframeCacheEntry>,
+  animationsByElement: ReadonlyMap<string, GsapAnimation[]>,
+): void {
+  const { keyframeCache, gsapAnimations } = usePlayerStore.getState();
+  const nextKeyframeCache = new Map(keyframeCache);
+  const nextGsapAnimations = new Map(gsapAnimations);
+  for (const id of cachedElementIdsForFile(sourceFile, keyframeCache, gsapAnimations)) {
+    for (const key of elementCacheKeys(sourceFile, id)) {
+      nextKeyframeCache.delete(key);
+      nextGsapAnimations.delete(key);
+    }
+  }
+  for (const [id, entry] of entries) {
+    const animations = animationsByElement.get(id);
+    for (const key of elementCacheKeys(sourceFile, id)) {
+      nextKeyframeCache.set(key, entry);
+      if (animations) nextGsapAnimations.set(key, animations);
+      else nextGsapAnimations.delete(key);
+    }
+  }
+  usePlayerStore.setState({
+    keyframeCache: nextKeyframeCache,
+    gsapAnimations: nextGsapAnimations,
+  });
+}
+
 export function writeGsapAnimationsForElement(
   sourceFile: string,
   elementId: string,

packages/studio/src/hooks/keyframeCacheAstLoad.ts

@@ -6,11 +6,7 @@
 import type { GsapAnimation, GsapKeyframesData, ParsedGsap } from "@hyperframes/core/gsap-parser";
 import { isStudioHoldSet } from "@hyperframes/core/gsap-parser";
 import { usePlayerStore } from "../player/store/playerStore";
-import {
-  clearKeyframeCacheForFile,
-  elementCacheKeys,
-  writeGsapAnimationsForElement,
-} from "./gsapKeyframeCacheHelpers";
+import { replaceKeyframeCacheForFile } from "./gsapKeyframeCacheHelpers";
 import { idFromSelector, toClipKeyframes } from "./gsapShared";
 import {
   deduplicateKeyframes,
@@ -146,8 +142,6 @@ export async function populateKeyframeCacheFromAst(
 ): Promise<void> {
   const parsed = await fetchParsedAnimations(projectId, sf);
   if (!parsed) return;
-  const { setKeyframeCache } = usePlayerStore.getState();
-  clearKeyframeCacheForFile(sf);
   const { elements, domClipChildren } = usePlayerStore.getState();
   const mergedByElement = new Map<string, GsapKeyframesData>();
   const sourceByElement = new Map<string, GsapAnimation[]>();
@@ -174,8 +168,5 @@ export async function populateKeyframeCacheFromAst(
       }
     }
   }
-  for (const [id, kfData] of mergedByElement) {
-    for (const key of elementCacheKeys(sf, id)) setKeyframeCache(key, kfData);
-    writeGsapAnimationsForElement(sf, id, sourceByElement.get(id));
-  }
+  replaceKeyframeCacheForFile(sf, mergedByElement, sourceByElement);
 }