@checkly/playwright-core 1.42.18 → 1.47.11

package/lib/server/bidi/bidiFirefox.js

@@ -0,0 +1,110 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BidiFirefox = void 0;
+var _os = _interopRequireDefault(require("os"));
+var _path = _interopRequireDefault(require("path"));
+var _utils = require("../../utils");
+var _browserType = require("../browserType");
+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 BidiFirefox extends _browserType.BrowserType {
+  constructor(parent) {
+    super(parent, 'bidi');
+    this._useBidi = true;
+  }
+  async connectToTransport(transport, options) {
+    return _bidiBrowser.BidiBrowser.connect(this.attribution.playwright, transport, options);
+  }
+  doRewriteStartupLog(error) {
+    if (!error.logs) return error;
+    // https://github.com/microsoft/playwright/issues/6500
+    if (error.logs.includes(`as root in a regular user's session is not supported.`)) error.logs = '\n' + (0, _utils.wrapInASCIIBox)(`Firefox is unable to launch if the $HOME folder isn't owned by the current user.\nWorkaround: Set the HOME=/root environment variable${process.env.GITHUB_ACTION ? ' in your GitHub Actions workflow file' : ''} when running Playwright.`, 1);
+    if (error.logs.includes('no DISPLAY environment variable specified')) error.logs = '\n' + (0, _utils.wrapInASCIIBox)(_browserType.kNoXServerRunningError, 1);
+    return error;
+  }
+  amendEnvironment(env, userDataDir, executable, browserArguments) {
+    if (!_path.default.isAbsolute(_os.default.homedir())) throw new Error(`Cannot launch Firefox with relative home directory. Did you set ${_os.default.platform() === 'win32' ? 'USERPROFILE' : 'HOME'} to a relative path?`);
+    if (_os.default.platform() === 'linux') {
+      // Always remove SNAP_NAME and SNAP_INSTANCE_NAME env variables since they
+      // confuse Firefox: in our case, builds never come from SNAP.
+      // See https://github.com/microsoft/playwright/issues/20555
+      return {
+        ...env,
+        SNAP_NAME: undefined,
+        SNAP_INSTANCE_NAME: undefined
+      };
+    }
+    return env;
+  }
+  attemptToGracefullyCloseBrowser(transport) {
+    transport.send({
+      method: 'browser.close',
+      params: {},
+      id: _bidiConnection.kBrowserCloseMessageId
+    });
+  }
+  defaultArgs(options, isPersistent, userDataDir) {
+    const {
+      args = [],
+      headless
+    } = options;
+    const userDataDirArg = args.find(arg => arg.startsWith('-profile') || arg.startsWith('--profile'));
+    if (userDataDirArg) throw this._createUserDataDirArgMisuseError('--profile');
+    const firefoxArguments = ['--remote-debugging-port=0'];
+    if (headless) firefoxArguments.push('--headless');else firefoxArguments.push('--foreground');
+    firefoxArguments.push(`--profile`, userDataDir);
+    firefoxArguments.push(...args);
+    // TODO: make ephemeral context work without this argument.
+    firefoxArguments.push('about:blank');
+    // if (isPersistent)
+    //   firefoxArguments.push('about:blank');
+    // else
+    //   firefoxArguments.push('-silent');
+    return firefoxArguments;
+  }
+  readyState(options) {
+    (0, _utils.assert)(options.useWebSocket);
+    return new BidiReadyState();
+  }
+}
+exports.BidiFirefox = BidiFirefox;
+class BidiReadyState {
+  constructor() {
+    this._wsEndpoint = new _utils.ManualPromise();
+  }
+  onBrowserOutput(message) {
+    // Bidi WebSocket in Firefox.
+    const match = message.match(/WebDriver BiDi listening on (ws:\/\/.*)$/);
+    if (match) this._wsEndpoint.resolve(match[1] + '/session');
+  }
+  onBrowserExit() {
+    // Unblock launch when browser prematurely exits.
+    this._wsEndpoint.resolve(undefined);
+  }
+  async waitUntilReady() {
+    const wsEndpoint = await this._wsEndpoint;
+    return {
+      wsEndpoint
+    };
+  }
+}

