@meltemi/diagrams-capture 1.9.0 → 1.10.0

package/dist/capture.mjs

@@ -96,7 +96,7 @@ export async function capture(jobs, options = {}) {
   if (!executable) throw new Error(NO_BROWSER);
   const session = await PipeSession.launch(executable, { timeout: options.timeout ?? 30_000 });
   try {
-    const { product } = await session.send("Browser.getVersion");
+    const { product } = await session.started();
     const results = [];
     for (const job of jobs) results.push(await captureOne(session, job));
     return { browser: product, results };

package/dist/cdp.d.mts

@@ -1,14 +1,20 @@
 /** Arguments of the headless browser. */
 export function browserArgs(profile: string): string[];
 
+/** How long a starting browser may take to answer its first call (see `started`). */
+export const STARTUP_TIMEOUT: number;
+
 /** A DevTools protocol session with a browser over a pipe. */
 export class PipeSession {
   static launch(executable: string, options?: { timeout?: number }): Promise<PipeSession>;
+  /** The browser's version once it has started, with the longer startup timeout. */
+  started(): Promise<Record<string, unknown>>;
   // Replies and events are plain JSON objects shaped by the DevTools protocol.
   send(
     method: string,
     params?: Record<string, unknown>,
     sessionId?: string,
+    timeout?: number,
   ): Promise<Record<string, unknown>>;
   waitFor(method: string, sessionId?: string): Promise<Record<string, unknown>>;
   close(): Promise<void>;

package/dist/cdp.mjs

@@ -53,6 +53,9 @@ export function browserArgs(profile) {
   ];
 }
 
+/** How long a starting browser may take to answer its first call (see `started`). */
+export const STARTUP_TIMEOUT = 120_000;
+
 export class PipeSession {
   /** Starts the browser. */
   static async launch(executable, { timeout = 30_000 } = {}) {
@@ -120,16 +123,25 @@ export class PipeSession {
     }
   }
 
-  /** Sends a command and waits for its result. */
-  send(method, params = {}, sessionId) {
+  /**
+   * Waits for the browser to have started: its version, once it answers. A first start builds the
+   * browser's caches (fonts, profile), which on a fresh or busy machine takes far longer than any
+   * later call, so it may take up to `STARTUP_TIMEOUT` (or the session's timeout, if longer).
+   */
+  started() {
+    return this.send("Browser.getVersion", {}, undefined, Math.max(this.timeout, STARTUP_TIMEOUT));
+  }
+
+  /** Sends a command and waits for its result, for `timeout` ms (the session's by default). */
+  send(method, params = {}, sessionId, timeout = this.timeout) {
     if (this.closed) return Promise.reject(new Error("The browser is closed."));
     const id = this.nextId++;
     const message = { id, method, params, ...(sessionId ? { sessionId } : {}) };
     return new Promise((resolve, reject) => {
       const timer = setTimeout(() => {
         this.pending.delete(id);
-        reject(new Error(`The browser did not answer ${method} within ${this.timeout} ms.`));
-      }, this.timeout);
+        reject(new Error(`The browser did not answer ${method} within ${timeout} ms.`));
+      }, timeout);
       this.pending.set(id, { resolve, reject, timer });
       this.child.stdio[3].write(`${JSON.stringify(message)}\0`);
     });

package/dist/video.mjs

@@ -148,7 +148,7 @@ export async function captureVideo(job, options = {}) {
   });
   const session = await PipeSession.launch(browser, { timeout: options.timeout ?? 30_000 });
   try {
-    const { product } = await session.send("Browser.getVersion");
+    const { product } = await session.started();
     const { targetId } = await session.send("Target.createTarget", { url: "about:blank" });
     const { sessionId } = await session.send("Target.attachToTarget", { targetId, flatten: true });
     await session.send("Page.enable", {}, sessionId);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meltemi/diagrams-capture",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "PNG, PDF and video captures of rendered SVG with the installed Edge, Chrome or Chromium over the DevTools protocol, and video encoding with the installed FFmpeg.",
   "license": "MIT",
   "repository": {