chore(release): '3-dev' into next

Author: sebtiz13

.github/workflows/push-and-pr.workflow.yaml

@@ -5,6 +5,7 @@ on:
     branches:
       - master
       - beta
+      - next
       - "[0-9]+-dev"
   pull_request:
 
@@ -65,7 +66,7 @@ jobs:
   release-device-manager:
     name: Release package
     runs-on: ubuntu-22.04
-    if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/beta' || github.ref == 'refs/heads/2-dev') }}
+    if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/beta'|| github.ref == 'refs/heads/next' || github.ref == 'refs/heads/2-dev') }}
     needs: [functional-tests]
     permissions:
       contents: write

.releaserc.js

@@ -23,7 +23,12 @@ module.exports = {
     },
     {
       name: "2-dev",
-      prerelease: "dev"
-    }
+      prerelease: "dev",
+      range: "2.x",
+    },
+    {
+      name: "next",
+      prerelease: true,
+    },
   ],
 };

doc/2/controllers/models/update-asset/index.md

@@ -22,7 +22,7 @@ Method: PUT
 
 ```js
 {
-  "controller": "device-manager/assets",
+  "controller": "device-manager/models",
   "action": "updateAsset",
   "engineGroup": "<engine group>",
   "model": "<asset model>",

doc/2/controllers/models/write-asset/index.md

@@ -24,7 +24,7 @@ Method: POST
 
 ```js
 {
-  "controller": "device-manager/assets",
+  "controller": "device-manager/models",
   "action": "writeAsset",
   "body": {
     "engineGroup": "<engine group>",
@@ -164,4 +164,3 @@ Method: POST
 | ------------------------------------------------------------------------------ | ------- | --------------------------------------------------- |
 | [ MappingsConflictsError ](../../../errors/mappings-conflicts/index.md)        | **409** | Writing an asset with conflicting metadata mappings |
 | [ MeasuresNamesDuplicatesError ](../../../errors/measures-duplicates/index.md) | **400** | Defining a measure name more than once              |
-

lib/modules/asset/AssetService.ts

@@ -298,6 +298,7 @@ export class AssetService extends DigitalTwinService {
             groups: [],
             lastMeasuredAt: null,
             linkedDevices: [],
+            measureSlots: assetModel.asset.measures,
             measures,
             metadata: { ...assetMetadata, ...metadata },
             model,
@@ -645,6 +646,8 @@ export class AssetService extends DigitalTwinService {
             ...assetMetadata,
           };
 
+          asset._source.measureSlots = assetModel.asset.measures;
+
           acc[asset.index].push(asset as KDocument<AssetContent>);
 
           return acc;

lib/modules/asset/collections/assetsMappings.ts

@@ -52,5 +52,12 @@ export const assetsMappings: CollectionMappings = {
         },
       },
     },
+
+    measureSlots: {
+      properties: {
+        name: { type: "keyword" },
+        type: { type: "keyword" },
+      },
+    },
   },
 };

lib/modules/decoder/PayloadService.ts

@@ -5,6 +5,7 @@ import { v4 as uuidv4 } from "uuid";
 
 import { DeviceContent, DeviceSerializer } from "../device";
 import { AskMeasureIngest, DecodedMeasurement } from "../measure";
+import { AskModelDeviceGet } from "../model";
 import { DeviceManagerPlugin, InternalCollection } from "../plugin";
 import { BaseService } from "../shared";
 
