test-proxy-recorder 0.3.0 → 0.3.2

package/dist/playwright/index.cjs

@@ -1,6 +1,12 @@
 'use strict';
 
-// src/constants.ts
+var path = require('path');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var path__default = /*#__PURE__*/_interopDefault(path);
+
+// src/playwright/index.ts
 var RECORDING_ID_HEADER = "x-test-rcrd-id";
 
 // src/types.ts
@@ -46,6 +52,30 @@ async function setProxyMode(mode, sessionId, timeout) {
     throw error;
   }
 }
+async function cleanupSession(sessionId) {
+  const proxyPort = getProxyPort();
+  try {
+    const body = {
+      cleanup: true,
+      id: sessionId
+    };
+    const response = await fetch(`http://127.0.0.1:${proxyPort}/__control`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(body)
+    });
+    if (!response.ok) {
+      const text = await response.text();
+      console.error(`Failed to cleanup session ${sessionId}:`, text);
+      throw new Error(`Failed to cleanup session: ${text}`);
+    }
+    await response.json();
+    console.log(`Session cleaned up: ${sessionId}`);
+  } catch (error) {
+    console.error(`Error cleaning up session:`, error);
+    throw error;
+  }
+}
 function parseSpecFilePath(specPath) {
   const folderMatch = specPath.match(/^(.+?)\/([^/]+)\.(spec|test)\.ts$/);
   if (folderMatch) {
@@ -87,6 +117,53 @@ async function stopProxy(testInfo) {
   const sessionId = generateSessionId(testInfo);
   await setProxyMode(Modes.transparent, sessionId);
 }
+var cachedRecordingsDir = null;
+async function getRecordingsDir() {
+  if (cachedRecordingsDir) {
+    return cachedRecordingsDir;
+  }
+  const proxyPort = getProxyPort();
+  try {
+    const response = await fetch(`http://127.0.0.1:${proxyPort}/__control`);
+    if (response.ok) {
+      const data = await response.json();
+      if (data.recordingsDir) {
+        cachedRecordingsDir = data.recordingsDir;
+        return cachedRecordingsDir;
+      }
+    }
+  } catch (error) {
+    console.warn(
+      "Failed to get recordings directory from proxy, using default:",
+      error
+    );
+  }
+  cachedRecordingsDir = path__default.default.join(process.cwd(), "e2e", "recordings");
+  return cachedRecordingsDir;
+}
+async function setupClientSideRecording(page, sessionId, mode, url) {
+  const harFileName = sessionId.replaceAll("/", "__");
+  const recordingsDir = await getRecordingsDir();
+  const harPath = path__default.default.join(recordingsDir, `${harFileName}.har`);
+  console.log(
+    `[Client-Side Recording] Setting up HAR for session: ${sessionId}, mode: ${mode}, path: ${harPath}`
+  );
+  try {
+    await page.routeFromHAR(harPath, {
+      url,
+      update: mode === Modes.record,
+      updateContent: "embed"
+    });
+  } catch (error) {
+    if (mode === Modes.replay) {
+      console.error(
+        `[Client-Side Replay] Failed to load HAR file. Run tests in record mode first.`,
+        error
+      );
+      throw error;
+    }
+  }
+}
 var playwrightProxy = {
   /**
    * Setup before test - sets the proxy mode and configures page with custom header
@@ -94,24 +171,84 @@ var playwrightProxy = {
    * @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
+   * @param options - Optional configuration including timeout and client-side recording patterns
    */
-  async before(page, testInfo, mode, timeout) {
+  async before(page, testInfo, mode, options) {
+    const timeout = typeof options === "number" ? options : options?.timeout;
+    const clientSideOptions = typeof options === "object" && options !== null ? options : void 0;
     const sessionId = generateSessionId(testInfo);
     await page.setExtraHTTPHeaders({
       [RECORDING_ID_HEADER]: sessionId
     });
+    console.log(`[Setup] Setting proxy mode: ${mode}, session: ${sessionId}`);
     await setProxyMode(mode, sessionId, timeout);
-    page.on("close", async () => {
-      try {
-        await setProxyMode(Modes.replay, sessionId);
-        console.log(
-          `[Cleanup] Switched to transparent mode for session: ${sessionId}`
-        );
-      } catch (error) {
-        console.error("[Cleanup] Error during page close cleanup:", error);
-      }
-    });
+    console.log(`[Setup] Proxy mode set successfully`);
+    if (clientSideOptions?.url) {
+      console.log(`[Setup] Setting up client-side recording with pattern: ${clientSideOptions.url}`);
+      await setupClientSideRecording(
+        page,
+        sessionId,
+        mode,
+        clientSideOptions.url
+      );
+      console.log(`[Setup] Client-side recording setup complete`);
+    }
+    const proxyPort = process.env.TEST_PROXY_RECORDER_PORT || "8100";
+    const proxyUrl = `localhost:${proxyPort}`;
+    console.log(`[Setup] Registering proxy route handler for: ${proxyUrl}`);
+    await page.route(
+      (url) => {
+        const urlStr = url.toString();
+        const matches = urlStr.includes(proxyUrl);
+        if (matches) {
+          console.log(`[Route Matcher] Matched proxy request: ${urlStr}`);
+        }
+        return matches;
+      },
+      async (route) => {
+        try {
+          const url = route.request().url();
+          const method = route.request().method();
+          const headers = route.request().headers();
+          const hadHeader = !!headers[RECORDING_ID_HEADER];
+          headers[RECORDING_ID_HEADER] = sessionId;
+          console.log(
+            `[Route Intercept] ${method} ${url} (had header: ${hadHeader}, adding session: ${sessionId})`
+          );
+          await route.continue({ headers });
+        } catch (error) {
+          console.error(
+            `[Route Handler Error] Failed to add ${RECORDING_ID_HEADER} header:`,
+            error
+          );
+          await route.fallback();
+        }
+      },
+      { times: Infinity }
+      // Ensure the handler applies to all matching requests
+    );
+    console.log(`[Setup] Proxy route handler registered`);
+    const context = page.context();
+    const contextId = context._guid || "default";
+    const handlerKey = `cleanup_${contextId}`;
+    if (!globalThis[handlerKey]) {
+      globalThis[handlerKey] = true;
+      context.on("close", async () => {
+        try {
+          console.log(
+            `[Cleanup] Browser context closed, cleaning up session: ${sessionId}`
+          );
+          await cleanupSession(sessionId);
+        } catch (error) {
+          console.warn(
+            `[Cleanup] Failed to cleanup session ${sessionId}:`,
+            error
+          );
+        } finally {
+          delete globalThis[handlerKey];
+        }
+      });
+    }
   },
   /**
    * Global teardown - switches proxy to transparent mode
@@ -122,6 +259,7 @@ var playwrightProxy = {
   }
 };
 
+exports.cleanupSession = cleanupSession;
 exports.generateSessionId = generateSessionId;
 exports.playwrightProxy = playwrightProxy;
 exports.setProxyMode = setProxyMode;

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-CVuiglPk.cjs';
+export { f as ClientSideRecordingOptions, P as PlaywrightTestInfo, e as cleanupSession, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-BlBWqSE4.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-CVuiglPk.js';
+export { f as ClientSideRecordingOptions, P as PlaywrightTestInfo, e as cleanupSession, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-BlBWqSE4.js';
 import 'node:http';

package/dist/playwright/index.mjs

@@ -1,4 +1,6 @@
-// src/constants.ts
+import path from 'path';
+
+// src/playwright/index.ts
 var RECORDING_ID_HEADER = "x-test-rcrd-id";
 
 // src/types.ts
@@ -44,6 +46,30 @@ async function setProxyMode(mode, sessionId, timeout) {
     throw error;
   }
 }
+async function cleanupSession(sessionId) {
+  const proxyPort = getProxyPort();
+  try {
+    const body = {
+      cleanup: true,
+      id: sessionId
+    };
+    const response = await fetch(`http://127.0.0.1:${proxyPort}/__control`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(body)
+    });
+    if (!response.ok) {
+      const text = await response.text();
+      console.error(`Failed to cleanup session ${sessionId}:`, text);
+      throw new Error(`Failed to cleanup session: ${text}`);
+    }
+    await response.json();
+    console.log(`Session cleaned up: ${sessionId}`);
+  } catch (error) {
+    console.error(`Error cleaning up session:`, error);
+    throw error;
+  }
+}
 function parseSpecFilePath(specPath) {
   const folderMatch = specPath.match(/^(.+?)\/([^/]+)\.(spec|test)\.ts$/);
   if (folderMatch) {
@@ -85,6 +111,53 @@ async function stopProxy(testInfo) {
   const sessionId = generateSessionId(testInfo);
   await setProxyMode(Modes.transparent, sessionId);
 }
+var cachedRecordingsDir = null;
+async function getRecordingsDir() {
+  if (cachedRecordingsDir) {
+    return cachedRecordingsDir;
+  }
+  const proxyPort = getProxyPort();
+  try {
+    const response = await fetch(`http://127.0.0.1:${proxyPort}/__control`);
+    if (response.ok) {
+      const data = await response.json();
+      if (data.recordingsDir) {
+        cachedRecordingsDir = data.recordingsDir;
+        return cachedRecordingsDir;
+      }
+    }
+  } catch (error) {
+    console.warn(
+      "Failed to get recordings directory from proxy, using default:",
+      error
+    );
+  }
+  cachedRecordingsDir = path.join(process.cwd(), "e2e", "recordings");
+  return cachedRecordingsDir;
+}
+async function setupClientSideRecording(page, sessionId, mode, url) {
+  const harFileName = sessionId.replaceAll("/", "__");
+  const recordingsDir = await getRecordingsDir();
+  const harPath = path.join(recordingsDir, `${harFileName}.har`);
+  console.log(
+    `[Client-Side Recording] Setting up HAR for session: ${sessionId}, mode: ${mode}, path: ${harPath}`
+  );
+  try {
+    await page.routeFromHAR(harPath, {
+      url,
+      update: mode === Modes.record,
+      updateContent: "embed"
+    });
+  } catch (error) {
+    if (mode === Modes.replay) {
+      console.error(
+        `[Client-Side Replay] Failed to load HAR file. Run tests in record mode first.`,
+        error
+      );
+      throw error;
+    }
+  }
+}
 var playwrightProxy = {
   /**
    * Setup before test - sets the proxy mode and configures page with custom header
@@ -92,24 +165,84 @@ var playwrightProxy = {
    * @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
+   * @param options - Optional configuration including timeout and client-side recording patterns
    */
-  async before(page, testInfo, mode, timeout) {
+  async before(page, testInfo, mode, options) {
+    const timeout = typeof options === "number" ? options : options?.timeout;
+    const clientSideOptions = typeof options === "object" && options !== null ? options : void 0;
     const sessionId = generateSessionId(testInfo);
     await page.setExtraHTTPHeaders({
       [RECORDING_ID_HEADER]: sessionId
     });
+    console.log(`[Setup] Setting proxy mode: ${mode}, session: ${sessionId}`);
     await setProxyMode(mode, sessionId, timeout);
-    page.on("close", async () => {
-      try {
-        await setProxyMode(Modes.replay, sessionId);
-        console.log(
-          `[Cleanup] Switched to transparent mode for session: ${sessionId}`
-        );
-      } catch (error) {
-        console.error("[Cleanup] Error during page close cleanup:", error);
-      }
-    });
+    console.log(`[Setup] Proxy mode set successfully`);
+    if (clientSideOptions?.url) {
+      console.log(`[Setup] Setting up client-side recording with pattern: ${clientSideOptions.url}`);
+      await setupClientSideRecording(
+        page,
+        sessionId,
+        mode,
+        clientSideOptions.url
+      );
+      console.log(`[Setup] Client-side recording setup complete`);
+    }
+    const proxyPort = process.env.TEST_PROXY_RECORDER_PORT || "8100";
+    const proxyUrl = `localhost:${proxyPort}`;
+    console.log(`[Setup] Registering proxy route handler for: ${proxyUrl}`);
+    await page.route(
+      (url) => {
+        const urlStr = url.toString();
+        const matches = urlStr.includes(proxyUrl);
+        if (matches) {
+          console.log(`[Route Matcher] Matched proxy request: ${urlStr}`);
+        }
+        return matches;
+      },
+      async (route) => {
+        try {
+          const url = route.request().url();
+          const method = route.request().method();
+          const headers = route.request().headers();
+          const hadHeader = !!headers[RECORDING_ID_HEADER];
+          headers[RECORDING_ID_HEADER] = sessionId;
+          console.log(
+            `[Route Intercept] ${method} ${url} (had header: ${hadHeader}, adding session: ${sessionId})`
+          );
+          await route.continue({ headers });
+        } catch (error) {
+          console.error(
+            `[Route Handler Error] Failed to add ${RECORDING_ID_HEADER} header:`,
+            error
+          );
+          await route.fallback();
+        }
+      },
+      { times: Infinity }
+      // Ensure the handler applies to all matching requests
+    );
+    console.log(`[Setup] Proxy route handler registered`);
+    const context = page.context();
+    const contextId = context._guid || "default";
+    const handlerKey = `cleanup_${contextId}`;
+    if (!globalThis[handlerKey]) {
+      globalThis[handlerKey] = true;
+      context.on("close", async () => {
+        try {
+          console.log(
+            `[Cleanup] Browser context closed, cleaning up session: ${sessionId}`
+          );
+          await cleanupSession(sessionId);
+        } catch (error) {
+          console.warn(
+            `[Cleanup] Failed to cleanup session ${sessionId}:`,
+            error
+          );
+        } finally {
+          delete globalThis[handlerKey];
+        }
+      });
+    }
   },
   /**
    * Global teardown - switches proxy to transparent mode
@@ -120,6 +253,6 @@ var playwrightProxy = {
   }
 };
 
-export { generateSessionId, playwrightProxy, setProxyMode, startRecording, startReplay, stopProxy };
+export { cleanupSession, generateSessionId, playwrightProxy, setProxyMode, startRecording, startReplay, stopProxy };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map