feat(fastify): add fastify route constraints

package.json

@@ -131,7 +131,7 @@
     "eslint-plugin-import": "2.29.0",
     "eventsource": "2.0.2",
     "fancy-log": "2.0.0",
-    "fastify": "4.24.3",
+    "fastify": "4.25.0",
     "graphql": "16.8.1",
     "graphql-tools": "9.0.0",
     "gulp": "4.0.2",

packages/platform-fastify/adapters/fastify-adapter.ts

@@ -52,7 +52,10 @@ import {
   FastifyStaticOptions,
   FastifyViewOptions,
 } from '../interfaces/external';
-import { FASTIFY_ROUTE_CONFIG_METADATA } from '../constants';
+import {
+  FASTIFY_ROUTE_CONFIG_METADATA,
+  FASTIFY_ROUTE_CONSTRAINTS_METADATA,
+} from '../constants';
 
 type FastifyHttp2SecureOptions<
   Server extends http2.Http2SecureServer,
@@ -659,17 +662,27 @@ export class FastifyAdapter<
       FASTIFY_ROUTE_CONFIG_METADATA,
       handlerRef,
     );
+
+    const routeConstraints = Reflect.getMetadata(
+      FASTIFY_ROUTE_CONSTRAINTS_METADATA,
+      handlerRef,
+    );
+
     const hasConfig = !isUndefined(routeConfig);
+    const hasConstraints = !isUndefined(routeConstraints);
 
-    if (isVersioned || hasConfig) {
+    if (isVersioned || hasConstraints || hasConfig) {
       const isPathAndRouteTuple = args.length === 2;
       if (isPathAndRouteTuple) {
-        const options = {
+        const constraints = {
+          ...(hasConstraints && routeConstraints),
           ...(isVersioned && {
-            constraints: {
-              version: handlerRef.version,
-            },
+            version: handlerRef.version,
           }),
+        };
+
+        const options = {
+          constraints,
           ...(hasConfig && {
             config: {
               ...routeConfig,
@@ -680,6 +693,7 @@ export class FastifyAdapter<
         return this.instance[routerMethodKey](path, options, handlerRef);
       }
     }
+
     return this.instance[routerMethodKey](
       ...(args as Parameters<
         RouteShorthandMethod<TServer, TRawRequest, TRawResponse>

packages/platform-fastify/constants.ts

@@ -1 +1,3 @@
 export const FASTIFY_ROUTE_CONFIG_METADATA = '__fastify_route_config__';
+export const FASTIFY_ROUTE_CONSTRAINTS_METADATA =
+  '__fastify_route_constraints__';

packages/platform-fastify/decorators/index.ts

@@ -1 +1,2 @@
 export * from './route-config.decorator';
+export * from './route-constraints.decorator';

packages/platform-fastify/decorators/route-constraints.decorator.ts

@@ -0,0 +1,11 @@
+import { SetMetadata } from '@nestjs/common';
+import { FASTIFY_ROUTE_CONSTRAINTS_METADATA } from '../constants';
+import { RouteShorthandOptions } from 'fastify';
+
+/**
+ * @publicApi
+ *
+ * @param config See {@link https://fastify.dev/docs/latest/Reference/Routes/#constraints}
+ */
+export const RouteConstraints = (config: RouteShorthandOptions['config']) =>
+  SetMetadata(FASTIFY_ROUTE_CONSTRAINTS_METADATA, config);

packages/platform-fastify/package.json

@@ -21,7 +21,7 @@
     "@fastify/cors": "8.4.2",
     "@fastify/formbody": "7.4.0",
     "@fastify/middie": "8.3.0",
-    "fastify": "4.24.3",
+    "fastify": "4.25.0",
     "light-my-request": "5.11.0",
     "path-to-regexp": "3.2.0",
     "tslib": "2.6.2"

packages/platform-fastify/test/decorators/router-constraints.decorator.spec.ts

@@ -0,0 +1,39 @@
+import { expect } from 'chai';
+import { FASTIFY_ROUTE_CONSTRAINTS_METADATA } from '../../constants';
+import { RouteConstraints } from '../../decorators/route-constraints.decorator';
+
+describe('@RouteConstraints', () => {
+  describe('has version constraints', () => {
+    const routeConstraints = { version: '1.2.x' };
+    class TestVersionConstraints {
+      config;
+      @RouteConstraints(routeConstraints)
+      public static test() {}
+    }
+
+    it('should have a version constraint', () => {
+      const path = Reflect.getMetadata(
+        FASTIFY_ROUTE_CONSTRAINTS_METADATA,
+        TestVersionConstraints.test,
+      );
+      expect(path).to.be.eql(routeConstraints);
+    });
+  });
+
+  describe('has custom constraints', () => {
+    const customRouteConstraints = { something: 'foo' };
+    class TestConstraints {
+      config;
+      @RouteConstraints(customRouteConstraints)
+      public static test() {}
+    }
+
+    it('should set a custom constraint', () => {
+      const path = Reflect.getMetadata(
+        FASTIFY_ROUTE_CONSTRAINTS_METADATA,
+        TestConstraints.test,
+      );
+      expect(path).to.be.eql(customRouteConstraints);
+    });
+  });
+});