@gasket/plugin-fastify 7.1.0 → 7.1.4

package/README.md

@@ -49,18 +49,24 @@ export default makeGasket({
 });
 ```
 
-## Actions
+### Route Definition
 
-### getFastifyApp
-
-Get the Fastify app instance.
+Routes can be defined in a in-app plugin in the `plugins` directory. The plugin will hook the `fastify` lifecycle to add the routes to the fastify app.
 
 ```js
-const app = actions.gasket.getFastifyApp();
+// plugins/routes-plugin.js
+export default {
+  name: 'routes-plugin',
+  hooks: {
+    fastify: async function (gasket, app) {
+      app.get('/hello', (req, res) => {
+        res.send('Hello World!');
+      });
+    }
+  }
+};
 ```
 
-Each Gasket creates a single shared Fastify instance, ensuring consistent access to the same app instance wherever it's needed.
-
 ## Lifecycles
 
 ### fastify

package/generator/app/plugins/README.md

@@ -0,0 +1,11 @@
+# Local Plugins
+
+### Routes plugin
+
+A local plugin is used to define Fastify routes. The plugin hooks the `fastify` lifecycle and mutates the Fastify app.
+
+The following routes are available:
+
+```javascript
+GET /default
+```

package/generator/app/plugins/routes-plugin.js

@@ -0,0 +1,30 @@
+export const defaultHandler = async (req, res) => {
+  if (res.statusCode === 200) {
+    res.send({ message: 'Welcome to your default route...' });
+  }
+};
+
+export default {
+  name: 'routes-plugin',
+  hooks: {
+    fastify(gasket, app) {
+      {{#if useSwagger }}
+      /**
+      * @swagger
+      *
+      * /default:
+      *   get:
+      *     summary: "Get default route"
+      *     produces:
+      *       - "application/json"
+      *     responses:
+      *       "200":
+      *         description: "Returns welcome message."
+      *         content:
+      *           application/json
+      */
+      {{/if }}
+      app.get('/default', defaultHandler);
+    }
+  }
+}

package/generator/app/plugins/routes-plugin.ts

@@ -0,0 +1,29 @@
+export const defaultHandler = async (req, res) => {
+  if (res.statusCode === 200) {
+    res.send({ message: 'Welcome to your default route...' });
+  }
+};
+export default {
+  name: 'routes-plugin',
+  hooks: {
+    fastify(gasket, app) {
+      {{#if useSwagger }}
+      /**
+      * @swagger
+      *
+      * /default:
+      *   get:
+      *     summary: "Get default route"
+      *     produces:
+      *       - "application/json"
+      *     responses:
+      *       "200":
+      *         description: "Returns welcome message."
+      *         content:
+      *           application/json
+      */
+      {{/if }}
+      app.get('/default', defaultHandler);
+    }
+  }
+}

package/generator/jest/test/index.test.js

@@ -1,5 +1,5 @@
 import { jest } from '@jest/globals';
-import { defaultHandler } from '../routes';
+import { defaultHandler } from '../plugins/routes-plugin.js';
 
 describe('Routes', () => {
   let mockRequest, mockResponse;

package/generator/jest/test/index.test.ts

@@ -5,7 +5,7 @@ import {
   it,
   expect
 } from '@jest/globals';
-import { defaultHandler } from '../routes';
+import { defaultHandler } from '../plugins/routes-plugin.js';
 
 describe('Routes', () => {
   let mockRequest, mockResponse;

package/generator/mocha/test/index.test.js

@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 import sinon from 'sinon';
-import { defaultHandler } from '../routes/index.js';
+import { defaultHandler } from '../plugins/routes-plugin.js';
 
 describe('Routes', () => {
   let mockRequest, mockResponse, sendSpy;

package/generator/mocha/test/index.test.ts

@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 import sinon from 'sinon';
-import { defaultHandler } from '../routes/index.js';
+import { defaultHandler } from '../plugins/routes-plugin.js';
 
 describe('Routes', () => {
   let mockRequest, mockResponse, sendSpy;

package/lib/create-servers.js

@@ -9,8 +9,17 @@
  */
 // eslint-disable-next-line max-statements
 module.exports = async function createServers(gasket, serverOpts) {
-  const app = gasket.actions.getFastifyApp();
+  const fastify = require('fastify');
+  const { alignLogger } = require('./utils');
+  const { fastify: fastifyConfig = {}, http2, https } = gasket.config;
+  const { trustProxy = false, disableRequestLogging = true } = fastifyConfig;
+  const fastifyLogger = alignLogger(gasket.logger);
+
+  // @ts-ignore
+  const app = fastify({ logger: fastifyLogger, trustProxy, https, http2, disableRequestLogging });
+
   // allow consuming apps to directly append options to their server
+  // @ts-ignore
   await gasket.exec('fastify', app);
 
   const postRenderingStacks = (await gasket.exec('errorMiddleware')).filter(Boolean);

package/lib/create.js

@@ -55,6 +55,7 @@ module.exports = async function create(gasket, context) {
   if (apiApp && addApiRoutes) {
     const globIgnore = typescript ? '!(*.js)' : '!(*.ts)';
     files.add(`${generatorDir}/app/**/${globIgnore}`);
+    gasketConfig.addPlugin('pluginRoutes', './plugins/routes-plugin.js');
 
     createTestFiles({ files, generatorDir, testPlugins, globIgnore });
   }

package/lib/index.d.ts

@@ -15,6 +15,7 @@ export type AppRoutes = Array<MaybeAsync<(app: FastifyInstance) => void>>;
 
 declare module '@gasket/core' {
   export interface GasketActions {
+    /** @deprecated */
     getFastifyApp(): FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>;
   }
 

package/lib/index.js

@@ -19,6 +19,7 @@ const plugin = {
   version,
   description,
   actions: {
+    /** @deprecated */
     getFastifyApp(gasket) {
       const { fastify: fastifyConfig = {}, http2, https } = gasket.config;
       const { trustProxy = false, disableRequestLogging = true } = fastifyConfig;
@@ -40,7 +41,8 @@ const plugin = {
           {
             name: 'getFastifyApp',
             description: 'Get the Fastify app instance',
-            link: 'README.md#getFastifyApp'
+            link: 'README.md#getFastifyApp',
+            deprecated: true
           }
         ],
         lifecycles: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasket/plugin-fastify",
-  "version": "7.1.0",
+  "version": "7.1.4",
   "description": "Adds fastify support to your application",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -40,7 +40,7 @@
     "fastify": "^4.28.1"
   },
   "devDependencies": {
-    "@gasket/core": "^7.1.0",
+    "@gasket/core": "^7.1.4",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
     "eslint-config-godaddy": "^7.1.1",
@@ -74,5 +74,5 @@
   "jest": {
     "rootDir": "test"
   },
-  "gitHead": "eb663b93543699ad6c1019c120c44b76d86d90ec"
+  "gitHead": "7d77c8fbff84ea9ae18b0f6b265f25bbbc25135e"
 }

package/generator/app/routes/index.js

@@ -1,28 +0,0 @@
-import gasket from '../gasket.js';
-
-const app = gasket.actions.getFastifyApp();
-
-export const defaultHandler = async (req, res) => {
-  if (res.statusCode === 200) {
-    res.send({ message: 'Welcome to your default route...' });
-  }
-};
-
-{{#if useSwagger}}
-/**
-* @swagger
-*
-* /default:
-*   get:
-*     summary: "Get default route"
-*     produces:
-*       - "application/json"
-*     responses:
-*       "200":
-*         description: "Returns welcome message."
-*         content:
-*           application/json
-*/
-{{/if}}
-app.get('/default',  defaultHandler);
-

package/generator/app/routes/index.ts

@@ -1,29 +0,0 @@
-import type { FastifyRequest, FastifyReply } from 'fastify';
-import gasket from '../gasket.js';
-
-const app = gasket.actions.getFastifyApp();
-
-export const defaultHandler = async (req: FastifyRequest, res: FastifyReply) => {
-  if (res.statusCode === 200) {
-    res.send({ message: 'Welcome to your default route...' });
-  }
-};
-
-{{#if useSwagger}}
-/**
-* @swagger
-*
-* /default:
-*   get:
-*     summary: "Get default route"
-*     produces:
-*       - "application/json"
-*     responses:
-*       "200":
-*         description: "Returns welcome message."
-*         content:
-*           application/json
-*/
-{{/if}}
-app.get('/default', defaultHandler);
-