node-tdd 3.0.5 → 3.1.2

package/README.md

@@ -80,12 +80,13 @@ Can be used in the following ways:
 
 - `--nock-heal`: Will try to heal ordering of nock cassette recordings
 - `--nock-heal prune`: Will remove unmatched recordings from nock cassette
+- `--nock-heal headers`: Will try to heal request headers of nock cassette recordings
 - `--nock-heal body`: Will try to heal bodies of nock cassette recordings
 - `--nock-heal path`: Will try to heal paths of nock cassette recordings
 - `--nock-heal response`: Will try to heal responses
 - `--nock-heal record`: Will record the next unmatched request
 - `--nock-heal stub`: Will stub the next unmatched request
-- `--nock-heal magic`: Shorthand for `prune,body,path,response`
+- `--nock-heal magic`: Shorthand for `headers,body,path,response`
 
 Notes:
 - Different flags can be combined as e.g. `--nock-heal body,path`

package/lib/modules/request-recorder/nock-mock.js

@@ -2,7 +2,7 @@
 
 const nockCommon = require('nock/lib/common');
 
-const fns = ['setInterval', 'setTimeout'];
+const fns = ['setInterval', 'setTimeout', 'deleteHeadersField'];
 const originals = fns.reduce((p, c) => Object.assign(p, {
   [c]: nockCommon[c]
 }), {});
