@empiricalrun/playwright-utils 0.65.1 → 0.66.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @empiricalrun/playwright-utils
 
+## 0.66.1
+
+### Patch Changes
+
+- 1598d3d: Fix `@empiricalrun/playwright-utils/test` failing to load with "Cannot find module '@empiricalrun/shared-types/playwright-utils'"
+  - @empiricalrun/cua@0.6.0
+  - @empiricalrun/reporter@0.30.3
+
+## 0.66.0
+
+### Minor Changes
+
+- 53ed84b: `baseTestFixture` holds Playwright `lock` names across every shard of an Empirical test run, using a KV lease per lock with a `lock` annotation for time spent waiting
+- 3ab73d4: `KVClient` uses the `/api/kv` API: `getEntry`, conditional `set` (`ifAbsent`, `ifVersion`) with `KvPreconditionFailedError`, `refresh`, `delete`, `list` and `entries`. Keys are limited to `A-Z a-z 0-9 . _ : -`, values to 1 MB and TTLs to 30 days.
+
 ## 0.65.1
 
 ### Patch Changes

package/dist/api-worker-client.d.ts

@@ -6,9 +6,22 @@ export type ProviderProxyRequest = components["schemas"]["PlaywrightUtilsProxyRe
 export type ProviderProxyResponse = components["schemas"]["PlaywrightUtilsProxyResponse"];
 export type TwoCaptchaProxyRequest = components["schemas"]["TwoCaptchaProxyRequest"];
 export type TwoCaptchaProxyResponse = components["schemas"]["TwoCaptchaProxyResponse"];
-export type ProjectKvGetResponse = components["schemas"]["ProjectKvGetResponse"];
-export type ProjectKvSetRequest = NonNullable<paths["/api/projects/kv"]["post"]["requestBody"]>["content"]["application/json"];
-export type ProjectKvSetResponse = components["schemas"]["ProjectKvSetResponse"];
+export type KvEntryRecord = components["schemas"]["KvEntry"];
+export type KvListQuery = NonNullable<paths["/api/kv"]["get"]["parameters"]["query"]>;
+export type KvListPageRecord = components["schemas"]["KvListResponse"]["data"];
+export type KvPutBody = components["schemas"]["PutKvEntryRequest"];
+export type KvWriteCondition = {
+    ifAbsent: true;
+} | {
+    ifVersion: number;
+};
+export type KvConditionalResult<T> = {
+    ok: true;
+    value: T;
+} | {
+    ok: false;
+    current: KvEntryRecord | null;
+};
 export type TelemetryTrackRequest = components["schemas"]["TelemetryTrackRequest"];
 export type TestCaseRunEndEventRequest = NonNullable<paths["/api/test-runs/events"]["put"]["requestBody"]>["content"]["application/json"];
 export type TestReportUploadUrlsRequest = components["schemas"]["CreateTestReportUploadUrlsRequest"];
@@ -26,7 +39,9 @@ export declare class NonRetryableHTTPError extends HTTPError {
 }
 export declare class RetryableHTTPError extends HTTPError {
 }
-export declare function fetchWithRetry(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+export declare function fetchWithRetry(input: RequestInfo | URL, init?: RequestInit, { acceptStatuses }?: {
+    acceptStatuses?: readonly number[];
+}): Promise<Response>;
 export declare class ApiWorkerClient {
     private baseUrl;
     readonly client: OpenApiWorkerClient;
@@ -35,8 +50,12 @@ export declare class ApiWorkerClient {
         baseUrl?: string;
     });
     getBaseUrl(): string;
-    getProjectKv(key: string): Promise<ProjectKvGetResponse>;
-    setProjectKv(body: ProjectKvSetRequest): Promise<ProjectKvSetResponse>;
+    getKvEntry(key: string): Promise<KvEntryRecord | null>;
+    listKvEntries(query: KvListQuery): Promise<KvListPageRecord>;
+    putKvEntry(key: string, body: KvPutBody, condition?: KvWriteCondition): Promise<KvConditionalResult<KvEntryRecord>>;
+    refreshKvEntry(key: string, ttl: number, ifVersion?: number): Promise<KvConditionalResult<KvEntryRecord> | null>;
+    deleteKvEntry(key: string, ifVersion?: number): Promise<KvConditionalResult<boolean>>;
+    private conditional;
     postProviderProxy(path: ProviderProxyPath, body: ProviderProxyRequest): Promise<ProviderProxyResponse>;
     putTestCaseRunEndEvent(body: TestCaseRunEndEventRequest): Promise<void>;
     putTestCaseRunBeginEvent(body: TestCaseRunBeginEventRequest): Promise<void>;

package/dist/api-worker-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-worker-client.d.ts","sourceRoot":"","sources":["../src/api-worker-client.ts"],"names":[],"mappings":"AACA,OAAqB,EAAE,KAAK,MAAM,EAAE,MAAM,eAAe,CAAC;AAE1D,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAC;AAExE,KAAK,mBAAmB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAEzC,KAAK,iBAAiB,GAClB,kBAAkB,GAClB,sBAAsB,GACtB,yBAAyB,CAAC;AAE9B,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,CAAC;AACvD,MAAM,MAAM,qBAAqB,GAC/B,UAAU,CAAC,SAAS,CAAC,CAAC,8BAA8B,CAAC,CAAC;AACxD,MAAM,MAAM,sBAAsB,GAChC,UAAU,CAAC,SAAS,CAAC,CAAC,wBAAwB,CAAC,CAAC;AAClD,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AACnD,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;AAChD,MAAM,MAAM,mBAAmB,GAAG,WAAW,CAC3C,KAAK,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CACjD,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AACjC,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;AAChD,MAAM,MAAM,qBAAqB,GAC/B,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;AACjD,MAAM,MAAM,0BAA0B,GAAG,WAAW,CAClD,KAAK,CAAC,uBAAuB,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CACrD,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AACjC,MAAM,MAAM,2BAA2B,GACrC,UAAU,CAAC,SAAS,CAAC,CAAC,mCAAmC,CAAC,CAAC;AAC7D,MAAM,MAAM,4BAA4B,GACtC,UAAU,CAAC,SAAS,CAAC,CAAC,oCAAoC,CAAC,CAAC;AAC9D,MAAM,MAAM,4BAA4B,GAAG,WAAW,CACpD,KAAK,CAAC,6BAA6B,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAC3D,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAQjC,wBAAgB,oBAAoB,IAChC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACnC,SAAS,CAgBZ;AAED,qBAAa,SAAU,SAAQ,KAAK;IAClC,MAAM,EAAE,MAAM,CAAC;IAEf,YAAY,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAG1C;CACF;AAED,qBAAa,qBAAsB,SAAQ,SAAS;CAAG;AACvD,qBAAa,kBAAmB,SAAQ,SAAS;CAAG;AASpD,wBAAsB,cAAc,CAClC,KAAK,EAAE,WAAW,GAAG,GAAG,EACxB,IAAI,CAAC,EAAE,WAAW,qBAoCnB;AAgBD,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAErC,YAAY,EACV,aAAa,EACb,OAAO,GACR,GAAE;QACD,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,CAAC;KACb,EAgBL;IAED,UAAU,IAAI,MAAM,CAEnB;IAEK,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAK7D;IAEK,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAK3E;IAEK,iBAAiB,CACrB,IAAI,EAAE,iBAAiB,EACvB,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,qBAAqB,CAAC,CAKhC;IAEK,sBAAsB,CAC1B,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,IAAI,CAAC,CAGf;IAEK,wBAAwB,CAC5B,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,IAAI,CAAC,CAKf;IAEK,0BAA0B,CAC9B,IAAI,EAAE,2BAA2B,GAChC,OAAO,CAAC,4BAA4B,CAAC,CAKvC;IAED,MAAM,CAAC,CAAC,EACN,MAAM,EAAE;QACN,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,EAAE,QAAQ,CAAC;KACpB,EACD,KAAK,EAAE,MAAM,GACZ,CAAC,CAUH;CACF"}
+{"version":3,"file":"api-worker-client.d.ts","sourceRoot":"","sources":["../src/api-worker-client.ts"],"names":[],"mappings":"AACA,OAAqB,EAAE,KAAK,MAAM,EAAE,MAAM,eAAe,CAAC;AAE1D,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAC;AAExE,KAAK,mBAAmB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAEzC,KAAK,iBAAiB,GAClB,kBAAkB,GAClB,sBAAsB,GACtB,yBAAyB,CAAC;AAE9B,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,CAAC;AACvD,MAAM,MAAM,qBAAqB,GAC/B,UAAU,CAAC,SAAS,CAAC,CAAC,8BAA8B,CAAC,CAAC;AACxD,MAAM,MAAM,sBAAsB,GAChC,UAAU,CAAC,SAAS,CAAC,CAAC,wBAAwB,CAAC,CAAC;AAClD,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AACnD,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AAC7D,MAAM,MAAM,WAAW,GAAG,WAAW,CACnC,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAC/C,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC/E,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;AACnE,MAAM,MAAM,gBAAgB,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC;AAC1E,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAC7B;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GACtB;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAA;CAAE,CAAC;AACjD,MAAM,MAAM,qBAAqB,GAC/B,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;AACjD,MAAM,MAAM,0BAA0B,GAAG,WAAW,CAClD,KAAK,CAAC,uBAAuB,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CACrD,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AACjC,MAAM,MAAM,2BAA2B,GACrC,UAAU,CAAC,SAAS,CAAC,CAAC,mCAAmC,CAAC,CAAC;AAC7D,MAAM,MAAM,4BAA4B,GACtC,UAAU,CAAC,SAAS,CAAC,CAAC,oCAAoC,CAAC,CAAC;AAC9D,MAAM,MAAM,4BAA4B,GAAG,WAAW,CACpD,KAAK,CAAC,6BAA6B,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAC3D,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAQjC,wBAAgB,oBAAoB,IAChC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACnC,SAAS,CAgBZ;AAED,qBAAa,SAAU,SAAQ,KAAK;IAClC,MAAM,EAAE,MAAM,CAAC;IAEf,YAAY,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAG1C;CACF;AAED,qBAAa,qBAAsB,SAAQ,SAAS;CAAG;AACvD,qBAAa,kBAAmB,SAAQ,SAAS;CAAG;AASpD,wBAAsB,cAAc,CAClC,KAAK,EAAE,WAAW,GAAG,GAAG,EACxB,IAAI,CAAC,EAAE,WAAW,EAClB,EAAE,cAAmB,EAAE,GAAE;IAAE,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAAO,qBAoCrE;AA0CD,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAErC,YAAY,EACV,aAAa,EACb,OAAO,GACR,GAAE;QACD,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,CAAC;KACb,EAgBL;IAED,UAAU,IAAI,MAAM,CAEnB;IAEK,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAY3D;IAEK,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAKjE;IAEK,UAAU,CACd,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,SAAS,EACf,SAAS,CAAC,EAAE,gBAAgB,GAC3B,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAO7C;IAEK,cAAc,CAClB,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAUpD;IAEK,aAAa,CACjB,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAevC;IAED,OAAO,CAAC,WAAW;IAcb,iBAAiB,CACrB,IAAI,EAAE,iBAAiB,EACvB,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,qBAAqB,CAAC,CAKhC;IAEK,sBAAsB,CAC1B,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,IAAI,CAAC,CAGf;IAEK,wBAAwB,CAC5B,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,IAAI,CAAC,CAKf;IAEK,0BAA0B,CAC9B,IAAI,EAAE,2BAA2B,GAChC,OAAO,CAAC,4BAA4B,CAAC,CAKvC;IAED,MAAM,CAAC,CAAC,EACN,MAAM,EAAE;QACN,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,EAAE,QAAQ,CAAC;KACpB,EACD,KAAK,EAAE,MAAM,GACZ,CAAC,CAUH;CACF"}

package/dist/api-worker-client.js

@@ -46,7 +46,7 @@ function describeRequest(input, init) {
     const url = input instanceof Request ? input.url : input.toString();
     return { method, url };
 }
-async function fetchWithRetry(input, init) {
+async function fetchWithRetry(input, init, { acceptStatuses = [] } = {}) {
     // openapi-fetch passes a Request object, and the first fetch consumes its
     // body: re-sending it throws "Request object that has already been used",
     // so every POST/PUT retry failed. Keep an unread copy and clone per attempt.
@@ -54,7 +54,7 @@ async function fetchWithRetry(input, init) {
     return (0, async_retry_1.default)(async (bail) => {
         const attemptInput = pristine instanceof Request ? pristine.clone() : pristine;
         const response = await fetch(attemptInput, init);
-        if (!response.ok) {
+        if (!response.ok && !acceptStatuses.includes(response.status)) {
             const { method, url } = describeRequest(input, init);
             const message = `HTTP error in ${method} request to ${url}! Status code: ${response.status}.`;
             if (response.status < 500) {
@@ -90,6 +90,24 @@ function formatError(error) {
         return String(error);
     }
 }
+const KV_EXPECTED_STATUSES = [404, 412];
+const kvFetch = (input) => fetchWithRetry(input, undefined, { acceptStatuses: KV_EXPECTED_STATUSES });
+function versionOf(ifVersion) {
+    return ifVersion === undefined ? undefined : { ifVersion };
+}
+function conditionHeaders(condition) {
+    if (!condition) {
+        return undefined;
+    }
+    return "ifAbsent" in condition
+        ? { "if-none-match": "*" }
+        : { "if-match": `"${condition.ifVersion}"` };
+}
+function preconditionCurrent(error) {
+    const current = error
+        ?.error?.current;
+    return current ?? null;
+}
 class ApiWorkerClient {
     baseUrl;
     client;
@@ -111,17 +129,63 @@ class ApiWorkerClient {
     getBaseUrl() {
         return this.baseUrl;
     }
-    async getProjectKv(key) {
-        const result = await this.client.GET("/api/projects/kv", {
-            params: { query: { key } },
+    async getKvEntry(key) {
+        const result = await this.client.GET("/api/kv/{key}", {
+            params: { path: { key } },
+            fetch: kvFetch,
         });
-        return this.unwrap(result, "GET /api/projects/kv");
+        if (result.response.status === 404) {
+            return null;
+        }
+        return this.unwrap(result, "GET /api/kv/{key}").data.entry;
+    }
+    async listKvEntries(query) {
+        const result = await this.client.GET("/api/kv", {
+            params: { query },
+        });
+        return this.unwrap(result, "GET /api/kv").data;
     }
-    async setProjectKv(body) {
-        const result = await this.client.POST("/api/projects/kv", {
+    async putKvEntry(key, body, condition) {
+        const result = await this.client.PUT("/api/kv/{key}", {
+            params: { path: { key }, header: conditionHeaders(condition) },
             body,
+            fetch: kvFetch,
+        });
+        return this.conditional(result, "PUT /api/kv/{key}");
+    }
+    async refreshKvEntry(key, ttl, ifVersion) {
+        const result = await this.client.PATCH("/api/kv/{key}", {
+            params: { path: { key }, header: conditionHeaders(versionOf(ifVersion)) },
+            body: { ttl },
+            fetch: kvFetch,
         });
-        return this.unwrap(result, "POST /api/projects/kv");
+        if (result.response.status === 404) {
+            return null;
+        }
+        return this.conditional(result, "PATCH /api/kv/{key}");
+    }
+    async deleteKvEntry(key, ifVersion) {
+        const result = await this.client.DELETE("/api/kv/{key}", {
+            params: { path: { key }, header: conditionHeaders(versionOf(ifVersion)) },
+            fetch: kvFetch,
+        });
+        if (result.response.status === 404) {
+            return { ok: true, value: false };
+        }
+        if (result.response.status === 412) {
+            return { ok: false, current: preconditionCurrent(result.error) };
+        }
+        if (result.response.ok) {
+            return { ok: true, value: true };
+        }
+        return this.unwrap(result, "DELETE /api/kv/{key}");
+    }
+    conditional(result, label) {
+        if (result.response.status === 412) {
+            return { ok: false, current: preconditionCurrent(result.error) };
+        }
+        const { data } = this.unwrap(result, label);
+        return { ok: true, value: data.entry };
     }
     async postProviderProxy(path, body) {
         const result = await this.client.POST(path, {