single-file-cli 2.1.0 → 2.1.2

package/compile.sh

@@ -9,15 +9,14 @@ trap 'rm -rf "$stage_dir"' EXIT
 cp ./single-file ./single-file-launcher.js ./single-file-cli-api.js ./options.js ./deno.json "$stage_dir"
 cp -R ./lib "$stage_dir/lib"
 cp -R ./resources "$stage_dir/resources"
-jq 'del(.dependencies, .devDependencies)' ./package.json > "$stage_dir/package.json"
 mkdir -p "$dist_dir"
 cd "$stage_dir"
 
-deno compile --allow-read --allow-write --allow-net --allow-env --allow-run --ext=js --output="$dist_dir/single-file-aarch64-apple-darwin" --target=aarch64-apple-darwin ./single-file
-deno compile --allow-read --allow-write --allow-net --allow-env --allow-run --ext=js --output="$dist_dir/single-file-x86_64-apple-darwin" --target=x86_64-apple-darwin ./single-file
-deno compile --allow-read --allow-write --allow-net --allow-env --allow-run --ext=js --output="$dist_dir/single-file-x86_64-linux" --target=x86_64-unknown-linux-gnu ./single-file
-deno compile --allow-read --allow-write --allow-net --allow-env --allow-run --ext=js --output="$dist_dir/single-file-aarch64-linux" --target=aarch64-unknown-linux-gnu ./single-file
-deno compile --allow-all --ext=js --output="$dist_dir/single-file.exe" --target=x86_64-pc-windows-msvc --icon=./resources/single-file.ico ./single-file
+deno compile --minimum-dependency-age=0 --allow-read --allow-write --allow-net --allow-env --allow-run --ext=js --output="$dist_dir/single-file-aarch64-apple-darwin" --target=aarch64-apple-darwin ./single-file
+deno compile --minimum-dependency-age=0 --allow-read --allow-write --allow-net --allow-env --allow-run --ext=js --output="$dist_dir/single-file-x86_64-apple-darwin" --target=x86_64-apple-darwin ./single-file
+deno compile --minimum-dependency-age=0 --allow-read --allow-write --allow-net --allow-env --allow-run --ext=js --output="$dist_dir/single-file-x86_64-linux" --target=x86_64-unknown-linux-gnu ./single-file
+deno compile --minimum-dependency-age=0 --allow-read --allow-write --allow-net --allow-env --allow-run --ext=js --output="$dist_dir/single-file-aarch64-linux" --target=aarch64-unknown-linux-gnu ./single-file
+deno compile --minimum-dependency-age=0 --allow-all --ext=js --output="$dist_dir/single-file.exe" --target=x86_64-pc-windows-msvc --icon=./resources/single-file.ico ./single-file
 
 cd - > /dev/null
 

package/deno.json

@@ -1,12 +1,12 @@
 {
   "name": "@single-file/single-file-cli",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "SingleFile CLI",
   "exports": {
     ".": "./single-file-cli-api.js"
   },
   "imports": {
-    "simple-cdp": "jsr:@simple-cdp/simple-cdp@^1.10.0",
-    "path": "jsr:@std/path@^1.1.2"
+    "simple-cdp": "jsr:@simple-cdp/simple-cdp@^1.10.1",
+    "path": "jsr:@std/path@^1.1.6"
   }
 }

package/deno.lock

