@browserbasehq/orca 3.1.0-patch.4 → 3.2.0-preview.2

package/dist/esm/lib/v3/understudy/page.js

@@ -34,7 +34,7 @@ var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn,
 };
 import { promises as fs } from "fs";
 import { v3Logger } from "../logger.js";
-import { logAction } from "../flowLogger.js";
+import { FlowLogger } from "../flowLogger.js";
 import { Frame } from "./frame.js";
 import { FrameLocator } from "./frameLocator.js";
 import { deepLocatorFromPage, resolveLocatorTarget } from "./deepLocator.js";
@@ -46,11 +46,12 @@ import { LifecycleWatcher } from "./lifecycleWatcher.js";
 import { NavigationResponseTracker } from "./navigationResponseTracker.js";
 import { Response, isSerializableResponse } from "./response.js";
 import { ConsoleMessage } from "./consoleMessage.js";
-import { StagehandSnapshotError, } from "../types/public/index.js";
+import { StagehandSetExtraHTTPHeadersError, StagehandSnapshotError, } from "../types/public/index.js";
 import { StagehandInvalidArgumentError, StagehandEvalError, } from "../types/public/sdkErrors.js";
 import { normalizeInitScriptSource } from "./initScripts.js";
 import { buildLocatorInvocation } from "./locatorInvocation.js";
-import { applyMaskOverlays, applyStyleToFrames, collectFramesForScreenshot, computeScreenshotScale, disableAnimations, hideCaret, normalizeScreenshotClip, runScreenshotCleanups, setTransparentBackground, withScreenshotTimeout, } from "./screenshotUtils.js";
+import { applyMaskOverlays, applyStyleToFrames, collectFramesForScreenshot, computeScreenshotScale, disableAnimations, hideCaret, normalizeScreenshotClip, runScreenshotCleanups, setTransparentBackground, } from "./screenshotUtils.js";
+import { withTimeout } from "../timeoutConfig.js";
 /**
  * Page
  *
@@ -90,22 +91,37 @@ let Page = (() => {
     return class Page {
         static {
             const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
-            _close_decorators = [logAction("Page.close")];
-            _goto_decorators = [logAction("Page.goto")];
-            _reload_decorators = [logAction("Page.reload")];
-            _goBack_decorators = [logAction("Page.goBack")];
-            _goForward_decorators = [logAction("Page.goForward")];
-            _screenshot_decorators = [logAction("Page.screenshot")];
-            _waitForLoadState_decorators = [logAction("Page.waitForLoadState")];
-            _waitForSelector_decorators = [logAction("Page.waitForSelector")];
-            _evaluate_decorators = [logAction("Page.evaluate")];
-            _click_decorators = [logAction("Page.click")];
-            _hover_decorators = [logAction("Page.hover")];
-            _scroll_decorators = [logAction("Page.scroll")];
-            _dragAndDrop_decorators = [logAction("Page.dragAndDrop")];
-            _type_decorators = [logAction("Page.type")];
-            _keyPress_decorators = [logAction("Page.keyPress")];
-            _snapshot_decorators = [logAction("Page.snapshot")];
+            _close_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageClose", eventIdSuffix: "5" })];
+            _goto_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageGoto", eventIdSuffix: "5" })];
+            _reload_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageReload", eventIdSuffix: "5" })];
+            _goBack_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageGoBack", eventIdSuffix: "5" })];
+            _goForward_decorators = [FlowLogger.wrapWithLogging({
+                    eventType: "PageGoForward",
+                    eventIdSuffix: "5",
+                })];
+            _screenshot_decorators = [FlowLogger.wrapWithLogging({
+                    eventType: "PageScreenshot",
+                    eventIdSuffix: "5",
+                })];
+            _waitForLoadState_decorators = [FlowLogger.wrapWithLogging({
+                    eventType: "PageWaitForLoadState",
+                    eventIdSuffix: "5",
+                })];
+            _waitForSelector_decorators = [FlowLogger.wrapWithLogging({
+                    eventType: "PageWaitForSelector",
+                    eventIdSuffix: "5",
+                })];
+            _evaluate_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageEvaluate", eventIdSuffix: "5" })];
+            _click_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageClick", eventIdSuffix: "5" })];
+            _hover_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageHover", eventIdSuffix: "5" })];
+            _scroll_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageScroll", eventIdSuffix: "5" })];
+            _dragAndDrop_decorators = [FlowLogger.wrapWithLogging({
+                    eventType: "PageDragAndDrop",
+                    eventIdSuffix: "5",
+                })];
+            _type_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageType", eventIdSuffix: "5" })];
+            _keyPress_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageKeyPress", eventIdSuffix: "5" })];
+            _snapshot_decorators = [FlowLogger.wrapWithLogging({ eventType: "PageSnapshot", eventIdSuffix: "5" })];
             __esDecorate(this, null, _close_decorators, { kind: "method", name: "close", static: false, private: false, access: { has: obj => "close" in obj, get: obj => obj.close }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _goto_decorators, { kind: "method", name: "goto", static: false, private: false, access: { has: obj => "goto" in obj, get: obj => obj.goto }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _reload_decorators, { kind: "method", name: "reload", static: false, private: false, access: { has: obj => "reload" in obj, get: obj => obj.reload }, metadata: _metadata }, null, _instanceExtraInitializers);
@@ -152,6 +168,7 @@ let Page = (() => {
         consoleHandlers = new Map();
         /** Document-start scripts installed across every session this page owns. */
         initScripts = [];
