@empiricalrun/playwright-utils 0.39.5 → 0.40.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @empiricalrun/playwright-utils
 
+## 0.40.0
+
+### Minor Changes
+
+- df795ce: feat: use external service dependencies via proxy
+
+## 0.39.6
+
+### Patch Changes
+
+- 4947d9a: feat: move failing line collection to reporter
+  - @empiricalrun/cua@0.2.0
+  - @empiricalrun/dashboard-client@0.2.0
+  - @empiricalrun/llm@0.25.2
+
 ## 0.39.5
 
 ### Patch Changes

package/dist/captcha/index.d.ts

@@ -1,7 +1,3 @@
 import type { Page } from "@playwright/test";
-type CaptchaSolveOptions = {
-    provider: "2captcha" | "llm-vision";
-};
-export declare function solveRecaptcha(page: Page, options?: CaptchaSolveOptions): Promise<void>;
-export {};
+export declare function solveRecaptcha(page: Page): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/captcha/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAK7C,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,UAAU,GAAG,YAAY,CAAC;CACrC,CAAC;AAMF,wBAAsB,cAAc,CAClC,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,mBAAiC,iBAmB3C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/captcha/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAmI7C,wBAAsB,cAAc,CAAC,IAAI,EAAE,IAAI,iBAU9C"}

package/dist/captcha/index.js

@@ -4,28 +4,96 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.solveRecaptcha = solveRecaptcha;
+const dashboard_client_1 = require("@empiricalrun/dashboard-client");
 const puppeteer_extra_plugin_recaptcha_1 = __importDefault(require("puppeteer-extra-plugin-recaptcha"));
