test-proxy-recorder 0.3.9 → 0.4.0

package/dist/index.mjs

@@ -7,6 +7,11 @@ import path2 from 'path';
 import filenamify2 from 'filenamify';
 import { WebSocket, WebSocketServer } from 'ws';
 
+// src/config.ts
+function defineConfig(config) {
+  return config;
+}
+
 // src/constants.ts
 var DEFAULT_TIMEOUT_MS = 120 * 1e3;
 var HTTP_STATUS_BAD_GATEWAY = 502;
@@ -260,6 +265,139 @@ var Modes = {
   record: "record",
   replay: "replay"
 };
+
+// src/utils/redact.ts
+var DEFAULT_REDACTED_HEADERS = [
+  "authorization",
+  "cookie",
+  "set-cookie"
+];
+var REDACTED_PLACEHOLDER = "[REDACTED]";
+var COOKIE_HEADERS = /* @__PURE__ */ new Set(["cookie", "set-cookie"]);
+function resolveRedaction(config) {
+  const extra = (config?.headers ?? []).map((name) => name.toLowerCase());
+  const headerSet = /* @__PURE__ */ new Set([...DEFAULT_REDACTED_HEADERS, ...extra]);
+  for (const name of config?.allowHeaders ?? []) {
+    headerSet.delete(name.toLowerCase());
+  }
+  return {
+    headerSet,
+    allowCookies: new Set(
+      (config?.allowCookies ?? []).map((name) => name.toLowerCase())
+    ),
+    regexes: toGlobalRegexes(config?.bodyPatterns),
+    placeholder: config?.placeholder ?? REDACTED_PLACEHOLDER
+  };
+}
+function toGlobalRegexes(patterns) {
+  if (!patterns || patterns.length === 0) {
+    return [];
+  }
+  return patterns.map((pattern) => {
+    if (typeof pattern === "string") {
+      return new RegExp(pattern, "g");
+    }
+    return pattern.flags.includes("g") ? pattern : new RegExp(pattern.source, `${pattern.flags}g`);
+  });
+}
+function redactCookieHeader(value, allowCookies, placeholder) {
+  return value.split(";").map((part) => part.trim()).filter(Boolean).map((pair) => {
+    const eq = pair.indexOf("=");
+    if (eq === -1) {
+      return pair;
+    }
+    const name = pair.slice(0, eq);
+    return allowCookies.has(name.toLowerCase()) ? pair : `${name}=${placeholder}`;
+  }).join("; ");
+}
+function redactSetCookieValue(value, allowCookies, placeholder) {
+  const semicolon = value.indexOf(";");
+  const firstPair = semicolon === -1 ? value : value.slice(0, semicolon);
+  const attributes = semicolon === -1 ? "" : value.slice(semicolon);
+  const eq = firstPair.indexOf("=");
+  if (eq === -1) {
+    return value;
+  }
+  const name = firstPair.slice(0, eq).trim();
+  if (allowCookies.has(name.toLowerCase())) {
+    return value;
+  }
+  return `${name}=${placeholder}${attributes}`;
+}
+function redactCookieAware(lower, value, resolved) {
+  const { allowCookies, placeholder } = resolved;
+  const redactOne = (cookie) => lower === "cookie" ? redactCookieHeader(cookie, allowCookies, placeholder) : redactSetCookieValue(cookie, allowCookies, placeholder);
+  return Array.isArray(value) ? value.map((v) => redactOne(v)) : redactOne(String(value));
+}
+function redactHeaderValue(name, value, resolved) {
+  const lower = name.toLowerCase();
+  if (resolved.allowCookies.size > 0 && COOKIE_HEADERS.has(lower)) {
+    return redactCookieAware(lower, value, resolved);
+  }
+  return Array.isArray(value) ? value.map(() => resolved.placeholder) : resolved.placeholder;
+}
+function redactHeaders(headers, resolved) {
+  const result = {};
+  for (const [name, value] of Object.entries(headers)) {
+    result[name] = resolved.headerSet.has(name.toLowerCase()) ? redactHeaderValue(name, value, resolved) : value;
+  }
+  return result;
+}
+function redactBody(body, regexes, placeholder) {
+  if (!body || regexes.length === 0) {
+    return body ?? null;
+  }
+  let result = body;
+  for (const regex of regexes) {
+    regex.lastIndex = 0;
+    result = result.replace(regex, placeholder);
+  }
+  return result;
+}
+function redactRecording(recording, resolved) {
+  const { regexes, placeholder } = resolved;
+  return {
+    ...recording,
+    request: {
+      ...recording.request,
+      headers: redactHeaders(recording.request.headers, resolved),
+      body: redactBody(recording.request.body, regexes, placeholder)
+    },
+    response: recording.response && {
+      ...recording.response,
+      headers: redactHeaders(recording.response.headers, resolved),
+      body: redactBody(recording.response.body, regexes, placeholder)
+    }
+  };
+}
+function redactWebSocketRecording(recording, resolved) {
+  const { regexes, placeholder } = resolved;
+  return {
+    ...recording,
+    headers: recording.headers ? redactHeaders(recording.headers, resolved) : recording.headers,
+    messages: recording.messages.map((message) => ({
+      ...message,
+      data: redactBody(message.data, regexes, placeholder) ?? message.data
+    }))
+  };
+}
+function redactSession(session, config) {
+  if (config?.enabled === false) {
+    return session;
+  }
+  const resolved = resolveRedaction(config);
+  return {
+    ...session,
+    recordings: session.recordings.map(
+      (recording) => redactRecording(recording, resolved)
+    ),
+    websocketRecordings: (session.websocketRecordings ?? []).map(
+      (recording) => redactWebSocketRecording(recording, resolved)
+    )
+  };
+}
+
+// src/utils/fileUtils.ts
 var JSON_INDENT_SPACES = 2;
 var EXTENSION = ".mock.json";
 var MAX_FILENAME_LENGTH = 255 - EXTENSION.length;
