@checkly/playwright-core 1.41.2-beta.0

package/lib/client/accessibility.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Accessibility = void 0;
+/**
+ * Copyright 2017 Google Inc. All rights reserved.
+ * Modifications 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.
+ */
+
+function axNodeFromProtocol(axNode) {
+  const result = {
+    ...axNode,
+    value: axNode.valueNumber !== undefined ? axNode.valueNumber : axNode.valueString,
+    checked: axNode.checked === 'checked' ? true : axNode.checked === 'unchecked' ? false : axNode.checked,
+    pressed: axNode.pressed === 'pressed' ? true : axNode.pressed === 'released' ? false : axNode.pressed,
+    children: axNode.children ? axNode.children.map(axNodeFromProtocol) : undefined
+  };
+  delete result.valueNumber;
+  delete result.valueString;
+  return result;
+}
+class Accessibility {
+  constructor(channel) {
+    this._channel = void 0;
+    this._channel = channel;
+  }
+  async snapshot(options = {}) {
+    const root = options.root ? options.root._elementChannel : undefined;
+    const result = await this._channel.accessibilitySnapshot({
+      interestingOnly: options.interestingOnly,
+      root
+    });
+    return result.rootAXNode ? axNodeFromProtocol(result.rootAXNode) : null;
+  }
+}
+exports.Accessibility = Accessibility;

package/lib/client/android.js

