test-proxy-recorder 0.1.5 → 0.1.7

package/dist/proxy.js

@@ -161,14 +161,16 @@ 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 corsHeaders = this.getCorsHeaders(req);
       res.writeHead(HTTP_STATUS_BAD_GATEWAY, {
-        "Content-Type": "application/json"
+        "Content-Type": "application/json",
+        ...corsHeaders
       });
     }
     res.end(JSON.stringify({ error: "Proxy error", message: err.message }));
@@ -179,24 +181,51 @@ var ProxyServer = class {
       this.recordResponse(req, proxyRes);
     }
   }
-  addCorsHeaders(proxyRes, req) {
+  /**
+   * Get CORS headers for a given request
+   * @param req The incoming HTTP request
+   * @returns An object containing CORS headers
+   */
+  getCorsHeaders(req) {
     const origin = req.headers.origin;
-    proxyRes.headers["access-control-allow-origin"] = origin || "*";
-    proxyRes.headers["access-control-allow-credentials"] = "true";
-    proxyRes.headers["access-control-allow-headers"] = req.headers["access-control-request-headers"] || "Origin, X-Requested-With, Content-Type, Accept, Authorization";
-    proxyRes.headers["access-control-allow-methods"] = "GET, POST, PUT, DELETE, PATCH, OPTIONS";
-    proxyRes.headers["access-control-expose-headers"] = "*";
+    return {
+      "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": "*"
+    };
+  }
+  addCorsHeaders(proxyRes, req) {
+    const corsHeaders = this.getCorsHeaders(req);
+    Object.assign(proxyRes.headers, corsHeaders);
   }
   getTarget() {
     const target = this.targets[this.currentTargetIndex];
     this.currentTargetIndex = (this.currentTargetIndex + 1) % this.targets.length;
     return target;
   }
+  parseGetParams(req) {
+    const url = new URL(req.url || "", `http://${req.headers.host}`);
+    const mode = url.searchParams.get("mode");
+    const id = url.searchParams.get("id") || void 0;
+    const timeoutParam = url.searchParams.get("timeout");
+    const timeout = timeoutParam ? Number.parseInt(timeoutParam, 10) : void 0;
+    if (!mode) {
+      throw new Error("Mode parameter is required");
+    }
+    return { mode, id, timeout };
+  }
   async handleControlRequest(req, res) {
     try {
-      const body = await readRequestBody(req);
-      console.log("MODE CHANGE", body);
-      const data = JSON.parse(body);
+      let data;
+      if (req.method === "GET") {
+        data = this.parseGetParams(req);
+      } else {
+        const body = await readRequestBody(req);
+        console.log("MODE CHANGE (POST)", body);
+        data = JSON.parse(body);
+      }
       const { mode, id, timeout: requestTimeout } = data;
       const timeout = requestTimeout ?? DEFAULT_TIMEOUT_MS;
       this.clearModeTimeout();
@@ -224,7 +253,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) {
@@ -279,33 +308,41 @@ 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;
     }
-    if (this.currentSession.recordings.length === 0 && this.currentSession.websocketRecordings.length === 0) {
-      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);
-    const currentSequence = this.requestSequenceMap.get(key) || 0;
-    this.requestSequenceMap.set(key, currentSequence + 1);
     const record = {
       request: {
         method: req.method,
@@ -315,9 +352,34 @@ var ProxyServer = class {
       },
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
       key,
-      sequence: currentSequence
+      sequence: -1
+      // Temporary, will be set when response arrives
     };
     this.currentSession.recordings.push(record);
+    console.log(
+      // eslint-disable-next-line sonarjs/no-nested-template-literals
+      `saveRequestRecordSync: Saved ${req.method} ${req.url} (key: ${key}, 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) {
@@ -342,59 +404,115 @@ var ProxyServer = class {
         headers: proxyRes.headers,
         body: body || null
       };
-      await this.saveCurrentSession();
       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
+    };
+    record.timestamp = (/* @__PURE__ */ new Date()).toISOString();
+    const currentSequence = this.requestSequenceMap.get(key) || 0;
+    record.sequence = currentSequence;
+    this.requestSequenceMap.set(key, currentSequence + 1);
+    console.log(
+      `recordResponseData: Recorded response for ${req.method} ${req.url} (seq: ${record.sequence})`
+    );
+    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
-      );
-      if (!record) {
+      const host = req.headers.host || "unknown";
+      const recordsWithKey = session.recordings.filter((r) => r.key === key && r.response).toSorted((a, b) => a.sequence - b.sequence);
+      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;
+      let record;
+      if (recordsWithKey.length > 1) {
+        record = recordsWithKey[recordsWithKey.length - 1];
+      } else {
+        const recordIndex = usageCount % recordsWithKey.length;
+        record = recordsWithKey[recordIndex];
+      }
+      console.log(
+        `Replaying ${req.method} ${req.url} (usage: ${usageCount}, sequence: ${record.sequence}, body_len: ${record.response?.body?.length || 0})`
+      );
+      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"
+        ...this.getCorsHeaders(req)
       };
       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 corsHeaders = this.getCorsHeaders(req);
+    res.writeHead(HTTP_STATUS_NOT_FOUND, {
+      "Content-Type": "application/json",
+      ...corsHeaders
     });
+    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") {
       return this.handleCorsPreflightRequest(req, res);
     }
-    if (req.url === CONTROL_ENDPOINT) {
+    const urlPath = req.url?.split("?")[0] || "";
+    if (urlPath === CONTROL_ENDPOINT) {
       return this.handleControlRequest(req, res);
     }
     if (this.mode === Modes.replay) {
@@ -403,12 +521,9 @@ var ProxyServer = class {
     await this.handleProxyRequest(req, res);
   }
   handleCorsPreflightRequest(req, res) {
-    const origin = req.headers.origin;
+    const corsHeaders = this.getCorsHeaders(req);
     res.writeHead(HTTP_STATUS_OK, {
-      "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",
+      ...corsHeaders,
       "Access-Control-Max-Age": "86400"
       // 24 hours
     });
@@ -418,6 +533,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 });
@@ -428,11 +544,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;
@@ -447,9 +572,33 @@ 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 responseHeaders = {
+            ...proxyRes.headers,
+            ...this.getCorsHeaders(req)
+          };
+          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) => {
@@ -501,9 +650,6 @@ var ProxyServer = class {
           if (backendWs.readyState === WebSocket.OPEN) {
             backendWs.send(message);
           }
-          this.saveCurrentSession().catch((error) => {
-            console.error("Failed to save WebSocket recording:", error);
-          });
         });
         backendWs.on("message", (data) => {
           const message = data.toString();
@@ -515,9 +661,6 @@ var ProxyServer = class {
           if (clientWs.readyState === WebSocket.OPEN) {
             clientWs.send(message);
           }
-          this.saveCurrentSession().catch((error) => {
-            console.error("Failed to save WebSocket recording:", error);
-          });
         });
         clientWs.on("error", (err) => {
           console.error("Client WebSocket error:", err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-proxy-recorder",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "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"
   }
 }