Fix renaming of values (#2)

* Fix renaming of configured values

Author: waldbaer

examples/Collect Multiple Values.json

@@ -46,7 +46,7 @@
         "name": "",
         "valuesConfig": "bdcc10eee2fc3654",
         "valuesConfigName": "RoomStates",
-        "valueSelect": "DoorOpen",
+        "valueId": "c532de90-a577-11ed-b30d-21918a802e2e",
         "value": "DoorOpen",
         "command": "write",
         "msgProperty": "payload",
@@ -334,13 +334,15 @@
         "name": "RoomStates",
         "values": [
             {
+                "id": "c532de90-a577-11ed-b30d-21918a802e2e",
                 "name": "DoorOpen",
                 "datatype": "bool",
                 "default": false,
                 "scope": "global",
                 "storage": "default"
             },
             {
+                "id": "c538aaf0-a577-11ed-b30d-21918a802e2e",
                 "name": "OpenWindows",
                 "datatype": "num",
                 "default": 3,

examples/Dynamic Command Override.json

@@ -31,7 +31,7 @@
         "name": "",
         "valuesConfig": "bbc8971830771b8e",
         "valuesConfigName": "Room State",
-        "valueSelect": "DoorOpen",
+        "valueId": "a9e87af0-a577-11ed-b30d-21918a802e2e",
         "value": "DoorOpen",
         "command": "write",
         "msgProperty": "payload",
@@ -224,6 +224,7 @@
         "name": "Room State",
         "values": [
             {
+                "id": "a9e87af0-a577-11ed-b30d-21918a802e2e",
                 "name": "DoorOpen",
                 "datatype": "bool",
                 "default": false,

examples/Read and Write.json

@@ -32,7 +32,7 @@
         "name": "",
         "valuesConfig": "7b534a78d263796e",
         "valuesConfigName": "House States",
-        "valueSelect": "LightOn",
+        "valueId": "6459a040-a577-11ed-b30d-21918a802e2e",
         "value": "LightOn",
         "command": "write",
         "msgProperty": "payload",
@@ -241,20 +241,23 @@
         "name": "House States",
         "values": [
             {
+                "id": "6459a040-a577-11ed-b30d-21918a802e2e",
                 "name": "LightOn",
                 "datatype": "bool",
                 "default": false,
                 "scope": "global",
                 "storage": "default"
             },
             {
+                "id": "645fe1d0-a577-11ed-b30d-21918a802e2e",
                 "name": "OpenWindows",
                 "datatype": "num",
                 "default": 0,
                 "scope": "global",
                 "storage": "default"
             },
             {
+                "id": "6465d540-a577-11ed-b30d-21918a802e2e",
                 "name": "NextGarbageCollection",
                 "datatype": "str",
                 "default": "Monday, 2023-01-08",

nodes/persistent-value.html

@@ -40,10 +40,10 @@
 
     defaults: {
       name: {value: ''},
-      valuesConfig: {value: '', type: 'persistent values config'},
-      valuesConfigName: {required: false},
-      valueSelect: {required: true},
-      value: {required: true},
+      valuesConfig: {value: '', type: 'persistent values config'}, // The selected configuration (ID)
+      valuesConfigName: {required: false}, // Name of the selected configuration
+      valueId: {required: false}, // ID of the selected value
+      value: {required: true}, // Name of the selected value
       command: {value: kCommandDefault, required: true},
       msgProperty: {value: 'payload', required: false},
       collectValues: {value: false, required: false},
@@ -83,8 +83,9 @@
       const valuesConfigField = $('#node-input-valuesConfig');
       const valuesConfigNameField = $('#node-input-valuesConfigName');
 
-      const valueSelectField = $('#node-input-valueSelect');
+      const valueIdField = $('#node-input-valueId');
       const valueField = $('#node-input-value');
+      const valueSelectField = $('#valueSelect'); // Drop-down
 
       const commandField = $('#node-input-command');
       const msgPropertyField = $('#node-input-msgProperty');
@@ -102,44 +103,69 @@
       // Initialize all possible types of compare value field. Concrete type dynamically switched based on config.
       blockIfCompareValueField.typedInput({type: 'str', types: ['str', 'num', 'bool']});
 
-      // Store current configured value name before drop-down repopulation
-      const currentSelectedValue = valueField.val();
+      const node = this; // Store access to node configuration itself
 
       valueSelectField.on('change', function() {
         const selected = $(this).find('option:selected');
 
         // Ignore re-population change
         if (selected.val() !== undefined) {
-          // Store actual selected value
-          valueField.val(selected.val());
+          // Store actual selected value ID and name
+          const selected_id = selected.data('id');
+          if(selected_id !== 'undefined') {
+            node.valueId = selected_id;
+            valueIdField.val(node.valueId);
+          }
+
+          node.value = selected.val();
+          valueField.val(node.value);
 
           // Switch datatype of blockIf compare value input field
           const selectedDatatype = selected.data('datatype');
           blockIfCompareValueField.typedInput('type', selectedDatatype);
           blockIfCompareValueField.typedInput('types', [selectedDatatype]);
+        } else {
+          node.valueId = undefined;
+          valueIdField.val(node.valueId);
+
+          node.value = selected.val();
+          valueField.val(node.value);
         }
       });
 
       // Initially change triggered by editor loaded, later with every user interaction.
       valuesConfigField.on('change', async function() {
         const selectedConfigId = $(this).val();
-        backendConfig = await getConfigFromBackend(selectedConfigId);
-        // Store current selected configuration name
-        valuesConfigNameField.val(backendConfig.name);
-
-        // Re-populate select widget
-        valueSelectField.empty();
-        for (const value of backendConfig.values) {
-          const optionText = `${value.name} [${value.datatype}, ${value.storage}]`;
-          valueSelectField.append(`<option value="${value.name}" data-datatype="${value.datatype}">${optionText}</option>`);
-        }
+        if (selectedConfigId !== '_ADD_') { // Skip if "add new config" is selected
+          backendConfig = await getConfigFromBackend(selectedConfigId);
+          // Store current selected configuration name
+          valuesConfigNameField.val(backendConfig.name);
+
+          // Re-populate value select widget
+          valueSelectField.empty();
+          for (const value of backendConfig.values) {
+            const optionText = `${value.name} [${value.datatype}, ${value.storage}]`;
+            valueSelectField.append(
+              `<option value="${value.name}" data-id="${value.id}" data-datatype="${value.datatype}">${optionText}</option>`);
+          }
 
-        // Select the previously selected value or set to invalid if the value is not known anymore
-        if (backendConfig.values.find((value) => value.name === currentSelectedValue)) {
-          valueSelectField.val(currentSelectedValue).change();
-        } else {
-          valueSelectField.val([]);
-          valueField.val(null);
+          // Select the previously selected value or set to invalid if the value is not known anymore
+          if (node.valueId) {
+            const selectedValue = backendConfig.values.find((value) => value.id === node.valueId);
+            if (selectedValue) {
+              $(`#valueSelect option[data-id="${selectedValue.id}"]`).attr('selected', true).trigger('change');
+            } else {
+              valueSelectField.val([]).trigger('change');
+            }
+          } else {
+            // Until version 1.1.0 no ID was existing for every value. Therefore search via value name.
+            const selectedValue = backendConfig.values.find((value) => value.name === node.value);
+            if (selectedValue) {
+              valueSelectField.val(selectedValue.name).trigger('change');
+            } else {
+              valueSelectField.val([]).trigger('change');
+            }
+          }
         }
       });
 
@@ -191,10 +217,12 @@
     <input type="hidden" id="node-input-valuesConfigName">
   </div>
   <div class="form-row">
-    <label for="node-input-valueSelect"><i class="fa fa-adjust"></i> Value</label>
+    <label for="node-input-value"><i class="fa fa-adjust"></i> Value</label>
     <!-- Classic select widget instead of NodeRED TypedInput used due to missing re-population capabiltiy -->
-    <select id="node-input-valueSelect"></select>
+    <select id="valueSelect"></select>
     <!-- Store the actually selected value in a hidden field. Required due to dynamic drop-down repopulation -->
+    <input type="hidden" id="node-input-valueId">
+    <!-- Store the actually selected value name in a hidden field. Required for node label creation -->
     <input type="hidden" id="node-input-value">
   </div>
   <div class="form-row">

nodes/persistent-value.js

@@ -1,4 +1,6 @@
 module.exports = function(RED) {
+  const uuid = require('uuid');
+
   // ---- elements of the reference config ----
 
   // Datatypes defined by TypedInput widget
@@ -43,7 +45,7 @@ module.exports = function(RED) {
   }
 
   function buildNodeStatus(node, msgProperty, blockFlow) {
-    let storage = node.config.storage;
+    let storage = node.valueConfig.storage;
     if (storage === kStorageDefault) {
       if (RED.settings.contextStorage !== undefined && RED.settings.contextStorage.default !== undefined) {
         storage += ` (${RED.settings.contextStorage.default})`;
@@ -53,7 +55,7 @@ module.exports = function(RED) {
     node.status({
       fill: `${blockFlow ? 'red' : 'green'}`,
       shape: 'dot',
-      text: `${msgProperty} [${kSupportedDatatypesByTypedInput[node.config.datatype]},${node.config.scope},${storage}]`,
+      text: `${msgProperty} [${kSupportedDatatypesByTypedInput[node.valueConfig.datatype]},${node.valueConfig.scope},${storage}]`,
     });
   }
 
@@ -81,10 +83,10 @@ module.exports = function(RED) {
 
   function getUsedContext(node) {
     let context = node.context();
-    if (node.config.scope === 'flow') {
+    if (node.valueConfig.scope === 'flow') {
       context = context.flow;
     }
-    if (node.config.scope === 'global') {
+    if (node.valueConfig.scope === 'global') {
       context = context.global;
     }
     return context;
@@ -98,24 +100,24 @@ module.exports = function(RED) {
 
   function getContext(node, context, contextKey) {
     let currentValue = undefined;
-    if (node.config.storage === kStorageDefault) {
+    if (node.valueConfig.storage === kStorageDefault) {
       currentValue = context.get(contextKey);
     } else {
-      currentValue = context.get(contextKey, node.config.storage);
+      currentValue = context.get(contextKey, node.valueConfig.storage);
     }
 
     // Apply default value if context contains no value
     if (currentValue === undefined) {
-      currentValue = node.config.default;
+      currentValue = node.valueConfig.default;
     }
     return currentValue;
   }
 
   function setContext(node, context, contextKey, newValue) {
-    if (node.config.storage === kStorageDefault) {
+    if (node.valueConfig.storage === kStorageDefault) {
       context.set(contextKey, newValue);
     } else {
-      context.set(contextKey, newValue, node.config.storage);
+      context.set(contextKey, newValue, node.valueConfig.storage);
     }
   }
 
@@ -134,7 +136,7 @@ module.exports = function(RED) {
 
   function convertToExpectedType(node, value) {
     let convertedValue = undefined;
-    switch (node.config.datatype) {
+    switch (node.valueConfig.datatype) {
     case kConfigDatatypeBool:
       if (value === 'true') {
         convertedValue = true;
@@ -156,11 +158,11 @@ module.exports = function(RED) {
       }
       break;
     default:
-      node.error(`Unsupported compare value type '${node.config.datatype}' configured!`);
+      node.error(`Unsupported compare value type '${node.valueConfig.datatype}' configured!`);
     }
 
     if (convertedValue === undefined) {
-      node.error(`Failed to convert value '${value}' to expected datatype '${node.config.datatype}'!`);
+      node.error(`Failed to convert value '${value}' to expected datatype '${node.valueConfig.datatype}'!`);
     }
 
     return convertedValue;
@@ -169,7 +171,7 @@ module.exports = function(RED) {
   function compareToConfiguredDatatype(node, value) {
     const typeOfValue = typeof value;
     return kSupportedDatatypesLanguageType.hasOwnProperty(typeOfValue) &&
-           (kSupportedDatatypesLanguageType[typeOfValue] === node.config.datatype);
+           (kSupportedDatatypesLanguageType[typeOfValue] === node.valueConfig.datatype);
   }
 
   function checkBlockIfCondition(node, currentValue) {
@@ -213,14 +215,28 @@ module.exports = function(RED) {
       return null;
     }
 
-    node.config = configNode.values.find((value) => value.name === nodeConfig.value);
-    node.configName = configNode.name; // Name of the referenced configuration
-    node.value = nodeConfig.value; // selected value
-    if (node.value === '' || node.value === undefined || node.value === null) {
+    // Selected value by ID or name
+    node.valueId = nodeConfig.valueId;
+    node.value = nodeConfig.value;
+    if (node.valueId !== undefined && !uuid.validate(node.valueId)) {
+      reportIncorrectConfiguration(node);
+      return null;
+    }
+    // Selectd value must be referenced via ID or name (deprecated)
+    if (node.valueId === undefined && (node.value === undefined)) {
       reportIncorrectConfiguration(node);
       return null;
     }
 
+    node.configName = configNode.name; // Name of the referenced configuration
+    if (node.valueId) {
+      node.valueConfig = configNode.values.find((value) => value.id === node.valueId);
+      node.value = node.valueConfig.name; // Update name again in case of inconsistent value / ID config
+    } else {
+      // Until version 1.1.0 no ID was existing for every value. Therefore search via value name.
+      node.valueConfig = configNode.values.find((value) => value.name === node.value);
+    }
+
     node.command = nodeConfig.command || kCommandDefault;
     node.msgProperty = nodeConfig.msgProperty || kMsgPropertyDefault;
 
@@ -241,7 +257,7 @@ module.exports = function(RED) {
       let currentValue = getContext(node, context, contextKey);
       if (!compareToConfiguredDatatype(node, currentValue)) {
         node.warn(`Persisted value ${node.configName} / ${node.value} does not have the configured datatype ` +
-                  `'${node.config.datatype}'!`);
+                  `'${node.valueConfig.datatype}'!`);
       }
 
       let onChangeMsg = null;
@@ -265,7 +281,7 @@ module.exports = function(RED) {
 
         if (!compareToConfiguredDatatype(node, inputValue)) {
           node.error(`Passed value in msg.${node.msgProperty} does not have the configured datatype ` +
-                     `'${node.config.datatype}'! Persistent value config: ${node.configName} / ${node.value}`);
+                     `'${node.valueConfig.datatype}'! Persistent value config: ${node.configName} / ${node.value}`);
           return;
         }