test-proxy-recorder 0.1.4 → 0.1.6

package/dist/proxy.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path2 from 'path';
 import { Command } from 'commander';
 import fs from 'fs/promises';
 import http from 'http';
@@ -38,7 +38,7 @@ function parseCliArgs() {
   if (targets2.length === 0) {
     program.help();
   }
-  const recordingsDir2 = path.resolve(process.cwd(), options.recordingsDir);
+  const recordingsDir2 = path2.resolve(process.cwd(), options.recordingsDir);
   return { targets: targets2, port: port2, recordingsDir: recordingsDir2 };
 }
 
@@ -58,7 +58,7 @@ var Modes = {
 };
 var JSON_INDENT_SPACES = 2;
 function getRecordingPath(recordingsDir2, id) {
-  return path.join(recordingsDir2, `${id}.json`);
+  return path2.join(recordingsDir2, `${id}.mock.json`);
 }
 async function loadRecordingSession(filePath) {
   const fileContent = await fs.readFile(filePath, "utf8");
@@ -66,6 +66,8 @@ async function loadRecordingSession(filePath) {
 }
 async function saveRecordingSession(recordingsDir2, session) {
   const filePath = getRecordingPath(recordingsDir2, session.id);
+  const dirPath = path2.dirname(filePath);
+  await fs.mkdir(dirPath, { recursive: true });
   await fs.writeFile(
     filePath,
     JSON.stringify(session, null, JSON_INDENT_SPACES)
@@ -150,6 +152,7 @@ var ProxyServer = class {
       this.handleUpgrade(req, socket, head);
     });
     server.listen(port2, () => {
+      process.env.TEST_PROXY_RECORDER_PORT = String(port2);
       this.logServerStartup(port2);
     });
     return server;
@@ -158,14 +161,17 @@ var ProxyServer = class {
     this.proxy.on("error", this.handleProxyError.bind(this));
     this.proxy.on("proxyRes", this.handleProxyResponse.bind(this));
   }
-  handleProxyError(err, _req, res) {
+  handleProxyError(err, req, res) {
     console.error("Proxy error:", err);
     if (!(res instanceof http.ServerResponse)) {
       return;
     }
     if (!res.headersSent) {
+      const origin = req.headers.origin;
       res.writeHead(HTTP_STATUS_BAD_GATEWAY, {
-        "Content-Type": "application/json"
+        "Content-Type": "application/json",
+        "Access-Control-Allow-Origin": origin || "*",
+        "Access-Control-Allow-Credentials": "true"
       });
     }
     res.end(JSON.stringify({ error: "Proxy error", message: err.message }));
@@ -221,7 +227,7 @@ var ProxyServer = class {
   async switchMode(mode, id) {
     if (this.currentSession) {
       console.log("Switching mode, saving current session first");
-      await this.saveCurrentSession();
+      await this.saveCurrentSession(true);
       console.log("Session saved, continuing with mode switch");
     }
     switch (mode) {
@@ -276,13 +282,13 @@ var ProxyServer = class {
     if (timeout && timeout > 0) {
       this.modeTimeout = setTimeout(async () => {
         console.log("Timeout reached, switching back to transparent mode");
-        await this.saveCurrentSession();
+        await this.saveCurrentSession(true);
         this.switchToTransparentMode();
         this.modeTimeout = null;
       }, timeout);
     }
   }
-  async saveCurrentSession() {
+  async saveCurrentSession(filterIncomplete = false) {
     if (!this.currentSession) {
       console.log("No current session to save");
       return;
@@ -291,13 +297,27 @@ var ProxyServer = class {
       console.log("Session has no recordings, skipping save");
       return;
     }
+    if (filterIncomplete) {
+      const incompleteCount = this.currentSession.recordings.filter(
+        (r) => !r.response
+      ).length;
+      if (incompleteCount > 0) {
+        console.log(
+          `Removing ${incompleteCount} incomplete recording(s) without responses`
+        );
+        this.currentSession.recordings = this.currentSession.recordings.filter(
+          (r) => r.response
+        );
+      }
+    }
     console.log(
       `Saving session with ${this.currentSession.recordings.length} HTTP and ${this.currentSession.websocketRecordings.length} WebSocket recordings`
     );
     await saveRecordingSession(this.recordingsDir, this.currentSession);
   }
-  async saveRequestRecord(req, body) {
+  saveRequestRecordSync(req, body) {
     if (!this.currentSession) {
+      console.log("saveRequestRecordSync: No current session");
       return;
     }
     const key = getReqID(req);
@@ -315,6 +335,30 @@ var ProxyServer = class {
       sequence: currentSequence
     };
     this.currentSession.recordings.push(record);
+    console.log(
+      // eslint-disable-next-line sonarjs/no-nested-template-literals
+      `saveRequestRecordSync: Saved ${req.method} ${req.url} (key: ${key}, seq: ${currentSequence}, body: ${body ? `${body.length} chars` : "null"}, total: ${this.currentSession.recordings.length}, sessionId: ${this.currentSession.id})`
+    );
+  }
+  updateRequestBodySync(req, body) {
+    if (!this.currentSession) {
+      console.log("updateRequestBodySync: No current session");
+      return;
+    }
+    const key = getReqID(req);
+    const record = this.currentSession.recordings.findLast(
+      (r) => r.key === key && !r.response
+    );
+    if (!record) {
+      console.error(
+        `updateRequestBodySync: Could not find request record for ${req.method} ${req.url}`
+      );
+      return;
+    }
+    record.request.body = body || null;
+    console.log(
+      `updateRequestBodySync: Updated body for ${req.method} ${req.url} (${body.length} chars)`
+    );
   }
   async recordResponse(req, proxyRes) {
     if (!this.currentSession) {
@@ -343,49 +387,105 @@ var ProxyServer = class {
       console.log(`Recorded: ${req.method} ${req.url}`);
     });
   }
+  async recordResponseData(req, proxyRes, body) {
+    if (!this.currentSession) {
+      console.log("recordResponseData: No current session");
+      return false;
+    }
+    const key = getReqID(req);
+    const record = this.currentSession.recordings.findLast(
+      (r) => r.key === key && !r.response
+    );
+    if (!record) {
+      const host = req.headers.host || "unknown";
+      const recordsWithKey = this.currentSession.recordings.filter(
+        (r) => r.key === key
+      );
+      console.error(
+        `Request record not found for response: ${key} at ${req.method} ${host}${req.url}`
+      );
+      console.error(
+        `  Total recordings: ${this.currentSession.recordings.length}, with this key: ${recordsWithKey.length}`
+      );
+      console.error(
+        `  Records with key:`,
+        recordsWithKey.map((r) => ({
+          seq: r.sequence,
+          hasResponse: !!r.response
+        }))
+      );
+      return false;
+    }
+    record.response = {
+      statusCode: proxyRes.statusCode,
+      headers: proxyRes.headers,
+      body: body || null
+    };
+    await this.saveCurrentSession();
+    console.log(
+      `recordResponseData: Recorded response for ${req.method} ${req.url}`
+    );
+    return true;
+  }
   async handleReplayRequest(req, res) {
     const key = getReqID(req);
     const filePath = getRecordingPath(this.recordingsDir, this.replayId);
     try {
       const session = await loadRecordingSession(filePath);
-      const currentSequence = this.replaySequenceMap.get(key) || 0;
-      const record = session.recordings.find(
-        (r) => r.key === key && r.sequence === currentSequence
+      const host = req.headers.host || "unknown";
+      const recordsWithKey = session.recordings.filter(
+        (r) => r.key === key && r.response
       );
-      if (!record) {
+      if (recordsWithKey.length === 0) {
         throw new Error(
-          `No recording found for ${key} with sequence ${currentSequence}`
+          `No recording found for ${key} at ${req.method} ${host}${req.url}`
         );
       }
+      const usageCount = this.replaySequenceMap.get(key) || 0;
+      const recordIndex = usageCount % recordsWithKey.length;
+      const record = recordsWithKey[recordIndex];
+      console.log(
+        `Replaying ${req.method} ${req.url} (usage: ${usageCount}, using recording ${recordIndex}/${recordsWithKey.length})`
+      );
+      this.replaySequenceMap.set(key, usageCount + 1);
       if (!record.response) {
-        throw new Error("No response recorded for this request");
+        throw new Error(
+          `No response recorded for this request: ${req.method} ${host}${req.url}`
+        );
       }
-      this.replaySequenceMap.set(key, currentSequence + 1);
       const { statusCode, headers, body } = record.response;
       const origin = req.headers.origin;
       const responseHeaders = {
         ...headers,
         "access-control-allow-origin": origin || "*",
-        "access-control-allow-credentials": "true"
+        "access-control-allow-credentials": "true",
+        "access-control-allow-headers": req.headers["access-control-request-headers"] || "Origin, X-Requested-With, Content-Type, Accept, Authorization",
+        "access-control-allow-methods": "GET, POST, PUT, DELETE, PATCH, OPTIONS",
+        "access-control-expose-headers": "*"
       };
       res.writeHead(statusCode, responseHeaders);
       res.end(body);
-      console.log(
-        `Replayed: ${req.method} ${req.url} (sequence: ${currentSequence})`
-      );
     } catch (error) {
-      this.handleReplayError(res, error, key, filePath);
+      this.handleReplayError(req, res, error, key, filePath);
     }
   }
-  handleReplayError(res, err, key, filePath) {
+  handleReplayError(req, res, err, key, filePath) {
     const isFileNotFound = err instanceof Error && "code" in err && err.code === "ENOENT";
     console.error("Replay error:", err);
-    sendJsonResponse(res, HTTP_STATUS_NOT_FOUND, {
-      error: isFileNotFound ? "Recording file not found" : "Recording not found",
-      message: err instanceof Error ? err.message : "Unknown error",
-      key,
-      filePath
+    const origin = req.headers.origin;
+    res.writeHead(HTTP_STATUS_NOT_FOUND, {
+      "Content-Type": "application/json",
+      "Access-Control-Allow-Origin": origin || "*",
+      "Access-Control-Allow-Credentials": "true"
     });
+    res.end(
+      JSON.stringify({
+        error: isFileNotFound ? "Recording file not found" : "Recording not found",
+        message: err instanceof Error ? err.message : "Unknown error",
+        key,
+        filePath
+      })
+    );
   }
   async handleRequest(req, res) {
     if (req.method === "OPTIONS") {
@@ -415,6 +515,7 @@ 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);
     } else {
       this.proxy.web(req, res, { target });
@@ -425,11 +526,20 @@ var ProxyServer = class {
     req.on("data", (chunk) => {
       chunks.push(chunk);
     });
-    await new Promise((resolve) => {
-      req.on("end", () => resolve());
-    });
+    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);
+    }
     const body = Buffer.concat(chunks).toString("utf8");
-    await this.saveRequestRecord(req, body);
+    this.updateRequestBodySync(req, body);
     const targetUrl = new URL(target);
     const isHttps = targetUrl.protocol === "https:";
     const requestModule = isHttps ? https : http;
@@ -444,9 +554,38 @@ var ProxyServer = class {
       },
       (proxyRes) => {
         this.addCorsHeaders(proxyRes, req);
-        this.recordResponse(req, proxyRes);
-        res.writeHead(proxyRes.statusCode || 200, proxyRes.headers);
-        proxyRes.pipe(res);
+        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 origin = req.headers.origin;
+          const responseHeaders = {
+            ...proxyRes.headers,
+            "access-control-allow-origin": origin || "*",
+            "access-control-allow-credentials": "true",
+            "access-control-allow-headers": req.headers["access-control-request-headers"] || "Origin, X-Requested-With, Content-Type, Accept, Authorization",
+            "access-control-allow-methods": "GET, POST, PUT, DELETE, PATCH, OPTIONS",
+            "access-control-expose-headers": "*"
+          };
+          res.writeHead(proxyRes.statusCode || 200, responseHeaders);
+          res.end(responseBody);
+          if (recorded) {
+            console.log(`Recorded: ${req.method} ${req.url}`);
+          }
+        });
+        proxyRes.on("error", (err) => {
+          console.error("Proxy response error:", err);
+          if (!res.headersSent) {
+            this.handleProxyError(err, req, res);
+          }
+        });
       }
     );
     proxyReq.on("error", (err) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-proxy-recorder",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "HTTP proxy server for recording and replaying network requests in testing. Works seamlessly with Playwright testing framework.",
   "type": "module",
   "main": "dist/index.mjs",
@@ -32,6 +32,9 @@
     "README.md",
     "LICENSE"
   ],
+  "pnpm": {
+    "onlyBuiltDependencies": ["esbuild"]
+  },
   "packageManager": "pnpm@10.20.0+sha512.cf9998222162dd85864d0a8102e7892e7ba4ceadebbf5a31f9c2fce48dfce317a9c53b9f6464d1ef9042cba2e02ae02a9f7c143a2b438cd93c91840f0192b9dd",
   "scripts": {
     "start": "node dist/proxy.js",
@@ -42,7 +45,8 @@
     "lint:fix": "eslint src --ext .ts --fix",
     "typecheck": "tsc --noEmit",
     "test": "vitest",
-    "test:run": "vitest run"
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage"
   },
   "keywords": [
     "playwright",
@@ -91,6 +95,7 @@
     "@types/ws": "^8.18.1",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
+    "@vitest/coverage-v8": "^4.0.8",
     "eslint": "^9.0.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.4",
@@ -101,7 +106,7 @@
     "tsup": "^8.5.0",
     "tsx": "^4.19.0",
     "typescript": "^5.6.0",
-    "vitest": "^3.2.4",
+    "vitest": "^4.0.8",
     "ws": "^8.18.3"
   }
 }