Skip to content

Commit 3ca71c1

Browse files
committed
fix: address PR #596 review issues (cache bypass, pool state, URL decoding)
- P1: symlink cached extraction frames into compiledDir so the served-frame fast path works when extractCacheDir is set - P2: replace raw forceKillBrowserProcess with forceReleaseBrowser that atomically clears pool state before killing the Chrome process - P3: decode percent-encoded path segments in the file server so reserved characters in video IDs round-trip correctly
1 parent 4750a98 commit 3ca71c1

7 files changed

Lines changed: 141 additions & 27 deletions

File tree

‎packages/engine/src/services/browserManager.test.ts‎

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import { describe, expect, it } from "vitest";
1+
import { describe, expect, it, vi } from "vitest";
22

3-
import { buildChromeArgs } from "./browserManager.js";
3+
import { buildChromeArgs, forceReleaseBrowser } from "./browserManager.js";
44

55
describe("buildChromeArgs browser GPU mode", () => {
66
const base = { width: 1920, height: 1080 };
@@ -46,3 +46,33 @@ describe("buildChromeArgs browser GPU mode", () => {
4646
expect(args).not.toContain("--use-angle=metal");
4747
});
4848
});
49+
50+
describe("forceReleaseBrowser", () => {
51+
it("kills the browser process and disconnects", () => {
52+
const killFn = vi.fn(() => true);
53+
const disconnectFn = vi.fn();
54+
const mockBrowser = {
55+
process: () => ({ kill: killFn, killed: false }),
56+
disconnect: disconnectFn,
57+
} as any;
58+
59+
forceReleaseBrowser(mockBrowser);
60+
61+
expect(killFn).toHaveBeenCalledWith("SIGKILL");
62+
expect(disconnectFn).toHaveBeenCalled();
63+
});
64+
65+
it("tolerates an already-killed process", () => {
66+
const killFn = vi.fn();
67+
const disconnectFn = vi.fn();
68+
const mockBrowser = {
69+
process: () => ({ kill: killFn, killed: true }),
70+
disconnect: disconnectFn,
71+
} as any;
72+
73+
forceReleaseBrowser(mockBrowser);
74+
75+
expect(killFn).not.toHaveBeenCalled();
76+
expect(disconnectFn).toHaveBeenCalled();
77+
});
78+
});

‎packages/engine/src/services/browserManager.ts‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,30 @@ export async function releaseBrowser(
234234
await browser.close().catch(() => {});
235235
}
236236

237+
export function forceReleaseBrowser(browser: Browser): void {
238+
if (pooledBrowser && pooledBrowser === browser) {
239+
pooledBrowserRefCount = 0;
240+
pooledBrowser = null;
241+
}
242+
const proc = (
243+
browser as unknown as {
244+
process?: () => { kill: (signal?: NodeJS.Signals) => boolean; killed?: boolean } | null;
245+
}
246+
).process?.();
247+
if (proc && !proc.killed) {
248+
try {
249+
proc.kill("SIGKILL");
250+
} catch {
251+
// Best-effort cleanup.
252+
}
253+
}
254+
try {
255+
browser.disconnect();
256+
} catch {
257+
// Best-effort cleanup.
258+
}
259+
}
260+
237261
export interface BuildChromeArgsOptions {
238262
width: number;
239263
height: number;

‎packages/engine/src/services/frameCapture.ts‎

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import { quantizeTimeToFrame } from "@hyperframes/core";
1616
import {
1717
acquireBrowser,
1818
releaseBrowser,
19+
forceReleaseBrowser,
1920
buildChromeArgs,
2021
resolveHeadlessShellPath,
2122
type CaptureMode,
@@ -95,27 +96,6 @@ async function waitForCloseWithTimeout(promise: Promise<unknown>): Promise<boole
9596
return !timedOut;
9697
}
9798

98-
function forceKillBrowserProcess(browser: Browser): void {
99-
const browserProcess = (
100-
browser as unknown as {
101-
process?: () => { kill: (signal?: NodeJS.Signals) => boolean; killed?: boolean } | null;
102-
}
103-
).process?.();
104-
105-
if (browserProcess && !browserProcess.killed) {
106-
try {
107-
browserProcess.kill("SIGKILL");
108-
} catch {
109-
// Best-effort cleanup after Puppeteer close has already timed out.
110-
}
111-
}
112-
try {
113-
browser.disconnect();
114-
} catch {
115-
// Best-effort cleanup after Puppeteer close has already timed out.
116-
}
117-
}
118-
11999
export async function createCaptureSession(
120100
serverUrl: string,
121101
outputDir: string,
@@ -718,7 +698,8 @@ export async function closeCaptureSession(session: CaptureSession): Promise<void
718698
const pageClosed = await waitForCloseWithTimeout(session.page.close());
719699
if (!pageClosed) {
720700
console.warn("[FrameCapture] Timed out closing page; forcing browser process shutdown");
721-
forceKillBrowserProcess(session.browser);
701+
forceReleaseBrowser(session.browser);
702+
session.browserReleased = true;
722703
}
723704
session.pageReleased = true;
724705
}
@@ -728,7 +709,7 @@ export async function closeCaptureSession(session: CaptureSession): Promise<void
728709
);
729710
if (!browserClosed) {
730711
console.warn("[FrameCapture] Timed out closing browser; forcing browser process shutdown");
731-
forceKillBrowserProcess(session.browser);
712+
forceReleaseBrowser(session.browser);
732713
}
733714
session.browserReleased = true;
734715
}

