@checkly/playwright-core 1.41.2-beta.0

package/lib/server/download.js

@@ -0,0 +1,53 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Download = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _page = require("./page");
+var _utils = require("../utils");
+var _artifact = require("./artifact");
+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 Download {
+  constructor(page, downloadsPath, uuid, url, suggestedFilename) {
+    this.artifact = void 0;
+    this.url = void 0;
+    this._page = void 0;
+    this._suggestedFilename = void 0;
+    const unaccessibleErrorMessage = page._browserContext._options.acceptDownloads === 'deny' ? 'Pass { acceptDownloads: true } when you are creating your browser context.' : undefined;
+    this.artifact = new _artifact.Artifact(page, _path.default.join(downloadsPath, uuid), unaccessibleErrorMessage, () => {
+      return this._page._browserContext.cancelDownload(uuid);
+    });
+    this._page = page;
+    this.url = url;
+    this._suggestedFilename = suggestedFilename;
+    page._browserContext._downloads.add(this);
+    if (suggestedFilename !== undefined) this._page.emit(_page.Page.Events.Download, this);
+  }
+  _filenameSuggested(suggestedFilename) {
+    (0, _utils.assert)(this._suggestedFilename === undefined);
+    this._suggestedFilename = suggestedFilename;
+    this._page.emit(_page.Page.Events.Download, this);
+  }
+  suggestedFilename() {
+    return this._suggestedFilename;
+  }
+}
+exports.Download = Download;

package/lib/server/electron/electron.js

