@empiricalrun/playwright-utils 0.65.0 → 0.66.0

package/dist/reporter/util.js

@@ -22,6 +22,7 @@ const mime_1 = __importDefault(require("mime"));
 const path_1 = __importDefault(require("path"));
 const api_worker_client_1 = require("../api-worker-client");
 const logger_1 = require("../logger");
+const attachment_key_1 = require("./attachment-key");
 // Mirrors https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/tools/cli-client/program.ts#L440
 function calculateSha1(buffer) {
     const hash = crypto_1.default.createHash("sha1");
@@ -173,8 +174,8 @@ async function sendTestCaseBeginToDashboard(params) {
 function safelySerialiseJSON(obj, keyFilter) {
     return JSON.parse(JSON.stringify(obj, (key, value) => (keyFilter?.(key) ? undefined : value)));
 }
-async function updateHtmlZipFileAttachmentPaths(jsonFilePath, htmlFilePath, repoPath) {
-    const testAttachmentMap = buildTestAttachmentMapFromSummary(jsonFilePath, repoPath);
+async function updateHtmlZipFileAttachmentPaths(jsonFilePath, htmlFilePath, outputDirs) {
+    const testAttachmentMap = buildTestAttachmentMapFromSummary(jsonFilePath, outputDirs);
     let htmlFile;
     try {
         htmlFile = await fs_1.default.promises.readFile(htmlFilePath, "utf8");
@@ -232,7 +233,7 @@ async function updateHtmlZipFileAttachmentPaths(jsonFilePath, htmlFilePath, repo
     finally {
     }
 }
-function buildTestAttachmentMapFromSummary(summaryJsonFilePath, repoPath, doNotNormalize = false) {
+function buildTestAttachmentMapFromSummary(summaryJsonFilePath, outputDirs, doNotNormalize = false) {
     const summaryJson = JSON.parse(fs_1.default.readFileSync(summaryJsonFilePath, "utf8"));
     return (0, reporter_1.buildTestAttachmentMap)(summaryJson, {
         transformAttachment: doNotNormalize
@@ -241,8 +242,10 @@ function buildTestAttachmentMapFromSummary(summaryJsonFilePath, repoPath, doNotN
                 if (!attachment?.path) {
                     return attachment;
                 }
-                const relativePath = path_1.default.relative(repoPath, attachment.path);
-                return { ...attachment, path: path_1.default.join("data", relativePath) };
+                return {
+                    ...attachment,
+                    path: path_1.default.join("data", (0, attachment_key_1.attachmentKey)(attachment.path, outputDirs)),
+                };
             },
     });
 }
@@ -255,7 +258,7 @@ async function checkFileExistsAsync(filePath) {
         return false;
     }
 }
-async function updateSummaryJsonAttachmentPaths(filePath, repoPath, urlPrefix) {
+async function updateSummaryJsonAttachmentPaths(filePath, outputDirs, urlPrefix) {
     if (!process.env.PROJECT_NAME || !process.env.TEST_RUN_GITHUB_ACTION_ID) {
         console.error("PROJECT_NAME and TEST_RUN_GITHUB_ACTION_ID must be set");
         return;
@@ -266,8 +269,7 @@ async function updateSummaryJsonAttachmentPaths(filePath, repoPath, urlPrefix) {
             for (const result of test.results || []) {
                 for (const attachment of result.attachments || []) {
                     if (attachment?.path) {
-                        const relativePath = path_1.default.relative(repoPath, attachment.path);
-                        attachment.path = `${urlPrefix}/${relativePath}`;
+                        attachment.path = `${urlPrefix}/${(0, attachment_key_1.attachmentKey)(attachment.path, outputDirs)}`;
                     }
                 }
             }

package/dist/test/cross-shard-locks.d.ts

@@ -0,0 +1,22 @@
+import { type TestLocksByTestId } from "@empiricalrun/shared-types/playwright-utils";
+import type { TestInfo } from "@playwright/test";
+import { type KVClient } from "../kv";
+type LockKv = Pick<KVClient, "set" | "refresh" | "delete">;
+export declare const LOCK_LEASE_SECONDS = 60;
+export declare function lockNamesFor(testId: string, locks?: TestLocksByTestId): string[];
+export declare function lockKey(runId: string, name: string): string;
+export declare function holdLocks({ kv, runId, names, holder, annotate, now, sleep, }: {
+    kv: LockKv;
+    runId: string;
+    names: string[];
+    holder: unknown;
+    annotate: (annotation: {
+        type: string;
+        description: string;
+    }) => void;
+    now?: () => number;
+    sleep?: (ms: number) => Promise<void>;
+}): Promise<() => Promise<void>>;
+export declare function holdCrossShardLocks(testInfo: TestInfo, createKv: () => LockKv): Promise<() => Promise<void>>;
+export {};
+//# sourceMappingURL=cross-shard-locks.d.ts.map

package/dist/test/cross-shard-locks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cross-shard-locks.d.ts","sourceRoot":"","sources":["../../src/test/cross-shard-locks.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,iBAAiB,EACvB,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,KAAK,QAAQ,EAA6B,MAAM,OAAO,CAAC;AAEjE,KAAK,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,GAAG,QAAQ,CAAC,CAAC;AAI3D,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAkBrC,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,iBACa,GACnB,MAAM,EAAE,CAEV;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI3D;AAuBD,wBAAsB,SAAS,CAAC,EAC9B,EAAE,EACF,KAAK,EACL,KAAK,EACL,MAAM,EACN,QAAQ,EACR,GAAc,EACd,KAAiE,GAClE,EAAE;IACD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,CAAC,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IACtE,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvC,GAAG,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CA6C/B;AAED,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,MAAM,MAAM,GACrB,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAmB9B"}

package/dist/test/cross-shard-locks.js

@@ -0,0 +1,110 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOCK_LEASE_SECONDS = void 0;
+exports.lockNamesFor = lockNamesFor;
+exports.lockKey = lockKey;
+exports.holdLocks = holdLocks;
+exports.holdCrossShardLocks = holdCrossShardLocks;
+const node_crypto_1 = require("node:crypto");
+const node_fs_1 = __importDefault(require("node:fs"));
+const playwright_utils_1 = require("@empiricalrun/shared-types/playwright-utils");
+const kv_1 = require("../kv");
+exports.LOCK_LEASE_SECONDS = 60;
+const RENEW_EVERY_MS = 20_000;
+const MAX_POLL_MS = 2_000;
+let sharedLocks;
+function readSharedLocks() {
+    const file = process.env[playwright_utils_1.TEST_LOCKS_FILE_ENV];
+    if (!file) {
+        return {};
+    }
+    try {
+        return JSON.parse(node_fs_1.default.readFileSync(file, "utf-8"));
+    }
+    catch {
+        return {};
+    }
+}
+function lockNamesFor(testId, locks = (sharedLocks ??=
+    readSharedLocks())) {
+    return [...new Set(locks[testId] ?? [])].sort();
+}
+function lockKey(runId, name) {
+    const readable = name.replace(/[^A-Za-z0-9._-]/g, "_").slice(0, 200);
+    const digest = (0, node_crypto_1.createHash)("sha256").update(name).digest("hex").slice(0, 12);
+    return `pw-lock:${runId}:${readable}:${digest}`;
+}
+async function acquire(kv, key, holder, sleep) {
+    for (let attempt = 0;; attempt++) {
+        try {
+            const entry = await kv.set(key, holder, exports.LOCK_LEASE_SECONDS, {
+                ifAbsent: true,
+            });
+            return entry.version;
+        }
+        catch (error) {
+            if (!(error instanceof kv_1.KvPreconditionFailedError)) {
+                throw error;
+            }
+            await sleep(Math.min(MAX_POLL_MS, 250 * 2 ** attempt));
+        }
+    }
+}
+async function holdLocks({ kv, runId, names, holder, annotate, now = Date.now, sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)), }) {
+    const held = [];
+    for (const name of names) {
+        const key = lockKey(runId, name);
+        const startedAt = now();
+        const version = await acquire(kv, key, holder, sleep);
+        held.push({ name, key, version });
+        annotate({
+            type: "lock",
+            description: `${name}: waited ${Math.round((now() - startedAt) / 1000)}s across shards`,
+        });
+    }
+    const leaseLost = (lock) => annotate({ type: "lock", description: `${lock.name}: lease lost` });
+    let renewing = Promise.resolve();
+    const renewal = setInterval(() => {
+        renewing = Promise.allSettled(held.map((lock) => kv
+            .refresh(lock.key, exports.LOCK_LEASE_SECONDS, { ifVersion: lock.version })
+            .then((entry) => {
+            if (entry) {
+                lock.version = entry.version;
+            }
+            else {
+                leaseLost(lock);
+            }
+        }, () => leaseLost(lock))));
+    }, RENEW_EVERY_MS);
+    renewal.unref();
+    return async () => {
+        clearInterval(renewal);
+        await renewing;
+        await Promise.allSettled(held
+            .reverse()
+            .map((lock) => kv.delete(lock.key, { ifVersion: lock.version })));
+    };
+}
+async function holdCrossShardLocks(testInfo, createKv) {
+    const names = lockNamesFor(testInfo.testId);
+    const runId = process.env.TEST_RUN_GITHUB_ACTION_ID;
+    if (names.length === 0 || !runId || !process.env.EMPIRICALRUN_API_KEY) {
+        return async () => { };
+    }
+    return holdLocks({
+        kv: createKv(),
+        runId,
+        names,
+        holder: {
+            test_id: testInfo.testId,
+            title: testInfo.titlePath.join(" › "),
+            retry: testInfo.retry,
+            shard: testInfo.config.shard?.current ?? null,
+            worker_index: testInfo.workerIndex,
+        },
+        annotate: (annotation) => testInfo.annotations.push(annotation),
+    });
+}

package/dist/test/expect/visual.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"visual.d.ts","sourceRoot":"","sources":["../../../src/test/expect/visual.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAY,MAAM,kBAAkB,CAAC;AAOhE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAgE7C,wBAAsB,WAAW,CAC/B,MAAM,EAAE,IAAI,GAAG,OAAO,EACtB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,aAAa,CAAC,CAsFxB"}
+{"version":3,"file":"visual.d.ts","sourceRoot":"","sources":["../../../src/test/expect/visual.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAY,MAAM,kBAAkB,CAAC;AAOhE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAsE7C,wBAAsB,WAAW,CAC/B,MAAM,EAAE,IAAI,GAAG,OAAO,EACtB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,aAAa,CAAC,CAsFxB"}

package/dist/test/expect/visual.js

@@ -4,13 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toLookRight = toLookRight;
-const vision_1 = require("@empiricalrun/llm/vision");
 const fs_1 = __importDefault(require("fs"));
 const openai_1 = __importDefault(require("openai"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const api_worker_client_1 = require("../../api-worker-client");
 const telemetry_1 = require("../../telemetry");
+function asImageDataUrl(image) {
+    return image.startsWith("data:image")
+        ? image
+        : `data:image/png;base64,${image}`;
+}
 function getCallerLine() {
     const stack = new Error().stack;
     if (!stack) {
@@ -91,7 +95,7 @@ async function toLookRight(target, pageDescription) {
                     {
                         type: "image_url",
                         image_url: {
-                            url: (0, vision_1.imageFormatForProvider)("anthropic", base64Image),
+                            url: asImageDataUrl(base64Image),
                         },
                     },
                 ],

package/dist/test/index.d.ts

@@ -21,6 +21,7 @@ type TestOptions = {
         page: Page;
     }>;
     saveVideos: void;
+    crossShardLocks: void;
 };
 declare const baseTestFixture: (testFn: TestType<PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>, options?: BaseTestFixtureOpts) => TestType<PlaywrightTestArgs & PlaywrightTestOptions & TestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 export { baseTestFixture, extendExpect, injectLocatorHighlightScripts, setVideoLabel, };

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,MAAM,EACN,IAAI,EACJ,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAGL,KAAK,qBAAqB,EAC3B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAA8B,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE3E,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,cAAc,CAAC;QACvB,UAAU,QAAQ,CAAC,CAAC;YAClB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC7C,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;SACnE;KACF;CACF;AAED,QAAA,MAAM,YAAY,mBAA6B,OAAO,MAAM,0CAG3D,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,EAAE,EAAE,QAAQ,CAAC;IACb,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,QAAA,MAAM,eAAe,WACX,QAAQ,CACd,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,YACQ,mBAAmB,uHA6G7B,CAAC;AAEF,OAAO,EACL,eAAe,EACf,YAAY,EACZ,6BAA6B,EAC7B,aAAa,GACd,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,MAAM,EACN,IAAI,EACJ,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAGjC,OAAO,EAGL,KAAK,qBAAqB,EAC3B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAA8B,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE3E,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,cAAc,CAAC;QACvB,UAAU,QAAQ,CAAC,CAAC;YAClB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC7C,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;SACnE;KACF;CACF;AAED,QAAA,MAAM,YAAY,mBAA6B,OAAO,MAAM,0CAG3D,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,EAAE,EAAE,QAAQ,CAAC;IACb,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;IACjB,eAAe,EAAE,IAAI,CAAC;CACvB,CAAC;AAIF,QAAA,MAAM,eAAe,WACX,QAAQ,CACd,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,YACQ,mBAAmB,uHA2H7B,CAAC;AAEF,OAAO,EACL,eAAe,EACf,YAAY,EACZ,6BAA6B,EAC7B,aAAa,GACd,CAAC"}

package/dist/test/index.js

@@ -7,6 +7,7 @@ exports.setVideoLabel = exports.injectLocatorHighlightScripts = exports.extendEx
 const path_1 = __importDefault(require("path"));
 const kv_1 = require("../kv");
 const coverage_1 = require("./coverage");
+const cross_shard_locks_1 = require("./cross-shard-locks");
 const expect_1 = require("./expect");
 const scripts_1 = require("./scripts");
 Object.defineProperty(exports, "injectLocatorHighlightScripts", { enumerable: true, get: function () { return scripts_1.injectLocatorHighlightScripts; } });
@@ -112,6 +113,18 @@ const baseTestFixture = function (testFn, options = {}) {
             },
             { auto: true },
         ],
+        crossShardLocks: [
+            async ({}, use, testInfo) => {
+                const release = await (0, cross_shard_locks_1.holdCrossShardLocks)(testInfo, () => new kv_1.KVClient());
+                try {
+                    await use();
+                }
+                finally {
+                    await release();
+                }
+            },
+            { auto: true, timeout: 0 },
+        ],
     });
     return extendedTestFn;
 };

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":"AAAA,OAAO,EACL,KAAK,SAAS,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAIxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAW9C,wBAAgB,gBAAgB,IAAI,SAAS,CAI5C;AAED,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,WAKhE;AAED,qBAAa,mBAAmB;IAOlB,OAAO,CAAC,QAAQ,CAAC,IAAI;IANjC,OAAO,CAAC,iBAAiB,CAIhB;IAET,YAA6B,IAAI,EAAE,IAAI,EAAI;IAErC,WAAW,kBAIhB;IAEK,GAAG,CACP,aAAa,EAAE,GAAG,EAClB,QAAQ,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,EACvC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC,CAUf;YAEa,OAAO;YAwDP,QAAQ;CAkCvB;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":"AAAA,OAAO,EACL,KAAK,SAAS,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAIxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAU9C,wBAAgB,gBAAgB,IAAI,SAAS,CAI5C;AAED,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,WAKhE;AAED,qBAAa,mBAAmB;IAOlB,OAAO,CAAC,QAAQ,CAAC,IAAI;IANjC,OAAO,CAAC,iBAAiB,CAIhB;IAET,YAA6B,IAAI,EAAE,IAAI,EAAI;IAErC,WAAW,kBAIhB;IAEK,GAAG,CACP,aAAa,EAAE,GAAG,EAClB,QAAQ,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,EACvC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC,CAUf;YAEa,OAAO;YAwDP,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

@@ -91,11 +91,9 @@ class OverlayDismissAgent {
     }
     async runAgent(element, text, testFn) {
         const task = await (0, prompt_1.getTask)(this.page, element, text);
-        const trace = (0, utils_1.traceThis)(task, testFn);
         const result = await testFn.step(utils_1.DISMISSAL_AGENT_STEP, () => (0, cua_1.createTestUsingComputerUseAgent)({
             page: this.page,
             task,
-            trace,
             // We don't want to use page.pause approach here because
             // overlay dismissal can kick in during a browser agent tool call
             // and we need app to be able to use page.pause for agent actions.

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

@@ -8,5 +8,4 @@ export declare function dismissOverlayStepTitle(element: OverlayElement | undefi
 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, testFn: TestFn): 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":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,sBASrE;AAED,eAAO,MAAM,oBAAoB,oBAAoB,CAAC;AACtD,eAAO,MAAM,oBAAoB,gCAAgC,CAAC;AAElE,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,UAO1E;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,uBAKzE;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,IAAI,EACb,OAAO,EAAE,cAAc,GAAG,SAAS,+BAgDpC;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,QAMpE;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,uDAiBrD"}
+{"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,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,sBASrE;AAED,eAAO,MAAM,oBAAoB,oBAAoB,CAAC;AACtD,eAAO,MAAM,oBAAoB,gCAAgC,CAAC;AAElE,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,UAO1E;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,uBAKzE;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,IAAI,EACb,OAAO,EAAE,cAAc,GAAG,SAAS,+BAgDpC;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,QAMpE"}

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

@@ -6,8 +6,6 @@ exports.dismissOverlayStepTitle = dismissOverlayStepTitle;
 exports.isProductFruitsOverlay = isProductFruitsOverlay;
 exports.textContent = textContent;
 exports.annotateForReport = annotateForReport;
-exports.traceThis = traceThis;
-const llm_1 = require("@empiricalrun/llm");
 function overlayDescription(element) {
     if (element) {
         const { interceptor, parent } = element;
@@ -85,21 +83,3 @@ function annotateForReport(testFn, description) {
         description,
     });
 }
-function traceThis(task, testFn) {
-    const metadata = {
-        projectName: process.env.PROJECT_NAME ?? "",
-        testRunId: process.env.TEST_RUN_GITHUB_ACTION_ID ?? "",
-        testCase: testFn.info().title,
-    };
-    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;
-}

package/dist/test/scripts/pw-locator-patch/vision/query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/vision/query.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAIhD,wBAAgB,UAAU,CAAC,YAAY,EAAE,QAAQ,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QASzE"}
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../../../src/test/scripts/pw-locator-patch/vision/query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAiEhD,wBAAgB,UAAU,CAAC,YAAY,EAAE,QAAQ,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAMzE"}

package/dist/test/scripts/pw-locator-patch/vision/query.js

@@ -1,15 +1,67 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchQuery = patchQuery;
-const vision_1 = require("@empiricalrun/llm/vision");
+const openai_1 = __importDefault(require("openai"));
 const api_worker_client_1 = require("../../../../api-worker-client");
+const telemetry_1 = require("../../../../telemetry");
+const QUERY_MODEL = "gpt-4o-mini";
+const SYSTEM_PROMPT = `
+You are given an image and an instruction. Use the "explanation" to
+think it through, and then respond with the "answer".`;
+async function queryScreenshot(base64Image, instruction) {
+    const openai = new openai_1.default({ maxRetries: 5, ...(0, api_worker_client_1.llmProxyOpenAIConfig)() });
+    const completion = await openai.chat.completions.create({
+        model: QUERY_MODEL,
+        messages: [
+            { role: "system", content: SYSTEM_PROMPT },
+            {
+                role: "user",
+                content: [
+                    {
+                        type: "image_url",
+                        image_url: { url: `data:image/png;base64,${base64Image}` },
+                    },
+                    { type: "text", text: `Instruction: ${instruction}` },
+                ],
+            },
+        ],
+        temperature: 0.5,
+        response_format: {
+            type: "json_schema",
+            json_schema: {
+                name: "your_response",
+                strict: true,
+                schema: {
+                    type: "object",
+                    properties: {
+                        explanation: { type: "string" },
+                        answer: { type: "string" },
+                    },
+                    required: ["explanation", "answer"],
+                    additionalProperties: false,
+                },
+            },
+        },
+    });
+    await (0, telemetry_1.trackLLMResponseGenerated)({
+        modelName: QUERY_MODEL,
+        tokensInput: completion.usage?.prompt_tokens ?? 0,
+        tokensOutput: completion.usage?.completion_tokens ?? 0,
+        chatSessionSource: "vision_query",
+    });
+    const content = completion.choices[0]?.message?.content;
+    if (!content) {
+        throw new Error("Query failed: no response content from LLM.");
+    }
+    return JSON.parse(content).answer;
+}
 function patchQuery(LocatorClass) {
     LocatorClass.prototype.query = async function (instruction) {
         await this.waitFor({ state: "visible" });
         const screenshot = await this.screenshot();
-        const answer = await (0, vision_1.query)(screenshot.toString("base64"), instruction, {
-            clientConfig: (0, api_worker_client_1.llmProxyOpenAIConfig)(),
-        });
-        return answer;
+        return queryScreenshot(screenshot.toString("base64"), instruction);
     };
 }

package/docs/kv.md

@@ -1,6 +1,8 @@
 # KV Store
 
-A simple key-value store for sharing data across test runs.
+A project-scoped key-value store for sharing state across tests, shards, test
+runs and agent sessions. Every entry expires, and conditional writes make it
+safe to coordinate between parallel shards.
 
 ## Fixture usage
 
@@ -17,10 +19,72 @@ test("example", async ({ page, kv }) => {
 import { KVClient } from "@empiricalrun/playwright-utils";
 
 const kv = new KVClient();
-await kv.set("my-key", { some: "data" }, 3600); // ttl in seconds, max 2 days
+await kv.set("my-key", { some: "data" }, 3600);
 const value = await kv.get<{ some: string }>("my-key");
 ```
 
+## Keys, values and expiry
+
+- Keys are 1-512 characters from `A-Z a-z 0-9 . _ : -`. Use `:` to namespace
+  them, e.g. `async-checks:analytics:1234`.
+- Values are any JSON value, up to 1 MB serialized.
+- `ttl` is required, in seconds, up to 30 days.
+
+## Entries and versions
+
+`getEntry` returns the value with its metadata. `version` increases on every
+write.
+
+```ts
+const entry = await kv.getEntry("my-key");
+// { key, value, version, expires_at, created_at, updated_at, written_by }
+```
+
+## Conditional writes
+
+`set` with `ifAbsent` writes only if the key does not exist; `ifVersion` writes
+only if the entry is still at that version. A failed condition throws
+`KvPreconditionFailedError`, whose `current` is the entry as it is now.
+
+```ts
+import { KvPreconditionFailedError } from "@empiricalrun/playwright-utils";
+
+try {
+  const lease = await kv.set("lock:checkout", testInfo.testId, 60, {
+    ifAbsent: true,
+  });
+  await kv.refresh("lock:checkout", 60, { ifVersion: lease.version });
+} catch (error) {
+  if (error instanceof KvPreconditionFailedError) {
+    console.log("held by", error.current?.value);
+  }
+}
+```
+
+## Refresh, delete and list
+
+```ts
+await kv.refresh("my-key", 600);
+await kv.delete("my-key", { ifVersion: 3 });
+
+const page = await kv.list({ prefix: "async-checks:" });
+for await (const entry of kv.entries("async-checks:")) {
+  console.log(entry.key, entry.value);
+}
+```
+
+`refresh` returns `null` and `delete` returns `false` when the key does not
+exist. `list` returns metadata only; `entries` pages through every entry with
+its value.
+
+## Locks across shards
+
+Tests declared with Playwright's `lock` option (`test("...", { lock: "name" }, ...)`)
+also hold that lock across every shard of an Empirical test run. The
+`baseTestFixture` fixtures take a KV lease per lock name while the test runs and
+add a `lock` annotation with the time spent waiting. Locks are scoped to the
+test run.
+
 ## Requirements
 
 - `EMPIRICALRUN_API_KEY` environment variable must be set

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.65.0",
+  "version": "0.66.0",
   "engines": {
     "node": ">=22"
   },
@@ -45,7 +45,7 @@
     "playwright-core": "1.63.0",
     "serve-handler": "^6.1.6",
     "typescript": "7.0.2",
-    "@empiricalrun/shared-types": "0.23.0"
+    "@empiricalrun/shared-types": "0.23.2"
   },
   "dependencies": {
     "async-retry": "^1.3.3",
@@ -56,10 +56,9 @@
     "openapi-fetch": "0.14.1",
     "puppeteer-extra-plugin-recaptcha": "^3.6.8",
     "ts-morph": "^28.0.0",
-    "@empiricalrun/cua": "^0.5.4",
-    "@empiricalrun/llm": "^0.28.3",
     "@empiricalrun/r2-uploader": "^0.11.5",
-    "@empiricalrun/reporter": "^0.30.3"
+    "@empiricalrun/reporter": "^0.30.3",
+    "@empiricalrun/cua": "^0.6.0"
   },
   "scripts": {
     "dev": "pnpm gen:api-worker-openapi && tsc --build --watch",