test-proxy-recorder 0.1.4 → 0.1.5

package/README.md

@@ -191,7 +191,7 @@ interface ControlRequest {
 ### Playwright Integration API
 
 ```typescript
-import { playwrightProxy } from 'test-proxy-recorder';
+import { playwrightProxy, setProxyMode } from 'test-proxy-recorder';
 
 // Main helper object for use with Playwright tests
 const playwrightProxy = {
@@ -203,14 +203,84 @@ const playwrightProxy = {
 };
 ```
 
-## Recording Format
+### Global Teardown and Hooks Setup (Recommended)
+
+For robust test setups, it's recommended to configure global teardown and afterEach hooks to ensure the proxy is properly reset even when tests fail. This prevents the proxy from staying in record/replay mode, which could affect subsequent test runs.
+
+#### 1. Create Global Teardown File
+
+Create `e2e/global-teardown.ts` to reset the proxy mode after all tests complete:
+
+```typescript
+import { setProxyMode } from 'test-proxy-recorder';
+
+async function globalTeardown() {
+  await setProxyMode('transparent');
+}
+
+export default globalTeardown;
+```
+
+#### 2. Create Global Hooks File
+
+Create `e2e/global-hooks.ts` to ensure proxy cleanup happens after each test, even on failure:
 
-Recordings are stored as JSON files in the recordings directory:
+```typescript
+import { test } from '@playwright/test';
+import { playwrightProxy } from 'test-proxy-recorder';
 
+/**
+ * Global afterEach hook to ensure proxy cleanup happens even when tests fail.
+ * This will run after every test across all test files.
+ */
+test.afterEach(async ({}, testInfo) => {
+  try {
+    await playwrightProxy.after(testInfo);
+  } catch (error) {
+    console.error('Error during proxy cleanup:', error);
+    // Don't throw - we want cleanup to continue even if this fails
+  }
+});
 ```
+
+#### 3. Configure Playwright
+
+Update your `playwright.config.ts` to include the global teardown:
+
+```typescript
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  testDir: './e2e',
+  globalTeardown: './e2e/global-teardown.ts',
+  // ... rest of your config
+});
+```
+
+#### 4. Import Global Hooks in Your Base Page or Test Setup
+
+Import the global hooks file in your base test file or base page to register the afterEach hook:
+
+```typescript
+// In your e2e/basePage.ts or similar base test file
+import { test as base } from '@playwright/test';
+
+// Import global hooks to register afterEach for proxy cleanup
+import './global-hooks';
+
+export const test = base.extend({
+  // your fixtures
+});
+```
+
+## Recording Format
+
+Recordings are stored as JSON files with `.mock.json` extension in the recordings directory:
+
+```text
 recordings/
-├── test-session-1.json
-├── test-session-2.json
+├── test-session-1.mock.json
+├── test-session-2.mock.json
 └── ...
 ```
 
@@ -228,11 +298,7 @@ Each recording contains:
    test-proxy-recorder http://localhost:8000 --port 8100
    ```
 
-2. **Configure your app** to use the proxy:
-
-   ```bash
-   export EXTERNAL_API_URL=http://localhost:8100 yarn dev
-   ```
+2. **Configure your app** to use the proxy (point your app to the proxy port, e.g., 8100)
 
 3. **Record responses** (first run):
 

package/dist/{index-De4mgziH.d.cts → index-CBjvm5rb.d.cts}

@@ -47,7 +47,7 @@ interface RecordingSession {
     websocketRecordings: WebSocketRecording[];
 }
 
-type PlaywrightTestInfo = Pick<TestInfo, 'title'>;
+type PlaywrightTestInfo = Pick<TestInfo, 'title' | 'titlePath'>;
 /**
  * Set the proxy mode for a given session
  * @param mode - The proxy mode to set (recording, replay, transparent)
@@ -57,6 +57,10 @@ type PlaywrightTestInfo = Pick<TestInfo, 'title'>;
 declare function setProxyMode(mode: Mode, sessionId?: string, timeout?: number): Promise<void>;
 /**
  * Generate a session ID from test info
+ * Uses titlePath to create folder structure with test file name
+ * Supports both .spec.ts and .test.ts extensions
+ * Example: ['jobs/Create.spec.ts', 'create a job'] becomes 'jobs/Create__create-a-job'
+ * Example: ['users/Auth.test.ts', 'login test'] becomes 'users/Auth__login-test'
  * @param testInfo - Playwright test info object
  */
 declare function generateSessionId(testInfo: PlaywrightTestInfo): string;

package/dist/{index-De4mgziH.d.ts → index-CBjvm5rb.d.ts}

@@ -47,7 +47,7 @@ interface RecordingSession {
     websocketRecordings: WebSocketRecording[];
 }
 
-type PlaywrightTestInfo = Pick<TestInfo, 'title'>;
+type PlaywrightTestInfo = Pick<TestInfo, 'title' | 'titlePath'>;
 /**
  * Set the proxy mode for a given session
  * @param mode - The proxy mode to set (recording, replay, transparent)
@@ -57,6 +57,10 @@ type PlaywrightTestInfo = Pick<TestInfo, 'title'>;
 declare function setProxyMode(mode: Mode, sessionId?: string, timeout?: number): Promise<void>;
 /**
  * Generate a session ID from test info
+ * Uses titlePath to create folder structure with test file name
+ * Supports both .spec.ts and .test.ts extensions
+ * Example: ['jobs/Create.spec.ts', 'create a job'] becomes 'jobs/Create__create-a-job'
+ * Example: ['users/Auth.test.ts', 'login test'] becomes 'users/Auth__login-test'
  * @param testInfo - Playwright test info object
  */
 declare function generateSessionId(testInfo: PlaywrightTestInfo): string;

package/dist/index.cjs

@@ -35,7 +35,7 @@ var Modes = {
 };
 var JSON_INDENT_SPACES = 2;
 function getRecordingPath(recordingsDir, id) {
-  return path__default.default.join(recordingsDir, `${id}.json`);
+  return path__default.default.join(recordingsDir, `${id}.mock.json`);
 }
 async function loadRecordingSession(filePath) {
   const fileContent = await fs__default.default.readFile(filePath, "utf8");
@@ -43,6 +43,8 @@ async function loadRecordingSession(filePath) {
 }
 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.writeFile(
     filePath,
     JSON.stringify(session, null, JSON_INDENT_SPACES)
@@ -127,6 +129,7 @@ var ProxyServer = class {
       this.handleUpgrade(req, socket, head);
     });
     server.listen(port, () => {
+      process.env.TEST_PROXY_RECORDER_PORT = String(port);
       this.logServerStartup(port);
     });
     return server;
@@ -605,15 +608,25 @@ var ProxyServer = class {
 };
 
 // src/playwright/index.ts
-var INTERNAL_API_URL = process.env.INTERNAL_API_URL || "http://localhost:8100";
+function getProxyPort() {
+  const envPort = process.env.TEST_PROXY_RECORDER_PORT;
+  if (envPort) {
+    const parsed = Number.parseInt(envPort, 10);
+    if (!Number.isNaN(parsed)) {
+      return parsed;
+    }
+  }
+  return 8100;
+}
 async function setProxyMode(mode, sessionId, timeout) {
+  const proxyPort = getProxyPort();
   try {
     const body = {
       mode,
       id: sessionId,
       ...timeout && { timeout }
     };
-    const response = await fetch(`${INTERNAL_API_URL}/__control`, {
+    const response = await fetch(`http://127.0.0.1:${proxyPort}/__control`, {
       method: "POST",
       headers: { "Content-Type": "application/json" },
       body: JSON.stringify(body)
@@ -630,8 +643,34 @@ async function setProxyMode(mode, sessionId, timeout) {
     throw error;
   }
 }
