@checkly/playwright-core 1.41.2-beta.0

package/lib/server/chromium/crConnection.js

@@ -0,0 +1,228 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.kBrowserCloseMessageId = exports.ConnectionEvents = exports.CRSession = exports.CRConnection = exports.CDPSession = void 0;
+var _utils = require("../../utils");
+var _events = require("events");
+var _debugLogger = require("../../utils/debugLogger");
+var _helper = require("../helper");
+var _protocolError = require("../protocolError");
+/**
+ * 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.
+ */
+
+const ConnectionEvents = exports.ConnectionEvents = {
+  Disconnected: Symbol('ConnectionEvents.Disconnected')
+};
+
+// CRPlaywright uses this special id to issue Browser.close command which we
+// should ignore.
+const kBrowserCloseMessageId = exports.kBrowserCloseMessageId = -9999;
+class CRConnection extends _events.EventEmitter {
+  constructor(transport, protocolLogger, browserLogsCollector) {
+    super();
+    this._lastId = 0;
+    this._transport = void 0;
+    this._sessions = new Map();
+    this._protocolLogger = void 0;
+    this._browserLogsCollector = void 0;
+    this._browserDisconnectedLogs = void 0;
+    this.rootSession = void 0;
+    this._closed = false;
+    this.setMaxListeners(0);
+    this._transport = transport;
+    this._protocolLogger = protocolLogger;
+    this._browserLogsCollector = browserLogsCollector;
+    this.rootSession = new CRSession(this, null, '');
+    this._sessions.set('', this.rootSession);
+    this._transport.onmessage = this._onMessage.bind(this);
+    // onclose should be set last, since it can be immediately called.
+    this._transport.onclose = this._onClose.bind(this);
+  }
+  _rawSend(sessionId, method, params) {
+    const id = ++this._lastId;
+    const message = {
+      id,
+      method,
+      params
+    };
+    if (sessionId) message.sessionId = sessionId;
+    this._protocolLogger('send', message);
+    this._transport.send(message);
+    return id;
+  }
+  async _onMessage(message) {
+    this._protocolLogger('receive', message);
+    if (message.id === kBrowserCloseMessageId) return;
+    const session = this._sessions.get(message.sessionId || '');
+    if (session) session._onMessage(message);
+  }
+  _onClose() {
+    this._closed = true;
+    this._transport.onmessage = undefined;
+    this._transport.onclose = undefined;
+    this._browserDisconnectedLogs = _helper.helper.formatBrowserLogs(this._browserLogsCollector.recentLogs());
+    this.rootSession.dispose();
+    Promise.resolve().then(() => this.emit(ConnectionEvents.Disconnected));
+  }
+  close() {
+    if (!this._closed) this._transport.close();
+  }
+  async createBrowserSession() {
+    const {
+      sessionId
+    } = await this.rootSession.send('Target.attachToBrowserTarget');
+    return new CDPSession(this.rootSession, sessionId);
+  }
+}
+exports.CRConnection = CRConnection;
+class CRSession extends _events.EventEmitter {
+  constructor(connection, parentSession, sessionId, eventListener) {
+    super();
+    this._connection = void 0;
+    this._eventListener = void 0;
+    this._callbacks = new Map();
+    this._sessionId = void 0;
+    this._parentSession = void 0;
+    this._crashed = false;
+    this._closed = false;
+    this.on = void 0;
+    this.addListener = void 0;
+    this.off = void 0;
+    this.removeListener = void 0;
+    this.once = void 0;
+    this.setMaxListeners(0);
+    this._connection = connection;
+    this._parentSession = parentSession;
+    this._sessionId = sessionId;
+    this._eventListener = eventListener;
+    this.on = super.on;
+    this.addListener = super.addListener;
+    this.off = super.removeListener;
+    this.removeListener = super.removeListener;
+    this.once = super.once;
+  }
+  _markAsCrashed() {
+    this._crashed = true;
+  }
+  createChildSession(sessionId, eventListener) {
+    const session = new CRSession(this._connection, this, sessionId, eventListener);
+    this._connection._sessions.set(sessionId, session);
+    return session;
+  }
+  async send(method, params) {
+    if (this._crashed || this._closed || this._connection._closed || this._connection._browserDisconnectedLogs) throw new _protocolError.ProtocolError(this._crashed ? 'crashed' : 'closed', undefined, this._connection._browserDisconnectedLogs);
+    const id = this._connection._rawSend(this._sessionId, method, params);
+    return new Promise((resolve, reject) => {
+      this._callbacks.set(id, {
+        resolve,
+        reject,
+        error: new _protocolError.ProtocolError('error', method)
+      });
+    });
+  }
+  _sendMayFail(method, params) {
+    return this.send(method, params).catch(error => _debugLogger.debugLogger.log('error', error));
+  }
+  _onMessage(object) {
+    var _object$error;
+    if (object.id && this._callbacks.has(object.id)) {
+      const callback = this._callbacks.get(object.id);
+      this._callbacks.delete(object.id);
+      if (object.error) {
+        callback.error.setMessage(object.error.message);
+        callback.reject(callback.error);
+      } else {
+        callback.resolve(object.result);
+      }
+    } else if (object.id && ((_object$error = object.error) === null || _object$error === void 0 ? void 0 : _object$error.code) === -32001) {
+      // Message to a closed session, just ignore it.
+    } else {
+      var _object$error2;
+      (0, _utils.assert)(!object.id, (object === null || object === void 0 || (_object$error2 = object.error) === null || _object$error2 === void 0 ? void 0 : _object$error2.message) || undefined);
+      Promise.resolve().then(() => {
+        if (this._eventListener) this._eventListener(object.method, object.params);
+        this.emit(object.method, object.params);
+      });
+    }
+  }
+  async detach() {
+    if (this._closed) throw new Error(`Session already detached. Most likely the page has been closed.`);
+    if (!this._parentSession) throw new Error('Root session cannot be closed');
+    // Ideally, detaching should resume any target, but there is a bug in the backend,
+    // so we must Runtime.runIfWaitingForDebugger first.
+    await this._sendMayFail('Runtime.runIfWaitingForDebugger');
+    await this._parentSession.send('Target.detachFromTarget', {
+      sessionId: this._sessionId
+    });
+    this.dispose();
+  }
+  dispose() {
+    this._closed = true;
+    this._connection._sessions.delete(this._sessionId);
+    for (const callback of this._callbacks.values()) {
+      callback.error.setMessage(`Internal server error, session closed.`);
+      callback.error.type = this._crashed ? 'crashed' : 'closed';
+      callback.error.logs = this._connection._browserDisconnectedLogs;
+      callback.reject(callback.error);
+    }
+    this._callbacks.clear();
+  }
+}
+exports.CRSession = CRSession;
+class CDPSession extends _events.EventEmitter {
+  constructor(parentSession, sessionId) {
+    super();
+    this.guid = void 0;
+    this._session = void 0;
+    this._listeners = [];
+    this.guid = `cdp-session@${sessionId}`;
+    this._session = parentSession.createChildSession(sessionId, (method, params) => this.emit(CDPSession.Events.Event, {
+      method,
+      params
+    }));
+    this._listeners = [_utils.eventsHelper.addEventListener(parentSession, 'Target.detachedFromTarget', event => {
+      if (event.sessionId === sessionId) this._onClose();
+    })];
+  }
+  async send(method, params) {
+    return await this._session.send(method, params);
+  }
+  async detach() {
+    return await this._session.detach();
+  }
+  async attachToTarget(targetId) {
+    const {
+      sessionId
+    } = await this.send('Target.attachToTarget', {
+      targetId,
+      flatten: true
+    });
+    return new CDPSession(this._session, sessionId);
+  }
+  _onClose() {
+    _utils.eventsHelper.removeEventListeners(this._listeners);
+    this._session.dispose();
+    this.emit(CDPSession.Events.Closed);
+  }
+}
+exports.CDPSession = CDPSession;
+CDPSession.Events = {
+  Event: 'event',
+  Closed: 'close'
+};