@@ -218,6 +219,13 @@ export class PayloadService extends BaseService {
     deviceIds: string[],
     { refresh }: { refresh: any },
   ): Promise<KDocument<DeviceContent>[]> {
+    const deviceModelContent = await ask<AskModelDeviceGet>(
+      "ask:device-manager:model:device:get",
+      {
+        model: deviceModel,
+      },
+    );
+
     const newDevices = deviceIds.map((deviceId) => {
       // Reference may contains a "-"
       const [, ...rest] = deviceId.split("-");
@@ -227,6 +235,7 @@ export class PayloadService extends BaseService {
         assetId: null,
         engineId: null,
         lastMeasuredAt: 0,
+        measureSlots: deviceModelContent.device.measures,
         measures: {},
         metadata: {},
         model: deviceModel,

lib/modules/device/DeviceService.ts

@@ -1,6 +1,13 @@
 import { BadRequestError, KuzzleRequest } from "kuzzle";
 import { ask, onAsk } from "kuzzle-plugin-commons";
-import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
+import {
+  BaseRequest,
+  DocumentSearchResult,
+  JSONObject,
+  KDocument,
+  KHit,
+  SearchResult,
+} from "kuzzle-sdk";
 
 import { DecodedMeasurement } from "../measure";
 import {
@@ -9,7 +16,11 @@ import {
   AssetModelContent,
   DeviceModelContent,
 } from "../model";
-import { DeviceManagerPlugin, InternalCollection } from "../plugin";
+import {
+  AskEngineList,
+  DeviceManagerPlugin,
+  InternalCollection,
+} from "../plugin";
 import { DigitalTwinService, Metadata, SearchParams, lock } from "../shared";
 import {
   AskAssetHistoryAdd,
@@ -26,6 +37,7 @@ import {
   AskDeviceAttachEngine,
   AskDeviceDetachEngine,
   AskDeviceLinkAsset,
+  AskDeviceRefreshModel,
   AskDeviceUnlinkAsset,
   EventDeviceUpdateAfter,
   EventDeviceUpdateBefore,
@@ -80,6 +92,11 @@ export class DeviceService extends DigitalTwinService {
         await this.attachEngine(engineId, deviceId, request);
       },
     );
+
+    onAsk<AskDeviceRefreshModel>(
+      "ask:device-manager:device:refresh-model",
+      this.refreshModel.bind(this),
+    );
   }
 
   /**
@@ -101,6 +118,7 @@ export class DeviceService extends DigitalTwinService {
         assetId: null,
         engineId: null,
         lastMeasuredAt: 0,
+        measureSlots: [],
         measures: {},
         metadata,
         model,
@@ -112,6 +130,8 @@ export class DeviceService extends DigitalTwinService {
       const deviceModel = await this.getDeviceModel(model);
       const engineId = request.getString("engineId");
 
+      device._source.measureSlots = deviceModel.device.measures;
+
       for (const metadataName of Object.keys(
         deviceModel.device.metadataMappings,
       )) {
@@ -933,4 +953,64 @@ export class DeviceService extends DigitalTwinService {
       model,
     });
   }
+
+  private async refreshModel({
+    deviceModel,
+  }: {
+    deviceModel: DeviceModelContent;
+  }): Promise<void> {
+    const engines = await ask<AskEngineList>("ask:device-manager:engine:list", {
+      group: null,
+    });
+
+    const targets = engines.map((engine) => ({
+      collections: [InternalCollection.DEVICES],
+      index: engine.index,
+    }));
+
+    const devices = await this.sdk.query<
+      BaseRequest,
+      DocumentSearchResult<DeviceContent>
+    >({
+      action: "search",
+      body: { query: { equals: { model: deviceModel.device.model } } },
+      controller: "document",
+      lang: "koncorde",
+      targets,
+    });
+
+    const updatedDevicesPerIndex: Record<string, KDocument<DeviceContent>[]> =
+      devices.result.hits.reduce(
+        (
+          acc: Record<string, KDocument<DeviceContent>[]>,
+          device: JSONObject,
+        ) => {
+          device._source.measureSlots = deviceModel.device.measures;
+
+          acc[device.index].push(device as KDocument<DeviceContent>);
+
+          return acc;
+        },
+        Object.fromEntries(
+          engines.map((engine) => [
+            engine.index,
+            [] as KDocument<DeviceContent>[],
+          ]),
+        ),
+      );
+
+    await Promise.all(
+      Object.entries(updatedDevicesPerIndex).map(([index, updatedDevices]) =>
+        this.sdk.document.mReplace<DeviceContent>(
+          index,
+          InternalCollection.DEVICES,
+          updatedDevices.map((device) => ({
+            _id: device._id,
+            body: device._source,
+          })),
+          { refresh: "wait_for" },
+        ),
+      ),
+    );
+  }
 }

lib/modules/device/collections/deviceMappings.ts

@@ -35,5 +35,11 @@ export const devicesMappings: CollectionMappings = {
       },
     },
     lastMeasuredAt: { type: "date" },
+    measureSlots: {
+      properties: {
+        name: { type: "keyword" },
+        type: { type: "keyword" },
+      },
+    },
   },
 };

lib/modules/device/types/DeviceEvents.ts

@@ -1,6 +1,7 @@
 import { User } from "kuzzle";
 import { KDocument } from "kuzzle-sdk";
 
+import { DeviceModelContent } from "../../../modules/model";
 import { Metadata } from "../../../modules/shared";
 
 import { DeviceContent } from "./DeviceContent";
@@ -68,3 +69,13 @@ export type AskDeviceAttachEngine = {
 
   result: void;
 };
+
+export type AskDeviceRefreshModel = {
+  name: "ask:device-manager:device:refresh-model";
+
+  payload: {
+    deviceModel: DeviceModelContent;
+  };
+
+  result: void;
+};