@checkly/playwright-core 1.42.18 → 1.47.20-alpha

package/lib/server/recorder/contextRecorder.js

@@ -0,0 +1,316 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ContextRecorder = void 0;
+exports.generateFrameSelector = generateFrameSelector;
+var _events = require("events");
+var recorderSource = _interopRequireWildcard(require("../../generated/recorderSource"));
+var _utils = require("../../utils");
+var _timeoutRunner = require("../../utils/timeoutRunner");
+var _browserContext = require("../browserContext");
+var _languages = require("../codegen/languages");
+var _frames = require("../frames");
+var _page = require("../page");
+var _recorderRunner = require("./recorderRunner");
+var _throttledFile = require("./throttledFile");
+var _recorderCollection = require("./recorderCollection");
+var _language = require("../codegen/language");
+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 ContextRecorder extends _events.EventEmitter {
+  constructor(context, params, delegate) {
+    super();
+    this._collection = void 0;
+    this._pageAliases = new Map();
+    this._lastPopupOrdinal = 0;
+    this._lastDialogOrdinal = -1;
+    this._lastDownloadOrdinal = -1;
+    this._timers = new Set();
+    this._context = void 0;
+    this._params = void 0;
+    this._delegate = void 0;
+    this._recorderSources = void 0;
+    this._throttledOutputFile = null;
+    this._orderedLanguages = [];
+    this._listeners = [];
+    this._context = context;
+    this._params = params;
+    this._delegate = delegate;
+    this._recorderSources = [];
+    const language = params.language || context.attribution.playwright.options.sdkLanguage;
+    this.setOutput(language, params.outputFile);
+
+    // Make a copy of options to modify them later.
+    const languageGeneratorOptions = {
+      browserName: context._browser.options.name,
+      launchOptions: {
+        headless: false,
+        ...params.launchOptions
+      },
+      contextOptions: {
+        ...params.contextOptions
+      },
+      deviceName: params.device,
+      saveStorage: params.saveStorage
+    };
+    const collection = new _recorderCollection.RecorderCollection(params.mode === 'recording');
+    collection.on('change', () => {
+      this._recorderSources = [];
+      for (const languageGenerator of this._orderedLanguages) {
+        var _this$_throttledOutpu;
+        const {
+          header,
+          footer,
+          actionTexts,
+          text
+        } = (0, _language.generateCode)(collection.actions(), languageGenerator, languageGeneratorOptions);
+        const source = {
+          isRecorded: true,
+          label: languageGenerator.name,
+          group: languageGenerator.groupName,
+          id: languageGenerator.id,
+          text,
+          header,
+          footer,
+          actions: actionTexts,
+          language: languageGenerator.highlighter,
+          highlight: []
+        };
+        source.revealLine = text.split('\n').length - 1;
+        this._recorderSources.push(source);
+        if (languageGenerator === this._orderedLanguages[0]) (_this$_throttledOutpu = this._throttledOutputFile) === null || _this$_throttledOutpu === void 0 || _this$_throttledOutpu.setContent(source.text);
+      }
+      this.emit(ContextRecorder.Events.Change, {
+        sources: this._recorderSources,
+        primaryFileName: this._orderedLanguages[0].id
+      });
+    });
+    context.on(_browserContext.BrowserContext.Events.BeforeClose, () => {
+      var _this$_throttledOutpu2;
+      (_this$_throttledOutpu2 = this._throttledOutputFile) === null || _this$_throttledOutpu2 === void 0 || _this$_throttledOutpu2.flush();
+    });
+    this._listeners.push(_utils.eventsHelper.addEventListener(process, 'exit', () => {
+      var _this$_throttledOutpu3;
+      (_this$_throttledOutpu3 = this._throttledOutputFile) === null || _this$_throttledOutpu3 === void 0 || _this$_throttledOutpu3.flush();
+    }));
+    this._collection = collection;
+  }
+  setOutput(codegenId, outputFile) {
+    var _this$_collection;
+    const languages = (0, _languages.languageSet)();
+    const primaryLanguage = [...languages].find(l => l.id === codegenId);
+    if (!primaryLanguage) throw new Error(`\n===============================\nUnsupported language: '${codegenId}'\n===============================\n`);
+    languages.delete(primaryLanguage);
+    this._orderedLanguages = [primaryLanguage, ...languages];
+    this._throttledOutputFile = outputFile ? new _throttledFile.ThrottledFile(outputFile) : null;
+    (_this$_collection = this._collection) === null || _this$_collection === void 0 || _this$_collection.restart();
+  }
+  languageName(id) {
+    for (const lang of this._orderedLanguages) {
+      if (!id || lang.id === id) return lang.highlighter;
+    }
+    return 'javascript';
+  }
+  async install() {
+    this._context.on(_browserContext.BrowserContext.Events.Page, page => this._onPage(page));
+    for (const page of this._context.pages()) this._onPage(page);
+    this._context.on(_browserContext.BrowserContext.Events.Dialog, dialog => this._onDialog(dialog.page()));
+
+    // Input actions that potentially lead to navigation are intercepted on the page and are
+    // performed by the Playwright.
+    await this._context.exposeBinding('__pw_recorderPerformAction', false, (source, action) => this._performAction(source.frame, action));
+
+    // Other non-essential actions are simply being recorded.
+    await this._context.exposeBinding('__pw_recorderRecordAction', false, (source, action) => this._recordAction(source.frame, action));
+    await this._context.extendInjectedScript(recorderSource.source);
+  }
+  setEnabled(enabled) {
+    this._collection.setEnabled(enabled);
+  }
+  dispose() {
+    for (const timer of this._timers) clearTimeout(timer);
+    this._timers.clear();
+    _utils.eventsHelper.removeEventListeners(this._listeners);
+  }
+  async _onPage(page) {
+    // First page is called page, others are called popup1, popup2, etc.
+    const frame = page.mainFrame();
+    page.on('close', () => {
+      this._collection.addAction({
+        frame: this._describeMainFrame(page),
+        committed: true,
+        action: {
+          name: 'closePage',
+          signals: []
+        }
+      });
+      this._pageAliases.delete(page);
+    });
+    frame.on(_frames.Frame.Events.InternalNavigation, event => {
+      if (event.isPublic) this._onFrameNavigated(frame, page);
+    });
+    page.on(_page.Page.Events.Download, () => this._onDownload(page));
+    const suffix = this._pageAliases.size ? String(++this._lastPopupOrdinal) : '';
+    const pageAlias = 'page' + suffix;
+    this._pageAliases.set(page, pageAlias);
+    if (page.opener()) {
+      this._onPopup(page.opener(), page);
+    } else {
+      this._collection.addAction({
+        frame: this._describeMainFrame(page),
+        committed: true,
+        action: {
+          name: 'openPage',
+          url: page.mainFrame().url(),
+          signals: []
+        }
+      });
+    }
+  }
+  clearScript() {
+    this._collection.restart();
+    if (this._params.mode === 'recording') {
+      for (const page of this._context.pages()) this._onFrameNavigated(page.mainFrame(), page);
+    }
+  }
+  _describeMainFrame(page) {
+    return {
+      pageAlias: this._pageAliases.get(page),
+      framePath: []
+    };
+  }
+  async _describeFrame(frame) {
+    return {
+      pageAlias: this._pageAliases.get(frame._page),
+      framePath: await generateFrameSelector(frame)
+    };
+  }
+  testIdAttributeName() {
+    return this._params.testIdAttributeName || this._context.selectors().testIdAttributeName() || 'data-testid';
+  }
+  async _performAction(frame, action) {
+    var _this$_delegate$rewri, _this$_delegate;
+    // Commit last action so that no further signals are added to it.
+    this._collection.commitLastAction();
+    const frameDescription = await this._describeFrame(frame);
+    const actionInContext = {
+      frame: frameDescription,
+      action,
+      description: undefined
+    };
+    await ((_this$_delegate$rewri = (_this$_delegate = this._delegate).rewriteActionInContext) === null || _this$_delegate$rewri === void 0 ? void 0 : _this$_delegate$rewri.call(_this$_delegate, this._pageAliases, actionInContext));
+    this._collection.willPerformAction(actionInContext);
+    const success = await (0, _recorderRunner.performAction)(this._pageAliases, actionInContext);
+    if (success) {
+      this._collection.didPerformAction(actionInContext);
+      this._setCommittedAfterTimeout(actionInContext);
+    } else {
+      this._collection.performedActionFailed(actionInContext);
+    }
+  }
+  async _recordAction(frame, action) {
+    var _this$_delegate$rewri2, _this$_delegate2;
+    // Commit last action so that no further signals are added to it.
+    this._collection.commitLastAction();
+    const frameDescription = await this._describeFrame(frame);
+    const actionInContext = {
+      frame: frameDescription,
+      action,
+      description: undefined
+    };
+    await ((_this$_delegate$rewri2 = (_this$_delegate2 = this._delegate).rewriteActionInContext) === null || _this$_delegate$rewri2 === void 0 ? void 0 : _this$_delegate$rewri2.call(_this$_delegate2, this._pageAliases, actionInContext));
+    this._setCommittedAfterTimeout(actionInContext);
+    this._collection.addAction(actionInContext);
+  }
+  _setCommittedAfterTimeout(actionInContext) {
+    const timer = setTimeout(() => {
+      // Commit the action after 5 seconds so that no further signals are added to it.
+      actionInContext.committed = true;
+      this._timers.delete(timer);
+    }, (0, _utils.isUnderTest)() ? 500 : 5000);
+    this._timers.add(timer);
+  }
+  _onFrameNavigated(frame, page) {
+    const pageAlias = this._pageAliases.get(page);
+    this._collection.signal(pageAlias, frame, {
+      name: 'navigation',
+      url: frame.url()
+    });
+  }
+  _onPopup(page, popup) {
+    const pageAlias = this._pageAliases.get(page);
+    const popupAlias = this._pageAliases.get(popup);
+    this._collection.signal(pageAlias, page.mainFrame(), {
+      name: 'popup',
+      popupAlias
+    });
+  }
+  _onDownload(page) {
+    const pageAlias = this._pageAliases.get(page);
+    ++this._lastDownloadOrdinal;
+    this._collection.signal(pageAlias, page.mainFrame(), {
+      name: 'download',
+      downloadAlias: this._lastDownloadOrdinal ? String(this._lastDownloadOrdinal) : ''
+    });
+  }
+  _onDialog(page) {
+    const pageAlias = this._pageAliases.get(page);
+    ++this._lastDialogOrdinal;
+    this._collection.signal(pageAlias, page.mainFrame(), {
+      name: 'dialog',
+      dialogAlias: this._lastDialogOrdinal ? String(this._lastDialogOrdinal) : ''
+    });
+  }
+}
+exports.ContextRecorder = ContextRecorder;
+ContextRecorder.Events = {
+  Change: 'change'
+};
+async function generateFrameSelector(frame) {
+  const selectorPromises = [];
+  while (frame) {
+    const parent = frame.parentFrame();
+    if (!parent) break;
+    selectorPromises.push(generateFrameSelectorInParent(parent, frame));
+    frame = parent;
+  }
+  const result = await Promise.all(selectorPromises);
+  return result.reverse();
+}
+async function generateFrameSelectorInParent(parent, frame) {
+  const result = await (0, _timeoutRunner.raceAgainstDeadline)(async () => {
+    try {
+      const frameElement = await frame.frameElement();
+      if (!frameElement || !parent) return;
+      const utility = await parent._utilityContext();
+      const injected = await utility.injectedScript();
+      const selector = await injected.evaluate((injected, element) => {
+        return injected.generateSelectorSimple(element);
+      }, frameElement);
+      return selector;
+    } catch (e) {
+      return e.toString();
+    }
+  }, (0, _utils.monotonicTime)() + 2000);
+  if (!result.timedOut && result.result) return result.result;
+  if (frame.name()) return `iframe[name=${(0, _utils.quoteCSSAttributeValue)(frame.name())}]`;
+  return `iframe[src=${(0, _utils.quoteCSSAttributeValue)(frame.url())}]`;
+}

