Add originId digital twins embedded measures (#272)

Add the originId property to EmbeddedMeasure which contains the Device ID when the measure comes from a Device.

It's more easier to retrieve the device who sent the measure, otherwise developers needs to find the device ID in the linkedDevices array from the measure name.

Author: Aschen

features/fixtures/application/tests/pipes.ts

@@ -6,7 +6,6 @@ import should from "should";
 import {
   MeasureContent,
   EventMeasureProcessBefore,
-  AssetContent,
   DeviceContent,
   TemperatureMeasurement,
 } from "../../../../index";
@@ -85,6 +84,7 @@ export function registerTestPipes(app: Backend) {
               values: {
                 temperature: temperatureInt.values.temperature,
               },
+              originId: device._id,
             };
           }
         }
@@ -131,6 +131,7 @@ export function registerTestPipes(app: Backend) {
           payloadUuids: measure.origin.payloadUuids,
           type: measure.type,
           values: measure.values,
+          originId: device._id,
         };
       }
 

lib/core/DeviceManagerEngine.ts

@@ -9,7 +9,10 @@ import {
   DeviceModelContent,
   MeasureModelContent,
 } from "../modules/model";
-import { measuresMappings } from "../modules/measure";
+import {
+  getEmbeddedMeasureMappings,
+  measuresMappings,
+} from "../modules/measure";
 import { devicesMappings } from "../modules/device";
 import { onAsk } from "../modules/shared";
 import { NamedMeasures } from "../modules/decoder";
@@ -225,17 +228,10 @@ export class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlugin> {
           );
         }
 
-        mappings.properties.measures.properties[measureName] = {
-          properties: {
-            measuredAt: { type: "date" },
-            name: { type: "keyword" },
-            payloadUuids: { type: "keyword" },
-            type: { type: "keyword" },
-            values: {
-              properties: measureModel._source.measure.valuesMappings,
-            },
-          },
-        };
+        mappings.properties.measures.properties[measureName] =
+          getEmbeddedMeasureMappings(
+            measureModel._source.measure.valuesMappings
+          );
       }
     }
 

lib/modules/measure/MeasureService.ts

@@ -292,6 +292,7 @@ export class MeasureService {
       device._source.measures[measureName] = {
         measuredAt: measurement.measuredAt,
         name: measureName,
+        originId: measurement.origin._id,
         payloadUuids: measurement.origin.payloadUuids,
         type: measurement.type,
         values: measurement.values,
@@ -330,6 +331,7 @@ export class MeasureService {
       asset._source.measures[measureName] = {
         measuredAt: measurement.measuredAt,
         name: measureName,
+        originId: measurement.origin._id,
         payloadUuids: measurement.origin.payloadUuids,
         type: measurement.type,
         values: measurement.values,

lib/modules/measure/collections/getEmbeddedMeasureMappings.ts

@@ -0,0 +1,16 @@
+import { JSONObject } from "kuzzle-sdk";
+
+export const getEmbeddedMeasureMappings: (values: JSONObject) => JSONObject = (
+  valuesMappings
+) => ({
+  properties: {
+    measuredAt: { type: "date" },
+    name: { type: "keyword" },
+    payloadUuids: { type: "keyword" },
+    type: { type: "keyword" },
+    values: {
+      properties: valuesMappings,
+    },
+    originId: { type: "keyword" },
+  },
+});

lib/modules/measure/index.ts

@@ -6,3 +6,4 @@ export * from "./measures";
 export * from "./MeasureModule";
 export * from "./roles/RoleMeasuresAdmin";
 export * from "./roles/RoleMeasuresReader";
+export * from "./collections/getEmbeddedMeasureMappings";

lib/modules/shared/types/EmbeddedMeasure.ts

@@ -26,4 +26,9 @@ export type EmbeddedMeasure<TMeasureValue extends JSONObject = JSONObject> = {
    * Name of the measure for the digital twin
    */
   name: string;
+
+  /**
+   * Origin ID of the measure (deviceId in most cases)
+   */
+  originId: string;
 };