@@ -10,6 +10,10 @@ module.exports = {
   patch: () => {
     fns.forEach(fn => {
       nockCommon[fn] = (...args) => {
+        if (fn === 'deleteHeadersField') {
+          return undefined;
+        }
+
         if (args[1] === 0) {
           return args[0](...args.slice(2));
         }

package/lib/modules/request-recorder/request-injector.js

@@ -6,7 +6,7 @@ const http = require('http');
 
 const https = require('https');
 
-const common = require('nock/lib/common');
+const nockCommon = require('nock/lib/common');
 
 let lastProtocol = null;
 let lastOptions = null;
@@ -21,7 +21,7 @@ const wrapper = proto => {
 
   const requestWrapper = (...args) => {
     lastProtocol = proto;
-    lastOptions = common.normalizeClientRequestArgs(...args).options;
+    lastOptions = nockCommon.normalizeClientRequestArgs(...args).options;
     lastBody.length = 0;
     const result = requestOriginal.call(protocol, ...args);
     const writeOriginal = result.write;

package/lib/modules/request-recorder/util.js

@@ -24,4 +24,12 @@ module.exports.convertHeaders = array => {
   }
 
   return obj;
+};
+
+module.exports.rewriteHeaders = (headers, fn = (k, v) => v) => {
+  if (headers === undefined) {
+    return {};
+  }
+
+  return Object.fromEntries(Object.entries(headers).sort(([a], [b]) => a > b ? 1 : -1).map(([k, v]) => [k.toLowerCase(), fn(k, v)]));
 };

package/lib/modules/request-recorder.js

@@ -16,6 +16,10 @@ const nock = require('nock');
 
 const cloneDeep = require('lodash.clonedeep');
 
+const compareUrls = require('compare-urls');
+
+const nockCommon = require('nock/lib/common');
+
 const nockListener = require('./request-recorder/nock-listener');
 
 const nockMock = require('./request-recorder/nock-mock');
@@ -28,7 +32,8 @@ const {
   buildKey,
   tryParseJson,
   nullAsString,
-  convertHeaders
+  convertHeaders,
+  rewriteHeaders
 } = require('./request-recorder/util');
 
 const requestInjector = require('./request-recorder/request-injector');
@@ -99,7 +104,7 @@ module.exports = opts => {
             nockRecorder.rec({
               output_objects: true,
               dont_print: true,
-              enable_reqheaders_recording: false
+              enable_reqheaders_recording: true
             });
             await new Promise(resolve => {
               options.protocol = `${protocol}:`;
@@ -131,6 +136,7 @@ module.exports = opts => {
             path: options.path,
             body: tryParseJson(body),
             status: 200,
+            reqheaders: rewriteHeaders(options.headers),
             response: {},
             responseIsBinary: false
           });
@@ -141,6 +147,19 @@ module.exports = opts => {
           records.push(cloneDeep(scope));
           applyModifiers(scope, opts.modifiers); // eslint-disable-next-line no-param-reassign
 
+          scope.reqheaders = rewriteHeaders(scope.reqheaders, (k, valueRecording) => valueRequest => {
+            const match = nockCommon.matchStringOrRegexp(valueRequest, /^\^.*\$$/.test(valueRecording) ? new RegExp(valueRecording) : valueRecording);
+
+            if (!match && anyFlagPresent(['magic', 'headers'])) {
+              const idx = pendingMocks.findIndex(m => m.idx === scopeIdx); // overwrite existing headers
+
+              pendingMocks[idx].record.reqheaders[k] = valueRequest;
+              return true;
+            }
+
+            return match;
+          }); // eslint-disable-next-line no-param-reassign
+
           scope.filteringRequestBody = body => {
             if (anyFlagPresent(['magic', 'body'])) {
               const idx = pendingMocks.findIndex(m => m.idx === scopeIdx);
@@ -156,7 +175,11 @@ module.exports = opts => {
           scope.filteringPath = requestPath => {
             if (anyFlagPresent(['magic', 'path'])) {
               const idx = pendingMocks.findIndex(m => m.idx === scopeIdx);
-              pendingMocks[idx].record.path = requestPath;
+
+              if (!compareUrls(pendingMocks[idx].record.path, requestPath)) {
+                pendingMocks[idx].record.path = requestPath;
+              }
+
               return scope.path;
             }
 
@@ -169,6 +192,13 @@ module.exports = opts => {
           scope.on('request', (req, interceptor, requestBodyString) => {
             const idx = pendingMocks.findIndex(e => e.idx === scopeIdx);
 
+            if (anyFlagPresent(['magic', 'headers'])) {
+              // add new headers
+              pendingMocks[idx].record.reqheaders = { ...rewriteHeaders(req.headers),
+                ...rewriteHeaders(pendingMocks[idx].record.reqheaders)
+              };
+            }
+
             if (anyFlagPresent(['magic', 'response'])) {
               const responseBody = tryParseJson([healSqsSendMessageBatch].reduce((respBody, fn) => fn(requestBodyString, respBody, scope), interceptor.body)); // eslint-disable-next-line no-param-reassign
 
@@ -187,7 +217,8 @@ module.exports = opts => {
         },
         afterRecord: recordings => JSON.stringify(recordings.map(r => ({ ...r,
           body: tryParseJson(r.body),
-          rawHeaders: opts.stripHeaders === true ? undefined : r.rawHeaders
+          rawHeaders: opts.stripHeaders === true ? undefined : r.rawHeaders,
+          reqheaders: rewriteHeaders(r.reqheaders)
         })), null, 2)
       }, resolve));
       requestInjector.inject();
@@ -195,10 +226,6 @@ module.exports = opts => {
     release: async () => {
       assert(nockDone !== null);
       requestInjector.release();
-      nockDone();
-      nockDone = null;
-      nockListener.unsubscribeAll('no match');
-      nockMock.unpatch();
 
       for (let idx = 0; idx < expectedCassette.length; idx += 1) {
         if (typeof expectedCassette[idx] === 'function') {
@@ -208,8 +235,13 @@ module.exports = opts => {
         }
       }
 
+      nockDone();
+      nockDone = null;
+      nockListener.unsubscribeAll('no match');
+      nockMock.unpatch();
+
       if (opts.heal !== false) {
-        fs.smartWrite(cassetteFilePath, anyFlagPresent(['magic', 'prune']) ? expectedCassette : [...expectedCassette, ...pendingMocks.map(({
+        fs.smartWrite(cassetteFilePath, anyFlagPresent(['prune']) ? expectedCassette : [...expectedCassette, ...pendingMocks.map(({
           record
         }) => record)], {
           keepOrder: outOfOrderErrors.length === 0 && pendingMocks.length === 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-tdd",
-  "version": "3.0.5",
+  "version": "3.1.2",
   "description": "Drop in extension for mocha to abstract commonly used test setups",
   "main": "lib/index.js",
   "scripts": {
@@ -48,7 +48,7 @@
     "@blackflux/robo-config-plugin": "5.3.0",
     "aws-sdk": "2.981.0",
     "aws-sdk-wrap": "9.6.0",
-    "axios": "0.21.1",
+    "axios": "0.24.0",
     "babel-eslint": "10.1.0",
     "babel-preset-latest-node": "5.5.1",
     "chai": "4.3.4",
@@ -109,6 +109,7 @@
   ],
   "dependencies": {
     "callsites": "3.1.0",
+    "compare-urls": "2.0.0",
     "joi-strict": "2.0.0",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "4.4.2",