@@ -0,0 +1,254 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ElectronApplication = exports.Electron = void 0;
+var _fs = _interopRequireDefault(require("fs"));
+var _os = _interopRequireDefault(require("os"));
+var _path = _interopRequireDefault(require("path"));
+var _crBrowser = require("../chromium/crBrowser");
+var _crConnection = require("../chromium/crConnection");
+var _crExecutionContext = require("../chromium/crExecutionContext");
+var js = _interopRequireWildcard(require("../javascript"));
+var _timeoutSettings = require("../../common/timeoutSettings");
+var _utils = require("../../utils");
+var _transport = require("../transport");
+var _processLauncher = require("../../utils/processLauncher");
+var _browserContext = require("../browserContext");
+var _progress = require("../progress");
+var _helper = require("../helper");
+var _eventsHelper = require("../../utils/eventsHelper");
+var readline = _interopRequireWildcard(require("readline"));
+var _debugLogger = require("../../utils/debugLogger");
+var _instrumentation = require("../instrumentation");
+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; }
+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.
+ */
+
+const ARTIFACTS_FOLDER = _path.default.join(_os.default.tmpdir(), 'playwright-artifacts-');
+class ElectronApplication extends _instrumentation.SdkObject {
+  constructor(parent, browser, nodeConnection, process) {
+    super(parent, 'electron-app');
+    this._browserContext = void 0;
+    this._nodeConnection = void 0;
+    this._nodeSession = void 0;
+    this._nodeExecutionContext = void 0;
+    this._nodeElectronHandlePromise = new _utils.ManualPromise();
+    this._timeoutSettings = new _timeoutSettings.TimeoutSettings();
+    this._process = void 0;
+    this._process = process;
+    this._browserContext = browser._defaultContext;
+    this._browserContext.on(_browserContext.BrowserContext.Events.Close, () => {
+      // Emit application closed after context closed.
+      Promise.resolve().then(() => this.emit(ElectronApplication.Events.Close));
+    });
+    this._nodeConnection = nodeConnection;
+    this._nodeSession = nodeConnection.rootSession;
+    this._nodeSession.on('Runtime.executionContextCreated', async event => {
+      if (!event.context.auxData || !event.context.auxData.isDefault) return;
+      const crExecutionContext = new _crExecutionContext.CRExecutionContext(this._nodeSession, event.context);
+      this._nodeExecutionContext = new js.ExecutionContext(this, crExecutionContext, 'electron');
+      const {
+        result: remoteObject
+      } = await crExecutionContext._client.send('Runtime.evaluate', {
+        expression: `require('electron')`,
+        contextId: event.context.id,
+        // Needed after Electron 28 to get access to require: https://github.com/microsoft/playwright/issues/28048
+        includeCommandLineAPI: true
+      });
+      this._nodeElectronHandlePromise.resolve(new js.JSHandle(this._nodeExecutionContext, 'object', 'ElectronModule', remoteObject.objectId));
+    });
+    this._browserContext.setCustomCloseHandler(async () => {
+      await this._browserContext.stopVideoRecording();
+      const electronHandle = await this._nodeElectronHandlePromise;
+      await electronHandle.evaluate(({
+        app
+      }) => app.quit()).catch(() => {});
+    });
+  }
+  async initialize() {
+    await this._nodeSession.send('Runtime.enable', {});
+    // Delay loading the app until browser is started and the browser targets are configured to auto-attach.
+    await this._nodeSession.send('Runtime.evaluate', {
+      expression: '__playwright_run()'
+    });
+  }
+  process() {
+    return this._process;
+  }
+  context() {
+    return this._browserContext;
+  }
+  async close() {
+    const progressController = new _progress.ProgressController((0, _instrumentation.serverSideCallMetadata)(), this);
+    const closed = progressController.run(progress => _helper.helper.waitForEvent(progress, this, ElectronApplication.Events.Close).promise);
+    await this._browserContext.close({
+      reason: 'Application exited'
+    });
+    this._nodeConnection.close();
+    await closed;
+  }
+  async browserWindow(page) {
+    // Assume CRPage as Electron is always Chromium.
+    const targetId = page._delegate._targetId;
+    const electronHandle = await this._nodeElectronHandlePromise;
+    return await electronHandle.evaluateHandle(({
+      BrowserWindow,
+      webContents
+    }, targetId) => {
+      const wc = webContents.fromDevToolsTargetId(targetId);
+      return BrowserWindow.fromWebContents(wc);
+    }, targetId);
+  }
+}
+exports.ElectronApplication = ElectronApplication;
+ElectronApplication.Events = {
+  Close: 'close'
+};
+class Electron extends _instrumentation.SdkObject {
+  constructor(playwright) {
+    super(playwright, 'electron');
+  }
+  async launch(options) {
+    const {
+      args = []
+    } = options;
+    const controller = new _progress.ProgressController((0, _instrumentation.serverSideCallMetadata)(), this);
+    controller.setLogName('browser');
+    return controller.run(async progress => {
+      let app = undefined;
+      // --remote-debugging-port=0 must be the last playwright's argument, loader.ts relies on it.
+      const electronArguments = ['--inspect=0', '--remote-debugging-port=0', ...args];
+      if (_os.default.platform() === 'linux') {
+        const runningAsRoot = process.geteuid && process.geteuid() === 0;
+        if (runningAsRoot && electronArguments.indexOf('--no-sandbox') === -1) electronArguments.unshift('--no-sandbox');
+      }
+      const artifactsDir = await _fs.default.promises.mkdtemp(ARTIFACTS_FOLDER);
+      const browserLogsCollector = new _debugLogger.RecentLogsCollector();
+      const env = options.env ? (0, _processLauncher.envArrayToObject)(options.env) : process.env;
+      let command;
+      if (options.executablePath) {
+        command = options.executablePath;
+      } else {
+        try {
+          // By default we fallback to the Electron App executable path.
+          // 'electron/index.js' resolves to the actual Electron App.
+          command = require('electron/index.js');
+        } catch (error) {
+          if ((error === null || error === void 0 ? void 0 : error.code) === 'MODULE_NOT_FOUND') {
+            throw new Error('\n' + (0, _utils.wrapInASCIIBox)(['Electron executablePath not found!', 'Please install it using `npm install -D electron` or set the executablePath to your Electron executable.'].join('\n'), 1));
+          }
+          throw error;
+        }
+        // Only use our own loader for non-packaged apps.
+        // Packaged apps might have their own command line handling.
+        electronArguments.unshift('-r', require.resolve('./loader'));
+      }
+
+      // When debugging Playwright test that runs Electron, NODE_OPTIONS
+      // will make the debugger attach to Electron's Node. But Playwright
+      // also needs to attach to drive the automation. Disable external debugging.
+      delete env.NODE_OPTIONS;
+      const {
+        launchedProcess,
+        gracefullyClose,
+        kill
+      } = await (0, _processLauncher.launchProcess)({
+        command,
+        args: electronArguments,
+        env,
+        log: message => {
+          progress.log(message);
+          browserLogsCollector.log(message);
+        },
+        stdio: 'pipe',
+        cwd: options.cwd,
+        tempDirectories: [artifactsDir],
+        attemptToGracefullyClose: () => app.close(),
+        handleSIGINT: true,
+        handleSIGTERM: true,
+        handleSIGHUP: true,
+        onExit: () => {}
+      });
+      const waitForXserverError = new Promise(async (resolve, reject) => {
+        waitForLine(progress, launchedProcess, /Unable to open X display/).then(() => reject(new Error(['Unable to open X display!', `================================`, 'Most likely this is because there is no X server available.', "Use 'xvfb-run' on Linux to launch your tests with an emulated display server.", "For example: 'xvfb-run npm run test:e2e'", `================================`, progress.metadata.log].join('\n')))).catch(() => {});
+      });
+      const nodeMatch = await waitForLine(progress, launchedProcess, /^Debugger listening on (ws:\/\/.*)$/);
+      const nodeTransport = await _transport.WebSocketTransport.connect(progress, nodeMatch[1]);
+      const nodeConnection = new _crConnection.CRConnection(nodeTransport, _helper.helper.debugProtocolLogger(), browserLogsCollector);
+
+      // Immediately release exiting process under debug.
+      waitForLine(progress, launchedProcess, /Waiting for the debugger to disconnect\.\.\./).then(() => {
+        nodeTransport.close();
+      }).catch(() => {});
+      const chromeMatch = await Promise.race([waitForLine(progress, launchedProcess, /^DevTools listening on (ws:\/\/.*)$/), waitForXserverError]);
+      const chromeTransport = await _transport.WebSocketTransport.connect(progress, chromeMatch[1]);
+      const browserProcess = {
+        onclose: undefined,
+        process: launchedProcess,
+        close: gracefullyClose,
+        kill
+      };
+      const contextOptions = {
+        ...options,
+        noDefaultViewport: true
+      };
+      const browserOptions = {
+        name: 'electron',
+        isChromium: true,
+        headful: true,
+        persistent: contextOptions,
+        browserProcess,
+        protocolLogger: _helper.helper.debugProtocolLogger(),
+        browserLogsCollector,
+        artifactsDir,
+        downloadsPath: artifactsDir,
+        tracesDir: options.tracesDir || artifactsDir,
+        originalLaunchOptions: {}
+      };
+      (0, _browserContext.validateBrowserContextOptions)(contextOptions, browserOptions);
+      const browser = await _crBrowser.CRBrowser.connect(this.attribution.playwright, chromeTransport, browserOptions);
+      app = new ElectronApplication(this, browser, nodeConnection, launchedProcess);
+      await app.initialize();
+      return app;
+    }, _timeoutSettings.TimeoutSettings.launchTimeout(options));
+  }
+}
+exports.Electron = Electron;
+function waitForLine(progress, process, regex) {
+  return new Promise((resolve, reject) => {
+    const rl = readline.createInterface({
+      input: process.stderr
+    });
+    const failError = new Error('Process failed to launch!');
+    const listeners = [_eventsHelper.eventsHelper.addEventListener(rl, 'line', onLine), _eventsHelper.eventsHelper.addEventListener(rl, 'close', reject.bind(null, failError)), _eventsHelper.eventsHelper.addEventListener(process, 'exit', reject.bind(null, failError)),
+    // It is Ok to remove error handler because we did not create process and there is another listener.
+    _eventsHelper.eventsHelper.addEventListener(process, 'error', reject.bind(null, failError))];
+    progress.cleanupWhenAborted(cleanup);
+    function onLine(line) {
+      const match = line.match(regex);
+      if (!match) return;
+      cleanup();
+      resolve(match);
+    }
+    function cleanup() {
+      _eventsHelper.eventsHelper.removeEventListeners(listeners);
+    }
+  });
+}

