@checkly/playwright-core 1.41.2-beta.0

package/lib/server/isomorphic/utilityScriptSerializers.js

@@ -0,0 +1,212 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.serializeAsCallArgument = exports.parseEvaluationResultValue = void 0;
+exports.source = source;
+/**
+ * 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 source() {
+  function isRegExp(obj) {
+    try {
+      return obj instanceof RegExp || Object.prototype.toString.call(obj) === '[object RegExp]';
+    } catch (error) {
+      return false;
+    }
+  }
+  function isDate(obj) {
+    try {
+      return obj instanceof Date || Object.prototype.toString.call(obj) === '[object Date]';
+    } catch (error) {
+      return false;
+    }
+  }
+  function isURL(obj) {
+    try {
+      return obj instanceof URL || Object.prototype.toString.call(obj) === '[object URL]';
+    } catch (error) {
+      return false;
+    }
+  }
+  function isError(obj) {
+    try {
+      var _Object$getPrototypeO;
+      return obj instanceof Error || obj && ((_Object$getPrototypeO = Object.getPrototypeOf(obj)) === null || _Object$getPrototypeO === void 0 ? void 0 : _Object$getPrototypeO.name) === 'Error';
+    } catch (error) {
+      return false;
+    }
+  }
+  function parseEvaluationResultValue(value, handles = [], refs = new Map()) {
+    if (Object.is(value, undefined)) return undefined;
+    if (typeof value === 'object' && value) {
+      if ('ref' in value) return refs.get(value.ref);
+      if ('v' in value) {
+        if (value.v === 'undefined') return undefined;
+        if (value.v === 'null') return null;
+        if (value.v === 'NaN') return NaN;
+        if (value.v === 'Infinity') return Infinity;
+        if (value.v === '-Infinity') return -Infinity;
+        if (value.v === '-0') return -0;
+        return undefined;
+      }
+      if ('d' in value) return new Date(value.d);
+      if ('u' in value) return new URL(value.u);
+      if ('bi' in value) return BigInt(value.bi);
+      if ('r' in value) return new RegExp(value.r.p, value.r.f);
+      if ('a' in value) {
+        const result = [];
+        refs.set(value.id, result);
+        for (const a of value.a) result.push(parseEvaluationResultValue(a, handles, refs));
+        return result;
+      }
+      if ('o' in value) {
+        const result = {};
+        refs.set(value.id, result);
+        for (const {
+          k,
+          v
+        } of value.o) result[k] = parseEvaluationResultValue(v, handles, refs);
+        return result;
+      }
+      if ('h' in value) return handles[value.h];
+    }
+    return value;
+  }
+  function serializeAsCallArgument(value, handleSerializer) {
+    return serialize(value, handleSerializer, {
+      visited: new Map(),
+      lastId: 0
+    });
+  }
+  function serialize(value, handleSerializer, visitorInfo) {
+    if (value && typeof value === 'object') {
+      if (typeof globalThis.Window === 'function' && value instanceof globalThis.Window) return 'ref: <Window>';
+      if (typeof globalThis.Document === 'function' && value instanceof globalThis.Document) return 'ref: <Document>';
+      if (typeof globalThis.Node === 'function' && value instanceof globalThis.Node) return 'ref: <Node>';
+    }
+    return innerSerialize(value, handleSerializer, visitorInfo);
+  }
+  function innerSerialize(value, handleSerializer, visitorInfo) {
+    const result = handleSerializer(value);
+    if ('fallThrough' in result) value = result.fallThrough;else return result;
+    if (typeof value === 'symbol') return {
+      v: 'undefined'
+    };
+    if (Object.is(value, undefined)) return {
+      v: 'undefined'
+    };
+    if (Object.is(value, null)) return {
+      v: 'null'
+    };
+    if (Object.is(value, NaN)) return {
+      v: 'NaN'
+    };
+    if (Object.is(value, Infinity)) return {
+      v: 'Infinity'
+    };
+    if (Object.is(value, -Infinity)) return {
+      v: '-Infinity'
+    };
+    if (Object.is(value, -0)) return {
+      v: '-0'
+    };
+    if (typeof value === 'boolean') return value;
+    if (typeof value === 'number') return value;
+    if (typeof value === 'string') return value;
+    if (typeof value === 'bigint') return {
+      bi: value.toString()
+    };
+    if (isError(value)) {
+      var _error$stack;
+      const error = value;
+      if ((_error$stack = error.stack) !== null && _error$stack !== void 0 && _error$stack.startsWith(error.name + ': ' + error.message)) {
+        // v8
+        return error.stack;
+      }
+      return `${error.name}: ${error.message}\n${error.stack}`;
+    }
+    if (isDate(value)) return {
+      d: value.toJSON()
+    };
+    if (isURL(value)) return {
+      u: value.toJSON()
+    };
+    if (isRegExp(value)) return {
+      r: {
+        p: value.source,
+        f: value.flags
+      }
+    };
+    const id = visitorInfo.visited.get(value);
+    if (id) return {
+      ref: id
+    };
+    if (Array.isArray(value)) {
+      const a = [];
+      const id = ++visitorInfo.lastId;
+      visitorInfo.visited.set(value, id);
+      for (let i = 0; i < value.length; ++i) a.push(serialize(value[i], handleSerializer, visitorInfo));
+      return {
+        a,
+        id
+      };
+    }
+    if (typeof value === 'object') {
+      const o = [];
+      const id = ++visitorInfo.lastId;
+      visitorInfo.visited.set(value, id);
+      for (const name of Object.keys(value)) {
+        let item;
+        try {
+          item = value[name];
+        } catch (e) {
+          continue; // native bindings will throw sometimes
+        }
+        if (name === 'toJSON' && typeof item === 'function') o.push({
+          k: name,
+          v: {
+            o: [],
+            id: 0
+          }
+        });else o.push({
+          k: name,
+          v: serialize(item, handleSerializer, visitorInfo)
+        });
+      }
+      let jsonWrapper;
+      try {
+        // If Object.keys().length === 0 we fall back to toJSON if it exists
+        if (o.length === 0 && value.toJSON && typeof value.toJSON === 'function') jsonWrapper = {
+          value: value.toJSON()
+        };
+      } catch (e) {}
+      if (jsonWrapper) return innerSerialize(jsonWrapper.value, handleSerializer, visitorInfo);
+      return {
+        o,
+        id
+      };
+    }
+  }
+  return {
+    parseEvaluationResultValue,
+    serializeAsCallArgument
+  };
+}
+const result = source();
+const parseEvaluationResultValue = exports.parseEvaluationResultValue = result.parseEvaluationResultValue;
+const serializeAsCallArgument = exports.serializeAsCallArgument = result.serializeAsCallArgument;

package/lib/server/javascript.js

@@ -0,0 +1,305 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.JavaScriptErrorInEvaluate = exports.JSHandle = exports.ExecutionContext = void 0;
+exports.evaluate = evaluate;
+exports.evaluateExpression = evaluateExpression;
+exports.isJavaScriptErrorInEvaluate = isJavaScriptErrorInEvaluate;
+exports.normalizeEvaluationExpression = normalizeEvaluationExpression;
+exports.parseUnserializableValue = parseUnserializableValue;
+exports.sparseArrayToString = sparseArrayToString;
+var utilityScriptSource = _interopRequireWildcard(require("../generated/utilityScriptSource"));
+var _utilityScriptSerializers = require("./isomorphic/utilityScriptSerializers");
+var _instrumentation = require("./instrumentation");
+var _manualPromise = require("../utils/manualPromise");
+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 ExecutionContext extends _instrumentation.SdkObject {
+  constructor(parent, delegate, worldNameForTest) {
+    super(parent, 'execution-context');
+    this._delegate = void 0;
+    this._utilityScriptPromise = void 0;
+    this._contextDestroyedScope = new _manualPromise.LongStandingScope();
+    this.worldNameForTest = void 0;
+    this.worldNameForTest = worldNameForTest;
+    this._delegate = delegate;
+  }
+  contextDestroyed(reason) {
+    this._contextDestroyedScope.close(new Error(reason));
+  }
+  async _raceAgainstContextDestroyed(promise) {
+    return this._contextDestroyedScope.race(promise);
+  }
+  rawEvaluateJSON(expression) {
+    return this._raceAgainstContextDestroyed(this._delegate.rawEvaluateJSON(expression));
+  }
+  rawEvaluateHandle(expression) {
+    return this._raceAgainstContextDestroyed(this._delegate.rawEvaluateHandle(expression));
+  }
+  rawCallFunctionNoReply(func, ...args) {
+    this._delegate.rawCallFunctionNoReply(func, ...args);
+  }
+  evaluateWithArguments(expression, returnByValue, utilityScript, values, objectIds) {
+    return this._raceAgainstContextDestroyed(this._delegate.evaluateWithArguments(expression, returnByValue, utilityScript, values, objectIds));
+  }
+  getProperties(context, objectId) {
+    return this._raceAgainstContextDestroyed(this._delegate.getProperties(context, objectId));
+  }
+  createHandle(remoteObject) {
+    return this._delegate.createHandle(this, remoteObject);
+  }
+  releaseHandle(objectId) {
+    return this._delegate.releaseHandle(objectId);
+  }
+  adoptIfNeeded(handle) {
+    return null;
+  }
+  utilityScript() {
+    if (!this._utilityScriptPromise) {
+      const source = `
+      (() => {
+        const module = {};
+        ${utilityScriptSource.source}
+        return new (module.exports.UtilityScript())();
+      })();`;
+      this._utilityScriptPromise = this._raceAgainstContextDestroyed(this._delegate.rawEvaluateHandle(source).then(objectId => new JSHandle(this, 'object', 'UtilityScript', objectId)));
+    }
+    return this._utilityScriptPromise;
+  }
+  async objectCount(objectId) {
+    return this._delegate.objectCount(objectId);
+  }
+  async doSlowMo() {
+    // overridden in FrameExecutionContext
+  }
+}
+exports.ExecutionContext = ExecutionContext;
+class JSHandle extends _instrumentation.SdkObject {
+  constructor(context, type, preview, objectId, value) {
+    super(context, 'handle');
+    this.__jshandle = true;
+    this._context = void 0;
+    this._disposed = false;
+    this._objectId = void 0;
+    this._value = void 0;
+    this._objectType = void 0;
+    this._preview = void 0;
+    this._previewCallback = void 0;
+    this._context = context;
+    this._objectId = objectId;
+    this._value = value;
+    this._objectType = type;
+    this._preview = this._objectId ? preview || `JSHandle@${this._objectType}` : String(value);
+    if (this._objectId && globalThis.leakedJSHandles) globalThis.leakedJSHandles.set(this, new Error('Leaked JSHandle'));
+  }
+  callFunctionNoReply(func, arg) {
+    this._context.rawCallFunctionNoReply(func, this, arg);
+  }
+  async evaluate(pageFunction, arg) {
+    return evaluate(this._context, true /* returnByValue */, pageFunction, this, arg);
+  }
+  async evaluateHandle(pageFunction, arg) {
+    return evaluate(this._context, false /* returnByValue */, pageFunction, this, arg);
+  }
+  async evaluateExpression(expression, options, arg) {
+    const value = await evaluateExpression(this._context, expression, {
+      ...options,
+      returnByValue: true
+    }, this, arg);
+    await this._context.doSlowMo();
+    return value;
+  }
+  async evaluateExpressionHandle(expression, options, arg) {
+    const value = await evaluateExpression(this._context, expression, {
+      ...options,
+      returnByValue: false
+    }, this, arg);
+    await this._context.doSlowMo();
+    return value;
+  }
+  async getProperty(propertyName) {
+    const objectHandle = await this.evaluateHandle((object, propertyName) => {
+      const result = {
+        __proto__: null
+      };
+      result[propertyName] = object[propertyName];
+      return result;
+    }, propertyName);
+    const properties = await objectHandle.getProperties();
+    const result = properties.get(propertyName);
+    objectHandle.dispose();
+    return result;
+  }
+  async getProperties() {
+    if (!this._objectId) return new Map();
+    return this._context.getProperties(this._context, this._objectId);
+  }
+  rawValue() {
+    return this._value;
+  }
+  async jsonValue() {
+    if (!this._objectId) return this._value;
+    const utilityScript = await this._context.utilityScript();
+    const script = `(utilityScript, ...args) => utilityScript.jsonValue(...args)`;
+    return this._context.evaluateWithArguments(script, true, utilityScript, [true], [this._objectId]);
+  }
+  asElement() {
+    return null;
+  }
+  dispose() {
+    if (this._disposed) return;
+    this._disposed = true;
+    if (this._objectId) {
+      this._context.releaseHandle(this._objectId).catch(e => {});
+      if (globalThis.leakedJSHandles) globalThis.leakedJSHandles.delete(this);
+    }
+  }
+  toString() {
+    return this._preview;
+  }
+  _setPreviewCallback(callback) {
+    this._previewCallback = callback;
+  }
+  preview() {
+    return this._preview;
+  }
+  worldNameForTest() {
+    return this._context.worldNameForTest;
+  }
+  _setPreview(preview) {
+    this._preview = preview;
+    if (this._previewCallback) this._previewCallback(preview);
+  }
+  async objectCount() {
+    if (!this._objectId) throw new Error('Can only count objects for a handle that points to the constructor prototype');
+    return this._context.objectCount(this._objectId);
+  }
+}
+exports.JSHandle = JSHandle;
+async function evaluate(context, returnByValue, pageFunction, ...args) {
+  return evaluateExpression(context, String(pageFunction), {
+    returnByValue,
+    isFunction: typeof pageFunction === 'function'
+  }, ...args);
+}
+async function evaluateExpression(context, expression, options, ...args) {
+  const utilityScript = await context.utilityScript();
+  expression = normalizeEvaluationExpression(expression, options.isFunction);
+  const handles = [];
+  const toDispose = [];
+  const pushHandle = handle => {
+    handles.push(handle);
+    return handles.length - 1;
+  };
+  args = args.map(arg => (0, _utilityScriptSerializers.serializeAsCallArgument)(arg, handle => {
+    if (handle instanceof JSHandle) {
+      if (!handle._objectId) return {
+        fallThrough: handle._value
+      };
+      if (handle._disposed) throw new JavaScriptErrorInEvaluate('JSHandle is disposed!');
+      const adopted = context.adoptIfNeeded(handle);
+      if (adopted === null) return {
+        h: pushHandle(Promise.resolve(handle))
+      };
+      toDispose.push(adopted);
+      return {
+        h: pushHandle(adopted)
+      };
+    }
+    return {
+      fallThrough: handle
+    };
+  }));
+  const utilityScriptObjectIds = [];
+  for (const handle of await Promise.all(handles)) {
+    if (handle._context !== context) throw new JavaScriptErrorInEvaluate('JSHandles can be evaluated only in the context they were created!');
+    utilityScriptObjectIds.push(handle._objectId);
+  }
+
+  // See UtilityScript for arguments.
+  const utilityScriptValues = [options.isFunction, options.returnByValue, options.exposeUtilityScript, expression, args.length, ...args];
+  const script = `(utilityScript, ...args) => utilityScript.evaluate(...args)`;
+  try {
+    return await context.evaluateWithArguments(script, options.returnByValue || false, utilityScript, utilityScriptValues, utilityScriptObjectIds);
+  } finally {
+    toDispose.map(handlePromise => handlePromise.then(handle => handle.dispose()));
+  }
+}
+function parseUnserializableValue(unserializableValue) {
+  if (unserializableValue === 'NaN') return NaN;
+  if (unserializableValue === 'Infinity') return Infinity;
+  if (unserializableValue === '-Infinity') return -Infinity;
+  if (unserializableValue === '-0') return -0;
+}
+function normalizeEvaluationExpression(expression, isFunction) {
+  expression = expression.trim();
+  if (isFunction) {
+    try {
+      new Function('(' + expression + ')');
+    } catch (e1) {
+      // This means we might have a function shorthand. Try another
+      // time prefixing 'function '.
+      if (expression.startsWith('async ')) expression = 'async function ' + expression.substring('async '.length);else expression = 'function ' + expression;
+      try {
+        new Function('(' + expression + ')');
+      } catch (e2) {
+        // We tried hard to serialize, but there's a weird beast here.
+        throw new Error('Passed function is not well-serializable!');
+      }
+    }
+  }
+  if (/^(async)?\s*function(\s|\()/.test(expression)) expression = '(' + expression + ')';
+  return expression;
+}
+
+// Error inside the expression evaluation as opposed to a protocol error.
+class JavaScriptErrorInEvaluate extends Error {}
+exports.JavaScriptErrorInEvaluate = JavaScriptErrorInEvaluate;
+function isJavaScriptErrorInEvaluate(error) {
+  return error instanceof JavaScriptErrorInEvaluate;
+}
+function sparseArrayToString(entries) {
+  const arrayEntries = [];
+  for (const {
+    name,
+    value
+  } of entries) {
+    const index = +name;
+    if (isNaN(index) || index < 0) continue;
+    arrayEntries.push({
+      index,
+      value
+    });
+  }
+  arrayEntries.sort((a, b) => a.index - b.index);
+  let lastIndex = -1;
+  const tokens = [];
+  for (const {
+    index,
+    value
+  } of arrayEntries) {
+    const emptyItems = index - lastIndex - 1;
+    if (emptyItems === 1) tokens.push(`empty`);else if (emptyItems > 1) tokens.push(`empty x ${emptyItems}`);
+    tokens.push(String(value));
+    lastIndex = index;
+  }
+  return '[' + tokens.join(', ') + ']';
+}

package/lib/server/launchApp.js

@@ -0,0 +1,90 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.launchApp = launchApp;
+exports.syncLocalStorageWithSettings = syncLocalStorageWithSettings;
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _registry = require("./registry");
+var _utils = require("../utils");
+var _instrumentation = require("./instrumentation");
+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.
+ */
+
+async function launchApp(browserType, options) {
+  var _options$persistentCo, _options$persistentCo2;
+  const args = [...((_options$persistentCo = (_options$persistentCo2 = options.persistentContextOptions) === null || _options$persistentCo2 === void 0 ? void 0 : _options$persistentCo2.args) !== null && _options$persistentCo !== void 0 ? _options$persistentCo : [])];
+  if (browserType.name() === 'chromium') {
+    args.push('--app=data:text/html,', `--window-size=${options.windowSize.width},${options.windowSize.height}`, ...(options.windowPosition ? [`--window-position=${options.windowPosition.x},${options.windowPosition.y}`] : []), '--test-type=');
+  }
+  const context = await browserType.launchPersistentContext((0, _instrumentation.serverSideCallMetadata)(), '', {
+    channel: (0, _registry.findChromiumChannel)(options.sdkLanguage),
+    noDefaultViewport: true,
+    ignoreDefaultArgs: ['--enable-automation'],
+    colorScheme: 'no-override',
+    acceptDownloads: (0, _utils.isUnderTest)() ? 'accept' : 'internal-browser-default',
+    ...(options === null || options === void 0 ? void 0 : options.persistentContextOptions),
+    args
+  });
+  const [page] = context.pages();
+  // Chromium on macOS opens a new tab when clicking on the dock icon.
+  // See https://github.com/microsoft/playwright/issues/9434
+  if (browserType.name() === 'chromium' && process.platform === 'darwin') {
+    context.on('page', async newPage => {
+      if (newPage.mainFrame().url() === 'chrome://new-tab-page/') {
+        await page.bringToFront();
+        await newPage.close((0, _instrumentation.serverSideCallMetadata)());
+      }
+    });
+  }
+  if (browserType.name() === 'chromium') await installAppIcon(page);
+  return {
+    context,
+    page
+  };
+}
+async function installAppIcon(page) {
+  const icon = await _fs.default.promises.readFile(require.resolve('./chromium/appIcon.png'));
+  const crPage = page._delegate;
+  await crPage._mainFrameSession._client.send('Browser.setDockTile', {
+    image: icon.toString('base64')
+  });
+}
+async function syncLocalStorageWithSettings(page, appName) {
+  if ((0, _utils.isUnderTest)()) return;
+  const settingsFile = _path.default.join(_registry.registryDirectory, '.settings', `${appName}.json`);
+  await page.exposeBinding('_saveSerializedSettings', false, (_, settings) => {
+    _fs.default.mkdirSync(_path.default.dirname(settingsFile), {
+      recursive: true
+    });
+    _fs.default.writeFileSync(settingsFile, settings);
+  });
+  const settings = await _fs.default.promises.readFile(settingsFile, 'utf-8').catch(() => '{}');
+  await page.addInitScript(`(${String(settings => {
+    // iframes w/ snapshots, etc.
+    if (location && location.protocol === 'data:') return;
+    Object.entries(settings).map(([k, v]) => localStorage[k] = v);
+    window.saveSettings = () => {
+      window._saveSerializedSettings(JSON.stringify({
+        ...localStorage
+      }));
+    };
+  })})(${settings});
+  `);
+}