@empiricalrun/playwright-utils 0.16.3 → 0.18.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @empiricalrun/playwright-utils
 
+## 0.18.0
+
+### Minor Changes
+
+- dbe713b: fix: auto dismiss popup at test runtime
+
+### Patch Changes
+
+- 041cd97: fix: remove log line
+- Updated dependencies [dbe713b]
+  - @empiricalrun/test-gen@0.38.30
+
+## 0.17.0
+
+### Minor Changes
+
+- 9f0a413: feat: auth store can extract cookies/localstorage
+
 ## 0.16.3
 
 ### Patch Changes

package/dist/auth/index.d.ts

@@ -3,6 +3,11 @@ type WithKey<T> = T & {
     key: string;
 };
 type AppType = "web-app" | "chrome-extension";
+type QueryFilter = {
+    type: "cookie" | "localStorage";
+    origin: string;
+    name: string;
+};
 export declare class AuthStore<T extends WithKey<{}>> {
     appType: AppType;
     page: Page;
@@ -18,6 +23,9 @@ export declare class AuthStore<T extends WithKey<{}>> {
     });
     loginIfRequired(): Promise<void>;
     loggedInPage(): Promise<Page | undefined>;
+    static getValueFromAuthState(userContext: {
+        key: string;
+    }, query: QueryFilter): string | undefined;
     private newPageWithAuthState;
     private saveAuthState;
     static location(userContext: {

package/dist/auth/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAU,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE/D,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,KAAK,OAAO,GAAG,SAAS,GAAG,kBAAkB,CAAC;AAE9C,qBAAa,SAAS,CAAC,CAAC,SAAS,OAAO,CAAC,EAAE,CAAC;IAC1C,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,CAAC,CAAC;IACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;gBACxD,EACV,IAAI,EACJ,WAAW,EACX,SAAS,EACT,iBAAiB,EACjB,OAAmB,GACpB,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,WAAW,EAAE,CAAC,CAAC;QACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QACpE,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;IAQK,eAAe;IAIf,YAAY,IAAI,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;YAqCjC,oBAAoB;YAsBpB,aAAa;IA6B3B,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;WAIxC,eAAe,CAC1B,OAAO,EAAE,cAAc,EACvB,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC;CAoB5B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAU,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAI/D,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,KAAK,OAAO,GAAG,SAAS,GAAG,kBAAkB,CAAC;AAE9C,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,QAAQ,GAAG,cAAc,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,qBAAa,SAAS,CAAC,CAAC,SAAS,OAAO,CAAC,EAAE,CAAC;IAC1C,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,CAAC,CAAC;IACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;gBACxD,EACV,IAAI,EACJ,WAAW,EACX,SAAS,EACT,iBAAiB,EACjB,OAAmB,GACpB,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,WAAW,EAAE,CAAC,CAAC;QACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QACpE,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;IAQK,eAAe;IAIf,YAAY,IAAI,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAqC/C,MAAM,CAAC,qBAAqB,CAC1B,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,EAC5B,KAAK,EAAE,WAAW,GACjB,MAAM,GAAG,SAAS;YAyBP,oBAAoB;YAsBpB,aAAa;IA6B3B,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;WAIxC,eAAe,CAC1B,OAAO,EAAE,cAAc,EACvB,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC;CAoB5B"}

package/dist/auth/index.js

@@ -58,6 +58,29 @@ class AuthStore {
         }
         return loggedInPage;
     }
+    static getValueFromAuthState(userContext, query) {
+        const storagePath = AuthStore.location(userContext);
+        const contents = fs_1.default.readFileSync(storagePath);
+        if (!contents) {
+            throw new Error("No auth state found");
+        }
+        const authState = JSON.parse(contents.toString());
+        if (query.type === "cookie") {
+            const cookie = authState.cookies.find((c) => c.name === query.name && c.domain === query.origin);
+            if (cookie) {
+                return cookie.value;
+            }
+        }
+        else if (query.type === "localStorage") {
+            const origin = authState.origins.find((o) => o.origin === query.origin);
+            if (origin) {
+                const item = origin.localStorage.find((i) => i.name === query.name);
+                if (item) {
+                    return item.value;
+                }
+            }
+        }
+    }
     async newPageWithAuthState(page, storagePath) {
         if (this.appType === "web-app") {
             // Load state from the file in a new context

package/dist/auth/types.d.ts

@@ -0,0 +1,24 @@
+type AuthStateCookie = {
+    name: string;
+    value: string;
+    domain: string;
+    path: string;
+    expires: number;
+    httpOnly: boolean;
+    secure: boolean;
+    sameSite: "Strict" | "Lax" | "None";
+};
+type AuthStateLocalStorage = {
+    name: string;
+    value: string;
+};
+type AuthStateOrigin = {
+    origin: string;
+    localStorage: AuthStateLocalStorage[];
+};
+export type AuthStateFileContent = {
+    cookies: AuthStateCookie[];
+    origins: AuthStateOrigin[];
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/auth/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/auth/types.ts"],"names":[],"mappings":"AAAA,KAAK,eAAe,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;CACrC,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,qBAAqB,EAAE,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B,CAAC"}

package/dist/auth/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/test/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,IAAI,EACJ,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAK1B,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,yBAAyB,EAAE,CACzB,OAAO,CAAC,EAAE,qBAAqB,KAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACtD,UAAU,EAAE,IAAI,CAAC;CAClB,CAAC;AAIF,eAAO,MAAM,eAAe,WAClB,SACN,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,YACQ,eAAe,uHAwDzB,CAAC;AAEF,OAAO,EAAE,6BAA6B,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,IAAI,EACJ,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAK1B,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,yBAAyB,EAAE,CACzB,OAAO,CAAC,EAAE,qBAAqB,KAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACtD,UAAU,EAAE,IAAI,CAAC;CAClB,CAAC;AAIF,eAAO,MAAM,eAAe,WAClB,SACN,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,YACQ,eAAe,uHA4DzB,CAAC;AAEF,OAAO,EAAE,6BAA6B,EAAE,CAAC"}

package/dist/test/index.js

@@ -14,8 +14,9 @@ const baseTestFixture = function (testFn, options = {
     mousePointerHighlighter: true,
     locatorHighlighter: true,
     visionMethods: true,
+    agentCapabilities: true,
 }) {
-    return testFn.extend({
+    const extendedTestFn = testFn.extend({
         page: async ({ page }, use) => {
             (0, scripts_1.injectLocatorHighlightScripts)(page, options);
             await use(page);
@@ -57,5 +58,8 @@ const baseTestFixture = function (testFn, options = {
             { auto: true },
         ],
     });
+    //@ts-ignore
+    global.testFn = extendedTestFn;
+    return extendedTestFn;
 };
 exports.baseTestFixture = baseTestFixture;

package/dist/test/scripts/agent-capabilities.d.ts

@@ -0,0 +1,3 @@
+import type { Page } from "@playwright/test";
+export declare function addAgentCapabilities(page: Page): void;
+//# sourceMappingURL=agent-capabilities.d.ts.map

package/dist/test/scripts/agent-capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent-capabilities.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/agent-capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAI7C,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,QAK9C"}

package/dist/test/scripts/agent-capabilities.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addAgentCapabilities = void 0;
+const click_1 = require("./pw-locator-patch/highlight/click");
+function addAgentCapabilities(page) {
+    applyPatchForAutoDismissOverlay(page);
+    page.context().on("page", async (newPage) => {
+        applyPatchForAutoDismissOverlay(newPage);
+    });
+}
+exports.addAgentCapabilities = addAgentCapabilities;
+function applyPatchForAutoDismissOverlay(page) {
+    const LocatorClass = page.locator("").constructor;
+    (0, click_1.patchClick)(LocatorClass);
+}

package/dist/test/scripts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAG7C,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAW3C,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,eAAgC,QAwB1C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAG7C,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAa3C,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,eAAgC,QA4B1C"}

package/dist/test/scripts/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.injectLocatorHighlightScripts = void 0;
 const logger_1 = require("../../logger");
+const agent_capabilities_1 = require("./agent-capabilities");
 const locator_highlights_1 = require("./locator-highlights");
 const locator_vision_1 = require("./locator-vision");
 const mouse_pointer_1 = require("./mouse-pointer");
@@ -9,6 +10,7 @@ const defaultOptions = {
     mousePointerHighlighter: true,
     locatorHighlighter: true,
     visionMethods: true,
+    agentCapabilities: true,
 };
 function injectLocatorHighlightScripts(page, options = defaultOptions) {
     // TODO: if this method is used standalone (not through the fixture),
@@ -30,6 +32,10 @@ function injectLocatorHighlightScripts(page, options = defaultOptions) {
             // patch with vision methods
             (0, locator_vision_1.addLocatorVisionMethods)(page);
         }
+        if (opts.agentCapabilities) {
+            //patch to enable agents at runtime
+            (0, agent_capabilities_1.addAgentCapabilities)(page);
+        }
     }
     catch (e) {
         logger_1.logger.debug("Failed to add mouse pointer highlighter", e);

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

@@ -0,0 +1,5 @@
+import type { Locator } from "@playwright/test";
+export declare function patchClick(LocatorClass: {
+    prototype: Locator;
+}): void;
+//# sourceMappingURL=click.d.ts.map

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

@@ -0,0 +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,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,UAAU,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QA4C9D"}

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

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patchClick = void 0;
+const planner_1 = require("@empiricalrun/test-gen/agent/master/planner");
+const run_1 = require("@empiricalrun/test-gen/agent/master/run");
+function patchClick(LocatorClass) {
+    const originalClick = LocatorClass.prototype.click;
+    //ref: github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L255
+    LocatorClass.prototype.click = async function (options) {
+        try {
+            await originalClick.apply(this, [options]);
+        }
+        catch (e) {
+            // If its a test gen, don't trigger the flow
+            if (process.env.TEST_GEN_TOKEN) {
+                throw new Error(`waiting for ${this.toString()} with options ${JSON.stringify(options)}`);
+            }
+            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.",
+                conversation: [],
+                //Need to add the type for frame
+                //@ts-ignore
+                page: this._frame._page,
+            });
+            if (plannerResp.isDone) {
+                throw new Error(`waiting for ${this.toString()} with options ${JSON.stringify(options)}`);
+            }
+            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.",
+                //Need to add the type for frame
+                //@ts-ignore
+                page: this._frame._page,
+                options: {
+                    useHints: true,
+                },
+            });
+            //@ts-ignore
+            global.testFn?.info().annotations.push({
+                type: "auto-overlay-dismissed",
+                description: "This test run had an overlay that was dismissed during runtime",
+            });
+            await originalClick.apply(this, [options]);
+        }
+    };
+}
+exports.patchClick = patchClick;

package/dist/test/types.d.ts

@@ -2,5 +2,6 @@ export type HighlighterOpts = {
     mousePointerHighlighter?: boolean;
     locatorHighlighter?: boolean;
     visionMethods?: boolean;
+    agentCapabilities?: boolean;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/test/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/test/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG;IAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/test/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG;IAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.16.3",
+  "version": "0.18.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -42,7 +42,8 @@
     "puppeteer-extra-plugin-recaptcha": "^3.6.8",
     "rimraf": "^6.0.1",
     "@empiricalrun/llm": "^0.9.27",
-    "@empiricalrun/r2-uploader": "^0.3.7"
+    "@empiricalrun/r2-uploader": "^0.3.7",
+    "@empiricalrun/test-gen": "^0.38.30"
   },
   "scripts": {
     "dev": "tsc --build --watch",