patchright-core 1.48.2

package/lib/server/artifact.js

@@ -0,0 +1,104 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Artifact = void 0;
+var _fs = _interopRequireDefault(require("fs"));
+var _utils = require("../utils");
+var _manualPromise = require("../utils/manualPromise");
+var _instrumentation = require("./instrumentation");
+var _errors = require("./errors");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * 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 Artifact extends _instrumentation.SdkObject {
+  constructor(parent, localPath, unaccessibleErrorMessage, cancelCallback) {
+    super(parent, 'artifact');
+    this._localPath = void 0;
+    this._unaccessibleErrorMessage = void 0;
+    this._cancelCallback = void 0;
+    this._finishedPromise = new _manualPromise.ManualPromise();
+    this._saveCallbacks = [];
+    this._finished = false;
+    this._deleted = false;
+    this._failureError = void 0;
+    this._localPath = localPath;
+    this._unaccessibleErrorMessage = unaccessibleErrorMessage;
+    this._cancelCallback = cancelCallback;
+  }
+  finishedPromise() {
+    return this._finishedPromise;
+  }
+  localPath() {
+    return this._localPath;
+  }
+  async localPathAfterFinished() {
+    if (this._unaccessibleErrorMessage) throw new Error(this._unaccessibleErrorMessage);
+    await this._finishedPromise;
+    if (this._failureError) throw this._failureError;
+    return this._localPath;
+  }
+  saveAs(saveCallback) {
+    if (this._unaccessibleErrorMessage) throw new Error(this._unaccessibleErrorMessage);
+    if (this._deleted) throw new Error(`File already deleted. Save before deleting.`);
+    if (this._failureError) throw this._failureError;
+    if (this._finished) {
+      saveCallback(this._localPath).catch(() => {});
+      return;
+    }
+    this._saveCallbacks.push(saveCallback);
+  }
+  async failureError() {
+    var _this$_failureError;
+    if (this._unaccessibleErrorMessage) return this._unaccessibleErrorMessage;
+    await this._finishedPromise;
+    return ((_this$_failureError = this._failureError) === null || _this$_failureError === void 0 ? void 0 : _this$_failureError.message) || null;
+  }
+  async cancel() {
+    (0, _utils.assert)(this._cancelCallback !== undefined);
+    return this._cancelCallback();
+  }
+  async delete() {
+    if (this._unaccessibleErrorMessage) return;
+    const fileName = await this.localPathAfterFinished();
+    if (this._deleted) return;
+    this._deleted = true;
+    if (fileName) await _fs.default.promises.unlink(fileName).catch(e => {});
+  }
+  async deleteOnContextClose() {
+    // Compared to "delete", this method does not wait for the artifact to finish.
+    // We use it when closing the context to avoid stalling.
+    if (this._deleted) return;
+    this._deleted = true;
+    if (!this._unaccessibleErrorMessage) await _fs.default.promises.unlink(this._localPath).catch(e => {});
+    await this.reportFinished(new _errors.TargetClosedError());
+  }
+  async reportFinished(error) {
+    if (this._finished) return;
+    this._finished = true;
+    this._failureError = error;
+    if (error) {
+      for (const callback of this._saveCallbacks) await callback('', error);
+    } else {
+      for (const callback of this._saveCallbacks) await callback(this._localPath);
+    }
+    this._saveCallbacks = [];
+    this._finishedPromise.resolve();
+  }
+}
+exports.Artifact = Artifact;

package/lib/server/bidi/bidiBrowser.js