package/lib/server/electron/loader.js

@@ -0,0 +1,57 @@
+"use strict";
+
+/**
+ * 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.
+ */
+
+const {
+  app
+} = require('electron');
+const {
+  chromiumSwitches
+} = require('../chromium/chromiumSwitches');
+
+// Always pass user arguments first, see https://github.com/microsoft/playwright/issues/16614 and
+// https://github.com/microsoft/playwright/issues/29198.
+// [Electron, -r, loader.js[, --no-sandbox>], --inspect=0, --remote-debugging-port=0, ...args]
+process.argv.splice(1, process.argv.indexOf('--remote-debugging-port=0'));
+for (const arg of chromiumSwitches) {
+  const match = arg.match(/--([^=]*)=?(.*)/);
+  app.commandLine.appendSwitch(match[1], match[2]);
+}
+
+// Defer ready event.
+const originalWhenReady = app.whenReady();
+const originalEmit = app.emit.bind(app);
+let readyEventArgs;
+app.emit = (event, ...args) => {
+  if (event === 'ready') {
+    readyEventArgs = args;
+    return app.listenerCount('ready') > 0;
+  }
+  return originalEmit(event, ...args);
+};
+let isReady = false;
+let whenReadyCallback;
+const whenReadyPromise = new Promise(f => whenReadyCallback = f);
+app.isReady = () => isReady;
+app.whenReady = () => whenReadyPromise;
+globalThis.__playwright_run = async () => {
+  // Wait for app to be ready to avoid browser initialization races.
+  const event = await originalWhenReady;
+  isReady = true;
+  whenReadyCallback(event);
+  originalEmit('ready', ...readyEventArgs);
+};

