@stablyai/internal-playwright-core 0.1.0

package/lib/server/chromium/chromium.js

@@ -0,0 +1,402 @@
+"use strict";
+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 chromium_exports = {};
+__export(chromium_exports, {
+  Chromium: () => Chromium,
+  waitForReadyState: () => waitForReadyState
+});
+module.exports = __toCommonJS(chromium_exports);
+var import_fs = __toESM(require("fs"));
+var import_os = __toESM(require("os"));
+var import_path = __toESM(require("path"));
+var import_chromiumSwitches = require("./chromiumSwitches");
+var import_crBrowser = require("./crBrowser");
+var import_crConnection = require("./crConnection");
+var import_utils = require("../../utils");
+var import_ascii = require("../utils/ascii");
+var import_debugLogger = require("../utils/debugLogger");
+var import_manualPromise = require("../../utils/isomorphic/manualPromise");
+var import_network = require("../utils/network");
+var import_userAgent = require("../utils/userAgent");
+var import_browserContext = require("../browserContext");
+var import_browserType = require("../browserType");
+var import_helper = require("../helper");
+var import_registry = require("../registry");
+var import_transport = require("../transport");
+var import_crDevTools = require("./crDevTools");
+var import_browser = require("../browser");
+var import_fileUtils = require("../utils/fileUtils");
+var import_processLauncher = require("../utils/processLauncher");
+const ARTIFACTS_FOLDER = import_path.default.join(import_os.default.tmpdir(), "playwright-artifacts-");
+class Chromium extends import_browserType.BrowserType {
+  constructor(parent, bidiChromium) {
+    super(parent, "chromium");
+    this._bidiChromium = bidiChromium;
+    if ((0, import_utils.debugMode)() === "inspector")
+      this._devtools = this._createDevTools();
+  }
+  launch(progress, options, protocolLogger) {
+    if (options.channel?.startsWith("bidi-"))
+      return this._bidiChromium.launch(progress, options, protocolLogger);
+    return super.launch(progress, options, protocolLogger);
+  }
+  async launchPersistentContext(progress, userDataDir, options) {
+    if (options.channel?.startsWith("bidi-"))
+      return this._bidiChromium.launchPersistentContext(progress, userDataDir, options);
+    return super.launchPersistentContext(progress, userDataDir, options);
+  }
+  async connectOverCDP(progress, endpointURL, options) {
+    return await this._connectOverCDPInternal(progress, endpointURL, options);
+  }
+  async _connectOverCDPInternal(progress, endpointURL, options, onClose) {
+    let headersMap;
+    if (options.headers)
+      headersMap = (0, import_utils.headersArrayToObject)(options.headers, false);
+    if (!headersMap)
+      headersMap = { "User-Agent": (0, import_userAgent.getUserAgent)() };
+    else if (headersMap && !Object.keys(headersMap).some((key) => key.toLowerCase() === "user-agent"))
+      headersMap["User-Agent"] = (0, import_userAgent.getUserAgent)();
+    const artifactsDir = await progress.race(import_fs.default.promises.mkdtemp(ARTIFACTS_FOLDER));
+    const doCleanup = async () => {
+      await (0, import_fileUtils.removeFolders)([artifactsDir]);
+      const cb = onClose;
+      onClose = void 0;
+      await cb?.();
+    };
+    let chromeTransport;
+    const doClose = async () => {
+      await chromeTransport?.closeAndWait();
+      await doCleanup();
+    };
+    try {
+      const wsEndpoint = await urlToWSEndpoint(progress, endpointURL, headersMap);
+      chromeTransport = await import_transport.WebSocketTransport.connect(progress, wsEndpoint, { headers: headersMap });
+      const browserProcess = { close: doClose, kill: doClose };
+      const persistent = { noDefaultViewport: true };
+      const browserOptions = {
+        slowMo: options.slowMo,
+        name: "chromium",
+        isChromium: true,
+        persistent,
+        browserProcess,
+        protocolLogger: import_helper.helper.debugProtocolLogger(),
+        browserLogsCollector: new import_debugLogger.RecentLogsCollector(),
+        artifactsDir,
+        downloadsPath: options.downloadsPath || artifactsDir,
+        tracesDir: options.tracesDir || artifactsDir,
+        originalLaunchOptions: {}
+      };
+      (0, import_browserContext.validateBrowserContextOptions)(persistent, browserOptions);
+      const browser = await progress.race(import_crBrowser.CRBrowser.connect(this.attribution.playwright, chromeTransport, browserOptions));
+      browser._isCollocatedWithServer = false;
+      browser.on(import_browser.Browser.Events.Disconnected, doCleanup);
+      return browser;
+    } catch (error) {
+      await doClose().catch(() => {
+      });
+      throw error;
+    }
+  }
+  _createDevTools() {
+    const directory = import_registry.registry.findExecutable("chromium").directory;
+    return directory ? new import_crDevTools.CRDevTools(import_path.default.join(directory, "devtools-preferences.json")) : void 0;
+  }
+  async connectToTransport(transport, options, browserLogsCollector) {
+    let devtools = this._devtools;
+    if (options.__testHookForDevTools) {
+      devtools = this._createDevTools();
+      await options.__testHookForDevTools(devtools);
+    }
+    try {
+      return await import_crBrowser.CRBrowser.connect(this.attribution.playwright, transport, options, devtools);
+    } 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, 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) {
+    return env;
+  }
+  attemptToGracefullyCloseBrowser(transport) {
+    const message = { method: "Browser.close", id: import_crConnection.kBrowserCloseMessageId, params: {} };
+    transport.send(message);
+  }
+  async _launchWithSeleniumHub(progress, hubUrl, options) {
+    await progress.race(this._createArtifactDirs(options));
+    if (!hubUrl.endsWith("/"))
+      hubUrl = hubUrl + "/";
+    const args = this._innerDefaultArgs(options);
+    args.push("--remote-debugging-port=0");
+    const isEdge = options.channel && options.channel.startsWith("msedge");
+    let desiredCapabilities = {
+      "browserName": isEdge ? "MicrosoftEdge" : "chrome",
+      [isEdge ? "ms:edgeOptions" : "goog:chromeOptions"]: { args }
+    };
+    if (process.env.SELENIUM_REMOTE_CAPABILITIES) {
+      const remoteCapabilities = parseSeleniumRemoteParams({ name: "capabilities", value: process.env.SELENIUM_REMOTE_CAPABILITIES }, progress);
+      if (remoteCapabilities)
+        desiredCapabilities = { ...desiredCapabilities, ...remoteCapabilities };
+    }
+    let headers = {};
+    if (process.env.SELENIUM_REMOTE_HEADERS) {
+      const remoteHeaders = parseSeleniumRemoteParams({ name: "headers", value: process.env.SELENIUM_REMOTE_HEADERS }, progress);
+      if (remoteHeaders)
+        headers = remoteHeaders;
+    }
+    progress.log(`<selenium> connecting to ${hubUrl}`);
+    const response = await (0, import_network.fetchData)(progress, {
+      url: hubUrl + "session",
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json; charset=utf-8",
+        ...headers
+      },
+      data: JSON.stringify({
+        capabilities: { alwaysMatch: desiredCapabilities }
+      })
+    }, seleniumErrorHandler);
+    const value = JSON.parse(response).value;
+    const sessionId = value.sessionId;
+    progress.log(`<selenium> connected to sessionId=${sessionId}`);
+    const disconnectFromSelenium = async () => {
+      progress.log(`<selenium> disconnecting from sessionId=${sessionId}`);
+      await (0, import_network.fetchData)(void 0, {
+        url: hubUrl + "session/" + sessionId,
+        method: "DELETE",
+        headers
+      }).catch((error) => progress.log(`<error disconnecting from selenium>: ${error}`));
+      progress.log(`<selenium> disconnected from sessionId=${sessionId}`);
+      import_processLauncher.gracefullyCloseSet.delete(disconnectFromSelenium);
+    };
+    import_processLauncher.gracefullyCloseSet.add(disconnectFromSelenium);
+    try {
+      const capabilities = value.capabilities;
+      let endpointURL;
+      if (capabilities["se:cdp"]) {
+        progress.log(`<selenium> using selenium v4`);
+        const endpointURLString = addProtocol(capabilities["se:cdp"]);
+        endpointURL = new URL(endpointURLString);
+        if (endpointURL.hostname === "localhost" || endpointURL.hostname === "127.0.0.1")
+          endpointURL.hostname = new URL(hubUrl).hostname;
+        progress.log(`<selenium> retrieved endpoint ${endpointURL.toString()} for sessionId=${sessionId}`);
+      } else {
+        progress.log(`<selenium> using selenium v3`);
+        const maybeChromeOptions = capabilities["goog:chromeOptions"];
+        const chromeOptions = maybeChromeOptions && typeof maybeChromeOptions === "object" ? maybeChromeOptions : void 0;
+        const debuggerAddress = chromeOptions && typeof chromeOptions.debuggerAddress === "string" ? chromeOptions.debuggerAddress : void 0;
+        const chromeOptionsURL = typeof maybeChromeOptions === "string" ? maybeChromeOptions : void 0;
+        const endpointURLString = addProtocol(debuggerAddress || chromeOptionsURL).replace("localhost", "127.0.0.1");
+        progress.log(`<selenium> retrieved endpoint ${endpointURLString} for sessionId=${sessionId}`);
+        endpointURL = new URL(endpointURLString);
+        if (endpointURL.hostname === "localhost" || endpointURL.hostname === "127.0.0.1") {
+          const sessionInfoUrl = new URL(hubUrl).origin + "/grid/api/testsession?session=" + sessionId;
+          try {
+            const sessionResponse = await (0, import_network.fetchData)(progress, {
+              url: sessionInfoUrl,
+              method: "GET",
+              headers
+            }, seleniumErrorHandler);
+            const proxyId = JSON.parse(sessionResponse).proxyId;
+            endpointURL.hostname = new URL(proxyId).hostname;
+            progress.log(`<selenium> resolved endpoint ip ${endpointURL.toString()} for sessionId=${sessionId}`);
+          } catch (e) {
+            progress.log(`<selenium> unable to resolve endpoint ip for sessionId=${sessionId}, running in standalone?`);
+          }
+        }
+      }
+      return await this._connectOverCDPInternal(progress, endpointURL.toString(), {
+        ...options,
+        headers: (0, import_utils.headersObjectToArray)(headers)
+      }, disconnectFromSelenium);
+    } catch (e) {
+      await disconnectFromSelenium();
+      throw e;
+    }
+  }
+  async defaultArgs(options, isPersistent, userDataDir) {
+    const chromeArguments = this._innerDefaultArgs(options);
+    chromeArguments.push(`--user-data-dir=${userDataDir}`);
+    if (options.cdpPort !== void 0)
+      chromeArguments.push(`--remote-debugging-port=${options.cdpPort}`);
+    else
+      chromeArguments.push("--remote-debugging-pipe");
+    if (isPersistent)
+      chromeArguments.push("about:blank");
+    else
+      chromeArguments.push("--no-startup-window");
+    return chromeArguments;
+  }
+  _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 = [...(0, import_chromiumSwitches.chromiumSwitches)(options.assistantMode, options.channel)];
+    if (import_os.default.platform() === "darwin") {
+      chromeArguments.push("--enable-unsafe-swiftshader");
+    }
+    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"
+      );
+    }
+    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:";
+      if (isSocks && !options.socksProxyPort) {
+        chromeArguments.push(`--host-resolver-rules="MAP * ~NOTFOUND , EXCLUDE ${proxyURL.hostname}"`);
+      }
+      chromeArguments.push(`--proxy-server=${proxy.server}`);
+      const proxyBypassRules = [];
+      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;
+  }
+  async waitForReadyState(options, browserLogsCollector) {
+    return waitForReadyState(options, browserLogsCollector);
+  }
+  getExecutableName(options) {
+    if (options.channel)
+      return options.channel;
+    return options.headless ? "chromium-headless-shell" : "chromium";
+  }
+}
+async function waitForReadyState(options, browserLogsCollector) {
+  if (options.cdpPort === void 0 && !options.args?.some((a) => a.startsWith("--remote-debugging-port")))
+    return {};
+  const result = new import_manualPromise.ManualPromise();
+  browserLogsCollector.onMessage((message) => {
+    if (message.includes("Failed to create a ProcessSingleton for your profile directory.")) {
+      result.reject(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."));
+    }
+    const match = message.match(/DevTools listening on (.*)/);
+    if (match)
+      result.resolve({ wsEndpoint: match[1] });
+  });
+  return result;
+}
+async function urlToWSEndpoint(progress, endpointURL, headers) {
+  if (endpointURL.startsWith("ws"))
+    return endpointURL;
+  progress.log(`<ws preparing> retrieving websocket url from ${endpointURL}`);
+  const url = new URL(endpointURL);
+  if (!url.pathname.endsWith("/"))
+    url.pathname += "/";
+  url.pathname += "json/version/";
+  const httpURL = url.toString();
+  const json = await (0, import_network.fetchData)(
+    progress,
+    {
+      url: httpURL,
+      headers
+    },
+    async (_, resp) => new Error(`Unexpected status ${resp.statusCode} when connecting to ${httpURL}.
+This does not look like a DevTools server, try connecting via ws://.`)
+  );
+  return JSON.parse(json).webSocketDebuggerUrl;
+}
+async function seleniumErrorHandler(params, response) {
+  const body = await streamToString(response);
+  let message = body;
+  try {
+    const json = JSON.parse(body);
+    message = json.value.localizedMessage || json.value.message;
+  } catch (e) {
+  }
+  return new Error(`Error connecting to Selenium at ${params.url}: ${message}`);
+}
+function addProtocol(url) {
+  if (!["ws://", "wss://", "http://", "https://"].some((protocol) => url.startsWith(protocol)))
+    return "http://" + url;
+  return url;
+}
+function streamToString(stream) {
+  return new Promise((resolve, reject) => {
+    const chunks = [];
+    stream.on("data", (chunk) => chunks.push(Buffer.from(chunk)));
+    stream.on("error", reject);
+    stream.on("end", () => resolve(Buffer.concat(chunks).toString("utf8")));
+  });
+}
+function parseSeleniumRemoteParams(env, progress) {
+  try {
+    const parsed = JSON.parse(env.value);
+    progress.log(`<selenium> using additional ${env.name} "${env.value}"`);
+    return parsed;
+  } catch (e) {
+    progress.log(`<selenium> ignoring additional ${env.name} "${env.value}": ${e}`);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Chromium,
+  waitForReadyState
+});

package/lib/server/chromium/chromiumSwitches.js

@@ -0,0 +1,95 @@
+"use strict";
+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 chromiumSwitches_exports = {};
+__export(chromiumSwitches_exports, {
+  chromiumSwitches: () => chromiumSwitches
+});
+module.exports = __toCommonJS(chromiumSwitches_exports);
+const disabledFeatures = (assistantMode) => [
+  // See https://github.com/microsoft/playwright/pull/10380
+  "AcceptCHFrame",
+  // See https://github.com/microsoft/playwright/issues/14047
+  "AvoidUnnecessaryBeforeUnloadCheckSync",
+  "DestroyProfileOnBrowserClose",
+  // See https://github.com/microsoft/playwright/pull/13854
+  "DialMediaRouteProvider",
+  "GlobalMediaControls",
+  // See https://github.com/microsoft/playwright/pull/27605
+  "HttpsUpgrades",
+  // Hides the Lens feature in the URL address bar. Its not working in unofficial builds.
+  "LensOverlay",
+  // See https://github.com/microsoft/playwright/pull/8162
+  "MediaRouter",
+  // See https://github.com/microsoft/playwright/issues/28023
+  "PaintHolding",
+  // See https://github.com/microsoft/playwright/issues/32230
+  "ThirdPartyStoragePartitioning",
+  // See https://github.com/microsoft/playwright/issues/16126
+  "Translate",
+  // See https://issues.chromium.org/u/1/issues/435410220
+  "AutoDeElevate",
+  // See https://github.com/microsoft/playwright/issues/37714
+  "RenderDocument",
+  assistantMode ? "AutomationControlled" : ""
+].filter(Boolean);
+const chromiumSwitches = (assistantMode, channel) => [
+  "--disable-field-trial-config",
+  // https://source.chromium.org/chromium/chromium/src/+/main:testing/variations/README.md
+  "--disable-background-networking",
+  "--disable-background-timer-throttling",
+  "--disable-backgrounding-occluded-windows",
+  "--disable-back-forward-cache",
+  // Avoids surprises like main request not being intercepted during page.goBack().
+  "--disable-breakpad",
+  "--disable-client-side-phishing-detection",
+  "--disable-component-extensions-with-background-pages",
+  "--disable-component-update",
+  // Avoids unneeded network activity after startup.
+  "--no-default-browser-check",
+  "--disable-default-apps",
+  "--disable-dev-shm-usage",
+  "--disable-extensions",
+  "--disable-features=" + disabledFeatures(assistantMode).join(","),
+  process.env.PLAYWRIGHT_LEGACY_SCREENSHOT ? "" : "--enable-features=CDPScreenshotNewSurface",
+  "--allow-pre-commit-input",
+  "--disable-hang-monitor",
+  "--disable-ipc-flooding-protection",
+  "--disable-popup-blocking",
+  "--disable-prompt-on-repost",
+  "--disable-renderer-backgrounding",
+  "--force-color-profile=srgb",
+  "--metrics-recording-only",
+  "--no-first-run",
+  "--password-store=basic",
+  "--use-mock-keychain",
+  // See https://chromium-review.googlesource.com/c/chromium/src/+/2436773
+  "--no-service-autorun",
+  "--export-tagged-pdf",
+  // https://chromium-review.googlesource.com/c/chromium/src/+/4853540
+  "--disable-search-engine-choice-screen",
+  // https://issues.chromium.org/41491762
+  "--unsafely-disable-devtools-self-xss-warnings",
+  // Edge can potentially restart on Windows (msRelaunchNoCompatLayer) which looses its file descriptors (stdout/stderr) and CDP (3/4). Disable until fixed upstream.
+  "--edge-skip-compat-layer-relaunch",
+  assistantMode ? "" : "--enable-automation"
+].filter(Boolean);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  chromiumSwitches
+});