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

package/README.md

@@ -40,8 +40,6 @@ The plugin automatically detects your Fastify version and applies the correct co
 
 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.
 - `trustProxy`: Enable trust proxy option, [see Fastify documentation for possible values](https://fastify.dev/docs/latest/Reference/Server/#trustproxy)
 - `disableRequestLogging`: Turn off request logging, true by default
 
@@ -53,8 +51,6 @@ export default makeGasket({
     pluginFastify
   ],
   fastify: {
-    compression: false,
-    excludedRoutesRegex: /^(?!\/_next\/)/,
     trustProxy: true
   }
 });
@@ -82,8 +78,7 @@ export default {
 
 ### fastify
 
-Executed **after** the `middleware` event for when you need full control over
-the `fastify` instance.
+Used to add routes and middleware directly to the `fastify` instance.
 
 ```js
 export default {
@@ -94,7 +89,6 @@ export default {
     *
     * @param {Gasket} gasket The Gasket API
     * @param {Fastify} fastify Fastify app instance
-    * @returns {function|function[]} middleware(s)
     */
     fastify: async function (gasket, fastify) {
     }
@@ -104,20 +98,24 @@ export default {
 
 ### errorMiddleware
 
-Executed after the `fastify` event. All middleware functions returned from this
-hook will be applied to Fastify.
+Executed after the `fastify` event. All error handler functions returned from this
+hook will be applied to Fastify in order.
 
 ```js
 export default {
   name: 'sample-plugin',
   hooks: {
     /**
-    * Add Fastify error middlewares
+    * Add error handling for Fastify
     *
     * @param {Gasket} gasket The Gasket API
-    * @returns {function|function[]} error middleware(s)
+    * @returns {function|function[]} error handler(s)
     */
     errorMiddleware: function (gasket) {
+      return function (err, req, res, next) {
+        // handle error or pass to next handler
+        next(err);
+      };
     }
   }
 };

package/lib/create-servers.js

@@ -5,23 +5,33 @@ import { getAppInstance } from './utils.js';
 
 /**
  * Create the Fastify instance and setup the lifecycle hooks.
- * Fastify is compatible with express middleware out of the box, so we can
- * use the same middleware lifecycles.
  * @type {import('@gasket/core').HookHandler<'createServers'>}
  */
 export default async function createServers(gasket, serverOpts) {
-  /** Cast to Fastify + Express hybrid because Gasket adds `.use()` via @fastify/express plugin */
-  const app = /** @type {import('fastify').FastifyInstance & { use: Function }} */ (getAppInstance(gasket));
+  const app = getAppInstance(gasket);
 
   // allow consuming apps to directly append options to their server
   await gasket.exec('fastify', app);
 
   const postRenderingStacks = (await gasket.exec('errorMiddleware')).filter(Boolean);
-  postRenderingStacks.forEach((stack) => {
-    /** @type {import('connect').NextHandleFunction} */
-    const middleware = stack;
-    app.use(middleware);
-  });
+  if (postRenderingStacks.length) {
+    // Fastify only supports one setErrorHandler per scope, so all Express-style
+    // error handlers (err, req, res, next) are chained manually through a single
+    // handler. request.raw and reply.raw expose the underlying Node.js
+    // IncomingMessage and ServerResponse that Express-style handlers expect.
+    app.setErrorHandler((error, request, reply) => {
+      let index = 0;
+      const next = (err) => {
+        const current = err || error;
+        if (index < postRenderingStacks.length) {
+          postRenderingStacks[index++](current, request.raw, reply.raw, next);
+        } else if (!reply.sent) {
+          reply.send(current);
+        }
+      };
+      next(error);
+    });
+  }
 
   return {
     ...serverOpts,

package/lib/index.d.ts

@@ -2,8 +2,6 @@ import type { MaybeAsync, MaybeMultiple, Plugin } from '@gasket/core';
 import type { Logger } from '@gasket/plugin-logger';
 import type {
   FastifyInstance,
-  FastifyRequest,
-  FastifyReply,
   FastifyServerOptions,
   FastifyBaseLogger,
   FastifyTypeProviderDefault,
@@ -12,8 +10,6 @@ import type {
 import type { IncomingMessage, ServerResponse } from 'http';
 
 export interface FastifyConfig {
-  /** Enable compression */
-  compression?: boolean;
   /** Trust proxy configuration */
   trustProxy?: FastifyServerOptions['trustProxy'];
   /** Fastify request logging per route */
@@ -36,11 +32,11 @@ declare module '@gasket/core' {
   }
 
 
-  /** Error handler function type */
+  /** Error handler function type (Express-style, receives raw Node.js req/res) */
   type ErrorHandler = (
     error: Error,
-    req: FastifyRequest,
-    res: FastifyReply,
+    req: IncomingMessage,
+    res: ServerResponse,
     next: (error?: Error) => void
   ) => void;
 

package/lib/index.js

@@ -31,8 +31,7 @@ const plugin = {
             method: 'exec',
             description: 'Modify the Fastify instance to for adding endpoints',
             link: 'README.md#express',
-            parent: 'createServers',
-            after: 'middleware'
+            parent: 'createServers'
           },
           {
             name: 'errorMiddleware',
@@ -50,19 +49,6 @@ const plugin = {
             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": "8.0.0-next.2",
+  "version": "8.0.0-next.3",
   "description": "Adds fastify support to your application",
   "type": "module",
   "types": "./lib/index.d.ts",
@@ -16,7 +16,10 @@
     },
     "./package.json": "./package.json"
   },
-  "repository": "godaddy/gasket.git",
+  "repository": {
+    "type": "git",
+    "url": "godaddy/gasket.git"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -33,11 +36,11 @@
     "@types/connect": "^3.4.38",
     "fastify": "^5.0.0",
     "vitest": "^3.2.0",
-    "@gasket/core": "^8.0.0-next.1",
+    "@gasket/core": "^8.0.0-next.2",
     "@gasket/plugin-https": "^8.0.0-next.1",
     "@gasket/plugin-logger": "^8.0.0-next.1",
     "@gasket/plugin-metadata": "^8.0.0-next.1",
-    "create-gasket-app": "^8.0.0-next.1"
+    "create-gasket-app": "^8.0.0-next.2"
   },
   "peerDependencies": {
     "fastify": "^4.29.1 || ^5.0.0"