rebrowser-playwright-core 1.47.2

package/lib/server/bidi/bidiExecutionContext.js

@@ -0,0 +1,162 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BidiExecutionContext = void 0;
+var _utilityScriptSerializers = require("../isomorphic/utilityScriptSerializers");
+var js = _interopRequireWildcard(require("../javascript"));
+var _bidiDeserializer = require("./third_party/bidiDeserializer");
+var bidi = _interopRequireWildcard(require("./third_party/bidiProtocol"));
+var _bidiSerializer = require("./third_party/bidiSerializer");
+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 BidiExecutionContext {
+  constructor(session, realmInfo) {
+    this._session = void 0;
+    this._target = void 0;
+    this._session = session;
+    if (realmInfo.type === 'window') {
+      // Simple realm does not seem to work for Window contexts.
+      this._target = {
+        context: realmInfo.context,
+        sandbox: realmInfo.sandbox
+      };
+    } else {
+      this._target = {
+        realm: realmInfo.realm
+      };
+    }
+  }
+  async rawEvaluateJSON(expression) {
+    const response = await this._session.send('script.evaluate', {
+      expression,
+      target: this._target,
+      serializationOptions: {
+        maxObjectDepth: 10,
+        maxDomDepth: 10
+      },
+      awaitPromise: true,
+      userActivation: true
+    });
+    if (response.type === 'success') return _bidiDeserializer.BidiDeserializer.deserialize(response.result);
+    if (response.type === 'exception') throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text + '\nFull val: ' + JSON.stringify(response.exceptionDetails));
+    throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));
+  }
+  async rawEvaluateHandle(expression) {
+    const response = await this._session.send('script.evaluate', {
+      expression,
+      target: this._target,
+      resultOwnership: bidi.Script.ResultOwnership.Root,
+      // Necessary for the handle to be returned.
+      serializationOptions: {
+        maxObjectDepth: 0,
+        maxDomDepth: 0
+      },
+      awaitPromise: true,
+      userActivation: true
+    });
+    if (response.type === 'success') {
+      if ('handle' in response.result) return response.result.handle;
+      throw new js.JavaScriptErrorInEvaluate('Cannot get handle: ' + JSON.stringify(response.result));
+    }
+    if (response.type === 'exception') throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text + '\nFull val: ' + JSON.stringify(response.exceptionDetails));
+    throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));
+  }
+  rawCallFunctionNoReply(func, ...args) {
+    throw new Error('Method not implemented.');
+  }
+  async evaluateWithArguments(functionDeclaration, returnByValue, utilityScript, values, objectIds) {
+    const response = await this._session.send('script.callFunction', {
+      functionDeclaration,
+      target: this._target,
+      arguments: [{
+        handle: utilityScript._objectId
+      }, ...values.map(_bidiSerializer.BidiSerializer.serialize), ...objectIds.map(handle => ({
+        handle
+      }))],
+      resultOwnership: returnByValue ? undefined : bidi.Script.ResultOwnership.Root,
+      // Necessary for the handle to be returned.
+      serializationOptions: returnByValue ? {} : {
+        maxObjectDepth: 0,
+        maxDomDepth: 0
+      },
+      awaitPromise: true,
+      userActivation: true
+    });
+    if (response.type === 'exception') throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text + '\nFull val: ' + JSON.stringify(response.exceptionDetails));
+    if (response.type === 'success') {
+      if (returnByValue) return (0, _utilityScriptSerializers.parseEvaluationResultValue)(_bidiDeserializer.BidiDeserializer.deserialize(response.result));
+      const objectId = 'handle' in response.result ? response.result.handle : undefined;
+      return utilityScript._context.createHandle({
+        objectId,
+        ...response.result
+      });
+    }
+    throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));
+  }
+  async getProperties(context, objectId) {
+    throw new Error('Method not implemented.');
+  }
+  createHandle(context, jsRemoteObject) {
+    const remoteObject = jsRemoteObject;
+    return new js.JSHandle(context, remoteObject.type, renderPreview(remoteObject), jsRemoteObject.objectId, remoteObjectValue(remoteObject));
+  }
+  async releaseHandle(objectId) {
+    await this._session.send('script.disown', {
+      target: this._target,
+      handles: [objectId]
+    });
+  }
+  objectCount(objectId) {
+    throw new Error('Method not implemented.');
+  }
+  async rawCallFunction(functionDeclaration, arg) {
+    const response = await this._session.send('script.callFunction', {
+      functionDeclaration,
+      target: this._target,
+      arguments: [arg],
+      resultOwnership: bidi.Script.ResultOwnership.Root,
+      // Necessary for the handle to be returned.
+      serializationOptions: {
+        maxObjectDepth: 0,
+        maxDomDepth: 0
+      },
+      awaitPromise: true,
+      userActivation: true
+    });
+    if (response.type === 'exception') throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text + '\nFull val: ' + JSON.stringify(response.exceptionDetails));
+    if (response.type === 'success') return response.result;
+    throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));
+  }
+}
+exports.BidiExecutionContext = BidiExecutionContext;
+function renderPreview(remoteObject) {
+  if (remoteObject.type === 'undefined') return 'undefined';
+  if (remoteObject.type === 'null') return 'null';
+  if ('value' in remoteObject) return String(remoteObject.value);
+  return `<${remoteObject.type}>`;
+}
+function remoteObjectValue(remoteObject) {
+  if (remoteObject.type === 'undefined') return undefined;
+  if (remoteObject.type === 'null') return null;
+  if (remoteObject.type === 'number' && typeof remoteObject.value === 'string') return js.parseUnserializableValue(remoteObject.value);
+  if ('value' in remoteObject) return remoteObject.value;
+  return undefined;
+}

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);
+}