@empiricalrun/playwright-utils 0.38.4 → 0.38.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @empiricalrun/playwright-utils
 
+## 0.38.6
+
+### Patch Changes
+
+- 26e5a97: feat: add proxy config helpers
+
+## 0.38.5
+
+### Patch Changes
+
+- 86a9e1d: feat: improvements to overlay dismissal telemetry
+
 ## 0.38.4
 
 ### Patch Changes

package/dist/config/proxy.d.ts

@@ -0,0 +1,6 @@
+import type { BrowserContextOptions } from "@playwright/test";
+type ProxyConfig = NonNullable<BrowserContextOptions["proxy"]>;
+type ProxyRegion = "ap-south-1";
+export declare function getProxyConfig(region: ProxyRegion): ProxyConfig;
+export {};
+//# sourceMappingURL=proxy.d.ts.map

package/dist/config/proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../../src/config/proxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAE9D,KAAK,WAAW,GAAG,WAAW,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;AAE/D,KAAK,WAAW,GAAG,YAAY,CAAC;AAOhC,wBAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAM/D"}

package/dist/config/proxy.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProxyConfig = getProxyConfig;
+const proxyEndpoints = {
+    "ap-south-1": "http://prod-proxy-nlb-6b53da958ae0b30e.elb.ap-south-1.amazonaws.com:8080",
+};
+function getProxyConfig(region) {
+    return {
+        server: proxyEndpoints[region],
+        username: "proxyuser",
+        password: process.env.EMPIRICAL_PROXY_PASSWORD,
+    };
+}

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from "./auth";
 export * from "./auth/google";
 export { solveRecaptcha } from "./captcha";
 export { baseConfig, chromeStablePath, devices } from "./config";
+export { getProxyConfig } from "./config/proxy";
 export * from "./email";
 export * from "./kv";
 export * from "./playwright-extensions";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACjE,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.devices = exports.chromeStablePath = exports.baseConfig = exports.solveRecaptcha = void 0;
+exports.getProxyConfig = exports.devices = exports.chromeStablePath = exports.baseConfig = exports.solveRecaptcha = void 0;
 __exportStar(require("./auth"), exports);
 __exportStar(require("./auth/google"), exports);
 var captcha_1 = require("./captcha");
@@ -23,6 +23,8 @@ var config_1 = require("./config");
 Object.defineProperty(exports, "baseConfig", { enumerable: true, get: function () { return config_1.baseConfig; } });
 Object.defineProperty(exports, "chromeStablePath", { enumerable: true, get: function () { return config_1.chromeStablePath; } });
 Object.defineProperty(exports, "devices", { enumerable: true, get: function () { return config_1.devices; } });
+var proxy_1 = require("./config/proxy");
+Object.defineProperty(exports, "getProxyConfig", { enumerable: true, get: function () { return proxy_1.getProxyConfig; } });
 __exportStar(require("./email"), exports);
 __exportStar(require("./kv"), exports);
 __exportStar(require("./playwright-extensions"), exports);

package/dist/telemetry.d.ts

