test-proxy-recorder 0.2.0 → 0.3.1

package/dist/nextjs/index.cjs

@@ -0,0 +1,43 @@
+'use strict';
+
+// src/constants.ts
+var RECORDING_ID_HEADER = "x-test-rcrd-id";
+
+// src/nextjs/middleware.ts
+function isRecorderEnabled() {
+  const isProduction = process.env.NODE_ENV === "production";
+  const isExplicitlyEnabled = process.env.TEST_PROXY_RECORDER_ENABLED === "true" || Number.parseInt(process.env.TEST_PROXY_RECORDER_ENABLED || "") === 1;
+  return !isProduction || isExplicitlyEnabled;
+}
+function setNextProxyHeaders(request, response) {
+  if (!isRecorderEnabled()) {
+    return;
+  }
+  const recordingId = request.headers.get(RECORDING_ID_HEADER);
+  if (recordingId) {
+    response.headers.set(RECORDING_ID_HEADER, recordingId);
+  }
+}
+function getRecordingId(requestHeaders) {
+  if (requestHeaders instanceof Headers) {
+    return requestHeaders.get(RECORDING_ID_HEADER);
+  }
+  return requestHeaders.headers.get(RECORDING_ID_HEADER);
+}
+function createHeadersWithRecordingId(requestHeaders, additionalHeaders = {}) {
+  if (!isRecorderEnabled()) {
+    return additionalHeaders;
+  }
+  const recordingId = getRecordingId(requestHeaders);
+  return {
+    ...additionalHeaders,
+    ...recordingId && { [RECORDING_ID_HEADER]: recordingId }
+  };
+}
+
+exports.RECORDING_ID_HEADER = RECORDING_ID_HEADER;
+exports.createHeadersWithRecordingId = createHeadersWithRecordingId;
+exports.getRecordingId = getRecordingId;
+exports.setNextProxyHeaders = setNextProxyHeaders;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/nextjs/index.d.cts

@@ -0,0 +1,89 @@
+declare const RECORDING_ID_HEADER = "x-test-rcrd-id";
+
+/**
+ * Minimal type for Next.js Request - compatible with next/server's NextRequest
+ * We define this locally to avoid requiring Next.js as a dependency
+ */
+interface NextJSRequest {
+    headers: Headers;
+}
+/**
+ * Minimal type for Next.js Response - compatible with next/server's NextResponse
+ * We define this locally to avoid requiring Next.js as a dependency
+ */
+interface NextJSResponse {
+    headers: Headers;
+}
+/**
+ * Next.js middleware helper for forwarding test proxy recording headers
+ * Automatically forwards the recording ID header from incoming requests to the proxy
+ * Only runs in non-production environments or when TEST_PROXY_RECORDER_ENABLED is set
+ *
+ * @example
+ * // middleware.ts
+ * import { NextResponse } from 'next/server';
+ * import type { NextRequest } from 'next/server';
+ * import { setNextProxyHeaders } from 'test-proxy-recorder/nextjs';
+ *
+ * export function middleware(request: NextRequest) {
+ *   const response = NextResponse.next();
+ *   // Only forwards headers in test/dev environments
+ *   setNextProxyHeaders(request, response);
+ *   return response;
+ * }
+ *
+ * @param request - Next.js request object (NextRequest from next/server)
+ * @param response - Next.js response object (NextResponse from next/server)
+ */
+declare function setNextProxyHeaders(request: NextJSRequest, response: NextJSResponse): void;
+/**
+ * Get the recording ID from the request if present
+ * Useful for manually adding the header to fetch requests in Next.js
+ *
+ * @example
+ * // In your API route or server component
+ * import { getRecordingId } from 'test-proxy-recorder/nextjs';
+ * import { headers } from 'next/headers';
+ *
+ * export async function GET() {
+ *   const recordingId = getRecordingId(headers());
+ *
+ *   const response = await fetch('http://localhost:8100/api/data', {
+ *     headers: {
+ *       ...(recordingId && { 'x-test-rcrd-id': recordingId })
+ *     }
+ *   });
+ *
+ *   return Response.json(await response.json());
+ * }
+ *
+ * @param requestHeaders - Next.js headers object or NextRequest from next/server
+ * @returns The recording ID if present, null otherwise
+ */
+declare function getRecordingId(requestHeaders: NextJSRequest | Headers): string | null;
+/**
+ * Create headers object with recording ID for fetch requests
+ * Use this helper when making fetch requests in Next.js to forward the recording ID
+ *
+ * @example
+ * // In your API route or server component
+ * import { createHeadersWithRecordingId } from 'test-proxy-recorder/nextjs';
+ * import { headers } from 'next/headers';
+ *
+ * export async function GET() {
+ *   const response = await fetch('http://localhost:8100/api/data', {
+ *     headers: createHeadersWithRecordingId(headers(), {
+ *       'Content-Type': 'application/json',
+ *     })
+ *   });
+ *
+ *   return Response.json(await response.json());
+ * }
+ *
+ * @param requestHeaders - Next.js headers object or NextRequest from next/server
+ * @param additionalHeaders - Optional additional headers to include
+ * @returns Headers object with recording ID if present
+ */
+declare function createHeadersWithRecordingId(requestHeaders: NextJSRequest | Headers, additionalHeaders?: Record<string, string>): Record<string, string>;
+
+export { type NextJSRequest, type NextJSResponse, RECORDING_ID_HEADER, createHeadersWithRecordingId, getRecordingId, setNextProxyHeaders };

