@checkly/playwright-core 1.51.17-beta.2 → 1.54.2-beta.0

package/lib/server/bidi/bidiChromium.js

@@ -1,125 +1,155 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var bidiChromium_exports = {};
+__export(bidiChromium_exports, {
+  BidiChromium: () => BidiChromium
 });
-exports.BidiChromium = void 0;
-var _os = _interopRequireDefault(require("os"));
-var _utils = require("../../utils");
-var _ascii = require("../utils/ascii");
-var _browserType = require("../browserType");
-var _bidiBrowser = require("./bidiBrowser");
-var _bidiConnection = require("./bidiConnection");
-var _chromiumSwitches = require("../chromium/chromiumSwitches");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the 'License');
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an 'AS IS' BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-class BidiChromium extends _browserType.BrowserType {
+module.exports = __toCommonJS(bidiChromium_exports);
+var import_os = __toESM(require("os"));
+var import_ascii = require("../utils/ascii");
+var import_browserType = require("../browserType");
+var import_bidiBrowser = require("./bidiBrowser");
+var import_bidiConnection = require("./bidiConnection");
+var import_chromiumSwitches = require("../chromium/chromiumSwitches");
+var import_chromium = require("../chromium/chromium");
+class BidiChromium extends import_browserType.BrowserType {
   constructor(parent) {
-    super(parent, 'bidi');
-    this._useBidi = true;
+    super(parent, "_bidiChromium");
   }
-  async connectToTransport(transport, options) {
-    // Chrome doesn't support Bidi, we create Bidi over CDP which is used by Chrome driver.
-    // bidiOverCdp depends on chromium-bidi which we only have in devDependencies, so
-    // we load bidiOverCdp dynamically.
-    const bidiTransport = await require('./bidiOverCdp').connectBidiOverCdp(transport);
+  async connectToTransport(transport, options, browserLogsCollector) {
+    const bidiTransport = await require("./bidiOverCdp").connectBidiOverCdp(transport);
     transport[kBidiOverCdpWrapper] = bidiTransport;
-    return _bidiBrowser.BidiBrowser.connect(this.attribution.playwright, bidiTransport, options);
+    try {
+      return import_bidiBrowser.BidiBrowser.connect(this.attribution.playwright, bidiTransport, options);
+    } catch (e) {
+      if (browserLogsCollector.recentLogs().some((log) => log.includes("Failed to create a ProcessSingleton for your profile directory."))) {
+        throw new Error(
+          "Failed to create a ProcessSingleton for your profile directory. This usually means that the profile is already in use by another instance of Chromium."
+        );
+      }
+      throw e;
+    }
   }
   doRewriteStartupLog(error) {
-    if (!error.logs) return error;
-    if (error.logs.includes('Missing X server')) error.logs = '\n' + (0, _ascii.wrapInASCIIBox)(_browserType.kNoXServerRunningError, 1);
-    // These error messages are taken from Chromium source code as of July, 2020:
-    // https://github.com/chromium/chromium/blob/70565f67e79f79e17663ad1337dc6e63ee207ce9/content/browser/zygote_host/zygote_host_impl_linux.cc
-    if (!error.logs.includes('crbug.com/357670') && !error.logs.includes('No usable sandbox!') && !error.logs.includes('crbug.com/638180')) return error;
-    error.logs = [`Chromium sandboxing failed!`, `================================`, `To avoid the sandboxing issue, do either of the following:`, `  - (preferred): Configure your environment to support sandboxing`, `  - (alternative): Launch Chromium without sandbox using 'chromiumSandbox: false' option`, `================================`, ``].join('\n');
+    if (!error.logs)
+      return error;
+    if (error.logs.includes("Missing X server"))
+      error.logs = "\n" + (0, import_ascii.wrapInASCIIBox)(import_browserType.kNoXServerRunningError, 1);
+    if (!error.logs.includes("crbug.com/357670") && !error.logs.includes("No usable sandbox!") && !error.logs.includes("crbug.com/638180"))
+      return error;
+    error.logs = [
+      `Chromium sandboxing failed!`,
+      `================================`,
+      `To avoid the sandboxing issue, do either of the following:`,
+      `  - (preferred): Configure your environment to support sandboxing`,
+      `  - (alternative): Launch Chromium without sandbox using 'chromiumSandbox: false' option`,
+      `================================`,
+      ``
+    ].join("\n");
     return error;
   }
-  amendEnvironment(env, userDataDir, executable, browserArguments) {
+  amendEnvironment(env) {
     return env;
   }
   attemptToGracefullyCloseBrowser(transport) {
     const bidiTransport = transport[kBidiOverCdpWrapper];
-    if (bidiTransport) transport = bidiTransport;
-    transport.send({
-      method: 'browser.close',
-      params: {},
-      id: _bidiConnection.kBrowserCloseMessageId
-    });
+    if (bidiTransport)
+      transport = bidiTransport;
+    transport.send({ method: "browser.close", params: {}, id: import_bidiConnection.kBrowserCloseMessageId });
+  }
+  supportsPipeTransport() {
+    return false;
   }
   defaultArgs(options, isPersistent, userDataDir) {
     const chromeArguments = this._innerDefaultArgs(options);
     chromeArguments.push(`--user-data-dir=${userDataDir}`);
-    chromeArguments.push('--remote-debugging-port=0');
-    if (isPersistent) chromeArguments.push('about:blank');else chromeArguments.push('--no-startup-window');
+    chromeArguments.push("--remote-debugging-port=0");
+    if (isPersistent)
+      chromeArguments.push("about:blank");
+    else
+      chromeArguments.push("--no-startup-window");
     return chromeArguments;
   }
-  readyState(options) {
-    (0, _utils.assert)(options.useWebSocket);
-    return new ChromiumReadyState();
+  async waitForReadyState(options, browserLogsCollector) {
+    return (0, import_chromium.waitForReadyState)({ ...options, cdpPort: 0 }, browserLogsCollector);
   }
   _innerDefaultArgs(options) {
-    const {
-      args = []
-    } = options;
-    const userDataDirArg = args.find(arg => arg.startsWith('--user-data-dir'));
-    if (userDataDirArg) throw this._createUserDataDirArgMisuseError('--user-data-dir');
-    if (args.find(arg => arg.startsWith('--remote-debugging-pipe'))) throw new Error('Playwright manages remote debugging connection itself.');
-    if (args.find(arg => !arg.startsWith('-'))) throw new Error('Arguments can not specify page to be opened');
-    const chromeArguments = [..._chromiumSwitches.chromiumSwitches];
-    if (_os.default.platform() === 'darwin') {
-      // See https://github.com/microsoft/playwright/issues/7362
-      chromeArguments.push('--enable-use-zoom-for-dsf=false');
-      // See https://bugs.chromium.org/p/chromium/issues/detail?id=1407025.
-      if (options.headless) chromeArguments.push('--use-angle');
+    const { args = [] } = options;
+    const userDataDirArg = args.find((arg) => arg.startsWith("--user-data-dir"));
+    if (userDataDirArg)
+      throw this._createUserDataDirArgMisuseError("--user-data-dir");
+    if (args.find((arg) => arg.startsWith("--remote-debugging-pipe")))
+      throw new Error("Playwright manages remote debugging connection itself.");
+    if (args.find((arg) => !arg.startsWith("-")))
+      throw new Error("Arguments can not specify page to be opened");
+    const chromeArguments = [...(0, import_chromiumSwitches.chromiumSwitches)(options.assistantMode)];
+    if (import_os.default.platform() === "darwin") {
+      chromeArguments.push("--enable-use-zoom-for-dsf=false");
+      if (options.headless)
+        chromeArguments.push("--use-angle");
     }
-    if (options.devtools) chromeArguments.push('--auto-open-devtools-for-tabs');
+    if (options.devtools)
+      chromeArguments.push("--auto-open-devtools-for-tabs");
     if (options.headless) {
-      chromeArguments.push('--headless');
-      chromeArguments.push('--hide-scrollbars', '--mute-audio', '--blink-settings=primaryHoverType=2,availableHoverTypes=2,primaryPointerType=4,availablePointerTypes=4');
+      chromeArguments.push("--headless");
+      chromeArguments.push(
+        "--hide-scrollbars",
+        "--mute-audio",
+        "--blink-settings=primaryHoverType=2,availableHoverTypes=2,primaryPointerType=4,availablePointerTypes=4"
+      );
     }
-    if (options.chromiumSandbox !== true) chromeArguments.push('--no-sandbox');
+    if (options.chromiumSandbox !== true)
+      chromeArguments.push("--no-sandbox");
     const proxy = options.proxyOverride || options.proxy;
     if (proxy) {
       const proxyURL = new URL(proxy.server);
-      const isSocks = proxyURL.protocol === 'socks5:';
-      // https://www.chromium.org/developers/design-documents/network-settings
-      if (isSocks && !this.attribution.playwright.options.socksProxyPort) {
-        // https://www.chromium.org/developers/design-documents/network-stack/socks-proxy
+      const isSocks = proxyURL.protocol === "socks5:";
+      if (isSocks && !options.socksProxyPort) {
         chromeArguments.push(`--host-resolver-rules="MAP * ~NOTFOUND , EXCLUDE ${proxyURL.hostname}"`);
       }
       chromeArguments.push(`--proxy-server=${proxy.server}`);
       const proxyBypassRules = [];
-      // https://source.chromium.org/chromium/chromium/src/+/master:net/docs/proxy.md;l=548;drc=71698e610121078e0d1a811054dcf9fd89b49578
-      if (this.attribution.playwright.options.socksProxyPort) proxyBypassRules.push('<-loopback>');
-      if (proxy.bypass) proxyBypassRules.push(...proxy.bypass.split(',').map(t => t.trim()).map(t => t.startsWith('.') ? '*' + t : t));
-      if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !proxyBypassRules.includes('<-loopback>')) proxyBypassRules.push('<-loopback>');
-      if (proxyBypassRules.length > 0) chromeArguments.push(`--proxy-bypass-list=${proxyBypassRules.join(';')}`);
+      if (options.socksProxyPort)
+        proxyBypassRules.push("<-loopback>");
+      if (proxy.bypass)
+        proxyBypassRules.push(...proxy.bypass.split(",").map((t) => t.trim()).map((t) => t.startsWith(".") ? "*" + t : t));
+      if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !proxyBypassRules.includes("<-loopback>"))
+        proxyBypassRules.push("<-loopback>");
+      if (proxyBypassRules.length > 0)
+        chromeArguments.push(`--proxy-bypass-list=${proxyBypassRules.join(";")}`);
     }
     chromeArguments.push(...args);
     return chromeArguments;
   }
 }
-exports.BidiChromium = BidiChromium;
-class ChromiumReadyState extends _browserType.BrowserReadyState {
-  onBrowserOutput(message) {
-    const match = message.match(/DevTools listening on (.*)/);
-    if (match) this._wsEndpoint.resolve(match[1]);
-  }
-}
-const kBidiOverCdpWrapper = Symbol('kBidiConnectionWrapper');
+const kBidiOverCdpWrapper = Symbol("kBidiConnectionWrapper");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BidiChromium
+});

package/lib/server/bidi/bidiConnection.js

@@ -1,71 +1,64 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var bidiConnection_exports = {};
+__export(bidiConnection_exports, {
+  BidiConnection: () => BidiConnection,
+  BidiSession: () => BidiSession,
+  kBrowserCloseMessageId: () => kBrowserCloseMessageId
 });
-exports.kBrowserCloseMessageId = exports.BidiSession = exports.BidiConnection = void 0;
-var _events = require("events");
-var _debugLogger = require("../utils/debugLogger");
-var _helper = require("../helper");
-var _protocolError = require("../protocolError");
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the 'License');
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an 'AS IS' BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// BidiPlaywright uses this special id to issue Browser.close command which we
-// should ignore.
-const kBrowserCloseMessageId = exports.kBrowserCloseMessageId = 0;
+module.exports = __toCommonJS(bidiConnection_exports);
+var import_events = require("events");
+var import_debugLogger = require("../utils/debugLogger");
+var import_helper = require("../helper");
+var import_protocolError = require("../protocolError");
+const kBrowserCloseMessageId = 0;
 class BidiConnection {
   constructor(transport, onDisconnect, protocolLogger, browserLogsCollector) {
-    this._transport = void 0;
-    this._onDisconnect = void 0;
-    this._protocolLogger = void 0;
-    this._browserLogsCollector = void 0;
-    this._browserDisconnectedLogs = void 0;
     this._lastId = 0;
     this._closed = false;
-    this.browserSession = void 0;
-    this._browsingContextToSession = new Map();
+    this._browsingContextToSession = /* @__PURE__ */ new Map();
     this._transport = transport;
     this._onDisconnect = onDisconnect;
     this._protocolLogger = protocolLogger;
     this._browserLogsCollector = browserLogsCollector;
-    this.browserSession = new BidiSession(this, '', message => {
+    this.browserSession = new BidiSession(this, "", (message) => {
       this.rawSend(message);
     });
     this._transport.onmessage = this._dispatchMessage.bind(this);
-    // onclose should be set last, since it can be immediately called.
     this._transport.onclose = this._onClose.bind(this);
   }
   nextMessageId() {
     return ++this._lastId;
   }
   rawSend(message) {
-    this._protocolLogger('send', message);
+    this._protocolLogger("send", message);
     this._transport.send(message);
   }
   _dispatchMessage(message) {
-    this._protocolLogger('receive', message);
+    this._protocolLogger("receive", message);
     const object = message;
-    // Bidi messages do not have a common session identifier, so we
-    // route them based on BrowsingContext.
-    if (object.type === 'event') {
-      var _object$params$source;
-      // Route page events to the right session.
+    if (object.type === "event") {
       let context;
-      if ('context' in object.params) context = object.params.context;else if (object.method === 'log.entryAdded' || object.method === 'script.message') context = (_object$params$source = object.params.source) === null || _object$params$source === void 0 ? void 0 : _object$params$source.context;
+      if ("context" in object.params)
+        context = object.params.context;
+      else if (object.method === "log.entryAdded" || object.method === "script.message")
+        context = object.params.source?.context;
       if (context) {
         const session = this._browsingContextToSession.get(context);
         if (session) {
@@ -74,7 +67,6 @@ class BidiConnection {
         }
       }
     } else if (message.id) {
-      // Find caller session.
       for (const session of this._browsingContextToSession.values()) {
         if (session.hasCallback(message.id)) {
           session.dispatchMessage(message);
@@ -86,9 +78,9 @@ class BidiConnection {
   }
   _onClose(reason) {
     this._closed = true;
-    this._transport.onmessage = undefined;
-    this._transport.onclose = undefined;
-    this._browserDisconnectedLogs = _helper.helper.formatBrowserLogs(this._browserLogsCollector.recentLogs(), reason);
+    this._transport.onmessage = void 0;
+    this._transport.onclose = void 0;
+    this._browserDisconnectedLogs = import_helper.helper.formatBrowserLogs(this._browserLogsCollector.recentLogs(), reason);
     this.browserSession.dispose();
     this._onDisconnect();
   }
@@ -96,30 +88,22 @@ class BidiConnection {
     return this._closed;
   }
   close() {
-    if (!this._closed) this._transport.close();
+    if (!this._closed)
+      this._transport.close();
   }
   createMainFrameBrowsingContextSession(bowsingContextId) {
-    const result = new BidiSession(this, bowsingContextId, message => this.rawSend(message));
+    const result = new BidiSession(this, bowsingContextId, (message) => this.rawSend(message));
     this._browsingContextToSession.set(bowsingContextId, result);
     return result;
   }
 }
-exports.BidiConnection = BidiConnection;
-class BidiSession extends _events.EventEmitter {
+class BidiSession extends import_events.EventEmitter {
   constructor(connection, sessionId, rawSend) {
     super();
-    this.connection = void 0;
-    this.sessionId = void 0;
     this._disposed = false;
-    this._rawSend = void 0;
-    this._callbacks = new Map();
+    this._callbacks = /* @__PURE__ */ new Map();
     this._crashed = false;
-    this._browsingContexts = new Set();
-    this.on = void 0;
-    this.addListener = void 0;
-    this.off = void 0;
-    this.removeListener = void 0;
-    this.once = void 0;
+    this._browsingContexts = /* @__PURE__ */ new Set();
     this.setMaxListeners(0);
     this.connection = connection;
     this.sessionId = sessionId;
@@ -139,24 +123,17 @@ class BidiSession extends _events.EventEmitter {
     this.connection._browsingContextToSession.delete(context);
   }
   async send(method, params) {
-    if (this._crashed || this._disposed || this.connection._browserDisconnectedLogs) throw new _protocolError.ProtocolError(this._crashed ? 'crashed' : 'closed', undefined, this.connection._browserDisconnectedLogs);
+    if (this._crashed || this._disposed || this.connection._browserDisconnectedLogs)
+      throw new import_protocolError.ProtocolError(this._crashed ? "crashed" : "closed", void 0, this.connection._browserDisconnectedLogs);
     const id = this.connection.nextMessageId();
-    const messageObj = {
-      id,
-      method,
-      params
-    };
+    const messageObj = { id, method, params };
     this._rawSend(messageObj);
     return new Promise((resolve, reject) => {
-      this._callbacks.set(id, {
-        resolve,
-        reject,
-        error: new _protocolError.ProtocolError('error', method)
-      });
+      this._callbacks.set(id, { resolve, reject, error: new import_protocolError.ProtocolError("error", method) });
     });
   }
   sendMayFail(method, params) {
-    return this.send(method, params).catch(error => _debugLogger.debugLogger.log('error', error));
+    return this.send(method, params).catch((error) => import_debugLogger.debugLogger.log("error", error));
   }
   markAsCrashed() {
     this._crashed = true;
@@ -167,10 +144,11 @@ class BidiSession extends _events.EventEmitter {
   dispose() {
     this._disposed = true;
     this.connection._browsingContextToSession.delete(this.sessionId);
-    for (const context of this._browsingContexts) this.connection._browsingContextToSession.delete(context);
+    for (const context of this._browsingContexts)
+      this.connection._browsingContextToSession.delete(context);
     this._browsingContexts.clear();
     for (const callback of this._callbacks.values()) {
-      callback.error.type = this._crashed ? 'crashed' : 'closed';
+      callback.error.type = this._crashed ? "crashed" : "closed";
       callback.error.logs = this.connection._browserDisconnectedLogs;
       callback.reject(callback.error);
     }
@@ -181,24 +159,29 @@ class BidiSession extends _events.EventEmitter {
   }
   dispatchMessage(message) {
     const object = message;
-    if (object.id === kBrowserCloseMessageId) return;
+    if (object.id === kBrowserCloseMessageId)
+      return;
     if (object.id && this._callbacks.has(object.id)) {
       const callback = this._callbacks.get(object.id);
       this._callbacks.delete(object.id);
-      if (object.type === 'error') {
-        callback.error.setMessage(object.error + '\nMessage: ' + object.message);
+      if (object.type === "error") {
+        callback.error.setMessage(object.error + "\nMessage: " + object.message);
         callback.reject(callback.error);
-      } else if (object.type === 'success') {
+      } else if (object.type === "success") {
         callback.resolve(object.result);
       } else {
-        callback.error.setMessage('Internal error, unexpected response type: ' + JSON.stringify(object));
+        callback.error.setMessage("Internal error, unexpected response type: " + JSON.stringify(object));
         callback.reject(callback.error);
       }
     } else if (object.id) {
-      // Response might come after session has been disposed and rejected all callbacks.
     } else {
       Promise.resolve().then(() => this.emit(object.method, object.params));
     }
   }
 }
-exports.BidiSession = BidiSession;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BidiConnection,
+  BidiSession,
+  kBrowserCloseMessageId
+});