package/lib/server/chromium/crCoverage.js

@@ -0,0 +1,246 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CRCoverage = void 0;
+var _eventsHelper = require("../../utils/eventsHelper");
+var _utils = require("../../utils");
+/**
+ * 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.
+ */
+
+class CRCoverage {
+  constructor(client) {
+    this._jsCoverage = void 0;
+    this._cssCoverage = void 0;
+    this._jsCoverage = new JSCoverage(client);
+    this._cssCoverage = new CSSCoverage(client);
+  }
+  async startJSCoverage(options) {
+    return await this._jsCoverage.start(options);
+  }
+  async stopJSCoverage() {
+    return await this._jsCoverage.stop();
+  }
+  async startCSSCoverage(options) {
+    return await this._cssCoverage.start(options);
+  }
+  async stopCSSCoverage() {
+    return await this._cssCoverage.stop();
+  }
+}
+exports.CRCoverage = CRCoverage;
+class JSCoverage {
+  constructor(client) {
+    this._client = void 0;
+    this._enabled = void 0;
+    this._scriptIds = void 0;
+    this._scriptSources = void 0;
+    this._eventListeners = void 0;
+    this._resetOnNavigation = void 0;
+    this._reportAnonymousScripts = false;
+    this._client = client;
+    this._enabled = false;
+    this._scriptIds = new Set();
+    this._scriptSources = new Map();
+    this._eventListeners = [];
+    this._resetOnNavigation = false;
+  }
+  async start(options) {
+    (0, _utils.assert)(!this._enabled, 'JSCoverage is already enabled');
+    const {
+      resetOnNavigation = true,
+      reportAnonymousScripts = false
+    } = options;
+    this._resetOnNavigation = resetOnNavigation;
+    this._reportAnonymousScripts = reportAnonymousScripts;
+    this._enabled = true;
+    this._scriptIds.clear();
+    this._scriptSources.clear();
+    this._eventListeners = [_eventsHelper.eventsHelper.addEventListener(this._client, 'Debugger.scriptParsed', this._onScriptParsed.bind(this)), _eventsHelper.eventsHelper.addEventListener(this._client, 'Runtime.executionContextsCleared', this._onExecutionContextsCleared.bind(this)), _eventsHelper.eventsHelper.addEventListener(this._client, 'Debugger.paused', this._onDebuggerPaused.bind(this))];
+    await Promise.all([this._client.send('Profiler.enable'), this._client.send('Profiler.startPreciseCoverage', {
+      callCount: true,
+      detailed: true
+    }), this._client.send('Debugger.enable'), this._client.send('Debugger.setSkipAllPauses', {
+      skip: true
+    })]);
+  }
+  _onDebuggerPaused() {
+    this._client.send('Debugger.resume');
+  }
+  _onExecutionContextsCleared() {
+    if (!this._resetOnNavigation) return;
+    this._scriptIds.clear();
+    this._scriptSources.clear();
+  }
+  async _onScriptParsed(event) {
+    this._scriptIds.add(event.scriptId);
+    // Ignore other anonymous scripts unless the reportAnonymousScripts option is true.
+    if (!event.url && !this._reportAnonymousScripts) return;
+    // This might fail if the page has already navigated away.
+    const response = await this._client._sendMayFail('Debugger.getScriptSource', {
+      scriptId: event.scriptId
+    });
+    if (response) this._scriptSources.set(event.scriptId, response.scriptSource);
+  }
+  async stop() {
+    (0, _utils.assert)(this._enabled, 'JSCoverage is not enabled');
+    this._enabled = false;
+    const [profileResponse] = await Promise.all([this._client.send('Profiler.takePreciseCoverage'), this._client.send('Profiler.stopPreciseCoverage'), this._client.send('Profiler.disable'), this._client.send('Debugger.disable')]);
+    _eventsHelper.eventsHelper.removeEventListeners(this._eventListeners);
+    const coverage = {
+      entries: []
+    };
+    for (const entry of profileResponse.result) {
+      if (!this._scriptIds.has(entry.scriptId)) continue;
+      if (!entry.url && !this._reportAnonymousScripts) continue;
+      const source = this._scriptSources.get(entry.scriptId);
+      if (source) coverage.entries.push({
+        ...entry,
+        source
+      });else coverage.entries.push(entry);
+    }
+    return coverage;
+  }
+}
+class CSSCoverage {
+  constructor(client) {
+    this._client = void 0;
+    this._enabled = void 0;
+    this._stylesheetURLs = void 0;
+    this._stylesheetSources = void 0;
+    this._eventListeners = void 0;
+    this._resetOnNavigation = void 0;
+    this._client = client;
+    this._enabled = false;
+    this._stylesheetURLs = new Map();
+    this._stylesheetSources = new Map();
+    this._eventListeners = [];
+    this._resetOnNavigation = false;
+  }
+  async start(options) {
+    (0, _utils.assert)(!this._enabled, 'CSSCoverage is already enabled');
+    const {
+      resetOnNavigation = true
+    } = options;
+    this._resetOnNavigation = resetOnNavigation;
+    this._enabled = true;
+    this._stylesheetURLs.clear();
+    this._stylesheetSources.clear();
+    this._eventListeners = [_eventsHelper.eventsHelper.addEventListener(this._client, 'CSS.styleSheetAdded', this._onStyleSheet.bind(this)), _eventsHelper.eventsHelper.addEventListener(this._client, 'Runtime.executionContextsCleared', this._onExecutionContextsCleared.bind(this))];
+    await Promise.all([this._client.send('DOM.enable'), this._client.send('CSS.enable'), this._client.send('CSS.startRuleUsageTracking')]);
+  }
+  _onExecutionContextsCleared() {
+    if (!this._resetOnNavigation) return;
+    this._stylesheetURLs.clear();
+    this._stylesheetSources.clear();
+  }
+  async _onStyleSheet(event) {
+    const header = event.header;
+    // Ignore anonymous scripts
+    if (!header.sourceURL) return;
+    // This might fail if the page has already navigated away.
+    const response = await this._client._sendMayFail('CSS.getStyleSheetText', {
+      styleSheetId: header.styleSheetId
+    });
+    if (response) {
+      this._stylesheetURLs.set(header.styleSheetId, header.sourceURL);
+      this._stylesheetSources.set(header.styleSheetId, response.text);
+    }
+  }
+  async stop() {
+    (0, _utils.assert)(this._enabled, 'CSSCoverage is not enabled');
+    this._enabled = false;
+    const ruleTrackingResponse = await this._client.send('CSS.stopRuleUsageTracking');
+    await Promise.all([this._client.send('CSS.disable'), this._client.send('DOM.disable')]);
+    _eventsHelper.eventsHelper.removeEventListeners(this._eventListeners);
+
+    // aggregate by styleSheetId
+    const styleSheetIdToCoverage = new Map();
+    for (const entry of ruleTrackingResponse.ruleUsage) {
+      let ranges = styleSheetIdToCoverage.get(entry.styleSheetId);
+      if (!ranges) {
+        ranges = [];
+        styleSheetIdToCoverage.set(entry.styleSheetId, ranges);
+      }
+      ranges.push({
+        startOffset: entry.startOffset,
+        endOffset: entry.endOffset,
+        count: entry.used ? 1 : 0
+      });
+    }
+    const coverage = {
+      entries: []
+    };
+    for (const styleSheetId of this._stylesheetURLs.keys()) {
+      const url = this._stylesheetURLs.get(styleSheetId);
+      const text = this._stylesheetSources.get(styleSheetId);
+      const ranges = convertToDisjointRanges(styleSheetIdToCoverage.get(styleSheetId) || []);
+      coverage.entries.push({
+        url,
+        ranges,
+        text
+      });
+    }
+    return coverage;
+  }
+}
+function convertToDisjointRanges(nestedRanges) {
+  const points = [];
+  for (const range of nestedRanges) {
+    points.push({
+      offset: range.startOffset,
+      type: 0,
+      range
+    });
+    points.push({
+      offset: range.endOffset,
+      type: 1,
+      range
+    });
+  }
+  // Sort points to form a valid parenthesis sequence.
+  points.sort((a, b) => {
+    // Sort with increasing offsets.
+    if (a.offset !== b.offset) return a.offset - b.offset;
+    // All "end" points should go before "start" points.
+    if (a.type !== b.type) return b.type - a.type;
+    const aLength = a.range.endOffset - a.range.startOffset;
+    const bLength = b.range.endOffset - b.range.startOffset;
+    // For two "start" points, the one with longer range goes first.
+    if (a.type === 0) return bLength - aLength;
+    // For two "end" points, the one with shorter range goes first.
+    return aLength - bLength;
+  });
+  const hitCountStack = [];
+  const results = [];
+  let lastOffset = 0;
+  // Run scanning line to intersect all ranges.
+  for (const point of points) {
+    if (hitCountStack.length && lastOffset < point.offset && hitCountStack[hitCountStack.length - 1] > 0) {
+      const lastResult = results.length ? results[results.length - 1] : null;
+      if (lastResult && lastResult.end === lastOffset) lastResult.end = point.offset;else results.push({
+        start: lastOffset,
+        end: point.offset
+      });
+    }
+    lastOffset = point.offset;
+    if (point.type === 0) hitCountStack.push(point.range.count);else hitCountStack.pop();
+  }
+  // Filter out empty ranges.
+  return results.filter(range => range.end - range.start > 1);
+}

