@empiricalrun/playwright-utils 0.19.32 → 0.19.33

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @empiricalrun/playwright-utils
 
+## 0.19.33
+
+### Patch Changes
+
+- 7b19602: feat: use overlay text content to improve overlay dismissal accuracy
+- b6d1326: fix: z-index scaling for better overlay dismissals
+- Updated dependencies [7b19602]
+- Updated dependencies [b6d1326]
+- Updated dependencies [f462463]
+  - @empiricalrun/test-gen@0.42.21
+
 ## 0.19.32
 
 ### Patch Changes

package/dist/test/scripts/pw-locator-patch/highlight/click.d.ts

@@ -1,9 +1,11 @@
 import type { Locator } from "@playwright/test";
-export declare function extractInterceptingElement(errorMessage: string): {
+type OverlayElement = {
     interceptor: string;
     parent: string | undefined;
-} | undefined;
+};
+export declare function extractInterceptingElement(errorMessage: string): OverlayElement | undefined;
 export declare function patchClick(LocatorClass: Function & {
     prototype: Locator;
 }): void;
+export {};
 //# sourceMappingURL=click.d.ts.map

package/dist/test/scripts/pw-locator-patch/highlight/click.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"click.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/highlight/click.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAQ,MAAM,kBAAkB,CAAC;AA6BtD,wBAAgB,0BAA0B,CAAC,YAAY,EAAE,MAAM,GAC3D;IACE,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,GACD,SAAS,CAiCZ;AAmDD,wBAAgB,UAAU,CAAC,YAAY,EAAE,QAAQ,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAwCzE"}
+{"version":3,"file":"click.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/highlight/click.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAQ,MAAM,kBAAkB,CAAC;AA6BtD,KAAK,cAAc,GAAG;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,MAAM,GACnB,cAAc,GAAG,SAAS,CAiC5B;AAwGD,wBAAgB,UAAU,CAAC,YAAY,EAAE,QAAQ,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QA2CzE"}

package/dist/test/scripts/pw-locator-patch/highlight/click.js

@@ -63,27 +63,71 @@ function extractInterceptingElement(errorMessage) {
     }
 }
 exports.extractInterceptingElement = extractInterceptingElement;
