@empiricalrun/playwright-utils 0.20.2 → 0.20.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/playwright-utils
 
+## 0.20.3
+
+### Patch Changes
+
+- bb0496f: fix: hover failure error stack should not contain patch method
+
 ## 0.20.2
 
 ### Patch Changes

package/dist/overlay-tests/click.spec.js

@@ -64,3 +64,17 @@ test_1.test.beforeEach(async ({ page }) => {
     await (0, test_1.expect)(page.getByText("This is a toast message")).not.toBeVisible();
     await (0, test_1.expect)(page.getByRole("button", { name: "Close" })).toBeVisible();
 });
+(0, test_1.test)("should not return patch method in error stack", async ({ page }) => {
+    await page.goto(`http://localhost:${PORT}/tos.html`);
+    let error;
+    try {
+        await page.locator("div.some-random-class-name").hover();
+    }
+    catch (e) {
+        error = e;
+    }
+    (0, test_1.expect)(error).toBeDefined();
+    (0, test_1.expect)(error.stack).toBeDefined();
+    (0, test_1.expect)(error.stack).not.toContain("hover.ts");
+    (0, test_1.expect)(error.stack).toContain("overlay-tests/click.spec.ts:83");
+});

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

@@ -1,3 +1,4 @@
-import type { Page, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from "@playwright/test";
-export declare function addAgentCapabilities(page: Page, testFn: TestType<PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>): void;
+import type { Page } from "@playwright/test";
+import { TestFn } from "./types";
+export declare function addAgentCapabilities(page: Page, testFn: TestFn): void;
 //# sourceMappingURL=agent-capabilities.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"agent-capabilities.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/agent-capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,IAAI,EACJ,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAe1B,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,QAAQ,CACd,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,QAMF"}
+{"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;AAG7C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAOjC,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,QAK9D"}

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

@@ -1,4 +1,5 @@
-import type { Page, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from "@playwright/test";
+import type { Page } from "@playwright/test";
 import { HighlighterOpts } from "../types";
-export declare function injectLocatorHighlightScripts(page: Page, testFn: TestType<PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>, options?: HighlighterOpts): void;
+import { TestFn } from "./types";
+export declare function injectLocatorHighlightScripts(page: Page, testFn: TestFn, options?: HighlighterOpts): void;
 //# sourceMappingURL=index.d.ts.map

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,EACV,IAAI,EACJ,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAa3C,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,QAAQ,CACd,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,EACD,OAAO,GAAE,eAAgC,QAsB1C"}
+{"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;AAK3C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AASjC,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,eAAgC,QAsB1C"}

package/dist/test/scripts/index.js

@@ -22,7 +22,7 @@ function injectLocatorHighlightScripts(page, testFn, options = defaultOptions) {
             (0, mouse_pointer_1.addMousePointerHighlighter)(page);
         }
         if (opts.locatorHighlighter) {
-            (0, locator_highlights_1.addLocatorHighlights)(page);
+            (0, locator_highlights_1.addLocatorHighlights)(page, testFn);
         }
         if (opts.visionMethods) {
             (0, locator_vision_1.addLocatorVisionMethods)(page);

package/dist/test/scripts/locator-highlights.d.ts

@@ -1,3 +1,4 @@
 import type { Page } from "@playwright/test";
-export declare function addLocatorHighlights(page: Page): void;
+import { TestFn } from "./types";
+export declare function addLocatorHighlights(page: Page, testFn: TestFn): void;
 //# sourceMappingURL=locator-highlights.d.ts.map

package/dist/test/scripts/locator-highlights.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"locator-highlights.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/locator-highlights.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAW7C,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,QAK9C"}
+{"version":3,"file":"locator-highlights.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/locator-highlights.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAU7C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,QAK9D"}

package/dist/test/scripts/locator-highlights.js

@@ -9,21 +9,21 @@ const is_checked_1 = require("./pw-locator-patch/highlight/is-checked");
 const is_disabled_1 = require("./pw-locator-patch/highlight/is-disabled");
 const is_editable_1 = require("./pw-locator-patch/highlight/is-editable");
 const text_content_1 = require("./pw-locator-patch/highlight/text-content");
-function addLocatorHighlights(page) {
-    applyHighlights(page);
+function addLocatorHighlights(page, testFn) {
+    applyHighlights(page, testFn);
     page.context().on("page", async (newPage) => {
-        applyHighlights(newPage);
+        applyHighlights(newPage, testFn);
     });
 }
 exports.addLocatorHighlights = addLocatorHighlights;
-function applyHighlights(page) {
+function applyHighlights(page, testFn) {
     const LocatorClass = page.locator("").constructor;
+    (0, hover_1.patchHover)(LocatorClass, testFn);
     (0, expect_1.patchExpect)(LocatorClass);
     (0, input_value_1.patchInputValue)(LocatorClass);
     (0, is_checked_1.patchIsChecked)(LocatorClass);
     (0, is_editable_1.patchIsEditable)(LocatorClass);
     (0, is_disabled_1.patchIsDisabled)(LocatorClass);
-    (0, hover_1.patchHover)(LocatorClass);
     (0, inner_text_1.patchInnerText)(LocatorClass);
     (0, text_content_1.patchTextContent)(LocatorClass);
 }

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

@@ -1,5 +1,6 @@
 import type { Locator } from "@playwright/test";
+import { TestFn } from "../../types";
 export declare function patchHover(LocatorClass: Function & {
     prototype: Locator;
-}): void;
+}, testFn: TestFn): void;
 //# sourceMappingURL=hover.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"hover.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/highlight/hover.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAMhD,wBAAgB,UAAU,CAAC,YAAY,EAAE,QAAQ,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAUzE"}
+{"version":3,"file":"hover.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/highlight/hover.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAKrC,wBAAgB,UAAU,CACxB,YAAY,EAAE,QAAQ,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,EAC/C,MAAM,EAAE,MAAM,QA2Bf"}

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

@@ -3,14 +3,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchHover = void 0;
 const utils_1 = require("../utils");
 const isHoverPatched = new WeakMap();
-function patchHover(LocatorClass) {
+function patchHover(LocatorClass, testFn) {
     if (isHoverPatched.get(LocatorClass)) {
         return;
     }
     const originalHover = LocatorClass.prototype.hover;
     LocatorClass.prototype.hover = async function (options) {
-        await originalHover.apply(this, [options]);
-        await (0, utils_1.highlight)(this);
+        let result;
+        const stepName = `locator.hover(${(0, utils_1.description)(this)})`;
+        await testFn.step(stepName, async () => {
+            try {
+                result = await originalHover.apply(this, [options]);
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    Error.captureStackTrace(error, LocatorClass.prototype.hover);
+                }
+                throw error;
+            }
+            await (0, utils_1.highlight)(this);
+        }, { box: true });
+        return result;
     };
     isHoverPatched.set(LocatorClass, true);
 }

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

@@ -1,4 +1,5 @@
 import { Locator } from "playwright-core";
+export declare function description(locator: Locator): string;
 export declare function scrollAndHighlight(locator: Locator): Promise<void>;
 export declare function highlight(locator: Locator): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAK1C,wBAAsB,kBAAkB,CAAC,OAAO,EAAE,OAAO,iBAsBxD;AAED,wBAAsB,SAAS,CAAC,OAAO,EAAE,OAAO,iBAiB/C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAK1C,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,UA0B3C;AAED,wBAAsB,kBAAkB,CAAC,OAAO,EAAE,OAAO,iBAsBxD;AAED,wBAAsB,SAAS,CAAC,OAAO,EAAE,OAAO,iBAiB/C"}

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

@@ -1,8 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.highlight = exports.scrollAndHighlight = void 0;
+exports.highlight = exports.scrollAndHighlight = exports.description = void 0;
 const logger_1 = require("../../../../logger");
 const constants_1 = require("../../../constants");
+function description(locator) {
+    const fallbackDescription = locator.toString();
+    try {
+        let cleanedDescription = fallbackDescription;
+        if (fallbackDescription.startsWith("locator(") &&
+            fallbackDescription.endsWith(")")) {
+            cleanedDescription = fallbackDescription
+                .substring(8, fallbackDescription.length - 1)
+                .trim();
+            if ((cleanedDescription.startsWith("'") &&
+                cleanedDescription.endsWith("'")) ||
+                (cleanedDescription.startsWith('"') && cleanedDescription.endsWith('"'))) {
+                cleanedDescription = cleanedDescription.substring(1, cleanedDescription.length - 1);
+            }
+        }
+        return cleanedDescription;
+    }
+    catch (e) {
+        return fallbackDescription;
+    }
+}
+exports.description = description;
 async function scrollAndHighlight(locator) {
     try {
         await locator.evaluate((node) => {

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

@@ -0,0 +1,3 @@
+import type { PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from "@playwright/test";
+export type TestFn = TestType<PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAE1B,MAAM,MAAM,MAAM,GAAG,QAAQ,CAC3B,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,CAAC"}

package/dist/test/scripts/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.20.2",
+  "version": "0.20.3",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -43,8 +43,8 @@
     "puppeteer-extra-plugin-recaptcha": "^3.6.8",
     "rimraf": "^6.0.1",
     "@empiricalrun/llm": "^0.9.35",
-    "@empiricalrun/test-gen": "^0.43.0",
-    "@empiricalrun/r2-uploader": "^0.3.8"
+    "@empiricalrun/r2-uploader": "^0.3.8",
+    "@empiricalrun/test-gen": "^0.43.0"
   },
   "scripts": {
     "dev": "tsc --build --watch",