node-tdd 3.0.6 → 3.2.0

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`
@@ -131,6 +132,13 @@ Default: `false`
 
 When set to true, all headers are stripped when requests are recorded.
 
+### nockReqHeaderOverwrite
+
+Type: `object`<br>
+Default: `{}`
+
+Can be used to overwrite `reqheaders` in recordings. Cassette files are only updated when changed.
+
 #### fixtureFolder
 
 Type: `string`<br>

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

@@ -18,6 +18,8 @@ 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');
@@ -30,7 +32,8 @@ const {
   buildKey,
   tryParseJson,
   nullAsString,
-  convertHeaders
+  convertHeaders,
+  rewriteHeaders
 } = require('./request-recorder/util');
 
 const requestInjector = require('./request-recorder/request-injector');
@@ -42,6 +45,7 @@ module.exports = opts => {
   Joi.assert(opts, Joi.object().keys({
     cassetteFolder: Joi.string(),
     stripHeaders: Joi.boolean(),
+    reqHeaderOverwrite: Joi.object().pattern(Joi.string().case('lower'), Joi.string()),
     strict: Joi.boolean(),
     heal: Joi.alternatives(Joi.boolean(), Joi.string()),
     modifiers: Joi.object().pattern(Joi.string(), Joi.alternatives(Joi.function(), Joi.link('#modifiers')))
@@ -65,6 +69,14 @@ module.exports = opts => {
     return flags.some(flag => needleFlags.includes(flag));
   };
 
+  const overwriteHeaders = (k, v) => {
+    if (k in opts.reqHeaderOverwrite) {
+      return opts.reqHeaderOverwrite[k];
+    }
+
+    return v;
+  };
+
   return {
     inject: async cassetteFile => {
       assert(nockDone === null);
@@ -101,7 +113,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}:`;
@@ -123,7 +135,8 @@ module.exports = opts => {
             nockRecorder.clear();
             return recorded.map(record => Object.assign(record, {
               headers: opts.stripHeaders === true ? undefined : convertHeaders(record.rawHeaders),
-              rawHeaders: undefined
+              rawHeaders: undefined,
+              reqheaders: rewriteHeaders(record.reqheaders, overwriteHeaders)
             }));
           });
         } else if (anyFlagPresent(['stub'])) {
@@ -133,6 +146,7 @@ module.exports = opts => {
             path: options.path,
             body: tryParseJson(body),
             status: 200,
+            reqheaders: rewriteHeaders(options.headers, overwriteHeaders),
             response: {},
             responseIsBinary: false
           });
@@ -143,6 +157,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);
@@ -175,6 +202,14 @@ module.exports = opts => {
           scope.on('request', (req, interceptor, requestBodyString) => {
             const idx = pendingMocks.findIndex(e => e.idx === scopeIdx);
 
+            if (anyFlagPresent(['magic', 'headers'])) {
+              // add new headers
+              const reqheaders = { ...rewriteHeaders(req.headers),
+                ...rewriteHeaders(pendingMocks[idx].record.reqheaders)
+              };
+              pendingMocks[idx].record.reqheaders = rewriteHeaders(reqheaders, overwriteHeaders);
+            }
+
             if (anyFlagPresent(['magic', 'response'])) {
               const responseBody = tryParseJson([healSqsSendMessageBatch].reduce((respBody, fn) => fn(requestBodyString, respBody, scope), interceptor.body)); // eslint-disable-next-line no-param-reassign
 
@@ -193,7 +228,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, overwriteHeaders)
         })), null, 2)
       }, resolve));
       requestInjector.inject();
@@ -201,10 +237,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') {
@@ -214,8 +246,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/lib/util/desc.js

@@ -73,6 +73,7 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
   const nockFolder = resolve(get(opts, 'nockFolder', '$FILENAME__cassettes'));
   const nockModifiers = get(opts, 'nockModifiers', {});
   const nockStripHeaders = get(opts, 'nockStripHeaders', false);
+  const nockReqHeaderOverwrite = get(opts, 'nockReqHeaderOverwrite', {});
   const fixtureFolder = resolve(get(opts, 'fixtureFolder', '$FILENAME__fixtures'));
   const envVarsFile = resolve(get(opts, 'envVarsFile', '$FILENAME.env.yml'));
   const envVars = get(opts, 'envVars', null);
@@ -178,6 +179,7 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
             requestRecorder = RequestRecorder({
               cassetteFolder: `${nockFolder}/`,
               stripHeaders: nockStripHeaders,
+              reqHeaderOverwrite: nockReqHeaderOverwrite,
               strict: true,
               heal: nockHeal,
               modifiers: nockModifiers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-tdd",
-  "version": "3.0.6",
+  "version": "3.2.0",
   "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",