feat: add log in decoders (#339)

* feat: add logger in Decoders * chore: lint * refactor: do not use the constructor directly pass the logger in registerDevice * refacto setup logger in decoders * untrack custom docker compose file * fix: this.context is undefined before the init method called in app.start() * fixed implementation * made lint happier (hopfully) --------- Co-authored-by: Eric Trousset <[email protected]>
kuzzleio · May 23, 2024 · fe08b7c · fe08b7c
1 parent 5cd6aca
commit fe08b7c
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 13 deletions.
diff --git a/lib/modules/decoder/Decoder.ts b/lib/modules/decoder/Decoder.ts
@@ -27,6 +27,17 @@ export type NamedMeasures = Array<{
 export abstract class Decoder {
   private _http?: HttpRoute[];
 
+  /**
+   * Internal logger.
+   */
+  public log: {
+    debug: (message: any) => void;
+    error: (message: any) => void;
+    info: (message: any) => void;
+    silly: (message: any) => void;
+    verbose: (message: any) => void;
+    warn: (message: any) => void;
+  };
   /**
    * Device model name.
    *

diff --git a/lib/modules/plugin/DeviceManagerPlugin.ts b/lib/modules/plugin/DeviceManagerPlugin.ts
@@ -196,6 +196,7 @@ export class DeviceManagerPlugin extends Plugin {
        */
       registerDevice: (model: string, definition: DeviceModelDefinition) => {
         this.decodersRegister.register(definition.decoder);
+        definition.decoder.log = this.context?.log;
 
         this.modelsRegister.registerDevice(
           model,
@@ -234,7 +235,6 @@ export class DeviceManagerPlugin extends Plugin {
     });
 
     /* eslint-disable sort-keys */
-
     this.api = {};
     this.pipes = {
       "generic:document:beforeWrite": [],
@@ -314,6 +314,10 @@ export class DeviceManagerPlugin extends Plugin {
     this.config = _.merge({}, this.config, config);
     this.context = context;
 
+    for (const decoder of this.decodersRegister.decoders) {
+      decoder.log = this.context.log;
+    }
+
     // Modules creation
     this.assetModule = new AssetModule(this);
     this.deviceModule = new DeviceModule(this);

diff --git a/tests/application/app.ts b/tests/application/app.ts
@@ -26,19 +26,23 @@ deviceManager.config.engineCollections.device.mappings.properties["softTenant"]
 };
 
 
-deviceManager.models.registerDevice("DummyTempPosition", {
-  decoder: new DummyTempPositionDecoder(),
-  metadataMappings: {
-    serial: { type: "keyword" },
-  },
-});
+deviceManager.models.registerDevice("DummyTempPosition", 
+  {
+    decoder: new DummyTempPositionDecoder(),
+    metadataMappings: {
+      serial: { type: "keyword" },
+    },
+  }
+);
 
-deviceManager.models.registerDevice("DummyTemp", {
-  decoder: new DummyTempDecoder(),
-  metadataMappings: {
-    color: { type: "keyword" },
-  },
-});
+deviceManager.models.registerDevice("DummyTemp", 
+  { 
+    decoder: new DummyTempDecoder(),
+    metadataMappings: {
+      color: { type: "keyword" },
+    },
+  }
+);
 
 // Register an asset for the "commons" group
 

diff --git a/tests/application/decoders/DummyTempDecoder.ts b/tests/application/decoders/DummyTempDecoder.ts
@@ -45,6 +45,7 @@ export class DummyTempDecoder extends Decoder {
     decodedPayload: DecodedPayload<DummyTempDecoder>,
     rawPayload: JSONObject,
   ): Promise<DecodedPayload<DummyTempDecoder>> {
+    this.log.info("Decoding payload");
     const payloads: any[] = rawPayload.measurements ?? [rawPayload];
 
     for (const payload of payloads) {

diff --git a/tests/application/decoders/DummyTempPositionDecoder.ts b/tests/application/decoders/DummyTempPositionDecoder.ts
@@ -17,6 +17,10 @@ export class DummyTempPositionDecoder extends Decoder {
     { name: "position", type: "position" },
   ] as const;
 
+  constructor() {
+    super();
+  }
+
   async validate(payload: JSONObject) {
     if (payload.deviceEUI === undefined) {
       throw new PreconditionError('Invalid payload: missing "deviceEUI"');