package/dist/nextjs/index.d.ts

@@ -0,0 +1,89 @@
+declare const RECORDING_ID_HEADER = "x-test-rcrd-id";
+
+/**
+ * Minimal type for Next.js Request - compatible with next/server's NextRequest
+ * We define this locally to avoid requiring Next.js as a dependency
+ */
+interface NextJSRequest {
+    headers: Headers;
+}
+/**
+ * Minimal type for Next.js Response - compatible with next/server's NextResponse
+ * We define this locally to avoid requiring Next.js as a dependency
+ */
+interface NextJSResponse {
+    headers: Headers;
+}
+/**
+ * Next.js middleware helper for forwarding test proxy recording headers
+ * Automatically forwards the recording ID header from incoming requests to the proxy
+ * Only runs in non-production environments or when TEST_PROXY_RECORDER_ENABLED is set
+ *
+ * @example
+ * // middleware.ts
+ * import { NextResponse } from 'next/server';
+ * import type { NextRequest } from 'next/server';
+ * import { setNextProxyHeaders } from 'test-proxy-recorder/nextjs';
+ *
+ * export function middleware(request: NextRequest) {
+ *   const response = NextResponse.next();
+ *   // Only forwards headers in test/dev environments
+ *   setNextProxyHeaders(request, response);
+ *   return response;
+ * }
+ *
+ * @param request - Next.js request object (NextRequest from next/server)
+ * @param response - Next.js response object (NextResponse from next/server)
+ */
+declare function setNextProxyHeaders(request: NextJSRequest, response: NextJSResponse): void;
+/**
+ * Get the recording ID from the request if present
+ * Useful for manually adding the header to fetch requests in Next.js
+ *
+ * @example
+ * // In your API route or server component
+ * import { getRecordingId } from 'test-proxy-recorder/nextjs';
+ * import { headers } from 'next/headers';
+ *
+ * export async function GET() {
+ *   const recordingId = getRecordingId(headers());
+ *
+ *   const response = await fetch('http://localhost:8100/api/data', {
+ *     headers: {
+ *       ...(recordingId && { 'x-test-rcrd-id': recordingId })
+ *     }
+ *   });
+ *
+ *   return Response.json(await response.json());
+ * }
+ *
+ * @param requestHeaders - Next.js headers object or NextRequest from next/server
+ * @returns The recording ID if present, null otherwise
+ */
+declare function getRecordingId(requestHeaders: NextJSRequest | Headers): string | null;
+/**
+ * Create headers object with recording ID for fetch requests
+ * Use this helper when making fetch requests in Next.js to forward the recording ID
+ *
+ * @example
+ * // In your API route or server component
+ * import { createHeadersWithRecordingId } from 'test-proxy-recorder/nextjs';
+ * import { headers } from 'next/headers';
+ *
+ * export async function GET() {
+ *   const response = await fetch('http://localhost:8100/api/data', {
+ *     headers: createHeadersWithRecordingId(headers(), {
+ *       'Content-Type': 'application/json',
+ *     })
+ *   });
+ *
+ *   return Response.json(await response.json());
+ * }
+ *
+ * @param requestHeaders - Next.js headers object or NextRequest from next/server
+ * @param additionalHeaders - Optional additional headers to include
+ * @returns Headers object with recording ID if present
+ */
+declare function createHeadersWithRecordingId(requestHeaders: NextJSRequest | Headers, additionalHeaders?: Record<string, string>): Record<string, string>;
+
+export { type NextJSRequest, type NextJSResponse, RECORDING_ID_HEADER, createHeadersWithRecordingId, getRecordingId, setNextProxyHeaders };

package/dist/nextjs/index.mjs

