iobroker.alpha-ess 0.4.0 → 0.5.0

package/README.md

@@ -37,6 +37,10 @@ The password is stored encrypted and must therefore be entered manually: demo
 **All product and company names or logos are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them or any associated subsidiaries! This personal project is maintained in spare time and has no business goal.**
 
 ## Changelog
+### 0.5.0 (2023-03-05)
+* (Gaspode) Remove no more supported states at startup automatically
+* (Gaspode) Prepared data migration for future versions
+
 ### 0.4.0 (2023-02-16)
 * (Gaspode) Optimized deletion of group states
 * (Gaspode) Added new Realtime state for pmeter_dc

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "alpha-ess",
-    "version": "0.4.0",
+    "version": "0.5.0",
     "news": {
+      "0.5.0": {
+        "en": "Remove no more supported states at startup automatically\nPrepared data migration for future versions",
+        "de": "Entfernen Sie keine unterstützten Zustände beim Start automatisch\nVorbereitete Datenmigration für zukünftige Versionen",
+        "ru": "Удалить больше не поддерживаемых состояний при запуске автоматически\nПодготовленная миграция данных для будущих версий",
+        "pt": "Remover estados não mais suportados na inicialização automaticamente\nMigração de dados preparada para versões futuras",
+        "nl": "Verwijder geen ondersteunende staten bij start-up automatisch\nVertaling:",
+        "fr": "Enlever plus d'états supportés au démarrage automatiquement\nMigration de données préparée pour les versions futures",
+        "it": "Non rimuovere più stati supportati all'avvio automaticamente\nMigrazione dei dati preparata per le versioni future",
+        "es": "Eliminar no más estados compatibles en el inicio automáticamente\nMigración de datos preparada para futuras versiones",
+        "pl": "Remove nie będzie więcej wspieranych państw\nWstępna migracja danych do przyszłych wersji",
+        "uk": "Видаліть не більше підтримуваних держав при запуску автоматично\nПідготовка міграції даних для майбутніх версій",
+        "zh-cn": "自动取消不再支持的开办国家\n今后版本的准备数据迁移"
+      },
       "0.4.0": {
         "en": "Optimized deletion of group states\nAdded new Realtime state for pmeter_dc",
         "de": "Optimiertes Löschen von Gruppenzuständen\nNeuer Realtime-Zustand für pmeter_dc hinzugefügt",
@@ -80,19 +93,6 @@
         "pl": "Zmniejszenie żądań dotyczących trwałych błędów",
         "uk": "Повільні запити у разі постійних помилок",
         "zh-cn": "长期错误请求下降"
-      },
-      "0.0.6-beta.4": {
-        "en": "Changed adapter type from metering to energy",
-        "de": "Geänderter Adaptertyp von der Dosierung bis zur Energie",
-        "ru": "Измененный тип адаптера от измерения до энергии",
-        "pt": "Tipo de adaptador alterado de medição para energia",
-        "nl": "Veranderde adapter type van meting naar energie",
-        "fr": "Type d'adaptateur modifié de mesure à énergie",
-        "it": "Tipo di adattatore modificato dalla misurazione all'energia",
-        "es": "Tipo de adaptador cambiado de medición a energía",
-        "pl": "Zmienił adapter typu z metrowania do energii",
-        "uk": "Змінений тип адаптера від вимірювальної енергії",
-        "zh-cn": "能源参数的变量"
       }
     },
     "titleLang": {

package/main.js

@@ -626,6 +626,9 @@ class AlphaEss extends utils.Adapter {
             RefreshToken: ''
         };
 
+        this.setObjectNormalAsync = this.setObjectNotExistsAsync.bind(this);
+        this.setObjectMigrationAsync = this.setObjectAsync.bind(this);
+
         this.createdStates = [];
 
         this.errorCount = 0;
@@ -658,24 +661,42 @@ class AlphaEss extends utils.Adapter {
             this.log.debug('config updateUnchangedStates:            ' + this.config.updateUnchangedStates);
             this.wrongCredentials = false;
 
+            await this.setObjectNotExistsAsync('info.version', {
+                type: 'state',
+                common: {
+                    name: 'Adapter Version'
+                    , type: 'string'
+                    , role: 'value'
+                    , read: true
+                    , write: false
+                },
+                native: {},
+            });
+
+            if (await this.isMigrationNecessary()) {
+                this.log.info('States will be migrated.');
+            }
+
             await this.resetAuth();
 
             if (this.config.password && this.config.username && this.config.systemId) {
 
                 for (const gidx of Object.keys(this.stateInfoList)) {
-                    const stateInfo = this.stateInfoList[gidx];
-                    if (this.config[stateInfo.enabledName]) {
-                        await stateInfo.fnct(stateInfo.Group);
+                    const groupInfo = this.stateInfoList[gidx];
+                    if (this.config[groupInfo.enabledName]) {
+                        await groupInfo.fnct(groupInfo.Group);
                     }
                     else {
-                        this.log.info(stateInfo.Group + ' data disabled! Adapter won\'t fetch ' + stateInfo.Group + ' data. According states deleted.');
-                        await this.delObjectAsync(stateInfo.Group, { recursive: true });
+                        this.log.info(groupInfo.Group + ' data disabled! Adapter won\'t fetch ' + groupInfo.Group + ' data. According states deleted.');
+                        await this.delObjectAsync(groupInfo.Group, { recursive: true });
                     }
                 }
             }
             else {
                 this.log.error('No username, password and/or system ID set! Adapter won\'t fetch any data.');
             }
+
+            await this.setStateAsync('info.version', this.version, true);
         }
         catch (e) {
             this.log.error('onReady Exception occurred: ' + e);
@@ -961,6 +982,26 @@ class AlphaEss extends utils.Adapter {
         }
     }
 
+    /**
+     * Answer if the states shall be migrated, i.e. overwritten.
+     * This is called a view times at startup only.
+     */
+    async isMigrationNecessary() {
+        const oldVersionState = await this.getStateAsync('info.version');
+        if (oldVersionState) {
+            const oldVersion = '' + oldVersionState.val;
+            const vParts = oldVersion.split('.');
+            if (vParts.length >= 3) {
+                const major = Number.parseInt(vParts[0]);
+                const minor = Number.parseInt(vParts[1]);
+                if (major == 0 && minor > 4 || major > 0) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
     /**
      * Create states when called the first time, update state values in each call
      * @param {string} group
@@ -971,20 +1012,41 @@ class AlphaEss extends utils.Adapter {
             if (data) {
                 const idx = new Date().getDate() - 1;
 
-                await this.setObjectNotExistsAsync(group, {
-                    type: 'folder',
-                    common: {
-                        name: group
-                        , read: true
-                        , write: false
-                    },
-                    native: {}
-                });
-                for (const [alphaAttrName, rawValue] of Object.entries(data)) {
-                    const stateInfo = this.getStateInfo(group, alphaAttrName);
-                    if (stateInfo) {
-                        if (!this.createdStates[group]) {
-                            await this.setObjectNotExistsAsync(group + '.' + this.osn(stateInfo.id), {
+                if (!this.createdStates[group]) {
+
+                    // Delete no longer supported states for this group
+                    const gidx = this.stateInfoList.findIndex(i => i.Group == group);
+                    if (gidx >= 0) {
+                        const groupStateList = this.stateInfoList[gidx].states;
+                        const states = await this.getStatesAsync(group + '.*');
+                        for (const sid in states) {
+                            const parts = sid.split('.');
+                            const id = parts[parts.length - 1];
+                            if (groupStateList.findIndex(i => i.id == id) == -1) {
+                                this.log.info('State ' + group + '.' + id + ' removed, no longer supported.');
+                                await this.delObjectAsync(group + '.' + id);
+                            }
+                        }
+                    }
+
+                    const setObjectFunc = await this.isMigrationNecessary() ? this.setObjectMigrationAsync : this.setObjectNormalAsync;
+
+                    // Create the folder for this group
+                    await setObjectFunc(group, {
+                        type: 'folder',
+                        common: {
+                            name: group
+                            , read: true
+                            , write: false
+                        },
+                        native: {}
+                    });
+
+                    // Create all states for received elements
+                    for (const [alphaAttrName, rawValue] of Object.entries(data)) {
+                        const stateInfo = this.getStateInfo(group, alphaAttrName);
+                        if (stateInfo) {
+                            await setObjectFunc(group + '.' + this.osn(stateInfo.id), {
                                 type: 'state',
                                 common: {
                                     name: stateInfo.name + ' [' + stateInfo.alphaAttrName + ']'
@@ -999,6 +1061,18 @@ class AlphaEss extends utils.Adapter {
                                 native: {},
                             });
                         }
+                        else {
+                            this.log.debug('Skipped object ' + group + '.' + alphaAttrName + ' with value ' + rawValue);
+                        }
+                    }
+                    this.log.info('Initialized states for : ' + group);
+                    this.createdStates[group] = true;
+                }
+
+                // Set values for received states
+                for (const [alphaAttrName, rawValue] of Object.entries(data)) {
+                    const stateInfo = this.getStateInfo(group, alphaAttrName);
+                    if (stateInfo) {
                         let value = '';
                         if (stateInfo.dayIndex) {
                             value = rawValue[idx];
@@ -1032,7 +1106,6 @@ class AlphaEss extends utils.Adapter {
                             default:
                                 tvalue = value;
                         }
-
                         if (this.config.updateUnchangedStates) {
                             await this.setStateAsync(group + '.' + this.osn(stateInfo.id), tvalue, true);
                         }
@@ -1041,15 +1114,6 @@ class AlphaEss extends utils.Adapter {
                         }
                         this.log.debug('Received object ' + group + '.' + this.osn(stateInfo.alphaAttrName) + ' with value ' + rawValue);
                     }
-                    else {
-                        if (!this.createdStates[group]) {
-                            this.log.info('Skipped object ' + group + '.' + alphaAttrName + ' with value ' + rawValue);
-                        }
-                    }
-                }
-                if (!this.createdStates[group]) {
-                    this.log.info('Created states for : ' + group);
-                    this.createdStates[group] = true;
                 }
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.alpha-ess",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Read and write data from and to Alpha ESS systems.",
   "author": {
     "name": "Gaspode",
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@iobroker/adapter-core": "^2.6.7",
-    "axios": "^1.3.0"
+    "axios": "^1.3.4"
   },
   "devDependencies": {
     "@alcalzone/release-script": "^3.5.9",
@@ -33,13 +33,13 @@
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.11.18",
+    "@types/node": "^18.14.2",
     "@types/proxyquire": "^1.3.28",
     "@types/sinon": "^10.0.13",
     "@types/sinon-chai": "^3.2.9",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^8.33.0",
+    "eslint": "^8.35.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.2.1",
     "mocha": "^10.2.0",