package/lib/server/bidi/bidiInput.js

@@ -0,0 +1,174 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.RawTouchscreenImpl = exports.RawMouseImpl = exports.RawKeyboardImpl = void 0;
+var bidi = _interopRequireWildcard(require("./third_party/bidiProtocol"));
+var _bidiKeyboard = require("./third_party/bidiKeyboard");
+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 RawKeyboardImpl {
+  constructor(session) {
+    this._session = void 0;
+    this._session = session;
+  }
+  setSession(session) {
+    this._session = session;
+  }
+  async keydown(modifiers, code, keyCode, keyCodeWithoutLocation, key, location, autoRepeat, text) {
+    const actions = [];
+    actions.push({
+      type: 'keyDown',
+      value: (0, _bidiKeyboard.getBidiKeyValue)(key)
+    });
+    // TODO: add modifiers?
+    await this._performActions(actions);
+  }
+  async keyup(modifiers, code, keyCode, keyCodeWithoutLocation, key, location) {
+    const actions = [];
+    actions.push({
+      type: 'keyUp',
+      value: (0, _bidiKeyboard.getBidiKeyValue)(key)
+    });
+    await this._performActions(actions);
+  }
+  async sendText(text) {
+    const actions = [];
+    for (const char of text) {
+      const value = (0, _bidiKeyboard.getBidiKeyValue)(char);
+      actions.push({
+        type: 'keyDown',
+        value
+      });
+      actions.push({
+        type: 'keyUp',
+        value
+      });
+    }
+    await this._performActions(actions);
+  }
+  async _performActions(actions) {
+    await this._session.send('input.performActions', {
+      context: this._session.sessionId,
+      actions: [{
+        type: 'key',
+        id: 'pw_keyboard',
+        actions
+      }]
+    });
+  }
+}
+exports.RawKeyboardImpl = RawKeyboardImpl;
+class RawMouseImpl {
+  constructor(session) {
+    this._session = void 0;
+    this._session = session;
+  }
+  async move(x, y, button, buttons, modifiers, forClick) {
+    // TODO: bidi throws when x/y are not integers.
+    x = Math.round(x);
+    y = Math.round(y);
+    await this._performActions([{
+      type: 'pointerMove',
+      x,
+      y
+    }]);
+  }
+  async down(x, y, button, buttons, modifiers, clickCount) {
+    await this._performActions([{
+      type: 'pointerDown',
+      button: toBidiButton(button)
+    }]);
+  }
+  async up(x, y, button, buttons, modifiers, clickCount) {
+    await this._performActions([{
+      type: 'pointerUp',
+      button: toBidiButton(button)
+    }]);
+  }
+  async click(x, y, options = {}) {
+    x = Math.round(x);
+    y = Math.round(y);
+    const button = toBidiButton(options.button || 'left');
+    const {
+      delay = null,
+      clickCount = 1
+    } = options;
+    const actions = [];
+    actions.push({
+      type: 'pointerMove',
+      x,
+      y
+    });
+    for (let cc = 1; cc <= clickCount; ++cc) {
+      actions.push({
+        type: 'pointerDown',
+        button
+      });
+      if (delay) actions.push({
+        type: 'pause',
+        duration: delay
+      });
+      actions.push({
+        type: 'pointerUp',
+        button
+      });
+      if (delay && cc < clickCount) actions.push({
+        type: 'pause',
+        duration: delay
+      });
+    }
+    await this._performActions(actions);
+  }
+  async wheel(x, y, buttons, modifiers, deltaX, deltaY) {}
+  async _performActions(actions) {
+    await this._session.send('input.performActions', {
+      context: this._session.sessionId,
+      actions: [{
+        type: 'pointer',
+        id: 'pw_mouse',
+        parameters: {
+          pointerType: bidi.Input.PointerType.Mouse
+        },
+        actions
+      }]
+    });
+  }
+}
+exports.RawMouseImpl = RawMouseImpl;
+class RawTouchscreenImpl {
+  constructor(session) {
+    this._session = void 0;
+    this._session = session;
+  }
+  async tap(x, y, modifiers) {}
+}
+exports.RawTouchscreenImpl = RawTouchscreenImpl;
+function toBidiButton(button) {
+  switch (button) {
+    case 'left':
+      return 0;
+    case 'right':
+      return 2;
+    case 'middle':
+      return 1;
+  }
+  throw new Error('Unknown button: ' + button);
+}

