fix(studio): export the composition the user has selected (#3550)

The header's Export button started renders with no options at all, so the
request carried no `composition` and the server fell back to index.html.
Selecting a sub-composition in the Comps panel showed its canvas and timeline
but exported the root file instead.

Studio starts renders from three controls, and the render target was owned by
each of them separately: the Renders panel resolved it, the header omitted it,
the sidebar's per-composition button named one explicitly. Give it one owner
in `startRender`, which all three route through, defaulting to the active
composition and leaving an explicit argument to win.

Fixes #3549
This commit is contained in:
Miguel Ángel
2026-08-29 13:54:27 -04:00
committed by GitHub
parent bddc9e9bba
commit b71f45981c
6 changed files with 112 additions and 28 deletions
+1 -1
View File
@@ -84,7 +84,7 @@ export function StudioApp() {
const activeCompPathRef = useRef(activeCompPath);
activeCompPathRef.current = activeCompPath;
const leftSidebarRef = useRef<LeftSidebarHandle>(null);
const renderQueue = useRenderQueue(projectId);
const renderQueue = useRenderQueue(projectId, activeCompPathRef);
const captionEditMode = useCaptionStore((s) => s.isEditMode);
const captionHasSelection = useCaptionStore((s) => s.selectedSegmentIds.size > 0);
const captionSync = useCaptionSync(projectId);
@@ -12,13 +12,8 @@ import { usePreviewVariablesStore } from "../../hooks/previewVariablesStore";
* without giving anything a second reader.
*/
export const RenderQueuePanel = memo(function RenderQueuePanel() {
const {
projectId,
activeCompPath,
compositionDimensions,
waitForPendingDomEditSaves,
renderQueue,
} = useStudioShellContext();
const { projectId, compositionDimensions, waitForPendingDomEditSaves, renderQueue } =
useStudioShellContext();
return (
<RenderQueue
@@ -36,14 +31,12 @@ export const RenderQueuePanel = memo(function RenderQueuePanel() {
onRecheckFfmpeg={renderQueue.recheckFfmpeg}
onStartRender={async (format, quality, resolution, fps) => {
await waitForPendingDomEditSaves();
const composition =
activeCompPath && activeCompPath !== "index.html" ? activeCompPath : undefined;
// No `composition`: startRender targets the active one by default.
await renderQueue.startRender({
fps,
quality,
format,
resolution,
composition,
// Render what the user is previewing: active variable overrides
// from the Variables panel ride along (undefined = defaults).
variables: usePreviewVariablesStore.getState().values ?? undefined,
@@ -49,13 +49,39 @@ export interface MountedQueue {
unmount: () => void;
}
/**
* Mounts the hook, starts one render, and returns the body of the POST it
* made — the only place Studio states what to render and who to attribute it
* to, so it is what the tests around it assert on. The caller keeps the
* returned queue to unmount it.
*/
export async function startRenderAndReadBody(
useRenderQueueHook: UseRenderQueue,
{
activeCompPath = null,
opts,
}: { activeCompPath?: string | null; opts?: Parameters<RenderQueueApi["startRender"]>[0] } = {},
): Promise<{ body: Record<string, unknown>; queue: MountedQueue }> {
const fetchMock = stubRenderFetch();
const queue = mountRenderQueue(useRenderQueueHook, "demo", activeCompPath);
await act(async () => {
await queue.api().startRender(opts);
});
const [post] = renderPosts(fetchMock) as [undefined | [string, RequestInit]];
const body = post?.[1]?.body;
if (body === undefined || body === null) throw new Error("hook made no POST with a body");
return { body: JSON.parse(String(body)) as Record<string, unknown>, queue };
}
export function mountRenderQueue(
useRenderQueueHook: UseRenderQueue,
projectId = "demo",
activeCompPath: string | null = null,
): MountedQueue {
let current: RenderQueueApi | null = null;
const activeCompPathRef = { current: activeCompPath };
function Harness(): null {
current = useRenderQueueHook(projectId);
current = useRenderQueueHook(projectId, activeCompPathRef);
return null;
}
const host = document.createElement("div");
@@ -30,7 +30,11 @@ export interface StartRenderOptions {
format?: "mp4" | "webm" | "mov";
/** `"auto"` (default) renders at the composition's authored dimensions. */
resolution?: ResolutionPreset | "auto";
/** Render a specific composition file instead of index.html. */
/**
* Render a specific composition file. Omit it to render the composition the
* user currently has open — only the sidebar's per-composition Render button
* names one, because it renders a card the user is not looking at.
*/
composition?: string;
/**
* Composition-variable overrides ({variableId: value}), forwarded to the
@@ -66,7 +70,13 @@ function writeHiddenIds(projectId: string, ids: Set<string>): void {
}
}
export function useRenderQueue(projectId: string | null) {
export function useRenderQueue(
projectId: string | null,
// A ref, not the value: the render target has to be read at click time, and
// threading the value through would rebuild every callback below on each
// composition switch.
activeCompPathRef: { current: string | null },
) {
const [jobs, setJobs] = useState<RenderJob[]>([]);
// History fetch failure — distinguished from "no renders yet" so the panel
// never shows a false empty state.
@@ -185,7 +195,13 @@ export function useRenderQueue(projectId: string | null) {
const quality = opts.quality ?? "standard";
const format = opts.format ?? "mp4";
const resolution = opts.resolution;
const composition = opts.composition;
// Which composition a render targets belongs here, with the same
// argument the FFmpeg gate above makes: Studio starts renders from three
// controls, and a default living in one of them leaves the others
// exporting a file the user is not looking at. The header's Export
// passed no options at all, so every render it started went to
// index.html no matter which composition was selected (#3549).
const composition = opts.composition ?? activeCompPathRef.current ?? undefined;
trackStudioRenderStart({
fps,
@@ -344,7 +360,7 @@ export function useRenderQueue(projectId: string | null) {
return jobId;
},
[projectId, closeActiveEventSource, addSessionJob, ffmpeg, ffmpegMissing],
[projectId, activeCompPathRef, closeActiveEventSource, addSessionJob, ffmpeg, ffmpegMissing],
);
// Cancel an in-flight render. The job row stays (as "cancelled") so the
@@ -0,0 +1,55 @@
// @vitest-environment happy-dom
// The render POST is the only place Studio says WHICH file to render. When it
// says nothing the server falls back to index.html, so a caller that forgets
// the field does not fail — it silently exports the wrong video (#3549). The
// default therefore lives in startRender, which every control routes through.
import { afterEach, describe, expect, it, vi } from "vitest";
import { startRenderAndReadBody, type MountedQueue } from "./renderQueueTestHarness";
vi.mock("../../telemetry/policy", () => ({ browserTelemetryAllowed: () => false }));
vi.mock("../../telemetry/config", () => ({ getAnonymousId: () => "unused" }));
vi.mock("../../telemetry/events", () => ({ trackStudioRenderStart: vi.fn() }));
const { useRenderQueue } = await import("./useRenderQueue");
let queue: MountedQueue | null = null;
/** Body of the render POST, started with `opts` while `activeCompPath` is open. */
async function renderBody(
activeCompPath: string | null,
opts?: Parameters<ReturnType<typeof useRenderQueue>["startRender"]>[0],
): Promise<Record<string, unknown>> {
const started = await startRenderAndReadBody(useRenderQueue, { activeCompPath, opts });
queue = started.queue;
return started.body;
}
afterEach(() => {
queue?.unmount();
queue = null;
document.body.innerHTML = "";
vi.unstubAllGlobals();
});
describe("render target composition", () => {
it("renders the composition the user has selected when the caller names none", async () => {
// The header's Export button: no options at all.
const body = await renderBody("parts/part-1.html", undefined);
expect(body["composition"]).toBe("parts/part-1.html");
});
it("keeps the caller's composition when one is named", async () => {
// The sidebar's per-composition Render button renders a card the user is
// not looking at, so its argument must win over the active composition.
const body = await renderBody("parts/part-1.html", { composition: "parts/part-4.html" });
expect(body["composition"]).toBe("parts/part-4.html");
});
it("omits the composition when nothing is selected", async () => {
// Master view. The server's index.html fallback is the right answer here.
const body = await renderBody(null, { format: "mp4" });
expect(body["composition"]).toBeUndefined();
});
});
@@ -7,9 +7,8 @@
// install id rather than the user's, which is worse than attributing it
// correctly.
import { act } from "react";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { mountRenderQueue, renderPosts, stubRenderFetch } from "./renderQueueTestHarness";
import { startRenderAndReadBody, type MountedQueue } from "./renderQueueTestHarness";
const policyState = { allowed: true };
const mintCalls = vi.fn(() => "browser-user-123");
@@ -26,20 +25,15 @@ vi.mock("../../telemetry/events", () => ({
const { useRenderQueue } = await import("./useRenderQueue");
let queue: ReturnType<typeof mountRenderQueue> | null = null;
let queue: MountedQueue | null = null;
/** Body of the POST the hook makes when a render is started. */
async function startRenderBody(): Promise<Record<string, unknown>> {
const fetchMock = stubRenderFetch();
queue = mountRenderQueue(useRenderQueue);
await act(async () => {
await queue?.api().startRender({ fps: 30, quality: "standard", format: "mp4" });
const started = await startRenderAndReadBody(useRenderQueue, {
opts: { fps: 30, quality: "standard", format: "mp4" },
});
const [post] = renderPosts(fetchMock) as [undefined | [string, RequestInit]];
const body = post?.[1]?.body;
if (body === undefined || body === null) throw new Error("hook made no POST with a body");
return JSON.parse(String(body)) as Record<string, unknown>;
queue = started.queue;
return started.body;
}
beforeEach(() => {