@gasket/plugin-fastify 7.0.0-next.34 → 7.0.0-next.38

package/README.md

@@ -34,7 +34,6 @@ All the configurations for the plugin are added under `fastify` in the config:
 
 - `compression`: true by default. Can be set to false if applying compression
   differently.
-- `excludedRoutesRegex`: Routes to be excluded based on a regex
 - `trustProxy`: Enable trust proxy option, [see Fastify documentation for possible values](https://fastify.dev/docs/latest/Reference/Server/#trustproxy)
 
 #### Example configuration
@@ -46,61 +45,15 @@ module.exports = {
   },
   fastify: {
     compression: false,
+    routes: 'api/*.js',
     excludedRoutesRegex: /^(?!\/_next\/)/,
     trustProxy: true
   }
 }
 ```
 
-### Middleware paths
-
-The `gasket.config.js` can contain a `middleware` property, which is an array of
-objects that map plugins to route or path patterns, allowing apps to tune which
-middleware are triggered for which requests.
-
-```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
-
-Executed when the `fastify` server has been created, it will apply all returned
-functions as middleware.
-
-```js
-module.exports = {
-  hooks: {
-    /**
-    * Add Fastify middleware
-    *
-    * @param {Gasket} gasket The Gasket API
-    * @param {Fastify} app - Fastify app instance
-    * @returns {function|function[]} middleware(s)
-    */
-    middleware: function (gasket, app) {
-      return require('x-xss-protection')();
-    }
-  }
-}
-```
-
-You may also return an `Array` to inject more than one middleware.
-
 ### fastify
 
 Executed **after** the `middleware` event for when you need full control over

package/lib/create-servers.js

@@ -1,12 +1,6 @@
 /// <reference types="@gasket/plugin-https" />
 /// <reference types="@gasket/plugin-logger" />
 
-const fastify = require('fastify');
-const middie = require('middie');
-const cookieParser = require('cookie-parser');
-const compression = require('compression');
-const debug = require('diagnostics')('gasket:fastify');
-
 /**
  * Create the Fastify instance and setup the lifecycle hooks.
  * Fastify is compatible with express middleware out of the box, so we can
@@ -15,73 +9,32 @@ const debug = require('diagnostics')('gasket:fastify');
  */
 // eslint-disable-next-line max-statements
 module.exports = async function createServers(gasket, serverOpts) {
-  const { logger, config } = gasket;
-  const { middleware: middlewareConfig } = config;
-  const trustProxy = config.fastify?.trustProxy ?? false;
-  const excludedRoutesRegex =
-    config.fastify && config.fastify.excludedRoutesRegex;
-  // @ts-ignore
-  const app = fastify({ logger, trustProxy });
-
-  // Enable middleware for fastify@3
-  await app.register(middie);
-
-  // Add express-like `res.locals` object attaching data
-  app.use(function attachLocals(req, res, next) {
-    res.locals = {};
-    next();
-  });
+  const fastify = require('fastify');
+  const { config, logger } = gasket;
+  const {
+    fastify: {
+      routes,
+      trustProxy = false
+    } = {},
+    http2
+  } = config;
 
-  if (excludedRoutesRegex) {
-    app.use(excludedRoutesRegex, cookieParser());
-  } else {
-    app.use(cookieParser());
-  }
-
-  const { compression: compressionConfig = true } = config.fastify || {};
-  if (compressionConfig) {
-    app.use(compression());
-  }
+  // @ts-ignore
+  const app = fastify({ logger, trustProxy, http2 });
 
-  const middlewares = [];
+  // allow consuming apps to directly append options to their server
+  await gasket.exec('fastify', app);
 
-  await gasket.execApply('middleware', async (plugin, handler) => {
-    const middleware = await 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);
-          }
-        }
+  if (routes) {
+    for (const route of routes) {
+      if (typeof route !== 'function') {
+        throw new Error('Route must be a function');
       }
-      middlewares.push(middleware);
-    }
-  });
-
-  debug('applied %s middleware layers to fastify', middlewares.length);
-  middlewares.forEach((layer) => {
-    const { paths } = layer;
-    if (paths) {
-      app.use(paths, layer);
-    } else if (excludedRoutesRegex) {
-      app.use(excludedRoutesRegex, layer);
-    } else {
-      app.use(layer);
+      await route(app);
     }
-  });
-
-  // allow consuming apps to directly append options to their server
-  await gasket.exec('fastify', app);
+  }
 
