node-tdd 3.4.3 → 3.5.0

package/README.md

@@ -176,6 +176,13 @@ loaded from `envVarsFile` (if allowed).
 
 To allow overwriting of environment variables, prefix the name of the environment variable with `^`.
 
+#### clearCache
+
+Type: `boolean`<br>
+Default: `true`
+
+Known accessed caches will be cleared after test has executed when set to `true`.
+
 #### timestamp
 
 Type: `number|string`<br>

package/lib/modules/cache-clearer.js

@@ -0,0 +1,57 @@
+import assert from 'assert';
+import LRU from 'lru-cache-ext';
+
+const getFns = (obj) => {
+  const result = [];
+  const properties = [];
+  let o = obj;
+  while (o instanceof Object) {
+    properties.push(...Object.getOwnPropertyNames(o));
+    o = Object.getPrototypeOf(o);
+  }
+  for (let i = 0; i < properties.length; i += 1) {
+    const key = properties[i];
+    const value = LRU.prototype[key];
+    if (typeof value !== 'function') {
+      // eslint-disable-next-line no-continue
+      continue;
+    }
+    result.push({ obj, key, value });
+  }
+  return result;
+};
+
+export default () => {
+  let injected = false;
+  const fns = [
+    ...getFns(LRU.prototype)
+  ];
+  const caches = [];
+
+  return {
+    inject: () => {
+      assert(injected === false);
+      fns.forEach(({ obj, key, value }) => {
+        try {
+          // eslint-disable-next-line no-param-reassign,func-names
+          obj[key] = function (...args) {
+            caches.push(this);
+            return value.call(this, ...args);
+          };
+        } catch (e) { /* ignored */ }
+      });
+      injected = true;
+    },
+    release: () => {
+      assert(injected === true);
+      fns.forEach(({ obj, key, value }) => {
+        try {
+          // eslint-disable-next-line no-param-reassign
+          obj[key] = value;
+        } catch (e) { /* ignored */ }
+      });
+      caches.splice(0).forEach((c) => c.clear());
+      injected = false;
+    }
+  };
+};

package/lib/util/desc.js

@@ -12,6 +12,7 @@ import EnvManager from '../modules/env-manager.js';
 import TimeKeeper from '../modules/time-keeper.js';
 import LogRecorder from '../modules/log-recorder.js';
 import RandomSeeder from '../modules/random-seeder.js';
+import CacheClearer from '../modules/cache-clearer.js';
 import { getParents, genCassetteName } from './mocha-test.js';
 
 const mocha = {
@@ -53,6 +54,7 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
     fixtureFolder: Joi.string().optional(),
     envVarsFile: Joi.string().optional(),
     envVars: Joi.object().optional().unknown(true).pattern(Joi.string(), Joi.string()),
+    clearCache: Joi.boolean().optional(),
     timestamp: Joi.alternatives(
       Joi.number().integer().min(0),
       Joi.date().iso()
@@ -75,6 +77,7 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
   const fixtureFolder = resolve(get(opts, 'fixtureFolder', '$FILENAME__fixtures'));
   const envVarsFile = resolve(get(opts, 'envVarsFile', '$FILENAME.env.yml'));
   const envVars = get(opts, 'envVars', null);
+  const clearCache = get(opts, 'clearCache', true);
   const timestamp = get(opts, 'timestamp', null);
   const record = get(opts, 'record', false);
   const cryptoSeed = get(opts, 'cryptoSeed', null);
@@ -84,6 +87,7 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
 
   let dir = null;
   let requestRecorder = null;
+  let cacheClearer = null;
   let envManagerFile = null;
   let envManagerDesc = null;
   let timeKeeper = null;
@@ -130,6 +134,9 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
       // eslint-disable-next-line func-names
       mocha.before(function () {
         return (async () => {
+          if (clearCache !== false) {
+            cacheClearer = CacheClearer();
+          }
           if (getParents(this.test).length === 3 && fs.existsSync(envVarsFile)) {
             envManagerFile = EnvManager({ envVars: fs.smartRead(envVarsFile), allowOverwrite: false });
             envManagerFile.apply();
@@ -190,6 +197,9 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
       // eslint-disable-next-line func-names
       mocha.beforeEach(function () {
         return (async () => {
+          if (cacheClearer !== null) {
+            cacheClearer.inject();
+          }
           if (useTmpDir === true) {
             tmp.setGracefulCleanup();
             dir = tmp.dirSync({ keep: false, unsafeCleanup: true }).name;
@@ -222,6 +232,9 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
           if (dir !== null) {
             dir = null;
           }
+          if (cacheClearer !== null) {
+            cacheClearer.release();
+          }
         })();
       });
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-tdd",
   "type": "module",
-  "version": "3.4.3",
+  "version": "3.5.0",
   "description": "Drop in extension for mocha to abstract commonly used test setups",
   "main": "lib/index.js",
   "scripts": {
@@ -81,6 +81,7 @@
     "joi-strict": "2.0.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "4.4.2",
+    "lru-cache-ext": "3.0.2",
     "minimist": "1.2.6",
     "nock": "13.2.4",
     "object-scan": "18.0.1",