test-proxy-recorder 0.1.0

package/dist/playwright/index.js

@@ -0,0 +1,92 @@
+const INTERNAL_API_URL = process.env.INTERNAL_API_URL || 'http://localhost:8100';
+/**
+ * Set the proxy mode for a given session
+ * @param mode - The proxy mode to set (recording, replay, transparent)
+ * @param sessionId - Unique identifier for the session
+ * @param timeout - Optional timeout in milliseconds
+ */
+export async function setProxyMode(mode, sessionId, timeout) {
+    if (!INTERNAL_API_URL) {
+        console.warn('INTERNAL_API_URL not set, proxy mode not changed');
+        return;
+    }
+    try {
+        const body = {
+            mode,
+            id: sessionId,
+            ...(timeout && { timeout }),
+        };
+        const response = await fetch(`${INTERNAL_API_URL}/__control`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify(body),
+        });
+        if (!response.ok) {
+            const text = await response.text();
+            console.error(`Failed to set proxy mode to ${mode}:`, text);
+            throw new Error(`Failed to set proxy mode: ${text}`);
+        }
+        await response.json();
+        console.log(`Proxy mode set to: ${mode} (session: ${sessionId})`);
+    }
+    catch (error) {
+        console.error(`Error setting proxy mode:`, error);
+        throw error;
+    }
+}
+/**
+ * Generate a session ID from test info
+ * @param testInfo - Playwright test info object
+ */
+export function generateSessionId(testInfo) {
+    return testInfo.title.toLowerCase().replaceAll(/\s+/g, '-');
+}
+/**
+ * Start recording for a test
+ * @param testInfo - Playwright test info object
+ */
+export async function startRecording(testInfo) {
+    const sessionId = generateSessionId(testInfo);
+    await setProxyMode('recording', sessionId);
+}
+/**
+ * Start replay for a test
+ * @param testInfo - Playwright test info object
+ */
+export async function startReplay(testInfo) {
+    const sessionId = generateSessionId(testInfo);
+    await setProxyMode('replay', sessionId);
+}
+/**
+ * Stop recording/replay and return to transparent mode
+ * @param testInfo - Playwright test info object
+ */
+export async function stopProxy(testInfo) {
+    const sessionId = generateSessionId(testInfo);
+    await setProxyMode('transparent', sessionId);
+}
+/**
+ * Playwright test fixture helper for managing proxy mode
+ * Use this in beforeEach/afterEach hooks
+ */
+export const playwrightProxy = {
+    /**
+     * Setup before test - sets the proxy mode
+     * @param testInfo - Playwright test info object
+     * @param mode - The proxy mode to use for this test
+     */
+    async before(testInfo, mode) {
+        const sessionId = generateSessionId(testInfo);
+        console.log('Proxy setup:', { mode, sessionId });
+        await setProxyMode(mode, sessionId);
+    },
+    /**
+     * Cleanup after test - returns to transparent mode
+     * @param testInfo - Playwright test info object
+     */
+    async after(testInfo) {
+        const sessionId = generateSessionId(testInfo);
+        await setProxyMode('transparent', sessionId);
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/proxy.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=proxy.d.ts.map

package/dist/proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../src/proxy.ts"],"names":[],"mappings":""}

package/dist/proxy.js

@@ -0,0 +1,8 @@
+import { parseCliArgs } from './cli.js';
+import { ProxyServer } from './ProxyServer.js';
+const { targets, port, recordingsDir } = parseCliArgs();
+const proxy = new ProxyServer(targets, recordingsDir);
+await proxy.init();
+proxy.listen(port);
+console.log(`Recordings will be saved to: ${recordingsDir}`);
+//# sourceMappingURL=proxy.js.map

package/dist/types.d.ts

@@ -0,0 +1,46 @@
+import http from 'node:http';
+export declare const Modes: {
+    readonly transparent: "transparent";
+    readonly record: "record";
+    readonly replay: "replay";
+};
+export type Mode = (typeof Modes)[keyof typeof Modes];
+export interface ControlRequest {
+    mode: Mode;
+    id?: string;
+    timeout?: number;
+}
+export interface RecordedRequest {
+    method: string;
+    url: string;
+    headers: http.IncomingHttpHeaders;
+    body: string | null;
+}
+export interface RecordedResponse {
+    statusCode: number;
+    headers: http.IncomingHttpHeaders;
+    body: string | null;
+}
+export interface Recording {
+    request: RecordedRequest;
+    response?: RecordedResponse;
+    timestamp: string;
+    key: string;
+}
+export interface WebSocketMessage {
+    direction: 'client-to-server' | 'server-to-client';
+    data: string;
+    timestamp: string;
+}
+export interface WebSocketRecording {
+    url: string;
+    messages: WebSocketMessage[];
+    timestamp: string;
+    key: string;
+}
+export interface RecordingSession {
+    id: string;
+    recordings: Recording[];
+    websocketRecordings: WebSocketRecording[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,eAAO,MAAM,KAAK;;;;CAIR,CAAC;AAEX,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,OAAO,KAAK,CAAC,CAAC;AAEtD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,IAAI,CAAC;IACX,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,IAAI,CAAC,mBAAmB,CAAC;IAClC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,IAAI,CAAC,mBAAmB,CAAC;IAClC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,kBAAkB,GAAG,kBAAkB,CAAC;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;CAC3C"}

package/dist/types.js

@@ -0,0 +1,6 @@
+export const Modes = {
+    transparent: 'transparent',
+    record: 'record',
+    replay: 'replay',
+};
+//# sourceMappingURL=types.js.map

package/dist/utils/fileUtils.d.ts

@@ -0,0 +1,5 @@
+import type { RecordingSession } from '../types.js';
+export declare function getRecordingPath(recordingsDir: string, id: string): string;
+export declare function loadRecordingSession(filePath: string): Promise<RecordingSession>;
+export declare function saveRecordingSession(recordingsDir: string, session: RecordingSession): Promise<void>;
+//# sourceMappingURL=fileUtils.d.ts.map

package/dist/utils/fileUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileUtils.d.ts","sourceRoot":"","sources":["../../src/utils/fileUtils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAIpD,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAE1E;AAED,wBAAsB,oBAAoB,CACxC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,gBAAgB,CAAC,CAG3B;AAED,wBAAsB,oBAAoB,CACxC,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,CASf"}

package/dist/utils/fileUtils.js

@@ -0,0 +1,16 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+const JSON_INDENT_SPACES = 2;
+export function getRecordingPath(recordingsDir, id) {
+    return path.join(recordingsDir, `${id}.json`);
+}
+export async function loadRecordingSession(filePath) {
+    const fileContent = await fs.readFile(filePath, 'utf8');
+    return JSON.parse(fileContent);
+}
+export async function saveRecordingSession(recordingsDir, session) {
+    const filePath = getRecordingPath(recordingsDir, session.id);
+    await fs.writeFile(filePath, JSON.stringify(session, null, JSON_INDENT_SPACES));
+    console.log(`Saved ${session.recordings.length} HTTP recordings and ${session.websocketRecordings?.length || 0} WebSocket recordings to ${filePath}`);
+}
+//# sourceMappingURL=fileUtils.js.map

package/dist/utils/httpHelpers.d.ts

@@ -0,0 +1,4 @@
+import http from 'node:http';
+export declare function readRequestBody(req: http.IncomingMessage): Promise<string>;
+export declare function sendJsonResponse(res: http.ServerResponse, statusCode: number, data: Record<string, unknown>): void;
+//# sourceMappingURL=httpHelpers.d.ts.map

package/dist/utils/httpHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpHelpers.d.ts","sourceRoot":"","sources":["../../src/utils/httpHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAI7B,wBAAsB,eAAe,CACnC,GAAG,EAAE,IAAI,CAAC,eAAe,GACxB,OAAO,CAAC,MAAM,CAAC,CAMjB;AAED,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,IAAI,CAAC,cAAc,EACxB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,IAAI,CAGN"}

package/dist/utils/httpHelpers.js

@@ -0,0 +1,13 @@
+const CONTENT_TYPE_JSON = 'application/json';
+export async function readRequestBody(req) {
+    let body = '';
+    for await (const chunk of req) {
+        body += chunk.toString();
+    }
+    return body;
+}
+export function sendJsonResponse(res, statusCode, data) {
+    res.writeHead(statusCode, { 'Content-Type': CONTENT_TYPE_JSON });
+    res.end(JSON.stringify(data));
+}
+//# sourceMappingURL=httpHelpers.js.map

package/dist/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './fileUtils.js';
+export * from './httpHelpers.js';
+export * from './requestKeyGenerator.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC"}

package/dist/utils/index.js

@@ -0,0 +1,4 @@
+export * from './fileUtils.js';
+export * from './httpHelpers.js';
+export * from './requestKeyGenerator.js';
+//# sourceMappingURL=index.js.map

package/dist/utils/requestKeyGenerator.d.ts

@@ -0,0 +1,3 @@
+import http from 'node:http';
+export declare function generateRequestKey(req: http.IncomingMessage): string;
+//# sourceMappingURL=requestKeyGenerator.d.ts.map

package/dist/utils/requestKeyGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestKeyGenerator.d.ts","sourceRoot":"","sources":["../../src/utils/requestKeyGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAI7B,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,IAAI,CAAC,eAAe,GAAG,MAAM,CASpE"}

package/dist/utils/requestKeyGenerator.js

@@ -0,0 +1,24 @@
+const QUERY_HASH_LENGTH = 8;
+export function generateRequestKey(req) {
+    const urlParts = req.url.split('?');
+    const pathname = urlParts[0];
+    const query = urlParts[1] || '';
+    const normalizedPath = normalizePathname(pathname);
+    const queryHash = generateQueryHash(query);
+    return `${req.method}_${normalizedPath}${queryHash}.json`;
+}
+function normalizePathname(pathname) {
+    const normalized = pathname.replaceAll('/', '_').replace(/^_/, '');
+    return normalized || 'root';
+}
+function generateQueryHash(query) {
+    if (!query) {
+        return '';
+    }
+    const hash = Buffer.from(query)
+        .toString('base64')
+        .replaceAll(/[^a-zA-Z0-9]/g, '')
+        .slice(0, Math.max(0, QUERY_HASH_LENGTH));
+    return `_${hash}`;
+}
+//# sourceMappingURL=requestKeyGenerator.js.map

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "test-proxy-recorder",
+  "version": "0.1.0",
+  "description": "HTTP proxy server for recording and replaying network requests in testing. Works seamlessly with Playwright testing framework.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./playwright": {
+      "types": "./dist/playwright/index.d.ts",
+      "import": "./dist/playwright/index.js"
+    }
+  },
+  "bin": {
+    "test-proxy-recorder": "./dist/proxy.js"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map",
+    "!dist/**/*.test.*",
+    "!dist/**/*.integration.test.*",
+    "README.md",
+    "LICENSE"
+  ],
+  "packageManager": "pnpm@10.20.0+sha512.cf9998222162dd85864d0a8102e7892e7ba4ceadebbf5a31f9c2fce48dfce317a9c53b9f6464d1ef9042cba2e02ae02a9f7c143a2b438cd93c91840f0192b9dd",
+  "scripts": {
+    "start": "node dist/proxy.js",
+    "dev": "tsx src/proxy.ts",
+    "build": "tsc",
+    "prepublish": "pnpm run build && pnpm run test:run && pnpm run lint",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "test:run": "vitest run"
+  },
+  "keywords": [
+    "playwright",
+    "testing",
+    "proxy",
+    "mock",
+    "record",
+    "replay",
+    "har",
+    "http",
+    "websocket",
+    "intercept",
+    "fixture",
+    "vcr",
+    "stub",
+    "e2e",
+    "integration-testing",
+    "test-automation",
+    "api-mocking",
+    "network-recording"
+  ],
+  "author": "asmyshlyaev177",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/asmyshlyaev177/test-proxy-recorder.git"
+  },
+  "bugs": {
+    "url": "https://github.com/asmyshlyaev177/test-proxy-recorder/issues"
+  },
+  "homepage": "https://github.com/asmyshlyaev177/test-proxy-recorder#readme",
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "dependencies": {
+    "commander": "^12.0.0",
+    "http-proxy": "^1.18.1"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@types/http-proxy": "^1.17.15",
+    "@types/node": "^22.0.0",
+    "@types/ws": "^8.18.1",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-sonarjs": "^3.0.5",
+    "eslint-plugin-unicorn": "^62.0.0",
+    "prettier": "^3.6.2",
+    "tsx": "^4.19.0",
+    "typescript": "^5.6.0",
+    "vitest": "^3.2.4",
+    "ws": "^8.18.3"
+  }
+}