package/lib/server/errors.js

@@ -0,0 +1,68 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TimeoutError = exports.TargetClosedError = void 0;
+exports.isTargetClosedError = isTargetClosedError;
+exports.parseError = parseError;
+exports.serializeError = serializeError;
+var _utils = require("../utils");
+var _serializers = require("../protocol/serializers");
+/**
+ * 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 CustomError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = this.constructor.name;
+  }
+}
+class TimeoutError extends CustomError {}
+exports.TimeoutError = TimeoutError;
+class TargetClosedError extends CustomError {
+  constructor(cause, logs) {
+    super((cause || 'Target page, context or browser has been closed') + (logs || ''));
+  }
+}
+exports.TargetClosedError = TargetClosedError;
+function isTargetClosedError(error) {
+  return error instanceof TargetClosedError || error.name === 'TargetClosedError';
+}
+function serializeError(e) {
+  if ((0, _utils.isError)(e)) return {
+    error: {
+      message: e.message,
+      stack: e.stack,
+      name: e.name
+    }
+  };
+  return {
+    value: (0, _serializers.serializeValue)(e, value => ({
+      fallThrough: value
+    }))
+  };
+}
+function parseError(error) {
+  if (!error.error) {
+    if (error.value === undefined) throw new Error('Serialized error must have either an error or a value');
+    return (0, _serializers.parseSerializedValue)(error.value, undefined);
+  }
+  const e = new Error(error.error.message);
+  e.stack = error.error.stack || '';
+  e.name = error.error.name;
+  return e;
+}