‎packages/producer/src/services/fileServer.test.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,34 @@ describe("createFileServer", () => {
189189
rmSync(workspaceDir, { recursive: true, force: true });
190190
}
191191
});
192+
193+
it("decodes percent-encoded reserved characters in URL path segments", async () => {
194+
const projectDir = mkdtempSync(join(tmpdir(), "hf-file-server-reserved-chars-"));
195+
196+
try {
197+
const subDir = join(projectDir, "video#1");
198+
mkdirSync(subDir, { recursive: true });
199+
writeFileSync(join(projectDir, "index.html"), "<!doctype html><html></html>");
200+
writeFileSync(join(subDir, "frame.jpg"), "fake-jpg");
201+
202+
const server = await createFileServer({
203+
projectDir,
204+
preHeadScripts: [],
205+
headScripts: [],
206+
bodyScripts: [],
207+
});
208+
209+
try {
210+
const res = await fetch(`${server.url}/video%231/frame.jpg`);
211+
expect(res.status).toBe(200);
212+
expect(await res.text()).toBe("fake-jpg");
213+
} finally {
214+
server.close();
215+
}
216+
} finally {
217+
rmSync(projectDir, { recursive: true, force: true });
218+
}
219+
});
192220
});
193221

194222
describe("HF_EARLY_STUB + HF_BRIDGE_SCRIPT integration", () => {

‎packages/producer/src/services/fileServer.ts‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -450,8 +450,17 @@ export function createFileServer(options: FileServerOptions): Promise<FileServer
450450
let requestPath = c.req.path;
451451
if (requestPath === "/") requestPath = "/index.html";
452452

453-
// Remove leading slash
454-
const relativePath = requestPath.replace(/^\//, "");
453+
const relativePath = requestPath
454+
.replace(/^\//, "")
455+
.split("/")
456+
.map((seg) => {
457+
try {
458+
return decodeURIComponent(seg);
459+
} catch {
460+
return seg;
461+
}
462+
})
463+
.join("/");
455464

456465
// Resolve against compiledDir first (preferred — overrides project files
457466
// for compositions emitted by the build), then projectDir as fallback.

‎packages/producer/src/services/renderOrchestrator.test.ts‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,28 @@ describe("createCompiledFrameSrcResolver", () => {
140140

141141
expect(resolver("/tmp/hf-job/video-frames/frame_00001.jpg")).toBeNull();
142142
});
143+
144+
it("resolves symlinked cache frames when materialized under compiledDir", () => {
145+
const resolver = createCompiledFrameSrcResolver("/tmp/hf-job/compiled");
146+
147+
expect(resolver("/tmp/hf-job/compiled/__hyperframes_video_frames/vid1/frame_00001.jpg")).toBe(
148+
"/__hyperframes_video_frames/vid1/frame_00001.jpg",
149+
);
150+
151+
expect(resolver("/tmp/cache/abc123/frame_00001.jpg")).toBeNull();
152+
});
153+
154+
it("encodes reserved characters in frame path segments", () => {
155+
const resolver = createCompiledFrameSrcResolver("/tmp/hf-job/compiled");
156+
157+
expect(
158+
resolver("/tmp/hf-job/compiled/__hyperframes_video_frames/video#1/frame_00001.jpg"),
159+
).toBe("/__hyperframes_video_frames/video%231/frame_00001.jpg");
160+
161+
expect(
162+
resolver("/tmp/hf-job/compiled/__hyperframes_video_frames/video?q=1/frame_00001.jpg"),
163+
).toBe("/__hyperframes_video_frames/video%3Fq%3D1/frame_00001.jpg");
164+
});
143165
});
144166

145167
describe("writeCompiledArtifacts — external assets on Windows drive-letter paths (GH #321)", () => {

‎packages/producer/src/services/renderOrchestrator.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import {
2626
writeFileSync,
2727
copyFileSync,
2828
appendFileSync,
29+
symlinkSync,
2930
} from "fs";
3031
import { parseHTML } from "linkedom";
3132
import {
@@ -2294,6 +2295,25 @@ export async function executeRenderJob(
22942295
);
22952296
assertNotAborted();
22962297

2298+
const compiledFrameRoot = join(compiledDir, "__hyperframes_video_frames");
2299+
for (const ext of extractionResult.extracted) {
2300+
const resolvedOut = resolve(ext.outputDir);
2301+
if (!resolvedOut.startsWith(resolve(compiledDir) + "/")) {
2302+
const linkPath = join(compiledFrameRoot, ext.videoId);
2303+
if (!existsSync(linkPath)) {
2304+
mkdirSync(dirname(linkPath), { recursive: true });
2305+
symlinkSync(resolvedOut, linkPath);
2306+
}
2307+
const remapped = new Map<number, string>();
2308+
for (const [idx, framePath] of ext.framePaths) {
2309+
const basename = framePath.slice(framePath.lastIndexOf("/") + 1);
2310+
remapped.set(idx, join(linkPath, basename));
2311+
}
2312+
ext.framePaths = remapped;
2313+
ext.outputDir = linkPath;
2314+
}
2315+
}
2316+
22972317
if (extractionResult.extracted.length > 0) {
22982318
frameLookup = createFrameLookupTable(composition.videos, extractionResult.extracted);
22992319
}

0 commit comments

Comments
 (0)