Skip to content

Write HTML. Render video. Built for agents.

fix(cli): capture keeps other screenshots when Chrome refuses one (#5739)

Miguel Ángela91903035658
diff --git a/packages/cli/src/capture/coreExtractionPhase.test.ts b/packages/cli/src/capture/coreExtractionPhase.test.ts
index bc2b9481bd..1593a3e1e5 100644
--- a/packages/cli/src/capture/coreExtractionPhase.test.ts
+++ b/packages/cli/src/capture/coreExtractionPhase.test.ts
@@ -73,12 +73,17 @@ afterEach(() => {
control.throwCatalog = false;
});
-async function extract(expireScreenshot = false) {
+const REFUSED = "Protocol error (Page.captureScreenshot): Unable to capture screenshot";
+
+/** `refuseShot`: the screenshot call (1-based) Chrome refuses. */
+async function extract(expireScreenshot = false, refuseShot?: number) {
vi.useFakeTimers();
const outputDir = mkdtempSync(join(tmpdir(), "hf-core-budget-"));
mkdirSync(join(outputDir, "extracted"));
const state = createPartialCaptureState({ url: "https://example.com", outputDir });
+ let shots = 0;
const screenshot = vi.fn(async () => {
+ if (++shots === refuseShot) throw new Error(REFUSED);
if (expireScreenshot) control.remaining = 0;
return new Uint8Array(24);
});
@@ -157,6 +162,14 @@ describe("core extraction screenshot budget", () => {
expect(screenshot).not.toHaveBeenCalled();
},
);
+ it("names the screenshot Chrome refused and keeps the rest", async () => {
+ const { result, warnings } = await extract(false, 2);
+ expect(result.screenshots).toEqual(["screenshots/scroll-000.png", "screenshots/full-page.png"]);
+ expect(warnings).toContain(
+ `2/3 requested screenshot files captured: could not capture screenshots/scroll-100.png (scrolled to 8920px): ${REFUSED}`,
+ );
+ expect(result.screenshotOutcome).toEqual({ kind: "partial", reason: "internal-error" });
+ });
it("keeps a positive partial count and names actual versus requested", async () => {
const { result, warnings } = await extract(true);
expect(result.screenshots).toHaveLength(1);
diff --git a/packages/cli/src/capture/coreExtractionPhase.ts b/packages/cli/src/capture/coreExtractionPhase.ts
index f279d01569..c9a815f6e1 100644
--- a/packages/cli/src/capture/coreExtractionPhase.ts
+++ b/packages/cli/src/capture/coreExtractionPhase.ts
@@ -332,16 +332,24 @@ export async function runCoreExtraction(input: CoreExtractionInput): Promise<Cor
maxScreenshots,
files: screenshots,
});
- if (capture.interruption || screenshots.length === 0) {
+ const failed = capture.failures.map(
+ ({ file, scrollY, message }) =>
+ `could not capture ${file}${scrollY === null ? "" : ` (scrolled to ${scrollY}px)`}: ${message}`,
+ );
+ if (capture.interruption || failed.length > 0 || screenshots.length === 0) {
recordBudget("screenshots");
const { reason, message: detail }: ScreenshotInterruption = capture.interruption ?? {
reason: "internal-error",
- message: "screenshot capture produced no files",
+ message: failed.length > 0 ? "" : "screenshot capture produced no files",
};
- const cause =
+ const cause = [
reason === "budget-exhausted"
? `--capture-budget exhausted during ${exhaustedPhase}`
- : detail;
+ : detail,
+ ...failed,
+ ]
+ .filter(Boolean)
+ .join("; ");
const message = `${screenshots.length}/${maxScreenshots} requested screenshot files captured: ${cause}`;
screenshotOutcome = {
kind: screenshots.length === 0 ? "failed" : "partial",
diff --git a/packages/cli/src/capture/screenshotCapture.test.ts b/packages/cli/src/capture/screenshotCapture.test.ts
index 5093113109..cc9dbe8632 100644
--- a/packages/cli/src/capture/screenshotCapture.test.ts
+++ b/packages/cli/src/capture/screenshotCapture.test.ts
@@ -269,6 +269,56 @@ describe("captureScrollScreenshots interruptions", () => {
});
});
+describe("captureScrollScreenshots — a shot Chrome will not take", () => {
+ const refusal = new Error(
+ "Protocol error (Page.captureScreenshot): Unable to capture screenshot",
+ );
+
+ /** 8000px page, 1080px viewport, 4 files: tiles at 0, 3780 and 6920px, then the plate. */
+ async function captureWith(screenshot: (opts?: { fullPage?: boolean }) => Promise<Buffer>) {
+ vi.useFakeTimers();
+ try {
+ const dir = tempDir("hf-scroll-refused-");
+ const { page } = fakePage({}, { screenshot: vi.fn(screenshot) });
+ const capture = captureScrollScreenshots(page, dir, { maxScreenshots: 4 });
+ await vi.runAllTimersAsync();
+ return { ...(await capture), written: readdirSync(join(dir, "screenshots")).sort() };
+ } finally {
+ vi.useRealTimers();
+ }
+ }
+
+ it("names the tile it could not take, and still takes the tiles after it and the plate", async () => {
+ let calls = 0;
+ const result = await captureWith(async () => {
+ if (++calls === 2) throw refusal;
+ return pngBuffer(1080);
+ });
+ expect(result.interruption).toBeNull();
+ expect(result.failures).toEqual([
+ { file: "screenshots/scroll-055.png", scrollY: 3780, message: refusal.message },
+ ]);
+ expect(result.files).toEqual([
+ "screenshots/scroll-000.png",
+ "screenshots/scroll-100.png",
+ "screenshots/full-page.png",
+ ]);
+ expect(result.written).toEqual(["full-page.png", "scroll-000.png", "scroll-100.png"]);
+ });
+
+ it("names the plate when only the full-page shot is refused", async () => {
+ const result = await captureWith(async (opts) => {
+ if (opts?.fullPage) throw refusal;
+ return pngBuffer(1080);
+ });
+ expect(result.interruption).toBeNull();
+ expect(result.failures).toEqual([
+ { file: "screenshots/full-page.png", scrollY: null, message: refusal.message },
+ ]);
+ expect(result.files).toHaveLength(3);
+ });
+});
+
describe("captureScrollScreenshots — capture budget", () => {
it("does not begin page work when the post-navigation budget is exhausted", async () => {
const dir = tempDir("hf-scroll-budget-");
diff --git a/packages/cli/src/capture/screenshotCapture.ts b/packages/cli/src/capture/screenshotCapture.ts
index 76c351cf04..8e74d4f8fe 100644
--- a/packages/cli/src/capture/screenshotCapture.ts
+++ b/packages/cli/src/capture/screenshotCapture.ts
@@ -8,7 +8,7 @@
import { DEFAULT_MAX_SCREENSHOTS } from "./types.js";
import { CaptureDirRefusedError } from "./captureErrors.js";
import { normalizeErrorMessage } from "../utils/errorMessage.js";
-import type { Page } from "puppeteer-core";
+import { ConnectionClosedError, type Page } from "puppeteer-core";
import { isDegradableEvaluateTimeoutError } from "./captureTimeout.js";
import { join } from "node:path";
import { ensureCaptureDirSync, writeCaptureFileSync } from "./captureFile.js";
@@ -40,9 +40,29 @@ export interface ScreenshotInterruption {
message: string;
}
+/** A shot Chrome would not take; the capture goes on to the next one. */
+export interface ScreenshotFailure {
+ file: string;
+ /** Where the page was scrolled to; null for the full-page plate. */
+ scrollY: number | null;
+ message: string;
+}
+
export interface ScreenshotCaptureResult {
files: string[];
interruption: ScreenshotInterruption | null;
+ failures: ScreenshotFailure[];
+}
+
+/** Notes one shot that failed. A timeout, a closed page or a refused output folder still ends the whole capture. */
+function shotFailure(err: unknown, file: string, scrollY: number | null): ScreenshotFailure {
+ const message = normalizeErrorMessage(err);
+ // puppeteer-core 25 exports no class for a closed page or session, only these messages.
+ const closed =
+ err instanceof ConnectionClosedError || /\b(target|session) closed\b/i.test(message);
+ if (closed || err instanceof CaptureDirRefusedError || isDegradableEvaluateTimeoutError(err))
+ throw err;
+ return { file, scrollY, message };
}
/**
@@ -149,7 +169,7 @@ export async function captureScrollScreenshots(
filePaths.length = 0;
const filenames = new Set<string>();
- const result: ScreenshotCaptureResult = { files: filePaths, interruption: null };
+ const result: ScreenshotCaptureResult = { files: filePaths, interruption: null, failures: [] };
const budgetSpent = (): boolean => {
if ((budget.remainingMs?.() ?? 1) > 0) return false;
result.interruption = {
@@ -270,7 +290,13 @@ export async function captureScrollScreenshots(
filenames.add(filename);
const filePath = join(screenshotsDir, filename);
if (budgetSpent()) break;
- const buffer = await page.screenshot({ type: "png" });
+ let buffer: Uint8Array;
+ try {
+ buffer = await page.screenshot({ type: "png" });
+ } catch (err) {
+ result.failures.push(shotFailure(err, `screenshots/${filename}`, finalPositions[i]!));
+ continue;
+ }
writeCaptureFileSync(filePath, buffer);
filePaths.push(`screenshots/${filename}`);
}
@@ -288,8 +314,11 @@ export async function captureScrollScreenshots(
const plate = await captureFullPagePlate(page, screenshotsDir, {
...budget,
files: filePaths,
+ }).catch((err: unknown) => {
+ result.failures.push(shotFailure(err, "screenshots/full-page.png", null));
+ return null;
});
- if (plate.kind === "omitted" && plate.reason === "budget-exhausted") budgetSpent();
+ if (plate?.kind === "omitted" && plate.reason === "budget-exhausted") budgetSpent();
}
} catch (err) {
if (err instanceof CaptureDirRefusedError) throw err;