+        extraHTTPHeaders;
         constructor(conn, mainSession, _targetId, mainFrameId, apiClient, browserIsRemote = false) {
             this.conn = conn;
             this.mainSession = mainSession;
@@ -305,8 +322,12 @@ let Page = (() => {
          * Assumes Page domain is already enabled on the session passed in.
          */
         static async create(conn, session, targetId, apiClient, localBrowserLaunchOptions, browserIsRemote = false) {
-            await session.send("Page.enable").catch(() => { });
-            await session
+            // Context already issues Page.enable + lifecycle enable before resume.
+            // Re-issue here only as best-effort and do not block page registration on
+            // their acknowledgements; some remote CDP backends can delay these replies
+            // long after the target is otherwise ready.
+            void session.send("Page.enable").catch(() => { });
+            void session
                 .send("Page.setLifecycleEventsEnabled", { enabled: true })
                 .catch(() => { });
             const { frameTree } = await session.send("Page.getFrameTree");
@@ -390,6 +411,8 @@ let Page = (() => {
             if (childSession.id)
                 this.sessions.set(childSession.id, childSession);
             this.networkManager.trackSession(childSession);
+            if (this.extraHTTPHeaders)
+                void this.applyExtraHTTPHeadersToSession(childSession, this.extraHTTPHeaders).catch(() => { });
             void this.applyInitScriptsToSession(childSession).catch(() => { });
             if (this.consoleListeners.size > 0) {
                 this.installConsoleTap(childSession);
@@ -576,6 +599,12 @@ let Page = (() => {
         asProtocolFrameTree(rootMainFrameId) {
             return this.registry.asProtocolFrameTree(rootMainFrameId);
         }
+        async applyExtraHTTPHeadersToSession(session, headers) {
+            await session.send("Network.enable");
+            await session.send("Network.setExtraHTTPHeaders", {
+                headers: headers,
+            });
+        }
         ensureOrdinal(frameId) {
             const hit = this.frameOrdinals.get(frameId);
             if (hit !== undefined)
@@ -952,7 +981,46 @@ let Page = (() => {
                     await runScreenshotCleanups(cleanupTasks);
                 }
             };
-            return withScreenshotTimeout(opts.timeout, exec);
+            return await withTimeout(exec(), opts.timeout, "screenshot");
+        }
+        /**
+         * specifies additional HTTP headers to be included in every request sent by
+         * the root CDP session of the page, and all of its child CDP sessions.
+         *
+         * @param headers - the headers to be set.
+         * @throws {StagehandSetExtraHTTPHeadersError}
+         * Thrown when one or more CDP sessions fail to enable the Network domain or fail
+         * to apply the headers (i.e. `Network.enable` and/or `Network.setExtraHTTPHeaders` rejects).
+         * @return void
+         */
+        async setExtraHTTPHeaders(headers) {
+            const headersToSet = { ...headers };
+            this.extraHTTPHeaders = headersToSet;
+            // get the session(s) for this page:
+            const sessions = [this.mainSession];
+            for (const session of this.sessions.values()) {
+                if (session === this.mainSession)
+                    continue;
+                sessions.push(session);
+            }
+            const results = await Promise.allSettled(sessions.map(async (session) => {
+                await this.applyExtraHTTPHeadersToSession(session, headersToSet);
+            }));
+            // get list of objects containing results & corresponding session IDs
+            const pairs = results.map((result, index) => ({
+                result,
+                id: sessions[index].id,
+            }));
+            const filtered = pairs.filter((pair) => pair.result.status === "rejected");
+            const errors = filtered.map((pair) => {
+                const reason = pair.result.reason;
+                const sessId = pair.id ?? "root";
+                const message = reason?.message ?? String(reason);
+                return `session=${sessId} error=${message}`;
+            });
+            if (errors.length > 0) {
+                throw new StagehandSetExtraHTTPHeadersError(errors);
+            }
         }
         /**
          * Create a locator bound to the current main frame.
@@ -1079,7 +1147,7 @@ let Page = (() => {
          * Force the page viewport to an exact CSS size and device scale factor.
          * Ensures screenshots match width x height pixels when deviceScaleFactor = 1.
          */
-        // @logAction("Page.setViewportSize")  // disabled because it's pretty noisy, can always re-enable if needed for debugging
+        // @FlowLogger.wrapWithLogging({ eventType: "PageSetViewportSize", eventIdSuffix: "5" })  // disabled because it's pretty noisy, can always re-enable if needed for debugging
         async setViewportSize(width, height, options) {
             const dsf = Math.max(0.01, options?.deviceScaleFactor ?? 1);
             await this.mainSession