package/lib/server/chromium/crDevTools.js

@@ -0,0 +1,104 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CRDevTools = void 0;
+var _fs = _interopRequireDefault(require("fs"));
+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 kBindingName = '__pw_devtools__';
+
+// This class intercepts preferences-related DevTools embedder methods
+// and stores preferences as a json file in the browser installation directory.
+class CRDevTools {
+  constructor(preferencesPath) {
+    this._preferencesPath = void 0;
+    this._prefs = void 0;
+    this._savePromise = void 0;
+    this.__testHookOnBinding = void 0;
+    this._preferencesPath = preferencesPath;
+    this._savePromise = Promise.resolve();
+  }
+  install(session) {
+    session.on('Runtime.bindingCalled', async event => {
+      if (event.name !== kBindingName) return;
+      const parsed = JSON.parse(event.payload);
+      let result = undefined;
+      if (this.__testHookOnBinding) this.__testHookOnBinding(parsed);
+      if (parsed.method === 'getPreferences') {
+        if (this._prefs === undefined) {
+          try {
+            const json = await _fs.default.promises.readFile(this._preferencesPath, 'utf8');
+            this._prefs = JSON.parse(json);
+          } catch (e) {
+            this._prefs = {};
+          }
+        }
+        result = this._prefs;
+      } else if (parsed.method === 'setPreference') {
+        this._prefs[parsed.params[0]] = parsed.params[1];
+        this._save();
+      } else if (parsed.method === 'removePreference') {
+        delete this._prefs[parsed.params[0]];
+        this._save();
+      } else if (parsed.method === 'clearPreferences') {
+        this._prefs = {};
+        this._save();
+      }
+      session.send('Runtime.evaluate', {
+        expression: `window.DevToolsAPI.embedderMessageAck(${parsed.id}, ${JSON.stringify(result)})`,
+        contextId: event.executionContextId
+      }).catch(e => null);
+    });
+    Promise.all([session.send('Runtime.enable'), session.send('Runtime.addBinding', {
+      name: kBindingName
+    }), session.send('Page.enable'), session.send('Page.addScriptToEvaluateOnNewDocument', {
+      source: `
+        (() => {
+          const init = () => {
+            // Lazy init happens when InspectorFrontendHost is initialized.
+            // At this point DevToolsHost is ready to be used.
+            const host = window.DevToolsHost;
+            const old = host.sendMessageToEmbedder.bind(host);
+            host.sendMessageToEmbedder = message => {
+              if (['getPreferences', 'setPreference', 'removePreference', 'clearPreferences'].includes(JSON.parse(message).method))
+                window.${kBindingName}(message);
+              else
+                old(message);
+            };
+          };
+          let value;
+          Object.defineProperty(window, 'InspectorFrontendHost', {
+            configurable: true,
+            enumerable: true,
+            get() { return value; },
+            set(v) { value = v; init(); },
+          });
+        })()
+      `
+    }), session.send('Runtime.runIfWaitingForDebugger')]).catch(e => null);
+  }
+  _save() {
+    // Serialize saves to avoid corruption.
+    this._savePromise = this._savePromise.then(async () => {
+      await _fs.default.promises.writeFile(this._preferencesPath, JSON.stringify(this._prefs)).catch(e => null);
+    });
+  }
+}
+exports.CRDevTools = CRDevTools;