http-snapshotter 0.1.4 → 0.2.0

package/README.md

@@ -41,7 +41,7 @@ In this mode, http-snapshotter will prevent any real HTTP calls from happening b
 
 There is also a `SNAPSHOT=ignore` option to neither read nor write from snapshot files and do real network requests instead. This could be useful while writing a new test.
 
-Tip: When you do `SNAPSHOT=update` to create snapshots, run it against a single test, so you know what exact snapshots that one test created.
+Tip: When you do `SNAPSHOT=update` to create snapshots, run it against a single test, so you know what exact snapshots that one test created/updated.
 
 Finally after getting all your tests to use snapshots, run your test runner against all your tests and then take a look at `<snapshots directory>/unused-snapshots.log` file to see which snapshot files haven't been used by your final test suite. You can delete unused snapshot files.
 
@@ -49,8 +49,8 @@ The tests of this library uses this library itself, check the `tests/` directory
 
 ## About snapshot files and its names
 
-A snapshot file name unique identifies a request. By default it is a combination of HTTP method + URL + body that makes a request unique.
-The hash of concatenated HTTP method + URL + body makes the file name suffix.
+A snapshot file name uniquely identifies a request. By default it is a combination of HTTP method + URL + body that makes a request unique.
+A SHA256 hash of concatenated HTTP method + URL + body makes the file name suffix.
 
 However you may want to specially handle some requests. e.g. DynamoDB calls also need the `x-amz-target` header to uniquely identify the request,
 because every call is a POST call with DynamoDB. You can add logic to create better snapshot files for this case:
@@ -134,7 +134,7 @@ test('Test behavior on a free account', async (t) => {
         }
       )
     }
-    // 
+ 
     return response;
   };
   attachResponseTransformer(interceptResponse);

package/index.js

@@ -140,7 +140,15 @@ async function getSnapshotFileName(request) {
 }
 
 // NOTE: This isn't going to work on a test runner that uses multiple processes / workers