-function overlayElementInfo(errorMessage) {
-    try {
-        const elements = extractInterceptingElement(errorMessage);
-        if (elements) {
-            const { interceptor, parent } = elements;
-            if (parent) {
-                return `${interceptor} inside ${parent}`;
-            }
-            else {
-                return `${interceptor}`;
-            }
+function description(element) {
+    if (element) {
+        const { interceptor, parent } = element;
+        if (parent) {
+            return `${interceptor} inside ${parent}`;
+        }
+        else {
+            return `${interceptor}`;
         }
     }
-    catch (e) {
-        // Ignoring errors on this for now, since we're only using element
-        // info for logging.
+}
+async function textContent(pageRef, element) {
+    if (element) {
+        const { interceptor, parent } = element;
+        let startTag = parent ? parent : interceptor;
+        let endTag;
+        const match = startTag.match(/^<\s*([^\s>]+)/);
+        if (match) {
+            const tagName = match[1]; // "div"
+            endTag = `</${tagName}>`;
+        }
+        if (!startTag || !endTag) {
+            return undefined;
+        }
+        return await pageRef.evaluate((tags) => {
+            const [startTag, endTag] = tags;
+            const htmlString = `${startTag}temp${endTag}`;
+            const parser = new DOMParser();
+            const doc = parser.parseFromString(htmlString, "text/html");
+            const tempEl = doc.body.firstElementChild;
+            let selector = tempEl.tagName.toLowerCase(); // start with the tag name, e.g., 'div'
+            // If there's an id, add it (id is unique and very specific)
+            if (tempEl.id) {
+                selector += `#${tempEl.id}`;
+            }
+            // Add all classes (if any)
+            if (tempEl.classList.length > 0) {
+                tempEl.classList.forEach((cls) => {
+                    selector += `.${cls}`;
+                });
+            }
+            // Add any other attributes that might help narrow it down.
+            // (Skip 'id' and 'class' because they are already included.)
+            Array.from(tempEl.attributes).forEach((attr) => {
+                if (attr.name === "id" || attr.name === "class")
+                    return;
+                // Note: if attribute values contain special characters, consider escaping them.
+                selector += `[${attr.name}="${attr.value}"]`;
+            });
+            const realElement = document.querySelector(selector);
+            return realElement?.textContent?.trim();
+        }, [startTag, endTag]);
     }
 }
-async function runAgentOnOverlay(pageRef) {
+async function runAgentOnOverlay(pageRef, element) {
+    const content = await textContent(pageRef, element);
+    const promptAddition = content
+        ? `
+The popup can be identified with its text content:
+${content}`
+        : ``;
     const plannerResp = await (0, planner_1.runtimePlannerWithScreenshot)({
-        task: "Find a way to dismiss the popup. If the popup is non dismissible or there is no popup then return immediately. Also note that you just need to dismiss popup and do nothing else.",
+        task: `
+Find a way to dismiss the popup. If the popup is non dismissible or there is no popup then return immediately.
+Also note that you just need to dismiss popup and do nothing else.`,
         conversation: [],
         page: pageRef,
     });
@@ -91,7 +135,12 @@ async function runAgentOnOverlay(pageRef) {
         throw new Error("No active popup found");
     }
     await (0, run_1.createTestUsingMasterAgent)({
-        task: "Find a way to dismiss the popup. If the popup is non dismissible or there is no popup then return immediately. Also note that you just need to dismiss popup and do nothing else.",
+        task: `
+Find a way to dismiss the popup. If the popup is non dismissible or there is no popup then return immediately.
+Also note that you just need to dismiss popup and do nothing else.
+
+${promptAddition}
+`,
         page: pageRef,
         options: {
             useActionSpecificAnnotations: true,
@@ -106,10 +155,6 @@ function annotateForReport(description) {
         description,
     });
 }
-function isSurvicateOverlay(errorMessage) {
-    const element = overlayElementInfo(errorMessage);
-    return element?.includes("survicate");
-}
 function patchClick(LocatorClass) {
     // Check if already patched
     if (isClickPatched.get(LocatorClass)) {
@@ -129,15 +174,16 @@ function patchClick(LocatorClass) {
             if (!originalError.message?.includes(ERROR_SUBSTRING_INTERCEPTION)) {
                 throw originalError;
             }
-            annotateForReport(`Attempting to auto-dismiss overlay ${overlayElementInfo(originalError.message)}`);
+            let overlayElement = undefined;
+            try {
+                overlayElement = extractInterceptingElement(originalError.message);
+            }
+            catch (err) {
+                // Ignoring this error
+            }
+            annotateForReport(`Attempting to auto-dismiss overlay: ${description(overlayElement)}`);
             try {
-                if (isSurvicateOverlay(originalError.message)) {
-                    // TODO: Survicate specific handling that bypasses the agent; this is temporary!
-                    await this._frame._page.getByLabel("Close the survey").click();
-                }
-                else {
-                    await runAgentOnOverlay(this._frame._page);
-                }
+                await runAgentOnOverlay(this._frame._page, overlayElement);
             }
             catch (agentError) {
                 annotateForReport(`Error in overlay dismiss: ${agentError.toString()}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.19.32",
+  "version": "0.19.33",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -44,7 +44,7 @@
     "rimraf": "^6.0.1",
     "@empiricalrun/llm": "^0.9.32",
     "@empiricalrun/r2-uploader": "^0.3.8",
-    "@empiricalrun/test-gen": "^0.42.20"
+    "@empiricalrun/test-gen": "^0.42.21"
   },
   "scripts": {
     "dev": "tsc --build --watch",