node-tdd 3.1.0 → 3.3.0

package/README.md

@@ -86,7 +86,7 @@ Can be used in the following ways:
 - `--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,headers,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`
@@ -132,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/util.js

@@ -31,5 +31,10 @@ module.exports.rewriteHeaders = (headers, fn = (k, v) => v) => {
     return {};
   }
 
-  return Object.fromEntries(Object.entries(headers).map(([k, v]) => [k.toLowerCase(), fn(k, v)]));
+  const headersLower = Object.fromEntries(Object.entries(headers).sort(([a], [b]) => a > b ? 1 : -1).map(([k, v]) => [k.toLowerCase(), v]));
+  const result = {};
+  Object.entries(headersLower).forEach(([k, v]) => {
+    result[k] = fn(k, v, headersLower);
+  });
+  return result;
 };

package/lib/modules/request-recorder.js

@@ -45,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.alternatives(Joi.string(), Joi.function())),
     strict: Joi.boolean(),
     heal: Joi.alternatives(Joi.boolean(), Joi.string()),
     modifiers: Joi.object().pattern(Joi.string(), Joi.alternatives(Joi.function(), Joi.link('#modifiers')))
@@ -68,6 +69,18 @@ module.exports = opts => {
     return flags.some(flag => needleFlags.includes(flag));
   };
 
+  const overwriteHeaders = (key, value, headers) => {
+    if (key in opts.reqHeaderOverwrite) {
+      return typeof opts.reqHeaderOverwrite[key] === 'function' ? opts.reqHeaderOverwrite[key]({
+        key,
+        value,
+        headers
+      }) : opts.reqHeaderOverwrite[key];
+    }
+
+    return value;
+  };
+
   return {
     inject: async cassetteFile => {
       assert(nockDone === null);
@@ -126,7 +139,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'])) {
@@ -136,7 +150,7 @@ module.exports = opts => {
             path: options.path,
             body: tryParseJson(body),
             status: 200,
-            reqheaders: rewriteHeaders(options.headers),
+            reqheaders: rewriteHeaders(options.headers, overwriteHeaders),
             response: {},
             responseIsBinary: false
           });
@@ -194,9 +208,10 @@ module.exports = opts => {
 
             if (anyFlagPresent(['magic', 'headers'])) {
               // add new headers
-              pendingMocks[idx].record.reqheaders = { ...rewriteHeaders(req.headers),
+              const reqheaders = { ...rewriteHeaders(req.headers),
                 ...rewriteHeaders(pendingMocks[idx].record.reqheaders)
               };
+              pendingMocks[idx].record.reqheaders = rewriteHeaders(reqheaders, overwriteHeaders);
             }
 
             if (anyFlagPresent(['magic', 'response'])) {
@@ -217,7 +232,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();
@@ -240,7 +256,7 @@ module.exports = opts => {
       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.1.0",
+  "version": "3.3.0",
   "description": "Drop in extension for mocha to abstract commonly used test setups",
   "main": "lib/index.js",
   "scripts": {