test-proxy-recorder 0.3.1 → 0.3.2

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 replay 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

package/dist/proxy.js

@@ -118,16 +118,19 @@ async function saveRecordingSession(recordingsDir2, session) {
     `Saved ${processedRecordings.length} HTTP recordings and ${session.websocketRecordings?.length || 0} WebSocket recordings to ${filePath}`
   );
 }
-function getReqID(req) {
-  const urlParts = req.url.split("?");
-  const pathname = urlParts[0];
-  const query = urlParts[1] || "";
+function generateRecordingKey(pathname, query, method) {
   const pathPart = pathname === "/" ? "root" : pathname.slice(1);
   const normalizedPath = filenamify2(pathPart, { replacement: "_" });
   const queryHash = generateQueryHash(query);
-  const filename = `${req.method}_${normalizedPath}${queryHash}.json`;
+  const filename = `${method}_${normalizedPath}${queryHash}.json`;
   return filenamify2(filename, { replacement: "_" });
 }
+function getReqID(req) {
+  const urlParts = req.url.split("?");
+  const pathname = urlParts[0];
+  const query = urlParts[1] || "";
+  return generateRecordingKey(pathname, query, req.method);
+}
 function generateQueryHash(query) {
   if (!query) {
     return "";
@@ -280,7 +283,15 @@ var ProxyServer = class {
    * @returns The recording ID, or null if not found
    */
   getRecordingIdFromRequest(req) {
-    return this.getRecordingIdFromHeader(req) || this.getRecordingIdFromCookie(req);
+    const fromHeader = this.getRecordingIdFromHeader(req);
+    const fromCookie = this.getRecordingIdFromCookie(req);
+    if (fromHeader) {
+      return fromHeader;
+    }
+    if (fromCookie) {
+      return fromCookie;
+    }
+    return null;
   }
   /**
    * Get or create a replay session state for a given recording ID
@@ -305,6 +316,27 @@ var ProxyServer = class {
     }
     return session;
   }
+  /**
+   * Clean up a session - removes it from memory and resets counters
+   * @param sessionId The session ID to clean up
+   */
+  async cleanupSession(sessionId) {
+    if (this.replaySessions.has(sessionId)) {
+      console.log(`[CLEANUP] Removing replay session: ${sessionId}`);
+      this.replaySessions.delete(sessionId);
+    }
+    if (this.recordingId === sessionId) {
+      console.log(`[CLEANUP] Saving and clearing active recording session: ${sessionId}`);
+      await this.saveCurrentSession();
+      this.currentSession = null;
+      this.recordingId = null;
+    }
+    if (this.replayId === sessionId) {
+      console.log(`[CLEANUP] Clearing active replay session: ${sessionId}`);
+      this.replayId = null;
+    }
+    console.log(`[CLEANUP] Session ${sessionId} cleaned up successfully`);
+  }
   parseGetParams(req) {
     const url = new URL(req.url || "", `http://${req.headers.host}`);
     const mode = url.searchParams.get("mode");
@@ -328,9 +360,29 @@ var ProxyServer = class {
     throw new Error("Unsupported control method");
   }
   async handleControlRequest(req, res) {
+    if (req.method === "GET") {
+      sendJsonResponse(res, HTTP_STATUS_OK, {
+        recordingsDir: this.recordingsDir,
+        mode: this.mode,
+        id: this.recordingId || this.replayId
+      });
+      return;
+    }
     try {
       const data = await this.parseControlRequest(req);
-      const { mode, id, timeout: requestTimeout } = data;
+      const { mode, id, timeout: requestTimeout, cleanup } = data;
+      if (cleanup && id) {
+        await this.cleanupSession(id);
+        sendJsonResponse(res, HTTP_STATUS_OK, {
+          success: true,
+          message: `Session ${id} cleaned up`,
+          mode: this.mode
+        });
+        return;
+      }
+      if (!mode) {
+        throw new Error("Mode parameter is required when cleanup is not specified");
+      }
       const timeout = requestTimeout ?? DEFAULT_TIMEOUT_MS;
       this.clearModeTimeout();
       await this.switchMode(mode, id);
@@ -346,7 +398,8 @@ var ProxyServer = class {
         success: true,
         mode: this.mode,
         id: this.recordingId || this.replayId,
-        timeout
+        timeout,
+        recordingsDir: this.recordingsDir
       });
     } catch (error) {
       console.error("Control request error:", error);
@@ -421,6 +474,7 @@ var ProxyServer = class {
     console.log(`Switched to replay mode with ID: ${id}`);
   }
   setupModeTimeout(timeout) {
+    clearTimeout(this.modeTimeout || 0);
     this.modeTimeout = setTimeout(async () => {
       console.log("Timeout reached, switching back to transparent mode");
       await this.saveCurrentSession();
@@ -456,7 +510,29 @@ var ProxyServer = class {
     await saveRecordingSession(this.recordingsDir, this.currentSession);
   }
   getRecordingIdOrError(req, res) {
-    const recordingId = this.getRecordingIdFromRequest(req) || this.replayId;
+    const recordingIdFromRequest = this.getRecordingIdFromRequest(req);
+    if (recordingIdFromRequest) {
+      return recordingIdFromRequest;
+    }
+    if (this.replaySessions.size > 1) {
+      console.warn(
+        `[CONCURRENT REPLAY WARNING] Request to ${req.method} ${req.url} is missing ${RECORDING_ID_HEADER} header/cookie. Active sessions: ${[...this.replaySessions.keys()].join(", ")}. this.replayId fallback would be: ${this.replayId} (NOT USING - could be wrong session)`
+      );
+      const corsHeaders = this.getCorsHeaders(req);
+      res.writeHead(HTTP_STATUS_BAD_REQUEST, {
+        "Content-Type": "application/json",
+        ...corsHeaders
+      });
+      res.end(
+        JSON.stringify({
+          error: "Missing recording ID in concurrent replay mode. Ensure x-test-rcrd-id header is set.",
+          activeSessions: [...this.replaySessions.keys()],
+          hint: "This usually means page.setExtraHTTPHeaders() did not apply to this request type"
+        })
+      );
+      return null;
+    }
+    const recordingId = this.replayId;
     if (!recordingId) {
       const corsHeaders = this.getCorsHeaders(req);
       res.writeHead(HTTP_STATUS_BAD_REQUEST, {
@@ -466,6 +542,9 @@ var ProxyServer = class {
       res.end(JSON.stringify({ error: "No replay session active" }));
       return null;
     }
+    console.log(
+      `[FALLBACK] Using replayId fallback for ${req.method} ${req.url} -> session: ${recordingId} (single session mode)`
+    );
     return recordingId;
   }
   async ensureSessionLoaded(recordingId, filePath) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-proxy-recorder",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "HTTP proxy server for recording and replaying network requests in testing. Works seamlessly with Playwright testing framework.",
   "type": "module",
   "main": "dist/index.mjs",