@clipboard-health/playwright-toolkit 1.0.0

package/src/lib/setupRetry.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.classifySetupRetry = classifySetupRetry;
+exports.isRetryableHttpStatus = isRetryableHttpStatus;
+exports.getHttpErrorStatus = getHttpErrorStatus;
+const util_ts_1 = require("@clipboard-health/util-ts");
+/**
+ * Classifies setup failures without conflating identity collisions and
+ * transient infrastructure errors.
+ *
+ * Collision retries must regenerate a fresh identity. Transient retries must
+ * repeat the same identity so they do not change the scenario under test.
+ */
+function classifySetupRetry(params) {
+    const context = {
+        error: params.error,
+        status: getHttpErrorStatus({ error: params.error }),
+    };
+    if (params.isIdentityCollision?.(context) === true) {
+        return {
+            classification: "identity-collision",
+            retryDecision: "regenerate-identity",
+        };
+    }
+    if (isRetryableHttpStatus({ status: context.status }) ||
+        params.isTransientError?.(context) === true) {
+        return {
+            classification: "transient",
+            retryDecision: "retry-same-identity",
+        };
+    }
+    return {
+        classification: "deterministic",
+        retryDecision: "do-not-retry",
+    };
+}
+function isRetryableHttpStatus(params) {
+    return (params.status === 408 ||
+        params.status === 429 ||
+        (typeof params.status === "number" && params.status >= 500 && params.status <= 599));
+}
+function getHttpErrorStatus(params) {
+    if (!(0, util_ts_1.isRecord)(params.error)) {
+        return undefined;
+    }
+    if (typeof params.error["status"] === "number") {
+        return params.error["status"];
+    }
+    const response = params.error["response"];
+    if ((0, util_ts_1.isRecord)(response) && typeof response["status"] === "number") {
+        return response["status"];
+    }
+    return undefined;
+}
+//# sourceMappingURL=setupRetry.js.map

package/src/lib/setupRetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupRetry.js","sourceRoot":"","sources":["../../../../../packages/playwright-toolkit/src/lib/setupRetry.ts"],"names":[],"mappings":";;;;;AAAA,uDAAqD;AAqBrD;;;;;;GAMG;AACH,4BAAmC,MAAgC;IACjE,MAAM,OAAO,GAAG;QACd,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,kBAAkB,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;KACpD,CAAC;IAEF,IAAI,MAAM,CAAC,mBAAmB,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;QACnD,OAAO;YACL,cAAc,EAAE,oBAAoB;YACpC,aAAa,EAAE,qBAAqB;SACrC,CAAC;IACJ,CAAC;IAED,IACE,qBAAqB,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QACjD,MAAM,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,EAC3C,CAAC;QACD,OAAO;YACL,cAAc,EAAE,WAAW;YAC3B,aAAa,EAAE,qBAAqB;SACrC,CAAC;IACJ,CAAC;IAED,OAAO;QACL,cAAc,EAAE,eAAe;QAC/B,aAAa,EAAE,cAAc;KAC9B,CAAC;AACJ,CAAC;AAED,+BAAsC,MAAsC;IAC1E,OAAO,CACL,MAAM,CAAC,MAAM,KAAK,GAAG;QACrB,MAAM,CAAC,MAAM,KAAK,GAAG;QACrB,CAAC,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CACpF,CAAC;AACJ,CAAC;AAED,4BAAmC,MAA0B;IAC3D,IAAI,CAAC,IAAA,kBAAQ,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC/C,OAAO,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,IAAA,kBAAQ,EAAC,QAAQ,CAAC,IAAI,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;QACjE,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/src/lib/traceparent.d.ts

@@ -0,0 +1,31 @@
+import type { Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions } from "@playwright/test";
+export interface TraceparentFixtures {
+    traceparent: string;
+}
+export interface TraceparentContextLike {
+    setExtraHTTPHeaders(headers: Record<string, string>): Promise<void>;
+}
+export interface TraceparentTestInfoLike {
+    annotations: Array<{
+        type: string;
+        description?: string;
+    }>;
+}
+export interface CreateTraceparentParams {
+    randomBytesImplementation?: (byteCount: number) => Uint8Array;
+}
+export interface InstallTraceparentForTestParams {
+    context: TraceparentContextLike;
+    testInfo: TraceparentTestInfoLike;
+    traceparent?: string;
+    existingHeaders?: Record<string, string> | undefined;
+}
+/**
+ * Creates an auto fixture that installs one W3C traceparent per Playwright
+ * test and records it as a test annotation for reporter/APM correlation.
+ */
+export declare function createTraceparentFixtures(params?: CreateTraceparentParams): Fixtures<TraceparentFixtures, Record<never, never>, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+export declare function createTraceparent(params?: CreateTraceparentParams): string;
+export declare function installTraceparentForTest(params: InstallTraceparentForTestParams): Promise<{
+    traceparent: string;
+}>;