package/lib/server/recorder/csharp.js

@@ -307,4 +307,5 @@ class CSharpFormatter {
 }
 function quote(text) {
   return (0, _stringUtils.escapeWithQuotes)(text, '\"');
-}
+}
+//# sourceMappingURL=csharp.js.map

package/lib/server/recorder/java.js

@@ -245,4 +245,5 @@ function formatClickOptions(options) {
 }
 function quote(text) {
   return (0, _stringUtils.escapeWithQuotes)(text, '\"');
-}
+}
+//# sourceMappingURL=java.js.map

package/lib/server/recorder/javascript.js

@@ -226,4 +226,5 @@ class JavaScriptFormatter {
 exports.JavaScriptFormatter = JavaScriptFormatter;
 function quote(text) {
   return (0, _stringUtils.escapeWithQuotes)(text, '\'');
-}
+}
+//# sourceMappingURL=javascript.js.map

package/lib/server/recorder/jsonl.js

@@ -44,4 +44,5 @@ class JsonlLanguageGenerator {
     return '';
   }
 }
-exports.JsonlLanguageGenerator = JsonlLanguageGenerator;
+exports.JsonlLanguageGenerator = JsonlLanguageGenerator;
+//# sourceMappingURL=jsonl.js.map

package/lib/server/recorder/language.js

