Skip to content

fix(studio): fail closed on backup failures #3961

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miguel-heygen merged 1 commit into from
Sep 15, 2026
+87 −11
Merged

fix(studio): fail closed on backup failures #3961

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions packages/studio-server/src/routes/files.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,27 @@ describe("registerFileRoutes", () => {
expect(readFileSync(join(projectDir, "index.html"), "utf-8")).toBe("after");
});

it("fails PUT closed when the backup cannot be created", async () => {
const projectDir = createProjectDir();
const original = "before";
writeFileSync(join(projectDir, "index.html"), original);
writeFileSync(join(projectDir, ".hyperframes"), "not a directory");
const app = new Hono();
registerFileRoutes(app, createAdapter(projectDir));

const response = await app.request("http://localhost/projects/demo/files/index.html", {
method: "PUT",
headers: { "If-Match": fileContentVersion(original) },
body: "after",
});

expect(response.status).toBe(500);
expect(await response.json()).toEqual({
error: expect.stringMatching(/^backup failed: ENOTDIR:/),
});
expect(readFileSync(join(projectDir, "index.html"), "utf-8")).toBe(original);
});

it("backs up the previous file content before delete", async () => {
const projectDir = createProjectDir();
writeFileSync(join(projectDir, "index.html"), "before delete");
Expand All @@ -501,6 +522,25 @@ describe("registerFileRoutes", () => {
expect(readFileSync(join(projectDir, payload.backupPath!), "utf-8")).toBe("before delete");
});

it("fails DELETE closed when the backup cannot be created", async () => {
const projectDir = createProjectDir();
const original = "before delete";
writeFileSync(join(projectDir, "index.html"), original);
writeFileSync(join(projectDir, ".hyperframes"), "not a directory");
const app = new Hono();
registerFileRoutes(app, createAdapter(projectDir));

const response = await app.request("http://localhost/projects/demo/files/index.html", {
method: "DELETE",
});

expect(response.status).toBe(500);
expect(await response.json()).toEqual({
error: expect.stringMatching(/^backup failed: ENOTDIR:/),
});
expect(readFileSync(join(projectDir, "index.html"), "utf-8")).toBe(original);
});

it("backs up the previous file content before structured DOM mutations", async () => {
const projectDir = createProjectDir();
writeFileSync(projectDir + "/index.html", '<div id="title">Before</div>');
Expand Down Expand Up @@ -538,6 +578,33 @@ describe("registerFileRoutes", () => {
expect(readFileSync(join(projectDir, "index.html"), "utf-8")).toContain("After");
});

it("fails structured DOM mutations closed when the backup cannot be created", async () => {
const projectDir = createProjectDir();
const original = '<div id="title">Before</div>';
writeFileSync(join(projectDir, "index.html"), original);
writeFileSync(join(projectDir, ".hyperframes"), "not a directory");
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: "text-content", property: "textContent", value: "After" }],
}),
},
);

expect(response.status).toBe(500);
expect(await response.json()).toEqual({
error: expect.stringMatching(/^backup failed: ENOTDIR:/),
});
expect(readFileSync(join(projectDir, "index.html"), "utf-8")).toBe(original);
});

it("returns the current durable version for a matched no-op element patch", async () => {
const projectDir = createProjectDir();
const original = '<div id="title">Before</div>';
Expand Down
31 changes: 20 additions & 11 deletions packages/studio-server/src/routes/files.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,9 +456,9 @@ function writeMutationResult(
filePath: string,
absPath: string,
html: string,
): { backupPath: string | null; version: string } {
): { backupPath: string | null; version: string } | Response {
const backup = snapshotBeforeWrite(projectDir, absPath);
if (backup.error) console.warn(`Failed to create backup for ${filePath}: ${backup.error}`);
if (backup.error) return c.json({ error: `backup failed: ${backup.error}` }, 500);
const { version } = writeFileWithReceipt(c, filePath, absPath, html);
return { backupPath: backupPathForResponse(projectDir, backup.backupPath), version };
}
Expand All @@ -475,7 +475,9 @@ function writeIfChanged(
if (next === original) {
return c.json({ ok: true, changed: false, content: original, path: filePath });
}
const { backupPath } = writeMutationResult(c, projectDir, filePath, absPath, next);
const mutationResult = writeMutationResult(c, projectDir, filePath, absPath, next);
if (mutationResult instanceof Response) return mutationResult;
const { backupPath } = mutationResult;
return c.json({
ok: true,
changed: true,
Expand Down Expand Up @@ -1311,13 +1313,15 @@ async function applyGsapMutations(
return c.json({ error: "file changed during GSAP mutation", conflict: true }, 409);
}
if (changed) {
backupPath = writeMutationResult(
const mutationResult = writeMutationResult(
c,
res.project.dir,
res.filePath,
res.absPath,
newHtml,
).backupPath;
);
if (mutationResult instanceof Response) return mutationResult;
backupPath = mutationResult.backupPath;
}

const responsePayload: Record<string, unknown> = {
Expand Down Expand Up @@ -2379,8 +2383,7 @@ export function registerFileRoutes(api: Hono, adapter: StudioApiAdapter): void {
);
}
backup = snapshotBeforeWrite(res.project.dir, res.absPath);
if (backup.error)
console.warn(`Failed to create backup for ${res.filePath}: ${backup.error}`);
if (backup.error) return c.json({ error: `backup failed: ${backup.error}` }, 500);
ftruncateSync(fd, 0);
writeSync(fd, body, 0, body.length, 0);
} finally {
Expand Down Expand Up @@ -2429,7 +2432,7 @@ export function registerFileRoutes(api: Hono, adapter: StudioApiAdapter): void {

const stat = statSync(res.absPath);
const backup = snapshotBeforeWrite(res.project.dir, res.absPath);
if (backup.error) console.warn(`Failed to create backup for ${res.filePath}: ${backup.error}`);
if (backup.error) return c.json({ error: `backup failed: ${backup.error}` }, 500);
if (stat.isDirectory()) {
rmSync(res.absPath, { recursive: true });
} else {
Expand Down Expand Up @@ -2766,13 +2769,15 @@ export function registerFileRoutes(api: Hono, adapter: StudioApiAdapter): void {
version,
});
}
const { version, backupPath } = writeMutationResult(
const mutationResult = writeMutationResult(
c,
ctx.project.dir,
ctx.filePath,
ctx.absPath,
result.html,
);
if (mutationResult instanceof Response) return mutationResult;
const { version, backupPath } = mutationResult;
c.header("ETag", version);
return c.json({
ok: true,
Expand Down Expand Up @@ -2825,13 +2830,15 @@ export function registerFileRoutes(api: Hono, adapter: StudioApiAdapter): void {
version,
});
}
const { backupPath, version } = writeMutationResult(
const mutationResult = writeMutationResult(
c,
ctx.project.dir,
ctx.filePath,
ctx.absPath,
patched,
);
if (mutationResult instanceof Response) return mutationResult;
const { backupPath, version } = mutationResult;
c.header("ETag", version);
return c.json({
ok: true,
Expand Down Expand Up @@ -2962,13 +2969,15 @@ export function registerFileRoutes(api: Hono, adapter: StudioApiAdapter): void {
result.error === "grouped elements must share a single parent" ? 422 : 400,
);
}
const { backupPath } = writeMutationResult(
const mutationResult = writeMutationResult(
c,
ctx.project.dir,
ctx.filePath,
ctx.absPath,
result.html,
);
if (mutationResult instanceof Response) return mutationResult;
const { backupPath } = mutationResult;
return c.json({
ok: true,
changed: true,
Expand Down
Loading