dx: split functions in separate files

Author: stafyniaksacha

Diff for: .eslintrc.js

@@ -1,10 +1,6 @@
 module.exports = {
   parser: '@typescript-eslint/parser',
-  extends: [
-    'eslint:recommended',
-    'google',
-    'prettier',
-  ],
+  extends: ['eslint:recommended', 'google', 'prettier'],
   env: {
     commonjs: true,
     es6: true,
@@ -25,10 +21,8 @@ module.exports = {
   },
   rules: {
     indent: ['error', 2, { SwitchCase: 1 }],
-    'no-console':
-      process.env.NODE_ENV === 'production' ? 'error' : 'off',
-    'no-debugger':
-      process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
     'object-curly-spacing': 'off',
     'valid-jsdoc': 'off',
     'require-jsdoc': 'off',

Diff for: .github/workflows/npm_publish.yml

@@ -20,7 +20,7 @@ jobs:
         uses: supercharge/[email protected]
         with:
           redis-version: ${{ matrix.redis-version }}
-      - run: npm install  
+      - run: npm install
       - run: npm test
 
   publish-npm:

Diff for: .github/workflows/npm_publish_beta.yml

@@ -20,7 +20,7 @@ jobs:
         uses: supercharge/[email protected]
         with:
           redis-version: ${{ matrix.redis-version }}
-      - run: npm install  
+      - run: npm install
       - run: npm test
 
   publish-npm:

Diff for: .github/workflows/test_middleware.yml

@@ -20,5 +20,5 @@ jobs:
         uses: supercharge/[email protected]
         with:
           redis-version: ${{ matrix.redis-version }}
-      - run: npm install  
+      - run: npm install
       - run: npm test

Diff for: .prettierrc

@@ -0,0 +1,4 @@
+{
+  "trailingComma": "es5",
+  "singleQuote": true
+}

Diff for: .vscode/launch.json

@@ -5,14 +5,14 @@
   "version": "0.2.0",
   "configurations": [
     {
-        "name": "Run mocha",
-        "type": "node",
-        "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
-        "stopOnEntry": false,
-        "args": ["./tests/*.test.js", "--no-timeouts", "--exit"],
-        "cwd": "${workspaceFolder}",
-        "runtimeExecutable": null,
-        "request": "launch"
+      "name": "Run mocha",
+      "type": "node",
+      "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+      "stopOnEntry": false,
+      "args": ["./tests/*.test.js", "--no-timeouts", "--exit"],
+      "cwd": "${workspaceFolder}",
+      "runtimeExecutable": null,
+      "request": "launch"
     }
   ]
-}
+}

Diff for: README.md

@@ -36,7 +36,8 @@ yarn add strapi-middleware-cache@beta
 ## Requirements
 
 Since `2.0.1`:
-- strapi `3.4.0` 
+
+- strapi `3.4.0`
 - node `14`
 
 _See `1.5.0` for strapi < `3.4.0`_
@@ -62,8 +63,8 @@ module.exports = ({ env }) => ({
   settings: {
     cache: {
       enabled: true,
-    }
-  }
+    },
+  },
 });
 ```
 
@@ -89,8 +90,8 @@ module.exports = ({ env }) => ({
     cache: {
       enabled: true,
       models: ['review'],
-    }
-  }
+    },
+  },
 });
 ```
 
@@ -149,9 +150,9 @@ module.exports = ({ env }) => ({
           { host: '192.168.10.43', port: 26379 },
         ],
         name: 'redis-primary',
-      }
-    }
-  }
+      },
+    },
+  },
 });
 ```
 
@@ -176,6 +177,7 @@ Each route can hold its own configuration object for more granular control. This
 by replacing the model strings in the list by object.
 
 On which you can set:
+
 - Its own custom `maxAge`
 - Headers to include in the cache-key (e.g the body may differ depending on the language requested)
 
@@ -255,10 +257,10 @@ module.exports = ({ env }) => ({
         {
           model: 'footer',
           singleType: true,
-        }
-      ]
-    }
-  }
+        },
+      ],
+    },
+  },
 });
 ```
 
@@ -274,7 +276,6 @@ $ strapi develop
 [2021-02-26T07:03:18.987Z] debug [cache] GET /review recv maxAge=3600000
 ```
 
-
 ## Authentication
 
 By default, cache is not looked up if `Authorization` or `Cookie` header are present.
@@ -295,10 +296,10 @@ module.exports = ({ env }) => ({
           model: 'footer',
           hitpass: false,
           singleType: true,
-        }
-      ]
-    }
-  }
+        },
+      ],
+    },
+  },
 });
 ```
 