@@ -0,0 +1,473 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.AndroidWebView = exports.AndroidSocket = exports.AndroidInput = exports.AndroidDevice = exports.Android = void 0;
+var _fs = _interopRequireDefault(require("fs"));
+var _utils = require("../utils");
+var _events = require("./events");
+var _browserContext = require("./browserContext");
+var _channelOwner = require("./channelOwner");
+var _timeoutSettings = require("../common/timeoutSettings");
+var _waiter = require("./waiter");
+var _events2 = require("events");
+var _connection = require("./connection");
+var _errors = require("./errors");
+var _timeoutRunner = require("../utils/timeoutRunner");
+let _Symbol$asyncDispose;
+/**
+ * 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.
+ */
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+class Android extends _channelOwner.ChannelOwner {
+  static from(android) {
+    return android._object;
+  }
+  constructor(parent, type, guid, initializer) {
+    super(parent, type, guid, initializer);
+    this._timeoutSettings = void 0;
+    this._serverLauncher = void 0;
+    this._timeoutSettings = new _timeoutSettings.TimeoutSettings();
+  }
+  setDefaultTimeout(timeout) {
+    this._timeoutSettings.setDefaultTimeout(timeout);
+    this._channel.setDefaultTimeoutNoReply({
+      timeout
+    });
+  }
+  async devices(options = {}) {
+    const {
+      devices
+    } = await this._channel.devices(options);
+    return devices.map(d => AndroidDevice.from(d));
+  }
+  async launchServer(options = {}) {
+    if (!this._serverLauncher) throw new Error('Launching server is not supported');
+    return await this._serverLauncher.launchServer(options);
+  }
+  async connect(wsEndpoint, options = {}) {
+    return await this._wrapApiCall(async () => {
+      const deadline = options.timeout ? (0, _utils.monotonicTime)() + options.timeout : 0;
+      const headers = {
+        'x-playwright-browser': 'android',
+        ...options.headers
+      };
+      const localUtils = this._connection.localUtils();
+      const connectParams = {
+        wsEndpoint,
+        headers,
+        slowMo: options.slowMo,
+        timeout: options.timeout
+      };
+      const {
+        pipe
+      } = await localUtils._channel.connect(connectParams);
+      const closePipe = () => pipe.close().catch(() => {});
+      const connection = new _connection.Connection(localUtils, this._instrumentation);
+      connection.markAsRemote();
+      connection.on('close', closePipe);
+      let device;
+      let closeError;
+      const onPipeClosed = () => {
+        var _device;
+        (_device = device) === null || _device === void 0 || _device._didClose();
+        connection.close(closeError);
+      };
+      pipe.on('closed', onPipeClosed);
+      connection.onmessage = message => pipe.send({
+        message
+      }).catch(onPipeClosed);
+      pipe.on('message', ({
+        message
+      }) => {
+        try {
+          connection.dispatch(message);
+        } catch (e) {
+          closeError = e;
+          closePipe();
+        }
+      });
+      const result = await (0, _timeoutRunner.raceAgainstDeadline)(async () => {
+        const playwright = await connection.initializePlaywright();
+        if (!playwright._initializer.preConnectedAndroidDevice) {
+          closePipe();
+          throw new Error('Malformed endpoint. Did you use Android.launchServer method?');
+        }
+        device = AndroidDevice.from(playwright._initializer.preConnectedAndroidDevice);
+        device._shouldCloseConnectionOnClose = true;
+        device.on(_events.Events.AndroidDevice.Close, closePipe);
+        return device;
+      }, deadline);
+      if (!result.timedOut) {
+        return result.result;
+      } else {
+        closePipe();
+        throw new Error(`Timeout ${options.timeout}ms exceeded`);
+      }
+    });
+  }
+}
+exports.Android = Android;
+_Symbol$asyncDispose = Symbol.asyncDispose;
+class AndroidDevice extends _channelOwner.ChannelOwner {
+  static from(androidDevice) {
+    return androidDevice._object;
+  }
+  constructor(parent, type, guid, initializer) {
+    super(parent, type, guid, initializer);
+    this._timeoutSettings = void 0;
+    this._webViews = new Map();
+    this._shouldCloseConnectionOnClose = false;
+    this.input = void 0;
+    this.input = new AndroidInput(this);
+    this._timeoutSettings = new _timeoutSettings.TimeoutSettings(parent._timeoutSettings);
+    this._channel.on('webViewAdded', ({
+      webView
+    }) => this._onWebViewAdded(webView));
+    this._channel.on('webViewRemoved', ({
+      socketName
+    }) => this._onWebViewRemoved(socketName));
+    this._channel.on('close', () => this._didClose());
+  }
+  _onWebViewAdded(webView) {
+    const view = new AndroidWebView(this, webView);
+    this._webViews.set(webView.socketName, view);
+    this.emit(_events.Events.AndroidDevice.WebView, view);
+  }
+  _onWebViewRemoved(socketName) {
+    const view = this._webViews.get(socketName);
+    this._webViews.delete(socketName);
+    if (view) view.emit(_events.Events.AndroidWebView.Close);
+  }
+  setDefaultTimeout(timeout) {
+    this._timeoutSettings.setDefaultTimeout(timeout);
+    this._channel.setDefaultTimeoutNoReply({
+      timeout
+    });
+  }
+  serial() {
+    return this._initializer.serial;
+  }
+  model() {
+    return this._initializer.model;
+  }
+  webViews() {
+    return [...this._webViews.values()];
+  }
+  async webView(selector, options) {
+    const predicate = v => {
+      if (selector.pkg) return v.pkg() === selector.pkg;
+      if (selector.socketName) return v._socketName() === selector.socketName;
+      return false;
+    };
+    const webView = [...this._webViews.values()].find(predicate);
+    if (webView) return webView;
+    return await this.waitForEvent('webview', {
+      ...options,
+      predicate
+    });
+  }
+  async wait(selector, options) {
+    await this._channel.wait({
+      selector: toSelectorChannel(selector),
+      ...options
+    });
+  }
+  async fill(selector, text, options) {
+    await this._channel.fill({
+      selector: toSelectorChannel(selector),
+      text,
+      ...options
+    });
+  }
+  async press(selector, key, options) {
+    await this.tap(selector, options);
+    await this.input.press(key);
+  }
+  async tap(selector, options) {
+    await this._channel.tap({
+      selector: toSelectorChannel(selector),
+      ...options
+    });
+  }
+  async drag(selector, dest, options) {
+    await this._channel.drag({
+      selector: toSelectorChannel(selector),
+      dest,
+      ...options
+    });
+  }
+  async fling(selector, direction, options) {
+    await this._channel.fling({
+      selector: toSelectorChannel(selector),
+      direction,
+      ...options
+    });
+  }
+  async longTap(selector, options) {
+    await this._channel.longTap({
+      selector: toSelectorChannel(selector),
+      ...options
+    });
+  }
+  async pinchClose(selector, percent, options) {
+    await this._channel.pinchClose({
+      selector: toSelectorChannel(selector),
+      percent,
+      ...options
+    });
+  }
+  async pinchOpen(selector, percent, options) {
+    await this._channel.pinchOpen({
+      selector: toSelectorChannel(selector),
+      percent,
+      ...options
+    });
+  }
+  async scroll(selector, direction, percent, options) {
+    await this._channel.scroll({
+      selector: toSelectorChannel(selector),
+      direction,
+      percent,
+      ...options
+    });
+  }
+  async swipe(selector, direction, percent, options) {
+    await this._channel.swipe({
+      selector: toSelectorChannel(selector),
+      direction,
+      percent,
+      ...options
+    });
+  }
+  async info(selector) {
+    return (await this._channel.info({
+      selector: toSelectorChannel(selector)
+    })).info;
+  }
+  async screenshot(options = {}) {
+    const {
+      binary
+    } = await this._channel.screenshot();
+    if (options.path) await _fs.default.promises.writeFile(options.path, binary);
+    return binary;
+  }
+  async [_Symbol$asyncDispose]() {
+    await this.close();
+  }
+  async close() {
+    try {
+      if (this._shouldCloseConnectionOnClose) this._connection.close();else await this._channel.close();
+    } catch (e) {
+      if ((0, _errors.isTargetClosedError)(e)) return;
+      throw e;
+    }
+  }
+  _didClose() {
+    this.emit(_events.Events.AndroidDevice.Close, this);
+  }
+  async shell(command) {
+    const {
+      result
+    } = await this._channel.shell({
+      command
+    });
+    return result;
+  }
+  async open(command) {
+    return AndroidSocket.from((await this._channel.open({
+      command
+    })).socket);
+  }
+  async installApk(file, options) {
+    await this._channel.installApk({
+      file: await loadFile(file),
+      args: options && options.args
+    });
+  }
+  async push(file, path, options) {
+    await this._channel.push({
+      file: await loadFile(file),
+      path,
+      mode: options ? options.mode : undefined
+    });
+  }
+  async launchBrowser(options = {}) {
+    const contextOptions = await (0, _browserContext.prepareBrowserContextParams)(options);
+    const result = await this._channel.launchBrowser(contextOptions);
+    const context = _browserContext.BrowserContext.from(result.context);
+    context._setOptions(contextOptions, {});
+    return context;
+  }
+  async waitForEvent(event, optionsOrPredicate = {}) {
+    return await this._wrapApiCall(async () => {
+      const timeout = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);
+      const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;
+      const waiter = _waiter.Waiter.createForEvent(this, event);
+      waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);
+      if (event !== _events.Events.AndroidDevice.Close) waiter.rejectOnEvent(this, _events.Events.AndroidDevice.Close, () => new _errors.TargetClosedError());
+      const result = await waiter.waitForEvent(this, event, predicate);
+      waiter.dispose();
+      return result;
+    });
+  }
+}
+exports.AndroidDevice = AndroidDevice;
+class AndroidSocket extends _channelOwner.ChannelOwner {
+  static from(androidDevice) {
+    return androidDevice._object;
+  }
+  constructor(parent, type, guid, initializer) {
+    super(parent, type, guid, initializer);
+    this._channel.on('data', ({
+      data
+    }) => this.emit(_events.Events.AndroidSocket.Data, data));
+    this._channel.on('close', () => this.emit(_events.Events.AndroidSocket.Close));
+  }
+  async write(data) {
+    await this._channel.write({
+      data
+    });
+  }
+  async close() {
+    await this._channel.close();
+  }
+  async [Symbol.asyncDispose]() {
+    await this.close();
+  }
+}
+exports.AndroidSocket = AndroidSocket;
+async function loadFile(file) {
+  if ((0, _utils.isString)(file)) return await _fs.default.promises.readFile(file);
+  return file;
+}
+class AndroidInput {
+  constructor(device) {
+    this._device = void 0;
+    this._device = device;
+  }
+  async type(text) {
+    await this._device._channel.inputType({
+      text
+    });
+  }
+  async press(key) {
+    await this._device._channel.inputPress({
+      key
+    });
+  }
+  async tap(point) {
+    await this._device._channel.inputTap({
+      point
+    });
+  }
+  async swipe(from, segments, steps) {
+    await this._device._channel.inputSwipe({
+      segments,
+      steps
+    });
+  }
+  async drag(from, to, steps) {
+    await this._device._channel.inputDrag({
+      from,
+      to,
+      steps
+    });
+  }
+}
+exports.AndroidInput = AndroidInput;
+function toSelectorChannel(selector) {
+  const {
+    checkable,
+    checked,
+    clazz,
+    clickable,
+    depth,
+    desc,
+    enabled,
+    focusable,
+    focused,
+    hasChild,
+    hasDescendant,
+    longClickable,
+    pkg,
+    res,
+    scrollable,
+    selected,
+    text
+  } = selector;
+  const toRegex = value => {
+    if (value === undefined) return undefined;
+    if ((0, _utils.isRegExp)(value)) return value.source;
+    return '^' + value.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&').replace(/-/g, '\\x2d') + '$';
+  };
+  return {
+    checkable,
+    checked,
+    clazz: toRegex(clazz),
+    pkg: toRegex(pkg),
+    desc: toRegex(desc),
+    res: toRegex(res),
+    text: toRegex(text),
+    clickable,
+    depth,
+    enabled,
+    focusable,
+    focused,
+    hasChild: hasChild ? {
+      selector: toSelectorChannel(hasChild.selector)
+    } : undefined,
+    hasDescendant: hasDescendant ? {
+      selector: toSelectorChannel(hasDescendant.selector),
+      maxDepth: hasDescendant.maxDepth
+    } : undefined,
+    longClickable,
+    scrollable,
+    selected
+  };
+}
+class AndroidWebView extends _events2.EventEmitter {
+  constructor(device, data) {
+    super();
+    this._device = void 0;
+    this._data = void 0;
+    this._pagePromise = void 0;
+    this._device = device;
+    this._data = data;
+  }
+  pid() {
+    return this._data.pid;
+  }
+  pkg() {
+    return this._data.pkg;
+  }
+  _socketName() {
+    return this._data.socketName;
+  }
+  async page() {
+    if (!this._pagePromise) this._pagePromise = this._fetchPage();
+    return await this._pagePromise;
+  }
+  async _fetchPage() {
+    const {
+      context
+    } = await this._device._channel.connectToWebView({
+      socketName: this._data.socketName
+    });
+    return _browserContext.BrowserContext.from(context).pages()[0];
+  }
+}
+exports.AndroidWebView = AndroidWebView;