@@ -1,7 +1,9 @@
 import { TelemetryEvent } from "@empiricalrun/shared-types/telemetry";
 export declare function trackEvent(event: TelemetryEvent): Promise<void>;
 export declare function trackOverlayDismissed(opts: {
+    original: string | undefined;
     description: string;
+    text: string | undefined;
     cache: boolean;
     success: boolean;
     testName?: string;

package/dist/telemetry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../src/telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAKtE,wBAAsB,UAAU,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAqBrE;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE;IAC1C,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,IAAI,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C,GAAG,IAAI,CAkBP"}
+{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../src/telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAKtE,wBAAsB,UAAU,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAqBrE;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE;IAC1C,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,IAAI,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C,GAAG,IAAI,CAoBP"}

package/dist/telemetry.js

@@ -32,6 +32,8 @@ function trackOverlayDismissed(opts) {
         properties: {
             environment,
             overlay_description: opts.description,
+            overlay_text: opts.text ?? "",
+            original_locator: opts.original ?? "",
             cache_hit: opts.cache,
             success: opts.success,
             project_name: process.env.PROJECT_NAME ?? "",

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":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAK9C,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,EACvC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;YAkDF,QAAQ;CA6BvB;AAED,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,MAAM,GACnB,cAAc,GAAG,SAAS,CAiC5B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/dismiss-overlays/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAK9C,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,EACvC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;YAqDF,QAAQ;CA6BvB;AAED,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,MAAM,GACnB,cAAc,GAAG,SAAS,CAiC5B"}

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

@@ -37,8 +37,14 @@ class OverlayDismissAgent {
         const description = (0, utils_1.overlayDescription)(element) ?? "unknown";
         const testName = testFn.info().title;
         reporter(`Attempting to auto-dismiss overlay: ${description}`);
+        const text = await (0, utils_1.textContent)(this.page, element);
+        const eventProps = {
+            description,
+            text,
+            testName,
+            original: originalFailingLocator(originalError.message),
+        };
         try {
-            const text = await (0, utils_1.textContent)(this.page, element);
             const { success } = await (0, cache_1.executeFromCache)({
                 page: this.page,
                 dom: element?.interceptor,
@@ -46,19 +52,17 @@ class OverlayDismissAgent {
             });
             if (success) {
                 (0, telemetry_1.trackOverlayDismissed)({
-                    description,
+                    ...eventProps,
                     cache: true,
                     success: true,
-                    testName,
                 });
                 return;
             }
             const usage = await this.runAgent(element, text, testFn);
             (0, telemetry_1.trackOverlayDismissed)({
-                description,
+                ...eventProps,
                 cache: false,
                 success: true,
-                testName,
                 tokens: usage.tokens,
                 cost: usage.cost,
             });
@@ -66,10 +70,9 @@ class OverlayDismissAgent {
         catch (agentError) {
             reporter(`Error during overlay dismissal agent execution: ${agentError.toString()}`);
             (0, telemetry_1.trackOverlayDismissed)({
-                description,
+                ...eventProps,
                 cache: false,
                 success: false,
-                testName,
             });
             throw originalError;
         }
@@ -134,6 +137,15 @@ function extractInterceptingElement(errorMessage) {
         };
     }
 }
+function originalFailingLocator(errorMessage) {
+    try {
+        const p = removeAnsiCodes(errorMessage).split("waiting for ")[1];
+        return p?.split("\n")[0];
+    }
+    catch {
+        return "";
+    }
+}
 function removeAnsiCodes(str) {
     const ansiRegex = new RegExp(String.raw `\u001b\[[0-9;]*m`, "g");
     return str.replace(ansiRegex, "");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.38.4",
+  "version": "0.38.6",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -22,7 +22,7 @@
   },
   "author": "Empirical Team <hey@empirical.run>",
   "devDependencies": {
-    "@playwright/test": "1.53.2",
+    "@playwright/test": "1.57.0",
     "@types/async-retry": "^1.4.8",
     "@types/authenticator": "^1.1.4",
     "@types/babel__code-frame": "^7.0.6",
@@ -30,7 +30,7 @@
     "@types/node": "^20.14.9",
     "@types/serve-handler": "^6.1.4",
     "@types/pg": "^8.11.6",
-    "playwright-core": "1.53.2",
+    "playwright-core": "1.57.0",
     "serve-handler": "^6.1.6",
     "@empiricalrun/shared-types": "0.12.0"
   },

package/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/email.ts","./src/index.ts","./src/kv.ts","./src/logger.ts","./src/mailosaur-client.ts","./src/playwright-extensions.ts","./src/postgres.ts","./src/telemetry.ts","./src/auth/google.ts","./src/auth/index.ts","./src/auth/types.ts","./src/captcha/index.ts","./src/captcha/vision.ts","./src/config/index.ts","./src/config/devices/types.ts","./src/overlay-tests/cache.spec.ts","./src/overlay-tests/click.spec.ts","./src/overlay-tests/fixtures.ts","./src/overlay-tests/patch.spec.ts","./src/reporter/blob-utils.ts","./src/reporter/empirical-reporter.ts","./src/reporter/uploader.ts","./src/reporter/util.ts","./src/test/constants.ts","./src/test/expect.ts","./src/test/index.ts","./src/test/types.ts","./src/test/video-labels.ts","./src/test/scripts/agent-capabilities.ts","./src/test/scripts/index.ts","./src/test/scripts/locator-highlights.ts","./src/test/scripts/locator-vision.ts","./src/test/scripts/mouse-pointer.ts","./src/test/scripts/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/cache.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/index.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/prompt.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/utils.ts","./src/test/scripts/pw-locator-patch/highlight/click.ts","./src/test/scripts/pw-locator-patch/highlight/expect.ts","./src/test/scripts/pw-locator-patch/highlight/hover.ts","./src/test/scripts/pw-locator-patch/highlight/inner-text.ts","./src/test/scripts/pw-locator-patch/highlight/input-value.ts","./src/test/scripts/pw-locator-patch/highlight/is-checked.ts","./src/test/scripts/pw-locator-patch/highlight/is-disabled.ts","./src/test/scripts/pw-locator-patch/highlight/is-editable.ts","./src/test/scripts/pw-locator-patch/highlight/text-content.ts","./src/test/scripts/pw-locator-patch/utils/index.ts","./src/test/scripts/pw-locator-patch/vision/query.ts"],"version":"5.8.3"}
+{"root":["./src/email.ts","./src/index.ts","./src/kv.ts","./src/logger.ts","./src/mailosaur-client.ts","./src/playwright-extensions.ts","./src/postgres.ts","./src/telemetry.ts","./src/auth/google.ts","./src/auth/index.ts","./src/auth/types.ts","./src/captcha/index.ts","./src/captcha/vision.ts","./src/config/index.ts","./src/config/proxy.ts","./src/config/devices/types.ts","./src/overlay-tests/cache.spec.ts","./src/overlay-tests/click.spec.ts","./src/overlay-tests/fixtures.ts","./src/overlay-tests/patch.spec.ts","./src/reporter/blob-utils.ts","./src/reporter/empirical-reporter.ts","./src/reporter/uploader.ts","./src/reporter/util.ts","./src/test/constants.ts","./src/test/expect.ts","./src/test/index.ts","./src/test/types.ts","./src/test/video-labels.ts","./src/test/scripts/agent-capabilities.ts","./src/test/scripts/index.ts","./src/test/scripts/locator-highlights.ts","./src/test/scripts/locator-vision.ts","./src/test/scripts/mouse-pointer.ts","./src/test/scripts/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/cache.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/index.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/prompt.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/utils.ts","./src/test/scripts/pw-locator-patch/highlight/click.ts","./src/test/scripts/pw-locator-patch/highlight/expect.ts","./src/test/scripts/pw-locator-patch/highlight/hover.ts","./src/test/scripts/pw-locator-patch/highlight/inner-text.ts","./src/test/scripts/pw-locator-patch/highlight/input-value.ts","./src/test/scripts/pw-locator-patch/highlight/is-checked.ts","./src/test/scripts/pw-locator-patch/highlight/is-disabled.ts","./src/test/scripts/pw-locator-patch/highlight/is-editable.ts","./src/test/scripts/pw-locator-patch/highlight/text-content.ts","./src/test/scripts/pw-locator-patch/utils/index.ts","./src/test/scripts/pw-locator-patch/vision/query.ts"],"version":"5.8.3"}