@@ -0,0 +1,311 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Network = exports.BidiBrowserContext = exports.BidiBrowser = void 0;
+var _eventsHelper = require("../../utils/eventsHelper");
+var _browser = require("../browser");
+var _browserContext = require("../browserContext");
+var network = _interopRequireWildcard(require("../network"));
+var _bidiConnection = require("./bidiConnection");
+var _bidiNetworkManager = require("./bidiNetworkManager");
+var _bidiPage = require("./bidiPage");
+var bidi = _interopRequireWildcard(require("./third_party/bidiProtocol"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+/**
+ * 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 BidiBrowser extends _browser.Browser {
+  static async connect(parent, transport, options) {
+    const browser = new BidiBrowser(parent, transport, options);
+    if (options.__testHookOnConnectToBrowser) await options.__testHookOnConnectToBrowser();
+    let proxy;
+    if (options.proxy) {
+      proxy = {
+        proxyType: 'manual'
+      };
+      const url = new URL(options.proxy.server); // Validate proxy server.
+      switch (url.protocol) {
+        case 'http:':
+          proxy.httpProxy = url.host;
+          break;
+        case 'https:':
+          proxy.httpsProxy = url.host;
+          break;
+        case 'socks4:':
+          proxy.socksProxy = url.host;
+          proxy.socksVersion = 4;
+          break;
+        case 'socks5:':
+          proxy.socksProxy = url.host;
+          proxy.socksVersion = 5;
+          break;
+        default:
+          throw new Error('Invalid proxy server protocol: ' + options.proxy.server);
+      }
+      if (options.proxy.bypass) proxy.noProxy = options.proxy.bypass.split(',');
+      // TODO: support authentication.
+    }
+    browser._bidiSessionInfo = await browser._browserSession.send('session.new', {
+      capabilities: {
+        alwaysMatch: {
+          acceptInsecureCerts: false,
+          proxy,
+          unhandledPromptBehavior: {
+            default: bidi.Session.UserPromptHandlerType.Ignore
+          },
+          webSocketUrl: true
+        }
+      }
+    });
+    await browser._browserSession.send('session.subscribe', {
+      events: ['browsingContext', 'network', 'log', 'script']
+    });
+    if (options.persistent) {
+      browser._defaultContext = new BidiBrowserContext(browser, undefined, options.persistent);
+      await browser._defaultContext._initialize();
+      // Create default page as we cannot get access to the existing one.
+      const pageDelegate = await browser._defaultContext.newPageDelegate();
+      await pageDelegate.pageOrError();
+    }
+    return browser;
+  }
+  constructor(parent, transport, options) {
+    super(parent, options);
+    this._connection = void 0;
+    this._browserSession = void 0;
+    this._bidiSessionInfo = void 0;
+    this._contexts = new Map();
+    this._bidiPages = new Map();
+    this._eventListeners = void 0;
+    this._connection = new _bidiConnection.BidiConnection(transport, this._onDisconnect.bind(this), options.protocolLogger, options.browserLogsCollector);
+    this._browserSession = this._connection.browserSession;
+    this._eventListeners = [_eventsHelper.eventsHelper.addEventListener(this._browserSession, 'browsingContext.contextCreated', this._onBrowsingContextCreated.bind(this)), _eventsHelper.eventsHelper.addEventListener(this._browserSession, 'script.realmDestroyed', this._onScriptRealmDestroyed.bind(this))];
+  }
+  _onDisconnect() {
+    this._didClose();
+  }
+  async doCreateNewContext(options) {
+    const {
+      userContext
+    } = await this._browserSession.send('browser.createUserContext', {});
+    const context = new BidiBrowserContext(this, userContext, options);
+    await context._initialize();
+    this._contexts.set(userContext, context);
+    return context;
+  }
+  contexts() {
+    return Array.from(this._contexts.values());
+  }
+  version() {
+    return this._bidiSessionInfo.capabilities.browserVersion;
+  }
+  userAgent() {
+    return this._bidiSessionInfo.capabilities.userAgent;
+  }
+  isConnected() {
+    return !this._connection.isClosed();
+  }
+  _onBrowsingContextCreated(event) {
+    if (event.parent) {
+      const parentFrameId = event.parent;
+      for (const page of this._bidiPages.values()) {
+        const parentFrame = page._page._frameManager.frame(parentFrameId);
+        if (!parentFrame) continue;
+        page._session.addFrameBrowsingContext(event.context);
+        page._page._frameManager.frameAttached(event.context, parentFrameId);
+        return;
+      }
+      return;
+    }
+    let context = this._contexts.get(event.userContext);
+    if (!context) context = this._defaultContext;
+    if (!context) return;
+    const session = this._connection.createMainFrameBrowsingContextSession(event.context);
+    const opener = event.originalOpener && this._bidiPages.get(event.originalOpener);
+    const page = new _bidiPage.BidiPage(context, session, opener || null);
+    this._bidiPages.set(event.context, page);
+  }
+  _onBrowsingContextDestroyed(event) {
+    if (event.parent) {
+      this._browserSession.removeFrameBrowsingContext(event.context);
+      const parentFrameId = event.parent;
+      for (const page of this._bidiPages.values()) {
+        const parentFrame = page._page._frameManager.frame(parentFrameId);
+        if (!parentFrame) continue;
+        page._page._frameManager.frameDetached(event.context);
+        return;
+      }
+      return;
+    }
+    const bidiPage = this._bidiPages.get(event.context);
+    if (!bidiPage) return;
+    bidiPage.didClose();
+    this._bidiPages.delete(event.context);
+  }
+  _onScriptRealmDestroyed(event) {
+    for (const page of this._bidiPages.values()) {
+      if (page._onRealmDestroyed(event)) return;
+    }
+  }
+}
+exports.BidiBrowser = BidiBrowser;
+class BidiBrowserContext extends _browserContext.BrowserContext {
+  constructor(browser, browserContextId, options) {
+    super(browser, options, browserContextId);
+    this._authenticateProxyViaHeader();
+  }
+  _bidiPages() {
+    return [...this._browser._bidiPages.values()].filter(bidiPage => bidiPage._browserContext === this);
+  }
+  pages() {
+    return this._bidiPages().map(bidiPage => bidiPage._initializedPage).filter(Boolean);
+  }
+  async newPageDelegate() {
+    (0, _browserContext.assertBrowserContextIsNotOwned)(this);
+    const {
+      context
+    } = await this._browser._browserSession.send('browsingContext.create', {
+      type: bidi.BrowsingContext.CreateType.Window,
+      userContext: this._browserContextId
+    });
+    return this._browser._bidiPages.get(context);
+  }
+  async doGetCookies(urls) {
+    const {
+      cookies
+    } = await this._browser._browserSession.send('storage.getCookies', {
+      partition: {
+        type: 'storageKey',
+        userContext: this._browserContextId
+      }
+    });
+    return network.filterCookies(cookies.map(c => {
+      var _c$expiry;
+      const copy = {
+        name: c.name,
+        value: (0, _bidiNetworkManager.bidiBytesValueToString)(c.value),
+        domain: c.domain,
+        path: c.path,
+        httpOnly: c.httpOnly,
+        secure: c.secure,
+        expires: (_c$expiry = c.expiry) !== null && _c$expiry !== void 0 ? _c$expiry : -1,
+        sameSite: c.sameSite ? fromBidiSameSite(c.sameSite) : 'None'
+      };
+      return copy;
+    }), urls);
+  }
+  async addCookies(cookies) {
+    cookies = network.rewriteCookies(cookies);
+    const promises = cookies.map(c => {
+      const cookie = {
+        name: c.name,
+        value: {
+          type: 'string',
+          value: c.value
+        },
+        domain: c.domain,
+        path: c.path,
+        httpOnly: c.httpOnly,
+        secure: c.secure,
+        sameSite: c.sameSite && toBidiSameSite(c.sameSite),
+        expiry: c.expires === -1 || c.expires === undefined ? undefined : Math.round(c.expires)
+      };
+      return this._browser._browserSession.send('storage.setCookie', {
+        cookie,
+        partition: {
+          type: 'storageKey',
+          userContext: this._browserContextId
+        }
+      });
+    });
+    await Promise.all(promises);
+  }
+  async doClearCookies() {
+    await this._browser._browserSession.send('storage.deleteCookies', {
+      partition: {
+        type: 'storageKey',
+        userContext: this._browserContextId
+      }
+    });
+  }
+  async doGrantPermissions(origin, permissions) {}
+  async doClearPermissions() {}
+  async setGeolocation(geolocation) {}
+  async setExtraHTTPHeaders(headers) {}
+  async setUserAgent(userAgent) {}
+  async setOffline(offline) {}
+  async doSetHTTPCredentials(httpCredentials) {
+    this._options.httpCredentials = httpCredentials;
+    for (const page of this.pages()) await page._delegate.updateHttpCredentials();
+  }
+  async doAddInitScript(initScript) {
+    await Promise.all(this.pages().map(page => page._delegate.addInitScript(initScript)));
+  }
+  async doRemoveNonInternalInitScripts() {}
+  async doUpdateRequestInterception() {}
+  onClosePersistent() {}
+  async clearCache() {}
+  async doClose(reason) {
+    if (!this._browserContextId) {
+      // Closing persistent context should close the browser.
+      await this._browser.close({
+        reason
+      });
+      return;
+    }
+    await this._browser._browserSession.send('browser.removeUserContext', {
+      userContext: this._browserContextId
+    });
+    this._browser._contexts.delete(this._browserContextId);
+  }
+  async cancelDownload(uuid) {}
+}
+exports.BidiBrowserContext = BidiBrowserContext;
+function fromBidiSameSite(sameSite) {
+  switch (sameSite) {
+    case 'strict':
+      return 'Strict';
+    case 'lax':
+      return 'Lax';
+    case 'none':
+      return 'None';
+  }
+  return 'None';
+}
+function toBidiSameSite(sameSite) {
+  switch (sameSite) {
+    case 'Strict':
+      return bidi.Network.SameSite.Strict;
+    case 'Lax':
+      return bidi.Network.SameSite.Lax;
+    case 'None':
+      return bidi.Network.SameSite.None;
+  }
+  return bidi.Network.SameSite.None;
+}
+let Network = exports.Network = void 0;
+(function (_Network) {
+  let SameSite = /*#__PURE__*/function (SameSite) {
+    SameSite["Strict"] = "strict";
+    SameSite["Lax"] = "lax";
+    SameSite["None"] = "none";
+    return SameSite;
+  }({});
+  _Network.SameSite = SameSite;
+})(Network || (exports.Network = Network = {}));

