http-snapshotter 0.4.2 → 0.5.0-beta.0

package/README.md

@@ -25,10 +25,14 @@ import { resolve, dirname } from "node:path";
 import { start, startTestCase, endTestCase } from "http-snapshotter";
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
+// if you are using an isolated test runner, then use a different directory per test (e.g. http-snapshots/test-case-1)
 start({ snapshotDirectory: resolve(__dirname, "http-snapshots") });
 
 test("Latest XKCD comic (ESM)", async (t) => {
+  // if you are *not* using an isolated test runner (e.g. tape), then `startTestCase` adds snapshots to separate directory
+  // Remove this line if it doesn't apply to your test runner
   startTestCase('test-case-1');
+
   const res = await fetch("https://xkcd.com/info.0.json");
   const json = await res.json();
 

package/index.d.ts

@@ -33,6 +33,7 @@ export type SnapshotJson = {
     };
 };
 export type Snapshot = SnapshotText | SnapshotJson;
+export type SnapshotFileInfo = Awaited<ReturnType<typeof getSnapshotFileInfo>>;
 export type ReadSnapshotReturnType = Promise<{
     snapshot: Snapshot;
     absoluteFilePath: string;
@@ -92,3 +93,13 @@ export function start({ snapshotDirectory: _snapshotDirectory, }?: {
 }): void;
 /** Stop the interceptor */
 export function stop(): void;
+/**
+ * @param {Request} request
+ */
+declare function getSnapshotFileInfo(request: Request): Promise<{
+    absoluteFilePath: string;
+    fileName: string;
+    filePrefix: string;
+    fileSuffixKey: string;
+}>;
+export {};

package/index.js

@@ -27,13 +27,19 @@
  * More docs at the end of this file, find the exported methods.
  */
 // Tested with @mswjs/interceptors v0.24.1
-const { BatchInterceptor } = require('@mswjs/interceptors');
+const { BatchInterceptor, RequestController } = require('@mswjs/interceptors');
 const { ClientRequestInterceptor } = require('@mswjs/interceptors/ClientRequest');
 const { FetchInterceptor } = require('@mswjs/interceptors/fetch');
 const slugify = require('@sindresorhus/slugify');
 const { createHash } = require('node:crypto');
 const { promises: fs } = require('node:fs');
 const { resolve, dirname, relative } = require('node:path');
+const zlib = require('node:zlib');
+const { promisify } = require('node:util');
+
+const gzip = promisify(zlib.gzip);
+const brotliCompress = promisify(zlib.brotliCompress);
+const deflate = promisify(zlib.deflate);
 
 // Environment variable SNAPSHOT = update / append / ignore / read (default)
 const SNAPSHOT = process.env.SNAPSHOT || 'read';
@@ -96,7 +102,7 @@ async function defaultSnapshotFileNameGenerator(request) {
     filePrefix = [
       'dynamodb',
       matches[1], // e.g. eu-west-1
-      slugify(request.headers?.get?.('x-amz-target')?.split?.('.')?.pop?.() || ''),
+      slugify(request.headers?.get?.('x-amz-target')?.split?.('.')?.pop?.() || ''), // e.g. get-item, put-item
       slugify(JSON.parse(await request.clone().text())?.TableName),
     ].filter(Boolean).join('-');
   } else {
@@ -134,7 +140,7 @@ let snapshotSubDirectory = '';
 /**
  * @param {Request} request
  */
-async function getSnapshotFileName(request) {
+async function getSnapshotFileInfo(request) {
   const { fileSuffixKey, filePrefix } = await snapshotFileNameGenerator(request.clone());
 
   // 15 characters are enough for uniqueness
@@ -153,6 +159,8 @@ async function getSnapshotFileName(request) {
   };
 }
 
+/** @typedef {Awaited<ReturnType<getSnapshotFileInfo>>} SnapshotFileInfo */
+
 // NOTE: This isn't going to work on a test runner that uses multiple processes / workers
 /**
  * @typedef {Promise<{
@@ -167,20 +175,12 @@ const readFiles = new Set();
 const existingSubDirectories = new Set();
 
 /**
- * @param {object} param
- * @param {Request} param.request
- * @param {Response} param.response
- * @param {string} param.absoluteFilePath
- * @param {string} param.fileName
- * @param {string} param.fileSuffixKey
+ * @param {Request} request
+ * @param {Response} response
+ * @param {SnapshotFileInfo} snapshotFileInfo
  */
-async function saveSnapshot({
-  request,
-  response,
-  absoluteFilePath,
-  fileName,
-  fileSuffixKey,
-}) {
+async function saveSnapshot(request, response, snapshotFileInfo) {
+  const { absoluteFilePath, fileName, fileSuffixKey } = snapshotFileInfo;
   // Prevent multiple tests from having same snapshot
   if (alreadyWrittenFiles.has(absoluteFilePath)) {
     return /** @type {ReadSnapshotReturnType} */ (alreadyWrittenFiles.get(absoluteFilePath));
@@ -264,9 +264,10 @@ const snapshotCache = {};
 
 /**
  * @param {Request} request
+ * @param {SnapshotFileInfo} snapshotFileInfo
  */
-async function readSnapshot(request) {
-  const { absoluteFilePath, fileName, fileSuffixKey } = await getSnapshotFileName(request);
+async function readSnapshot(request, snapshotFileInfo) {
+  const { absoluteFilePath, fileName, fileSuffixKey } = snapshotFileInfo;
 
   if (!snapshotCache[absoluteFilePath]) {
     if (LOG_SNAPSHOT) {
@@ -307,10 +308,10 @@ async function readSnapshot(request) {
 }
 
 /**
- * @param {Request} request
+ * @param {RequestController} controller
  * @param {Snapshot} snapshot
  */
-async function sendResponse(request, snapshot) {
+async function sendResponse(controller, snapshot) {
   const {
     responseType,
     response: {
@@ -321,10 +322,31 @@ async function sendResponse(request, snapshot) {
     },
   } = snapshot;
 
+  /** @type {string|Buffer} */
+  let encodedBody = responseType === 'json'
+    ? JSON.stringify(body)
+    : /** @type {string} */ (body);
+  const contentEncoding = headers.find(tuple => tuple[0]?.toLowerCase() === 'content-encoding');
+
+  if (contentEncoding) {
+    if (contentEncoding[1].includes('br')) {
+      encodedBody = await brotliCompress(encodedBody);
+    } else if (contentEncoding[1].includes('gzip')) {
+      encodedBody = await gzip(encodedBody);
+    } else if (contentEncoding[1].includes('deflate')) {
+      encodedBody = await deflate(encodedBody);
+    } else if (contentEncoding[1].includes('compress')) {
+      // Most servers don't send compress responses and node.js
+      // doesn't have built-in compress support even for fetch().
+      throw new Error('compress encoding not supported');
+    } else if (contentEncoding[1].includes('zstd')) {
+      // Node.js doesn't have built-in zstd support at the moment
+      throw new Error('zstd encoding not supported');
+    }
+  }
+
   const newResponse = new Response(
-    responseType === 'json'
-      ? JSON.stringify(body)
-      : /** @type {string} */ (body),
+    encodedBody,
     {
       status,
       statusText,
@@ -332,19 +354,20 @@ async function sendResponse(request, snapshot) {
     },
   );
 
-  // respondWith is a method added by @mswjs/interceptors
   // @ts-ignore
-  request.respondWith(newResponse);
+  controller.respondWith(newResponse);
   return newResponse;
 }
 
 /**
  * @param {Request} request
+ * @param {RequestController} controller
+ * @param {SnapshotFileInfo} snapshotFileInfo
  */
-async function readSnapshotAndSendResponse(request) {
-  const { snapshot } = await readSnapshot(request);
+async function readSnapshotAndSendResponse(request, controller, snapshotFileInfo) {
+  const { snapshot } = await readSnapshot(request, snapshotFileInfo);
   if (snapshot) {
-    return sendResponse(request, snapshot);
+    return sendResponse(controller, snapshot);
   }
   return undefined;
 }
@@ -464,10 +487,14 @@ function start({
     ],
   });
 
+  const cache = /** @type {WeakMap<Request, SnapshotFileInfo>} */ (new WeakMap());
+
   // @ts-ignore
-  interceptor.on('request', async ({ request }) => {
+  interceptor.on('request', async ({ request, controller }) => {
     if (['read', 'append'].includes(SNAPSHOT)) {
-      await readSnapshotAndSendResponse(request);
+      const snapshotFileInfo = await getSnapshotFileInfo(request);
+      cache.set(request, snapshotFileInfo);
+      await readSnapshotAndSendResponse(request, controller, snapshotFileInfo);
     }
   });
   interceptor.on(
@@ -475,7 +502,13 @@ function start({
     'response',
     /** @type {(params: { request: Request, response: Response }) => Promise<void>} */
     async ({ request, response }) => {
-      const { absoluteFilePath, fileName, fileSuffixKey } = await getSnapshotFileName(request);
+      const snapshotFileInfo = cache.get(request) || (await getSnapshotFileInfo(request));
+      cache.delete(request);
+      const {
+        // absoluteFilePath,
+        fileName,
+        fileSuffixKey,
+      } = snapshotFileInfo;
       if (LOG_REQ) {
         const summary = `----------\n${request.method} ${request.url}\nWould use file name: ${fileName}`;
         if (LOG_REQ === '1' || LOG_REQ === 'summary') {
@@ -503,9 +536,7 @@ function start({
           dirCreatePromise = fs.mkdir( /** @type {string} */(snapshotDirectory), { recursive: true });
         }
         await dirCreatePromise;
-        await saveSnapshot({
-          request, response, absoluteFilePath, fileName, fileSuffixKey,
-        });
+        await saveSnapshot(request, response, snapshotFileInfo);
       }
     },
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-snapshotter",
-  "version": "0.4.2",
+  "version": "0.5.0-beta.0",
   "description": "Snapshot HTTP requests for tests (node.js)",
   "main": "index.js",
   "types": "index.d.ts",
@@ -24,7 +24,7 @@
     "url": "https://github.com/Munawwar/http-snapshotter/issues"
   },
   "dependencies": {
-    "@mswjs/interceptors": "^0.24.1",
+    "@mswjs/interceptors": "^0.37.5",
     "@sindresorhus/slugify": "^1.1.2"
   },
   "devDependencies": {