package/src/lib/traceparent.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTraceparentFixtures = createTraceparentFixtures;
+exports.createTraceparent = createTraceparent;
+exports.installTraceparentForTest = installTraceparentForTest;
+const node_crypto_1 = require("node:crypto");
+const INVALID_TRACE_ID = "00000000000000000000000000000000";
+const INVALID_PARENT_ID = "0000000000000000";
+/**
+ * Creates an auto fixture that installs one W3C traceparent per Playwright
+ * test and records it as a test annotation for reporter/APM correlation.
+ */
+function createTraceparentFixtures(params = {}) {
+    return {
+        traceparent: [
+            async ({ context, extraHTTPHeaders }, use, testInfo) => {
+                const result = await installTraceparentForTest({
+                    context,
+                    existingHeaders: extraHTTPHeaders,
+                    testInfo,
+                    traceparent: createTraceparent(params),
+                });
+                await use(result.traceparent);
+            },
+            { auto: true },
+        ],
+    };
+}
+function createTraceparent(params = {}) {
+    const randomBytesImplementation = params.randomBytesImplementation ?? node_crypto_1.randomBytes;
+    const traceId = createNonZeroHex({
+        byteCount: 16,
+        invalidValue: INVALID_TRACE_ID,
+        randomBytesImplementation,
+    });
+    const parentId = createNonZeroHex({
+        byteCount: 8,
+        invalidValue: INVALID_PARENT_ID,
+        randomBytesImplementation,
+    });
+    return `00-${traceId}-${parentId}-01`;
+}
+async function installTraceparentForTest(params) {
+    const traceparent = params.traceparent ?? createTraceparent();
+    await params.context.setExtraHTTPHeaders({
+        ...params.existingHeaders,
+        traceparent,
+    });
+    params.testInfo.annotations.push({
+        type: "traceparent",
+        description: traceparent,
+    });
+    return { traceparent };
+}
+function createNonZeroHex(params) {
+    for (;;) {
+        const value = Buffer.from(params.randomBytesImplementation(params.byteCount)).toString("hex");
+        if (value.length !== params.byteCount * 2) {
+            throw new Error(`Random byte source returned ${value.length / 2} bytes`);
+        }
+        if (value !== params.invalidValue) {
+            return value;
+        }
+    }
+}
+//# sourceMappingURL=traceparent.js.map

package/src/lib/traceparent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traceparent.js","sourceRoot":"","sources":["../../../../../packages/playwright-toolkit/src/lib/traceparent.ts"],"names":[],"mappings":";;;;;AAAA,6CAA0C;AAU1C,MAAM,gBAAgB,GAAG,kCAAkC,CAAC;AAC5D,MAAM,iBAAiB,GAAG,kBAAkB,CAAC;AAyB7C;;;GAGG;AACH,mCACE,MAAM,GAA4B,EAAE;IAOpC,OAAO;QACL,WAAW,EAAE;YACX,KAAK,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE;gBACrD,MAAM,MAAM,GAAG,MAAM,yBAAyB,CAAC;oBAC7C,OAAO;oBACP,eAAe,EAAE,gBAAgB;oBACjC,QAAQ;oBACR,WAAW,EAAE,iBAAiB,CAAC,MAAM,CAAC;iBACvC,CAAC,CAAC;gBAEH,MAAM,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAChC,CAAC;YACD,EAAE,IAAI,EAAE,IAAI,EAAE;SACf;KACF,CAAC;AACJ,CAAC;AAED,2BAAkC,MAAM,GAA4B,EAAE;IACpE,MAAM,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,IAAI,yBAAW,CAAC;IAClF,MAAM,OAAO,GAAG,gBAAgB,CAAC;QAC/B,SAAS,EAAE,EAAE;QACb,YAAY,EAAE,gBAAgB;QAC9B,yBAAyB;KAC1B,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,gBAAgB,CAAC;QAChC,SAAS,EAAE,CAAC;QACZ,YAAY,EAAE,iBAAiB;QAC/B,yBAAyB;KAC1B,CAAC,CAAC;IAEH,OAAO,MAAM,OAAO,IAAI,QAAQ,KAAK,CAAC;AACxC,CAAC;AAEM,KAAK,oCACV,MAAuC;IAEvC,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,iBAAiB,EAAE,CAAC;IAE9D,MAAM,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC;QACvC,GAAG,MAAM,CAAC,eAAe;QACzB,WAAW;KACZ,CAAC,CAAC;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC;QAC/B,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,OAAO,EAAE,WAAW,EAAE,CAAC;AACzB,CAAC;AAED,SAAS,gBAAgB,CAAC,MAIzB;IACC,SAAS,CAAC;QACR,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE9F,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,+BAA+B,KAAK,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,KAAK,KAAK,MAAM,CAAC,YAAY,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;AACH,CAAC"}