@gasket/plugin-fastify 8.0.0-next.1 → 8.0.0-next.2

package/README.md

@@ -24,6 +24,18 @@ export default makeGasket({
 });
 ```
 
+## Fastify Version Support
+
+This plugin supports both Fastify v4 and v5 through an internal adapter pattern. The appropriate version-specific adapter is automatically selected based on your installed Fastify version.
+
+### Fastify v4
+- **Installation**: `npm install fastify@^4`
+
+### Fastify v5
+- **Installation**: `npm install fastify@^5`
+
+The plugin automatically detects your Fastify version and applies the correct configuration. No manual configuration is required.
+
 ## Configuration
 
 All the configurations for the plugin are added under `fastify` in the config:

package/lib/adapters/adapter-factory.js

@@ -0,0 +1,46 @@
+import { createRequire } from 'module';
+import { FastifyV4Adapter } from './fastify-v4-adapter.js';
+import { FastifyV5Adapter } from './fastify-v5-adapter.js';
+
+const require = createRequire(import.meta.url);
+
+/**
+ * Detect the installed Fastify version.
+ * Reads the version from fastify/package.json in node_modules.
+ * This works reliably with npm, pnpm, yarn, and bun.
+ * @returns {string} - Version string (e.g., '5.2.1')
+ */
+export function detectFastifyVersion() {
+  try {
+    const fastifyModule = require('fastify/package.json');
+    return fastifyModule.version;
+  } catch (err) {
+    throw new Error(
+      'Could not detect Fastify version. Ensure fastify is installed.\n' +
+      `Error: ${err.message}`
+    );
+  }
+}
+
+/**
+ * Create the appropriate Fastify adapter based on the installed Fastify version.
+ * Automatically detects the version from fastify/package.json.
+ * @returns {import('./base-adapter.js').FastifyAdapter} - Adapter instance
+ */
+export function createFastifyAdapter() {
+  const version = detectFastifyVersion();
+  const majorVersion = parseInt(version.split('.')[0], 10);
+
+  switch (majorVersion) {
+    case 4:
+      return new FastifyV4Adapter();
+    case 5:
+      return new FastifyV5Adapter();
+    default:
+      throw new Error(
+        `Unsupported Fastify version: ${version}\n` +
+        'Gasket supports Fastify v4 and v5. Please upgrade or downgrade Fastify, ' +
+        'or open an issue at https://github.com/godaddy/gasket'
+      );
+  }
+}

package/lib/adapters/base-adapter.js

@@ -0,0 +1,30 @@
+/**
+ * Base abstract class for Fastify version adapters.
+ * Provides a common interface for creating and configuring Fastify instances
+ * across different major versions.
+ * @abstract
+ */
+export class FastifyAdapter {
+  constructor() {
+    if (new.target === FastifyAdapter) {
+      throw new Error('FastifyAdapter is an abstract class and cannot be instantiated directly');
+    }
+  }
+
+  /**
+   * Create a Fastify instance with version-specific configuration.
+   * Subclasses must implement this method to handle version-specific options.
+   * @abstract
+   * @param {object} config - Fastify configuration options
+   * @param {boolean} [config.trustProxy] - Trust proxy headers
+   * @param {object} [config.https] - HTTPS configuration
+   * @param {boolean} [config.http2] - Enable HTTP/2
+   * @param {boolean} [config.disableRequestLogging] - Disable request logging
+   * @param {object} logger - Gasket logger instance
+   * @returns {ReturnType<typeof import('fastify').default>} - Configured Fastify instance
+   */
+  // eslint-disable-next-line no-unused-vars
+  createInstance(config, logger) {
+    throw new Error('createInstance() must be implemented by subclass');
+  }
+}

package/lib/adapters/fastify-v4-adapter.js

@@ -0,0 +1,55 @@
+import fastify from 'fastify';
+import { FastifyAdapter } from './base-adapter.js';
+
+const fallbackMap = {
+  fatal: 'error',
+  trace: 'debug'
+};
+
+/**
+ * Adapter for Fastify v4.x
+ *
+ * Key differences from v5:
+ * - Uses 'logger' option (not 'loggerInstance')
+ * - No 'useSemicolonDelimiter' option
+ * - Supports Node.js v14+
+ */
+export class FastifyV4Adapter extends FastifyAdapter {
+  /**
+   * Align Gasket logger with Fastify v4 requirements.
+   * Ensures 'fatal' and 'trace' log levels exist.
+   * @param {object} logger - Gasket logger instance
+   * @returns {object} - Fastify-compatible logger
+   */
+  alignLogger(logger) {
+    const fastifyLogger = logger;
+    ['fatal', 'trace'].forEach(level => {
+      if (!logger[level]) {
+        fastifyLogger[level] = logger[fallbackMap[level]];
+      }
+    });
+    return fastifyLogger;
+  }
+
+  /**
+   * Create a Fastify v4 instance.
+   * @param {object} config - Fastify configuration
+   * @param {object} logger - Gasket logger
+   * @returns {ReturnType<typeof import('fastify').default>} - Configured Fastify v4 instance
+   */
+  createInstance(config, logger) {
+    const { trustProxy = false, disableRequestLogging = true, https, http2, ...restConfig } = config;
+
+    const fastifyLogger = this.alignLogger(logger);
+
+    // Fastify v4 uses 'logger' option
+    return fastify({
+      logger: fastifyLogger,
+      trustProxy,
+      disableRequestLogging,
+      https,
+      http2,
+      ...restConfig
+    });
+  }
+}

package/lib/adapters/fastify-v5-adapter.js

@@ -0,0 +1,67 @@
+import fastify from 'fastify';
+import { FastifyAdapter } from './base-adapter.js';
+
+const fallbackMap = {
+  fatal: 'error',
+  trace: 'debug'
+};
+
+/**
+ * Adapter for Fastify v5.x
+ *
+ * Key differences from v4:
+ * - Uses 'loggerInstance' option (not 'logger')
+ * - Adds 'useSemicolonDelimiter' option (defaults to true)
+ * - Requires Node.js v20+
+ * - Stricter JSON Schema validation
+ */
+export class FastifyV5Adapter extends FastifyAdapter {
+  /**
+   * Align Gasket logger with Fastify v5 requirements.
+   * Ensures 'fatal' and 'trace' log levels exist.
+   * @param {object} logger - Gasket logger instance
+   * @returns {object} - Fastify-compatible logger
+   */
+  alignLogger(logger) {
+    const fastifyLogger = logger;
+    ['fatal', 'trace'].forEach(level => {
+      if (!logger[level]) {
+        fastifyLogger[level] = logger[fallbackMap[level]];
+      }
+    });
+    return fastifyLogger;
+  }
+
+  /**
+   * Create a Fastify v5 instance.
+   * @param {object} config - Fastify configuration
+   * @param {object} logger - Gasket logger
+   * @returns {ReturnType<typeof import('fastify').default>} - Configured Fastify v5 instance
+   */
+  createInstance(config, logger) {
+    const {
+      trustProxy = false,
+      disableRequestLogging = true,
+      https,
+      http2,
+      useSemicolonDelimiter = true,
+      ...restConfig
+    } = config;
+
+    const fastifyLogger = this.alignLogger(logger);
+
+    // Fastify v5 uses 'loggerInstance' instead of 'logger'
+    // Router options are nested under 'routerOptions' to avoid deprecation warnings
+    return fastify({
+      loggerInstance: fastifyLogger,
+      trustProxy,
+      disableRequestLogging,
+      https,
+      http2,
+      routerOptions: {
+        useSemicolonDelimiter
+      },
+      ...restConfig
+    });
+  }
+}

package/lib/adapters/index.js

@@ -0,0 +1,4 @@
+export { FastifyAdapter } from './base-adapter.js';
+export { FastifyV4Adapter } from './fastify-v4-adapter.js';
+export { FastifyV5Adapter } from './fastify-v5-adapter.js';
+export { createFastifyAdapter, detectFastifyVersion } from './adapter-factory.js';

package/lib/utils.js

@@ -1,29 +1,9 @@
 // @ts-nocheck
 
-import fastify from 'fastify';
-
-const fallbackMap = {
-  fatal: 'error',
-  trace: 'debug'
-};
-
-/**
- * A helper function to ensure that all the required log levels
- * for a Fastify server are present.
- * @type {import('@gasket/plugin-fastify').alignLogger}
- */
-function alignLogger(logger) {
-  const fastifyLogger = logger;
-  ['fatal', 'trace'].map(level => {
-    if (!logger[level]) {
-      fastifyLogger[level] = logger[fallbackMap[level]];
-    }
-  });
-
-  return fastifyLogger;
-}
+import { createFastifyAdapter } from './adapters/index.js';
 
 let instance = null;
+let adapter = null;
 
 /**
  * Get the Fastify instance.
@@ -33,21 +13,29 @@ let instance = null;
 export function getAppInstance(gasket) {
   if (!instance) {
     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 });
+    // Create the appropriate adapter for the installed Fastify version
+    adapter = createFastifyAdapter();
+
+    // Use the adapter to create the Fastify instance
+    instance = adapter.createInstance(
+      {
+        ...fastifyConfig,
+        https,
+        http2
+      },
+      gasket.logger
+    );
   }
 
   return instance;
 }
 
-export { alignLogger };
-
 /**
  * Clear the Fastify app instance (for testing only)
  * @returns {void}
  */
 export function testClearAppInstance() {
   instance = null;
+  adapter = null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasket/plugin-fastify",
-  "version": "8.0.0-next.1",
+  "version": "8.0.0-next.2",
   "description": "Adds fastify support to your application",
   "type": "module",
   "types": "./lib/index.d.ts",
@@ -29,13 +29,9 @@
   "license": "MIT",
   "bugs": "https://github.com/godaddy/gasket/issues",
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-plugin-fastify",
-  "dependencies": {
-    "@fastify/express": "^3.0.0",
-    "fastify": "^4.29.1"
-  },
   "devDependencies": {
     "@types/connect": "^3.4.38",
-    "fastify": "^4.29.1",
+    "fastify": "^5.0.0",
     "vitest": "^3.2.0",
     "@gasket/core": "^8.0.0-next.1",
     "@gasket/plugin-https": "^8.0.0-next.1",
@@ -44,7 +40,7 @@
     "create-gasket-app": "^8.0.0-next.1"
   },
   "peerDependencies": {
-    "fastify": "^4.29.1"
+    "fastify": "^4.29.1 || ^5.0.0"
   },
   "scripts": {
     "lint": "eslint .",