@empiricalrun/playwright-utils 0.25.23 → 0.25.24

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/playwright-utils
 
+## 0.25.24
+
+### Patch Changes
+
+- e5430e4: fix: cache overlay actions only if original action passes
+
 ## 0.25.23
 
 ### Patch Changes

package/dist/test/scripts/pw-locator-patch/dismiss-overlays/cache.js

@@ -63,7 +63,7 @@ async function executeFromCache({ page, dom, text, }) {
             return { success: false };
         }
         try {
-            console.log(`Executing "${match.code}" for element: ${dom}`);
+            console.log(`Executing from cache: "${match.code}" for element: ${dom}`);
             // Ref: https://davidwalsh.name/async-function-class
             const AsyncFunction = Object.getPrototypeOf(async function () { }).constructor;
             const exec = new AsyncFunction("page", match.code);

package/dist/test/scripts/pw-locator-patch/dismiss-overlays/index.d.ts

@@ -1,6 +1,13 @@
 import { Page } from "@playwright/test";
 import { OverlayElement } from "./types";
 export declare function isErrorSupported(errorMessage: string | undefined): boolean;
+export declare class OverlayDismissAgent {
+    private readonly page;
+    private cachingCandidates;
+    constructor(page: Page);
+    saveToCache(): Promise<void>;
+    run(originalError: any, reporter: (description: string) => void): Promise<void>;
+    private runAgent;
+}
 export declare function extractInterceptingElement(errorMessage: string): OverlayElement | undefined;
-export declare function attemptToDismissOverlay(originalError: any, page: Page, reporter: (description: string) => void): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/dist/test/scripts/pw-locator-patch/dismiss-overlays/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/dismiss-overlays/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAIxC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAOzC,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,WAKhE;AA8DD,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,MAAM,GACnB,cAAc,GAAG,SAAS,CAiC5B;AAwBD,wBAAsB,uBAAuB,CAC3C,aAAa,EAAE,GAAG,EAClB,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,GACtC,OAAO,CAAC,IAAI,CAAC,CAiBf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/dismiss-overlays/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAIxC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAOzC,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,WAKhE;AAED,qBAAa,mBAAmB;IAOlB,OAAO,CAAC,QAAQ,CAAC,IAAI;IANjC,OAAO,CAAC,iBAAiB,CAIhB;gBAEoB,IAAI,EAAE,IAAI;IAEjC,WAAW;IAMX,GAAG,CACP,aAAa,EAAE,GAAG,EAClB,QAAQ,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,GACtC,OAAO,CAAC,IAAI,CAAC;YA4BF,QAAQ;CAgCvB;AAED,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,MAAM,GACnB,cAAc,GAAG,SAAS,CAiC5B"}

package/dist/test/scripts/pw-locator-patch/dismiss-overlays/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.attemptToDismissOverlay = exports.extractInterceptingElement = exports.isErrorSupported = void 0;
-const llm_1 = require("@empiricalrun/llm");
+exports.extractInterceptingElement = exports.OverlayDismissAgent = exports.isErrorSupported = void 0;
 const run_1 = require("@empiricalrun/test-gen/agent/master/run");
 const cache_1 = require("./cache");
 const prompt_1 = require("./prompt");
@@ -15,62 +14,76 @@ function isErrorSupported(errorMessage) {
     return errorMessage.includes(ERROR_SUBSTRING_INTERCEPTION);
 }
 exports.isErrorSupported = isErrorSupported;
-function traceThis(task) {
-    const metadata = {
-        projectName: process.env.PROJECT_NAME ?? "",
-        testRunId: process.env.TEST_RUN_GITHUB_ACTION_ID ?? "",
-    };
-    const trace = (0, llm_1.createLangfuseTrace)({
-        name: "overlay_dismiss",
-        input: task,
-        tags: ["overlay_dismiss"],
-        metadata,
-    });
-    if (trace) {
-        const traceUrl = trace.getTraceUrl();
-        console.log(`Starting computer use agent: ${traceUrl}`);
-    }
-    return trace;
-}
-async function runAgentOnOverlay(pageRef, element) {
-    const text = await (0, utils_1.textContent)(pageRef, element);
-    const task = await (0, prompt_1.getTask)(pageRef, element, text);
-    const { success } = await (0, cache_1.executeFromCache)({
-        page: pageRef,
-        dom: element?.interceptor,
-        text,
-    });
-    if (success) {
-        return;
-    }
-    let generatedCode;
-    if (PREFERRED_AGENT === "inhouse-master") {
-        const result = await (0, run_1.createTestUsingMasterAgent)({
-            task,
-            page: pageRef,
-            options: {
-                useActionSpecificAnnotations: true,
-            },
-        });
-        generatedCode = result.code;
-    }
-    else if (PREFERRED_AGENT === "openai-cua") {
-        const trace = traceThis(task);
-        const result = await (0, run_1.createTestUsingComputerUseAgent)({
-            page: pageRef,
-            task,
-            trace,
-        });
-        generatedCode = result.code;
-    }
-    if (generatedCode) {
-        await (0, cache_1.setCodeToCache)({
-            dom: element?.interceptor,
-            text,
-            code: generatedCode,
-        });
+class OverlayDismissAgent {
+    page;
+    cachingCandidates = [];
+    constructor(page) {
+        this.page = page;
+    }
+    async saveToCache() {
+        for (const candidate of this.cachingCandidates) {
+            await (0, cache_1.setCodeToCache)(candidate);
+        }
+    }
+    async run(originalError, reporter) {
+        let element;
+        try {
+            element = extractInterceptingElement(originalError.message);
+        }
+        catch (err) {
+            // Ignoring this error
+        }
+        const description = (0, utils_1.overlayDescription)(element);
+        reporter(`Attempting to auto-dismiss overlay: ${description}`);
+        try {
+            const text = await (0, utils_1.textContent)(this.page, element);
+            const { success } = await (0, cache_1.executeFromCache)({
+                page: this.page,
+                dom: element?.interceptor,
+                text,
+            });
+            if (success) {
+                return;
+            }
+            await this.runAgent(element, text);
+        }
+        catch (agentError) {
+            reporter(`Error during overlay dismissal agent execution: ${agentError.toString()}`);
+            throw originalError;
+        }
+    }
+    async runAgent(element, text) {
+        const task = await (0, prompt_1.getTask)(this.page, element, text);
+        if (PREFERRED_AGENT === "inhouse-master") {
+            const result = await (0, run_1.createTestUsingMasterAgent)({
+                task,
+                page: this.page,
+                options: {
+                    useActionSpecificAnnotations: true,
+                },
+            });
+            this.cachingCandidates.push({
+                dom: element?.interceptor,
+                text,
+                code: result.code,
+            });
+        }
+        else if (PREFERRED_AGENT === "openai-cua") {
+            const trace = (0, utils_1.traceThis)(task);
+            const result = await (0, run_1.createTestUsingComputerUseAgent)({
+                page: this.page,
+                task,
+                trace,
+            });
+            this.cachingCandidates.push({
+                dom: element?.interceptor,
+                text,
+                code: result.code,
+            });
+        }
     }
 }
+exports.OverlayDismissAgent = OverlayDismissAgent;
 function extractInterceptingElement(errorMessage) {
     // This extract element and parent info from interception error message
     // Note that error message from the last retry is returned.
@@ -128,22 +141,3 @@ function findAllMatches(str, regex) {
     }
     return matches;
 }
-async function attemptToDismissOverlay(originalError, page, reporter) {
-    let overlayElement;
-    try {
-        overlayElement = extractInterceptingElement(originalError.message);
-    }
-    catch (err) {
-        // Ignoring this error
-    }
-    const description = (0, utils_1.overlayDescription)(overlayElement);
-    reporter(`Attempting to auto-dismiss overlay: ${description}`);
-    try {
-        await runAgentOnOverlay(page, overlayElement);
-    }
-    catch (agentError) {
-        reporter(`Error during overlay dismissal agent execution: ${agentError.toString()}`);
-        throw originalError;
-    }
-}
-exports.attemptToDismissOverlay = attemptToDismissOverlay;

package/dist/test/scripts/pw-locator-patch/dismiss-overlays/utils.d.ts

@@ -5,4 +5,5 @@ export declare function overlayDescription(element: OverlayElement | undefined):
 export declare function isProductFruitsOverlay(element: OverlayElement | undefined): boolean | undefined;
 export declare function textContent(pageRef: Page, element: OverlayElement | undefined): Promise<string | undefined>;
 export declare function annotateForReport(testFn: TestFn, description: string): void;
+export declare function traceThis(task: string): import("@empiricalrun/llm").TraceClient | undefined;
 //# sourceMappingURL=utils.d.ts.map

package/dist/test/scripts/pw-locator-patch/dismiss-overlays/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/dismiss-overlays/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,sBASrE;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,uBAKzE;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,IAAI,EACb,OAAO,EAAE,cAAc,GAAG,SAAS,+BAiDpC;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,QAMpE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/dismiss-overlays/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,sBASrE;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,uBAKzE;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,IAAI,EACb,OAAO,EAAE,cAAc,GAAG,SAAS,+BAiDpC;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,QAMpE;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,uDAgBrC"}

package/dist/test/scripts/pw-locator-patch/dismiss-overlays/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.annotateForReport = exports.textContent = exports.isProductFruitsOverlay = exports.overlayDescription = void 0;
+exports.traceThis = exports.annotateForReport = exports.textContent = exports.isProductFruitsOverlay = exports.overlayDescription = void 0;
+const llm_1 = require("@empiricalrun/llm");
 function overlayDescription(element) {
     if (element) {
         const { interceptor, parent } = element;
@@ -75,3 +76,21 @@ function annotateForReport(testFn, description) {
     });
 }
 exports.annotateForReport = annotateForReport;
+function traceThis(task) {
+    const metadata = {
+        projectName: process.env.PROJECT_NAME ?? "",
+        testRunId: process.env.TEST_RUN_GITHUB_ACTION_ID ?? "",
+    };
+    const trace = (0, llm_1.createLangfuseTrace)({
+        name: "overlay_dismiss",
+        input: task,
+        tags: ["overlay_dismiss"],
+        metadata,
+    });
+    if (trace) {
+        const traceUrl = trace.getTraceUrl();
+        console.log(`Starting computer use agent: ${traceUrl}`);
+    }
+    return trace;
+}
+exports.traceThis = traceThis;

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

@@ -12,17 +12,20 @@ function patchClick(LocatorClass, testFn) {
     }
     const reporter = (description) => (0, utils_1.annotateForReport)(testFn, description);
     const originalClick = LocatorClass.prototype.click;
-    //ref: github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L255
+    // ref: github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L255
     LocatorClass.prototype.click = async function (options) {
         const stepName = `locator.click(${(0, utils_2.description)(this)})`;
         return await testFn.step(stepName, async () => {
             let overlayAttemptsRemaining = 2;
             let originalError;
+            const overlayDismiss = new dismiss_overlays_1.OverlayDismissAgent(this._frame._page);
             while (overlayAttemptsRemaining >= 0) {
                 overlayAttemptsRemaining--;
                 try {
                     let result = await originalClick.apply(this, [options]);
-                    return result; // If click is successful, we're done -- just return
+                    // If click is successful, we can save overlay dismissal code to cache and return
+                    await overlayDismiss.saveToCache();
+                    return result;
                 }
                 catch (error) {
                     originalError = error;
@@ -36,7 +39,7 @@ function patchClick(LocatorClass, testFn) {
                         // This will cause our overlay dismissal to not run.
                         throw originalError;
                     }
-                    await (0, dismiss_overlays_1.attemptToDismissOverlay)(originalError, this._frame._page, reporter);
+                    await overlayDismiss.run(originalError, reporter);
                     // Dismissal attempt finished (implicitly successful if no error thrown)
                     reporter(`Overlay dismissal attempted, retrying original action.`);
                 }

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

@@ -16,12 +16,15 @@ function patchHover(LocatorClass, testFn) {
         return await testFn.step(stepName, async () => {
             let overlayAttemptsRemaining = 2;
             let originalError;
+            const overlayDismiss = new dismiss_overlays_1.OverlayDismissAgent(this._frame._page);
             while (overlayAttemptsRemaining >= 0) {
                 overlayAttemptsRemaining--;
                 try {
                     let result = await originalHover.apply(this, [options]);
                     await (0, utils_2.highlight)(this);
-                    return result; // If hover is successful, we're done -- just return
+                    // If hover is successful, we can save overlay dismissal code to cache and return
+                    await overlayDismiss.saveToCache();
+                    return result;
                 }
                 catch (error) {
                     originalError = error;
@@ -31,7 +34,7 @@ function patchHover(LocatorClass, testFn) {
                     if (!(0, dismiss_overlays_1.isErrorSupported)(originalError.message)) {
                         throw originalError;
                     }
-                    await (0, dismiss_overlays_1.attemptToDismissOverlay)(originalError, this._frame._page, reporter);
+                    await overlayDismiss.run(originalError, reporter);
                     reporter(`Overlay dismissal attempted, retrying original action.`);
                 }
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.25.23",
+  "version": "0.25.24",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"