node-tdd 3.3.1 → 3.4.0

package/lib/modules/request-recorder.js

@@ -1,54 +1,43 @@
-"use strict";
-
-const assert = require('assert');
-
-const http = require('http');
-
-const https = require('http');
-
-const path = require('path');
-
-const fs = require('smart-fs');
-
-const Joi = require('joi-strict');
-
-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');
-
-const healSqsSendMessageBatch = require('./request-recorder/heal-sqs-send-message-batch');
-
-const applyModifiers = require('./request-recorder/apply-modifiers');
-
-const {
+import assert from 'assert';
+import http from 'http';
+import path from 'path';
+import fs from 'smart-fs';
+import Joi from 'joi-strict';
+import nock from 'nock';
+import cloneDeep from 'lodash.clonedeep';
+import compareUrls from 'compare-urls';
+import nockCommon from 'nock/lib/common.js';
+import nockListener from './request-recorder/nock-listener.js';
+import nockMock from './request-recorder/nock-mock.js';
+import healSqsSendMessageBatch from './request-recorder/heal-sqs-send-message-batch.js';
+import applyModifiers from './request-recorder/apply-modifiers.js';
+import requestInjector from './request-recorder/request-injector.js';
+
+import {
   buildKey,
   tryParseJson,
   nullAsString,
   convertHeaders,
   rewriteHeaders
-} = require('./request-recorder/util');
-
-const requestInjector = require('./request-recorder/request-injector');
+} from './request-recorder/util.js';
 
 const nockBack = nock.back;
 const nockRecorder = nock.recorder;
 
-module.exports = opts => {
+export default (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())),
+    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')))
+    modifiers: Joi.object().pattern(
+      Joi.string(),
+      Joi.alternatives(Joi.function(), Joi.link('#modifiers'))
+    )
   }), 'Invalid Options Provided');
   let nockDone = null;
   let cassetteFilePath = null;