@@ -41,4 +41,5 @@ function toSignalMap(action) {
     download,
     dialog
   };
-}
+}
+//# sourceMappingURL=language.js.map

package/lib/server/recorder/python.js

@@ -272,4 +272,5 @@ class PythonFormatter {
 }
 function quote(text) {
   return (0, _stringUtils.escapeWithQuotes)(text, '\"');
-}
+}
+//# sourceMappingURL=python.js.map

package/lib/server/recorder/recorderApp.js

@@ -85,7 +85,13 @@ class RecorderApp extends _events.EventEmitter {
     const mainFrame = this._page.mainFrame();
     await mainFrame.goto((0, _instrumentation.serverSideCallMetadata)(), 'https://playwright/index.html');
   }
-  static async open(recorder, inspectedContext, handleSIGINT) {
+  static factory(context) {
+    return async recorder => {
+      if (process.env.PW_CODEGEN_NO_INSPECTOR) return new EmptyRecorderApp();
+      return await RecorderApp._open(recorder, context);
+    };
+  }
+  static async _open(recorder, inspectedContext) {
     const sdkLanguage = inspectedContext.attribution.playwright.options.sdkLanguage;
     const headed = !!inspectedContext._browser.options.headful;
     const recorderPlaywright = require('../playwright').createPlaywright({
@@ -109,8 +115,9 @@ class RecorderApp extends _events.EventEmitter {
         noDefaultViewport: true,
         headless: !!process.env.PWTEST_CLI_HEADLESS || (0, _utils.isUnderTest)() && !headed,
         useWebSocket: !!process.env.PWTEST_RECORDER_PORT,
-        handleSIGINT,
-        args: process.env.PWTEST_RECORDER_PORT ? [`--remote-debugging-port=${process.env.PWTEST_RECORDER_PORT}`] : []
+        handleSIGINT: false,
+        args: process.env.PWTEST_RECORDER_PORT ? [`--remote-debugging-port=${process.env.PWTEST_RECORDER_PORT}`] : [],
+        executablePath: inspectedContext._browser.options.isChromium ? inspectedContext._browser.options.customExecutablePath : undefined
       }
     });
     const controller = new _progress.ProgressController((0, _instrumentation.serverSideCallMetadata)(), context._browser);
@@ -154,11 +161,13 @@ class RecorderApp extends _events.EventEmitter {
   }
   async setSelector(selector, userGesture) {
     if (userGesture) {
-      if (this._recorder.mode() === 'inspecting') {
+      var _this$_recorder;
+      if (((_this$_recorder = this._recorder) === null || _this$_recorder === void 0 ? void 0 : _this$_recorder.mode()) === 'inspecting') {
         this._recorder.setMode('standby');
         this._page.bringToFront();
       } else {
-        this._recorder.setMode('recording');
+        var _this$_recorder2;
+        (_this$_recorder2 = this._recorder) === null || _this$_recorder2 === void 0 || _this$_recorder2.setMode('recording');
       }
     }
     await this._page.mainFrame().evaluateExpression((data => {

package/lib/server/recorder/recorderCollection.js

@@ -0,0 +1,127 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.RecorderCollection = 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 RecorderCollection extends _events.EventEmitter {
+  constructor(enabled) {
+    super();
+    this._currentAction = null;
+    this._lastAction = null;
+    this._actions = [];
+    this._enabled = void 0;
+    this._enabled = enabled;
+    this.restart();
+  }
+  restart() {
+    this._currentAction = null;
+    this._lastAction = null;
+    this._actions = [];
+    this.emit('change');
+  }
+  actions() {
+    return this._actions;
+  }
+  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 || signal.name !== 'navigation')) {
+      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,
+          framePath: []
+        },
+        committed: true,
+        action: {
+          name: 'navigate',
+          url: frame.url(),
+          signals: []
+        }
+      });
+    }
+  }
+}
+exports.RecorderCollection = RecorderCollection;