@checkly/playwright-core 1.41.2-beta.0

package/lib/server/pipeTransport.js

@@ -0,0 +1,85 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PipeTransport = void 0;
+var _utils = require("../utils");
+var _debugLogger = require("../utils/debugLogger");
+/**
+ * Copyright 2018 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 PipeTransport {
+  constructor(pipeWrite, pipeRead) {
+    this._pipeRead = void 0;
+    this._pipeWrite = void 0;
+    this._pendingBuffers = [];
+    this._waitForNextTask = (0, _utils.makeWaitForNextTask)();
+    this._closed = false;
+    this._onclose = void 0;
+    this.onmessage = void 0;
+    this._pipeRead = pipeRead;
+    this._pipeWrite = pipeWrite;
+    pipeRead.on('data', buffer => this._dispatch(buffer));
+    pipeRead.on('close', () => {
+      this._closed = true;
+      if (this._onclose) this._onclose.call(null);
+    });
+    pipeRead.on('error', e => _debugLogger.debugLogger.log('error', e));
+    pipeWrite.on('error', e => _debugLogger.debugLogger.log('error', e));
+    this.onmessage = undefined;
+  }
+  get onclose() {
+    return this._onclose;
+  }
+  set onclose(onclose) {
+    this._onclose = onclose;
+    if (onclose && !this._pipeRead.readable) onclose();
+  }
+  send(message) {
+    if (this._closed) throw new Error('Pipe has been closed');
+    this._pipeWrite.write(JSON.stringify(message));
+    this._pipeWrite.write('\0');
+  }
+  close() {
+    throw new Error('unimplemented');
+  }
+  _dispatch(buffer) {
+    let end = buffer.indexOf('\0');
+    if (end === -1) {
+      this._pendingBuffers.push(buffer);
+      return;
+    }
+    this._pendingBuffers.push(buffer.slice(0, end));
+    const message = Buffer.concat(this._pendingBuffers).toString();
+    this._waitForNextTask(() => {
+      if (this.onmessage) this.onmessage.call(null, JSON.parse(message));
+    });
+    let start = end + 1;
+    end = buffer.indexOf('\0', start);
+    while (end !== -1) {
+      const message = buffer.toString(undefined, start, end);
+      this._waitForNextTask(() => {
+        if (this.onmessage) this.onmessage.call(null, JSON.parse(message));
+      });
+      start = end + 1;
+      end = buffer.indexOf('\0', start);
+    }
+    this._pendingBuffers = [buffer.slice(start)];
+  }
+}
+exports.PipeTransport = PipeTransport;

package/lib/server/playwright.js

@@ -0,0 +1,82 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Playwright = void 0;
+exports.createPlaywright = createPlaywright;
+var _android = require("./android/android");
+var _backendAdb = require("./android/backendAdb");
+var _chromium = require("./chromium/chromium");
+var _electron = require("./electron/electron");
+var _firefox = require("./firefox/firefox");
+var _selectors = require("./selectors");
+var _webkit = require("./webkit/webkit");
+var _instrumentation = require("./instrumentation");
+var _debugLogger = require("../utils/debugLogger");
+var _debugController = require("./debugController");
+/**
+ * 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 Playwright extends _instrumentation.SdkObject {
+  constructor(options) {
+    super({
+      attribution: {},
+      instrumentation: (0, _instrumentation.createInstrumentation)()
+    }, undefined, 'Playwright');
+    this.selectors = void 0;
+    this.chromium = void 0;
+    this.android = void 0;
+    this.electron = void 0;
+    this.firefox = void 0;
+    this.webkit = void 0;
+    this.options = void 0;
+    this.debugController = void 0;
+    this._allPages = new Set();
+    this._allBrowsers = new Set();
+    this.options = options;
+    this.attribution.playwright = this;
+    this.instrumentation.addListener({
+      onBrowserOpen: browser => this._allBrowsers.add(browser),
+      onBrowserClose: browser => this._allBrowsers.delete(browser),
+      onPageOpen: page => this._allPages.add(page),
+      onPageClose: page => this._allPages.delete(page),
+      onCallLog: (sdkObject, metadata, logName, message) => {
+        _debugLogger.debugLogger.log(logName, message);
+      }
+    }, null);
+    this.chromium = new _chromium.Chromium(this);
+    this.firefox = new _firefox.Firefox(this);
+    this.webkit = new _webkit.WebKit(this);
+    this.electron = new _electron.Electron(this);
+    this.android = new _android.Android(this, new _backendAdb.AdbBackend());
+    this.selectors = new _selectors.Selectors();
+    this.debugController = new _debugController.DebugController(this);
+  }
+  async hideHighlight() {
+    await Promise.all([...this._allPages].map(p => p.hideHighlight().catch(() => {})));
+  }
+  allBrowsers() {
+    return [...this._allBrowsers];
+  }
+  allPages() {
+    return [...this._allPages];
+  }
+}
+exports.Playwright = Playwright;
+function createPlaywright(options) {
+  return new Playwright(options);
+}

package/lib/server/progress.js

@@ -0,0 +1,102 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ProgressController = void 0;
+var _errors = require("./errors");
+var _utils = require("../utils");
+var _manualPromise = require("../utils/manualPromise");
+/**
+ * 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 ProgressController {
+  constructor(metadata, sdkObject) {
+    this._forceAbortPromise = new _manualPromise.ManualPromise();
+    // Cleanups to be run only in the case of abort.
+    this._cleanups = [];
+    this._logName = 'api';
+    this._state = 'before';
+    this._deadline = 0;
+    this._timeout = 0;
+    this.metadata = void 0;
+    this.instrumentation = void 0;
+    this.sdkObject = void 0;
+    this.metadata = metadata;
+    this.sdkObject = sdkObject;
+    this.instrumentation = sdkObject.instrumentation;
+    this._forceAbortPromise.catch(e => null); // Prevent unhandled promise rejection.
+  }
+  setLogName(logName) {
+    this._logName = logName;
+  }
+  abort(error) {
+    this._forceAbortPromise.reject(error);
+  }
+  async run(task, timeout) {
+    var _this$sdkObject$attri;
+    if (timeout) {
+      this._timeout = timeout;
+      this._deadline = timeout ? (0, _utils.monotonicTime)() + timeout : 0;
+    }
+    (0, _utils.assert)(this._state === 'before');
+    this._state = 'running';
+    (_this$sdkObject$attri = this.sdkObject.attribution.context) === null || _this$sdkObject$attri === void 0 || _this$sdkObject$attri._activeProgressControllers.add(this);
+    const progress = {
+      log: message => {
+        if (this._state === 'running') this.metadata.log.push(message);
+        // Note: we might be sending logs after progress has finished, for example browser logs.
+        this.instrumentation.onCallLog(this.sdkObject, this.metadata, this._logName, message);
+      },
+      timeUntilDeadline: () => this._deadline ? this._deadline - (0, _utils.monotonicTime)() : 2147483647,
+      // 2^31-1 safe setTimeout in Node.
+      isRunning: () => this._state === 'running',
+      cleanupWhenAborted: cleanup => {
+        if (this._state === 'running') this._cleanups.push(cleanup);else runCleanup(cleanup);
+      },
+      throwIfAborted: () => {
+        if (this._state === 'aborted') throw new AbortedError();
+      },
+      beforeInputAction: async element => {
+        await this.instrumentation.onBeforeInputAction(this.sdkObject, this.metadata, element);
+      },
+      metadata: this.metadata
+    };
+    const timeoutError = new _errors.TimeoutError(`Timeout ${this._timeout}ms exceeded.`);
+    const timer = setTimeout(() => this._forceAbortPromise.reject(timeoutError), progress.timeUntilDeadline());
+    try {
+      const promise = task(progress);
+      const result = await Promise.race([promise, this._forceAbortPromise]);
+      this._state = 'finished';
+      return result;
+    } catch (e) {
+      this._state = 'aborted';
+      await Promise.all(this._cleanups.splice(0).map(runCleanup));
+      throw e;
+    } finally {
+      var _this$sdkObject$attri2;
+      (_this$sdkObject$attri2 = this.sdkObject.attribution.context) === null || _this$sdkObject$attri2 === void 0 || _this$sdkObject$attri2._activeProgressControllers.delete(this);
+      clearTimeout(timer);
+    }
+  }
+}
+exports.ProgressController = ProgressController;
+async function runCleanup(cleanup) {
+  try {
+    await cleanup();
+  } catch (e) {}
+}
+class AbortedError extends Error {}

package/lib/server/protocolError.js

@@ -0,0 +1,49 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ProtocolError = void 0;
+exports.isProtocolError = isProtocolError;
+exports.isSessionClosedError = isSessionClosedError;
+var _stackTrace = require("../utils/stackTrace");
+/**
+ * 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 ProtocolError extends Error {
+  constructor(type, method, logs) {
+    super();
+    this.type = void 0;
+    this.method = void 0;
+    this.logs = void 0;
+    this.type = type;
+    this.method = method;
+    this.logs = logs;
+  }
+  setMessage(message) {
+    (0, _stackTrace.rewriteErrorMessage)(this, `Protocol error (${this.method}): ${message}`);
+  }
+  browserLogMessage() {
+    return this.logs ? '\nBrowser logs:\n' + this.logs : '';
+  }
+}
+exports.ProtocolError = ProtocolError;
+function isProtocolError(e) {
+  return e instanceof ProtocolError;
+}
+function isSessionClosedError(e) {
+  return e instanceof ProtocolError && (e.type === 'closed' || e.type === 'crashed');
+}

package/lib/server/recorder/codeGenerator.js

@@ -0,0 +1,153 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CodeGenerator = void 0;
+var _events = require("events");
+/**
+ * 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 CodeGenerator extends _events.EventEmitter {
+  constructor(browserName, enabled, launchOptions, contextOptions, deviceName, saveStorage) {
+    super();
+
+    // Make a copy of options to modify them later.
+    this._currentAction = null;
+    this._lastAction = null;
+    this._actions = [];
+    this._enabled = void 0;
+    this._options = void 0;
+    launchOptions = {
+      headless: false,
+      ...launchOptions
+    };
+    contextOptions = {
+      ...contextOptions
+    };
+    this._enabled = enabled;
+    this._options = {
+      browserName,
+      launchOptions,
+      contextOptions,
+      deviceName,
+      saveStorage
+    };
+    this.restart();
+  }
+  restart() {
+    this._currentAction = null;
+    this._lastAction = null;
+    this._actions = [];
+    this.emit('change');
+  }
+  setEnabled(enabled) {
+    this._enabled = enabled;
+  }
+  addAction(action) {
+    if (!this._enabled) return;
+    this.willPerformAction(action);
+    this.didPerformAction(action);
+  }
+  willPerformAction(action) {
+    if (!this._enabled) return;
+    this._currentAction = action;
+  }
+  performedActionFailed(action) {
+    if (!this._enabled) return;
+    if (this._currentAction === action) this._currentAction = null;
+  }
+  didPerformAction(actionInContext) {
+    if (!this._enabled) return;
+    const action = actionInContext.action;
+    let eraseLastAction = false;
+    if (this._lastAction && this._lastAction.frame.pageAlias === actionInContext.frame.pageAlias) {
+      const lastAction = this._lastAction.action;
+      // We augment last action based on the type.
+      if (this._lastAction && action.name === 'fill' && lastAction.name === 'fill') {
+        if (action.selector === lastAction.selector) eraseLastAction = true;
+      }
+      if (lastAction && action.name === 'click' && lastAction.name === 'click') {
+        if (action.selector === lastAction.selector && action.clickCount > lastAction.clickCount) eraseLastAction = true;
+      }
+      if (lastAction && action.name === 'navigate' && lastAction.name === 'navigate') {
+        if (action.url === lastAction.url) {
+          // Already at a target URL.
+          this._currentAction = null;
+          return;
+        }
+      }
+      // Check and uncheck erase click.
+      if (lastAction && (action.name === 'check' || action.name === 'uncheck') && lastAction.name === 'click') {
+        if (action.selector === lastAction.selector) eraseLastAction = true;
+      }
+    }
+    this._lastAction = actionInContext;
+    this._currentAction = null;
+    if (eraseLastAction) this._actions.pop();
+    this._actions.push(actionInContext);
+    this.emit('change');
+  }
+  commitLastAction() {
+    if (!this._enabled) return;
+    const action = this._lastAction;
+    if (action) action.committed = true;
+  }
+  signal(pageAlias, frame, signal) {
+    if (!this._enabled) return;
+
+    // Signal either arrives while action is being performed or shortly after.
+    if (this._currentAction) {
+      this._currentAction.action.signals.push(signal);
+      return;
+    }
+    if (this._lastAction && !this._lastAction.committed) {
+      const signals = this._lastAction.action.signals;
+      if (signal.name === 'navigation' && signals.length && signals[signals.length - 1].name === 'download') return;
+      if (signal.name === 'download' && signals.length && signals[signals.length - 1].name === 'navigation') signals.length = signals.length - 1;
+      this._lastAction.action.signals.push(signal);
+      this.emit('change');
+      return;
+    }
+    if (signal.name === 'navigation' && frame._page.mainFrame() === frame) {
+      this.addAction({
+        frame: {
+          pageAlias,
+          isMainFrame: true
+        },
+        committed: true,
+        action: {
+          name: 'navigate',
+          url: frame.url(),
+          signals: []
+        }
+      });
+    }
+  }
+  generateStructure(languageGenerator) {
+    const header = languageGenerator.generateHeader(this._options);
+    const footer = languageGenerator.generateFooter(this._options.saveStorage);
+    const actions = this._actions.map(a => languageGenerator.generateAction(a)).filter(Boolean);
+    const text = [header, ...actions, footer].join('\n');
+    return {
+      header,
+      footer,
+      actions,
+      text
+    };
+  }
+}
+exports.CodeGenerator = CodeGenerator;