-const alreadyWrittenFiles = new Set();
+/**
+ * @typedef {Promise<{
+ *  snapshot: Snapshot,
+ *  absoluteFilePath: string,
+ *  fileName: string
+ * }>} ReadSnapshotReturnType
+ */
+/** @type {Map<string, ReadSnapshotReturnType>} */
+const alreadyWrittenFiles = new Map();
 const readFiles = new Set();
 
 /**
@@ -152,40 +160,48 @@ async function saveSnapshot(request, response) {
   // console.log(fileName);
 
   // Prevent multiple tests from having same snapshot
-  if (alreadyWrittenFiles.has(absoluteFilePath)) return fileName;
-  alreadyWrittenFiles.add(absoluteFilePath);
-
-  let body;
-  /** @type {'text' | 'json'} */
-  let responseType;
-  const contentType = response.headers.get('content-type') || '';
-  if (contentType.includes('application/json') || contentType.includes('application/x-amz-json-1.0')) {
-    responseType = 'json';
-    body = await response.clone().json();
-  } else {
-    responseType = 'text';
-    body = await response.clone().text();
+  if (alreadyWrittenFiles.has(absoluteFilePath)) {
+    return /** @type {ReadSnapshotReturnType} */ (alreadyWrittenFiles.get(absoluteFilePath));
   }
-  /** @type {Snapshot} */
-  const snapshot = {
-    request: {
-      method: request.method,
-      url: request.url,
-      headers: [...request.headers.entries()],
-      body: await request.clone().text(),
-    },
-    responseType,
-    response: {
-      status: response.status,
-      statusText: response.statusText,
-      headers: [...response.headers.entries()],
-      body,
-    },
-    fileSuffixKey,
+
+  /** @returns {ReadSnapshotReturnType} */
+  const saveFreshSnapshot = async () => {
+    let body;
+    /** @type {'text' | 'json'} */
+    let responseType;
+    const contentType = response.headers.get('content-type') || '';
+    if (contentType.includes('application/json') || contentType.includes('application/x-amz-json-1.0')) {
+      responseType = 'json';
+      body = await response.clone().json();
+    } else {
+      responseType = 'text';
+      body = await response.clone().text();
+    }
+    /** @type {Snapshot} */
+    const snapshot = {
+      request: {
+        method: request.method,
+        url: request.url,
+        headers: [...request.headers.entries()],
+        body: await request.clone().text(),
+      },
+      responseType,
+      response: {
+        status: response.status,
+        statusText: response.statusText,
+        headers: [...response.headers.entries()],
+        body,
+      },
+      fileSuffixKey,
+    };
+    const json = JSON.stringify(snapshot, null, 2);
+    await fs.writeFile(absoluteFilePath, json, 'utf-8');
+    return { snapshot, absoluteFilePath, fileName };
   };
-  const json = JSON.stringify(snapshot, null, 2);
-  await fs.writeFile(absoluteFilePath, json, 'utf-8');
-  return fileName;
+
+  const savePromise = saveFreshSnapshot();
+  alreadyWrittenFiles.set(absoluteFilePath, savePromise);
+  return savePromise;
 }
 
 /** @type {Record<string, Snapshot>} */
@@ -194,7 +210,7 @@ const snapshotCache = {};
 /**
  * @param {Request} request
  */
-async function enforceSnapshotResponse(request) {
+async function readSnapshot(request) {
   const { absoluteFilePath, fileName, fileSuffixKey } = await getSnapshotFileName(request);
   // console.log(fileName);
 
@@ -221,14 +237,22 @@ async function enforceSnapshotResponse(request) {
       } else {
         // @ts-ignore
         console.error('Error reading network snapshot file:', err.message);
+        throw err;
       }
-      return null;
     }
     snapshotCache[absoluteFilePath] = JSON.parse(json);
     readFiles.add(fileName);
   }
 
   const snapshot = snapshotCache[absoluteFilePath];
+  return { snapshot, absoluteFilePath, fileName };
+}
+
+/**
+ * @param {Request} request
+ * @param {Snapshot} snapshot
+ */
+async function sendResponse(request, snapshot) {
   const {
     responseType,
     response: {
@@ -258,6 +282,23 @@ async function enforceSnapshotResponse(request) {
   return newResponse;
 }
 
+/**
+ * @param {Request} request
+ */
+async function readSnapshotAndSendResponse(request) {
+  const { snapshot } = await readSnapshot(request);
+  return sendResponse(request, snapshot);
+}
+
+/**
+ * @param {Request} request
+ * @param {Response} response
+ */
+async function saveSnapshotAndSendResponse(request, response) {
+  const { snapshot } = await saveSnapshot(request, response);
+  return sendResponse(request, snapshot);
+}
+
 /** @typedef {import('@mswjs/interceptors/ClientRequest').ClientRequestInterceptor} ClientRequestInterceptorType */
 /** @typedef {import('@mswjs/interceptors/fetch').FetchInterceptor} FetchInterceptorType */
 /**
@@ -376,7 +417,7 @@ function start({
   // @ts-ignore
   interceptor.on('request', async ({ request }) => {
     if (SNAPSHOT === 'read') {
-      await enforceSnapshotResponse(request);
+      await readSnapshotAndSendResponse(request);
     }
   });
   interceptor.on(
@@ -384,13 +425,6 @@ function start({
     'response',
     /** @type {(params: { request: Request, response: Response }) => Promise<void>} */
     async ({ request, response }) => {
-      if (SNAPSHOT === 'update') {
-        if (!dirCreatePromise) {
-          dirCreatePromise = fs.mkdir( /** @type {string} */(snapshotDirectory), { recursive: true });
-        }
-        await dirCreatePromise;
-        saveSnapshot(request, response);
-      }
       if (LOG_REQ) {
         const { fileName, fileSuffixKey } = await getSnapshotFileName(request);
         console.debug('Request', {
@@ -404,6 +438,13 @@ function start({
           wouldBeFileSuffixKey: fileSuffixKey,
         });
       }
+      if (SNAPSHOT === 'update') {
+        if (!dirCreatePromise) {
+          dirCreatePromise = fs.mkdir( /** @type {string} */(snapshotDirectory), { recursive: true });
+        }
+        await dirCreatePromise;
+        await saveSnapshotAndSendResponse(request, response);
+      }
     },
   );
   interceptor.apply();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-snapshotter",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "Snapshot HTTP requests for tests (node.js)",
   "main": "index.cjs",
   "types": "index.d.ts",