@@ -304,14 +442,17 @@ function processRecordings(recordings) {
   processedRecordings.sort((a, b) => a.recordingId - b.recordingId);
   return processedRecordings;
 }
-async function saveRecordingSession(recordingsDir, session) {
+async function saveRecordingSession(recordingsDir, session, redaction) {
   const filePath = getRecordingPath(recordingsDir, session.id);
   await fs.mkdir(recordingsDir, { recursive: true });
   const processedRecordings = processRecordings(session.recordings);
-  const processedSession = {
-    ...session,
-    recordings: processedRecordings
-  };
+  const processedSession = redactSession(
+    {
+      ...session,
+      recordings: processedRecordings
+    },
+    redaction
+  );
   await fs.writeFile(
     filePath,
     JSON.stringify(processedSession, null, JSON_INDENT_SPACES)
@@ -542,17 +683,20 @@ var ProxyServer = class {
   timeoutMs;
   // Unique ID for each recording entry
   recordingIdCounter;
-  sequenceCounterByKey;
   // Sequence counter per key (endpoint)
+  sequenceCounterByKey;
   replaySessions;
   // Track multiple concurrent replay sessions by recording ID
   recordingPromises;
   // Stack of promises that resolve to completed recordings
   flushPromise;
   // Promise for in-progress flush operation
-  constructor(target, recordingsDir, timeoutMs) {
+  redaction;
+  // Secret-redaction config applied before saving
+  constructor(target, recordingsDir, timeoutMs, redaction) {
     this.target = target;
     this.timeoutMs = timeoutMs ?? DEFAULT_TIMEOUT_MS;
+    this.redaction = redaction;
     this.mode = Modes.transparent;
     this.recordingId = null;
     this.recordingIdCounter = 0;
@@ -802,7 +946,11 @@ var ProxyServer = class {
     console.log(
       `Saving session with ${this.currentSession.recordings.length} HTTP and ${this.currentSession.websocketRecordings.length} WebSocket recordings`
     );
-    await saveRecordingSession(this.recordingsDir, this.currentSession);
+    await saveRecordingSession(
+      this.recordingsDir,
+      this.currentSession,
+      this.redaction
+    );
   }
   getRecordingIdOrError(req, res) {
     const recordingIdFromRequest = getRecordingIdFromRequest(req);
@@ -1306,6 +1454,6 @@ function createHeadersWithRecordingId(requestHeaders, additionalHeaders = {}) {
   };
 }
 
-export { ProxyServer, RECORDING_ID_HEADER, createHeadersWithRecordingId, generateSessionId, getRecordingId, playwrightProxy, setNextProxyHeaders, setProxyMode, startRecording, startReplay, stopProxy };
+export { DEFAULT_REDACTED_HEADERS, ProxyServer, RECORDING_ID_HEADER, REDACTED_PLACEHOLDER, createHeadersWithRecordingId, defineConfig, generateSessionId, getRecordingId, playwrightProxy, redactSession, setNextProxyHeaders, setProxyMode, startRecording, startReplay, stopProxy };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map

package/dist/playwright/index.d.cts

@@ -1,3 +1,3 @@
 import '@playwright/test';
-export { f as ClientSideRecordingOptions, P as PlaywrightTestInfo, e as cleanupSession, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-BloXCw69.cjs';
+export { f as ClientSideRecordingOptions, P as PlaywrightTestInfo, e as cleanupSession, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-BnkejxM_.cjs';
 import 'node:http';

package/dist/playwright/index.d.ts

@@ -1,3 +1,3 @@
 import '@playwright/test';
-export { f as ClientSideRecordingOptions, P as PlaywrightTestInfo, e as cleanupSession, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-BloXCw69.js';
+export { f as ClientSideRecordingOptions, P as PlaywrightTestInfo, e as cleanupSession, g as generateSessionId, p as playwrightProxy, s as setProxyMode, b as startRecording, c as startReplay, d as stopProxy } from '../index-BnkejxM_.js';
 import 'node:http';