@gasket/plugin-fastify 6.24.2 → 6.33.0

package/README.md

@@ -32,9 +32,9 @@ module.exports = {
 
 All the configurations for the plugin are added under `fastify` in the config:
 
-- `compression`: true by default. Can to set to false if applying compression
+- `compression`: true by default. Can be set to false if applying compression
   differently.
-- `excludedRoutesRegex`: Regex of the routes to exclude by Fastify.
+- `excludedRoutesRegex`: Routes to be excluded based on a regex
 
 #### Example configuration
 
@@ -50,6 +50,26 @@ module.exports = {
 }
 ```
 
+### middleware
+
+You can configure which paths middleware will run on by adding the middleware configuration array to your local `gasket.config.js`. The array is made up of objects with the name of the middlware (Gasket plugin name) you want to configure and an array of path patterns representing the paths to match for this middleware. Pattern matching entries in the array can come in the form of path strings and/or regular expressions.
+```js
+  middleware: [
+    {
+      plugin:'gasket-plugin-example', // Name of the Gasket plugin
+      paths: ['/api']
+    },
+    {
+      plugin:'@some/gasket-plugin-example',
+      paths: [/\/default/]
+    },
+    {
+      plugin: '@another/gasket-plugin-example'
+      paths: ['/proxy', /\/home/]
+    }
+  ]
+```
+
 ## Lifecycles
 
 ### middleware

package/lib/index.js

@@ -35,6 +35,7 @@ module.exports = {
       const compression = require('compression');
 
       const { logger, config } = gasket;
+      const { middleware: middlewareConfig } = config;
       const excludedRoutesRegex = config.fastify && config.fastify.excludedRoutesRegex;
       const app = fastify({ logger });
 
@@ -58,11 +59,30 @@ module.exports = {
         app.use(compression());
       }
 
-      const middlewares = (await gasket.exec('middleware', app)).filter(Boolean);
+      const middlewares = [];
+      await gasket.execApply('middleware', async (plugin, handler) => {
+        const middleware = handler(app);
+        if (middleware) {
+          if (middlewareConfig) {
+            const pluginName = plugin && plugin.name ? plugin.name : '';
+            const mwConfig = middlewareConfig.find(mw => mw.plugin === pluginName);
+            if (mwConfig) {
+              middleware.paths = mwConfig.paths;
+              if (excludedRoutesRegex) {
+                middleware.paths.push(excludedRoutesRegex);
+              }
+            }
+          }
+          middlewares.push(middleware);
+        }
+      });
 
       debug('applied %s middleware layers to fastify', middlewares.length);
       middlewares.forEach(layer => {
-        if (excludedRoutesRegex) {
+        const { paths } = layer;
+        if (paths) {
+          app.use(paths, layer);
+        } else if (excludedRoutesRegex) {
           app.use(excludedRoutesRegex, layer);
         } else {
           app.use(layer);
@@ -106,6 +126,23 @@ module.exports = {
           link: 'README.md#errorMiddleware',
           parent: 'createServers',
           after: 'express'
+        }],
+        configurations: [{
+          name: 'fastify',
+          link: 'README.md#configuration',
+          description: 'Fastify configuration object',
+          type: 'object'
+        }, {
+          name: 'fastify.compression',
+          link: 'README.md#configuration',
+          description: 'Automatic compression',
+          type: 'boolean',
+          default: true
+        }, {
+          name: 'fastify.excludedRoutesRegex',
+          link: 'README.md#configuration',
+          description: 'Routes to be excluded based on a regex',
+          type: 'RegExp'
         }]
       };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasket/plugin-fastify",
-  "version": "6.24.2",
+  "version": "6.33.0",
   "description": "Adds fastify support to your application",
   "main": "lib",
   "types": "lib/index.d.ts",
@@ -45,7 +45,7 @@
     "middie": "5.1.0"
   },
   "devDependencies": {
-    "@gasket/engine": "^6.24.2",
+    "@gasket/engine": "^6.26.1",
     "assume": "^2.3.0",
     "assume-sinon": "^1.1.0",
     "eslint": "^8.7.0",
@@ -73,5 +73,5 @@
       "unicorn/filename-case": "error"
     }
   },
-  "gitHead": "f9a5d895f1bafefe2c4f4eb0375afce9460931cf"
+  "gitHead": "e19fab235461a16577f27ad30062b754233e05c9"
 }