+function parseSpecFilePath(specPath) {
+  const folderMatch = specPath.match(/^(.+?)\/([^/]+)\.(spec|test)\.ts$/);
+  if (folderMatch) {
+    return { folder: folderMatch[1], fileName: folderMatch[2] };
+  }
+  const fileMatch = specPath.match(/^([^/]+)\.(spec|test)\.ts$/);
+  if (fileMatch) {
+    return { folder: null, fileName: fileMatch[1] };
+  }
+  return { folder: null, fileName: null };
+}
+function buildSessionPath(folder, fileName, testName) {
+  if (folder && fileName) {
+    return `${folder}/${fileName}__${testName}`;
+  }
+  if (fileName) {
+    return `${fileName}__${testName}`;
+  }
+  return testName;
+}
 function generateSessionId(testInfo) {
-  return testInfo.title.toLowerCase().replaceAll(/\s+/g, "-");
+  const { titlePath } = testInfo;
+  if (!titlePath || titlePath.length === 0) {
+    return testInfo.title.toLowerCase().replaceAll(/\s+/g, "-");
+  }
+  const { folder, fileName } = parseSpecFilePath(titlePath[0]);
+  const testName = titlePath.at(-1).toLowerCase().replaceAll(/\s+/g, "-");
+  return buildSessionPath(folder, fileName, testName);
 }
 async function startRecording(testInfo) {
   const sessionId = generateSessionId(testInfo);

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-De4mgziH.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-CBjvm5rb.cjs';
 import '@playwright/test';
 
 declare class ProxyServer {

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-De4mgziH.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-CBjvm5rb.js';
 import '@playwright/test';
 
 declare class ProxyServer {

package/dist/index.mjs

@@ -24,7 +24,7 @@ var Modes = {
 };
 var JSON_INDENT_SPACES = 2;
 function getRecordingPath(recordingsDir, id) {
-  return path.join(recordingsDir, `${id}.json`);
+  return path.join(recordingsDir, `${id}.mock.json`);
 }
 async function loadRecordingSession(filePath) {
   const fileContent = await fs.readFile(filePath, "utf8");
@@ -32,6 +32,8 @@ async function loadRecordingSession(filePath) {
 }
 async function saveRecordingSession(recordingsDir, session) {
   const filePath = getRecordingPath(recordingsDir, session.id);
+  const dirPath = path.dirname(filePath);
+  await fs.mkdir(dirPath, { recursive: true });
   await fs.writeFile(
     filePath,
     JSON.stringify(session, null, JSON_INDENT_SPACES)
@@ -116,6 +118,7 @@ var ProxyServer = class {
       this.handleUpgrade(req, socket, head);
     });
     server.listen(port, () => {
+      process.env.TEST_PROXY_RECORDER_PORT = String(port);
       this.logServerStartup(port);
     });
     return server;
@@ -594,15 +597,25 @@ var ProxyServer = class {
 };
 
 // src/playwright/index.ts
-var INTERNAL_API_URL = process.env.INTERNAL_API_URL || "http://localhost:8100";
+function getProxyPort() {
+  const envPort = process.env.TEST_PROXY_RECORDER_PORT;
+  if (envPort) {
+    const parsed = Number.parseInt(envPort, 10);
+    if (!Number.isNaN(parsed)) {
+      return parsed;
+    }
+  }
+  return 8100;
+}
 async function setProxyMode(mode, sessionId, timeout) {
+  const proxyPort = getProxyPort();
   try {
     const body = {
       mode,
       id: sessionId,
       ...timeout && { timeout }
     };
-    const response = await fetch(`${INTERNAL_API_URL}/__control`, {
+    const response = await fetch(`http://127.0.0.1:${proxyPort}/__control`, {
       method: "POST",
       headers: { "Content-Type": "application/json" },
       body: JSON.stringify(body)
@@ -619,8 +632,34 @@ async function setProxyMode(mode, sessionId, timeout) {
     throw error;
   }
 }
+function parseSpecFilePath(specPath) {
+  const folderMatch = specPath.match(/^(.+?)\/([^/]+)\.(spec|test)\.ts$/);
+  if (folderMatch) {
+    return { folder: folderMatch[1], fileName: folderMatch[2] };
+  }
+  const fileMatch = specPath.match(/^([^/]+)\.(spec|test)\.ts$/);
+  if (fileMatch) {
+    return { folder: null, fileName: fileMatch[1] };
+  }
+  return { folder: null, fileName: null };
+}
+function buildSessionPath(folder, fileName, testName) {
+  if (folder && fileName) {
+    return `${folder}/${fileName}__${testName}`;
+  }
+  if (fileName) {
+    return `${fileName}__${testName}`;
+  }
+  return testName;
+}
 function generateSessionId(testInfo) {
-  return testInfo.title.toLowerCase().replaceAll(/\s+/g, "-");
+  const { titlePath } = testInfo;
+  if (!titlePath || titlePath.length === 0) {
+    return testInfo.title.toLowerCase().replaceAll(/\s+/g, "-");
+  }
+  const { folder, fileName } = parseSpecFilePath(titlePath[0]);
+  const testName = titlePath.at(-1).toLowerCase().replaceAll(/\s+/g, "-");
+  return buildSessionPath(folder, fileName, testName);
 }
 async function startRecording(testInfo) {
   const sessionId = generateSessionId(testInfo);

package/dist/playwright/index.cjs

@@ -8,15 +8,25 @@ var Modes = {
 };
 
 // src/playwright/index.ts
-var INTERNAL_API_URL = process.env.INTERNAL_API_URL || "http://localhost:8100";
+function getProxyPort() {
+  const envPort = process.env.TEST_PROXY_RECORDER_PORT;
+  if (envPort) {
+    const parsed = Number.parseInt(envPort, 10);
+    if (!Number.isNaN(parsed)) {
+      return parsed;
+    }
+  }
+  return 8100;
+}
 async function setProxyMode(mode, sessionId, timeout) {
+  const proxyPort = getProxyPort();
   try {
     const body = {
       mode,
       id: sessionId,
       ...timeout && { timeout }
     };
-    const response = await fetch(`${INTERNAL_API_URL}/__control`, {
+    const response = await fetch(`http://127.0.0.1:${proxyPort}/__control`, {
       method: "POST",
       headers: { "Content-Type": "application/json" },
       body: JSON.stringify(body)
@@ -33,8 +43,34 @@ async function setProxyMode(mode, sessionId, timeout) {
     throw error;
   }
 }
+function parseSpecFilePath(specPath) {
+  const folderMatch = specPath.match(/^(.+?)\/([^/]+)\.(spec|test)\.ts$/);
+  if (folderMatch) {
+    return { folder: folderMatch[1], fileName: folderMatch[2] };
+  }
+  const fileMatch = specPath.match(/^([^/]+)\.(spec|test)\.ts$/);
+  if (fileMatch) {
+    return { folder: null, fileName: fileMatch[1] };
+  }
+  return { folder: null, fileName: null };
+}
+function buildSessionPath(folder, fileName, testName) {
+  if (folder && fileName) {
+    return `${folder}/${fileName}__${testName}`;
+  }
+  if (fileName) {
+    return `${fileName}__${testName}`;
+  }
+  return testName;
+}
 function generateSessionId(testInfo) {
-  return testInfo.title.toLowerCase().replaceAll(/\s+/g, "-");
+  const { titlePath } = testInfo;
+  if (!titlePath || titlePath.length === 0) {
+    return testInfo.title.toLowerCase().replaceAll(/\s+/g, "-");
+  }
+  const { folder, fileName } = parseSpecFilePath(titlePath[0]);
+  const testName = titlePath.at(-1).toLowerCase().replaceAll(/\s+/g, "-");
+  return buildSessionPath(folder, fileName, testName);
 }
 async function startRecording(testInfo) {
   const sessionId = generateSessionId(testInfo);

package/dist/playwright/index.d.cts

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

package/dist/playwright/index.d.ts

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

package/dist/playwright/index.mjs

@@ -6,15 +6,25 @@ var Modes = {
 };
 
 // src/playwright/index.ts
-var INTERNAL_API_URL = process.env.INTERNAL_API_URL || "http://localhost:8100";
+function getProxyPort() {
+  const envPort = process.env.TEST_PROXY_RECORDER_PORT;
+  if (envPort) {
+    const parsed = Number.parseInt(envPort, 10);
+    if (!Number.isNaN(parsed)) {
+      return parsed;
+    }
+  }
+  return 8100;
+}
 async function setProxyMode(mode, sessionId, timeout) {
+  const proxyPort = getProxyPort();
   try {
     const body = {
       mode,
       id: sessionId,
       ...timeout && { timeout }
     };
-    const response = await fetch(`${INTERNAL_API_URL}/__control`, {
+    const response = await fetch(`http://127.0.0.1:${proxyPort}/__control`, {
       method: "POST",
       headers: { "Content-Type": "application/json" },
       body: JSON.stringify(body)
@@ -31,8 +41,34 @@ async function setProxyMode(mode, sessionId, timeout) {
     throw error;
   }
 }
+function parseSpecFilePath(specPath) {
+  const folderMatch = specPath.match(/^(.+?)\/([^/]+)\.(spec|test)\.ts$/);
+  if (folderMatch) {
+    return { folder: folderMatch[1], fileName: folderMatch[2] };
+  }
+  const fileMatch = specPath.match(/^([^/]+)\.(spec|test)\.ts$/);
+  if (fileMatch) {
+    return { folder: null, fileName: fileMatch[1] };
+  }
+  return { folder: null, fileName: null };
+}
+function buildSessionPath(folder, fileName, testName) {
+  if (folder && fileName) {
+    return `${folder}/${fileName}__${testName}`;
+  }
+  if (fileName) {
+    return `${fileName}__${testName}`;
+  }
+  return testName;
+}
 function generateSessionId(testInfo) {
-  return testInfo.title.toLowerCase().replaceAll(/\s+/g, "-");
+  const { titlePath } = testInfo;
+  if (!titlePath || titlePath.length === 0) {
+    return testInfo.title.toLowerCase().replaceAll(/\s+/g, "-");
+  }
+  const { folder, fileName } = parseSpecFilePath(titlePath[0]);
+  const testName = titlePath.at(-1).toLowerCase().replaceAll(/\s+/g, "-");
+  return buildSessionPath(folder, fileName, testName);
 }
 async function startRecording(testInfo) {
   const sessionId = generateSessionId(testInfo);

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;

package/package.json

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