fix(studio): reject unsafe keyframe values (#1389)

This commit is contained in:
Miguel Ángel
2026-06-12 22:48:19 -04:00
committed by GitHub
parent ab7f69c1f5
commit 3bcab3dc29
10 changed files with 372 additions and 43 deletions
@@ -0,0 +1,41 @@
import { describe, expect, it } from "vitest";
import { findUnsafeDomPatchValues, findUnsafeMutationValues } from "./finiteMutation";
describe("finiteMutation", () => {
it("reports non-finite numbers before mutation serialization", () => {
expect(
findUnsafeMutationValues({
type: "set-arc-path",
segments: [{ curviness: Number.NaN, cp1: { x: Infinity, y: 0 } }],
}).map((field) => field.path),
).toEqual(["body.segments[0].curviness", "body.segments[0].cp1.x"]);
});
it("treats null as unsafe because JSON serializes NaN and Infinity to null", () => {
expect(
findUnsafeMutationValues({
type: "update-property",
property: "x",
value: null,
}),
).toEqual([{ path: "body.value", reason: "null" }]);
});
it("allows explicit DOM patch value removals while rejecting unsafe patch metadata", () => {
expect(
findUnsafeDomPatchValues({
target: { id: "title", selectorIndex: null },
operations: [{ type: "inline-style", property: "opacity", value: null }],
}),
).toEqual([{ path: "body.target.selectorIndex", reason: "null" }]);
});
it("rejects non-finite DOM patch values before JSON serialization can turn them into null", () => {
expect(
findUnsafeDomPatchValues({
target: { id: "title" },
operations: [{ type: "inline-style", property: "left", value: Number.NaN }],
}),
).toEqual([{ path: "body.operations[0].value", reason: "non-finite-number" }]);
});
});
@@ -0,0 +1,38 @@
export interface UnsafeMutationValue {
path: string;
reason: "non-finite-number" | "null";
}
interface FindUnsafeMutationValuesOptions {
allowNullPath?: (path: string) => boolean;
}
export function findUnsafeMutationValues(
value: unknown,
path = "body",
options: FindUnsafeMutationValuesOptions = {},
): UnsafeMutationValue[] {
if (value === null) {
return options.allowNullPath?.(path) ? [] : [{ path, reason: "null" }];
}
if (typeof value === "number") {
return Number.isFinite(value) ? [] : [{ path, reason: "non-finite-number" }];
}
if (!value || typeof value !== "object") return [];
if (Array.isArray(value)) {
return value.flatMap((item, index) =>
findUnsafeMutationValues(item, `${path}[${index}]`, options),
);
}
return Object.entries(value).flatMap(([key, item]) =>
findUnsafeMutationValues(item, `${path}.${key}`, options),
);
}
const DOM_PATCH_NULL_VALUE_PATH = /^body\.operations\[\d+\]\.value$/;
export function findUnsafeDomPatchValues(value: unknown): UnsafeMutationValue[] {
return findUnsafeMutationValues(value, "body", {
allowNullPath: (path) => DOM_PATCH_NULL_VALUE_PATH.test(path),
});
}
@@ -19,18 +19,21 @@ function createProjectDir(): string {
}
describe("walkDir", () => {
it("hides internal HyperFrames backup files from project listings", () => {
it("hides internal HyperFrames files from project listings", () => {
const projectDir = createProjectDir();
mkdirSync(join(projectDir, ".hyperframes", "backup"), { recursive: true });
mkdirSync(join(projectDir, ".hyperframes", "examples"), { recursive: true });
mkdirSync(join(projectDir, ".cache", "examples"), { recursive: true });
mkdirSync(join(projectDir, "compositions"), { recursive: true });
writeFileSync(join(projectDir, ".hyperframes", "backup", "snapshot.html"), "backup");
writeFileSync(join(projectDir, ".hyperframes", "examples", "preset.html"), "preset");
writeFileSync(join(projectDir, ".cache", "examples", "preset.html"), "preset");
writeFileSync(join(projectDir, "compositions", "scene.html"), "scene");
expect(walkDir(projectDir)).toEqual([
".hyperframes/examples/preset.html",
"compositions/scene.html",
]);
const files = walkDir(projectDir);
expect(files).toContain(".cache/examples/preset.html");
expect(files).toContain("compositions/scene.html");
expect(files).not.toContain(".hyperframes/backup/snapshot.html");
expect(files).not.toContain(".hyperframes/examples/preset.html");
});
});
@@ -7,11 +7,7 @@ export function isSafePath(base: string, resolved: string): boolean {
return resolved.startsWith(norm) || resolved === resolve(base);
}
const IGNORE_DIRS = new Set([".thumbnails", "node_modules", ".git"]);
function shouldIgnoreDir(rel: string): boolean {
return rel === ".hyperframes/backup";
}
const IGNORE_DIRS = new Set([".thumbnails", ".hyperframes", "node_modules", ".git"]);
/**
* True when any directory segment of a relative path is a dot-directory or
@@ -30,7 +26,7 @@ export function walkDir(dir: string, prefix = ""): string[] {
const files: string[] = [];
for (const entry of readdirSync(dir, { withFileTypes: true })) {
const rel = prefix ? `${prefix}/${entry.name}` : entry.name;
if (IGNORE_DIRS.has(entry.name) || shouldIgnoreDir(rel)) continue;
if (IGNORE_DIRS.has(entry.name)) continue;
if (entry.isDirectory()) {
files.push(...walkDir(join(dir, entry.name), rel));
} else {
@@ -239,6 +239,86 @@ tl.fromTo("#box", { opacity: 0, x: -50 }, { opacity: 1, x: 0, duration: 1.5, eas
expect(result.parsed.animations[0].fromProperties?.x).toBe(-50);
});
it("rejects serialized non-finite mutation values before writing source", async () => {
const projectDir = createProjectDir();
writeHtml(projectDir, "comp.html", FROMTO_COMP);
const app = new Hono();
registerFileRoutes(app, createAdapter(projectDir));
const anim = await getFirstAnimation(app, "comp.html");
const before = readFileSync(join(projectDir, "comp.html"), "utf-8");
const res = await app.request("http://localhost/projects/demo/gsap-mutations/comp.html", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
type: "update-property",
animationId: anim.id,
property: "x",
value: Number.NaN,
}),
});
const payload = (await res.json()) as { error?: string; fields?: string[] };
expect(res.status).toBe(400);
expect(payload.error).toContain("unsafe values");
expect(payload.fields).toContain("body.value");
expect(readFileSync(join(projectDir, "comp.html"), "utf-8")).toBe(before);
});
it("rejects unsafe DOM patch metadata before writing source", async () => {
const projectDir = createProjectDir();
writeFileSync(join(projectDir, "index.html"), '<div id="title">Before</div>');
const app = new Hono();
registerFileRoutes(app, createAdapter(projectDir));
const response = await app.request(
"http://localhost/projects/demo/file-mutations/patch-element/index.html",
{
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
target: { id: "title", selectorIndex: Number.NaN },
operations: [{ type: "text-content", property: "textContent", value: "After" }],
}),
},
);
const payload = (await response.json()) as { error?: string; fields?: string[] };
expect(response.status).toBe(400);
expect(payload.error).toContain("unsafe values");
expect(payload.fields).toContain("body.target.selectorIndex");
expect(readFileSync(join(projectDir, "index.html"), "utf-8")).toBe(
'<div id="title">Before</div>',
);
});
it("allows DOM patch null values used for explicit style removals", async () => {
const projectDir = createProjectDir();
writeFileSync(
join(projectDir, "index.html"),
'<div id="title" style="opacity: 1">Before</div>',
);
const app = new Hono();
registerFileRoutes(app, createAdapter(projectDir));
const response = await app.request(
"http://localhost/projects/demo/file-mutations/patch-element/index.html",
{
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
target: { id: "title" },
operations: [{ type: "inline-style", property: "opacity", value: null }],
}),
},
);
const payload = (await response.json()) as { changed?: boolean; content?: string };
expect(response.status).toBe(200);
expect(payload.changed).toBe(true);
expect(payload.content).not.toContain("opacity");
});
it("update-from-property returns 400 for a non-fromTo animation", async () => {
const projectDir = createProjectDir();
const TO_COMP = `<!DOCTYPE html><html><body><script data-hyperframes-gsap>
@@ -18,6 +18,11 @@ import { generateWaveformCache } from "../helpers/waveform.js";
import { validateUploadedMediaBuffer } from "../helpers/mediaValidation.js";
import { isSafePath } from "../helpers/safePath.js";
import { backupPathForResponse, snapshotBeforeWrite } from "../helpers/backupJournal.js";
import {
findUnsafeDomPatchValues,
findUnsafeMutationValues,
type UnsafeMutationValue,
} from "../helpers/finiteMutation.js";
import type { GsapAnimation } from "../../parsers/gsapSerialize.js";
import {
removeElementFromHtml,
@@ -116,6 +121,20 @@ function writeIfChanged(
});
}
function rejectUnsafeMutationValues(
c: RouteContext,
unsafeFields: UnsafeMutationValue[],
): Response {
return c.json(
{
error: "mutation contains unsafe values",
fields: unsafeFields.map((field) => field.path),
unsafeValues: unsafeFields,
},
400,
);
}
/**
* Parse the request body and validate that `target` is present.
* Returns `{ error }` if missing, or `{ target, body }` for the full parsed body.
@@ -951,6 +970,10 @@ export function registerFileRoutes(api: Hono, adapter: StudioApiAdapter): void {
if (!Array.isArray(parsed.body.operations) || parsed.body.operations.length === 0) {
return c.json({ error: "target and operations required" }, 400);
}
const unsafeFields = findUnsafeDomPatchValues(parsed.body);
if (unsafeFields.length > 0) {
return rejectUnsafeMutationValues(c, unsafeFields);
}
let originalContent: string;
try {
@@ -1125,6 +1148,10 @@ export function registerFileRoutes(api: Hono, adapter: StudioApiAdapter): void {
if (!body || !body.type) {
return c.json({ error: "mutation type required" }, 400);
}
const unsafeFields = findUnsafeMutationValues(body);
if (unsafeFields.length > 0) {
return rejectUnsafeMutationValues(c, unsafeFields);
}
let html = readFileSync(res.absPath, "utf-8");
let block = extractGsapScriptBlock(html);