fix(measures): add device groups field to origin of measures documents (#441)

QuentinRousselet · web-flow · commit 35aa43dc3b60 · 2025-10-02T14:36:31.000+02:00
diff --git a/lib/modules/decoder/PayloadService.ts b/lib/modules/decoder/PayloadService.ts
@@ -18,6 +18,7 @@ import { Decoder } from "./Decoder";
 import { DecodingState } from "./DecodingState";
 import { SkipError } from "./SkipError";
 import { AskPayloadReceiveFormated } from "./types/PayloadEvents";
+import { DeviceMeasureSource } from "../measure/types/MeasureSources";
 
 export class PayloadService extends BaseService {
   constructor(plugin: DeviceManagerPlugin) {
@@ -110,12 +111,14 @@ export class PayloadService extends BaseService {
     const devices = await this.retrieveDevices(
       decoder.deviceModel,
       decodedPayload.references,
-      { refresh },
+      {
+        refresh,
+      },
     );
     for (const device of devices) {
       const {
         _id,
-        _source: { reference, model, metadata, linkedMeasures, engineId },
+        _source: { reference, linkedMeasures, engineId },
       } = device;
       // ? Done here to avoid invoque Measure service only for device metadata change (if no engineId)
       const deviceMetadataChanges = decodedPayload.getMetadata(reference);
@@ -145,14 +148,10 @@ export class PayloadService extends BaseService {
             {
               measurements,
               payloadUuids: [uuid],
-              source: {
-                deviceMetadata: metadata,
-                id: _id,
-                metadata: deviceMetadataChanges,
-                model: model,
-                reference: reference,
-                type: "device",
-              },
+              source: this.getDeviceMeasureSource(
+                device,
+                deviceMetadataChanges,
+              ),
               target: {
                 assetId: null,
                 indexId: engineId,
@@ -175,14 +174,10 @@ export class PayloadService extends BaseService {
             {
               measurements: assetMeasurements,
               payloadUuids: [uuid],
-              source: {
-                deviceMetadata: metadata,
-                id: _id,
-                metadata: deviceMetadataChanges,
-                model: model,
-                reference: reference,
-                type: "device",
-              },
+              source: this.getDeviceMeasureSource(
+                device,
+                deviceMetadataChanges,
+              ),
               target: {
                 assetId: assetId,
                 indexId: engineId,
@@ -206,14 +201,10 @@ export class PayloadService extends BaseService {
             {
               measurements: unlinkedMeasurements,
               payloadUuids: [uuid],
-              source: {
-                deviceMetadata: metadata,
-                id: _id,
-                metadata: deviceMetadataChanges,
-                model: model,
-                reference: reference,
-                type: "device",
-              },
+              source: this.getDeviceMeasureSource(
+                device,
+                deviceMetadataChanges,
+              ),
               target: {
                 assetId: null,
                 indexId: engineId,
@@ -235,8 +226,7 @@ export class PayloadService extends BaseService {
   ) {
     const apiAction = "device-manager/devices:receiveMeasure";
     const {
-      _id,
-      _source: { reference, model, metadata, linkedMeasures, engineId },
+      _source: { model, linkedMeasures, engineId },
     } = device;
 
     // TODO: do we want update a metadata from formatted payload to ?
@@ -260,13 +250,10 @@ export class PayloadService extends BaseService {
           {
             measurements: assetMeasurements,
             payloadUuids,
-            source: {
-              deviceMetadata: metadata,
-              id: _id,
-              model: model,
-              reference: reference,
-              type: "device",
-            },
+            source: this.getDeviceMeasureSource(
+              device,
+              device._source.metadata,
+            ),
             target: {
               assetId: assetId,
               indexId: engineId,
@@ -290,13 +277,10 @@ export class PayloadService extends BaseService {
           {
             measurements: unlinkedMeasurements,
             payloadUuids,
-            source: {
-              deviceMetadata: metadata,
-              id: _id,
-              model: model,
-              reference: reference,
-              type: "device",
-            },
+            source: this.getDeviceMeasureSource(
+              device,
+              device._source.metadata,
+            ),
             target: {
               assetId: null,
               indexId: engineId,
@@ -386,9 +370,7 @@ export class PayloadService extends BaseService {
         updatedDevices.push(...newDevices);
       } else {
         this.app.log.info(
-          `Skipping new devices "${errors.join(
-            ", ",
-          )}". Auto-provisioning is disabled.`,
+          `Skipping new devices "${errors.join(", ")}". Auto-provisioning is disabled.`,
         );
       }
     }
@@ -473,7 +455,9 @@ export class PayloadService extends BaseService {
     const deleted = await this.sdk.bulk.deleteByQuery(
       this.config.platformIndex,
       "payloads",
-      { query: { bool: { filter } } },
+      {
+        query: { bool: { filter } },
+      },
     );
 
     return deleted;
@@ -486,4 +470,21 @@ export class PayloadService extends BaseService {
   ) {
     await this.savePayload(deviceModel, uuidv4(), false, payload, apiAction);
   }
+
+  private getDeviceMeasureSource(
+    device: KDocument<DeviceContent>,
+    deviceMetadataChanges: JSONObject,
+  ): DeviceMeasureSource {
+    const { reference, model, metadata, groups } = device._source;
+
+    return {
+      deviceMetadata: metadata,
+      groups,
+      id: device._id,
+      metadata: deviceMetadataChanges,
+      model: model,
+      reference: reference,
+      type: "device",
+    };
+  }
 }
diff --git a/lib/modules/measure/MeasureService.ts b/lib/modules/measure/MeasureService.ts
@@ -70,8 +70,7 @@ export class MeasureService extends BaseService {
   ) {
     const { id: dataSourceId } = source;
     const { indexId, assetId } = target;
-
-    if (!measurements) {
+    if (!measurements || measurements.length === 0) {
       this.app.log.warn(
         `No measurements provided for "${dataSourceId}" measures ingest`,
       );
diff --git a/lib/modules/measure/MeasureSourcesBuilder.ts b/lib/modules/measure/MeasureSourcesBuilder.ts
@@ -25,11 +25,12 @@ export function deviceSourceToOriginDevice(
   payloadUuids: string[],
   deviceMetadata: Metadata,
 ): MeasureOriginDevice {
-  const { id: dataSourceId, model, reference } = source;
+  const { id: dataSourceId, model, reference, groups } = source;
   return {
     _id: dataSourceId,
     deviceMetadata,
     deviceModel: model,
+    groups,
     measureName,
     payloadUuids,
     reference: reference,
diff --git a/lib/modules/measure/collections/measuresMappings.ts b/lib/modules/measure/collections/measuresMappings.ts
@@ -34,10 +34,7 @@ export const measuresMappings: CollectionMappings = {
         },
         groups: {
           properties: {
-            path: {
-              type: "keyword",
-              fields: { text: { type: "text" } },
-            },
+            path: { type: "keyword", fields: { text: { type: "text" } } },
             date: { type: "date" },
           },
         },
@@ -58,11 +55,13 @@ export const measuresMappings: CollectionMappings = {
             // populated with device models metadata mappings
           },
         },
-
-        apiMetadata: {
-          dynamic: "false",
-          properties: {},
+        groups: {
+          properties: {
+            path: { type: "keyword", fields: { text: { type: "text" } } },
+            date: { type: "date" },
+          },
         },
+        apiMetadata: { dynamic: "false", properties: {} },
 
         payloadUuids: { type: "keyword" },
 
diff --git a/lib/modules/measure/types/MeasureContent.ts b/lib/modules/measure/types/MeasureContent.ts
@@ -45,6 +45,11 @@ export interface MeasureOriginDevice extends AbstractMeasureOrigin {
    */
   deviceMetadata?: Metadata;
 
+  /**
+   * Origin device groups
+   */
+  groups: Array<{ path: string; date: number }>;
+
   /**
    * Device ID
    */
diff --git a/lib/modules/measure/types/MeasureSources.ts b/lib/modules/measure/types/MeasureSources.ts
@@ -12,6 +12,10 @@ export interface DeviceMeasureSource extends AbstractMeasureSource {
   deviceMetadata: Metadata;
   model: string;
   lastMeasuredAt?: number;
+  groups: Array<{
+    path: string;
+    date: number;
+  }>;
 }
 
 export interface ApiMeasureSource extends AbstractMeasureSource {
diff --git a/tests/scenario/migrated/measure-ingestion-pipeline.test.ts b/tests/scenario/migrated/measure-ingestion-pipeline.test.ts
@@ -126,9 +126,7 @@ describe('features/Measure/IngestionPipeline', () => {
   });
 
   it('Should enrich measure with the origin device metadata', async () => {
-    const metadata = {
-      color: 'blue',
-    };
+    const metadata = { color: 'blue' };
 
     await sdk.query({
       controller: 'device-manager/devices',
@@ -186,4 +184,24 @@ describe('features/Measure/IngestionPipeline', () => {
       ],
     });
   });
+
+  it('Should enrich measure with the origin device groups', async () => {
+    await sendPayloads(sdk, 'dummy-temp-position', [
+      { deviceEUI: 'linked2', temperature: 35, location: { lon: 12, lat: 12 } },
+    ]);
+
+    await sdk.collection.refresh('engine-ayse', 'measures');
+
+    const response = await sdk.query({
+      controller: 'document',
+      action: 'search',
+      index: 'engine-ayse',
+      collection: 'measures',
+      body: { query: { term: { 'origin.reference': 'linked2' } } },
+    });
+
+    expect(response.result.hits[0]._source.origin.groups[0]).toMatchObject({
+      path: 'test-parent-asset',
+    });
+  });
 });
