patchright-core 1.57.0 → 1.59.0

package/lib/server/recorder/recorderApp.js

@@ -53,6 +53,7 @@ class RecorderApp {
     this._recorderSources = [];
     this._page = page;
     this._recorder = recorder;
+    this._frontend = createRecorderFrontend(page);
     this.wsEndpointForTest = wsEndpointForTest;
     this._languageGeneratorOptions = {
       browserName: params.browserName,
@@ -64,6 +65,10 @@ class RecorderApp {
     this._throttledOutputFile = params.outputFile ? new import_throttledFile.ThrottledFile(params.outputFile) : null;
     this._primaryGeneratorId = process.env.TEST_INSPECTOR_LANGUAGE || params.language || determinePrimaryGeneratorId(params.sdkLanguage);
     this._selectedGeneratorId = this._primaryGeneratorId;
+    for (const languageGenerator of (0, import_languages.languageSet)()) {
+      if (languageGenerator.id === this._primaryGeneratorId)
+        this._recorder.setLanguage(languageGenerator.highlighter);
+    }
   }
   async _init(inspectedContext) {
     await (0, import_launchApp.syncLocalStorageWithSettings)(this._page, "recorder");
@@ -89,7 +94,7 @@ class RecorderApp {
           });
         });
       });
-      await this._page.exposeBinding(progress, "dispatch", false, (_, data) => this._handleUIEvent(data));
+      await this._createDispatcher(progress);
       this._page.once("close", () => {
         this._recorder.close();
         this._page.browserContext.close({ reason: "Recorder window closed" }).catch(() => {
@@ -100,59 +105,56 @@ class RecorderApp {
     });
     const url = this._recorder.url();
     if (url)
-      this._onPageNavigated(url);
-    this._onModeChanged(this._recorder.mode());
-    this._onPausedStateChanged(this._recorder.paused());
+      this._frontend.pageNavigated({ url });
+    this._frontend.modeChanged({ mode: this._recorder.mode() });
+    this._frontend.pauseStateChanged({ paused: this._recorder.paused() });
     this._updateActions("reveal");
     this._onUserSourcesChanged(this._recorder.userSources(), this._recorder.pausedSourceId());
-    this._onCallLogsUpdated(this._recorder.callLog());
+    this._frontend.callLogsUpdated({ callLogs: this._recorder.callLog() });
     this._wireListeners(this._recorder);
   }
-  _handleUIEvent(data) {
-    if (data.event === "clear") {
-      this._actions = [];
-      this._updateActions("reveal");
-      this._recorder.clear();
-      return;
-    }
-    if (data.event === "fileChanged") {
-      const source = [...this._recorderSources, ...this._userSources].find((s) => s.id === data.params.fileId);
-      if (source) {
-        if (source.isRecorded)
-          this._selectedGeneratorId = source.id;
-        this._recorder.setLanguage(source.language);
+  async _createDispatcher(progress) {
+    const dispatcher = {
+      clear: async () => {
+        this._actions = [];
+        this._updateActions("reveal");
+        this._recorder.clear();
+      },
+      fileChanged: async (params) => {
+        const source = [...this._recorderSources, ...this._userSources].find((s) => s.id === params.fileId);
+        if (source) {
+          if (source.isRecorded)
+            this._selectedGeneratorId = source.id;
+          await this._recorder.setLanguage(source.language);
+        }
+      },
+      setAutoExpect: async (params) => {
+        this._languageGeneratorOptions.generateAutoExpect = params.autoExpect;
+        this._updateActions();
+      },
+      setMode: async (params) => {
+        await this._recorder.setMode(params.mode);
+      },
+      resume: async () => {
+        this._recorder.resume();
+      },
+      pause: async () => {
+        this._recorder.pause();
+      },
+      step: async () => {
+        this._recorder.step();
+      },
+      highlightRequested: async (params) => {
+        if (params.selector)
+          await this._recorder.setHighlightedSelector(params.selector);
+        if (params.ariaTemplate)
+          await this._recorder.setHighlightedAriaTemplate(params.ariaTemplate);
       }
-      return;
-    }
-    if (data.event === "setAutoExpect") {
-      this._languageGeneratorOptions.generateAutoExpect = data.params.autoExpect;
-      this._updateActions();
-      return;
-    }
-    if (data.event === "setMode") {
-      this._recorder.setMode(data.params.mode);
-      return;
-    }
-    if (data.event === "resume") {
-      this._recorder.resume();
-      return;
-    }
-    if (data.event === "pause") {
-      this._recorder.pause();
-      return;
-    }
-    if (data.event === "step") {
-      this._recorder.step();
-      return;
-    }
-    if (data.event === "highlightRequested") {
-      if (data.params.selector)
-        this._recorder.setHighlightedSelector(data.params.selector);
-      if (data.params.ariaTemplate)
-        this._recorder.setHighlightedAriaTemplate(data.params.ariaTemplate);
-      return;
-    }
-    throw new Error(`Unknown event: ${data.event}`);
+    };
+    await this._page.exposeBinding(progress, "sendCommand", false, async (_, data) => {
+      const { method, params } = data;
+      return await dispatcher[method].call(dispatcher, params);
+    });
   }
   static async show(context, params) {
     if (process.env.PW_CODEGEN_NO_INSPECTOR)
@@ -179,6 +181,7 @@ class RecorderApp {
       return;
     inspectedContext[recorderAppSymbol] = true;
     const sdkLanguage = inspectedContext._browser.sdkLanguage();
+    const isChromium = inspectedContext._browser.options.browserType === "chromium";
     const headed = !!inspectedContext._browser.options.headful;
     const recorderPlaywright = require("../playwright").createPlaywright({ sdkLanguage: "javascript", isInternalPlaywright: true });
     const { context: appContext, page } = await (0, import_launchApp2.launchApp)(recorderPlaywright.chromium, {
@@ -190,9 +193,9 @@ class RecorderApp {
         headless: !!process.env.PWTEST_CLI_HEADLESS || (0, import_debug.isUnderTest)() && !headed,
         cdpPort: (0, import_debug.isUnderTest)() ? 0 : void 0,
         handleSIGINT: params.handleSIGINT,
-        executablePath: inspectedContext._browser.options.isChromium ? inspectedContext._browser.options.customExecutablePath : void 0,
+        executablePath: isChromium ? inspectedContext._browser.options.customExecutablePath : void 0,
         // Use the same channel as the inspected context to guarantee that the browser is installed.
-        channel: inspectedContext._browser.options.isChromium ? inspectedContext._browser.options.channel : void 0
+        channel: isChromium ? inspectedContext._browser.options.channel : void 0
       }
     });
     const controller = new import_progress.ProgressController();
@@ -204,8 +207,8 @@ class RecorderApp {
       sdkLanguage: inspectedContext._browser.sdkLanguage(),
       wsEndpointForTest: inspectedContext._browser.options.wsEndpoint,
       headed: !!inspectedContext._browser.options.headful,
-      executablePath: inspectedContext._browser.options.isChromium ? inspectedContext._browser.options.customExecutablePath : void 0,
-      channel: inspectedContext._browser.options.isChromium ? inspectedContext._browser.options.channel : void 0,
+      executablePath: isChromium ? inspectedContext._browser.options.customExecutablePath : void 0,
+      channel: isChromium ? inspectedContext._browser.options.channel : void 0,
       ...params
     };
     const recorderApp = new RecorderApp(recorder, appParams, page, appContext._browser.options.wsEndpoint);
@@ -220,25 +223,29 @@ class RecorderApp {
       this._onSignalAdded(signal);
     });
     recorder.on(import_recorder.RecorderEvent.PageNavigated, (url) => {
-      this._onPageNavigated(url);
+      this._frontend.pageNavigated({ url });
     });
     recorder.on(import_recorder.RecorderEvent.ContextClosed, () => {
-      this._onContextClosed();
+      this._throttledOutputFile?.flush();
+      this._page.browserContext.close({ reason: "Recorder window closed" }).catch(() => {
+      });
     });
     recorder.on(import_recorder.RecorderEvent.ModeChanged, (mode) => {
-      this._onModeChanged(mode);
+      this._frontend.modeChanged({ mode });
     });
     recorder.on(import_recorder.RecorderEvent.PausedStateChanged, (paused) => {
-      this._onPausedStateChanged(paused);
+      this._frontend.pauseStateChanged({ paused });
     });
     recorder.on(import_recorder.RecorderEvent.UserSourcesChanged, (sources, pausedSourceId) => {
       this._onUserSourcesChanged(sources, pausedSourceId);
     });
     recorder.on(import_recorder.RecorderEvent.ElementPicked, (elementInfo, userGesture) => {
-      this._onElementPicked(elementInfo, userGesture);
+      if (userGesture)
+        this._page.bringToFront();
+      this._frontend.elementPicked({ elementInfo, userGesture });
     });
     recorder.on(import_recorder.RecorderEvent.CallLogsUpdated, (callLogs) => {
-      this._onCallLogsUpdated(callLogs);
+      this._frontend.callLogsUpdated({ callLogs });
     });
   }
   _onActionAdded(action) {
@@ -251,29 +258,6 @@ class RecorderApp {
       lastAction.action.signals.push(signal.signal);
     this._updateActions();
   }
-  _onPageNavigated(url) {
-    this._page.mainFrame().evaluateExpression((({ url: url2 }) => {
-      window.playwrightSetPageURL(url2);
-    }).toString(), { isFunction: true }, { url }).catch(() => {
-    });
-  }
-  _onContextClosed() {
-    this._throttledOutputFile?.flush();
-    this._page.browserContext.close({ reason: "Recorder window closed" }).catch(() => {
-    });
-  }
-  _onModeChanged(mode) {
-    this._page.mainFrame().evaluateExpression(((mode2) => {
-      window.playwrightSetMode(mode2);
-    }).toString(), { isFunction: true }, mode).catch(() => {
-    });
-  }
-  _onPausedStateChanged(paused) {
-    this._page.mainFrame().evaluateExpression(((paused2) => {
-      window.playwrightSetPaused(paused2);
-    }).toString(), { isFunction: true }, paused).catch(() => {
-    });
-  }
   _onUserSourcesChanged(sources, pausedSourceId) {
     if (!sources.length && !this._userSources.length)
       return;
@@ -281,34 +265,14 @@ class RecorderApp {
     this._pushAllSources();
     this._revealSource(pausedSourceId);
   }
-  _onElementPicked(elementInfo, userGesture) {
-    if (userGesture)
-      this._page.bringToFront();
-    this._page.mainFrame().evaluateExpression(((param) => {
-      window.playwrightElementPicked(param.elementInfo, param.userGesture);
-    }).toString(), { isFunction: true }, { elementInfo, userGesture }).catch(() => {
-    });
-  }
-  _onCallLogsUpdated(callLogs) {
-    this._page.mainFrame().evaluateExpression(((callLogs2) => {
-      window.playwrightUpdateLogs(callLogs2);
-    }).toString(), { isFunction: true }, callLogs).catch(() => {
-    });
-  }
   _pushAllSources() {
     const sources = [...this._userSources, ...this._recorderSources];
-    this._page.mainFrame().evaluateExpression((({ sources: sources2 }) => {
-      window.playwrightSetSources(sources2);
-    }).toString(), { isFunction: true }, { sources }).catch(() => {
-    });
+    this._frontend.sourcesUpdated({ sources });
   }
   _revealSource(sourceId) {
     if (!sourceId)
       return;
-    this._page.mainFrame().evaluateExpression((({ sourceId: sourceId2 }) => {
-      window.playwrightSelectSource(sourceId2);
-    }).toString(), { isFunction: true }, { sourceId }).catch(() => {
-    });
+    this._frontend.sourceRevealRequested({ sourceId });
   }
   _updateActions(reveal) {
     const recorderSources = [];
@@ -372,6 +336,8 @@ class ProgrammaticRecorderApp {
     });
     recorder.on(import_recorder.RecorderEvent.SignalAdded, (signal) => {
       const page = findPageByGuid(inspectedContext, signal.frame.pageGuid);
+      if (!page)
+        return;
       inspectedContext.emit(import_browserContext.BrowserContext.Events.RecorderEvent, { event: "signalAdded", data: signal, page, code: "" });
     });
   }
@@ -379,6 +345,20 @@ class ProgrammaticRecorderApp {
 function findPageByGuid(context, guid) {
   return context.pages().find((p) => p.guid === guid);
 }
+function createRecorderFrontend(page) {
+  return new Proxy({}, {
+    get: (_target, prop) => {
+      if (typeof prop !== "string")
+        return void 0;
+      return (params) => {
+        page.mainFrame().evaluateExpression(((event) => {
+          window.dispatch(event);
+        }).toString(), { isFunction: true }, { method: prop, params }).catch(() => {
+        });
+      };
+    }
+  });
+}
 const recorderAppSymbol = Symbol("recorderApp");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/lib/server/recorder.js

@@ -41,6 +41,7 @@ var import_recorderUtils = require("./recorder/recorderUtils");
 var import_locatorParser = require("../utils/isomorphic/locatorParser");
 var import_selectorParser = require("../utils/isomorphic/selectorParser");
 var import_progress = require("./progress");
+var import_manualPromise = require("../utils/isomorphic/manualPromise");
 var import_recorderSignalProcessor = require("./recorder/recorderSignalProcessor");
 var rawRecorderSource = __toESM(require("./../generated/pollingRecorderSource"));
 var import_utils2 = require("./../utils");
@@ -144,8 +145,11 @@ class Recorder extends import_events.default {
             }
           }
         }
+        let mode = this._mode;
+        if (this._pickLocatorPage && source.page !== this._pickLocatorPage)
+          mode = "none";
         const uiState = {
-          mode: this._mode,
+          mode,
           actionPoint,
           actionSelector,
           ariaTemplate: this._highlightedElement.ariaTemplate,
@@ -162,7 +166,7 @@ class Recorder extends import_events.default {
       await this._context.exposeBinding(progress, "__pw_recorderSetMode", false, async ({ frame }, mode) => {
         if (frame.parentFrame())
           return;
-        this.setMode(mode);
+        await this.setMode(mode);
       });
       await this._context.exposeBinding(progress, "__pw_recorderSetOverlayState", false, async ({ frame }, state) => {
         if (frame.parentFrame())
@@ -170,7 +174,7 @@ class Recorder extends import_events.default {
         this._overlayState = state;
       });
       await this._context.exposeBinding(progress, "__pw_resume", false, () => {
-        this._debugger.resume(false);
+        this._debugger.resume();
       });
       this._context.on(import_browserContext.BrowserContext.Events.Page, (page) => this._onPage(page));
       for (const page of this._context.pages())
@@ -191,17 +195,16 @@ class Recorder extends import_events.default {
         false,
         (source, action) => this._recordAction(source.frame, action)
       );
-      await this._context.extendInjectedScript(rawRecorderSource.source, { recorderMode: this._recorderMode });
+      await this._context.extendInjectedScript(rawRecorderSource.source, { recorderMode: this._recorderMode, hideToolbar: !!this._params.hideToolbar });
     });
     if (this._debugger.isPaused())
       this._pausedStateChanged();
     this._debugger.on(import_debugger.Debugger.Events.PausedStateChanged, () => this._pausedStateChanged());
   }
   _pausedStateChanged() {
-    for (const { metadata, sdkObject } of this._debugger.pausedDetails()) {
-      if (!this._currentCallsMetadata.has(metadata))
-        this.onBeforeCall(sdkObject, metadata);
-    }
+    const pausedDetails = this._debugger.pausedDetails();
+    if (pausedDetails && !this._currentCallsMetadata.has(pausedDetails.metadata))
+      this.onBeforeCall(pausedDetails.sdkObject, pausedDetails.metadata);
     this.emit(RecorderEvent.PausedStateChanged, this._debugger.isPaused());
     this._updateUserSources();
     this.updateCallLog([...this._currentCallsMetadata.keys()]);
@@ -209,7 +212,7 @@ class Recorder extends import_events.default {
   mode() {
     return this._mode;
   }
-  setMode(mode) {
+  async setMode(mode) {
     if (this._mode === mode)
       return;
     this._highlightedElement = {};
@@ -217,54 +220,91 @@ class Recorder extends import_events.default {
     this.emit(RecorderEvent.ModeChanged, this._mode);
     this._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") {
+      let pageToFocus = this._pickLocatorPage;
+      if (!pageToFocus && this._context.pages().length === 1)
+        pageToFocus = this._context.pages()[0];
+      pageToFocus?.bringToFront().catch(() => {
       });
-    this._refreshOverlay();
+    }
+    await this._refreshOverlay();
+  }
+  async pickLocator(progress, page) {
+    if (this._mode !== "none")
+      await this.setMode("none");
+    const selectorPromise = new import_manualPromise.ManualPromise();
+    let recorderChangedState = false;
+    const onElementPicked = (elementInfo) => {
+      selectorPromise.resolve(elementInfo.selector);
+    };
+    const onModeChanged = () => {
+      if (this._mode === "inspecting")
+        return;
+      recorderChangedState = true;
+      selectorPromise.reject(new Error("Locator picking was cancelled"));
+    };
+    const listeners = [
+      import_utils2.eventsHelper.addEventListener(this, RecorderEvent.ElementPicked, onElementPicked),
+      import_utils2.eventsHelper.addEventListener(this, RecorderEvent.ModeChanged, onModeChanged)
+    ];
+    try {
+      const doPickLocator = async () => {
+        selectorPromise.catch(() => {
+        });
+        this._pickLocatorPage = page;
+        await this.setMode("inspecting");
+        return await selectorPromise;
+      };
+      return await progress.race(doPickLocator());
+    } finally {
+      import_utils2.eventsHelper.removeEventListeners(listeners);
+      this._pickLocatorPage = void 0;
+      if (!recorderChangedState)
+        await this.setMode("none");
+    }
   }
   url() {
     const page = this._context.pages()[0];
     return page?.mainFrame().url();
   }
-  setHighlightedSelector(selector) {
+  async setHighlightedSelector(selector) {
     this._highlightedElement = { selector: (0, import_locatorParser.locatorOrSelectorAsSelector)(this._currentLanguage, selector, this._context.selectors().testIdAttributeName()) };
-    this._refreshOverlay();
+    await this._refreshOverlay();
   }
-  setHighlightedAriaTemplate(ariaTemplate) {
+  async setHighlightedAriaTemplate(ariaTemplate) {
     this._highlightedElement = { ariaTemplate };
-    this._refreshOverlay();
+    await this._refreshOverlay();
   }
   step() {
-    this._debugger.resume(true);
+    this._debugger.setPauseAt({ next: true });
+    this._debugger.resume();
   }
-  setLanguage(language) {
+  async setLanguage(language) {
     this._currentLanguage = language;
-    this._refreshOverlay();
+    await this._refreshOverlay();
   }
   resume() {
-    this._debugger.resume(false);
+    this._debugger.resume();
   }
   pause() {
-    this._debugger.pauseOnNextStatement();
+    this._debugger.setPauseAt({ next: true });
   }
   paused() {
     return this._debugger.isPaused();
   }
   close() {
-    this._debugger.resume(false);
+    this._debugger.resume();
   }
-  hideHighlightedSelector() {
+  async hideHighlightedSelector() {
     this._highlightedElement = {};
-    this._refreshOverlay();
+    await this._refreshOverlay();
   }
   pausedSourceId() {
-    for (const { metadata } of this._debugger.pausedDetails()) {
-      if (!metadata.location)
-        continue;
-      const source = this._userSources.get(metadata.location.file);
-      if (!source)
-        continue;
-      return source.id;
+    const pausedDetails = this._debugger.pausedDetails();
+    if (pausedDetails?.metadata.location) {
+      const source = this._userSources.get(pausedDetails.metadata.location.file);
+      if (source)
+        return source.id;
     }
   }
   userSources() {
@@ -290,12 +330,10 @@ class Recorder extends import_events.default {
       return "";
     }
   }
-  _refreshOverlay() {
-    for (const page of this._context.pages()) {
-      for (const frame of page.frames())
-        frame.evaluateExpression("window.__pw_refreshOverlay()").catch(() => {
-        });
-    }
+  async _refreshOverlay() {
+    await Promise.all(this._context.pages().map(
+      (page) => page.safeNonStallingEvaluateInAllFrames("window.__pw_refreshOverlay()", "main")
+    ));
   }
   async onBeforeCall(sdkObject, metadata) {
     if (this._omitCallTracking || this._isRecording())
@@ -338,8 +376,6 @@ class Recorder extends import_events.default {
     }
     this.emit(RecorderEvent.UserSourcesChanged, this.userSources(), this.pausedSourceId());
   }
-  async onBeforeInputAction(sdkObject, metadata) {
-  }
   async onCallLog(sdkObject, metadata, logName, message) {
     this.updateCallLog([metadata]);
   }
@@ -388,7 +424,7 @@ class Recorder extends import_events.default {
       this._filePrimaryURLChanged();
     });
     frame.on(import_frames.Frame.Events.InternalNavigation, (event) => {
-      if (event.isPublic) {
+      if (event.isPublic && !event.error) {
         this._onFrameNavigated(frame, page);
         this._filePrimaryURLChanged();
       }

package/lib/server/registry/browserFetcher.js

@@ -42,10 +42,13 @@ var import_userAgent = require("../utils/userAgent");
 var import_utilsBundle = require("../../utilsBundle");
 var import_fileUtils = require("../utils/fileUtils");
 var import__ = require(".");
-async function downloadBrowserWithProgressBar(title, browserDirectory, executablePath, downloadURLs, downloadFileName, downloadSocketTimeout) {
+async function downloadBrowserWithProgressBar(title, browserDirectory, executablePath, downloadURLs, downloadFileName, downloadSocketTimeout, force) {
   if (await (0, import_fileUtils.existsAsync)((0, import__.browserDirectoryToMarkerFilePath)(browserDirectory))) {
     import_debugLogger.debugLogger.log("install", `${title} is already downloaded.`);
-    return false;
+    if (force)
+      import_debugLogger.debugLogger.log("install", `force-downloading ${title}.`);
+    else
+      return;
   }
   const uniqueTempDir = await import_fs.default.promises.mkdtemp(import_path.default.join(import_os.default.tmpdir(), "playwright-download-"));
   const zipPath = import_path.default.join(uniqueTempDir, downloadFileName);
@@ -63,7 +66,7 @@ async function downloadBrowserWithProgressBar(title, browserDirectory, executabl
       if (await (0, import_fileUtils.existsAsync)(zipPath))
         await import_fs.default.promises.unlink(zipPath);
       if (await (0, import_fileUtils.existsAsync)(browserDirectory))
-        await import_fs.default.promises.rmdir(browserDirectory, { recursive: true });
+        await (0, import_fileUtils.removeFolders)([browserDirectory]);
       const errorMessage = error?.message || "";
       import_debugLogger.debugLogger.log("install", `attempt #${attempt} - ERROR: ${errorMessage}`);
       if (attempt >= retryCount)
@@ -77,7 +80,6 @@ async function downloadBrowserWithProgressBar(title, browserDirectory, executabl
     await (0, import_fileUtils.removeFolders)([uniqueTempDir]);
   }
   logPolitely(`${title} downloaded to ${browserDirectory}`);
-  return true;
 }
 function downloadBrowserWithProgressBarOutOfProcess(title, browserDirectory, url, zipPath, executablePath, socketTimeout) {
   const cp = childProcess.fork(import_path.default.join(__dirname, "oopDownloadBrowserMain.js"));