@@ -325,17 +326,17 @@ module.exports = ({ env }) => ({
     cache: {
       enabled: true,
       populateContext: true,
-      models: ['post']
-    }
-  }
+      models: ['post'],
+    },
+  },
 });
 
 // controller
 
 module.exports = {
   async index(ctx) {
-    ctx.middleware.cache // A direct access to the Cache API
-  }
+    ctx.middleware.cache; // A direct access to the Cache API
+  },
 };
 ```
 
@@ -352,37 +353,37 @@ module.exports = ({ env }) => ({
     cache: {
       enabled: true,
       populateStrapiMiddleware: true,
-      models: ['post']
-    }
-  }
+      models: ['post'],
+    },
+  },
 });
 
 // model
 
 module.exports = {
   lifecycles: {
     async beforeUpdate(params, data) {
-      strapi.middleware.cache // A direct access to the Cache API
-    }
-  }
+      strapi.middleware.cache; // A direct access to the Cache API
+    },
+  },
 };
 ```
 
 **IMPORTANT**: We do not recommend using this unless truly necessary. It is disabled by default as it goes against the non-intrusive/transparent nature of this middleware.
 
 ## Cache API
 
-```javascript 
+```javascript
 const cache = {
- /**
-  * @typedef {Object} CacheStore
-  * @property {function(string): any} get
-  * @property {function(string): any} peek
-  * @property {function(string, any, number?): boolean} set
-  * @property {function(string): void} del
-  * @property {function(): any[]} keys
-  * @property {function(): void} reset
-  */
+  /**
+   * @typedef {Object} CacheStore
+   * @property {function(string): any} get
+   * @property {function(string): any} peek
+   * @property {function(string, any, number?): boolean} set
+   * @property {function(string): void} del
+   * @property {function(): any[]} keys
+   * @property {function(): void} reset
+   */
   store,
 
   /**
@@ -408,7 +409,7 @@ const cache = {
 
   /**
    * Clear cache with uri parameters
-   * 
+   *
    * @param {ModelCacheConfig} cacheConf
    * @param {{ [key: string]: string; }=} params
    */
@@ -425,7 +426,7 @@ const cache = {
 
   /**
    * Get related ModelCacheConfig with an uid
-   * 
+   *
    * uid:
    * - application::sport.sport
    * - plugins::users-permissions.user
@@ -445,7 +446,7 @@ const cache = {
 
   /**
    * Get regexs to match all ModelCacheConfig keys with given params
-   * 
+   *
    * @param {ModelCacheConfig} cacheConf
    * @param {{ [key: string]: string; }=} params
    * @param {boolean=} wildcard

Diff for: lib/cache/index.js

@@ -1,6 +1,6 @@
 // @ts-check
 
-const mapValues = require("lodash/mapValues");
+const mapValues = require('lodash/mapValues');
 
 const rejectAfterTimeout = (ms) =>
   new Promise((_, reject) => setTimeout(reject, ms));
@@ -46,24 +46,25 @@ module.exports = (strapi, options, logger) => {
         return await store.reset();
       },
     },
-    (fn) => async (...args) => {
-      try {
-        if (!store.ready) {
-          logger.warn("the store is not ready");
+    (fn) =>
+      async (...args) => {
+        try {
+          if (!store.ready) {
+            logger.warn('the store is not ready');
+            return null;
+          }
+          return await Promise.race([
+            fn(...args),
+            rejectAfterTimeout(options.cacheTimeout),
+          ]);
+        } catch (e) {
+          if (e) {
+            logger.warn('there was an error with the store', e);
+          }
+          logger.warn('the cache request timed out');
+
           return null;
         }
-        return await Promise.race([
-          fn(...args),
-          rejectAfterTimeout(options.cacheTimeout),
-        ]);
-      } catch (e) {
-        if (e) {
-          logger.warn("there was an error with the store", e);
-        } 
-        logger.warn("the cache request timed out");
-        
-        return null;
       }
-    }
   );
 };

Diff for: lib/cache/stores/mem.js

@@ -1,6 +1,6 @@
 // @ts-check
 
-const LRU = require("lru-cache");
+const LRU = require('lru-cache');
 
 /**
  *

Diff for: lib/cache/stores/redis.js

@@ -1,7 +1,7 @@
 // @ts-check
 
-const Redis = require("ioredis");
-const lru = require("redis-lru");
+const Redis = require('ioredis');
+const lru = require('redis-lru');
 
 /**
  *
@@ -11,25 +11,25 @@ const lru = require("redis-lru");
  */
 module.exports = (strapi, options, logger) => {
   const prefix = (key) => `strapi-middleware-cache:${key}`;
-  const unprefix = (key) => key.replace(/^strapi-middleware-cache:/, "");
+  const unprefix = (key) => key.replace(/^strapi-middleware-cache:/, '');
 
   const client = new Redis(options.redisConfig);
   const cache = lru(client, options.max);
   let reconnected = false;
 
-  client.on("ready", () => {
-    logger.debug("redis connection established");
+  client.on('ready', () => {
+    logger.debug('redis connection established');
 
     if (reconnected) {
       cache.reset();
     }
   });
 
-  client.on("error", (error) => {
+  client.on('error', (error) => {
     logger.error(`redis connection failed`, error);
   });
 
-  client.on("reconnecting", (e) => {
+  client.on('reconnecting', (e) => {
     reconnected = true;
   });
 
@@ -54,7 +54,7 @@ module.exports = (strapi, options, logger) => {
       return cache.reset();
     },
     get ready() {
-      return client.status === "ready";
+      return client.status === 'ready';
     },
   };
 };