test-proxy-recorder 0.1.9 → 0.1.11

package/README.md

@@ -102,7 +102,7 @@ Create `e2e/global-teardown.ts`:
 import { setProxyMode } from 'test-proxy-recorder';
 
 async function globalTeardown() {
-  await setProxyMode('transparent');
+  await setProxyMode('transparent').catch(err => { console.error(err) });
 }
 
 export default globalTeardown;
@@ -247,7 +247,7 @@ Create `e2e/global-teardown.ts`:
 import { setProxyMode } from 'test-proxy-recorder';
 
 async function globalTeardown() {
-  await setProxyMode('transparent');
+  await setProxyMode('transparent').catch(err => { console.error(err) });
 }
 
 export default globalTeardown;

package/dist/{index-CG-XcFDa.d.cts → index-Cx_Kflfl.d.cts}

@@ -28,7 +28,7 @@ interface Recording {
     response?: RecordedResponse;
     timestamp: string;
     key: string;
-    sequence: number;
+    sequence?: number;
     recordingId: number;
 }
 interface WebSocketMessage {

package/dist/{index-CG-XcFDa.d.ts → index-Cx_Kflfl.d.ts}

@@ -28,7 +28,7 @@ interface Recording {
     response?: RecordedResponse;
     timestamp: string;
     key: string;
-    sequence: number;
+    sequence?: number;
     recordingId: number;
 }
 interface WebSocketMessage {

package/dist/index.cjs

@@ -5,9 +5,9 @@ var http = require('http');
 var https = require('https');
 var httpProxy = require('http-proxy');
 var ws = require('ws');
-var path = require('path');
 var crypto = require('crypto');
-var filenamify = require('filenamify');
+var path = require('path');
+var filenamify2 = require('filenamify');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -15,9 +15,9 @@ var fs__default = /*#__PURE__*/_interopDefault(fs);
 var http__default = /*#__PURE__*/_interopDefault(http);
 var https__default = /*#__PURE__*/_interopDefault(https);
 var httpProxy__default = /*#__PURE__*/_interopDefault(httpProxy);
-var path__default = /*#__PURE__*/_interopDefault(path);
 var crypto__default = /*#__PURE__*/_interopDefault(crypto);
-var filenamify__default = /*#__PURE__*/_interopDefault(filenamify);
+var path__default = /*#__PURE__*/_interopDefault(path);
+var filenamify2__default = /*#__PURE__*/_interopDefault(filenamify2);
 
 // src/ProxyServer.ts
 
@@ -36,23 +36,53 @@ var Modes = {
   replay: "replay"
 };
 var JSON_INDENT_SPACES = 2;
+var EXTENSION = ".mock.json";
+var MAX_FILENAME_LENGTH = 255 - EXTENSION.length;
+var HASH_LENGTH = 8;
+function generateHash(str) {
+  return crypto__default.default.createHash("shake256", { outputLength: HASH_LENGTH / 2 }).update(str).digest("hex");
+}
 function getRecordingPath(recordingsDir, id) {
-  return path__default.default.join(recordingsDir, `${id}.mock.json`);
+  let processedId = id.replaceAll("/", "__");
+  if (processedId.length > MAX_FILENAME_LENGTH) {
+    const hash = generateHash(id);
+    const maxBaseLength = MAX_FILENAME_LENGTH - HASH_LENGTH - 1;
+    processedId = `${processedId.slice(0, maxBaseLength)}_${hash}`;
+  }
+  const sanitizedId = filenamify2__default.default(processedId, {
+    replacement: "_",
+    maxLength: 255
+    // Set explicit max to prevent filenamify's default truncation
+  });
+  return path__default.default.join(recordingsDir, `${sanitizedId}${EXTENSION}`);
 }
 async function loadRecordingSession(filePath) {
   const fileContent = await fs__default.default.readFile(filePath, "utf8");
   return JSON.parse(fileContent);
 }
+function processRecordings(recordings) {
+  const keySequenceMap = /* @__PURE__ */ new Map();
+  return recordings.map((recording) => {
+    const key = recording.key;
+    const currentSeq = keySequenceMap.get(key) || 0;
+    keySequenceMap.set(key, currentSeq + 1);
+    return { ...recording, sequence: currentSeq };
+  });
+}
 async function saveRecordingSession(recordingsDir, session) {
   const filePath = getRecordingPath(recordingsDir, session.id);
-  const dirPath = path__default.default.dirname(filePath);
-  await fs__default.default.mkdir(dirPath, { recursive: true });
+  await fs__default.default.mkdir(recordingsDir, { recursive: true });
+  const processedRecordings = processRecordings(session.recordings);
+  const processedSession = {
+    ...session,
+    recordings: processedRecordings
+  };
   await fs__default.default.writeFile(
     filePath,
-    JSON.stringify(session, null, JSON_INDENT_SPACES)
+    JSON.stringify(processedSession, null, JSON_INDENT_SPACES)
   );
   console.log(
-    `Saved ${session.recordings.length} HTTP recordings and ${session.websocketRecordings?.length || 0} WebSocket recordings to ${filePath}`
+    `Saved ${processedRecordings.length} HTTP recordings and ${session.websocketRecordings?.length || 0} WebSocket recordings to ${filePath}`
   );
 }
 function getReqID(req) {
@@ -60,10 +90,10 @@ function getReqID(req) {
   const pathname = urlParts[0];
   const query = urlParts[1] || "";
   const pathPart = pathname === "/" ? "root" : pathname.slice(1);
-  const normalizedPath = filenamify__default.default(pathPart, { replacement: "_" });
+  const normalizedPath = filenamify2__default.default(pathPart, { replacement: "_" });
   const queryHash = generateQueryHash(query);
   const filename = `${req.method}_${normalizedPath}${queryHash}.json`;
-  return filenamify__default.default(filename, { replacement: "_" });
+  return filenamify2__default.default(filename, { replacement: "_" });
 }
 function generateQueryHash(query) {
   if (!query) {
@@ -98,12 +128,10 @@ var ProxyServer = class {
   proxy;
   currentSession;
   recordingsDir;
-  requestSequenceMap;
-  // Track sequence per request key
-  replaySequenceMap;
-  // Track replay position per request key
   recordingIdCounter;
   // Unique ID for each recording entry
+  replaySessions;
+  // Track multiple concurrent replay sessions by recording ID
   constructor(targets, recordingsDir) {
     this.targets = targets;
     this.currentTargetIndex = 0;
@@ -114,11 +142,11 @@ var ProxyServer = class {
     this.modeTimeout = null;
     this.currentSession = null;
     this.recordingsDir = recordingsDir;
-    this.requestSequenceMap = /* @__PURE__ */ new Map();
-    this.replaySequenceMap = /* @__PURE__ */ new Map();
+    this.replaySessions = /* @__PURE__ */ new Map();
     this.proxy = httpProxy__default.default.createProxyServer({
       secure: false,
-      changeOrigin: true
+      changeOrigin: true,
+      ws: true
     });
     this.setupProxyEventHandlers();
   }
@@ -186,6 +214,43 @@ var ProxyServer = class {
     this.currentTargetIndex = (this.currentTargetIndex + 1) % this.targets.length;
     return target;
   }
+  /**
+   * Extract recording ID from request cookie
+   * Used for concurrent replay session routing
+   * @param req The incoming HTTP request
+   * @returns The recording ID from cookie, or null if not found
+   */
+  getRecordingIdFromCookie(req) {
+    const cookies = req.headers.cookie;
+    if (!cookies) {
+      return null;
+    }
+    const match = cookies.match(/proxy-recording-id=([^;]+)/);
+    return match ? decodeURIComponent(match[1]) : null;
+  }
+  /**
+   * Get or create a replay session state for a given recording ID
+   * @param recordingId The recording ID to get/create session for
+   * @returns The replay session state
+   */
+  getOrCreateReplaySession(recordingId) {
+    let session = this.replaySessions.get(recordingId);
+    if (session) {
+      session.lastAccessTime = Date.now();
+    } else {
+      session = {
+        recordingId,
+        servedRecordingIdsByKey: /* @__PURE__ */ new Map(),
+        loadedSession: null,
+        lastAccessTime: Date.now()
+      };
+      this.replaySessions.set(recordingId, session);
+      console.log(
+        `[CONCURRENT REPLAY] Created new session for recording: ${recordingId}`
+      );
+    }
+    return session;
+  }
   parseGetParams(req) {
     const url = new URL(req.url || "", `http://${req.headers.host}`);
     const mode = url.searchParams.get("mode");
@@ -202,16 +267,25 @@ var ProxyServer = class {
       let data;
       if (req.method === "GET") {
         data = this.parseGetParams(req);
-      } else {
+      } else if (req.method === "POST") {
         const body = await readRequestBody(req);
-        console.log("MODE CHANGE (POST)", body);
+        console.log(`MODE CHANGE (${req.method})`, body);
         data = JSON.parse(body);
+      } else {
+        return;
       }
       const { mode, id, timeout: requestTimeout } = data;
       const timeout = requestTimeout ?? DEFAULT_TIMEOUT_MS;
       this.clearModeTimeout();
       await this.switchMode(mode, id);
       this.setupModeTimeout(timeout);
+      if (mode === Modes.replay && id) {
+        res.setHeader(
+          "Set-Cookie",
+          `proxy-recording-id=${encodeURIComponent(id)}; HttpOnly; Path=/; SameSite=Lax`
+        );
+        console.log(`[CONCURRENT REPLAY] Set cookie for recording: ${id}`);
+      }
       sendJsonResponse(res, HTTP_STATUS_OK, {
         success: true,
         mode: this.mode,
@@ -226,14 +300,12 @@ var ProxyServer = class {
     }
   }
   clearModeTimeout() {
-    if (this.modeTimeout) {
-      clearTimeout(this.modeTimeout);
-      this.modeTimeout = null;
-    }
+    clearTimeout(this.modeTimeout || 0);
+    this.modeTimeout = null;
   }
   async switchMode(mode, id) {
-    if (this.currentSession) {
-      console.log("Switching mode, saving current session first");
+    console.log(`Switching to ${mode.toUpperCase()} mode`);
+    if (this.currentSession && this.mode === Modes.record) {
       await this.saveCurrentSession(true);
       console.log("Session saved, continuing with mode switch");
     }
@@ -243,11 +315,17 @@ var ProxyServer = class {
         break;
       }
       case Modes.record: {
+        if (!id) {
+          throw new Error("Record ID is required");
+        }
         this.switchToRecordMode(id);
         break;
       }
       case Modes.replay: {
-        this.switchToReplayMode(id);
+        if (!id) {
+          throw new Error("Replay ID is required");
+        }
+        await this.switchToReplayMode(id);
         break;
       }
       default: {
@@ -264,36 +342,33 @@ var ProxyServer = class {
     console.log("Switched to transparent mode");
   }
   switchToRecordMode(id) {
-    if (!id) {
-      throw new Error("Record ID is required");
-    }
     this.mode = Modes.record;
     this.recordingId = id;
     this.replayId = null;
     this.currentSession = { id, recordings: [], websocketRecordings: [] };
-    this.requestSequenceMap.clear();
     console.log(`Switched to record mode with ID: ${id}`);
   }
-  switchToReplayMode(id) {
-    if (!id) {
-      throw new Error("Replay ID is required");
-    }
+  async switchToReplayMode(id) {
     this.mode = Modes.replay;
     this.replayId = id;
     this.recordingId = null;
     this.currentSession = null;
-    this.replaySequenceMap.clear();
+    const session = this.replaySessions.get(id);
+    if (session) {
+      session.servedRecordingIdsByKey.clear();
+      console.log(`Reset served recordings tracker for session: ${id}`);
+    } else {
+      this.getOrCreateReplaySession(id);
+    }
     console.log(`Switched to replay mode with ID: ${id}`);
   }
   setupModeTimeout(timeout) {
-    if (timeout && timeout > 0) {
-      this.modeTimeout = setTimeout(async () => {
-        console.log("Timeout reached, switching back to transparent mode");
-        await this.saveCurrentSession(true);
-        this.switchToTransparentMode();
-        this.modeTimeout = null;
-      }, timeout);
-    }
+    this.modeTimeout = setTimeout(async () => {
+      console.log("Timeout reached, switching back to transparent mode");
+      await this.saveCurrentSession(true);
+      this.switchToTransparentMode();
+      this.modeTimeout = null;
+    }, timeout);
   }
   async saveCurrentSession(filterIncomplete = false) {
     if (!this.currentSession) {
@@ -319,9 +394,6 @@ var ProxyServer = class {
       return;
     }
     const key = getReqID(req);
-    const currentSequence = this.requestSequenceMap.get(key) || 0;
-    const sequence = currentSequence;
-    this.requestSequenceMap.set(key, currentSequence + 1);
     const recordingId = this.recordingIdCounter++;
     req.__recordingId = recordingId;
     const record = {
@@ -333,13 +405,12 @@ var ProxyServer = class {
       },
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
       key,
-      sequence,
       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}, seq: ${sequence}, recordingId: ${recordingId}, body: ${body ? `${body.length} chars` : "null"}, total: ${this.currentSession.recordings.length}, sessionId: ${this.currentSession.id})`
+      `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) {
@@ -399,7 +470,7 @@ var ProxyServer = class {
         body: body || null
       };
       console.log(
-        `Recorded: ${req.method} ${req.url} (seq: ${record.sequence}, recordingId: ${recordingId})`
+        `Recorded: ${req.method} ${req.url} (recordingId: ${recordingId})`
       );
     });
   }
@@ -429,46 +500,77 @@ var ProxyServer = class {
       body: body || null
     };
     console.log(
-      `recordResponseData: Recorded response for ${req.method} ${req.url} (seq: ${record.sequence}, recordingId: ${recordingId})`
+      `recordResponseData: Recorded response for ${req.method} ${req.url} (recordingId: ${recordingId})`
     );
     return true;
   }
   async handleReplayRequest(req, res) {
+    const recordingId = this.getRecordingIdFromCookie(req) || this.replayId;
+    if (!recordingId) {
+      const corsHeaders = this.getCorsHeaders(req);
+      res.writeHead(HTTP_STATUS_BAD_REQUEST, {
+        "Content-Type": "application/json",
+        ...corsHeaders
+      });
+      res.end(JSON.stringify({ error: "No replay session active" }));
+      return;
+    }
     const key = getReqID(req);
-    const filePath = getRecordingPath(this.recordingsDir, this.replayId);
+    const filePath = getRecordingPath(this.recordingsDir, recordingId);
     try {
-      const session = await loadRecordingSession(filePath);
+      const sessionState = this.getOrCreateReplaySession(recordingId);
+      if (!sessionState.loadedSession) {
+        sessionState.loadedSession = await loadRecordingSession(filePath);
+        console.log(`[REPLAY] Loaded recording session: ${recordingId}`);
+      }
+      const session = sessionState.loadedSession;
+      if (!sessionState.servedRecordingIdsByKey.has(key)) {
+        sessionState.servedRecordingIdsByKey.set(key, /* @__PURE__ */ new Set());
+      }
+      const servedForThisKey = sessionState.servedRecordingIdsByKey.get(key);
       const host = req.headers.host || "unknown";
-      const recordsWithKey = session.recordings.filter((r) => r.key === key && r.response).toSorted((a, b) => a.sequence - b.sequence);
+      const recordsWithKey = session.recordings.filter((r) => r.key === key && r.response).toSorted((a, b) => a.recordingId - b.recordingId);
       if (recordsWithKey.length === 0) {
-        console.warn(
-          `No recording found for ${key} at ${req.method} ${host}${req.url}, returning default response`
+        const errorMsg = `No recording found for ${key} at ${req.method} ${host}${req.url}`;
+        console.error(`[REPLAY ERROR] ${errorMsg} (session: ${recordingId})`);
+        console.error(
+          `[REPLAY ERROR] This request was not made during recording - possible test non-determinism`
         );
-        const defaultResponse = req.method === "GET" ? {
-          data: [],
-          items: [],
-          results: [],
-          updated_at: "0001-01-01T00:00:00Z"
-        } : { success: true };
+        const errorResponse = {
+          error: "No recording found",
+          message: errorMsg,
+          key,
+          sessionId: recordingId
+        };
         const corsHeaders = this.getCorsHeaders(req);
-        res.writeHead(HTTP_STATUS_OK, {
+        res.writeHead(HTTP_STATUS_NOT_FOUND, {
           "Content-Type": "application/json",
           ...corsHeaders
         });
-        res.end(JSON.stringify(defaultResponse));
+        res.end(JSON.stringify(errorResponse));
         return;
       }
-      const usageCount = this.replaySequenceMap.get(key) || 0;
+      const requestCount = servedForThisKey.size + 1;
+      console.log(
+        `[REPLAY REQUEST #${requestCount}] ${req.method} ${req.url} (session: ${recordingId}, total: ${recordsWithKey.length}, served: ${servedForThisKey.size})`
+      );
       let record;
-      if (usageCount < recordsWithKey.length) {
-        record = recordsWithKey[usageCount];
-      } else {
+      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`
+        );
         record = recordsWithKey[recordsWithKey.length - 1];
       }
+      servedForThisKey.add(record.recordingId);
       console.log(
-        `Replaying ${req.method} ${req.url} (usage: ${usageCount}, sequence: ${record.sequence}, body_len: ${record.response?.body?.length || 0})`
+        `[REPLAY SERVING] recordingId: ${record.recordingId}, session: ${recordingId}, 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: ${req.method} ${host}${req.url}`
@@ -534,6 +636,7 @@ var ProxyServer = class {
       this.proxy.web(req, res, { target });
     }
   }
+  // TODO: check if can handle streaming requests
   async bufferAndProxyRequest(req, res, target) {
     const chunks = [];
     req.on("data", (chunk) => {

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import http from 'node:http';
-export { C as ControlRequest, M as Mode, P as PlaywrightTestInfo, R as Recording, a as RecordingSession, W as WebSocketRecording, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from './index-CG-XcFDa.cjs';
+export { C as ControlRequest, M as Mode, P as PlaywrightTestInfo, R as Recording, a as RecordingSession, W as WebSocketRecording, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from './index-Cx_Kflfl.cjs';
 import '@playwright/test';
 
 declare class ProxyServer {
@@ -12,9 +12,8 @@ declare class ProxyServer {
     private proxy;
     private currentSession;
     private recordingsDir;
-    private requestSequenceMap;
-    private replaySequenceMap;
     private recordingIdCounter;
+    private replaySessions;
     constructor(targets: string[], recordingsDir: string);
     init(): Promise<void>;
     listen(port: number): http.Server;
@@ -29,6 +28,19 @@ declare class ProxyServer {
     private getCorsHeaders;
     private addCorsHeaders;
     private getTarget;
+    /**
+     * Extract recording ID from request cookie
+     * Used for concurrent replay session routing
+     * @param req The incoming HTTP request
+     * @returns The recording ID from cookie, or null if not found
+     */
+    private getRecordingIdFromCookie;
+    /**
+     * Get or create a replay session state for a given recording ID
+     * @param recordingId The recording ID to get/create session for
+     * @returns The replay session state
+     */
+    private getOrCreateReplaySession;
     private parseGetParams;
     private handleControlRequest;
     private clearModeTimeout;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import http from 'node:http';
-export { C as ControlRequest, M as Mode, P as PlaywrightTestInfo, R as Recording, a as RecordingSession, W as WebSocketRecording, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from './index-CG-XcFDa.js';
+export { C as ControlRequest, M as Mode, P as PlaywrightTestInfo, R as Recording, a as RecordingSession, W as WebSocketRecording, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from './index-Cx_Kflfl.js';
 import '@playwright/test';
 
 declare class ProxyServer {
@@ -12,9 +12,8 @@ declare class ProxyServer {
     private proxy;
     private currentSession;
     private recordingsDir;
-    private requestSequenceMap;
-    private replaySequenceMap;
     private recordingIdCounter;
+    private replaySessions;
     constructor(targets: string[], recordingsDir: string);
     init(): Promise<void>;
     listen(port: number): http.Server;
@@ -29,6 +28,19 @@ declare class ProxyServer {
     private getCorsHeaders;
     private addCorsHeaders;
     private getTarget;
+    /**
+     * Extract recording ID from request cookie
+     * Used for concurrent replay session routing
+     * @param req The incoming HTTP request
+     * @returns The recording ID from cookie, or null if not found
+     */
+    private getRecordingIdFromCookie;
+    /**
+     * Get or create a replay session state for a given recording ID
+     * @param recordingId The recording ID to get/create session for
+     * @returns The replay session state
+     */
+    private getOrCreateReplaySession;
     private parseGetParams;
     private handleControlRequest;
     private clearModeTimeout;