package/lib/server/bidi/bidiNetworkManager.js

@@ -0,0 +1,304 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BidiNetworkManager = void 0;
+exports.bidiBytesValueToString = bidiBytesValueToString;
+var _eventsHelper = require("../../utils/eventsHelper");
+var network = _interopRequireWildcard(require("../network"));
+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 BidiNetworkManager {
+  constructor(bidiSession, page, onNavigationResponseStarted) {
+    this._session = void 0;
+    this._requests = void 0;
+    this._page = void 0;
+    this._eventListeners = void 0;
+    this._onNavigationResponseStarted = void 0;
+    this._userRequestInterceptionEnabled = false;
+    this._protocolRequestInterceptionEnabled = false;
+    this._credentials = void 0;
+    this._intercepId = void 0;
+    this._session = bidiSession;
+    this._requests = new Map();
+    this._page = page;
+    this._onNavigationResponseStarted = onNavigationResponseStarted;
+    this._eventListeners = [_eventsHelper.eventsHelper.addEventListener(bidiSession, 'network.beforeRequestSent', this._onBeforeRequestSent.bind(this)), _eventsHelper.eventsHelper.addEventListener(bidiSession, 'network.responseStarted', this._onResponseStarted.bind(this)), _eventsHelper.eventsHelper.addEventListener(bidiSession, 'network.responseCompleted', this._onResponseCompleted.bind(this)), _eventsHelper.eventsHelper.addEventListener(bidiSession, 'network.fetchError', this._onFetchError.bind(this)), _eventsHelper.eventsHelper.addEventListener(bidiSession, 'network.authRequired', this._onAuthRequired.bind(this))];
+  }
+  dispose() {
+    _eventsHelper.eventsHelper.removeEventListeners(this._eventListeners);
+  }
+  _onBeforeRequestSent(param) {
+    if (param.request.url.startsWith('data:')) return;
+    const redirectedFrom = param.redirectCount ? this._requests.get(param.request.request) || null : null;
+    const frame = redirectedFrom ? redirectedFrom.request.frame() : param.context ? this._page._frameManager.frame(param.context) : null;
+    if (!frame) return;
+    if (redirectedFrom) this._requests.delete(redirectedFrom._id);
+    let route;
+    if (param.intercepts) {
+      // We do not support intercepting redirects.
+      if (redirectedFrom) {
+        var _redirectedFrom$_orig;
+        this._session.sendMayFail('network.continueRequest', {
+          request: param.request.request,
+          headers: (_redirectedFrom$_orig = redirectedFrom._originalRequestRoute) === null || _redirectedFrom$_orig === void 0 ? void 0 : _redirectedFrom$_orig._alreadyContinuedHeaders
+        });
+      } else {
+        route = new BidiRouteImpl(this._session, param.request.request);
+      }
+    }
+    const request = new BidiRequest(frame, redirectedFrom, param, route);
+    this._requests.set(request._id, request);
+    this._page._frameManager.requestStarted(request.request, route);
+  }
+  _onResponseStarted(params) {
+    const request = this._requests.get(params.request.request);
+    if (!request) return;
+    const getResponseBody = async () => {
+      throw new Error(`Response body is not available for requests in Bidi`);
+    };
+    const timings = params.request.timings;
+    const startTime = timings.requestTime;
+    function relativeToStart(time) {
+      if (!time) return -1;
+      return (time - startTime) / 1000;
+    }
+    const timing = {
+      startTime: startTime / 1000,
+      requestStart: relativeToStart(timings.requestStart),
+      responseStart: relativeToStart(timings.responseStart),
+      domainLookupStart: relativeToStart(timings.dnsStart),
+      domainLookupEnd: relativeToStart(timings.dnsEnd),
+      connectStart: relativeToStart(timings.connectStart),
+      secureConnectionStart: relativeToStart(timings.tlsStart),
+      connectEnd: relativeToStart(timings.connectEnd)
+    };
+    const response = new network.Response(request.request, params.response.status, params.response.statusText, fromBidiHeaders(params.response.headers), timing, getResponseBody, false);
+    response._serverAddrFinished();
+    response._securityDetailsFinished();
+    // "raw" headers are the same as "provisional" headers in Bidi.
+    response.setRawResponseHeaders(null);
+    response.setResponseHeadersSize(params.response.headersSize);
+    this._page._frameManager.requestReceivedResponse(response);
+    if (params.navigation) this._onNavigationResponseStarted(params);
+  }
+  _onResponseCompleted(params) {
+    const request = this._requests.get(params.request.request);
+    if (!request) return;
+    const response = request.request._existingResponse();
+    // TODO: body size is the encoded size
+    response.setTransferSize(params.response.bodySize);
+    response.setEncodedBodySize(params.response.bodySize);
+
+    // Keep redirected requests in the map for future reference as redirectedFrom.
+    const isRedirected = response.status() >= 300 && response.status() <= 399;
+    const responseEndTime = params.request.timings.responseEnd / 1000 - response.timing().startTime;
+    if (isRedirected) {
+      response._requestFinished(responseEndTime);
+    } else {
+      this._requests.delete(request._id);
+      response._requestFinished(responseEndTime);
+    }
+    response._setHttpVersion(params.response.protocol);
+    this._page._frameManager.reportRequestFinished(request.request, response);
+  }
+  _onFetchError(params) {
+    const request = this._requests.get(params.request.request);
+    if (!request) return;
+    this._requests.delete(request._id);
+    const response = request.request._existingResponse();
+    if (response) {
+      response.setTransferSize(null);
+      response.setEncodedBodySize(null);
+      response._requestFinished(-1);
+    }
+    request.request._setFailureText(params.errorText);
+    // TODO: support canceled flag
+    this._page._frameManager.requestFailed(request.request, params.errorText === 'NS_BINDING_ABORTED');
+  }
+  _onAuthRequired(params) {
+    var _params$response$auth;
+    const isBasic = (_params$response$auth = params.response.authChallenges) === null || _params$response$auth === void 0 ? void 0 : _params$response$auth.some(challenge => challenge.scheme.startsWith('Basic'));
+    const credentials = this._page._browserContext._options.httpCredentials;
+    if (isBasic && credentials) {
+      this._session.sendMayFail('network.continueWithAuth', {
+        request: params.request.request,
+        action: 'provideCredentials',
+        credentials: {
+          type: 'password',
+          username: credentials.username,
+          password: credentials.password
+        }
+      });
+    } else {
+      this._session.sendMayFail('network.continueWithAuth', {
+        request: params.request.request,
+        action: 'default'
+      });
+    }
+  }
+  async setRequestInterception(value) {
+    this._userRequestInterceptionEnabled = value;
+    await this._updateProtocolRequestInterception();
+  }
+  async setCredentials(credentials) {
+    this._credentials = credentials;
+    await this._updateProtocolRequestInterception();
+  }
+  async _updateProtocolRequestInterception(initial) {
+    const enabled = this._userRequestInterceptionEnabled || !!this._credentials;
+    if (enabled === this._protocolRequestInterceptionEnabled) return;
+    this._protocolRequestInterceptionEnabled = enabled;
+    if (initial && !enabled) return;
+    const cachePromise = this._session.send('network.setCacheBehavior', {
+      cacheBehavior: enabled ? 'bypass' : 'default'
+    });
+    let interceptPromise = Promise.resolve(undefined);
+    if (enabled) {
+      interceptPromise = this._session.send('network.addIntercept', {
+        phases: [bidi.Network.InterceptPhase.AuthRequired, bidi.Network.InterceptPhase.BeforeRequestSent],
+        urlPatterns: [{
+          type: 'pattern'
+        }]
+        // urlPatterns: [{ type: 'string', pattern: '*' }],
+      }).then(r => {
+        this._intercepId = r.intercept;
+      });
+    } else if (this._intercepId) {
+      interceptPromise = this._session.send('network.removeIntercept', {
+        intercept: this._intercepId
+      });
+      this._intercepId = undefined;
+    }
+    await Promise.all([cachePromise, interceptPromise]);
+  }
+}
+exports.BidiNetworkManager = BidiNetworkManager;
+class BidiRequest {
+  constructor(frame, redirectedFrom, payload, route) {
+    var _payload$navigation;
+    this.request = void 0;
+    this._id = void 0;
+    this._redirectedTo = void 0;
+    // Only first request in the chain can be intercepted, so this will
+    // store the first and only Route in the chain (if any).
+    this._originalRequestRoute = void 0;
+    this._id = payload.request.request;
+    if (redirectedFrom) redirectedFrom._redirectedTo = this;
+    // TODO: missing in the spec?
+    const postDataBuffer = null;
+    this.request = new network.Request(frame._page._browserContext, frame, null, redirectedFrom ? redirectedFrom.request : null, (_payload$navigation = payload.navigation) !== null && _payload$navigation !== void 0 ? _payload$navigation : undefined, payload.request.url, 'other', payload.request.method, postDataBuffer, fromBidiHeaders(payload.request.headers));
+    // "raw" headers are the same as "provisional" headers in Bidi.
+    this.request.setRawRequestHeaders(null);
+    this.request._setBodySize(payload.request.bodySize || 0);
+    this._originalRequestRoute = route !== null && route !== void 0 ? route : redirectedFrom === null || redirectedFrom === void 0 ? void 0 : redirectedFrom._originalRequestRoute;
+    route === null || route === void 0 || route._setRequest(this.request);
+  }
+  _finalRequest() {
+    let request = this;
+    while (request._redirectedTo) request = request._redirectedTo;
+    return request;
+  }
+}
+class BidiRouteImpl {
+  constructor(session, requestId) {
+    this._requestId = void 0;
+    this._session = void 0;
+    this._request = void 0;
+    this._alreadyContinuedHeaders = void 0;
+    this._session = session;
+    this._requestId = requestId;
+  }
+  _setRequest(request) {
+    this._request = request;
+  }
+  async continue(overrides) {
+    // Firefox does not update content-length header.
+    let headers = overrides.headers || this._request.headers();
+    if (overrides.postData && headers) {
+      headers = headers.map(header => {
+        if (header.name.toLowerCase() === 'content-length') return {
+          name: header.name,
+          value: overrides.postData.byteLength.toString()
+        };
+        return header;
+      });
+    }
+    this._alreadyContinuedHeaders = toBidiHeaders(headers);
+    await this._session.sendMayFail('network.continueRequest', {
+      request: this._requestId,
+      url: overrides.url,
+      method: overrides.method,
+      // TODO: cookies!
+      headers: this._alreadyContinuedHeaders,
+      body: overrides.postData ? {
+        type: 'base64',
+        value: Buffer.from(overrides.postData).toString('base64')
+      } : undefined
+    });
+  }
+  async fulfill(response) {
+    const base64body = response.isBase64 ? response.body : Buffer.from(response.body).toString('base64');
+    await this._session.sendMayFail('network.provideResponse', {
+      request: this._requestId,
+      statusCode: response.status,
+      reasonPhrase: network.statusText(response.status),
+      headers: toBidiHeaders(response.headers),
+      body: {
+        type: 'base64',
+        value: base64body
+      }
+    });
+  }
+  async abort(errorCode) {
+    await this._session.sendMayFail('network.failRequest', {
+      request: this._requestId
+    });
+  }
+}
+function fromBidiHeaders(bidiHeaders) {
+  const result = [];
+  for (const {
+    name,
+    value
+  } of bidiHeaders) result.push({
+    name,
+    value: bidiBytesValueToString(value)
+  });
+  return result;
+}
+function toBidiHeaders(headers) {
+  return headers.map(({
+    name,
+    value
+  }) => ({
+    name,
+    value: {
+      type: 'string',
+      value
+    }
+  }));
+}
+function bidiBytesValueToString(value) {
+  if (value.type === 'string') return value.value;
+  if (value.type === 'base64') return Buffer.from(value.type, 'base64').toString('binary');
+  return 'unknown value type: ' + value.type;
+}