patchright-core 1.51.2 → 1.52.0

package/lib/server/recorder.js

@@ -1,45 +1,75 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var recorder_exports = {};
+__export(recorder_exports, {
+  Recorder: () => Recorder
 });
-exports.Recorder = void 0;
-var _fs = _interopRequireDefault(require("fs"));
-var consoleApiSource = _interopRequireWildcard(require("../generated/consoleApiSource"));
-var _utils = require("../utils");
-var _browserContext = require("./browserContext");
-var _debugger = require("./debugger");
-var _contextRecorder = require("./recorder/contextRecorder");
-var _recorderUtils = require("./recorder/recorderUtils");
-var _locatorParser = require("../utils/isomorphic/locatorParser");
-var _selectorParser = require("../utils/isomorphic/selectorParser");
-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 && {}.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(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * 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 recorderSymbol = Symbol('recorderSymbol');
+module.exports = __toCommonJS(recorder_exports);
+var import_fs = __toESM(require("fs"));
+var consoleApiSource = __toESM(require("../generated/consoleApiSource"));
+var import_utils = require("../utils");
+var import_browserContext = require("./browserContext");
+var import_debugger = require("./debugger");
+var import_contextRecorder = require("./recorder/contextRecorder");
+var import_recorderUtils = require("./recorder/recorderUtils");
+var import_locatorParser = require("../utils/isomorphic/locatorParser");
+var import_selectorParser = require("../utils/isomorphic/selectorParser");
+const recorderSymbol = Symbol("recorderSymbol");
 class Recorder {
+  constructor(context, params) {
+    this._highlightedElement = {};
+    this._overlayState = { offsetX: 0 };
+    this._recorderApp = null;
+    this._currentCallsMetadata = /* @__PURE__ */ new Map();
+    this._recorderSources = [];
+    this._userSources = /* @__PURE__ */ new Map();
+    this._omitCallTracking = false;
+    this._mode = params.mode || "none";
+    this.handleSIGINT = params.handleSIGINT;
+    this._contextRecorder = new import_contextRecorder.ContextRecorder(context, params, {});
+    this._context = context;
+    this._omitCallTracking = !!params.omitCallTracking;
+    this._debugger = context.debugger();
+    context.instrumentation.addListener(this, context);
+    this._currentLanguage = this._contextRecorder.languageName();
+    if ((0, import_utils.isUnderTest)()) {
+      this._overlayState.offsetX = 200;
+    }
+  }
   static async showInspector(context, params, recorderAppFactory) {
-    if ((0, _utils.isUnderTest)()) params.language = process.env.TEST_INSPECTOR_LANGUAGE;
+    if ((0, import_utils.isUnderTest)())
+      params.language = process.env.TEST_INSPECTOR_LANGUAGE;
     return await Recorder.show(context, recorderAppFactory, params);
   }
   static showInspectorNoReply(context, recorderAppFactory) {
-    Recorder.showInspector(context, {}, recorderAppFactory).catch(() => {});
+    Recorder.showInspector(context, {}, recorderAppFactory).catch(() => {
+    });
   }
   static show(context, recorderAppFactory, params) {
     let recorderPromise = context[recorderSymbol];
@@ -55,91 +85,68 @@ class Recorder {
     await recorder._install(recorderApp);
     return recorder;
   }
-  constructor(context, params) {
-    this.handleSIGINT = void 0;
-    this._context = void 0;
-    this._mode = void 0;
-    this._highlightedElement = {};
-    this._overlayState = {
-      offsetX: 0
-    };
-    this._recorderApp = null;
-    this._currentCallsMetadata = new Map();
-    this._recorderSources = [];
-    this._userSources = new Map();
-    this._debugger = void 0;
-    this._contextRecorder = void 0;
-    this._omitCallTracking = false;
-    this._currentLanguage = void 0;
-    this._mode = params.mode || 'none';
-    this.handleSIGINT = params.handleSIGINT;
-    this._contextRecorder = new _contextRecorder.ContextRecorder(context, params, {});
-    this._context = context;
-    this._omitCallTracking = !!params.omitCallTracking;
-    this._debugger = context.debugger();
-    context.instrumentation.addListener(this, context);
-    this._currentLanguage = this._contextRecorder.languageName();
-    if ((0, _utils.isUnderTest)()) {
-      // Most of our tests put elements at the top left, so get out of the way.
-      this._overlayState.offsetX = 200;
-    }
-  }
   async _install(recorderApp) {
     this._recorderApp = recorderApp;
-    recorderApp.once('close', () => {
+    recorderApp.once("close", () => {
       this._debugger.resume(false);
       this._recorderApp = null;
     });
-    recorderApp.on('event', data => {
-      if (data.event === 'setMode') {
+    recorderApp.on("event", (data) => {
+      if (data.event === "setMode") {
         this.setMode(data.params.mode);
         return;
       }
-      if (data.event === 'highlightRequested') {
-        if (data.params.selector) this.setHighlightedSelector(this._currentLanguage, data.params.selector);
-        if (data.params.ariaTemplate) this.setHighlightedAriaTemplate(data.params.ariaTemplate);
+      if (data.event === "highlightRequested") {
+        if (data.params.selector)
+          this.setHighlightedSelector(this._currentLanguage, data.params.selector);
+        if (data.params.ariaTemplate)
+          this.setHighlightedAriaTemplate(data.params.ariaTemplate);
         return;
       }
-      if (data.event === 'step') {
+      if (data.event === "step") {
         this._debugger.resume(true);
         return;
       }
-      if (data.event === 'fileChanged') {
+      if (data.event === "fileChanged") {
         this._currentLanguage = this._contextRecorder.languageName(data.params.file);
         this._refreshOverlay();
         return;
       }
-      if (data.event === 'resume') {
+      if (data.event === "resume") {
         this._debugger.resume(false);
         return;
       }
-      if (data.event === 'pause') {
+      if (data.event === "pause") {
         this._debugger.pauseOnNextStatement();
         return;
       }
-      if (data.event === 'clear') {
+      if (data.event === "clear") {
         this._contextRecorder.clearScript();
         return;
       }
-      if (data.event === 'runTask') {
+      if (data.event === "runTask") {
         this._contextRecorder.runTask(data.params.task);
         return;
       }
     });
-    await Promise.all([recorderApp.setMode(this._mode), recorderApp.setPaused(this._debugger.isPaused()), this._pushAllSources()]);
-    this._context.once(_browserContext.BrowserContext.Events.Close, () => {
-      var _this$_recorderApp;
+    await Promise.all([
+      recorderApp.setMode(this._mode),
+      recorderApp.setPaused(this._debugger.isPaused()),
+      this._pushAllSources()
+    ]);
+    this._context.once(import_browserContext.BrowserContext.Events.Close, () => {
       this._contextRecorder.dispose();
       this._context.instrumentation.removeListener(this);
-      (_this$_recorderApp = this._recorderApp) === null || _this$_recorderApp === void 0 || _this$_recorderApp.close().catch(() => {});
+      this._recorderApp?.close().catch(() => {
+      });
     });
-    this._contextRecorder.on(_contextRecorder.ContextRecorder.Events.Change, data => {
+    this._contextRecorder.on(import_contextRecorder.ContextRecorder.Events.Change, (data) => {
       this._recorderSources = data.sources;
       recorderApp.setActions(data.actions, data.sources);
-      recorderApp.setRunningFile(undefined);
+      recorderApp.setRunningFile(void 0);
       this._pushAllSources();
     });
-    await this._context.exposeBinding('__pw_recorderState', false, async source => {
+    await this._context.exposeBinding("__pw_recorderState", false, async (source) => {
       let actionSelector;
       let actionPoint;
       const hasActiveScreenshotCommand = [...this._currentCallsMetadata.keys()].some(isScreenshotCommand);
@@ -163,59 +170,50 @@ class Recorder {
       };
       return uiState;
     });
-    await this._context.exposeBinding('__pw_recorderElementPicked', false, async ({
-      frame
-    }, elementInfo) => {
-      var _this$_recorderApp2;
-      const selectorChain = await (0, _contextRecorder.generateFrameSelector)(frame);
-      await ((_this$_recorderApp2 = this._recorderApp) === null || _this$_recorderApp2 === void 0 ? void 0 : _this$_recorderApp2.elementPicked({
-        selector: (0, _recorderUtils.buildFullSelector)(selectorChain, elementInfo.selector),
-        ariaSnapshot: elementInfo.ariaSnapshot
-      }, true));
+    await this._context.exposeBinding("__pw_recorderElementPicked", false, async ({ frame }, elementInfo) => {
+      const selectorChain = await (0, import_contextRecorder.generateFrameSelector)(frame);
+      await this._recorderApp?.elementPicked({ selector: (0, import_recorderUtils.buildFullSelector)(selectorChain, elementInfo.selector), ariaSnapshot: elementInfo.ariaSnapshot }, true);
     });
-    await this._context.exposeBinding('__pw_recorderSetMode', false, async ({
-      frame
-    }, mode) => {
-      if (frame.parentFrame()) return;
+    await this._context.exposeBinding("__pw_recorderSetMode", false, async ({ frame }, mode) => {
+      if (frame.parentFrame())
+        return;
       this.setMode(mode);
     });
-    await this._context.exposeBinding('__pw_recorderSetOverlayState', false, async ({
-      frame
-    }, state) => {
-      if (frame.parentFrame()) return;
+    await this._context.exposeBinding("__pw_recorderSetOverlayState", false, async ({ frame }, state) => {
+      if (frame.parentFrame())
+        return;
       this._overlayState = state;
     });
-    await this._context.exposeBinding('__pw_resume', false, () => {
+    await this._context.exposeBinding("__pw_resume", false, () => {
       this._debugger.resume(false);
     });
     await this._context.extendInjectedScript(consoleApiSource.source);
     await this._contextRecorder.install();
-    if (this._debugger.isPaused()) this._pausedStateChanged();
-    this._debugger.on(_debugger.Debugger.Events.PausedStateChanged, () => this._pausedStateChanged());
+    if (this._debugger.isPaused())
+      this._pausedStateChanged();
+    this._debugger.on(import_debugger.Debugger.Events.PausedStateChanged, () => this._pausedStateChanged());
     this._context.recorderAppForTest = this._recorderApp;
   }
   _pausedStateChanged() {
-    var _this$_recorderApp3;
-    // If we are called upon page.pause, we don't have metadatas, populate them.
-    for (const {
-      metadata,
-      sdkObject
-    } of this._debugger.pausedDetails()) {
-      if (!this._currentCallsMetadata.has(metadata)) this.onBeforeCall(sdkObject, metadata);
+    for (const { metadata, sdkObject } of this._debugger.pausedDetails()) {
+      if (!this._currentCallsMetadata.has(metadata))
+        this.onBeforeCall(sdkObject, metadata);
     }
-    (_this$_recorderApp3 = this._recorderApp) === null || _this$_recorderApp3 === void 0 || _this$_recorderApp3.setPaused(this._debugger.isPaused());
+    this._recorderApp?.setPaused(this._debugger.isPaused());
     this._updateUserSources();
     this.updateCallLog([...this._currentCallsMetadata.keys()]);
   }
   setMode(mode) {
-    var _this$_recorderApp4;
-    if (this._mode === mode) return;
+    if (this._mode === mode)
+      return;
     this._highlightedElement = {};
     this._mode = mode;
-    (_this$_recorderApp4 = this._recorderApp) === null || _this$_recorderApp4 === void 0 || _this$_recorderApp4.setMode(this._mode);
+    this._recorderApp?.setMode(this._mode);
     this._contextRecorder.setEnabled(this._isRecording());
     this._debugger.setMuted(this._isRecording());
-    if (this._mode !== 'none' && this._mode !== 'standby' && this._context.pages().length === 1) this._context.pages()[0].bringToFront().catch(() => {});
+    if (this._mode !== "none" && this._mode !== "standby" && this._context.pages().length === 1)
+      this._context.pages()[0].bringToFront().catch(() => {
+      });
     this._refreshOverlay();
   }
   resume() {
@@ -225,15 +223,11 @@ class Recorder {
     return this._mode;
   }
   setHighlightedSelector(language, selector) {
-    this._highlightedElement = {
-      selector: (0, _locatorParser.locatorOrSelectorAsSelector)(language, selector, this._context.selectors().testIdAttributeName())
-    };
+    this._highlightedElement = { selector: (0, import_locatorParser.locatorOrSelectorAsSelector)(language, selector, this._context.selectors().testIdAttributeName()) };
     this._refreshOverlay();
   }
   setHighlightedAriaTemplate(ariaTemplate) {
-    this._highlightedElement = {
-      ariaTemplate
-    };
+    this._highlightedElement = { ariaTemplate };
     this._refreshOverlay();
   }
   hideHighlightedSelector() {
@@ -241,23 +235,20 @@ class Recorder {
     this._refreshOverlay();
   }
   async _scopeHighlightedSelectorToFrame(frame) {
-    if (!this._highlightedElement.selector) return;
+    if (!this._highlightedElement.selector)
+      return;
     try {
       const mainFrame = frame._page.mainFrame();
       const resolved = await mainFrame.selectors.resolveFrameForSelector(this._highlightedElement.selector);
-      // selector couldn't be found, don't highlight anything
-      if (!resolved) return '';
-
-      // selector points to no specific frame, highlight in all frames
-      if ((resolved === null || resolved === void 0 ? void 0 : resolved.frame) === mainFrame) return (0, _selectorParser.stringifySelector)(resolved.info.parsed);
-
-      // selector points to this frame, highlight it
-      if ((resolved === null || resolved === void 0 ? void 0 : resolved.frame) === frame) return (0, _selectorParser.stringifySelector)(resolved.info.parsed);
-
-      // selector points to a different frame, highlight nothing
-      return '';
+      if (!resolved)
+        return "";
+      if (resolved?.frame === mainFrame)
+        return (0, import_selectorParser.stringifySelector)(resolved.info.parsed);
+      if (resolved?.frame === frame)
+        return (0, import_selectorParser.stringifySelector)(resolved.info.parsed);
+      return "";
     } catch {
-      return '';
+      return "";
     }
   }
   setOutput(codegenId, outputFile) {
@@ -265,105 +256,105 @@ class Recorder {
   }
   _refreshOverlay() {
     for (const page of this._context.pages()) {
-      for (const frame of page.frames()) frame.evaluateExpression('window.__pw_refreshOverlay()').catch(() => {});
+      for (const frame of page.frames())
+        frame.evaluateExpression("window.__pw_refreshOverlay()").catch(() => {
+        });
     }
   }
   async onBeforeCall(sdkObject, metadata) {
-    if (this._omitCallTracking || this._isRecording()) return;
+    if (this._omitCallTracking || this._isRecording())
+      return;
     this._currentCallsMetadata.set(metadata, sdkObject);
     this._updateUserSources();
     this.updateCallLog([metadata]);
-    if (isScreenshotCommand(metadata)) this.hideHighlightedSelector();else if (metadata.params && metadata.params.selector) this._highlightedElement = {
-      selector: metadata.params.selector
-    };
+    if (isScreenshotCommand(metadata))
+      this.hideHighlightedSelector();
+    else if (metadata.params && metadata.params.selector)
+      this._highlightedElement = { selector: metadata.params.selector };
   }
   async onAfterCall(sdkObject, metadata) {
-    if (this._omitCallTracking || this._isRecording()) return;
-    if (!metadata.error) this._currentCallsMetadata.delete(metadata);
+    if (this._omitCallTracking || this._isRecording())
+      return;
+    if (!metadata.error)
+      this._currentCallsMetadata.delete(metadata);
     this._updateUserSources();
     this.updateCallLog([metadata]);
   }
   _updateUserSources() {
-    var _this$_recorderApp5;
-    // Remove old decorations.
     for (const source of this._userSources.values()) {
       source.highlight = [];
-      source.revealLine = undefined;
+      source.revealLine = void 0;
     }
-
-    // Apply new decorations.
-    let fileToSelect = undefined;
+    let fileToSelect = void 0;
     for (const metadata of this._currentCallsMetadata.keys()) {
-      if (!metadata.location) continue;
-      const {
-        file,
-        line
-      } = metadata.location;
+      if (!metadata.location)
+        continue;
+      const { file, line } = metadata.location;
       let source = this._userSources.get(file);
       if (!source) {
-        source = {
-          isRecorded: false,
-          label: file,
-          id: file,
-          text: this._readSource(file),
-          highlight: [],
-          language: languageForFile(file)
-        };
+        source = { isRecorded: false, label: file, id: file, text: this._readSource(file), highlight: [], language: languageForFile(file) };
         this._userSources.set(file, source);
       }
       if (line) {
         const paused = this._debugger.isPaused(metadata);
-        source.highlight.push({
-          line,
-          type: metadata.error ? 'error' : paused ? 'paused' : 'running'
-        });
+        source.highlight.push({ line, type: metadata.error ? "error" : paused ? "paused" : "running" });
         source.revealLine = line;
         fileToSelect = source.id;
       }
     }
     this._pushAllSources();
-    if (fileToSelect) (_this$_recorderApp5 = this._recorderApp) === null || _this$_recorderApp5 === void 0 || _this$_recorderApp5.setRunningFile(fileToSelect);
+    if (fileToSelect)
+      this._recorderApp?.setRunningFile(fileToSelect);
   }
   _pushAllSources() {
-    var _this$_recorderApp6;
     const primaryPage = this._context.pages()[0];
-    (_this$_recorderApp6 = this._recorderApp) === null || _this$_recorderApp6 === void 0 || _this$_recorderApp6.setSources([...this._recorderSources, ...this._userSources.values()], primaryPage === null || primaryPage === void 0 ? void 0 : primaryPage.mainFrame().url());
+    this._recorderApp?.setSources([...this._recorderSources, ...this._userSources.values()], primaryPage?.mainFrame().url());
+  }
+  async onBeforeInputAction(sdkObject, metadata) {
   }
-  async onBeforeInputAction(sdkObject, metadata) {}
   async onCallLog(sdkObject, metadata, logName, message) {
     this.updateCallLog([metadata]);
   }
   updateCallLog(metadatas) {
-    var _this$_recorderApp7;
-    if (this._isRecording()) return;
+    if (this._isRecording())
+      return;
     const logs = [];
     for (const metadata of metadatas) {
-      if (!metadata.method || metadata.internal) continue;
-      let status = 'done';
-      if (this._currentCallsMetadata.has(metadata)) status = 'in-progress';
-      if (this._debugger.isPaused(metadata)) status = 'paused';
-      logs.push((0, _recorderUtils.metadataToCallLog)(metadata, status));
+      if (!metadata.method || metadata.internal)
+        continue;
+      let status = "done";
+      if (this._currentCallsMetadata.has(metadata))
+        status = "in-progress";
+      if (this._debugger.isPaused(metadata))
+        status = "paused";
+      logs.push((0, import_recorderUtils.metadataToCallLog)(metadata, status));
     }
-    (_this$_recorderApp7 = this._recorderApp) === null || _this$_recorderApp7 === void 0 || _this$_recorderApp7.updateCallLogs(logs);
+    this._recorderApp?.updateCallLogs(logs);
   }
   _isRecording() {
-    return ['recording', 'assertingText', 'assertingVisibility', 'assertingValue', 'assertingSnapshot'].includes(this._mode);
+    return ["recording", "assertingText", "assertingVisibility", "assertingValue", "assertingSnapshot"].includes(this._mode);
   }
   _readSource(fileName) {
     try {
-      return _fs.default.readFileSync(fileName, 'utf-8');
+      return import_fs.default.readFileSync(fileName, "utf-8");
     } catch (e) {
-      return '// No source available';
+      return "// No source available";
     }
   }
 }
-exports.Recorder = Recorder;
 function isScreenshotCommand(metadata) {
-  return metadata.method.toLowerCase().includes('screenshot');
+  return metadata.method.toLowerCase().includes("screenshot");
 }
 function languageForFile(file) {
-  if (file.endsWith('.py')) return 'python';
-  if (file.endsWith('.java')) return 'java';
-  if (file.endsWith('.cs')) return 'csharp';
-  return 'javascript';
-}
+  if (file.endsWith(".py"))
+    return "python";
+  if (file.endsWith(".java"))
+    return "java";
+  if (file.endsWith(".cs"))
+    return "csharp";
+  return "javascript";
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Recorder
+});