Merge pull request #440 from kuzzleio/KZLPRD-1032-routing-payloads

feat(payload controller): route endpoint redirect to decoders

Author: QuentinRousselet

lib/modules/decoder/DecodersController.ts

@@ -1,4 +1,4 @@
-import { ControllerDefinition, KuzzleRequest } from "kuzzle";
+import { BadRequestError, ControllerDefinition, KuzzleRequest } from "kuzzle";
 
 import { DecodersRegister } from "./DecodersRegister";
 import { PayloadService } from "./PayloadService";
@@ -32,6 +32,15 @@ export class DecodersController {
             { path: "device-manager/decoders/_prunePayloads", verb: "delete" },
           ],
         },
+        route: {
+          handler: this.route.bind(this),
+          http: [
+            {
+              path: "device-manager/decoders/route",
+              verb: "post",
+            },
+          ],
+        },
       },
     };
   }
@@ -61,4 +70,32 @@ export class DecodersController {
 
     return { deleted };
   }
+
+  async route(request: KuzzleRequest): Promise<{ valid: boolean }> {
+    const payload = request.getBody();
+    const model =
+      payload.deviceModel ?? request.getString("deviceModel", "unknownModel");
+    const apiAction = `${request.input.controller}:${request.input.action}`;
+    if (model === "unknownModel") {
+      app.log.warn(
+        "Received payload without a device model: routing to receiveUnknown",
+      );
+      this.payloadService.receiveUnknown(model, payload, apiAction);
+      throw new BadRequestError(
+        "Payload must specify the deviceModel for proper routing",
+      );
+    }
+    const decoder = this.decodersRegister.decoders.find(
+      (d) => d.deviceModel === model,
+    );
+    if (!decoder) {
+      app.log.warn(
+        `Received payload from ${model} model, no associated decoder found: routing to receiveUnknown`,
+      );
+      this.payloadService.receiveUnknown(model, payload, apiAction);
+      throw new BadRequestError("The specified device model is unknown");
+    }
+    app.log.debug("Routing payload to decoder for " + decoder.deviceModel);
+    return this.payloadService.receive(request, decoder);
+  }
 }

lib/modules/decoder/DecodersRegister.ts

@@ -128,6 +128,11 @@ export class DecodersRegister {
   private registerDefaultRole() {
     const role = {
       controllers: {
+        "device-manager/decoders": {
+          actions: {
+            route: true,
+          },
+        },
         "device-manager/payloads": {
           actions: {
             "*": true,

lib/modules/decoder/roles/RolePayloadsAll.ts

@@ -19,6 +19,11 @@ export const RolePayloadsAll: KuzzleRole = {
           "*": true,
         },
       },
+      "device-manager/decoders": {
+        actions: {
+          route: true,
+        },
+      },
     },
   },
 };