test-proxy-recorder 0.3.0 → 0.3.1

package/dist/proxy.js

@@ -23,7 +23,7 @@ function parseCliArgs() {
     "Port number for the proxy server",
     String(DEFAULT_PORT)
   ).option(
-    "-r, --recordings-dir <path>",
+    "-d, --dir <path>",
     "Directory to store recordings (relative to CWD)",
     DEFAULT_RECORDINGS_DIR
   ).action(() => {
@@ -39,7 +39,7 @@ function parseCliArgs() {
   if (targets2.length === 0) {
     program.help();
   }
-  const recordingsDir2 = path.resolve(process.cwd(), options.recordingsDir);
+  const recordingsDir2 = path.resolve(process.cwd(), options.dir);
   return { targets: targets2, port: port2, recordingsDir: recordingsDir2 };
 }
 
@@ -84,13 +84,23 @@ async function loadRecordingSession(filePath) {
   return JSON.parse(fileContent);
 }
 function processRecordings(recordings) {
-  const keySequenceMap = /* @__PURE__ */ new Map();
-  return recordings.map((recording) => {
+  const recordingsByKey = /* @__PURE__ */ new Map();
+  for (const recording of recordings) {
     const key = recording.key;
-    const currentSeq = keySequenceMap.get(key) || 0;
-    keySequenceMap.set(key, currentSeq + 1);
-    return { ...recording, sequence: currentSeq };
-  });
+    if (!recordingsByKey.has(key)) {
+      recordingsByKey.set(key, []);
+    }
+    recordingsByKey.get(key).push(recording);
+  }
+  const processedRecordings = [];
+  for (const [_key, keyRecordings] of recordingsByKey) {
+    keyRecordings.sort((a, b) => a.recordingId - b.recordingId);
+    keyRecordings.forEach((recording, index) => {
+      processedRecordings.push({ ...recording, sequence: index });
+    });
+  }
+  processedRecordings.sort((a, b) => a.recordingId - b.recordingId);
+  return processedRecordings;
 }
 async function saveRecordingSession(recordingsDir2, session) {
   const filePath = getRecordingPath(recordingsDir2, session.id);
@@ -153,19 +163,25 @@ var ProxyServer = class {
   recordingsDir;
   recordingIdCounter;
   // Unique ID for each recording entry
+  sequenceCounterByKey;
+  // Sequence counter per key (endpoint)
   replaySessions;
   // Track multiple concurrent replay sessions by recording ID
+  recordingPromises;
+  // Stack of promises that resolve to completed recordings
   constructor(targets2, recordingsDir2) {
     this.targets = targets2;
     this.currentTargetIndex = 0;
     this.mode = Modes.transparent;
     this.recordingId = null;
     this.recordingIdCounter = 0;
+    this.sequenceCounterByKey = /* @__PURE__ */ new Map();
     this.replayId = null;
     this.modeTimeout = null;
     this.currentSession = null;
     this.recordingsDir = recordingsDir2;
     this.replaySessions = /* @__PURE__ */ new Map();
+    this.recordingPromises = [];
     this.proxy = httpProxy.createProxyServer({
       secure: false,
       changeOrigin: true,
@@ -191,7 +207,7 @@ var ProxyServer = class {
   }
   setupProxyEventHandlers() {
     this.proxy.on("error", this.handleProxyError.bind(this));
-    this.proxy.on("proxyRes", this.handleProxyResponse.bind(this));
+    this.proxy.on("proxyRes", this.addCorsHeaders.bind(this));
   }
   handleProxyError(err, req, res) {
     console.error("Proxy error:", err);
@@ -207,12 +223,6 @@ var ProxyServer = class {
     }
     res.end(JSON.stringify({ error: "Proxy error", message: err.message }));
   }
-  handleProxyResponse(proxyRes, req) {
-    this.addCorsHeaders(proxyRes, req);
-    if (this.mode === Modes.record && this.recordingId) {
-      this.recordResponse(req, proxyRes);
-    }
-  }
   /**
    * Get CORS headers for a given request
    * @param req The incoming HTTP request
@@ -306,18 +316,20 @@ var ProxyServer = class {
     }
     return { mode, id, timeout };
   }
+  async parseControlRequest(req) {
+    if (req.method === "GET") {
+      return this.parseGetParams(req);
+    }
+    if (req.method === "POST") {
+      const body = await readRequestBody(req);
+      console.log(`MODE CHANGE (${req.method})`, body);
+      return JSON.parse(body);
+    }
+    throw new Error("Unsupported control method");
+  }
   async handleControlRequest(req, res) {
     try {
-      let data;
-      if (req.method === "GET") {
-        data = this.parseGetParams(req);
-      } else if (req.method === "POST") {
-        const body = await readRequestBody(req);
-        console.log(`MODE CHANGE (${req.method})`, body);
-        data = JSON.parse(body);
-      } else {
-        return;
-      }
+      const data = await this.parseControlRequest(req);
       const { mode, id, timeout: requestTimeout } = data;
       const timeout = requestTimeout ?? DEFAULT_TIMEOUT_MS;
       this.clearModeTimeout();
@@ -350,7 +362,7 @@ var ProxyServer = class {
   async switchMode(mode, id) {
     console.log(`Switching to ${mode.toUpperCase()} mode`);
     if (this.currentSession && this.mode === Modes.record) {
-      await this.saveCurrentSession(true);
+      await this.saveCurrentSession();
       console.log("Session saved, continuing with mode switch");
     }
     switch (mode) {
@@ -390,6 +402,8 @@ var ProxyServer = class {
     this.recordingId = id;
     this.replayId = null;
     this.currentSession = { id, recordings: [], websocketRecordings: [] };
+    this.recordingIdCounter = 0;
+    this.sequenceCounterByKey.clear();
     console.log(`Switched to record mode with ID: ${id}`);
   }
   async switchToReplayMode(id) {
@@ -409,146 +423,39 @@ var ProxyServer = class {
   setupModeTimeout(timeout) {
     this.modeTimeout = setTimeout(async () => {
       console.log("Timeout reached, switching back to transparent mode");
-      await this.saveCurrentSession(true);
+      await this.saveCurrentSession();
       this.switchToTransparentMode();
       this.modeTimeout = null;
     }, timeout);
   }
-  async saveCurrentSession(filterIncomplete = false) {
-    if (!this.currentSession) {
+  async flushPendingRecordings() {
+    if (this.recordingPromises.length === 0) {
       return;
     }
-    if (filterIncomplete) {
-      const incompleteCount = this.currentSession.recordings.filter(
-        (r) => !r.response
-      ).length;
-      if (incompleteCount > 0) {
-        this.currentSession.recordings = this.currentSession.recordings.filter(
-          (r) => r.response
-        );
+    const results = await Promise.allSettled(this.recordingPromises);
+    if (this.currentSession) {
+      for (const result of results) {
+        if (result.status === "fulfilled" && result.value) {
+          this.currentSession.recordings.push(result.value);
+        }
       }
-    }
-    console.log(
-      `Saving session with ${this.currentSession.recordings.length} HTTP and ${this.currentSession.websocketRecordings.length} WebSocket recordings`
-    );
-    await saveRecordingSession(this.recordingsDir, this.currentSession);
-  }
-  saveRequestRecordSync(req, body) {
-    if (!this.currentSession) {
-      return;
-    }
-    const key = getReqID(req);
-    const recordingId = this.recordingIdCounter++;
-    req.__recordingId = recordingId;
-    const record = {
-      request: {
-        method: req.method,
-        url: req.url,
-        headers: req.headers,
-        body: body || null
-      },
-      timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      key,
-      recordingId
-    };
-    this.currentSession.recordings.push(record);
-    console.log(
-      // eslint-disable-next-line sonarjs/no-nested-template-literals
-      `saveRequestRecordSync: Saved ${req.method} ${req.url} (key: ${key}, recordingId: ${recordingId}, body: ${body ? `${body.length} chars` : "null"}, total: ${this.currentSession.recordings.length}, sessionId: ${this.currentSession.id})`
-    );
-  }
-  updateRequestBodySync(req, body) {
-    if (!this.currentSession) {
-      return;
-    }
-    const recordingId = req.__recordingId;
-    if (recordingId === void 0) {
-      console.error(
-        `updateRequestBodySync: No recording ID found on request ${req.method} ${req.url}`
-      );
-      return;
-    }
-    const record = this.currentSession.recordings.find(
-      (r) => r.recordingId === recordingId
-    );
-    if (!record) {
-      console.error(
-        `updateRequestBodySync: Could not find recording with ID ${recordingId} for ${req.method} ${req.url}`
+      console.log(
+        `Flushed ${results.length} recordings to session (total: ${this.currentSession.recordings.length})`
       );
-      return;
     }
-    record.request.body = body || null;
-    console.log(
-      `updateRequestBodySync: Updated body for ${req.method} ${req.url} (${body.length} chars, recordingId: ${recordingId})`
-    );
+    this.recordingPromises = [];
   }
-  async recordResponse(req, proxyRes) {
+  async saveCurrentSession() {
     if (!this.currentSession) {
       return;
     }
-    const recordingId = req.__recordingId;
-    if (recordingId === void 0) {
-      console.error(
-        `recordResponse: No recording ID found on request ${req.method} ${req.url}`
-      );
-      return;
-    }
-    const record = this.currentSession.recordings.find(
-      (r) => r.recordingId === recordingId
-    );
-    if (!record) {
-      console.error(
-        `recordResponse: Could not find recording with ID ${recordingId} for ${req.method} ${req.url}`
-      );
-      return;
-    }
-    const chunks = [];
-    proxyRes.on("data", (chunk) => {
-      chunks.push(chunk);
-    });
-    proxyRes.on("end", async () => {
-      const body = Buffer.concat(chunks).toString("utf8");
-      record.response = {
-        statusCode: proxyRes.statusCode,
-        headers: proxyRes.headers,
-        body: body || null
-      };
-      console.log(
-        `Recorded: ${req.method} ${req.url} (recordingId: ${recordingId})`
-      );
-    });
-  }
-  async recordResponseData(req, proxyRes, body) {
-    if (!this.currentSession) {
-      return false;
-    }
-    const recordingId = req.__recordingId;
-    if (recordingId === void 0) {
-      console.error(
-        `recordResponseData: No recording ID found on request ${req.method} ${req.url}`
-      );
-      return false;
-    }
-    const record = this.currentSession.recordings.find(
-      (r) => r.recordingId === recordingId
-    );
-    if (!record) {
-      console.error(
-        `recordResponseData: Could not find recording with ID ${recordingId} for ${req.method} ${req.url}`
-      );
-      return false;
-    }
-    record.response = {
-      statusCode: proxyRes.statusCode,
-      headers: proxyRes.headers,
-      body: body || null
-    };
+    await this.flushPendingRecordings();
     console.log(
-      `recordResponseData: Recorded response for ${req.method} ${req.url} (recordingId: ${recordingId})`
+      `Saving session with ${this.currentSession.recordings.length} HTTP and ${this.currentSession.websocketRecordings.length} WebSocket recordings`
     );
-    return true;
+    await saveRecordingSession(this.recordingsDir, this.currentSession);
   }
-  async handleReplayRequest(req, res) {
+  getRecordingIdOrError(req, res) {
     const recordingId = this.getRecordingIdFromRequest(req) || this.replayId;
     if (!recordingId) {
       const corsHeaders = this.getCorsHeaders(req);
@@ -557,21 +464,50 @@ var ProxyServer = class {
         ...corsHeaders
       });
       res.end(JSON.stringify({ error: "No replay session active" }));
-      return;
+      return null;
+    }
+    return recordingId;
+  }
+  async ensureSessionLoaded(recordingId, filePath) {
+    const sessionState = this.getOrCreateReplaySession(recordingId);
+    if (!sessionState.loadedSession) {
+      sessionState.loadedSession = await loadRecordingSession(filePath);
+      console.log(`[REPLAY] Loaded recording session: ${recordingId}`);
+    }
+    return sessionState;
+  }
+  getServedTracker(sessionState, key) {
+    if (!sessionState.servedRecordingIdsByKey.has(key)) {
+      sessionState.servedRecordingIdsByKey.set(key, /* @__PURE__ */ new Set());
+    }
+    return sessionState.servedRecordingIdsByKey.get(key);
+  }
+  selectReplayRecord(recordsWithKey, servedForThisKey, key, recordingId) {
+    for (const rec of recordsWithKey) {
+      if (!servedForThisKey.has(rec.recordingId)) {
+        return rec;
+      }
     }
+    if (recordsWithKey.length > 0) {
+      console.log(
+        `[REPLAY WARNING] All ${recordsWithKey.length} recordings already served for ${key} (session: ${recordingId}), reusing last one`
+      );
+      return recordsWithKey[recordsWithKey.length - 1];
+    }
+    return null;
+  }
+  async handleReplayRequest(req, res) {
+    const recordingId = this.getRecordingIdOrError(req, res);
+    if (!recordingId) return;
     const key = getReqID(req);
     const filePath = getRecordingPath(this.recordingsDir, recordingId);
     try {
-      const sessionState = this.getOrCreateReplaySession(recordingId);
-      if (!sessionState.loadedSession) {
-        sessionState.loadedSession = await loadRecordingSession(filePath);
-        console.log(`[REPLAY] Loaded recording session: ${recordingId}`);
-      }
+      const sessionState = await this.ensureSessionLoaded(
+        recordingId,
+        filePath
+      );
       const session = sessionState.loadedSession;
-      if (!sessionState.servedRecordingIdsByKey.has(key)) {
-        sessionState.servedRecordingIdsByKey.set(key, /* @__PURE__ */ new Set());
-      }
-      const servedForThisKey = sessionState.servedRecordingIdsByKey.get(key);
+      const servedForThisKey = this.getServedTracker(sessionState, key);
       const host = req.headers.host || "unknown";
       const recordsWithKey = session.recordings.filter((r) => r.key === key && r.response).toSorted((a, b) => {
         const aSeq = a.sequence !== void 0 ? a.sequence : a.recordingId;
@@ -600,30 +536,23 @@ var ProxyServer = class {
       }
       const requestCount = servedForThisKey.size + 1;
       console.log(
-        `[replay request #${requestCount}] ${req.method} ${req.url} (session: ${recordingId}, total: ${recordsWithKey.length}, served: ${servedForThisKey.size})`
+        `[replay request #${requestCount}] ${req.method} ${req.url} (key: ${key}, session: ${recordingId}, total: ${recordsWithKey.length}, served: ${servedForThisKey.size})`
       );
-      let record;
-      for (const rec of recordsWithKey) {
-        if (!servedForThisKey.has(rec.recordingId)) {
-          record = rec;
-          break;
-        }
-      }
-      if (!record) {
-        console.log(
-          `[REPLAY WARNING] All ${recordsWithKey.length} recordings already served for ${key} (session: ${recordingId}), reusing last one`
+      const record = this.selectReplayRecord(
+        recordsWithKey,
+        servedForThisKey,
+        key,
+        recordingId
+      );
+      if (!record || !record.response) {
+        throw new Error(
+          `No response recorded for this request: ${req.method} ${host}${req.url}`
         );
-        record = recordsWithKey[recordsWithKey.length - 1];
       }
       servedForThisKey.add(record.recordingId);
       console.log(
         `[replay serving] recordingId: ${record.recordingId}, session: ${recordingId}, body_len: ${record.response?.body?.length || 0}`
       );
-      if (!record.response) {
-        throw new Error(
-          `No response recorded for this request: ${req.method} ${host}${req.url}`
-        );
-      }
       const { statusCode, headers, body } = record.response;
       const responseHeaders = {
         ...headers,
@@ -678,82 +607,124 @@ var ProxyServer = class {
     const target = this.getTarget();
     console.log(`[${this.mode}] ${req.method} ${req.url} -> ${target}`);
     if (this.mode === Modes.record) {
-      this.saveRequestRecordSync(req, null);
-      await this.bufferAndProxyRequest(req, res, target);
+      await this.recordAndProxyRequest(req, res, target);
     } else {
       this.proxy.web(req, res, { target });
     }
   }
-  // TODO: check if can handle streaming requests
-  async bufferAndProxyRequest(req, res, target) {
-    const chunks = [];
-    req.on("data", (chunk) => {
-      chunks.push(chunk);
-    });
-    try {
-      await new Promise((resolve, reject) => {
-        req.on("end", () => resolve());
-        req.on("error", (err) => reject(err));
-        setTimeout(
-          () => reject(new Error("Request buffering timeout")),
-          3e4
-        );
-      });
-    } catch (error) {
-      console.error("Error buffering request:", error);
+  // Note: streaming requests are buffered before proxying; streaming passthrough is not yet implemented
+  async recordAndProxyRequest(req, res, target) {
+    if (!this.currentSession) {
+      return;
     }
-    const body = Buffer.concat(chunks).toString("utf8");
-    this.updateRequestBodySync(req, body);
-    const targetUrl = new URL(target);
-    const isHttps = targetUrl.protocol === "https:";
-    const requestModule = isHttps ? https : http;
-    const defaultPort = isHttps ? 443 : 80;
-    const proxyReq = requestModule.request(
-      {
-        hostname: targetUrl.hostname,
-        port: targetUrl.port || defaultPort,
-        path: req.url,
-        method: req.method,
-        headers: req.headers
-      },
-      (proxyRes) => {
-        this.addCorsHeaders(proxyRes, req);
-        const responseChunks = [];
-        proxyRes.on("data", (chunk) => {
-          responseChunks.push(chunk);
-        });
-        proxyRes.on("end", async () => {
-          const responseBody = Buffer.concat(responseChunks);
-          const recorded = await this.recordResponseData(
-            req,
-            proxyRes,
-            responseBody.toString("utf8")
-          );
-          const responseHeaders = {
-            ...proxyRes.headers,
-            ...this.getCorsHeaders(req)
-          };
-          res.writeHead(proxyRes.statusCode || 200, responseHeaders);
-          res.end(responseBody);
-          if (recorded) {
-            console.log(`Recorded: ${req.method} ${req.url}`);
+    const key = getReqID(req);
+    const recordingId = this.recordingIdCounter++;
+    const sequence = this.sequenceCounterByKey.get(key) || 0;
+    this.sequenceCounterByKey.set(key, sequence + 1);
+    const recordingPromise = new Promise((resolve) => {
+      (async () => {
+        try {
+          const chunks = [];
+          req.on("data", (chunk) => {
+            chunks.push(chunk);
+          });
+          try {
+            await new Promise((resolveBuffer, rejectBuffer) => {
+              req.on("end", () => resolveBuffer());
+              req.on("error", (err) => rejectBuffer(err));
+              setTimeout(
+                () => rejectBuffer(new Error("Request buffering timeout")),
+                3e4
+              );
+            });
+          } catch (error) {
+            console.error("Error buffering request:", error);
           }
-        });
-        proxyRes.on("error", (err) => {
-          console.error("Proxy response error:", err);
-          if (!res.headersSent) {
+          const requestBody = Buffer.concat(chunks).toString("utf8");
+          const targetUrl = new URL(target);
+          const isHttps = targetUrl.protocol === "https:";
+          const requestModule = isHttps ? https : http;
+          const defaultPort = isHttps ? 443 : 80;
+          const proxyReq = requestModule.request(
+            {
+              hostname: targetUrl.hostname,
+              port: targetUrl.port || defaultPort,
+              path: req.url,
+              method: req.method,
+              headers: req.headers
+            },
+            (proxyRes) => {
+              this.addCorsHeaders(proxyRes, req);
+              const responseChunks = [];
+              proxyRes.on("data", (chunk) => {
+                responseChunks.push(chunk);
+              });
+              proxyRes.on("end", async () => {
+                try {
+                  const responseBody = Buffer.concat(responseChunks);
+                  const responseBodyStr = responseBody.toString("utf8");
+                  const recording = {
+                    request: {
+                      method: req.method,
+                      url: req.url,
+                      headers: req.headers,
+                      body: requestBody || null
+                    },
+                    response: {
+                      statusCode: proxyRes.statusCode,
+                      headers: proxyRes.headers,
+                      body: responseBodyStr || null
+                    },
+                    timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+                    key,
+                    recordingId,
+                    sequence
+                  };
+                  const responseHeaders = {
+                    ...proxyRes.headers,
+                    ...this.getCorsHeaders(req)
+                  };
+                  res.writeHead(proxyRes.statusCode || 200, responseHeaders);
+                  res.end(responseBody);
+                  console.log(
+                    `Recorded: ${req.method} ${req.url} (recordingId: ${recordingId}, sequence: ${sequence})`
+                  );
+                  resolve(recording);
+                } catch (error) {
+                  console.error("Error completing recording:", error);
+                  resolve(null);
+                }
+              });
+              proxyRes.on("error", (err) => {
+                console.error("Proxy response error:", err);
+                if (!res.headersSent) {
+                  this.handleProxyError(err, req, res);
+                }
+                resolve(null);
+              });
+            }
+          );
+          proxyReq.on("error", (err) => {
             this.handleProxyError(err, req, res);
+            resolve(null);
+          });
+          if (chunks.length > 0) {
+            proxyReq.write(Buffer.concat(chunks));
           }
-        });
-      }
-    );
-    proxyReq.on("error", (err) => {
-      this.handleProxyError(err, req, res);
+          proxyReq.end();
+        } catch (error) {
+          console.error("Error in recordAndProxyRequest:", error);
+          try {
+            this.handleProxyError(error, req, res);
+          } catch (error_) {
+            console.error("Failed to handle proxy error:", error_);
+          }
+          resolve(null);
+        }
+      })();
     });
-    if (chunks.length > 0) {
-      proxyReq.write(Buffer.concat(chunks));
-    }
-    proxyReq.end();
+    this.recordingPromises.push(recordingPromise);
+    await recordingPromise;
   }
   handleUpgrade(req, socket, head) {
     if (this.mode === Modes.replay) {

package/package.json

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