-const vision_1 = require("./vision");
-const defaultOpts = {
-    provider: "2captcha",
-};
-async function solveRecaptcha(page, options = defaultOpts) {
-    const { provider } = options;
-    if (provider === "2captcha") {
-        const token = process.env.TWOCAPTCHA_API_KEY;
-        if (!token) {
-            throw new Error("Missing environment variable: TWOCAPTCHA_API_KEY");
+const POLLING_INTERVAL = 5000;
+const MAX_POLLING_TIME = 180_000;
+function buildTask(captcha) {
+    const taskType = captcha._vendor === "hcaptcha"
+        ? "HCaptchaTaskProxyless"
+        : "RecaptchaV2TaskProxyless";
+    const task = {
+        type: taskType,
+        websiteURL: captcha.url,
+        websiteKey: captcha.sitekey,
+    };
+    if (captcha.isEnterprise) {
+        task.isEnterprise = true;
+    }
+    if (captcha.s) {
+        task.recaptchaDataSValue = captcha.s;
+    }
+    return task;
+}
+function assertNoError(result) {
+    if (result.errorId && result.errorId > 0) {
+        throw new Error(`2captcha error: ${result.errorCode || "unknown"}`);
+    }
+}
+async function solveViaProxy(captchas) {
+    const apiClient = new dashboard_client_1.DashboardAPIClient({
+        authType: "project-api-key",
+    });
+    const solutions = await Promise.all(captchas.map((captcha) => solveSingleViaProxy(apiClient, captcha)));
+    return { solutions, error: solutions.find((s) => !!s.error) };
+}
+async function solveSingleViaProxy(apiClient, captcha) {
+    const solution = {
+        _vendor: captcha._vendor,
+        provider: "2captcha",
+    };
+    try {
+        if (!captcha.sitekey || !captcha.url || !captcha.id) {
+            throw new Error("Missing data in captcha");
         }
-        const rcPlugin = (0, puppeteer_extra_plugin_recaptcha_1.default)({
-            provider: {
-                id: "2captcha",
-                token,
-            },
-            visualFeedback: true,
+        solution.id = captcha.id;
+        solution.requestAt = new Date();
+        const createResult = await apiClient.request(`/api/twocaptcha/proxy`, {
+            method: "POST",
+            body: { endpoint: "/createTask", body: { task: buildTask(captcha) } },
         });
-        await rcPlugin.solveRecaptchas(page);
+        assertNoError(createResult);
+        if (!createResult.taskId) {
+            throw new Error("2captcha error: no taskId returned");
+        }
+        const taskId = createResult.taskId;
+        const startTime = Date.now();
+        while (Date.now() - startTime < MAX_POLLING_TIME) {
+            await new Promise((resolve) => setTimeout(resolve, POLLING_INTERVAL));
+            const result = await apiClient.request(`/api/twocaptcha/proxy`, {
+                method: "POST",
+                body: { endpoint: "/getTaskResult", body: { taskId } },
+            });
+            assertNoError(result);
+            if (result.status === 1 && result.solution) {
+                const token = result.solution.gRecaptchaResponse || result.solution.token;
+                if (token) {
+                    solution.text = token;
+                    break;
+                }
+            }
+        }
+        if (!solution.text) {
+            throw new Error("2captcha error: polling timed out");
+        }
+        solution.responseAt = new Date();
+        solution.hasSolution = true;
+        solution.duration =
+            (solution.responseAt.getTime() - solution.requestAt.getTime()) / 1000;
     }
-    else if (provider === "llm-vision") {
-        return (0, vision_1.solveRecaptcha)(page);
+    catch (error) {
+        solution.error = String(error);
     }
+    return solution;
+}
+async function solveRecaptcha(page) {
+    const rcPlugin = (0, puppeteer_extra_plugin_recaptcha_1.default)({
+        provider: {
+            id: "2captcha",
+            token: "proxy",
+            fn: solveViaProxy,
+        },
+        visualFeedback: true,
+    });
+    await rcPlugin.solveRecaptchas(page);
 }

package/dist/reporter/empirical-reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"empirical-reporter.d.ts","sourceRoot":"","sources":["../../src/reporter/empirical-reporter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,UAAU,EACX,MAAM,2BAA2B,CAAC;AAmBnC,cAAM,iBAAkB,YAAW,QAAQ;IACzC,OAAO,CAAC,kBAAkB,CAAyB;IACnD,OAAO,CAAC,oBAAoB,CAG1B;IACF,OAAO,CAAC,sBAAsB,CAAuB;IACrD,OAAO,CAAC,YAAY,CAAgD;IACpE,OAAO,CAAC,iBAAiB,CAAyC;IAClE,OAAO,CAAC,gBAAgB,CAAkC;IAC1D,OAAO,CAAC,SAAS,CAAyB;;IAM1C,OAAO,CAAC,6BAA6B,CAkCnC;IAEF,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAoFtC,KAAK,CAAC,MAAM,EAAE,UAAU;IA8G9B,OAAO,CAAC,gBAAgB;YAoBV,gBAAgB;YAOhB,iBAAiB;CAmChC;AAED,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"empirical-reporter.d.ts","sourceRoot":"","sources":["../../src/reporter/empirical-reporter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,UAAU,EACX,MAAM,2BAA2B,CAAC;AAoBnC,cAAM,iBAAkB,YAAW,QAAQ;IACzC,OAAO,CAAC,kBAAkB,CAAyB;IACnD,OAAO,CAAC,oBAAoB,CAG1B;IACF,OAAO,CAAC,sBAAsB,CAAuB;IACrD,OAAO,CAAC,YAAY,CAAgD;IACpE,OAAO,CAAC,iBAAiB,CAAyC;IAClE,OAAO,CAAC,gBAAgB,CAAkC;IAC1D,OAAO,CAAC,SAAS,CAAyB;;IAM1C,OAAO,CAAC,6BAA6B,CAkCnC;IAEF,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IA6FtC,KAAK,CAAC,MAAM,EAAE,UAAU;IA8G9B,OAAO,CAAC,gBAAgB;YAoBV,gBAAgB;YAOhB,iBAAiB;CAmChC;AAED,eAAe,iBAAiB,CAAC"}

package/dist/reporter/empirical-reporter.js

@@ -8,6 +8,7 @@ const path_1 = __importDefault(require("path"));
 const logger_1 = require("../logger");
 const telemetry_1 = require("../telemetry");
 const blob_utils_1 = require("./blob-utils");
+const failing_line_1 = require("./failing-line");
 const uploader_1 = require("./uploader");
 const util_1 = require("./util");
 class EmpiricalReporter {
@@ -88,6 +89,10 @@ class EmpiricalReporter {
                 try {
                     logger_1.logger.debug(`[Empirical Reporter] Attachments for test ${test.title} are uploaded:`, successfulAttachments);
                     const { suites, projectName } = (0, util_1.suitesAndProjectForTest)(test);
+                    const errorLocation = result.error?.location;
+                    const failingLine = errorLocation
+                        ? (0, failing_line_1.getFailingLineFromSource)(errorLocation.file, errorLocation.line, errorLocation.column)
+                        : undefined;
                     const params = {
                         test,
                         suites,
@@ -95,6 +100,7 @@ class EmpiricalReporter {
                         projectName,
                         attachments: successfulAttachments,
                         runId: process.env.TEST_RUN_GITHUB_ACTION_ID,
+                        failingLine,
                     };
                     return (0, util_1.sendTestCaseUpdateToDashboard)(params);
                 }

package/dist/reporter/failing-line.d.ts

@@ -0,0 +1,2 @@
+export declare function getFailingLineFromSource(filePath: string, line: number, column: number): string | undefined;
+//# sourceMappingURL=failing-line.d.ts.map

package/dist/reporter/failing-line.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"failing-line.d.ts","sourceRoot":"","sources":["../../src/reporter/failing-line.ts"],"names":[],"mappings":"AAmDA,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,GACb,MAAM,GAAG,SAAS,CAQpB"}

package/dist/reporter/failing-line.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFailingLineFromSource = getFailingLineFromSource;
+const fs_1 = __importDefault(require("fs"));
+const ts_morph_1 = require("ts-morph");
+const supportedSyntaxes = [
+    ts_morph_1.SyntaxKind.ExpressionStatement,
+    ts_morph_1.SyntaxKind.VariableStatement,
+    ts_morph_1.SyntaxKind.ReturnStatement,
+    ts_morph_1.SyntaxKind.IfStatement,
+    ts_morph_1.SyntaxKind.ForStatement,
+    ts_morph_1.SyntaxKind.WhileStatement,
+    ts_morph_1.SyntaxKind.DoStatement,
+    ts_morph_1.SyntaxKind.SwitchStatement,
+    ts_morph_1.SyntaxKind.TryStatement,
+    ts_morph_1.SyntaxKind.FunctionDeclaration,
+    ts_morph_1.SyntaxKind.ArrowFunction,
+    ts_morph_1.SyntaxKind.ClassDeclaration,
+    ts_morph_1.SyntaxKind.Block,
+    ts_morph_1.SyntaxKind.ThrowStatement,
+];
+function getTestStatementFromCode(code, line, column) {
+    const project = new ts_morph_1.Project();
+    const sourceFile = project.createSourceFile("temp-file.ts", `${code}`);
+    const position = sourceFile
+        .getFullText()
+        .split("\n")
+        .slice(0, line - 1)
+        .reduce((sum, l) => sum + l.length + 1, 0) +
+        (column - 1);
+    const nodeAtPos = sourceFile.getDescendantAtPos(position);
+    if (nodeAtPos) {
+        let statement = nodeAtPos.getFirstAncestor((ancestor) => supportedSyntaxes.includes(ancestor.getKind()));
+        if (!statement) {
+            if (supportedSyntaxes.includes(nodeAtPos.getKind())) {
+                statement = nodeAtPos;
+            }
+        }
+        if (statement) {
+            return statement.getText();
+        }
+    }
+    return "";
+}
+function getFailingLineFromSource(filePath, line, column) {
+    try {
+        const code = fs_1.default.readFileSync(filePath, "utf-8");
+        const statement = getTestStatementFromCode(code, line, column);
+        return statement || undefined;
+    }
+    catch {
+        return undefined;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.39.5",
+  "version": "0.40.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -32,7 +32,7 @@
     "@types/pg": "^8.11.6",
     "playwright-core": "1.57.0",
     "serve-handler": "^6.1.6",
-    "@empiricalrun/shared-types": "0.12.0"
+    "@empiricalrun/shared-types": "0.12.1"
   },
   "dependencies": {
     "@babel/code-frame": "^7.24.7",
@@ -42,8 +42,9 @@
     "console-log-level": "^1.4.1",
     "puppeteer-extra-plugin-recaptcha": "^3.6.8",
     "rimraf": "^6.0.1",
-    "@empiricalrun/dashboard-client": "^0.2.0",
+    "ts-morph": "^23.0.0",
     "@empiricalrun/cua": "^0.2.0",
+    "@empiricalrun/dashboard-client": "^0.2.0",
     "@empiricalrun/llm": "^0.25.2",
     "@empiricalrun/r2-uploader": "^0.9.1"
   },

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/webhook.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/index.ts","./src/test/types.ts","./src/test/video-labels.ts","./src/test/expect/index.ts","./src/test/expect/types.ts","./src/test/expect/visual.ts","./src/test/expect/webhook.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/webhook.ts","./src/auth/google.ts","./src/auth/index.ts","./src/auth/types.ts","./src/captcha/index.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/failing-line.ts","./src/reporter/uploader.ts","./src/reporter/util.ts","./src/test/constants.ts","./src/test/index.ts","./src/test/types.ts","./src/test/video-labels.ts","./src/test/expect/index.ts","./src/test/expect/types.ts","./src/test/expect/visual.ts","./src/test/expect/webhook.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"}

package/dist/captcha/vision.d.ts

@@ -1,3 +0,0 @@
-import type { Page } from "playwright-core";
-export declare function solveRecaptcha(page: Page): Promise<void>;
-//# sourceMappingURL=vision.d.ts.map

package/dist/captcha/vision.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"vision.d.ts","sourceRoot":"","sources":["../../src/captcha/vision.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAkB,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAyE5D,wBAAsB,cAAc,CAAC,IAAI,EAAE,IAAI,iBAiB9C"}

package/dist/captcha/vision.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.solveRecaptcha = solveRecaptcha;
-const vision_1 = require("@empiricalrun/llm/vision");
-const RECAPTCHA_FRAME_URL = "https://www.google.com/recaptcha/api2";
-const MAX_ATTEMPTS = 5;
-async function isVisible(locator) {
-    const isVisibleAccordingToPlaywright = await locator.isVisible();
-    if (isVisibleAccordingToPlaywright) {
-        const bbox = await locator.boundingBox();
-        const isValidBbox = !!bbox && bbox.width > 0 && bbox.height > 0 && bbox.x > 0 && bbox.y > 0;
-        return isValidBbox;
-    }
-    return false;
-}
-async function isVerifyCaptchaVisible(page) {
-    const frames = page.frames();
-    for (const frame of frames) {
-        if (frame.url().includes(RECAPTCHA_FRAME_URL)) {
-            if (await isVisible(frame.getByText("Select all images"))) {
-                return { frame, type: "images" };
-            }
-            else if (await isVisible(frame.getByText("Select all squares"))) {
-                return { frame, type: "squares" };
-            }
-        }
-    }
-}
-async function getObjectiveCaptcha(capFrame) {
-    const { frame, type } = capFrame;
-    const text = await frame.getByText(`Select all ${type}`).textContent();
-    return text
-        ?.replace(`Select all ${type} with`, "")
-        .replace(`Click verify once there are none left`, "")
-        .replace(`If there are none, click skip`, "")
-        .trim();
-}
-async function clickImageTile(frame, nth) {
-    const image = frame.locator(".rc-imageselect-tile").nth(nth);
-    await image.dispatchEvent("click");
-}
-async function handleCaptcha(cf) {
-    const screenshot = await cf.frame
-        .locator(".rc-imageselect-challenge")
-        .screenshot();
-    const gridBoxesToSelect = await (0, vision_1.solveRecaptchaGrid)({
-        captchaType: cf.type,
-        captchaObject: (await getObjectiveCaptcha(cf)),
-        screenshotBase64: screenshot.toString("base64"),
-    });
-    for (const n of gridBoxesToSelect) {
-        await clickImageTile(cf.frame, n - 1);
-    }
-    const verifyButton = cf.frame.getByRole("button", { name: "Verify" });
-    const nextButton = cf.frame.getByRole("button", { name: "Next" });
-    if (await isVisible(verifyButton)) {
-        await verifyButton.dispatchEvent("click");
-    }
-    else if (await isVisible(nextButton)) {
-        await nextButton.dispatchEvent("click");
-    }
-    await cf.frame.waitForTimeout(3000);
-}
-async function solveRecaptcha(page) {
-    const frame = page.frameLocator('iframe[title="reCAPTCHA"]');
-    await frame.getByLabel("not a robot").click();
-    await page.waitForTimeout(2000);
-    for (let i = 0; i < MAX_ATTEMPTS; i++) {
-        const cf = await isVerifyCaptchaVisible(page);
-        if (cf) {
-            await handleCaptcha(cf);
-        }
-        else {
-            break;
-        }
-        if (i === MAX_ATTEMPTS - 1) {
-            if (await isVerifyCaptchaVisible(page)) {
-                throw new Error(`Failed to solve captcha in ${MAX_ATTEMPTS} attempts.`);
-            }
-        }
-    }
-}