Skip to content

Commit f1655b9

Browse files
fix(studio): honor selected render resolution (#2876)
1 parent 0d42d65 commit f1655b9

5 files changed

Lines changed: 146 additions & 39 deletions

File tree

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
// @vitest-environment happy-dom
2+
3+
import { act } from "react";
4+
import { createRoot, type Root } from "react-dom/client";
5+
import { afterEach, describe, expect, it, vi } from "vitest";
6+
import { RenderQueue } from "./RenderQueue";
7+
8+
Object.assign(globalThis, { IS_REACT_ACT_ENVIRONMENT: true });
9+
10+
let root: Root | null = null;
11+
12+
afterEach(() => {
13+
if (root) act(() => root?.unmount());
14+
root = null;
15+
document.body.innerHTML = "";
16+
});
17+
18+
function mountRenderQueue(onStartRender: ReturnType<typeof vi.fn>) {
19+
const host = document.createElement("div");
20+
document.body.append(host);
21+
root = createRoot(host);
22+
act(() => {
23+
root?.render(
24+
<RenderQueue
25+
jobs={[]}
26+
projectId="demo"
27+
onDelete={vi.fn()}
28+
onClearCompleted={vi.fn()}
29+
onStartRender={onStartRender}
30+
isRendering={false}
31+
compositionDimensions={{ width: 1920, height: 1080 }}
32+
/>,
33+
);
34+
});
35+
return host;
36+
}
37+
38+
describe("RenderQueue resolution submission", () => {
39+
it("submits the canonical landscape 4K preset selected by the user", () => {
40+
const onStartRender = vi.fn();
41+
const host = mountRenderQueue(onStartRender);
42+
const resolutionSelect = [...host.querySelectorAll("select")].find((select) =>
43+
[...select.options].some((option) => option.textContent?.startsWith("4K")),
44+
);
45+
if (!resolutionSelect) throw new Error("resolution selector did not render");
46+
47+
act(() => {
48+
resolutionSelect.value = "4k";
49+
resolutionSelect.dispatchEvent(new Event("change", { bubbles: true }));
50+
});
51+
52+
const exportButton = [...host.querySelectorAll("button")].find(
53+
(button) => button.textContent === "Export",
54+
);
55+
if (!exportButton) throw new Error("export button did not render");
56+
act(() => {
57+
exportButton.dispatchEvent(new MouseEvent("click", { bubbles: true }));
58+
});
59+
60+
expect(onStartRender).toHaveBeenCalledWith("mp4", "standard", "landscape-4k", 30);
61+
});
62+
});

‎packages/studio/src/components/renders/RenderQueue.tsx‎

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { memo, useState, useRef, useEffect, useId } from "react";
2+
import { CANVAS_DIMENSIONS } from "@hyperframes/parsers";
23
import { RenderQueueItem } from "./RenderQueueItem";
34
import { Button } from "../ui/Button";
45
import type { RenderJob, ResolutionPreset } from "./useRenderQueue";
@@ -53,17 +54,6 @@ const SCALE_LABEL: Record<RenderScale, string> = {
5354
"4k": "4K",
5455
};
5556

56-
// Mirrors `CANVAS_DIMENSIONS` in @hyperframes/core. Studio can't import from
57-
// the core barrel (it transitively pulls in node:fs) and the values are stable.
58-
const CANVAS_DIMENSIONS: Record<ResolutionPreset, CompositionDimensions> = {
59-
landscape: { width: 1920, height: 1080 },
60-
portrait: { width: 1080, height: 1920 },
61-
"landscape-4k": { width: 3840, height: 2160 },
62-
"portrait-4k": { width: 2160, height: 3840 },
63-
square: { width: 1080, height: 1080 },
64-
"square-4k": { width: 2160, height: 2160 },
65-
};
66-
6757
type CompAspect = "landscape" | "portrait" | "square";
6858

6959
function compAspect(dims: CompositionDimensions | null | undefined): CompAspect {
@@ -254,7 +244,7 @@ function FormatExportButton({
254244
const persisted = getPersistedRenderSettings();
255245
const [format, setFormat] = useState<"mp4" | "webm" | "mov">(persisted.format);
256246
const [quality, setQuality] = useState<"draft" | "standard" | "high">(persisted.quality);
257-
const [resolution, setResolution] = useState<ResolutionPreset | "auto">("auto");
247+
const [resolution, setResolution] = useState<RenderScale>("auto");
258248
const [fps, setFps] = useState<24 | 30 | 60>(persisted.fps);
259249

260250
// MOV (ProRes) is a fixed-quality codec — quality selector has no effect.
@@ -290,7 +280,7 @@ function FormatExportButton({
290280
<span className="text-[10px] text-panel-text-4">Resolution</span>
291281
<select
292282
value={resolution}
293-
onChange={(e) => setResolution(e.target.value as ResolutionPreset | "auto")}
283+
onChange={(e) => setResolution(e.target.value as RenderScale)}
294284
disabled={isRendering}
295285
className={selectCls}
296286
>
@@ -352,8 +342,9 @@ function FormatExportButton({
352342
// loading already disables the button; this guard also stops a
353343
// double-click in the same frame from enqueueing two renders.
354344
if (isRendering) return;
355-
trackStudioEvent("render_start", { format, quality, resolution, fps });
356-
void onStartRender(format, quality, resolution, fps);
345+
const outputResolution = resolveResolution(resolution, compositionDimensions);
346+
trackStudioEvent("render_start", { format, quality, resolution: outputResolution, fps });
347+
void onStartRender(format, quality, outputResolution, fps);
357348
}}
358349
className="w-full text-[11px] font-semibold"
359350
>

‎packages/studio/src/components/renders/useRenderQueue.ts‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { useState, useEffect, useCallback, useRef, useMemo } from "react";
2+
import type { CanvasResolution } from "@hyperframes/parsers";
23
import { trackStudioRenderStart } from "../../telemetry/events";
34
import { getAnonymousId } from "../../telemetry/config";
45
import { generateId } from "../../utils/generateId";
@@ -14,17 +15,10 @@ export interface RenderJob {
1415
durationMs?: number;
1516
}
1617

17-
// Mirrors `CanvasResolution` from @hyperframes/core. Kept local because
18-
// studio's tsconfig doesn't include node types, and the core barrel
19-
// transitively pulls in modules with `node:fs` imports. Drift risk is
20-
// low (6 string literals kept in sync manually with CANVAS_DIMENSIONS).
21-
export type ResolutionPreset =
22-
| "landscape"
23-
| "portrait"
24-
| "landscape-4k"
25-
| "portrait-4k"
26-
| "square"
27-
| "square-4k";
18+
// The CLI consumes this same source through @hyperframes/core's re-export.
19+
// Importing from the browser-safe parsers package avoids the core barrel's
20+
// Node-only transitive modules without duplicating the preset union in Studio.
21+
export type ResolutionPreset = CanvasResolution;
2822

2923
export interface StartRenderOptions {
3024
fps?: number;
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
import { beforeEach, describe, expect, it, vi } from "vitest";
2+
3+
const launch = vi.fn();
4+
5+
vi.mock("puppeteer-core", () => ({
6+
default: { launch },
7+
}));
8+
9+
describe("generateThumbnail", () => {
10+
beforeEach(() => {
11+
launch.mockReset();
12+
launch.mockRejectedValue(new Error("browser launch failed"));
13+
});
14+
15+
it("contains browser launch failures and retries them on the next request", async () => {
16+
const { generateThumbnail } = await import("./vite.browser");
17+
const options = {
18+
project: { dir: "/tmp/hyperframes-thumbnail-test" },
19+
compPath: "index.html",
20+
seekTime: 0.5,
21+
previewUrl: "http://localhost/preview",
22+
width: 1920,
23+
height: 1080,
24+
format: "jpeg" as const,
25+
};
26+
27+
await expect(generateThumbnail(options)).resolves.toBeNull();
28+
await expect(generateThumbnail({ ...options, seekTime: 1 })).resolves.toBeNull();
29+
30+
expect(launch).toHaveBeenCalledTimes(2);
31+
});
32+
});
33+
34+
describe("findSystemChrome", () => {
35+
it("uses the CLI browser override before legacy producer and system paths", async () => {
36+
const { findSystemChrome } = await import("./vite.browser");
37+
const pathExists = vi.fn(() => true);
38+
39+
expect(
40+
findSystemChrome(
41+
{
42+
HYPERFRAMES_BROWSER_PATH: "/custom/browser",
43+
PRODUCER_HEADLESS_SHELL_PATH: "/legacy/browser",
44+
},
45+
pathExists,
46+
),
47+
).toBe("/custom/browser");
48+
expect(pathExists).toHaveBeenCalledTimes(1);
49+
});
50+
});

‎packages/studio/vite.browser.ts‎

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,22 @@ const CHROME_PATHS = [
2020
"/usr/bin/chromium-browser",
2121
];
2222

23+
/** Resolve the same explicit browser overrides used by the CLI before system paths. */
24+
export function findSystemChrome(
25+
env: NodeJS.ProcessEnv = process.env,
26+
pathExists: (path: string) => boolean = existsSync,
27+
): string | undefined {
28+
const override = env["HYPERFRAMES_BROWSER_PATH"] ?? env["PRODUCER_HEADLESS_SHELL_PATH"];
29+
if (override && pathExists(override)) return override;
30+
return CHROME_PATHS.find((path) => pathExists(path));
31+
}
32+
2333
async function getSharedBrowser(): Promise<import("puppeteer-core").Browser | null> {
2434
if (_browser?.connected) return _browser;
2535
if (_browserLaunchPromise) return _browserLaunchPromise;
26-
_browserLaunchPromise = (async () => {
36+
const launchPromise = (async () => {
2737
const puppeteer = await import("puppeteer-core");
28-
const executablePath = CHROME_PATHS.find((p) => existsSync(p));
38+
const executablePath = findSystemChrome();
2939
if (!executablePath) return null;
3040
_browser = await puppeteer.default.launch({
3141
headless: true,
@@ -40,15 +50,14 @@ async function getSharedBrowser(): Promise<import("puppeteer-core").Browser | nu
4050
"--enable-unsafe-swiftshader",
4151
],
4252
});
43-
_browserLaunchPromise = null;
4453
return _browser;
4554
})();
46-
return _browserLaunchPromise;
47-
}
48-
49-
/** The system Chrome executable path (undefined if not found). */
50-
export function findSystemChrome(): string | undefined {
51-
return CHROME_PATHS.find((p) => existsSync(p));
55+
_browserLaunchPromise = launchPromise;
56+
try {
57+
return await launchPromise;
58+
} finally {
59+
if (_browserLaunchPromise === launchPromise) _browserLaunchPromise = null;
60+
}
5261
}
5362

5463
// In-flight thumbnail dedup
@@ -121,10 +130,10 @@ export async function generateThumbnail(opts: GenerateThumbnailOptions): Promise
121130
let bufferPromise = _thumbnailInflight.get(cacheKey);
122131
if (!bufferPromise) {
123132
bufferPromise = (async () => {
124-
const browser = await getSharedBrowser();
125-
if (!browser) return null;
126-
let page: Awaited<ReturnType<typeof browser.newPage>> | null = null;
133+
let page: Awaited<ReturnType<import("puppeteer-core").Browser["newPage"]>> | null = null;
127134
try {
135+
const browser = await getSharedBrowser();
136+
if (!browser) return null;
128137
page = await browser.newPage();
129138
await page.setViewport({
130139
width: opts.width,
@@ -196,7 +205,8 @@ export async function generateThumbnail(opts: GenerateThumbnailOptions): Promise
196205
}
197206
})();
198207
_thumbnailInflight.set(cacheKey, bufferPromise);
199-
bufferPromise.finally(() => _thumbnailInflight.delete(cacheKey));
208+
const clearInflight = () => _thumbnailInflight.delete(cacheKey);
209+
bufferPromise.then(clearInflight, clearInflight);
200210
}
201211
return bufferPromise;
202212
}

0 commit comments

Comments
 (0)