mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-05 00:56:23 +00:00
* feat(studio): glue API coexistence layer for the NLE swap What: extends 21 glue files so the OLD timeline/canvas engine and the NEW NLE components type-check side by side: playerStore (multi-select setters, zoom pin, snap toggle, non-reactive scale scratch), drag-state types gain optional NLE fields, timelineLayout/timelineAssetDrop/timelineEditingHelpers/ timelineEditing/timelineElementHelpers/studioHelpers/assetHelpers gain the NLE exports, DomEditOverlay + gestures + AssetContextMenu + Timeline props gain optional callbacks/params, contexts gain *Optional hooks, and TimelineEditCallbacks.onMoveElements becomes a bivariant method accepting both engines' change shapes. patchDocumentRootDuration's test rides along. Why: this is the keystone that dissolves the old "welded glue" problem — every symbol the NLE components need is ADDED next to what the old engine still uses, so the engine components and the swaps can land as separate reviewable PRs. How: 15 authored intermediate files (main content + additive symbols; no behavior changes — new fields optional, new callbacks unused until wired) plus 6 files whose final content is already purely additive. New exports without consumers yet carry TEMP(studio-dnd) ignoreExports entries, removed by the app-shell swap. Test plan: tsc --noEmit in studio + studio-server (verifies BOTH engines compile); bunx vitest run (full suite green incl. the 6 new patchDocumentRootDuration tests); fallow audit clean. * feat(studio): timeline interaction hooks and lanes component (unwired) What: the timeline-side wiring layer, unwired: TimelineLanes (the lane renderer driving drag/resize/marquee), timelineMarquee (+tests), useTimelineStackingSync, useTimelineGeometry, useTimelineEditPinning, useTimelineEditingDrops. Why: everything between the pure drag math and <Timeline> itself; the timeline-glue swap PR then only rewires Timeline/TimelineCanvas onto these. How: new files, tsc-clean against the coexistence layer. Unwired components carry TEMP(studio-dnd) entry registrations, removed at the app-shell swap. Test plan: bunx vitest run timelineMarquee.test.ts; tsc --noEmit; fallow audit clean. * feat(studio): NLE shell assembly (unwired) What: EditorShell (the full editor layout replacing NLELayout + StudioPreviewArea), TimelinePane (timeline host with sub-comp rebasing) and useTimelineEditCallbacks (the callback bag bridging store edits to the timeline), all unwired. Why: the shell that App swaps to in the final step; reviewing it standalone keeps that swap PR small. How: new files against the coexistence layer; TEMP(studio-dnd) entries until App mounts EditorShell in the app-shell swap. Test plan: tsc --noEmit; bunx vitest run (suite unchanged); fallow audit clean. * feat(studio): timeline glue swap — Timeline/TimelineCanvas onto the NLE engine What: flips the timeline glue to its final form (23 files): Timeline and TimelineCanvas rebuilt on TimelineLanes/TimelineOverlays, useTimelineClipDrag drives preview/commit through the new drag engine, range selection goes multi-select, playback loop moves to useTimelinePlayerLoop. Deletes the 9 old-engine files this orphans (group drag, marquee selection, snap targets, layer gutter, selection overlays + their suites) — each is compile- or gate-forced by this swap, verified by probe. Why: second swap step; timeline-only, canvas and App untouched. How: modified files to final content + forced deletions. playerStore/timelineEditing/timelineCallbacks stay at their coexistence form until the app swap (the old App still runs on them). Test plan: tsc --noEmit; bunx vitest run (full suite); fallow audit clean. * feat(studio): clip thumbnail modules What: ImageThumbnail (+tests) and thumbnailUtils (+tests) — frame decode with SVG/AVIF format fallbacks and rounded-corner clipping — plus VideoThumbnail updates. Why: the decode layer for timeline clip thumbnails, ahead of the visual refresh that renders them. How: new modules + one modified file; purely presentational. Test plan: bunx vitest run on both test files; tsc --noEmit; fallow audit clean. * feat(studio): assets/blocks panel behaviors + preview helpers What: blocks tab install flow, right-panel and global drag-overlay polish, music beat analysis and clip-content rendering hooks, and the preview-helper utilities backing asset preview. Why: completes the studio NLE stack on top of the visual refresh. How: modified files only (kept as one PR: splitting further would produce sub-150-LOC fragments of interdependent panel glue). Test plan: bunx vitest run studioPreviewHelpers/studioUrlState suites; tsc --noEmit; fallow audit clean. * fix(studio): restore timeline playback loop * fix(studio): restore missing GSAP helpers module * refactor(studio): split timeline GSAP helpers * style(studio): keep timeline helper under size limit * fix(studio): restore timeline overlays module * fix(studio): remove stale GSAP import * fix(studio): restore canonical timeline dependencies * style(studio): format restored timeline helpers * style(studio): satisfy helper line limit * fix(studio): repair rebuilt timeline integration * feat(studio): complete rebuilt NLE cutover * fix(studio): guard project and timeline race boundaries * fix(studio): preserve graded resize and crop geometry * fix(studio): log resize/rotate commit failures, move anchor accumulator to resize-local * fix(studio): treat duration-0 tweens as static holds and settle resize position before persist Instant holds (to()/fromTo() with duration 0) were classified as animated tweens by every commit route, so resizing or rotating them converted the hold into a corrupt duration-0 keyframes tween (new value at 0%, old at 100%) that GSAP drops; panel edits appended a losing set. A shared isInstantHold() now routes them through the static replace-in-place path, and percentage math guards zero-duration windows. Separately, anchored-corner resizes painted 3-5 frames at the new size but old position while the offset persist round-tripped the server. The commit path now applies the corrected GSAP position synchronously before awaiting the offset persist, mirroring the scale route's settle. * feat(studio): gesture-transaction seam with commit observability Introduce runGestureTransaction — one owner for a gesture commit's settle -> persist -> record lifecycle. It settles the live DOM synchronously before any async persist, folds every mutation into one undo entry via a per-transaction coalesceKey, restores pre-gesture state exactly once on failure, and asserts (dev console) + reports (PostHog: commit_transaction / commit_invariant_violation / commit_transaction_failed) that a persist never changes pixels. The box-size resize path is migrated onto it; the ad hoc per-route coalesceKey/reload handling is removed. Extract the resize draft-rect math into resizeDraft.ts to keep the gesture-handler file under the size cap. Also: keep url_hash telemetry to the route slug only (drop the query string, which carried the user's selected element id/selector), and gate the [hf-resize] diagnostics behind localStorage hf-resize-debug so they ship as opt-in tracing rather than console noise. * fix(studio): transaction owns the undo label The coalesced history entry took the last sub-mutation's label, so a resize surfaced as "Move layer" (the offset persist) in undo/redo. The seam now stamps tx.label on every wrapped mutation, so the folded entry reads as the gesture. * fix(studio): atomic static size/position commits (no data loss) Static resize/position holds updated an existing set via delete+add — two undo entries, and a delete that succeeded before a failed add lost the hold on disk. Use one in-place update-properties mutation when a set exists (one undo entry, no partial-failure window). The keyframed-hold heal that can't be expressed as a property update now adds before it deletes, so any single failure leaves a recoverable duplicate, never a lost hold. Transaction-owned commits are tracked via a WeakSet so the heal path never double-wraps an already-wrapped gesture. * fix(core): restore timed-clip visibility after a forced timeline rebind __hfForceTimelineRebind force-rendered the re-registered timeline but never re-ran the per-[data-start] visibility pass, so after undo or soft reload every clip rendered regardless of its time window until a full page reload. Extract the visibility loop into syncTimedElementVisibility and call it from both syncMediaForCurrentState (unchanged) and the rebind. * fix(studio): atomic z-order/keyframe/split commits, one undo entry each Three edit-commit paths hardened onto the one-transaction invariant: - Z-order reorder (useElementLifecycleOps): N per-element writes now fold into one undo entry (coalesceMs Infinity) and, on a failed persist, restore already-written files to disk so no partial reorder survives. - Enable-keyframes (useEnableKeyframes/useGsapKeyframeOps): the intermediate convert phase no longer full-reloads the preview (skipReload), killing the black-flash remount; convert + edit share one coalesce key = one undo entry. - Razor split-all (useRazorSplit): snapshot before the batch and restore on any failure, so a mid-batch error never leaves un-revertable partial splits. Shared file-history helpers (RecordEditInput, DomEditCommitBaseParams, readProjectFileContent, restoreFilesToOriginal) dedupe the rollback/commit logic across these paths. Commit options thread as one partial object rather than field-by-field. Test setup extracted into colocated helpers. * fix(studio): fold multi-step edits into one undo entry; guard text revert - Gesture recording (useGestureCommit): the per-property-group commits now share one coalesce key and only the last reloads, so a recording is one undo entry and one preview reload instead of up to four. - Delete selected keyframes (deleteSelectedKeyframes, split out of timelineEditingHelpers): N removals fold into one coalesced undo entry with a single reload. - Text-field commit (useDomEditTextCommits): commitDomTextFields now uses the same version-guarded revert as handleDomTextCommit, so a stale failed commit can no longer stomp a newer successful one. * feat(studio): batch a gesture's mutations into one atomic server write A transaction that emits N mutations previously did N sequential POSTs, each rewriting the file and soft-reloading — the root of the multi-phase persist window. Add a gsap-mutations-batch endpoint that validates every mutation up front, applies them in one in-memory rewrite chain, and writes the file once (all-or-nothing: an invalid entry rejects the whole batch, no partial write). The seam buffers a transaction's commits and, when more than one targets the same file, dispatches a single batch — one write, one history entry, one reload. The batch capability rides on the existing commit-function reference; no option fields are threaded through callers. * fix(studio): soften off-canvas indicator outline to 30% opacity The dashed off-canvas selection outline at 60% was noisy with many protruding elements on screen; drop the resting opacity to 30% (hover still restores full opacity so it stays discoverable). * fix(studio): drop off-canvas indicator outline to 10% opacity Follow-up to the 30% softening — 10% resting opacity reads much calmer with many protruding elements; hover still restores full opacity. * fix(studio): gate [hf-commit] console traces to dev only The start/settled/persisted/restore lifecycle traces logged on every gesture commit in all environments — console noise for end users. Route them through a dev-only traceCommit helper (matching the pixel-violation error's existing DEV gate). The commit_* PostHog events stay always on; they are the production observability, the console lines are a dev aid. * fix(studio): count actual reloads, not softReload requests, in commit telemetry A resize's size and offset persists both request softReload; the seam counted each request, so a batched gesture reported reload_count 2 even though the batch is one write and one reload. Compute the count from what dispatchBufferedCommits actually did — one for a batch, the request count for the sequential fallback. * fix(studio): rotate hover + off-canvas overlays with the element; flicker-free crop - Hover overlay applied the element's rotation only to the selection chrome, not the hover box; it now rotates about center like the selection, via a shared orientedGroupAwareOverlayRect router (one owner for rotation-aware overlay geometry across hover/selection/off-canvas). - Off-canvas indicator was axis-aligned; it now rotates with the element and inverse-rotates the canvas-exclusion clip into the element's local frame, so the protruding-sliver clip stays correct for rotated elements. - Crop commit re-lifted the element only in the commit's .then(), so one frame painted the cropped state (the flicker). Re-lift synchronously right after onStyleCommit (which applies the clip before its first await), so the cropped state never paints; the persisted file value is unchanged. * fix(studio): address code-review findings across the commit-hardening campaign Correctness (would ship green, bite under latency): - Enable-keyframes phase 2 now carries coalesceMs: Infinity, so the convert folds into one undo entry instead of splitting past the 300ms default. - The SDK keyframe persist path forwards coalesceMs (CutoverOptions gains the field); multi-keyframe delete and convert coalesce correctly when SDK-routed. - Razor split-all's rollback is guarded so a failing restore can't swallow the error toast that tells the user the split failed. Simplification (single source of truth / no dead flexibility): - Decompose resolveResizeDraftRect (drops a fallow-ignore suppression). - Delegate the third readProjectFileContent copy to the shared helper. - Inline setPatchFromUpdateProperties (its only caller passes one mutation). - One toSdkPersistOptions translates gesture overrides to SDK options. - Bundle the reorder-rollback deps into one object (was 7-9 positional args). - Dedupe the 'last group reloads' ternary; type gesture options as CommitMutationOptions; drop a Map+array wrapper around a single write. * feat(studio): atomic z-order reorder via batch patch-element endpoint Z-order reorder issued N per-element inline-style patches (one server write each), so a mid-chain failure could leave a partial reorder on disk. Add a patch-elements-batch endpoint that validates every patch, folds them over the file in one in-memory rewrite, and writes once (all-or-nothing; unsafe input rejects with no write). The reorder now sends one batch per source file and records one undo entry. Because a failed atomic write persists nothing, the interim disk-write-back rollback (restoreReorderedFile / restoreFulfilledReorderFiles / ReorderRollbackDeps) is deleted — failure rolls back only live DOM/store state. Closes the last disk-atomicity gap. * fix(studio): razor-split undo no longer silently no-ops The split clone was written to disk without a data-hf-id, so the split endpoint recorded that unstamped HTML as the undo entry's afterHash. The next reloadPreview() ran the preview route's ensureHfIds write-back, which minted a fresh id and persisted DIFFERENT bytes — so at undo time the disk hash no longer matched afterHash and editHistory's content-mismatch guard silently refused the undo (no write, no network, no error). Stamp the split output via ensureHfIds in splitElementInHtml before it is written/returned, so the preview write-back is a no-op and the recorded afterHash always equals the final on-disk bytes. Fixes at the source rather than relaxing the mismatch guard. Corrects the stale comment that credited forceReloadSdkSession. * feat(studio): closed-hand grab cursor on the rotate handle The rotate handle used the default arrow cursor; show a grabbing (closed-hand) cursor on hover to signal it's grabbed and dragged to rotate. * fix(studio): dropping a dragged element over another no longer selects it A moved drag's release fired the box click, which re-selected whatever now sat under the pointer via the hover cache — so dropping an element over a higher-z one selected the drop target instead of keeping the dragged element selected. The drag-move branch now suppresses the next box click, mirroring the resize branch. * fix(studio): group drag is one undo entry, not one per element Dragging a multi-selected group committed each member's position write as its own undo entry, so reverting took N Cmd+Z presses. Force a shared coalesceKey (infinite window) across every member's commit so they fold into a single undo entry, like the other multi-step commit paths. * fix(studio): undo of a split no longer leaves a ghost clip in the timeline The file and the composition iframe revert correctly on undo, but the timeline panel kept a ghost node for the split clone. The element-merge that repopulates the timeline preserves elements the fresh scan dropped — intended for enriched sub-composition children a bare DOM re-scan misses, but it also preserved a genuinely-removed TOP-LEVEL element (the split clone after undo), leaving a phantom clip. Restrict the preserve to elements with a compositionSrc (the enriched sub-comp children); a top-level element missing from the fresh scan was truly removed. --------- Co-authored-by: ukimsanov <ular.kimsanov@heygen.com>
387 lines
16 KiB
TypeScript
387 lines
16 KiB
TypeScript
import { useCallback, useMemo, useRef } from "react";
|
|
import { findUnsafeMutationValues } from "@hyperframes/core/studio-api/finite-mutation";
|
|
import { readProjectFileContent as readSharedProjectFileContent } from "../utils/studioFileHistory";
|
|
import type { DomEditSelection } from "../components/editor/domEditingTypes";
|
|
import { usePlayerStore } from "../player/store/playerStore";
|
|
import { applySoftReload, extractGsapScriptText } from "../utils/gsapSoftReload";
|
|
import type { SoftReloadResult } from "../utils/gsapSoftReload";
|
|
import { trackStudioEvent } from "../utils/studioTelemetry";
|
|
import type { CutoverDeps } from "../utils/sdkCutover";
|
|
import { updateKeyframeCacheFromParsed } from "./gsapKeyframeCacheHelpers";
|
|
import { patchRuntimeTweenInPlace } from "./gsapRuntimePatch";
|
|
import { createKeyedSerializer } from "./serializeByKey";
|
|
import {
|
|
GsapMutationHttpError,
|
|
formatGsapMutationRejectionToast,
|
|
readJsonResponseBody,
|
|
} from "./gsapScriptCommitHelpers";
|
|
import type {
|
|
CommitMutation,
|
|
CommitMutationCall,
|
|
CommitMutationOptions,
|
|
GsapScriptCommitsParams,
|
|
MutationResult,
|
|
} from "./gsapScriptCommitTypes";
|
|
import { useGsapAnimationOps } from "./useGsapAnimationOps";
|
|
import { useGsapArcPathOps } from "./useGsapArcPathOps";
|
|
import { useGsapKeyframeOps } from "./useGsapKeyframeOps";
|
|
import { useGsapPropertyDebounce } from "./useGsapPropertyDebounce";
|
|
import {
|
|
useGsapSaveFailureTelemetry,
|
|
useSafeGsapCommitMutation,
|
|
} from "./useSafeGsapCommitMutation";
|
|
|
|
async function mutateGsapScript(
|
|
projectId: string,
|
|
sourceFile: string,
|
|
mutation: Record<string, unknown>,
|
|
): Promise<MutationResult> {
|
|
const res = await fetch(
|
|
`/api/projects/${encodeURIComponent(projectId)}/gsap-mutations/${encodeURIComponent(sourceFile)}`,
|
|
{
|
|
method: "POST",
|
|
headers: { "Content-Type": "application/json" },
|
|
body: JSON.stringify(mutation),
|
|
},
|
|
);
|
|
if (!res.ok) throw new GsapMutationHttpError(res.status, await readJsonResponseBody(res));
|
|
const result = (await res.json()) as MutationResult;
|
|
if (!result.ok) throw new Error(`Failed to update GSAP in ${sourceFile}`);
|
|
return result;
|
|
}
|
|
|
|
async function mutateGsapScriptBatch(
|
|
projectId: string,
|
|
sourceFile: string,
|
|
mutations: Record<string, unknown>[],
|
|
): Promise<MutationResult> {
|
|
const res = await fetch(
|
|
`/api/projects/${encodeURIComponent(projectId)}/gsap-mutations-batch/${encodeURIComponent(sourceFile)}`,
|
|
{
|
|
method: "POST",
|
|
headers: { "Content-Type": "application/json" },
|
|
body: JSON.stringify({ mutations }),
|
|
},
|
|
);
|
|
if (!res.ok) throw new GsapMutationHttpError(res.status, await readJsonResponseBody(res));
|
|
const result = (await res.json()) as MutationResult;
|
|
if (!result.ok) throw new Error(`Failed to update GSAP in ${sourceFile}`);
|
|
return result;
|
|
}
|
|
|
|
type ShowToast = (message: string, tone?: "error" | "info") => void;
|
|
|
|
async function runMutationRequest(
|
|
mutations: Record<string, unknown>[],
|
|
options: CommitMutationOptions,
|
|
showToast: ShowToast | undefined,
|
|
request: () => Promise<MutationResult>,
|
|
): Promise<MutationResult | undefined> {
|
|
const unsafeFields = mutations.flatMap((mutation) => findUnsafeMutationValues(mutation));
|
|
if (unsafeFields.length > 0) {
|
|
showToast?.("Couldn't read element layout — try again at a different playhead time", "error");
|
|
if (options.skipReload) return;
|
|
throw new Error(
|
|
`Mutation contains unsafe values: ${unsafeFields.map((field) => field.path).join(", ")}`,
|
|
);
|
|
}
|
|
try {
|
|
return await request();
|
|
} catch (error) {
|
|
if (error instanceof GsapMutationHttpError)
|
|
showToast?.(formatGsapMutationRejectionToast(error), "error");
|
|
if (options.skipReload) return;
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
function finishUnchangedMutation(
|
|
iframe: HTMLIFrameElement | null,
|
|
result: MutationResult,
|
|
options: CommitMutationOptions,
|
|
reloadPreview: () => void,
|
|
): boolean {
|
|
if (result.changed !== false) return false;
|
|
if (!options.skipReload && options.instantPatch) {
|
|
applyPreviewSync(iframe, result, options, reloadPreview);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
function refreshMutationPreview(
|
|
iframe: HTMLIFrameElement | null,
|
|
result: MutationResult,
|
|
options: CommitMutationOptions,
|
|
reloadPreview: () => void,
|
|
onCacheInvalidate: () => void,
|
|
): void {
|
|
options.beforeReload?.();
|
|
applyPreviewSync(iframe, result, options, reloadPreview);
|
|
onCacheInvalidate();
|
|
}
|
|
|
|
/**
|
|
* Apply a soft reload and enforce the U4 invariant via the richer
|
|
* `SoftReloadResult`, with telemetry on every non-success path so the invariant
|
|
* is observable in production, not just asserted in tests:
|
|
*
|
|
* - `"cannot-soft-reload"` (PERMANENT/STRUCTURAL: no gsap runtime, no rebind
|
|
* hook, no scopable key, no script element, or the sync re-run threw) →
|
|
* escalate to a full `reloadPreview()`; the preview is genuinely stale/broken.
|
|
* - `"verify-failed"` (TRANSIENT: re-run happened, `__timelines` momentarily
|
|
* empty) → do NOT escalate; the live `gsap.set` already shows the correct value
|
|
* and a remount would re-flash the WebGL context + revert subcomp keyframes.
|
|
* - `"applied"` → success (or deferred to async plugin load; `onAsyncFailure`
|
|
* covers the CDN-error escalation).
|
|
*/
|
|
function softReloadOrEscalate(
|
|
iframe: HTMLIFrameElement | null,
|
|
scriptText: string,
|
|
reloadPreview: () => void,
|
|
origin: "preview_sync" | "sdk_refresh",
|
|
authoredHtml?: string,
|
|
): void {
|
|
// Seek the rebuilt timeline to the studio's own authoritative scrub position,
|
|
// not the iframe's raw `__player.getTime()` — see the comment in
|
|
// applySoftReload for why the two can desync after a keyframe-node drag.
|
|
const currentTime = usePlayerStore.getState().currentTime;
|
|
const result: SoftReloadResult = applySoftReload(iframe, scriptText, {
|
|
onAsyncFailure: reloadPreview,
|
|
currentTimeOverride: currentTime,
|
|
authoredHtml,
|
|
});
|
|
if (result === "applied") return;
|
|
trackStudioEvent("gsap_soft_reload_outcome", {
|
|
origin,
|
|
result,
|
|
escalated: result === "cannot-soft-reload",
|
|
});
|
|
// PERMANENT failure: the preview can't be soft-updated → full reload. TRANSIENT
|
|
// "verify-failed" is suppressed (live state is correct).
|
|
if (result === "cannot-soft-reload") reloadPreview();
|
|
}
|
|
|
|
/**
|
|
* Sync the preview after a persisted commit. For a value-only edit
|
|
* (`options.instantPatch`), try the in-place runtime patch first: on success the
|
|
* preview is already correct, so we skip the reload entirely (instant). On `false`
|
|
* — or when no `instantPatch` is supplied — fall back to the existing soft/full
|
|
* reload. Pure (no React) so `runCommit`'s preview-sync decision is unit-testable.
|
|
*/
|
|
export function applyPreviewSync(
|
|
iframe: HTMLIFrameElement | null,
|
|
result: MutationResult,
|
|
options: CommitMutationOptions,
|
|
reloadPreview: () => void,
|
|
): void {
|
|
if (options.instantPatch) {
|
|
const patched = patchRuntimeTweenInPlace(
|
|
iframe,
|
|
options.instantPatch.selector,
|
|
options.instantPatch.change,
|
|
);
|
|
// Patched in place — element is already correct on screen; no reload needed.
|
|
if (patched) return;
|
|
// The instant path couldn't patch in place — record the fallback so we can
|
|
// track how often the fast path misses before the soft/full reload below.
|
|
trackStudioEvent("gsap_instant_patch_fallback", { selector: options.instantPatch.selector });
|
|
// Fall through to the soft/full reload path below.
|
|
}
|
|
if (options.softReload && result.scriptText) {
|
|
// A soft-reloadable edit escalates to a full iframe remount ONLY on the
|
|
// PERMANENT "cannot-soft-reload" result (the preview is genuinely stale/
|
|
// broken). The TRANSIENT "verify-failed" does NOT escalate — the value is
|
|
// already correct on screen, and a remount re-flashes the WebGL context AND
|
|
// re-inlines subcomps (reverting their keyframes). The async MotionPath-plugin
|
|
// load failure escalates separately via `onAsyncFailure`.
|
|
softReloadOrEscalate(
|
|
iframe,
|
|
result.scriptText,
|
|
reloadPreview,
|
|
"preview_sync",
|
|
result.after ?? undefined,
|
|
);
|
|
} else {
|
|
reloadPreview();
|
|
}
|
|
}
|
|
|
|
// oxfmt-ignore
|
|
// fallow-ignore-next-line complexity
|
|
export function useGsapScriptCommits({ projectIdRef, activeCompPath, previewIframeRef, editHistory, domEditSaveTimestampRef, reloadPreview, onCacheInvalidate, onFileContentChanged, showToast, sdkSession, writeProjectFile, forceReloadSdkSession }: GsapScriptCommitsParams) {
|
|
// Serializer for per-key commits (options.serializeKey). Keyed by
|
|
// `gsap:${animationId}:meta`, it chains a meta commit onto the prior one for
|
|
// the same animationId so their POSTs can't interleave. Held in a ref so the
|
|
// chain survives re-renders.
|
|
const serializerRef = useRef(createKeyedSerializer());
|
|
const recordMutationEdit = useCallback(async (targetPath: string, result: MutationResult, options: CommitMutationOptions) => {
|
|
if (result.before == null || result.after == null) return;
|
|
await editHistory.recordEdit({
|
|
label: options.label,
|
|
kind: "manual",
|
|
coalesceKey: options.coalesceKey,
|
|
coalesceMs: options.coalesceMs,
|
|
files: { [targetPath]: { before: result.before, after: result.after } },
|
|
});
|
|
}, [editHistory]);
|
|
|
|
const finalizeSuccessfulMutation = useCallback(async (selection: DomEditSelection, mutation: Record<string, unknown>, targetPath: string, result: MutationResult, options: CommitMutationOptions) => {
|
|
// A no-op file write may still owe the runtime a deferred instant patch.
|
|
if (finishUnchangedMutation(previewIframeRef.current, result, options, reloadPreview)) return;
|
|
domEditSaveTimestampRef.current = Date.now();
|
|
await recordMutationEdit(targetPath, result, options);
|
|
if (result.after != null) onFileContentChanged?.(targetPath, result.after);
|
|
// Server wrote the file; the in-memory SDK doc is now stale. Resync it so a
|
|
// later SDK-routed edit doesn't serialize the pre-write doc and revert this.
|
|
forceReloadSdkSession?.();
|
|
if (options.skipReload) return;
|
|
if (result.parsed?.animations) updateKeyframeCacheFromParsed(result.parsed.animations, targetPath, selection.id ?? undefined, mutation);
|
|
refreshMutationPreview(
|
|
previewIframeRef.current,
|
|
result,
|
|
options,
|
|
reloadPreview,
|
|
onCacheInvalidate,
|
|
);
|
|
}, [previewIframeRef, domEditSaveTimestampRef, reloadPreview, onCacheInvalidate, onFileContentChanged, forceReloadSdkSession, recordMutationEdit]);
|
|
|
|
const runCommit = useCallback(async (selection: DomEditSelection, mutation: Record<string, unknown>, options: CommitMutationOptions) => {
|
|
const pid = projectIdRef.current;
|
|
if (!pid) return;
|
|
const targetPath = selection.sourceFile || activeCompPath || "index.html";
|
|
const result = await runMutationRequest([mutation], options, showToast, () =>
|
|
mutateGsapScript(pid, targetPath, mutation),
|
|
);
|
|
if (!result) return;
|
|
await finalizeSuccessfulMutation(selection, mutation, targetPath, result, options);
|
|
}, [projectIdRef, activeCompPath, showToast, finalizeSuccessfulMutation]);
|
|
|
|
const runBatchCommit = useCallback(async (calls: CommitMutationCall[], options: CommitMutationOptions) => {
|
|
const pid = projectIdRef.current;
|
|
const first = calls[0];
|
|
const last = calls.at(-1);
|
|
if (!pid || !first || !last) return;
|
|
const targetPath = first.selection.sourceFile || activeCompPath || "index.html";
|
|
const mutations = calls.map(({ mutation }) => mutation);
|
|
const result = await runMutationRequest(mutations, options, showToast, () =>
|
|
mutateGsapScriptBatch(pid, targetPath, mutations),
|
|
);
|
|
if (!result) return;
|
|
await finalizeSuccessfulMutation(last.selection, last.mutation, targetPath, result, options);
|
|
}, [projectIdRef, activeCompPath, showToast, finalizeSuccessfulMutation]);
|
|
|
|
// Every GSAP-script commit is a read-modify-write of one file. Overlapping
|
|
// commits to the SAME file (any op type, any animation) interleave server-side,
|
|
// so serialize per target file by default; an explicit serializeKey overrides.
|
|
const commitMutation = useMemo<CommitMutation>(() => {
|
|
const commit: CommitMutation = (selection, mutation, options) => {
|
|
const file = selection.sourceFile || activeCompPath || "index.html";
|
|
const key = options.serializeKey ?? `gsap-file:${file}`;
|
|
return serializerRef.current(key, () => runCommit(selection, mutation, options));
|
|
};
|
|
commit.batch = (calls, options) => {
|
|
const file = calls[0]?.selection.sourceFile || activeCompPath || "index.html";
|
|
const key = options.serializeKey ?? `gsap-file:${file}`;
|
|
return serializerRef.current(key, () => runBatchCommit(calls, options));
|
|
};
|
|
return commit;
|
|
}, [runCommit, runBatchCommit, activeCompPath]);
|
|
const trackGsapSaveFailure = useGsapSaveFailureTelemetry(activeCompPath);
|
|
const commitMutationSafely = useSafeGsapCommitMutation(commitMutation, trackGsapSaveFailure, showToast);
|
|
|
|
// One stable SDK-deps object shared by all GSAP child hooks. Memoized so the
|
|
// hooks' callbacks keep a stable identity (an inline literal here re-fired the
|
|
// property-debounce flush on every render). refresh() soft-reloads (preserving
|
|
// the playhead) and invalidates the panel cache, matching the server path.
|
|
const sdkRefresh = useCallback(
|
|
(after: string) => {
|
|
// extractGsapScriptText returns null when zero/multiple GSAP scripts are
|
|
// present — that's an ambiguous/structural change that genuinely needs a full
|
|
// reload. But a SINGLE-script soft-reloadable edit must not escalate to a full
|
|
// remount even if applySoftReload reports failure (same U4 invariant as
|
|
// applyPreviewSync): the live state is already correct, and a remount re-inlines
|
|
// subcomps + reverts their keyframes.
|
|
const script = extractGsapScriptText(after);
|
|
if (script) {
|
|
// Soft-reload in place. reloadPreview is the ASYNC-failure escalation — a
|
|
// plugin-CDN load error genuinely breaks the iframe → full reload. Per U4, a
|
|
// synchronous "verify-failed" (transient empty __timelines) does NOT escalate,
|
|
// but a "cannot-soft-reload" (structural failure) does.
|
|
softReloadOrEscalate(previewIframeRef.current, script, reloadPreview, "sdk_refresh", after);
|
|
} else {
|
|
reloadPreview();
|
|
}
|
|
onCacheInvalidate();
|
|
},
|
|
[previewIframeRef, reloadPreview, onCacheInvalidate],
|
|
);
|
|
// Reuse the SAME per-file serializer the legacy commitMutation path uses, so
|
|
// SDK gsap-write flushes serialize against legacy commits AND each other —
|
|
// overlapping same-file read-modify-writes can't interleave and lose an edit.
|
|
const serializeByFile = useCallback(
|
|
<T>(key: string, task: () => Promise<T>): Promise<T> => serializerRef.current(key, task),
|
|
[],
|
|
);
|
|
// Read the on-disk bytes of targetPath so the SDK GSAP persist captures the
|
|
// exact prior content as its undo `before` (matching the style/delete paths),
|
|
// instead of a normalized full-DOM re-emit that would reformat the whole file.
|
|
const readProjectFileContent = useCallback(
|
|
(path: string): Promise<string> => {
|
|
const pid = projectIdRef.current;
|
|
if (!pid) throw new Error("No active project");
|
|
return readSharedProjectFileContent(pid, path);
|
|
},
|
|
[projectIdRef],
|
|
);
|
|
const sdkDeps = useMemo<CutoverDeps | null>(
|
|
() =>
|
|
writeProjectFile
|
|
? {
|
|
editHistory: { recordEdit: editHistory.recordEdit },
|
|
writeProjectFile,
|
|
reloadPreview,
|
|
domEditSaveTimestampRef,
|
|
refresh: sdkRefresh,
|
|
compositionPath: activeCompPath,
|
|
serialize: serializeByFile,
|
|
readProjectFile: readProjectFileContent,
|
|
}
|
|
: null,
|
|
[
|
|
editHistory.recordEdit,
|
|
writeProjectFile,
|
|
reloadPreview,
|
|
domEditSaveTimestampRef,
|
|
sdkRefresh,
|
|
activeCompPath,
|
|
serializeByFile,
|
|
readProjectFileContent,
|
|
],
|
|
);
|
|
|
|
const propertyOps = useGsapPropertyDebounce(commitMutationSafely, {
|
|
sdkSession,
|
|
sdkDeps,
|
|
activeCompPath,
|
|
});
|
|
const animationOps = useGsapAnimationOps({
|
|
projectIdRef,
|
|
activeCompPath,
|
|
commitMutation,
|
|
commitMutationSafely,
|
|
showToast,
|
|
sdkSession,
|
|
sdkDeps,
|
|
});
|
|
const keyframeOps = useGsapKeyframeOps({
|
|
activeCompPath,
|
|
commitMutation,
|
|
commitMutationSafely,
|
|
trackGsapSaveFailure,
|
|
sdkSession,
|
|
sdkDeps,
|
|
});
|
|
const arcPathOps = useGsapArcPathOps(commitMutationSafely);
|
|
return { commitMutation, ...propertyOps, ...animationOps, ...keyframeOps, ...arcPathOps };
|
|
}
|