@@ -58,47 +47,44 @@ module.exports = opts => {
   const expectedCassette = [];
   const pendingMocks = [];
 
-  const anyFlagPresent = flags => {
+  const anyFlagPresent = (flags) => {
     assert(Array.isArray(flags) && flags.length !== 0);
-
     if (typeof opts.heal !== 'string') {
       return false;
     }
-
     const needleFlags = opts.heal.split(',');
-    return flags.some(flag => needleFlags.includes(flag));
+    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 typeof opts.reqHeaderOverwrite[key] === 'function'
+        ? opts.reqHeaderOverwrite[key]({ key, value, headers })
+        : opts.reqHeaderOverwrite[key];
     }
-
     return value;
   };
 
-  return {
-    inject: async cassetteFile => {
+  return ({
+    inject: async (cassetteFile) => {
       assert(nockDone === null);
       knownCassetteNames.push(cassetteFile);
       records.length = 0;
       outOfOrderErrors.length = 0;
       expectedCassette.length = 0;
       pendingMocks.length = 0;
+
       cassetteFilePath = path.join(opts.cassetteFolder, cassetteFile);
       const hasCassette = fs.existsSync(cassetteFilePath);
-
       if (hasCassette) {
         const cassetteContent = fs.smartRead(cassetteFilePath);
-        pendingMocks.push(...nock.define(cassetteContent).map((e, idx) => ({
-          idx,
-          key: buildKey(e.interceptors[0]),
-          record: cassetteContent[idx]
-        })));
+        pendingMocks.push(...nock
+          .define(cassetteContent)
+          .map((e, idx) => ({
+            idx,
+            key: buildKey(e.interceptors[0]),
+            record: cassetteContent[idx]
+          })));
       }
 
       nockBack.setMode(hasCassette ? 'lockdown' : 'record');
@@ -106,12 +92,7 @@ module.exports = opts => {
       nockMock.patch();
       nockListener.subscribe('no match', () => {
         assert(hasCassette === true);
-        const {
-          protocol,
-          options,
-          body
-        } = requestInjector.getLast();
-
+        const { protocol, options, body } = requestInjector.getLast();
         if (anyFlagPresent(['record'])) {
           expectedCassette.push(async () => {
             nockRecorder.rec({
@@ -119,25 +100,20 @@ module.exports = opts => {
               dont_print: true,
               enable_reqheaders_recording: true
             });
-            await new Promise(resolve => {
+            await new Promise((resolve) => {
               options.protocol = `${protocol}:`;
-              const r = {
-                http,
-                https
-              }[protocol].request(options, response => {
+              const r = { http, https: http }[protocol].request(options, (response) => {
                 response.on('data', () => {});
                 response.on('end', resolve);
               });
-
               if (body !== undefined) {
                 r.write(body);
               }
-
               r.end();
             });
             const recorded = nockRecorder.play();
             nockRecorder.clear();
-            return recorded.map(record => Object.assign(record, {
+            return recorded.map((record) => Object.assign(record, {
               headers: opts.stripHeaders === true ? undefined : convertHeaders(record.rawHeaders),
               rawHeaders: undefined,
               reqheaders: rewriteHeaders(record.reqheaders, overwriteHeaders)
@@ -156,86 +132,101 @@ module.exports = opts => {
           });
         }
       });
-      nockDone = await new Promise(resolve => nockBack(cassetteFile, {
-        before: (scope, scopeIdx) => {
-          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);
-              const requestBody = tryParseJson(body);
-              pendingMocks[idx].record.body = nullAsString(requestBody);
-              return scope.body;
-            }
-
-            return body;
-          }; // eslint-disable-next-line no-param-reassign
-
-
-          scope.filteringPath = requestPath => {
-            if (anyFlagPresent(['magic', 'path'])) {
-              const idx = pendingMocks.findIndex(m => m.idx === scopeIdx);
-
-              if (!compareUrls(pendingMocks[idx].record.path, requestPath)) {
-                pendingMocks[idx].record.path = requestPath;
+      nockDone = await new Promise((resolve) => {
+        nockBack(cassetteFile, {
+          before: (scope, scopeIdx) => {
+            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);
+                const requestBody = tryParseJson(body);
+                pendingMocks[idx].record.body = nullAsString(requestBody);
+                return scope.body;
+              }
+              return body;
+            };
+            // eslint-disable-next-line no-param-reassign
+            scope.filteringPath = (requestPath) => {
+              if (anyFlagPresent(['magic', 'path'])) {
+                const idx = pendingMocks.findIndex((m) => m.idx === scopeIdx);
+                if (!compareUrls(pendingMocks[idx].record.path, requestPath)) {
+                  pendingMocks[idx].record.path = requestPath;
+                }
+                return scope.path;
+              }
+              return requestPath;
+            };
+            return scope;
+          },
+          after: (scope, scopeIdx) => {
+            scope.on('request', (req, interceptor, requestBodyString) => {
+              const idx = pendingMocks.findIndex((e) => e.idx === scopeIdx);
+
+              // https://github.com/nock/nock/blob/79ee0429050af929c525ae21a326d22796344bfc/lib/interceptor.js#L616
+              if (Number.isInteger(pendingMocks[idx]?.record?.delayConnection)) {
+                interceptor.delayConnection(pendingMocks[idx].record.delayConnection);
+              }
+              if (Number.isInteger(pendingMocks[idx]?.record?.delayBody)) {
+                interceptor.delayBody(pendingMocks[idx].record.delayBody);
               }
 
-              return scope.path;
-            }
-
-            return requestPath;
-          };
-
-          return scope;
-        },
-        after: (scope, scopeIdx) => {
-          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
-
-              interceptor.body = responseBody;
-              pendingMocks[idx].record.response = responseBody;
-            }
-
-            expectedCassette.push(pendingMocks[idx].record);
+              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 (idx !== 0) {
-              outOfOrderErrors.push(pendingMocks[idx].key);
-            }
+              if (anyFlagPresent(['magic', 'response'])) {
+                const responseBody = tryParseJson([
+                  healSqsSendMessageBatch
+                ].reduce(
+                  (respBody, fn) => fn(requestBodyString, respBody, scope),
+                  interceptor.body
+                ));
+                // eslint-disable-next-line no-param-reassign
+                interceptor.body = responseBody;
+                pendingMocks[idx].record.response = responseBody;
+              }
 
-            pendingMocks.splice(idx, 1);
-          });
-        },
-        afterRecord: recordings => JSON.stringify(recordings.map(r => ({ ...r,
-          body: tryParseJson(r.body),
-          rawHeaders: opts.stripHeaders === true ? undefined : r.rawHeaders,
-          reqheaders: rewriteHeaders(r.reqheaders, overwriteHeaders)
-        })), null, 2)
-      }, resolve));
+              expectedCassette.push(pendingMocks[idx].record);
+              if (idx !== 0) {
+                outOfOrderErrors.push(pendingMocks[idx].key);
+              }
+              pendingMocks.splice(idx, 1);
+            });
+          },
+          afterRecord: (recordings) => JSON.stringify(recordings.map((r) => ({
+            ...r,
+            body: tryParseJson(r.body),
+            rawHeaders: opts.stripHeaders === true ? undefined : r.rawHeaders,
+            reqheaders: rewriteHeaders(r.reqheaders, overwriteHeaders)
+          })), null, 2)
+        }, resolve);
+      });
       requestInjector.inject();
     },
     release: async () => {
@@ -245,7 +236,7 @@ module.exports = opts => {
       for (let idx = 0; idx < expectedCassette.length; idx += 1) {
         if (typeof expectedCassette[idx] === 'function') {
           // eslint-disable-next-line no-await-in-loop
-          expectedCassette.splice(idx, 1, ...(await expectedCassette[idx]()));
+          expectedCassette.splice(idx, 1, ...await expectedCassette[idx]());
           idx -= 1;
         }
       }
@@ -256,26 +247,25 @@ module.exports = opts => {
       nockMock.unpatch();
 
       if (opts.heal !== false) {
-        fs.smartWrite(cassetteFilePath, anyFlagPresent(['prune']) ? expectedCassette : [...expectedCassette, ...pendingMocks.map(({
-          record
-        }) => record)], {
-          keepOrder: outOfOrderErrors.length === 0 && pendingMocks.length === 0
-        });
+        fs.smartWrite(
+          cassetteFilePath,
+          anyFlagPresent(['prune'])
+            ? expectedCassette
+            : [...expectedCassette, ...pendingMocks.map(({ record }) => record)],
+          { keepOrder: outOfOrderErrors.length === 0 && pendingMocks.length === 0 }
+        );
       }
-
       if (opts.strict !== false) {
         if (outOfOrderErrors.length !== 0) {
           throw new Error(`Out of Order Recordings: ${outOfOrderErrors.join(', ')}`);
         }
-
         if (pendingMocks.length !== 0) {
-          throw new Error(`Unmatched Recordings: ${pendingMocks.map(e => e.key).join(', ')}`);
+          throw new Error(`Unmatched Recordings: ${pendingMocks.map((e) => e.key).join(', ')}`);
         }
       }
     },
     shutdown: () => {
-      const unexpectedFiles = fs.walkDir(opts.cassetteFolder).filter(f => !knownCassetteNames.includes(f));
-
+      const unexpectedFiles = fs.walkDir(opts.cassetteFolder).filter((f) => !knownCassetteNames.includes(f));
       if (unexpectedFiles.length !== 0) {
         throw new Error(`Unexpected file(s) in cassette folder: ${unexpectedFiles.join(', ')}`);
       }
@@ -283,9 +273,9 @@ module.exports = opts => {
     get: () => ({
       records: records.slice(),
       outOfOrderErrors: outOfOrderErrors.slice(),
-      unmatchedRecordings: pendingMocks.map(e => e.key).slice(),
+      unmatchedRecordings: pendingMocks.map((e) => e.key).slice(),
       expectedCassette: expectedCassette.slice(),
       cassetteFilePath
     })
-  };
-};
+  });
+};

package/lib/modules/time-keeper.js

@@ -1,19 +1,22 @@
-"use strict";
+import assert from 'assert';
+import Joi from 'joi-strict';
+import tk from 'timekeeper';
 
-const assert = require('assert');
-
-const Joi = require('joi-strict');
-
-const tk = require('timekeeper');
-
-module.exports = opts => {
+export default (opts) => {
   Joi.assert(opts, Joi.object().keys({
-    timestamp: Joi.alternatives(Joi.number().integer().min(0), Joi.date().iso())
+    timestamp: Joi.alternatives(
+      Joi.number().integer().min(0),
+      Joi.date().iso()
+    )
   }), 'Invalid Options Provided');
   return {
     inject: () => {
       assert(tk.isKeepingTime() === false);
-      tk.freeze(Number.isInteger(opts.timestamp) ? new Date(opts.timestamp * 1000) : new Date(opts.timestamp));
+      tk.freeze(
+        Number.isInteger(opts.timestamp)
+          ? new Date(opts.timestamp * 1000)
+          : new Date(opts.timestamp)
+      );
     },
     release: () => {
       assert(tk.isKeepingTime());
@@ -21,4 +24,4 @@ module.exports = opts => {
     },
     isInjected: () => tk.isKeepingTime()
   };
-};
+};