-  const postRenderingStacks = (await gasket.exec('errorMiddleware')).filter(
-    Boolean
-  );
+  const postRenderingStacks = (await gasket.exec('errorMiddleware')).filter(Boolean);
   postRenderingStacks.forEach((stack) => app.use(stack));
 
   return {

package/lib/create.js

@@ -0,0 +1,34 @@
+/// <reference types="@gasket/core" />
+
+const { name, version, devDependencies } = require('../package.json');
+
+/**
+ * Add files & extend package.json for new apps.
+ * @type {import('@gasket/core').HookHandler<'create'>}
+ */
+module.exports = async function create(gasket, context) {
+  const generatorDir = `${__dirname}/../generator`;
+
+  context.gasketConfig.addPlugin('pluginFastify', name);
+
+  context.pkg.add('dependencies', {
+    [name]: `^${version}`,
+    fastify: devDependencies.fastify
+  });
+
+  if ('apiApp' in context && context.apiApp) {
+    context.gasketConfig.add('fastify', {
+      routes: []
+    });
+
+    if ('typescript' in context && context.typescript) {
+      context.files.add(`${generatorDir}/**/!(*.js)`);
+    } else {
+      context.files.add(`${generatorDir}/**/!(*.ts)`);
+    }
+
+    context.gasketConfig
+      .addImport('{ routes }', './routes/index.js')
+      .injectValue('fastify.routes', 'routes');
+  }
+};

package/lib/index.d.ts

@@ -1,22 +1,26 @@
 import type { MaybeAsync, MaybeMultiple } from '@gasket/core';
 import type {
-  Fastify,
+  FastifyInstance,
   FastifyRequest,
   FastifyReply,
   FastifyServerOptions
 } from 'fastify';
 
+export type AppRoutes = Array<MaybeAsync<(app: FastifyInstance) => void>>;
+
 declare module '@gasket/core' {
   export interface GasketConfig {
     fastify?: {
       /** Enable compression */
       compression?: boolean;
-      /** Regular expression for excluded routes */
+      /** Filter for which request URLs invoke Gasket middleware */
+      middlewareInclusionRegex?: RegExp;
+      /** @deprecated */
       excludedRoutesRegex?: RegExp;
       /** Trust proxy configuration */
       trustProxy?: FastifyServerOptions['trustProxy'];
       /** Glob pattern for source files setting up fastify routes */
-      routes?: string;
+      routes?: Array<MaybeAsync<(app: FastifyInstance) => void>>;
     };
     /** Middleware configuration */
     middleware?: {
@@ -45,7 +49,7 @@ declare module '@gasket/core' {
     middleware(
       fastify: Fastify
     ): MaybeAsync<MaybeMultiple<Handler> & { paths?: (string | RegExp)[] }>;
-    fastify(fastify: Fastify): MaybeAsync<void>;
+    fastify(fastify: FastifyInstance): MaybeAsync<void>;
     errorMiddleware(): MaybeAsync<MaybeMultiple<ErrorHandler>>;
   }
 }
@@ -59,5 +63,7 @@ declare module 'create-gasket-app' {
 
 export default {
   name: '@gasket/plugin-fastify',
+  version: '',
+  description: '',
   hooks: {}
 };

package/lib/index.js

@@ -1,28 +1,21 @@
 /// <reference types="@gasket/core" />
 /// <reference types="@gasket/plugin-metadata" />
 
-const { peerDependencies, name } = require('../package.json');
+const {
+  name,
+  version,
+  description
+} = require('../package.json');
+const create = require('./create');
 const createServers = require('./create-servers');
 
 /** @type {import('@gasket/core').Plugin} */
 const plugin = {
   name,
+  version,
+  description,
   hooks: {
-    create: async function create(gasket, context) {
-      const generatorDir = `${__dirname}/../generator`;
-
-      context.pkg.add('dependencies', {
-        fastify: peerDependencies.fastify
-      });
-
-      if ('apiApp' in context && context.apiApp) {
-        context.files.add(`${generatorDir}/**/*`);
-
-        context.gasketConfig.add('fastify', {
-          routes: './routes/*'
-        });
-      }
-    },
+    create,
     createServers,
     metadata(gasket, meta) {
       return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasket/plugin-fastify",
-  "version": "7.0.0-next.34",
+  "version": "7.0.0-next.38",
   "description": "Adds fastify support to your application",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -38,14 +38,8 @@
     "url": "https://github.com/godaddy/gasket/issues"
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-plugin-fastify",
-  "dependencies": {
-    "compression": "^1.7.4",
-    "cookie-parser": "^1.4.6",
-    "diagnostics": "^2.0.2",
-    "middie": "^5.4.0"
-  },
   "devDependencies": {
-    "@gasket/core": "^7.0.0-next.34",
+    "@gasket/core": "^7.0.0-next.38",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
     "eslint-config-godaddy": "^7.1.0",
@@ -76,5 +70,5 @@
   "eslintIgnore": [
     "generator"
   ],
-  "gitHead": "219ddcd68d2d6efd13a8324da31a7dc51cf2b78a"
+  "gitHead": "ba4f49da6e6b7cbbdf4949194ece663caeef5ef5"
 }