@@ -0,0 +1,38 @@
+// src/constants.ts
+var RECORDING_ID_HEADER = "x-test-rcrd-id";
+
+// src/nextjs/middleware.ts
+function isRecorderEnabled() {
+  const isProduction = process.env.NODE_ENV === "production";
+  const isExplicitlyEnabled = process.env.TEST_PROXY_RECORDER_ENABLED === "true" || Number.parseInt(process.env.TEST_PROXY_RECORDER_ENABLED || "") === 1;
+  return !isProduction || isExplicitlyEnabled;
+}
+function setNextProxyHeaders(request, response) {
+  if (!isRecorderEnabled()) {
+    return;
+  }
+  const recordingId = request.headers.get(RECORDING_ID_HEADER);
+  if (recordingId) {
+    response.headers.set(RECORDING_ID_HEADER, recordingId);
+  }
+}
+function getRecordingId(requestHeaders) {
+  if (requestHeaders instanceof Headers) {
+    return requestHeaders.get(RECORDING_ID_HEADER);
+  }
+  return requestHeaders.headers.get(RECORDING_ID_HEADER);
+}
+function createHeadersWithRecordingId(requestHeaders, additionalHeaders = {}) {
+  if (!isRecorderEnabled()) {
+    return additionalHeaders;
+  }
+  const recordingId = getRecordingId(requestHeaders);
+  return {
+    ...additionalHeaders,
+    ...recordingId && { [RECORDING_ID_HEADER]: recordingId }
+  };
+}
+
+export { RECORDING_ID_HEADER, createHeadersWithRecordingId, getRecordingId, setNextProxyHeaders };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/playwright/index.cjs

@@ -1,5 +1,8 @@
 'use strict';
 
+// src/constants.ts
+var RECORDING_ID_HEADER = "x-test-rcrd-id";
+
 // src/types.ts
 var Modes = {
   transparent: "transparent",
@@ -86,23 +89,29 @@ async function stopProxy(testInfo) {
 }
 var playwrightProxy = {
   /**
-   * Setup before test - sets the proxy mode
+   * Setup before test - sets the proxy mode and configures page with custom header
+   * Automatically sets up page.on('close') handler for cleanup
+   * @param page - Playwright page object
    * @param testInfo - Playwright test info object
    * @param mode - The proxy mode to use for this test
    * @param timeout - Optional timeout in milliseconds
    */
-  async before(testInfo, mode, timeout) {
+  async before(page, testInfo, mode, timeout) {
     const sessionId = generateSessionId(testInfo);
+    await page.setExtraHTTPHeaders({
+      [RECORDING_ID_HEADER]: sessionId
+    });
     await setProxyMode(mode, sessionId, timeout);
-  },
-  /**
-   * Cleanup after test - resets replay session by re-entering replay mode
-   * switchToReplayMode automatically clears sequence counters
-   * @param testInfo - Playwright test info object
-   */
-  async after(testInfo) {
-    const sessionId = generateSessionId(testInfo);
-    await setProxyMode(Modes.replay, sessionId);
+    page.on("close", async () => {
+      try {
+        await setProxyMode(Modes.replay, sessionId);
+        console.log(
+          `[Cleanup] Switched to replay mode for session: ${sessionId}`
+        );
+      } catch (error) {
+        console.error("[Cleanup] Error during page close cleanup:", error);
+      }
+    });
   },
   /**
    * Global teardown - switches proxy to transparent mode

package/dist/playwright/index.d.cts

@@ -1,3 +1,3 @@
 import '@playwright/test';
-export { P as PlaywrightTestInfo, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-nmNRt1WE.cjs';
+export { P as PlaywrightTestInfo, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-CVuiglPk.cjs';
 import 'node:http';

package/dist/playwright/index.d.ts

@@ -1,3 +1,3 @@
 import '@playwright/test';
-export { P as PlaywrightTestInfo, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-nmNRt1WE.js';
+export { P as PlaywrightTestInfo, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-CVuiglPk.js';
 import 'node:http';

package/dist/playwright/index.mjs

@@ -1,3 +1,6 @@
+// src/constants.ts
+var RECORDING_ID_HEADER = "x-test-rcrd-id";
+
 // src/types.ts
 var Modes = {
   transparent: "transparent",
@@ -84,23 +87,29 @@ async function stopProxy(testInfo) {
 }
 var playwrightProxy = {
   /**
-   * Setup before test - sets the proxy mode
+   * Setup before test - sets the proxy mode and configures page with custom header
+   * Automatically sets up page.on('close') handler for cleanup
+   * @param page - Playwright page object
    * @param testInfo - Playwright test info object
    * @param mode - The proxy mode to use for this test
    * @param timeout - Optional timeout in milliseconds
    */
-  async before(testInfo, mode, timeout) {
+  async before(page, testInfo, mode, timeout) {
     const sessionId = generateSessionId(testInfo);
+    await page.setExtraHTTPHeaders({
+      [RECORDING_ID_HEADER]: sessionId
+    });
     await setProxyMode(mode, sessionId, timeout);
-  },
-  /**
-   * Cleanup after test - resets replay session by re-entering replay mode
-   * switchToReplayMode automatically clears sequence counters
-   * @param testInfo - Playwright test info object
-   */
-  async after(testInfo) {
-    const sessionId = generateSessionId(testInfo);
-    await setProxyMode(Modes.replay, sessionId);
+    page.on("close", async () => {
+      try {
+        await setProxyMode(Modes.replay, sessionId);
+        console.log(
+          `[Cleanup] Switched to replay mode for session: ${sessionId}`
+        );
+      } catch (error) {
+        console.error("[Cleanup] Error during page close cleanup:", error);
+      }
+    });
   },
   /**
    * Global teardown - switches proxy to transparent mode