package/lib/server/bidi/bidiChromium.js

@@ -0,0 +1,124 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BidiChromium = void 0;
+var _os = _interopRequireDefault(require("os"));
+var _utils = require("../../utils");
+var _browserType = require("../browserType");
+var _chromiumSwitches = require("../chromium/chromiumSwitches");
+var _bidiBrowser = require("./bidiBrowser");
+var _bidiConnection = require("./bidiConnection");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * 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 {
+  constructor(parent) {
+    super(parent, 'bidi');
+    this._useBidi = true;
+  }
+  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);
+    transport[kBidiOverCdpWrapper] = bidiTransport;
+    return _bidiBrowser.BidiBrowser.connect(this.attribution.playwright, bidiTransport, options);
+  }
+  doRewriteStartupLog(error) {
+    if (!error.logs) return error;
+    if (error.logs.includes('Missing X server')) error.logs = '\n' + (0, _utils.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');
+    return error;
+  }
+  amendEnvironment(env, userDataDir, executable, browserArguments) {
+    return env;
+  }
+  attemptToGracefullyCloseBrowser(transport) {
+    const bidiTransport = transport[kBidiOverCdpWrapper];
+    if (bidiTransport) transport = bidiTransport;
+    transport.send({
+      method: 'browser.close',
+      params: {},
+      id: _bidiConnection.kBrowserCloseMessageId
+    });
+  }
+  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');
+    return chromeArguments;
+  }
+  readyState(options) {
+    (0, _utils.assert)(options.useWebSocket);
+    return new ChromiumReadyState();
+  }
+  _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');
+    }
+    if (options.devtools) chromeArguments.push('--auto-open-devtools-for-tabs');
+    if (options.headless) {
+      if (process.env.PLAYWRIGHT_CHROMIUM_USE_HEADLESS_NEW) chromeArguments.push('--headless=new');else chromeArguments.push('--headless=old');
+      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:';
+      // 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
+        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(';')}`);
+    }
+    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');