@checkly/playwright-core 1.41.2-beta.0

package/lib/browserServerImpl.js

@@ -0,0 +1,92 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BrowserServerLauncherImpl = void 0;
+var _utilsBundle = require("./utilsBundle");
+var _clientHelper = require("./client/clientHelper");
+var _utils = require("./utils");
+var _instrumentation = require("./server/instrumentation");
+var _playwright = require("./server/playwright");
+var _playwrightServer = require("./remote/playwrightServer");
+var _helper = require("./server/helper");
+var _stackTrace = require("./utils/stackTrace");
+var _socksProxy = require("./common/socksProxy");
+/**
+ * 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 BrowserServerLauncherImpl {
+  constructor(browserName) {
+    this._browserName = void 0;
+    this._browserName = browserName;
+  }
+  async launchServer(options = {}) {
+    const playwright = (0, _playwright.createPlaywright)({
+      sdkLanguage: 'javascript',
+      isServer: true
+    });
+    // TODO: enable socks proxy once ipv6 is supported.
+    const socksProxy = false ? new _socksProxy.SocksProxy() : undefined;
+    playwright.options.socksProxyPort = await (socksProxy === null || socksProxy === void 0 ? void 0 : socksProxy.listen(0));
+
+    // 1. Pre-launch the browser
+    const metadata = (0, _instrumentation.serverSideCallMetadata)();
+    const browser = await playwright[this._browserName].launch(metadata, {
+      ...options,
+      ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
+      ignoreAllDefaultArgs: !!options.ignoreDefaultArgs && !Array.isArray(options.ignoreDefaultArgs),
+      env: options.env ? (0, _clientHelper.envObjectToArray)(options.env) : undefined
+    }, toProtocolLogger(options.logger)).catch(e => {
+      const log = _helper.helper.formatBrowserLogs(metadata.log);
+      (0, _stackTrace.rewriteErrorMessage)(e, `${e.message} Failed to launch browser.${log}`);
+      throw e;
+    });
+    const path = options.wsPath ? options.wsPath.startsWith('/') ? options.wsPath : `/${options.wsPath}` : `/${(0, _utils.createGuid)()}`;
+
+    // 2. Start the server
+    const server = new _playwrightServer.PlaywrightServer({
+      mode: 'launchServer',
+      path,
+      maxConnections: Infinity,
+      preLaunchedBrowser: browser,
+      preLaunchedSocksProxy: socksProxy
+    });
+    const wsEndpoint = await server.listen(options.port);
+
+    // 3. Return the BrowserServer interface
+    const browserServer = new _utilsBundle.ws.EventEmitter();
+    browserServer.process = () => browser.options.browserProcess.process;
+    browserServer.wsEndpoint = () => wsEndpoint;
+    browserServer.close = () => browser.options.browserProcess.close();
+    browserServer[Symbol.asyncDispose] = browserServer.close;
+    browserServer.kill = () => browser.options.browserProcess.kill();
+    browserServer._disconnectForTest = () => server.close();
+    browserServer._userDataDirForTest = browser._userDataDirForTest;
+    browser.options.browserProcess.onclose = (exitCode, signal) => {
+      socksProxy === null || socksProxy === void 0 || socksProxy.close().catch(() => {});
+      server.close();
+      browserServer.emit('close', exitCode, signal);
+    };
+    return browserServer;
+  }
+}
+exports.BrowserServerLauncherImpl = BrowserServerLauncherImpl;
+function toProtocolLogger(logger) {
+  return logger ? (direction, message) => {
+    if (logger.isEnabled('protocol', 'verbose')) logger.log('protocol', 'verbose', (direction === 'send' ? 'SEND ► ' : '◀ RECV ') + JSON.stringify(message), [], {});
+  } : undefined;
+}

package/lib/cli/driver.js

@@ -0,0 +1,97 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.launchBrowserServer = launchBrowserServer;
+exports.printApiJson = printApiJson;
+exports.runDriver = runDriver;
+exports.runServer = runServer;
+var _fs = _interopRequireDefault(require("fs"));
+var playwright = _interopRequireWildcard(require("../.."));
+var _server = require("../server");
+var _transport = require("../protocol/transport");
+var _playwrightServer = require("../remote/playwrightServer");
+var _processLauncher = require("../utils/processLauncher");
+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.
+ */
+
+/* eslint-disable no-console */
+
+function printApiJson() {
+  // Note: this file is generated by build-playwright-driver.sh
+  console.log(JSON.stringify(require('../../api.json')));
+}
+function runDriver() {
+  const dispatcherConnection = new _server.DispatcherConnection();
+  new _server.RootDispatcher(dispatcherConnection, async (rootScope, {
+    sdkLanguage
+  }) => {
+    const playwright = (0, _server.createPlaywright)({
+      sdkLanguage
+    });
+    return new _server.PlaywrightDispatcher(rootScope, playwright);
+  });
+  const transport = new _transport.PipeTransport(process.stdout, process.stdin);
+  transport.onmessage = message => dispatcherConnection.dispatch(JSON.parse(message));
+  // Certain Language Binding JSON parsers (e.g. .NET) do not like strings with lone surrogates.
+  const isJavaScriptLanguageBinding = !process.env.PW_LANG_NAME || process.env.PW_LANG_NAME === 'javascript';
+  const replacer = !isJavaScriptLanguageBinding && String.prototype.toWellFormed ? (key, value) => {
+    if (typeof value === 'string')
+      // @ts-expect-error
+      return value.toWellFormed();
+    return value;
+  } : undefined;
+  dispatcherConnection.onmessage = message => transport.send(JSON.stringify(message, replacer));
+  transport.onclose = () => {
+    // Drop any messages during shutdown on the floor.
+    dispatcherConnection.onmessage = () => {};
+    (0, _processLauncher.gracefullyProcessExitDoNotHang)(0);
+  };
+  // Ignore the SIGINT signal in the driver process so the parent can gracefully close the connection.
+  // We still will destruct everything (close browsers and exit) when the transport pipe closes.
+  process.on('SIGINT', () => {
+    // Keep the process running.
+  });
+}
+async function runServer(options) {
+  const {
+    port,
+    host,
+    path = '/',
+    maxConnections = Infinity,
+    extension
+  } = options;
+  const server = new _playwrightServer.PlaywrightServer({
+    mode: extension ? 'extension' : 'default',
+    path,
+    maxConnections
+  });
+  const wsEndpoint = await server.listen(port, host);
+  process.on('exit', () => server.close().catch(console.error));
+  console.log('Listening on ' + wsEndpoint);
+  process.stdin.on('close', () => (0, _processLauncher.gracefullyProcessExitDoNotHang)(0));
+}
+async function launchBrowserServer(browserName, configFile) {
+  let options = {};
+  if (configFile) options = JSON.parse(_fs.default.readFileSync(configFile).toString());
+  const browserType = playwright[browserName];
+  const server = await browserType.launchServer(options);
+  console.log(server.wsEndpoint());
+}