@uphold/fastify-openapi-router-plugin 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uphold/fastify-openapi-router-plugin",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A plugin for Fastify to connect routes with a OpenAPI 3.x specification",
   "main": "./src/index.js",
   "types": "./types/index.d.ts",

package/src/index.test.js

@@ -164,4 +164,58 @@ describe('Fastify plugin', () => {
       );
     });
   });
+
+  describe('encapsulation', () => {
+    it('should use the correct fastify instance when calling oas.route() from a child plugin', async () => {
+      const app = fastify({ logger: false });
+
+      await app.register(OpenAPIRouter, { spec });
+
+      await app.register(async childFastify => {
+        childFastify.decorateRequest('customProperty', null);
+        childFastify.addHook('onRequest', async request => {
+          request.customProperty = 'decorated-value';
+        });
+
+        childFastify.oas.route({
+          handler: async request => {
+            return { customProperty: request.customProperty };
+          },
+          operationId: 'getPets'
+        });
+      });
+
+      const result = await app.inject({ url: '/pets' });
+
+      expect(result.json()).toMatchObject({
+        customProperty: 'decorated-value'
+      });
+    });
+
+    it('should use the correct fastify instance when calling oas.installNotImplementedRoutes() from a child plugin', async () => {
+      const app = fastify({ logger: false });
+
+      await app.register(OpenAPIRouter, { spec });
+
+      await app.register(async childFastify => {
+        childFastify.decorateRequest('customProperty', null);
+        childFastify.addHook('onRequest', async request => {
+          request.customProperty = 'decorated-value';
+        });
+
+        childFastify.oas.route({
+          handler: async request => {
+            return { customProperty: request.customProperty };
+          },
+          operationId: 'getPets'
+        });
+
+        childFastify.oas.installNotImplementedRoutes();
+      });
+
+      const postPetsResult = await app.inject({ method: 'POST', url: '/pets' });
+
+      expect(postPetsResult.statusCode).toBe(501);
+    });
+  });
 });

package/src/parser/index.js

@@ -22,7 +22,7 @@ export const parse = async options => {
       const operation = methods[method];
 
       const securityFn = applySecurity(operation, spec, options.securityHandlers, options.securityErrorMapper);
-      const applyParamsCoercingFn = applyParamsCoercing(operation);
+      const paramsCoercingFn = applyParamsCoercing(operation);
 
       // Build fastify route.
       const route = {
@@ -32,7 +32,7 @@ export const parse = async options => {
             request[DECORATOR_NAME].operation = operation;
 
             await securityFn?.(request);
-            applyParamsCoercingFn?.(request);
+            paramsCoercingFn?.(request);
           }
         ],
         schema: {

package/src/plugin.js

@@ -2,10 +2,10 @@ import { DECORATOR_NAME } from './utils/constants.js';
 import { createNotImplementedError, errors } from './errors/index.js';
 import { parse } from './parser/index.js';
 
-const createRoute = (fastify, routes, notImplementedErrorMapper) => {
+const createRouting = (routes, notImplementedErrorMapper) => {
   const missingRoutes = new Set(Object.values(routes));
 
-  const addMissingRoutes = () => {
+  const addMissingRoutes = fastify => {
     missingRoutes.forEach(route => {
       fastify.route({
         ...route,
@@ -28,7 +28,7 @@ const createRoute = (fastify, routes, notImplementedErrorMapper) => {
     missingRoutes.clear();
   };
 
-  const addRoute = ({ method, onRequest, operationId, schema, url, ...routeOptions }) => {
+  const addRoute = (fastify, { method, onRequest, operationId, schema, url, ...routeOptions }) => {
     const route = routes[operationId];
 
     // Throw an error if the operation is unknown.
@@ -68,13 +68,19 @@ const plugin = async (fastify, options) => {
 
   const routes = await parse(options);
 
-  const { addMissingRoutes, addRoute } = createRoute(fastify, routes, options.notImplementedErrorMapper);
+  const { addMissingRoutes, addRoute } = createRouting(routes, options.notImplementedErrorMapper);
 
   // Decorate fastify object.
   fastify.decorate(DECORATOR_NAME, {
-    errors,
-    installNotImplementedRoutes: addMissingRoutes,
-    route: addRoute
+    getter: function () {
+      const fastify = this;
+
+      return {
+        errors,
+        installNotImplementedRoutes: () => addMissingRoutes(fastify),
+        route: route => addRoute(fastify, route)
+      };
+    }
   });
 
   // Avoid decorating the request with reference types.