@clipboard-health/playwright-toolkit 1.4.1 → 1.4.3

package/README.md

@@ -94,6 +94,8 @@ Playwright response bodies can become unreadable after a document navigation. Us
 `waitForParsedJsonResponse` when a page action both waits for a JSON response and crosses a
 navigation boundary. The helper parses each candidate inside the `waitForResponse` predicate and
 returns only the parsed value, so callers cannot accidentally retain a lazy `Response` handle.
+Predicate-local parsing narrows the response-lifetime window but cannot eliminate it: Chromium can
+discard the underlying CDP resource while `response.json()` is still pending.
 
 ```typescript
 const workerResponsePromise = waitForParsedJsonResponse({
@@ -110,8 +112,14 @@ const workerResponse = await workerResponsePromise;
 ```
 
 Return `undefined` from `parseCandidate` when the URL-level candidate is valid but its body is not
-the response the test needs. Parsing errors propagate immediately. Keep repository-specific URL,
-method, resource-type, and schema matching in the consumer.
+the response the test needs. If a candidate body read fails with the exact Chromium
+`Network.getResponseBody` / `No resource with given identifier found` signature, the helper rejects
+only that candidate and continues inside the original finite waiter. It does not issue another
+request or navigation, add a retry or sleep, or widen the timeout. Invalid JSON, parsing and schema
+errors, near-match protocol errors, page or target closure, and cancellation propagate immediately.
+If the outer waiter times out after classified losses, the error preserves the original timeout as
+its cause and adds only bounded diagnostics with the loss count, method, status, and a redacted path
+template. Keep repository-specific URL, method, resource-type, and schema matching in the consumer.
 
 ## Per-test traceparent fixture
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clipboard-health/playwright-toolkit",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "description": "Shared anti-flake primitives for Clipboard Health Playwright suites.",
   "keywords": [
     "cognito",
@@ -26,7 +26,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@clipboard-health/util-ts": "5.17.1",
+    "@clipboard-health/util-ts": "5.17.2",
     "tslib": "2.8.1"
   },
   "devDependencies": {

package/src/lib/jsonResponse.d.ts

@@ -1,4 +1,4 @@
-import type { Page, Response } from "@playwright/test";
+import { type Page, type Response } from "@playwright/test";
 export interface WaitForParsedJsonResponseParams<T> {
     isCandidate: (params: {
         response: Response;
@@ -12,7 +12,9 @@ export interface WaitForParsedJsonResponseParams<T> {
 }
 /**
  * Waits for a matching JSON response and parses its body while Playwright's
- * document-scoped response resource is still readable. Return `undefined`
- * from `parseCandidate` to keep waiting for another candidate response.
+ * document-scoped response resource is still readable. If Chromium discards
+ * only that candidate's response body during the read, the unchanged waiter
+ * continues. Return `undefined` from `parseCandidate` to keep waiting for
+ * another candidate response.
  */
 export declare function waitForParsedJsonResponse<T>(params: WaitForParsedJsonResponseParams<T>): Promise<T>;

package/src/lib/jsonResponse.js

@@ -2,33 +2,124 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.waitForParsedJsonResponse = waitForParsedJsonResponse;
 const util_ts_1 = require("@clipboard-health/util-ts");
+const test_1 = require("@playwright/test");
+const MAX_RESPONSE_BODY_LOSS_DIAGNOSTICS = 3;
+const RESPONSE_BODY_METHOD_SIGNATURE = "Protocol error (Network.getResponseBody):";
+const RESPONSE_BODY_LOSS_MESSAGE = "No resource with given identifier found";
 /**
  * Waits for a matching JSON response and parses its body while Playwright's
- * document-scoped response resource is still readable. Return `undefined`
- * from `parseCandidate` to keep waiting for another candidate response.
+ * document-scoped response resource is still readable. If Chromium discards
+ * only that candidate's response body during the read, the unchanged waiter
+ * continues. Return `undefined` from `parseCandidate` to keep waiting for
+ * another candidate response.
  */
 async function waitForParsedJsonResponse(params) {
     const { isCandidate, page, parseCandidate, timeoutMs } = params;
+    const candidateTimeoutErrors = new WeakSet();
     const parsedCandidates = new WeakMap();
-    const response = await page.waitForResponse(async (candidateResponse) => {
-        if (!isCandidate({ response: candidateResponse })) {
-            return false;
+    const responseBodyLossDiagnostics = new Set();
+    let responseBodyLossCount = 0;
+    let response;
+    try {
+        response = await page.waitForResponse(async (candidateResponse) => {
+            try {
+                if (!isCandidate({ response: candidateResponse })) {
+                    return false;
+                }
+                let body;
+                try {
+                    body = await candidateResponse.json();
+                }
+                catch (error) {
+                    if (!isResponseBodyLoss({ error })) {
+                        throw error;
+                    }
+                    responseBodyLossCount += 1;
+                    if (responseBodyLossDiagnostics.size < MAX_RESPONSE_BODY_LOSS_DIAGNOSTICS) {
+                        responseBodyLossDiagnostics.add(formatResponseBodyLossDiagnostic({ response: candidateResponse }));
+                    }
+                    return false;
+                }
+                const parsedCandidate = parseCandidate({
+                    body,
+                    response: candidateResponse,
+                });
+                // JSON null is a valid parsed value; only undefined means "keep waiting".
+                if (parsedCandidate === undefined) {
+                    return false;
+                }
+                parsedCandidates.set(candidateResponse, { value: parsedCandidate });
+                return true;
+            }
+            catch (error) {
+                if (error instanceof test_1.errors.TimeoutError) {
+                    candidateTimeoutErrors.add(error);
+                }
+                throw error;
+            }
+        }, { timeout: timeoutMs });
+    }
+    catch (error) {
+        if (!(error instanceof test_1.errors.TimeoutError) ||
+            candidateTimeoutErrors.has(error) ||
+            responseBodyLossCount === 0) {
+            throw error;
         }
-        const parsedCandidate = parseCandidate({
-            body: await candidateResponse.json(),
-            response: candidateResponse,
+        throw createResponseBodyLossTimeoutError({
+            diagnostics: [...responseBodyLossDiagnostics],
+            responseBodyLossCount,
+            timeoutError: error,
         });
-        // JSON null is a valid parsed value; only undefined means "keep waiting".
-        if (parsedCandidate === undefined) {
-            return false;
-        }
-        parsedCandidates.set(candidateResponse, { value: parsedCandidate });
-        return true;
-    }, { timeout: timeoutMs });
+    }
     const parsedResponse = parsedCandidates.get(response);
     if (!(0, util_ts_1.isDefined)(parsedResponse)) {
         throw new Error("Expected the matched JSON response body to be captured while it was readable.");
     }
     return parsedResponse.value;
 }
+function createResponseBodyLossTimeoutError(params) {
+    const { diagnostics, responseBodyLossCount, timeoutError } = params;
+    return new Error(`${timeoutError.message}\nResponse body loss diagnostics: count=${responseBodyLossCount}; candidates=${diagnostics.join(", ")}`, { cause: timeoutError });
+}
+function formatResponseBodyLossDiagnostic(params) {
+    const { response } = params;
+    return [
+        `method=${getResponseMethod({ response })}`,
+        `status=${getResponseStatus({ response })}`,
+        `path=${getResponsePathTemplate({ response })}`,
+    ].join(" ");
+}
+function getResponseMethod(params) {
+    try {
+        const method = params.response.request().method();
+        return /^[A-Za-z]{1,16}$/.test(method) ? method.toUpperCase() : "[redacted]";
+    }
+    catch {
+        return "[unavailable]";
+    }
+}
+function getResponsePathTemplate(params) {
+    try {
+        return new URL(params.response.url()).pathname === "/" ? "/" : "/[redacted-path]";
+    }
+    catch {
+        return "/[redacted-path]";
+    }
+}
+function getResponseStatus(params) {
+    try {
+        const status = params.response.status();
+        return Number.isInteger(status) && status >= 100 && status <= 599
+            ? String(status)
+            : "[unavailable]";
+    }
+    catch {
+        return "[unavailable]";
+    }
+}
+function isResponseBodyLoss(params) {
+    const { error } = params;
+    const message = (0, util_ts_1.toError)(error).message;
+    return (message.includes(RESPONSE_BODY_METHOD_SIGNATURE) && message.includes(RESPONSE_BODY_LOSS_MESSAGE));
+}
 //# sourceMappingURL=jsonResponse.js.map

package/src/lib/jsonResponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"jsonResponse.js","sourceRoot":"","sources":["../../../../../packages/playwright-toolkit/src/lib/jsonResponse.ts"],"names":[],"mappings":";;;AAAA,uDAAsD;AActD;;;;GAIG;AACI,KAAK,oCACV,MAA0C;IAE1C,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAChE,MAAM,gBAAgB,GAAG,IAAI,OAAO,EAAgC,CAAC;IAErE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CACzC,KAAK,EAAE,iBAAiB,EAAE,EAAE;QAC1B,IAAI,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAC,EAAE,CAAC;YAClD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,eAAe,GAAG,cAAc,CAAC;YACrC,IAAI,EAAE,MAAM,iBAAiB,CAAC,IAAI,EAAE;YACpC,QAAQ,EAAE,iBAAiB;SAC5B,CAAC,CAAC;QACH,0EAA0E;QAC1E,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,gBAAgB,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC;IACd,CAAC,EACD,EAAE,OAAO,EAAE,SAAS,EAAE,CACvB,CAAC;IACF,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEtD,IAAI,CAAC,IAAA,mBAAS,EAAC,cAAc,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;IACJ,CAAC;IAED,OAAO,cAAc,CAAC,KAAK,CAAC;AAC9B,CAAC"}
+{"version":3,"file":"jsonResponse.js","sourceRoot":"","sources":["../../../../../packages/playwright-toolkit/src/lib/jsonResponse.ts"],"names":[],"mappings":";;;AAAA,uDAA+D;AAC/D,2CAAoE;AAEpE,MAAM,kCAAkC,GAAG,CAAC,CAAC;AAC7C,MAAM,8BAA8B,GAAG,2CAA2C,CAAC;AACnF,MAAM,0BAA0B,GAAG,yCAAyC,CAAC;AAa7E;;;;;;GAMG;AACI,KAAK,oCACV,MAA0C;IAE1C,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAChE,MAAM,sBAAsB,GAAG,IAAI,OAAO,EAAS,CAAC;IACpD,MAAM,gBAAgB,GAAG,IAAI,OAAO,EAAgC,CAAC;IACrE,MAAM,2BAA2B,GAAG,IAAI,GAAG,EAAU,CAAC;IACtD,IAAI,qBAAqB,GAAG,CAAC,CAAC;IAE9B,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CACnC,KAAK,EAAE,iBAAiB,EAAE,EAAE;YAC1B,IAAI,CAAC;gBACH,IAAI,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAC,EAAE,CAAC;oBAClD,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,IAAI,IAAa,CAAC;gBAClB,IAAI,CAAC;oBACH,IAAI,GAAG,MAAM,iBAAiB,CAAC,IAAI,EAAE,CAAC;gBACxC,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,IAAI,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;wBACnC,MAAM,KAAK,CAAC;oBACd,CAAC;oBAED,qBAAqB,IAAI,CAAC,CAAC;oBAC3B,IAAI,2BAA2B,CAAC,IAAI,GAAG,kCAAkC,EAAE,CAAC;wBAC1E,2BAA2B,CAAC,GAAG,CAC7B,gCAAgC,CAAC,EAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAC,CAClE,CAAC;oBACJ,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,MAAM,eAAe,GAAG,cAAc,CAAC;oBACrC,IAAI;oBACJ,QAAQ,EAAE,iBAAiB;iBAC5B,CAAC,CAAC;gBACH,0EAA0E;gBAC1E,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;oBAClC,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,gBAAgB,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;gBACpE,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,aAAM,CAAC,YAAY,EAAE,CAAC;oBACzC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACpC,CAAC;gBAED,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC,EACD,EAAE,OAAO,EAAE,SAAS,EAAE,CACvB,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IACE,CAAC,CAAC,KAAK,YAAY,aAAM,CAAC,YAAY,CAAC;YACvC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC;YACjC,qBAAqB,KAAK,CAAC,EAC3B,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,kCAAkC,CAAC;YACvC,WAAW,EAAE,CAAC,GAAG,2BAA2B,CAAC;YAC7C,qBAAqB;YACrB,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;IACL,CAAC;IACD,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEtD,IAAI,CAAC,IAAA,mBAAS,EAAC,cAAc,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;IACJ,CAAC;IAED,OAAO,cAAc,CAAC,KAAK,CAAC;AAC9B,CAAC;AAED,SAAS,kCAAkC,CAAC,MAI3C;IACC,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;IACpE,OAAO,IAAI,KAAK,CACd,GAAG,YAAY,CAAC,OAAO,2CAA2C,qBAAqB,gBAAgB,WAAW,CAAC,IAAI,CACrH,IAAI,CACL,EAAE,EACH,EAAE,KAAK,EAAE,YAAY,EAAE,CACxB,CAAC;AACJ,CAAC;AAED,SAAS,gCAAgC,CAAC,MAA8B;IACtE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAE5B,OAAO;QACL,UAAU,iBAAiB,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE;QAC3C,UAAU,iBAAiB,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE;QAC3C,QAAQ,uBAAuB,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE;KAChD,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACd,CAAC;AAED,SAAS,iBAAiB,CAAC,MAA8B;IACvD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;QAClD,OAAO,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;IAC/E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,eAAe,CAAC;IACzB,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,MAA8B;IAC7D,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,kBAAkB,CAAC;IACpF,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,kBAAkB,CAAC;IAC5B,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,MAA8B;IACvD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxC,OAAO,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG;YAC/D,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;YAChB,CAAC,CAAC,eAAe,CAAC;IACtB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,eAAe,CAAC;IACzB,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,MAA0B;IACpD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,MAAM,OAAO,GAAG,IAAA,iBAAO,EAAC,KAAK,CAAC,CAAC,OAAO,CAAC;IAEvC,OAAO,CACL,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CACjG,CAAC;AACJ,CAAC"}