patchright-core 1.52.4 → 1.55.0

package/lib/server/screenshotter.js

@@ -130,11 +130,10 @@ class Screenshotter {
     this._queue = new TaskQueue();
   }
   async _originalViewportSize(progress) {
-    const originalViewportSize = this._page.viewportSize();
-    let viewportSize = originalViewportSize;
+    let viewportSize = this._page.emulatedSize()?.viewport;
     if (!viewportSize)
       viewportSize = await this._page.mainFrame().waitForFunctionValueInUtility(progress, () => ({ width: window.innerWidth, height: window.innerHeight }));
-    return { viewportSize, originalViewportSize };
+    return viewportSize;
   }
   async _fullPageSize(progress) {
     const fullPageSize = await this._page.mainFrame().waitForFunctionValueInUtility(progress, () => {
@@ -165,116 +164,118 @@ class Screenshotter {
     const format = validateScreenshotOptions(options);
     return this._queue.postTask(async () => {
       progress.log("taking page screenshot");
-      const { viewportSize } = await this._originalViewportSize(progress);
+      const viewportSize = await this._originalViewportSize(progress);
       await this._preparePageForScreenshot(progress, this._page.mainFrame(), options.style, options.caret !== "initial", options.animations === "disabled");
-      progress.throwIfAborted();
-      if (options.fullPage) {
-        const fullPageSize = await this._fullPageSize(progress);
-        let documentRect = { x: 0, y: 0, width: fullPageSize.width, height: fullPageSize.height };
-        const fitsViewport = fullPageSize.width <= viewportSize.width && fullPageSize.height <= viewportSize.height;
-        if (options.clip)
-          documentRect = trimClipToSize(options.clip, documentRect);
-        const buffer2 = await this._screenshot(progress, format, documentRect, void 0, fitsViewport, options);
-        progress.throwIfAborted();
+      try {
+        if (options.fullPage) {
+          const fullPageSize = await this._fullPageSize(progress);
+          let documentRect = { x: 0, y: 0, width: fullPageSize.width, height: fullPageSize.height };
+          const fitsViewport = fullPageSize.width <= viewportSize.width && fullPageSize.height <= viewportSize.height;
+          if (options.clip)
+            documentRect = trimClipToSize(options.clip, documentRect);
+          return await this._screenshot(progress, format, documentRect, void 0, fitsViewport, options);
+        }
+        const viewportRect = options.clip ? trimClipToSize(options.clip, viewportSize) : { x: 0, y: 0, ...viewportSize };
+        return await this._screenshot(progress, format, void 0, viewportRect, true, options);
+      } finally {
         await this._restorePageAfterScreenshot();
-        return buffer2;
       }
-      const viewportRect = options.clip ? trimClipToSize(options.clip, viewportSize) : { x: 0, y: 0, ...viewportSize };
-      const buffer = await this._screenshot(progress, format, void 0, viewportRect, true, options);
-      progress.throwIfAborted();
-      await this._restorePageAfterScreenshot();
-      return buffer;
     });
   }
   async screenshotElement(progress, handle, options) {
     const format = validateScreenshotOptions(options);
     return this._queue.postTask(async () => {
       progress.log("taking element screenshot");
-      const { viewportSize } = await this._originalViewportSize(progress);
+      const viewportSize = await this._originalViewportSize(progress);
       await this._preparePageForScreenshot(progress, handle._frame, options.style, options.caret !== "initial", options.animations === "disabled");
-      progress.throwIfAborted();
-      await handle._waitAndScrollIntoViewIfNeeded(
-        progress,
-        true
-        /* waitForVisible */
-      );
-      progress.throwIfAborted();
-      const boundingBox = await handle.boundingBox();
-      (0, import_utils.assert)(boundingBox, "Node is either not visible or not an HTMLElement");
-      (0, import_utils.assert)(boundingBox.width !== 0, "Node has 0 width.");
-      (0, import_utils.assert)(boundingBox.height !== 0, "Node has 0 height.");
-      const fitsViewport = boundingBox.width <= viewportSize.width && boundingBox.height <= viewportSize.height;
-      progress.throwIfAborted();
-      const scrollOffset = await this._page.mainFrame().waitForFunctionValueInUtility(progress, () => ({ x: window.scrollX, y: window.scrollY }));
-      const documentRect = { ...boundingBox };
-      documentRect.x += scrollOffset.x;
-      documentRect.y += scrollOffset.y;
-      const buffer = await this._screenshot(progress, format, import_helper.helper.enclosingIntRect(documentRect), void 0, fitsViewport, options);
-      progress.throwIfAborted();
-      await this._restorePageAfterScreenshot();
-      return buffer;
+      try {
+        await handle._waitAndScrollIntoViewIfNeeded(
+          progress,
+          true
+          /* waitForVisible */
+        );
+        const boundingBox = await progress.race(handle.boundingBox());
+        (0, import_utils.assert)(boundingBox, "Node is either not visible or not an HTMLElement");
+        (0, import_utils.assert)(boundingBox.width !== 0, "Node has 0 width.");
+        (0, import_utils.assert)(boundingBox.height !== 0, "Node has 0 height.");
+        const fitsViewport = boundingBox.width <= viewportSize.width && boundingBox.height <= viewportSize.height;
+        const scrollOffset = await this._page.mainFrame().waitForFunctionValueInUtility(progress, () => ({ x: window.scrollX, y: window.scrollY }));
+        const documentRect = { ...boundingBox };
+        documentRect.x += scrollOffset.x;
+        documentRect.y += scrollOffset.y;
+        return await this._screenshot(progress, format, import_helper.helper.enclosingIntRect(documentRect), void 0, fitsViewport, options);
+      } finally {
+        await this._restorePageAfterScreenshot();
+      }
     });
   }
   async _preparePageForScreenshot(progress, frame, screenshotStyle, hideCaret, disableAnimations) {
     if (disableAnimations)
       progress.log("  disabled all CSS animations");
-    const syncAnimations = this._page._delegate.shouldToggleStyleSheetToSyncAnimations();
-    await this._page.safeNonStallingEvaluateInAllFrames("(" + inPagePrepareForScreenshots.toString() + `)(${JSON.stringify(screenshotStyle)}, ${hideCaret}, ${disableAnimations}, ${syncAnimations})`, "utility");
-    if (!process.env.PW_TEST_SCREENSHOT_NO_FONTS_READY) {
-      progress.log("waiting for fonts to load...");
-      await frame.nonStallingEvaluateInExistingContext("document.fonts.ready", "utility").catch(() => {
-      });
-      progress.log("fonts loaded");
+    const syncAnimations = this._page.delegate.shouldToggleStyleSheetToSyncAnimations();
+    await progress.race(this._page.safeNonStallingEvaluateInAllFrames("(" + inPagePrepareForScreenshots.toString() + `)(${JSON.stringify(screenshotStyle)}, ${hideCaret}, ${disableAnimations}, ${syncAnimations})`, "utility"));
+    try {
+      if (!process.env.PW_TEST_SCREENSHOT_NO_FONTS_READY) {
+        progress.log("waiting for fonts to load...");
+        await progress.race(frame.nonStallingEvaluateInExistingContext("document.fonts.ready", "utility").catch(() => {
+        }));
+        progress.log("fonts loaded");
+      }
+    } catch (error) {
+      await this._restorePageAfterScreenshot();
+      throw error;
     }
-    progress.cleanupWhenAborted(() => this._restorePageAfterScreenshot());
   }
   async _restorePageAfterScreenshot() {
     await this._page.safeNonStallingEvaluateInAllFrames("window.__pwCleanupScreenshot && window.__pwCleanupScreenshot()", "utility");
   }
   async _maskElements(progress, options) {
-    const framesToParsedSelectors = new import_multimap.MultiMap();
-    const cleanup = async () => {
-      await Promise.all([...framesToParsedSelectors.keys()].map(async (frame) => {
-        await frame.hideHighlight();
-      }));
-    };
     if (!options.mask || !options.mask.length)
-      return cleanup;
-    await Promise.all((options.mask || []).map(async ({ frame, selector }) => {
+      return () => Promise.resolve();
+    const framesToParsedSelectors = new import_multimap.MultiMap();
+    await progress.race(Promise.all((options.mask || []).map(async ({ frame, selector }) => {
       const pair = await frame.selectors.resolveFrameForSelector(selector);
       if (pair)
         framesToParsedSelectors.set(pair.frame, pair.info.parsed);
-    }));
-    progress.throwIfAborted();
-    await Promise.all([...framesToParsedSelectors.keys()].map(async (frame) => {
-      await frame.maskSelectors(framesToParsedSelectors.get(frame), options.maskColor || "#F0F");
-    }));
-    progress.cleanupWhenAborted(cleanup);
-    return cleanup;
+    })));
+    const frames = [...framesToParsedSelectors.keys()];
+    const cleanup = async () => {
+      await Promise.all(frames.map((frame) => frame.hideHighlight()));
+    };
+    try {
+      const promises = frames.map((frame) => frame.maskSelectors(framesToParsedSelectors.get(frame), options.maskColor || "#F0F"));
+      await progress.race(Promise.all(promises));
+      return cleanup;
+    } catch (error) {
+      cleanup().catch(() => {
+      });
+      throw error;
+    }
   }
   async _screenshot(progress, format, documentRect, viewportRect, fitsViewport, options) {
     if (options.__testHookBeforeScreenshot)
-      await options.__testHookBeforeScreenshot();
-    progress.throwIfAborted();
+      await progress.race(options.__testHookBeforeScreenshot());
     const shouldSetDefaultBackground = options.omitBackground && format === "png";
-    if (shouldSetDefaultBackground) {
-      await this._page._delegate.setBackgroundColor({ r: 0, g: 0, b: 0, a: 0 });
-      progress.cleanupWhenAborted(() => this._page._delegate.setBackgroundColor());
-    }
-    progress.throwIfAborted();
-    const cleanupHighlight = await this._maskElements(progress, options);
-    progress.throwIfAborted();
-    const quality = format === "jpeg" ? options.quality ?? 80 : void 0;
-    const buffer = await this._page._delegate.takeScreenshot(progress, format, documentRect, viewportRect, quality, fitsViewport, options.scale || "device");
-    progress.throwIfAborted();
-    await cleanupHighlight();
-    progress.throwIfAborted();
     if (shouldSetDefaultBackground)
-      await this._page._delegate.setBackgroundColor();
-    progress.throwIfAborted();
-    if (options.__testHookAfterScreenshot)
-      await options.__testHookAfterScreenshot();
-    return buffer;
+      await progress.race(this._page.delegate.setBackgroundColor({ r: 0, g: 0, b: 0, a: 0 }));
+    const cleanupHighlight = await this._maskElements(progress, options);
+    try {
+      const quality = format === "jpeg" ? options.quality ?? 80 : void 0;
+      const buffer = await this._page.delegate.takeScreenshot(progress, format, documentRect, viewportRect, quality, fitsViewport, options.scale || "device");
+      await cleanupHighlight();
+      if (shouldSetDefaultBackground)
+        await this._page.delegate.setBackgroundColor();
+      if (options.__testHookAfterScreenshot)
+        await progress.race(options.__testHookAfterScreenshot());
+      return buffer;
+    } catch (error) {
+      cleanupHighlight().catch(() => {
+      });
+      if (shouldSetDefaultBackground)
+        this._page.delegate.setBackgroundColor().catch(() => {
+        });
+      throw error;
+    }
   }
 }
 class TaskQueue {

package/lib/server/selectors.js

@@ -24,9 +24,8 @@ module.exports = __toCommonJS(selectors_exports);
 var import_crypto = require("./utils/crypto");
 var import_selectorParser = require("../utils/isomorphic/selectorParser");
 class Selectors {
-  constructor() {
+  constructor(engines, testIdAttributeName) {
     this.guid = `selectors@${(0, import_crypto.createGuid)()}`;
-    this._testIdAttributeName = "data-testid";
     this._builtinEngines = /* @__PURE__ */ new Set([
       "css",
       "css:light",
@@ -60,6 +59,7 @@ class Selectors {
       "internal:text",
       "internal:role",
       "internal:testid",
+      "internal:describe",
       "aria-ref"
     ]);
     this._builtinEnginesInMainWorld = /* @__PURE__ */ new Set([
@@ -67,15 +67,18 @@ class Selectors {
       "_vue"
     ]);
     this._engines = /* @__PURE__ */ new Map();
+    this._testIdAttributeName = testIdAttributeName ?? "data-testid";
+    for (const engine of engines)
+      this.register(engine);
   }
-  async register(name, source, contentScript = false) {
-    if (!name.match(/^[a-zA-Z_0-9-]+$/))
+  register(engine) {
+    if (!engine.name.match(/^[a-zA-Z_0-9-]+$/))
       throw new Error("Selector engine name may only contain [a-zA-Z0-9_] characters");
-    if (this._builtinEngines.has(name) || name === "zs" || name === "zs:light")
-      throw new Error(`"${name}" is a predefined selector engine`);
-    if (this._engines.has(name))
-      throw new Error(`"${name}" selector engine has been already registered`);
-    this._engines.set(name, { source, contentScript });
+    if (this._builtinEngines.has(engine.name) || engine.name === "zs" || engine.name === "zs:light")
+      throw new Error(`"${engine.name}" is a predefined selector engine`);
+    if (this._engines.has(engine.name))
+      throw new Error(`"${engine.name}" selector engine has been already registered`);
+    this._engines.set(engine.name, engine);
   }
   testIdAttributeName() {
     return this._testIdAttributeName;
@@ -83,9 +86,6 @@ class Selectors {
   setTestIdAttributeName(testIdAttributeName) {
     this._testIdAttributeName = testIdAttributeName;
   }
-  unregisterAll() {
-    this._engines.clear();
-  }
   parseSelector(selector, strict) {
     const parsed = typeof selector === "string" ? (0, import_selectorParser.parseSelector)(selector) : selector;
     let needsMainWorld = false;