@twin.org/api-server-fastify 0.0.2-next.1 → 0.0.2-next.11

package/dist/cjs/index.cjs

@@ -5,7 +5,6 @@ var FastifyCors = require('@fastify/cors');
 var apiModels = require('@twin.org/api-models');
 var apiProcessors = require('@twin.org/api-processors');
 var core = require('@twin.org/core');
-var loggingModels = require('@twin.org/logging-models');
 var web = require('@twin.org/web');
 var Fastify = require('fastify');
 var fp = require('fastify-plugin');
@@ -28,11 +27,6 @@ const fastifySocketIO = fp(async (fastify, opts) => {
  * Implementation of the web server using Fastify.
  */
 class FastifyWebServer {
-    /**
-     * Runtime name for the class in camel case.
-     * @internal
-     */
-    static _CLASS_NAME_CAMEL_CASE = core.StringHelper.camelCase("FastifyWebServer");
     /**
      * Default port for running the server.
      * @internal
@@ -48,10 +42,15 @@ class FastifyWebServer {
      */
     CLASS_NAME = "FastifyWebServer";
     /**
-     * The logging connector.
+     * The logging component type.
      * @internal
      */
-    _loggingConnector;
+    _loggingComponentType;
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
     /**
      * The options for the server.
      * @internal
@@ -87,12 +86,15 @@ class FastifyWebServer {
      * @param options The options for the server.
      */
     constructor(options) {
-        this._loggingConnector = core.Is.stringValue(options?.loggingConnectorType)
-            ? loggingModels.LoggingConnectorFactory.get(options.loggingConnectorType)
-            : undefined;
+        this._loggingComponentType = options?.loggingComponentType;
+        this._logging = core.ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
         this._fastify = Fastify({
-            maxParamLength: 2000,
+            routerOptions: {
+                maxParamLength: 2000
+            },
             ...options?.config?.web
+            // Need this cast for now as maxParamLength has moved in to routerOptions
+            // but the TS defs has not been updated yet
         });
         this._socketConfig = {
             path: "/socket",
@@ -129,11 +131,11 @@ class FastifyWebServer {
         if (core.Is.arrayValue(socketRoutes) && !core.Is.arrayValue(socketRouteProcessors)) {
             throw new core.GeneralError(this.CLASS_NAME, "noSocketProcessors");
         }
-        await this._loggingConnector?.log({
+        await this._logging?.log({
             level: "info",
             ts: Date.now(),
             source: this.CLASS_NAME,
-            message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.building`
+            message: `${"fastifyWebServer"}.building`
         });
         this._options = options;
         await this._fastify.register(FastifyCompress);
@@ -174,11 +176,11 @@ class FastifyWebServer {
                 err = errorAndCode.error;
                 httpStatusCode = errorAndCode.httpStatusCode;
             }
-            await this._loggingConnector?.log({
+            await this._logging?.log({
                 level: "error",
                 ts: Date.now(),
                 source: this.CLASS_NAME,
-                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.badRequest`,
+                message: `${"fastifyWebServer"}.badRequest`,
                 error: err
             });
             return reply.status(httpStatusCode).send({
@@ -195,11 +197,11 @@ class FastifyWebServer {
     async start() {
         const host = this._options?.host ?? FastifyWebServer._DEFAULT_HOST;
         const port = this._options?.port ?? FastifyWebServer._DEFAULT_PORT;
-        await this._loggingConnector?.log({
+        await this._logging?.log({
             level: "info",
             ts: Date.now(),
             source: this.CLASS_NAME,
-            message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.starting`,
+            message: `${"fastifyWebServer"}.starting`,
             data: {
                 host,
                 port
@@ -210,11 +212,11 @@ class FastifyWebServer {
                 await this._fastify.listen({ port, host });
                 const addresses = this._fastify.addresses();
                 const protocol = core.Is.object(this._fastify.initialConfig.https) ? "https://" : "http://";
-                await this._loggingConnector?.log({
+                await this._logging?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.started`,
+                    message: `${"fastifyWebServer"}.started`,
                     data: {
                         addresses: addresses
                             .map(a => `${protocol}${a.family === "IPv6" ? "[" : ""}${a.address}${a.family === "IPv6" ? "]" : ""}:${a.port}`)
@@ -224,11 +226,11 @@ class FastifyWebServer {
                 this._started = true;
             }
             catch (err) {
-                await this._loggingConnector?.log({
+                await this._logging?.log({
                     level: "error",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.startFailed`,
+                    message: `${"fastifyWebServer"}.startFailed`,
                     error: core.BaseError.fromError(err)
                 });
             }
@@ -242,11 +244,11 @@ class FastifyWebServer {
         if (this._started) {
             this._started = false;
             await this._fastify.close();
-            await this._loggingConnector?.log({
+            await this._logging?.log({
                 level: "info",
                 ts: Date.now(),
                 source: this.CLASS_NAME,
-                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.stopped`
+                message: `${"fastifyWebServer"}.stopped`
             });
         }
     }
@@ -263,11 +265,11 @@ class FastifyWebServer {
                 if (!path.startsWith("/")) {
                     path = `/${path}`;
                 }
-                await this._loggingConnector?.log({
+                await this._logging?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.restRouteAdded`,
+                    message: `${"fastifyWebServer"}.restRouteAdded`,
                     data: { route: path, method: restRoute.method }
                 });
                 const method = restRoute.method.toLowerCase();
@@ -288,30 +290,33 @@ class FastifyWebServer {
             for (const socketRoute of socketRoutes) {
                 const path = core.StringHelper.trimLeadingSlashes(core.StringHelper.trimTrailingSlashes(socketRoute.path));
                 const pathParts = path.split("/");
-                await this._loggingConnector?.log({
+                const namespace = `/${pathParts[0]}`;
+                const topic = pathParts.slice(1).join("/");
+                await this._logging?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.socketRouteAdded`,
-                    data: { route: `/${path}` }
+                    message: `${"fastifyWebServer"}.socketRouteAdded`,
+                    data: {
+                        handshakePath: this._socketConfig.path,
+                        namespace,
+                        eventName: topic
+                    }
                 });
-                const socketNamespace = io.of(`/${pathParts[0]}`);
-                const topic = pathParts.slice(1).join("/");
+                const socketNamespace = io.of(namespace);
                 socketNamespace.on("connection", async (socket) => {
-                    const httpServerRequest = {
+                    const socketServerRequest = {
                         method: web.HttpMethod.GET,
                         url: socket.handshake.url,
                         query: socket.handshake.query,
-                        headers: socket.handshake.headers
+                        headers: socket.handshake.headers,
+                        socketId: socket.id
                     };
                     // Pass the connected information on to any processors
                     try {
-                        const processorState = {
-                            socketId: socket.id
-                        };
                         for (const socketRouteProcessor of socketRouteProcessors) {
-                            if (core.Is.function(socketRouteProcessor.connected)) {
-                                await socketRouteProcessor.connected(httpServerRequest, socketRoute, processorState);
+                            if (socketRouteProcessor.connected) {
+                                await socketRouteProcessor.connected(socketServerRequest, socketRoute, this._loggingComponentType);
                             }
                         }
                     }
@@ -323,13 +328,10 @@ class FastifyWebServer {
                     }
                     socket.on("disconnect", async () => {
                         try {
-                            const processorState = {
-                                socketId: socket.id
-                            };
                             // The socket disconnected so notify any processors
                             for (const socketRouteProcessor of socketRouteProcessors) {
-                                if (core.Is.function(socketRouteProcessor.disconnected)) {
-                                    await socketRouteProcessor.disconnected(httpServerRequest, socketRoute, processorState);
+                                if (socketRouteProcessor.disconnected) {
+                                    await socketRouteProcessor.disconnected(socketServerRequest, socketRoute, this._loggingComponentType);
                                 }
                             }
                         }
@@ -386,19 +388,20 @@ class FastifyWebServer {
      */
     async runProcessorsRest(restRouteProcessors, restRoute, httpServerRequest, httpResponse, httpRequestIdentity, processorState) {
         try {
-            for (const routeProcessor of restRouteProcessors) {
-                if (core.Is.function(routeProcessor.pre)) {
-                    await routeProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            const filteredProcessors = this.filterRouteProcessors(restRoute, restRouteProcessors);
+            for (const routeProcessor of filteredProcessors) {
+                if (routeProcessor.pre) {
+                    await routeProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
-            for (const routeProcessor of restRouteProcessors) {
-                if (core.Is.function(routeProcessor.process)) {
-                    await routeProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            for (const routeProcessor of filteredProcessors) {
+                if (routeProcessor.process) {
+                    await routeProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
-            for (const routeProcessor of restRouteProcessors) {
-                if (core.Is.function(routeProcessor.post)) {
-                    await routeProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            for (const routeProcessor of filteredProcessors) {
+                if (routeProcessor.post) {
+                    await routeProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
         }
@@ -407,6 +410,33 @@ class FastifyWebServer {
             apiModels.HttpErrorHelper.buildResponse(httpResponse, error, httpStatusCode);
         }
     }
+    /**
+     * Filter the route processors based on the requested features.
+     * @param route The route to process.
+     * @param routeProcessors The processors to filter.
+     * @returns The filtered list of route processor.
+     * @internal
+     */
+    filterRouteProcessors(route, routeProcessors) {
+        const requestedFeatures = route?.processorFeatures ?? [];
+        if (!core.Is.arrayValue(requestedFeatures)) {
+            // If there are no requested features, we just return all the processors
+            return routeProcessors;
+        }
+        // Reduce the list of route processors to just those in the requested features list
+        const reducedProcessors = routeProcessors.filter(routeProcessor => {
+            // Processors that do not define any features always get run
+            // If the route processor has features defined, then we only run it
+            // if the route has at least one of those features required
+            let runRouteProcessor = true;
+            if (routeProcessor.features) {
+                const routeProcessorFeatures = routeProcessor.features();
+                runRouteProcessor = routeProcessorFeatures.some(feature => requestedFeatures.includes(feature));
+            }
+            return runRouteProcessor;
+        });
+        return reducedProcessors;
+    }
     /**
      * Handle the incoming socket request.
      * @param socketRouteProcessors The hooks to process the incoming requests.
@@ -418,53 +448,54 @@ class FastifyWebServer {
      * @internal
      */
     async handleRequestSocket(socketRouteProcessors, socketRoute, socket, fullPath, emitTopic, request) {
-        const httpServerRequest = {
+        const socketServerRequest = {
             method: web.HttpMethod.GET,
             url: fullPath,
             query: socket.handshake.query,
             headers: socket.handshake.headers,
-            body: request.body
+            body: request.body,
+            socketId: socket.id
         };
         const httpResponse = {};
         const httpRequestIdentity = {};
-        const processorState = {
-            socketId: socket.id
-        };
-        delete httpServerRequest.query?.EIO;
-        delete httpServerRequest.query?.transport;
-        await this.runProcessorsSocket(socketRouteProcessors, socketRoute, httpServerRequest, httpResponse, httpRequestIdentity, processorState, emitTopic, async (topic, response) => {
+        const processorState = {};
+        delete socketServerRequest.query?.EIO;
+        delete socketServerRequest.query?.transport;
+        await this.runProcessorsSocket(socketRouteProcessors, socketRoute, socketServerRequest, httpResponse, httpRequestIdentity, processorState, emitTopic, async (topic, response) => {
             await socket.emit(topic, response);
         });
     }
     /**
      * Run the socket processors for the route.
+     * @param socketId The id of the socket.
      * @param socketRouteProcessors The processors to run.
      * @param socketRoute The route to process.
-     * @param httpServerRequest The incoming request.
+     * @param socketServerRequest The incoming request.
      * @param httpResponse The outgoing response.
      * @param httpRequestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
      * @param requestTopic The topic of the request.
      * @internal
      */
-    async runProcessorsSocket(socketRouteProcessors, socketRoute, httpServerRequest, httpResponse, httpRequestIdentity, processorState, requestTopic, responseEmitter) {
+    async runProcessorsSocket(socketRouteProcessors, socketRoute, socketServerRequest, httpResponse, httpRequestIdentity, processorState, requestTopic, responseEmitter) {
+        const filteredProcessors = this.filterRouteProcessors(socketRoute, socketRouteProcessors);
         // Custom emit method which will also call the post processors
         const postProcessEmit = async (topic, response, responseProcessorState) => {
             await responseEmitter(topic, response);
             try {
                 // The post processors are called after the response has been emitted
-                for (const postSocketRouteProcessor of socketRouteProcessors) {
-                    if (core.Is.function(postSocketRouteProcessor.post)) {
-                        await postSocketRouteProcessor.post(httpServerRequest, response, socketRoute, httpRequestIdentity, responseProcessorState);
+                for (const postSocketRouteProcessor of filteredProcessors) {
+                    if (postSocketRouteProcessor.post) {
+                        await postSocketRouteProcessor.post(socketServerRequest, response, socketRoute, httpRequestIdentity, responseProcessorState, this._loggingComponentType);
                     }
                 }
             }
             catch (err) {
-                this._loggingConnector?.log({
+                this._logging?.log({
                     level: "error",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.postProcessorError`,
+                    message: `${"fastifyWebServer"}.postProcessorError`,
                     error: core.BaseError.fromError(err),
                     data: {
                         route: socketRoute.path
@@ -473,9 +504,9 @@ class FastifyWebServer {
             }
         };
         try {
-            for (const socketRouteProcessor of socketRouteProcessors) {
-                if (core.Is.function(socketRouteProcessor.pre)) {
-                    await socketRouteProcessor.pre(httpServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState);
+            for (const socketRouteProcessor of filteredProcessors) {
+                if (socketRouteProcessor.pre) {
+                    await socketRouteProcessor.pre(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
             // We always call all the processors regardless of any response set by a previous processor.
@@ -484,11 +515,11 @@ class FastifyWebServer {
             if (!core.Is.empty(httpResponse.statusCode)) {
                 await postProcessEmit(requestTopic, httpResponse, processorState);
             }
-            for (const socketRouteProcessor of socketRouteProcessors) {
-                if (core.Is.function(socketRouteProcessor.process)) {
-                    await socketRouteProcessor.process(httpServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, async (topic, processResponse) => {
+            for (const socketRouteProcessor of filteredProcessors) {
+                if (socketRouteProcessor.process) {
+                    await socketRouteProcessor.process(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, async (topic, processResponse) => {
                         await postProcessEmit(topic, processResponse, processorState);
-                    });
+                    }, this._loggingComponentType);
                 }
             }
             // If the processors set the status to any kind of error then we should emit this manually

package/dist/esm/index.mjs

@@ -2,8 +2,7 @@ import FastifyCompress from '@fastify/compress';
 import FastifyCors from '@fastify/cors';
 import { HttpErrorHelper } from '@twin.org/api-models';
 import { JsonLdMimeTypeProcessor } from '@twin.org/api-processors';
-import { StringHelper, Is, GeneralError, BaseError } from '@twin.org/core';
-import { LoggingConnectorFactory } from '@twin.org/logging-models';
+import { ComponentFactory, Is, GeneralError, BaseError, StringHelper } from '@twin.org/core';
 import { HttpStatusCode, HttpMethod, HeaderTypes } from '@twin.org/web';
 import Fastify from 'fastify';
 import fp from 'fastify-plugin';
@@ -26,11 +25,6 @@ const fastifySocketIO = fp(async (fastify, opts) => {
  * Implementation of the web server using Fastify.
  */
 class FastifyWebServer {
-    /**
-     * Runtime name for the class in camel case.
-     * @internal
-     */
-    static _CLASS_NAME_CAMEL_CASE = StringHelper.camelCase("FastifyWebServer");
     /**
      * Default port for running the server.
      * @internal
@@ -46,10 +40,15 @@ class FastifyWebServer {
      */
     CLASS_NAME = "FastifyWebServer";
     /**
-     * The logging connector.
+     * The logging component type.
      * @internal
      */
-    _loggingConnector;
+    _loggingComponentType;
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
     /**
      * The options for the server.
      * @internal
@@ -85,12 +84,15 @@ class FastifyWebServer {
      * @param options The options for the server.
      */
     constructor(options) {
-        this._loggingConnector = Is.stringValue(options?.loggingConnectorType)
-            ? LoggingConnectorFactory.get(options.loggingConnectorType)
-            : undefined;
+        this._loggingComponentType = options?.loggingComponentType;
+        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
         this._fastify = Fastify({
-            maxParamLength: 2000,
+            routerOptions: {
+                maxParamLength: 2000
+            },
             ...options?.config?.web
+            // Need this cast for now as maxParamLength has moved in to routerOptions
+            // but the TS defs has not been updated yet
         });
         this._socketConfig = {
             path: "/socket",
@@ -127,11 +129,11 @@ class FastifyWebServer {
         if (Is.arrayValue(socketRoutes) && !Is.arrayValue(socketRouteProcessors)) {
             throw new GeneralError(this.CLASS_NAME, "noSocketProcessors");
         }
-        await this._loggingConnector?.log({
+        await this._logging?.log({
             level: "info",
             ts: Date.now(),
             source: this.CLASS_NAME,
-            message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.building`
+            message: `${"fastifyWebServer"}.building`
         });
         this._options = options;
         await this._fastify.register(FastifyCompress);
@@ -172,11 +174,11 @@ class FastifyWebServer {
                 err = errorAndCode.error;
                 httpStatusCode = errorAndCode.httpStatusCode;
             }
-            await this._loggingConnector?.log({
+            await this._logging?.log({
                 level: "error",
                 ts: Date.now(),
                 source: this.CLASS_NAME,
-                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.badRequest`,
+                message: `${"fastifyWebServer"}.badRequest`,
                 error: err
             });
             return reply.status(httpStatusCode).send({
@@ -193,11 +195,11 @@ class FastifyWebServer {
     async start() {
         const host = this._options?.host ?? FastifyWebServer._DEFAULT_HOST;
         const port = this._options?.port ?? FastifyWebServer._DEFAULT_PORT;
-        await this._loggingConnector?.log({
+        await this._logging?.log({
             level: "info",
             ts: Date.now(),
             source: this.CLASS_NAME,
-            message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.starting`,
+            message: `${"fastifyWebServer"}.starting`,
             data: {
                 host,
                 port
@@ -208,11 +210,11 @@ class FastifyWebServer {
                 await this._fastify.listen({ port, host });
                 const addresses = this._fastify.addresses();
                 const protocol = Is.object(this._fastify.initialConfig.https) ? "https://" : "http://";
-                await this._loggingConnector?.log({
+                await this._logging?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.started`,
+                    message: `${"fastifyWebServer"}.started`,
                     data: {
                         addresses: addresses
                             .map(a => `${protocol}${a.family === "IPv6" ? "[" : ""}${a.address}${a.family === "IPv6" ? "]" : ""}:${a.port}`)
@@ -222,11 +224,11 @@ class FastifyWebServer {
                 this._started = true;
             }
             catch (err) {
-                await this._loggingConnector?.log({
+                await this._logging?.log({
                     level: "error",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.startFailed`,
+                    message: `${"fastifyWebServer"}.startFailed`,
                     error: BaseError.fromError(err)
                 });
             }
@@ -240,11 +242,11 @@ class FastifyWebServer {
         if (this._started) {
             this._started = false;
             await this._fastify.close();
-            await this._loggingConnector?.log({
+            await this._logging?.log({
                 level: "info",
                 ts: Date.now(),
                 source: this.CLASS_NAME,
-                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.stopped`
+                message: `${"fastifyWebServer"}.stopped`
             });
         }
     }
@@ -261,11 +263,11 @@ class FastifyWebServer {
                 if (!path.startsWith("/")) {
                     path = `/${path}`;
                 }
-                await this._loggingConnector?.log({
+                await this._logging?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.restRouteAdded`,
+                    message: `${"fastifyWebServer"}.restRouteAdded`,
                     data: { route: path, method: restRoute.method }
                 });
                 const method = restRoute.method.toLowerCase();
@@ -286,30 +288,33 @@ class FastifyWebServer {
             for (const socketRoute of socketRoutes) {
                 const path = StringHelper.trimLeadingSlashes(StringHelper.trimTrailingSlashes(socketRoute.path));
                 const pathParts = path.split("/");
-                await this._loggingConnector?.log({
+                const namespace = `/${pathParts[0]}`;
+                const topic = pathParts.slice(1).join("/");
+                await this._logging?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.socketRouteAdded`,
-                    data: { route: `/${path}` }
+                    message: `${"fastifyWebServer"}.socketRouteAdded`,
+                    data: {
+                        handshakePath: this._socketConfig.path,
+                        namespace,
+                        eventName: topic
+                    }
                 });
-                const socketNamespace = io.of(`/${pathParts[0]}`);
-                const topic = pathParts.slice(1).join("/");
+                const socketNamespace = io.of(namespace);
                 socketNamespace.on("connection", async (socket) => {
-                    const httpServerRequest = {
+                    const socketServerRequest = {
                         method: HttpMethod.GET,
                         url: socket.handshake.url,
                         query: socket.handshake.query,
-                        headers: socket.handshake.headers
+                        headers: socket.handshake.headers,
+                        socketId: socket.id
                     };
                     // Pass the connected information on to any processors
                     try {
-                        const processorState = {
-                            socketId: socket.id
-                        };
                         for (const socketRouteProcessor of socketRouteProcessors) {
-                            if (Is.function(socketRouteProcessor.connected)) {
-                                await socketRouteProcessor.connected(httpServerRequest, socketRoute, processorState);
+                            if (socketRouteProcessor.connected) {
+                                await socketRouteProcessor.connected(socketServerRequest, socketRoute, this._loggingComponentType);
                             }
                         }
                     }
@@ -321,13 +326,10 @@ class FastifyWebServer {
                     }
                     socket.on("disconnect", async () => {
                         try {
-                            const processorState = {
-                                socketId: socket.id
-                            };
                             // The socket disconnected so notify any processors
                             for (const socketRouteProcessor of socketRouteProcessors) {
-                                if (Is.function(socketRouteProcessor.disconnected)) {
-                                    await socketRouteProcessor.disconnected(httpServerRequest, socketRoute, processorState);
+                                if (socketRouteProcessor.disconnected) {
+                                    await socketRouteProcessor.disconnected(socketServerRequest, socketRoute, this._loggingComponentType);
                                 }
                             }
                         }
@@ -384,19 +386,20 @@ class FastifyWebServer {
      */
     async runProcessorsRest(restRouteProcessors, restRoute, httpServerRequest, httpResponse, httpRequestIdentity, processorState) {
         try {
-            for (const routeProcessor of restRouteProcessors) {
-                if (Is.function(routeProcessor.pre)) {
-                    await routeProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            const filteredProcessors = this.filterRouteProcessors(restRoute, restRouteProcessors);
+            for (const routeProcessor of filteredProcessors) {
+                if (routeProcessor.pre) {
+                    await routeProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
-            for (const routeProcessor of restRouteProcessors) {
-                if (Is.function(routeProcessor.process)) {
-                    await routeProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            for (const routeProcessor of filteredProcessors) {
+                if (routeProcessor.process) {
+                    await routeProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
-            for (const routeProcessor of restRouteProcessors) {
-                if (Is.function(routeProcessor.post)) {
-                    await routeProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            for (const routeProcessor of filteredProcessors) {
+                if (routeProcessor.post) {
+                    await routeProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
         }
@@ -405,6 +408,33 @@ class FastifyWebServer {
             HttpErrorHelper.buildResponse(httpResponse, error, httpStatusCode);
         }
     }
+    /**
+     * Filter the route processors based on the requested features.
+     * @param route The route to process.
+     * @param routeProcessors The processors to filter.
+     * @returns The filtered list of route processor.
+     * @internal
+     */
+    filterRouteProcessors(route, routeProcessors) {
+        const requestedFeatures = route?.processorFeatures ?? [];
+        if (!Is.arrayValue(requestedFeatures)) {
+            // If there are no requested features, we just return all the processors
+            return routeProcessors;
+        }
+        // Reduce the list of route processors to just those in the requested features list
+        const reducedProcessors = routeProcessors.filter(routeProcessor => {
+            // Processors that do not define any features always get run
+            // If the route processor has features defined, then we only run it
+            // if the route has at least one of those features required
+            let runRouteProcessor = true;
+            if (routeProcessor.features) {
+                const routeProcessorFeatures = routeProcessor.features();
+                runRouteProcessor = routeProcessorFeatures.some(feature => requestedFeatures.includes(feature));
+            }
+            return runRouteProcessor;
+        });
+        return reducedProcessors;
+    }
     /**
      * Handle the incoming socket request.
      * @param socketRouteProcessors The hooks to process the incoming requests.
@@ -416,53 +446,54 @@ class FastifyWebServer {
      * @internal
      */
     async handleRequestSocket(socketRouteProcessors, socketRoute, socket, fullPath, emitTopic, request) {
-        const httpServerRequest = {
+        const socketServerRequest = {
             method: HttpMethod.GET,
             url: fullPath,
             query: socket.handshake.query,
             headers: socket.handshake.headers,
-            body: request.body
+            body: request.body,
+            socketId: socket.id
         };
         const httpResponse = {};
         const httpRequestIdentity = {};
-        const processorState = {
-            socketId: socket.id
-        };
-        delete httpServerRequest.query?.EIO;
-        delete httpServerRequest.query?.transport;
-        await this.runProcessorsSocket(socketRouteProcessors, socketRoute, httpServerRequest, httpResponse, httpRequestIdentity, processorState, emitTopic, async (topic, response) => {
+        const processorState = {};
+        delete socketServerRequest.query?.EIO;
+        delete socketServerRequest.query?.transport;
+        await this.runProcessorsSocket(socketRouteProcessors, socketRoute, socketServerRequest, httpResponse, httpRequestIdentity, processorState, emitTopic, async (topic, response) => {
             await socket.emit(topic, response);
         });
     }
     /**
      * Run the socket processors for the route.
+     * @param socketId The id of the socket.
      * @param socketRouteProcessors The processors to run.
      * @param socketRoute The route to process.
-     * @param httpServerRequest The incoming request.
+     * @param socketServerRequest The incoming request.
      * @param httpResponse The outgoing response.
      * @param httpRequestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
      * @param requestTopic The topic of the request.
      * @internal
      */
-    async runProcessorsSocket(socketRouteProcessors, socketRoute, httpServerRequest, httpResponse, httpRequestIdentity, processorState, requestTopic, responseEmitter) {
+    async runProcessorsSocket(socketRouteProcessors, socketRoute, socketServerRequest, httpResponse, httpRequestIdentity, processorState, requestTopic, responseEmitter) {
+        const filteredProcessors = this.filterRouteProcessors(socketRoute, socketRouteProcessors);
         // Custom emit method which will also call the post processors
         const postProcessEmit = async (topic, response, responseProcessorState) => {
             await responseEmitter(topic, response);
             try {
                 // The post processors are called after the response has been emitted
-                for (const postSocketRouteProcessor of socketRouteProcessors) {
-                    if (Is.function(postSocketRouteProcessor.post)) {
-                        await postSocketRouteProcessor.post(httpServerRequest, response, socketRoute, httpRequestIdentity, responseProcessorState);
+                for (const postSocketRouteProcessor of filteredProcessors) {
+                    if (postSocketRouteProcessor.post) {
+                        await postSocketRouteProcessor.post(socketServerRequest, response, socketRoute, httpRequestIdentity, responseProcessorState, this._loggingComponentType);
                     }
                 }
             }
             catch (err) {
-                this._loggingConnector?.log({
+                this._logging?.log({
                     level: "error",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
-                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.postProcessorError`,
+                    message: `${"fastifyWebServer"}.postProcessorError`,
                     error: BaseError.fromError(err),
                     data: {
                         route: socketRoute.path
@@ -471,9 +502,9 @@ class FastifyWebServer {
             }
         };
         try {
-            for (const socketRouteProcessor of socketRouteProcessors) {
-                if (Is.function(socketRouteProcessor.pre)) {
-                    await socketRouteProcessor.pre(httpServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState);
+            for (const socketRouteProcessor of filteredProcessors) {
+                if (socketRouteProcessor.pre) {
+                    await socketRouteProcessor.pre(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
             // We always call all the processors regardless of any response set by a previous processor.
@@ -482,11 +513,11 @@ class FastifyWebServer {
             if (!Is.empty(httpResponse.statusCode)) {
                 await postProcessEmit(requestTopic, httpResponse, processorState);
             }
-            for (const socketRouteProcessor of socketRouteProcessors) {
-                if (Is.function(socketRouteProcessor.process)) {
-                    await socketRouteProcessor.process(httpServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, async (topic, processResponse) => {
+            for (const socketRouteProcessor of filteredProcessors) {
+                if (socketRouteProcessor.process) {
+                    await socketRouteProcessor.process(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, async (topic, processResponse) => {
                         await postProcessEmit(topic, processResponse, processorState);
-                    });
+                    }, this._loggingComponentType);
                 }
             }
             // If the processors set the status to any kind of error then we should emit this manually

package/dist/types/models/IFastifyWebServerConstructorOptions.d.ts

@@ -5,9 +5,9 @@ import type { IFastifyWebServerConfig } from "./IFastifyWebServerConfig";
  */
 export interface IFastifyWebServerConstructorOptions {
     /**
-     * The type of the logging connector to use, if undefined, no logging will happen.
+     * The type of the logging component to use, if undefined, no logging will happen.
      */
-    loggingConnectorType?: string;
+    loggingComponentType?: string;
     /**
      * Additional configuration for the server.
      */

package/docs/changelog.md

@@ -1,5 +1,170 @@
 # @twin.org/api-server-fastify - Changelog
 
+## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.10...api-server-fastify-v0.0.2-next.11) (2025-09-29)
+
+
+### Features
+
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.10 to 0.0.2-next.11
+    * @twin.org/api-models bumped from 0.0.2-next.10 to 0.0.2-next.11
+    * @twin.org/api-processors bumped from 0.0.2-next.10 to 0.0.2-next.11
+
+## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.9...api-server-fastify-v0.0.2-next.10) (2025-09-23)
+
+
+### Features
+
+* add authentication generators and process features option ([a67edf1](https://github.com/twinfoundation/api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/api-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/api-processors bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.8...api-server-fastify-v0.0.2-next.9) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/api-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/api-processors bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.7...api-server-fastify-v0.0.2-next.8) (2025-08-21)
+
+
+### Features
+
+* add root, favicon routes ([71da1c3](https://github.com/twinfoundation/api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.7 to 0.0.2-next.8
+    * @twin.org/api-models bumped from 0.0.2-next.7 to 0.0.2-next.8
+    * @twin.org/api-processors bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.6...api-server-fastify-v0.0.2-next.7) (2025-08-20)
+
+
+### Features
+
+* logging naming consistency ([a4a6ef2](https://github.com/twinfoundation/api/commit/a4a6ef2de5049045589eb78b177ff62e744bde9d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.6 to 0.0.2-next.7
+    * @twin.org/api-models bumped from 0.0.2-next.6 to 0.0.2-next.7
+    * @twin.org/api-processors bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [0.0.2-next.6](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.5...api-server-fastify-v0.0.2-next.6) (2025-08-19)
+
+
+### Features
+
+* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.5 to 0.0.2-next.6
+    * @twin.org/api-models bumped from 0.0.2-next.5 to 0.0.2-next.6
+    * @twin.org/api-processors bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.4...api-server-fastify-v0.0.2-next.5) (2025-07-25)
+
+
+### Features
+
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* improve socket route logging ([b8d9519](https://github.com/twinfoundation/api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/api-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/api-processors bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.3...api-server-fastify-v0.0.2-next.4) (2025-07-25)
+
+
+### Features
+
+* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/api-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/api-processors bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.2...api-server-fastify-v0.0.2-next.3) (2025-07-24)
+
+
+### Features
+
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/api-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/api-processors bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.1...api-server-fastify-v0.0.2-next.2) (2025-07-17)
+
+
+### Features
+
+* improve socket route logging ([b8d9519](https://github.com/twinfoundation/api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/api-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/api-processors bumped from 0.0.2-next.1 to 0.0.2-next.2
+
 ## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.0...api-server-fastify-v0.0.2-next.1) (2025-07-08)
 
 

package/docs/reference/interfaces/IFastifyWebServerConstructorOptions.md

@@ -4,11 +4,11 @@ The options for the Fastify web server constructor.
 
 ## Properties
 
-### loggingConnectorType?
+### loggingComponentType?
 
-> `optional` **loggingConnectorType**: `string`
+> `optional` **loggingComponentType**: `string`
 
-The type of the logging connector to use, if undefined, no logging will happen.
+The type of the logging component to use, if undefined, no logging will happen.
 
 ***
 

package/locales/en.json

@@ -7,7 +7,7 @@
 		"stopped": "The Web Server was stopped",
 		"badRequest": "The web server could not handle the request",
 		"restRouteAdded": "Added REST route \"{route}\" \"{method}\"",
-		"socketRouteAdded": "Added socket route \"{route}\"",
+		"socketRouteAdded": "Added socket route: handshake path \"{handshakePath}\", namespace \"{namespace}\", event name \"{eventName}\"",
 		"noRestProcessors": "You must configure at least one REST processor",
 		"noSocketProcessors": "You must configure at least one socket processor",
 		"postProcessorError": "There was a failure after in a post processor for route \"{route}\""

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-server-fastify",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.11",
 	"description": "Use Fastify as the core web server for APIs",
 	"repository": {
 		"type": "git",
@@ -14,16 +14,16 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@fastify/compress": "8.0.3",
-		"@fastify/cors": "11.0.1",
-		"@twin.org/api-core": "0.0.2-next.1",
-		"@twin.org/api-models": "0.0.2-next.1",
-		"@twin.org/api-processors": "0.0.2-next.1",
+		"@fastify/compress": "8.1.0",
+		"@fastify/cors": "11.1.0",
+		"@twin.org/api-core": "0.0.2-next.11",
+		"@twin.org/api-models": "0.0.2-next.11",
+		"@twin.org/api-processors": "0.0.2-next.11",
 		"@twin.org/core": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next",
-		"fastify": "5.3.3",
+		"fastify": "5.6.1",
 		"socket.io": "4.8.1"
 	},
 	"main": "./dist/cjs/index.cjs",