Merge pull request #264 from kuzzleio/2.1.0-proposal

# [2.1.0](https://github.com/kuzzleio/kuzzle-device-manager/releases/tag/2.1.0) (2023-02-07)


#### Bug fixes

- [ [#263](#263) ] Imports roles, profiles and users before Kuzzle starts   ([Aschen](https://github.com/Aschen))

#### New features

- [ [#262](#262) ] Add action to directly send formated measure a device   ([Aschen](https://github.com/Aschen))
---

Author: Aschen

features/Decoder/DefaultRights.feature

@@ -1,11 +1,6 @@
 Feature: Device Manager Decoders
 
   Scenario: Creates default roles, profiles and users
-    Then I am able to get a role with id "payload_gateway.dummy_temp"
-    Then I am able to get a role with id "payload_gateway.dummy_temp_position"
-    Then I am able to get a profile with id "payload_gateway.dummy_temp"
-    Then I am able to get a profile with id "payload_gateway.dummy_temp_position"
+    Then I am able to get a role with id "payload_gateway"
     Then I am able to get a profile with id "payload_gateway"
-    Then The user "payload_gateway.dummy_temp" exists
-    Then The user "payload_gateway.dummy_temp_position" exists
     Then The user "payload_gateway" exists

lib/core/DeviceManagerPlugin.ts

@@ -28,7 +28,7 @@ import {
   ModelModule,
   modelsMappings,
 } from "../modules/model";
-import { lock, KuzzleRole } from "../modules/shared";
+import { lock } from "../modules/shared";
 
 import { DeviceManagerConfiguration } from "./DeviceManagerConfiguration";
 import { DeviceManagerEngine } from "./DeviceManagerEngine";
@@ -38,7 +38,6 @@ import { ModelsRegister } from "./registers/ModelsRegister";
 
 export class DeviceManagerPlugin extends Plugin {
   public config: DeviceManagerConfiguration;
-  public roles: KuzzleRole[] = [];
 
   private deviceManagerEngine: DeviceManagerEngine;
   private adminConfigManager: ConfigManager;
@@ -160,7 +159,7 @@ export class DeviceManagerPlugin extends Plugin {
 
   constructor() {
     super({
-      kuzzleVersion: ">=2.19.5 <3",
+      kuzzleVersion: ">=2.20.2 <3",
     });
 
     /* eslint-disable sort-keys */
@@ -172,6 +171,12 @@ export class DeviceManagerPlugin extends Plugin {
       "generic:document:beforeDelete": [],
     };
     this.hooks = {};
+    this.imports = {
+      roles: {},
+      users: {},
+      profiles: {},
+      onExistingUsers: "skip",
+    };
 
     this.config = {
       ignoreStartupErrors: false,
@@ -244,7 +249,7 @@ export class DeviceManagerPlugin extends Plugin {
     await this.measureModule.init();
     await this.modelModule.init();
 
-    this.decodersRegister.init(this.context);
+    this.decodersRegister.init(this, this.context);
     this.modelsRegister.init(this);
 
     this.adminConfigManager = new ConfigManager(this, {
@@ -282,21 +287,7 @@ export class DeviceManagerPlugin extends Plugin {
       this.deviceManagerEngine
     );
 
-    this.hooks["kuzzle:state:live"] = async () => {
-      try {
-        await this.decodersRegister.createDefaultRights();
-        await this.createDefaultRoles();
-      } catch (error) {
-        if (this.config.ignoreStartupErrors) {
-          this.context.log.warn(
-            `WARNING: An error occured during plugin initialization: ${error.message}`
-          );
-        } else {
-          throw error;
-        }
-      }
-    };
-
+    this.decodersRegister.registerDefaultRights();
     this.decodersRegister.printDecoders();
 
     try {
@@ -318,18 +309,6 @@ export class DeviceManagerPlugin extends Plugin {
     }
   }
 
-  private async createDefaultRoles() {
-    const promises = [];
-
-    for (const role of this.roles) {
-      promises.push(
-        this.sdk.security.createOrReplaceRole(role.name, role.definition)
-      );
-    }
-
-    await Promise.all(promises);
-  }
-
   /**
    * Initialize the administration index of the plugin
    */

lib/core/registers/DecodersRegister.ts

@@ -4,12 +4,13 @@ import {
   PluginContext,
   PluginImplementationError,
 } from "kuzzle";
-import { snakeCase } from "../../modules/shared";
 
 import { Decoder, DecoderContent } from "../../modules/decoder";
+import { DeviceManagerPlugin } from "..";
 
 export class DecodersRegister {
   private context: PluginContext;
+  private plugin: DeviceManagerPlugin;
 
   /**
    * Map<deviceModel, Decoder>
@@ -24,7 +25,8 @@ export class DecodersRegister {
     return Array.from(this._decoders.values());
   }
 
-  init(context: PluginContext) {
+  init(plugin: DeviceManagerPlugin, context: PluginContext) {
+    this.plugin = plugin;
     this.context = context;
   }
 
@@ -88,117 +90,50 @@ export class DecodersRegister {
   }
 
   /**
-   * Creates default roles, profiles and users associated to the generated actions
+   * Register default role, profile and user associated to the generated actions
    * in the Payload controller.
-   *
-   * This method never returns a rejected promise.
    */
-  async createDefaultRights() {
+  registerDefaultRights() {
     if (this.decoders.length === 0) {
       return;
     }
 
-    await this.createDefaultRoles();
-
-    await this.createDefaultProfiles();
+    this.registerDefaultRole();
 
-    await this.createDefaultUsers();
+    this.registerDefaultProfile();
 
-    this.context.log.info(
-      "Default rights for payload controller has been registered."
-    );
+    this.registerDefaultUser();
   }
 
-  private async createDefaultUsers() {
-    const promises = [];
+  private registerDefaultUser() {
     const gatewayUser = {
       content: {
-        profileIds: [],
+        profileIds: ["payload_gateway"],
       },
     };
 
-    for (const decoder of this.decoders) {
-      const userId = `payload_gateway.${snakeCase(decoder.action)}`;
-      const user = {
-        content: {
-          // each created user has only the profile of the same name
-          profileIds: [userId],
-        },
-      };
-
-      gatewayUser.content.profileIds.push(userId);
-
-      promises.push(
-        this.sdk.security.createUser(userId, user).catch((error) => {
-          if (error.id !== "security.user.already_exists") {
-            throw error;
-          }
-          return this.sdk.security.updateUser(userId, user);
-        })
-      );
-    }
-
-    promises.push(
-      this.sdk.security
-        .createUser("payload_gateway", gatewayUser)
-        .catch((error) => {
-          if (error.id !== "security.user.already_exists") {
-            throw error;
-          }
-          return this.sdk.security.updateUser("payload_gateway", gatewayUser);
-        })
-    );
-
-    await Promise.all(promises);
+    this.plugin.imports.users.payload_gateway = gatewayUser;
   }
 
-  private async createDefaultProfiles() {
-    const promises = [];
+  private registerDefaultProfile() {
     const gatewayProfile = {
-      policies: [],
+      policies: [{ roleId: "payload_gateway" }],
     };
 
-    for (const decoder of this.decoders) {
-      const profileId = `payload_gateway.${snakeCase(decoder.action)}`;
-      const profile = {
-        // each created profile has only the role of the same name
-        policies: [{ roleId: profileId }],
-      };
-
-      gatewayProfile.policies.push({ roleId: profileId });
-      promises.push(
-        this.sdk.security.createOrReplaceProfile(profileId, profile)
-      );
-    }
-
-    promises.push(
-      this.sdk.security.createOrReplaceProfile(
-        "payload_gateway",
-        gatewayProfile
-      )
-    );
-
-    await Promise.all(promises);
+    this.plugin.imports.profiles.payload_gateway = gatewayProfile;
   }
 
-  private async createDefaultRoles() {
-    const promises = [];
-
-    for (const decoder of this.decoders) {
-      const roleId = `payload_gateway.${snakeCase(decoder.action)}`;
-      const role = {
-        controllers: {
-          "device-manager/payloads": {
-            actions: {
-              [decoder.action]: true,
-            },
+  private registerDefaultRole() {
+    const role = {
+      controllers: {
+        "device-manager/payloads": {
+          actions: {
+            "*": true,
           },
         },
-      };
-
-      promises.push(this.sdk.security.createOrReplaceRole(roleId, role));
-    }
+      },
+    };
 
-    await Promise.all(promises);
+    this.plugin.imports.roles.payload_gateway = role;
   }
 }

lib/modules/asset/AssetModule.ts

@@ -18,7 +18,9 @@ export class AssetModule extends Module {
 
     this.plugin.api["device-manager/assets"] = this.assetController.definition;
 
-    this.plugin.roles.push(RoleAssetsAdmin);
-    this.plugin.roles.push(RoleAssetsReader);
+    this.plugin.imports.roles[RoleAssetsAdmin.name] =
+      RoleAssetsAdmin.definition;
+    this.plugin.imports.roles[RoleAssetsReader.name] =
+      RoleAssetsReader.definition;
   }
 }

lib/modules/decoder/DecoderModule.ts

@@ -34,7 +34,9 @@ export class DecoderModule extends Module {
     this.plugin.api["device-manager/payloads"] =
       this.payloadsController.definition;
 
-    this.plugin.roles.push(RoleDecodersAdmin);
-    this.plugin.roles.push(RolePayloadsAll);
+    this.plugin.imports.roles[RoleDecodersAdmin.name] =
+      RoleDecodersAdmin.definition;
+    this.plugin.imports.roles[RolePayloadsAll.name] =
+      RolePayloadsAll.definition;
   }
 }