@gasket/plugin-fastify 7.3.4 → 7.3.5

package/README.md

@@ -42,7 +42,6 @@ export default makeGasket({
   ],
   fastify: {
     compression: false,
-    routes: 'api/*.js',
     excludedRoutesRegex: /^(?!\/_next\/)/,
     trustProxy: true
   }

package/lib/actions.js

@@ -0,0 +1,17 @@
+const { getAppInstance } = require('./utils.js');
+
+const actions = {
+  /**
+   * @deprecated
+   * @param {import('@gasket/core').Gasket} gasket - Gasket instance
+   * @returns {import('fastify').FastifyInstance} - Fastify instance
+   */
+  getFastifyApp(gasket) {
+    gasket.logger.warn(
+      `DEPRECATED \`getFastifyApp\` action will not be support in future major release.`
+    );
+    return getAppInstance(gasket);
+  }
+};
+
+module.exports = actions;

package/lib/create-servers.js

@@ -1,6 +1,7 @@
 /// <reference types="@gasket/plugin-https" />
 /// <reference types="@gasket/plugin-logger" />
 
+const { getAppInstance } = require('./utils.js');
 /**
  * Create the Fastify instance and setup the lifecycle hooks.
  * Fastify is compatible with express middleware out of the box, so we can
@@ -9,14 +10,7 @@
  */
 // eslint-disable-next-line max-statements
 module.exports = async function createServers(gasket, serverOpts) {
-  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 });
+  const app = getAppInstance(gasket);
 
   // allow consuming apps to directly append options to their server
   // @ts-ignore

package/lib/create.js

@@ -3,14 +3,7 @@
 
 const { name, version, devDependencies } = require('../package.json');
 
-/**
- * createTestFiles
- * @property {Files} files - The Gasket Files API.
- * @property {generatorDir} - The directory of the generator.
- * @property {testPlugins} - Array of selected test plugins
- * @property {globIgnore} - Extension pattern to ignore
- */
-function createTestFiles({ files, generatorDir, testPlugins, globIgnore }) {
+const createTestFiles = ({ files, generatorDir, testPlugins, globIgnore }) => {
   if (!testPlugins || testPlugins.length === 0) return;
   const unit = ['jest', 'mocha'];
   const integration = ['cypress'];
@@ -28,7 +21,7 @@ function createTestFiles({ files, generatorDir, testPlugins, globIgnore }) {
       }
     }
   });
-}
+};
 
 /**
  * Add files & extend package.json for new apps.

package/lib/index.js

@@ -1,36 +1,17 @@
 /// <reference types="@gasket/core" />
 /// <reference types="@gasket/plugin-metadata" />
 
-const {
-  name,
-  version,
-  description
-} = require('../package.json');
+const { name, version, description } = require('../package.json');
 const create = require('./create');
 const createServers = require('./create-servers');
-const fastify = require('fastify');
-const { alignLogger } = require('./utils');
-
-let app;
+const actions = require('./actions');
 
 /** @type {import('@gasket/core').Plugin} */
 const plugin = {
   name,
   version,
   description,
-  actions: {
-    /** @deprecated */
-    getFastifyApp(gasket) {
-      const { fastify: fastifyConfig = {}, http2, https } = gasket.config;
-      const { trustProxy = false, disableRequestLogging = true } = fastifyConfig;
-      const fastifyLogger = alignLogger(gasket.logger);
-
-      // @ts-ignore
-      app ??= fastify({ logger: fastifyLogger, trustProxy, https, http2, disableRequestLogging });
-
-      return app;
-    }
-  },
+  actions,
   hooks: {
     create,
     createServers,

package/lib/utils.js

@@ -1,5 +1,5 @@
 // @ts-nocheck
-/* eslint-disable no-console */
+
 const fallbackMap = {
   fatal: 'error',
   trace: 'debug'
@@ -21,6 +21,30 @@ function alignLogger(logger) {
   return fastifyLogger;
 }
 
+let instance = null;
+
+/**
+ * Get the Fastify instance.
+ * @param {import('@gasket/core').Gasket} gasket - Gasket instance
+ * @returns {import('fastify').FastifyInstance} - Fastify instance
+ */
+function getAppInstance(gasket) {
+  if (!instance) {
+    const fastify = require('fastify');
+    const { fastify: fastifyConfig = {}, http2, https } = gasket.config;
+    const { trustProxy = false, disableRequestLogging = true } = fastifyConfig;
+    const fastifyLogger = alignLogger(gasket.logger);
+
+    instance = fastify({ logger: fastifyLogger, trustProxy, https, http2, disableRequestLogging });
+  }
+
+  return instance;
+}
+
 module.exports = {
-  alignLogger
+  alignLogger,
+  getAppInstance,
+  testClearAppInstance: () => {
+    instance = null;
+  }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasket/plugin-fastify",
-  "version": "7.3.4",
+  "version": "7.3.5",
   "description": "Adds fastify support to your application",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -36,11 +36,11 @@
     "fastify": "^4.29.0",
     "jest": "^29.7.0",
     "typescript": "^5.7.3",
-    "@gasket/core": "7.3.3",
+    "@gasket/core": "7.4.0",
     "@gasket/plugin-https": "7.3.4",
     "@gasket/plugin-logger": "7.3.3",
-    "@gasket/plugin-metadata": "7.3.5",
-    "create-gasket-app": "7.3.4"
+    "@gasket/plugin-metadata": "7.3.6",
+    "create-gasket-app": "7.3.5"
   },
   "peerDependencies": {
     "fastify": "^4.29.0"
@@ -69,6 +69,14 @@
         "rules": {
           "jsdoc/*": "off"
         }
+      },
+      {
+        "files": [
+          "test/**/*.js"
+        ],
+        "rules": {
+          "jsdoc/require-jsdoc": "off"
+        }
       }
     ]
   },