@@ -1,17 +1,17 @@
 {
   "version": "5",
   "specifiers": {
-    "jsr:@simple-cdp/simple-cdp@^1.10.0": "1.10.0",
+    "jsr:@simple-cdp/simple-cdp@^1.10.1": "1.10.1",
     "jsr:@std/internal@^1.0.14": "1.0.14",
-    "jsr:@std/path@^1.1.2": "1.1.6",
-    "npm:@eslint/js@^9.39.1": "9.39.5",
-    "npm:esbuild@~0.27.4": "0.27.7",
+    "jsr:@std/path@^1.1.6": "1.1.6",
+    "npm:@eslint/js@^9.39.5": "9.39.5",
+    "npm:esbuild@~0.27.7": "0.27.7",
     "npm:eslint@^10.8.1": "10.8.1",
-    "npm:simple-cdp@^1.10.0": "1.10.0"
+    "npm:simple-cdp@^1.10.1": "1.10.1"
   },
   "jsr": {
-    "@simple-cdp/simple-cdp@1.10.0": {
-      "integrity": "3f8c91e22598c3e15a680f14ee3d2aa174c21b9b528caad5ec8552e3df0c3897"
+    "@simple-cdp/simple-cdp@1.10.1": {
+      "integrity": "33c686242e812a53d13ba7fcebd18ed81b4685fb02da37c2ee6ed9a5123f9b8c"
     },
     "@std/internal@1.0.14": {
       "integrity": "291516b3d4c35024d6ffbc0a9df5bf4c64116e05b50012cf846710152d2ffdf7"
@@ -527,8 +527,8 @@
     "shebang-regex@3.0.0": {
       "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A=="
     },
-    "simple-cdp@1.10.0": {
-      "integrity": "sha512-UXDAaiges1GqNKtBy39po+CD4hXDJxQEDtR1GF9bK2J9MNN0epTo2GpoSmEc8o5ofW8dutpHafBjowEchSNgig=="
+    "simple-cdp@1.10.1": {
+      "integrity": "sha512-svGX76zc2MY2ErGAWGb9NWP9aF5XQgDyx00iqAGCgRi1qQd5MQjtBwuC7mcktliFH263gpHdnHicfsB+n7Vnyg=="
     },
     "type-check@0.4.0": {
       "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==",
@@ -558,15 +558,15 @@
   },
   "workspace": {
     "dependencies": [
-      "jsr:@simple-cdp/simple-cdp@^1.10.0",
-      "jsr:@std/path@^1.1.2"
+      "jsr:@simple-cdp/simple-cdp@^1.10.1",
+      "jsr:@std/path@^1.1.6"
     ],
     "packageJson": {
       "dependencies": [
-        "npm:@eslint/js@^9.39.1",
-        "npm:esbuild@~0.27.4",
+        "npm:@eslint/js@^9.39.5",
+        "npm:esbuild@~0.27.7",
         "npm:eslint@^10.8.1",
-        "npm:simple-cdp@^1.10.0"
+        "npm:simple-cdp@^1.10.1"
       ]
     }
   }

package/lib/browser.js

@@ -21,7 +21,7 @@
  *   Source.
  */
 
-/* global fetch */
+/* global fetch, setTimeout */
 
 import { BROWSER_PATHS, BROWSER_ARGS } from "./constants.js";
 import { Deno } from "./deno-polyfill.js";
@@ -29,10 +29,12 @@ import { Deno } from "./deno-polyfill.js";
 const NULL_STD_CONFIG = "null";
 const DEBUG_PORT_MIN = 9222;
 const DEBUG_PORT_RANGE = 256;
+const READY_TIMEOUT = 30000;
+const READY_RETRY_DELAY = 250;
 
 const { build, makeTempDir, Command, errors, remove } = Deno;
-let child, profilePath;
-export { launchBrowser, closeBrowser };
+let child, profilePath, childExited;
+export { launchBrowser, closeBrowser, browserExited };
 
 async function launchBrowser(options = {}, indexPath = 0) {
 	const executablePath = options.executablePath || BROWSER_PATHS[build.os][indexPath];
@@ -78,15 +80,58 @@ async function launchBrowser(options = {}, indexPath = 0) {
 	} catch (error) {
 		await remove(profilePath, { recursive: true }).catch(() => { });
 		profilePath = undefined;
-		if (error instanceof errors.NotFound && indexPath + 1 < BROWSER_PATHS[build.os].length) {
-			return launchBrowser(options, indexPath + 1);
+		if (error instanceof errors.NotFound) {
+			if (!options.executablePath && indexPath + 1 < BROWSER_PATHS[build.os].length) {
+				return launchBrowser(options, indexPath + 1);
+			}
+			throw new Error(options.executablePath ?
+				`The browser executable was not found at ${JSON.stringify(executablePath)}` :
+				"The browser executable was not found, use --browser-executable-path to set its location");
 		}
 		throw error;
 	}
 	child.ref();
+	childExited = false;
+	child.status.then(() => childExited = true);
+	try {
+		await waitUntilReady(debugPort);
+	} catch (error) {
+		await closeBrowser();
+		if (options.singleProcess) {
+			console.warn("Warning: the browser exited when using --browser-single-process, retrying without it"); // eslint-disable-line no-console
+			return launchBrowser(Object.assign({}, options, { singleProcess: false }), indexPath);
+		}
+		throw error;
+	}
 	return debugPort;
 }
 
+async function waitUntilReady(debugPort) {
+	const timeoutTime = Date.now() + READY_TIMEOUT;
+	while (!childExited && Date.now() < timeoutTime) {
+		try {
+			await fetch("http://localhost:" + debugPort + "/json/version");
+			return;
+		} catch {
+			await new Promise(resolve => setTimeout(resolve, READY_RETRY_DELAY));
+		}
+	}
+	throw new Error(childExited ? "The browser exited unexpectedly" : "The browser is not responding");
+}
+
+async function browserExited(maxDelay = 0) {
+	if (child === undefined) {
+		return false;
+	}
+	if (childExited || !maxDelay) {
+		return childExited;
+	}
+	return Promise.race([
+		child.status.then(() => true),
+		new Promise(resolve => setTimeout(() => resolve(childExited), maxDelay))
+	]);
+}
+
 async function getDebugPort(port = getRandomDebugPort(), usedPorts = []) {
 	try {
 		await fetch("http://localhost:" + port + "/json/version");
@@ -111,7 +156,11 @@ function getRandomDebugPort() {
 
 async function closeBrowser() {
 	if (child !== undefined) {
-		child.kill();
+		try {
+			child.kill();
+		} catch {
+			// ignored
+		}
 		await child.status;
 		child = undefined;
 	}

package/lib/cdp-client-util.js

@@ -23,6 +23,7 @@
 
 /* global setTimeout, clearTimeout, fetch, URL, Headers */
 
+import { Buffer } from "node:buffer";
 import { Deno, isDeno, path } from "./deno-polyfill.js";
 
 const ABORT_EVENT = "abort";
@@ -82,7 +83,7 @@ function waitForTimeout(abortSignal, maxDelay, errorMessage, errorCode) {
 }
 
 function arrayBufferToBase64(arrayBuffer) {
-	return new Uint8Array(arrayBuffer).toBase64();
+	return Buffer.from(arrayBuffer).toString("base64");
 }
 
 function getAlternativeUrl(url) {

package/lib/cdp-client.js

@@ -25,7 +25,8 @@
 
 import {
 	launchBrowser,
-	closeBrowser
+	closeBrowser,
+	browserExited
 } from "./browser.js";
 import {
 	CDP,
@@ -57,6 +58,10 @@ const SET_SCREENSHOT_FUNCTION_NAME = "setScreenshot";
 const SET_PDF_FUNCTION_NAME = "setPDF";
 const SET_PAGE_DATA_FUNCTION_NAME = "setPageData";
 const BINDING_CALLED_EVENT_TYPE = "bindingCalled";
+const LOCALHOST = "http://localhost:";
+const BROWSER_EXITED_MAX_DELAY = 2000;
+
+let browserOptions, relaunchBrowserPromise;
 
 export {
 	initialize,
@@ -68,8 +73,7 @@ async function initialize(singleFileOptions) {
 	if (singleFileOptions.browserServer) {
 		options.apiUrl = singleFileOptions.browserServer;
 	} else {
-		const LOCALHOST = "http://localhost:";
-		const browserOptions = {};
+		browserOptions = {};
 		browserOptions.args = singleFileOptions.browserArgs;
 		browserOptions.headless = singleFileOptions.browserHeadless;
 		browserOptions.executablePath = singleFileOptions.browserExecutablePath;
@@ -84,9 +88,21 @@ async function initialize(singleFileOptions) {
 	}
 }
 
+function relaunchBrowser() {
+	if (!relaunchBrowserPromise) {
+		console.warn("Warning: the browser exited when using --browser-single-process, retrying without it"); // eslint-disable-line no-console
+		relaunchBrowserPromise = (async () => {
+			await closeBrowser();
+			browserOptions.singleProcess = false;
+			options.apiUrl = LOCALHOST + (await launchBrowser(browserOptions));
+		})();
+	}
+	return relaunchBrowserPromise;
+}
+
 async function getPageData(options) {
 	const EMPTY_PAGE_URL = "about:blank";
-	const pageContext = { options, consoleMessages: [], debugMessages: [], httpInfo: {} };
+	const pageContext = { options, consoleMessages: [], debugMessages: [], httpInfo: {}, fetchAbortController: new AbortController() };
 	let targetInfo, cdp;
 	try {
 		logData(["Loading page", EMPTY_PAGE_URL], pageContext);
@@ -108,10 +124,14 @@ async function getPageData(options) {
 		if (shouldRetryWithFallback(error)) {
 			return await retryWithFallback();
 		}
+		if (await shouldRelaunchBrowser()) {
+			return await relaunchBrowserAndRetry();
+		}
 		attachDebugInfo(error, pageContext);
 		throw error;
 	} finally {
 		logData(["Closing page"], pageContext);
+		pageContext.fetchAbortController.abort();
 		await closeTarget();
 		logData(["Finishing"], pageContext);
 	}
@@ -131,9 +151,28 @@ async function getPageData(options) {
 		return await getPageData(options);
 	}
 
+	async function shouldRelaunchBrowser() {
+		return Boolean(browserOptions && browserOptions.singleProcess) && await browserExited(BROWSER_EXITED_MAX_DELAY);
+	}
+
+	async function relaunchBrowserAndRetry() {
+		logData(["Relaunching the browser"], pageContext);
+		targetInfo = null;
+		if (cdp) {
+			cdp.reset();
+			cdp = null;
+		}
+		await relaunchBrowser();
+		return await getPageData(options);
+	}
+
 	async function closeTarget() {
 		if (targetInfo && !options.browserDebug) {
-			await CDP.closeTarget(targetInfo.id);
+			try {
+				await CDP.closeTarget(targetInfo.id);
+			} catch {
+				// ignored
+			}
 			targetInfo = null;
 		}
 		// the connection is closed even when the target is left open for
@@ -416,14 +455,16 @@ async function loadPage({ Page, Runtime }, { options, debugMessages }) {
 			]),
 			waitForTimeout(loadTimeoutAbortSignal, options.browserLoadMaxTime, LOAD_TIMEOUT_ERROR_MESSAGE, LOAD_TIMEOUT_ERROR)
 		]);
+		// only called when the page loaded, these calls can hang forever on an
+		// unresponsive page and would mask the load timeout error
+		await Page.setLifecycleEventsEnabled({ enabled: false });
+		await Runtime.disable();
+		await Page.disable();
 		return contextId;
 	} finally {
 		if (!loadTimeoutAbortSignal.aborted) {
 			loadTimeoutAbortController.abort();
 		}
-		await Page.setLifecycleEventsEnabled({ enabled: false });
-		await Runtime.disable();
-		await Page.disable();
 	}
 }
 
@@ -533,7 +574,7 @@ function setupPageDataCapture({ Runtime }, _contextId, { options, debugMessages
 	});
 }
 
-async function setupBindings({ Page, Runtime }, contextId, { options, debugMessages }) {
+async function setupBindings({ Page, Runtime }, contextId, { options, debugMessages, fetchAbortController }) {
 	await Runtime.addBinding({ name: SET_PAGE_DATA_FUNCTION_NAME, executionContextId: contextId });
 	if (options.embedScreenshot && options.compressContent) {
 		await setupScreenshotCapture({ Page, Runtime }, contextId, { options, debugMessages });
@@ -544,7 +585,7 @@ async function setupBindings({ Page, Runtime }, contextId, { options, debugMessa
 	await Runtime.addBinding({ name: FETCH_FUNCTION_NAME, executionContextId: contextId });
 	Runtime.addEventListener(BINDING_CALLED_EVENT_TYPE, ignoringErrors(async ({ params }) => {
 		if (params.name === FETCH_FUNCTION_NAME) {
-			await handleFetchRequest({ Runtime }, params, contextId, { options, debugMessages });
+			await handleFetchRequest({ Runtime }, params, contextId, { options, debugMessages, fetchAbortController });
 		}
 	}, { options, debugMessages }));
 }
@@ -607,12 +648,12 @@ async function setupPdfCapture({ Page, Runtime }, contextId, { options, debugMes
 	}
 }
 
-async function handleFetchRequest({ Runtime }, params, contextId, { options, debugMessages }) {
+async function handleFetchRequest({ Runtime }, params, contextId, { options, debugMessages, fetchAbortController }) {
 	const { payload } = params;
 	const { requestId, url, options: fetchOptions } = JSON.parse(payload);
 	logData(["Fetching URL", url], { options, debugMessages });
 	try {
-		const response = await fetch(url, fetchOptions);
+		const response = await fetch(url, Object.assign({}, fetchOptions, { signal: fetchAbortController.signal }));
 		const arrayBuffer = await response.arrayBuffer();
 		const base64Data = arrayBufferToBase64(arrayBuffer);
 		const result = {

package/lib/deno-polyfill.js

@@ -53,6 +53,12 @@ const errors = {
 			super(message);
 			this.name = "NotFound";
 		}
+	},
+	AlreadyExists: DENO_RUNTIME_DETECTED ? Deno.errors.AlreadyExists : class AlreadyExists extends Error {
+		constructor(message) {
+			super(message);
+			this.name = "AlreadyExists";
+		}
 	}
 };
 
@@ -157,7 +163,7 @@ async function writeTextFile(path, data, options = {}) {
 		if (options.append) {
 			return fsPromise.appendFile(path, data, options);
 		} else {
-			return fsPromise.writeFile(path, data, options);
+			return nodeWriteFile(fsPromise, path, data, options);
 		}
 	}
 }
@@ -167,7 +173,18 @@ async function writeFile(path, data, options = {}) {
 		return Deno.writeFile(path, data, options);
 	} else {
 		const fsPromise = await import(NODE_MODULES["fs"]);
-		return fsPromise.writeFile(path, data, options);
+		return nodeWriteFile(fsPromise, path, data, options);
+	}
+}
+
+async function nodeWriteFile(fsPromise, path, data, options) {
+	if (options.createNew) {
+		options.flag = "wx";
+	}
+	try {
+		return await fsPromise.writeFile(path, data, options);
+	} catch (error) {
+		throw error.code == "EEXIST" ? new errors.AlreadyExists(error.message) : error;
 	}
 }
 

package/lib/version.js

@@ -1 +1 @@
-export const version = "2.1.0";
+export const version = "2.1.2";