@iobroker/json-config 8.3.12 → 8.4.0

package/build/JsonConfigComponent/ConfigGeneric.js

@@ -24,6 +24,7 @@ export default class ConfigGeneric extends Component {
     sendToTimeout;
     noPlaceRequired;
     reportedHidden = false;
+    calculateTimeout = null;
     constructor(props) {
         super(props);
         // @ts-expect-error of course, as we just
@@ -35,24 +36,30 @@ export default class ConfigGeneric extends Component {
             confirmCallback: null,
         };
         this.isError = {};
+        this.lang = I18n.getLanguage();
+        // Initialize literal defaults synchronously so the first render has them.
+        // defaultFunc is evaluated asynchronously in componentDidMount.
         if (props.schema) {
             if (props.custom) {
-                this.defaultValue = props.schema.defaultFunc
-                    ? this.executeCustom(props.schema.defaultFunc, props.data, props.customObj, props.oContext.instanceObj, props.arrayIndex, props.globalData)
-                    : props.schema.default;
+                if (!props.schema.defaultFunc) {
+                    this.defaultValue = props.schema.default;
+                }
             }
-            else if (props.schema.type !== 'state') {
-                this.defaultValue = props.schema.defaultFunc
-                    ? this.execute(props.schema.defaultFunc, props.schema.default, props.data, props.arrayIndex, props.globalData)
-                    : props.schema.default;
+            else if (props.schema.type !== 'state' && !props.schema.defaultFunc) {
+                this.defaultValue = props.schema.default;
             }
         }
-        this.lang = I18n.getLanguage();
     }
-    componentDidMount() {
-        if (this.props.oContext.registerOnForceUpdate) {
-            this.props.oContext.registerOnForceUpdate(this.props.attr, this.onUpdate);
+    async componentDidMount() {
+        if (this.props.schema?.defaultFunc) {
+            if (this.props.custom) {
+                this.defaultValue = await this.executeCustom(this.props.schema.defaultFunc, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData);
+            }
+            else if (this.props.schema.type !== 'state') {
+                this.defaultValue = await this.execute(this.props.schema.defaultFunc, this.props.schema.default, this.props.data, this.props.arrayIndex, this.props.globalData);
+            }
         }
+        this.props.oContext.registerOnForceUpdate?.(this.props.attr, this.onUpdate);
         const LIKE_SELECT = ['select', 'autocomplete', 'autocompleteSendTo'];
         // init default value
         if (this.defaultValue !== undefined) {
@@ -71,15 +78,15 @@ export default class ConfigGeneric extends Component {
             }
         }
         else if (this.props.schema.defaultSendTo) {
-            this.sendTo();
+            this.sendTo().catch(e => console.error(e));
         }
     }
-    sendTo() {
+    async sendTo() {
         if (this.props.alive) {
             this.defaultSendToDone = true;
             let data = this.props.schema.data;
             if (data === undefined && this.props.schema.jsonData) {
-                const dataStr = this.getPattern(this.props.schema.jsonData, null, true);
+                const dataStr = await this.getPatternAsync(this.props.schema.jsonData, null, true);
                 try {
                     data = JSON.parse(dataStr);
                 }
@@ -126,6 +133,10 @@ export default class ConfigGeneric extends Component {
             clearTimeout(this.sendToTimeout);
             this.sendToTimeout = null;
         }
+        if (this.calculateTimeout) {
+            clearTimeout(this.calculateTimeout);
+            this.calculateTimeout = null;
+        }
     }
     onUpdate = (data) => {
         const value = ConfigGeneric.getValue(data || this.props.data, this.props.attr) || '';
@@ -351,12 +362,12 @@ export default class ConfigGeneric extends Component {
      * @param newValue new value of the attribute
      * @param cb optional callback function, else returns a Promise
      */
-    onChange(attr, newValue, cb) {
+    async onChange(attr, newValue, cb) {
         // Do not use here deep copy, as it is not JsonConfig
         const data = JSON.parse(JSON.stringify(this.props.data));
         ConfigGeneric.setValue(data, attr, newValue);
         if (this.props.schema.confirm &&
-            this.execute(this.props.schema.confirm.condition, false, data, this.props.arrayIndex, this.props.globalData)) {
+            (await this.execute(this.props.schema.confirm.condition, false, data, this.props.arrayIndex, this.props.globalData))) {
             return new Promise(resolve => {
                 this.setState({
                     confirmDialog: true,
@@ -379,7 +390,7 @@ export default class ConfigGeneric extends Component {
                 const dep = this.props.schema.confirmDependsOn[z];
                 if (dep.confirm) {
                     const val = ConfigGeneric.getValue(data, dep.attr);
-                    if (this.execute(dep.confirm.condition, false, data, this.props.arrayIndex, this.props.globalData)) {
+                    if (await this.execute(dep.confirm.condition, false, data, this.props.arrayIndex, this.props.globalData)) {
                         return new Promise(resolve => {
                             this.setState({
                                 confirmDialog: true,
@@ -409,10 +420,10 @@ export default class ConfigGeneric extends Component {
                     const val = ConfigGeneric.getValue(data, dep.attr);
                     let _newValue;
                     if (this.props.custom) {
-                        _newValue = this.executeCustom(dep.onChange.calculateFunc, data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData);
+                        _newValue = await this.executeCustom(dep.onChange.calculateFunc, data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData);
                     }
                     else {
-                        _newValue = this.execute(dep.onChange.calculateFunc, val, data, this.props.arrayIndex, this.props.globalData);
+                        _newValue = await this.execute(dep.onChange.calculateFunc, val, data, this.props.arrayIndex, this.props.globalData);
                     }
                     if (_newValue !== val) {
                         ConfigGeneric.setValue(data, dep.attr, _newValue);
@@ -448,8 +459,8 @@ export default class ConfigGeneric extends Component {
         if (this.props.schema.onChange && !this.props.schema.onChange.ignoreOwnChanges) {
             const val = ConfigGeneric.getValue(data, this.props.attr);
             const newValue_ = this.props.custom
-                ? this.executeCustom(this.props.schema.onChange.calculateFunc, data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData)
-                : this.execute(this.props.schema.onChange.calculateFunc, val, data, this.props.arrayIndex, this.props.globalData);
+                ? await this.executeCustom(this.props.schema.onChange.calculateFunc, data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData)
+                : await this.execute(this.props.schema.onChange.calculateFunc, val, data, this.props.arrayIndex, this.props.globalData);
             if (newValue_ !== val) {
                 ConfigGeneric.setValue(data, this.props.attr, newValue_);
             }
@@ -465,14 +476,22 @@ export default class ConfigGeneric extends Component {
                 if (changed.length) {
                     this.props.oContext.forceUpdate(changed, data);
                 }
-                if (cb) {
-                    cb();
-                }
+                cb?.();
             });
         }
         return Promise.resolve();
     }
-    execute(func, defaultValue, data, arrayIndex, globalData) {
+    /** Ensure that every bare getObject( call is preceded by "await". */
+    static ensureAwaitGetObject(code) {
+        return code.replace(/(?<![\w$.])getObject\(/g, (match, offset) => {
+            const before = code.slice(Math.max(0, offset - 10), offset);
+            if (/await\s+$/.test(before)) {
+                return match;
+            }
+            return `await ${match}`;
+        });
+    }
+    async execute(func, defaultValue, data, arrayIndex, globalData) {
         let fun;
         if (isObject(func)) {
             fun = func.func;
@@ -486,16 +505,20 @@ export default class ConfigGeneric extends Component {
         if (!fun) {
             return defaultValue;
         }
+        if (fun.includes('getObject(')) {
+            // ensure, that await is placed in front of getObject
+            fun = ConfigGeneric.ensureAwaitGetObject(fun);
+        }
         try {
-            const f = new Function('data', 'originalData', '_system', '_alive', '_common', '_socket', '_instance', 'arrayIndex', 'globalData', '_changed', fun.includes('return') ? fun : `return ${fun}`);
-            return f(data || this.props.data, this.props.originalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.oContext.instance, arrayIndex, globalData, this.props.changed);
+            const f = new Function('data', 'originalData', '_system', '_alive', '_common', '_socket', '_instance', 'arrayIndex', 'globalData', '_changed', '_href', 'getObject', fun.includes('return') ? fun : `return ${fun}`);
+            return await f(data || this.props.data, this.props.originalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.oContext.instance, arrayIndex, globalData, this.props.changed, window.location.href, this.getObject);
         }
         catch (e) {
             console.error(`Cannot execute ${JSON.stringify(func)}: ${e}`);
             return defaultValue;
         }
     }
-    executeCustom(func, data, customObj, instanceObj, arrayIndex, globalData) {
+    async executeCustom(func, data, customObj, instanceObj, arrayIndex, globalData) {
         let fun;
         if (isObject(func)) {
             fun = func.func;
@@ -509,30 +532,34 @@ export default class ConfigGeneric extends Component {
         if (!fun) {
             return null;
         }
+        if (fun.includes('getObject(')) {
+            // ensure, that await is placed in front of getObject
+            fun = ConfigGeneric.ensureAwaitGetObject(fun);
+        }
         try {
-            const f = new Function('data', 'originalData', '_system', 'instanceObj', 'customObj', '_socket', 'arrayIndex', 'globalData', '_changed', fun.includes('return') ? fun : `return ${fun}`);
-            return f(data || this.props.data, this.props.originalData, this.props.oContext.systemConfig, instanceObj, customObj, this.props.oContext.socket, arrayIndex, globalData, this.props.changed);
+            const f = new Function('data', 'originalData', '_system', 'instanceObj', 'customObj', '_socket', 'arrayIndex', 'globalData', '_changed', '_href', 'getObject', fun.includes('return') ? fun : `return ${fun}`);
+            return await f(data || this.props.data, this.props.originalData, this.props.oContext.systemConfig, instanceObj, customObj, this.props.oContext.socket, arrayIndex, globalData, this.props.changed, window.location.href, this.getObject);
         }
         catch (e) {
             console.error(`Cannot execute ${fun}: ${e}`);
             return null;
         }
     }
-    calculate(schema) {
+    async calculate(schema) {
         let error;
         let disabled;
         let hidden;
         let defaultValue;
         if (this.props.custom) {
             error = schema.validator
-                ? !this.executeCustom(schema.validator, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData)
+                ? !(await this.executeCustom(schema.validator, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData))
                 : false;
             if (schema.disabled === true) {
                 disabled = true;
             }
             else {
                 disabled = schema.disabled
-                    ? this.executeCustom(schema.disabled, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData)
+                    ? (await this.executeCustom(schema.disabled, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData))
                     : false;
             }
             if (schema.hidden === true) {
@@ -540,23 +567,23 @@ export default class ConfigGeneric extends Component {
             }
             else {
                 hidden = schema.hidden
-                    ? this.executeCustom(schema.hidden, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData)
+                    ? (await this.executeCustom(schema.hidden, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData))
                     : false;
             }
             defaultValue = schema.defaultFunc
-                ? this.executeCustom(schema.defaultFunc, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData)
+                ? await this.executeCustom(schema.defaultFunc, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData)
                 : schema.default;
         }
         else {
             error = schema.validator
-                ? !this.execute(schema.validator, false, this.props.data, this.props.arrayIndex, this.props.globalData)
+                ? !(await this.execute(schema.validator, false, this.props.data, this.props.arrayIndex, this.props.globalData))
                 : false;
             if (schema.disabled === true) {
                 disabled = true;
             }
             else {
                 disabled = schema.disabled
-                    ? this.execute(schema.disabled, false, this.props.data, this.props.arrayIndex, this.props.globalData)
+                    ? (await this.execute(schema.disabled, false, this.props.data, this.props.arrayIndex, this.props.globalData))
                     : false;
             }
             if (schema.hidden === true) {
@@ -564,11 +591,11 @@ export default class ConfigGeneric extends Component {
             }
             else {
                 hidden = schema.hidden
-                    ? this.execute(schema.hidden, false, this.props.data, this.props.arrayIndex, this.props.globalData)
+                    ? (await this.execute(schema.hidden, false, this.props.data, this.props.arrayIndex, this.props.globalData))
                     : false;
             }
             defaultValue = schema.defaultFunc
-                ? this.execute(schema.defaultFunc, schema.default, this.props.data, this.props.arrayIndex, this.props.globalData)
+                ? await this.execute(schema.defaultFunc, schema.default, this.props.data, this.props.arrayIndex, this.props.globalData)
                 : schema.default;
         }
         return {
@@ -614,7 +641,7 @@ export default class ConfigGeneric extends Component {
             return '';
         }
         str = str.replace(/`/g, '\\`');
-        // extract all tokes with ${data.token}
+        // extract all tokens with ${data.token}
         str = str.replace(/\${([^}]+)}/g, (_match, p1) => {
             if (p1 && typeof p1 === 'string' && p1.startsWith('data.')) {
                 const value = ConfigGeneric.getValue(data, p1.replace(/^data\./, ''));
@@ -629,6 +656,60 @@ export default class ConfigGeneric extends Component {
         });
         return str;
     }
+    /** This function is used in pattern */
+    getObject = async (id) => {
+        try {
+            const obj = await this.props.oContext.getCachedObject(id);
+            return obj || null;
+        }
+        catch (e) {
+            console.error(e);
+            return null;
+        }
+    };
+    async getPatternAsync(pattern, data, noTranslation) {
+        data ||= this.props.data;
+        if (!pattern) {
+            return '';
+        }
+        let patternStr;
+        if (typeof pattern === 'object') {
+            if (pattern.func) {
+                patternStr = pattern.func;
+            }
+            else {
+                console.log(`Object must be stringified: ${JSON.stringify(pattern)}`);
+                patternStr = JSON.stringify(pattern);
+            }
+        }
+        else {
+            patternStr = pattern;
+        }
+        if (patternStr.includes('getObject(')) {
+            // ensure, that await is placed in front of getObject
+            patternStr = ConfigGeneric.ensureAwaitGetObject(patternStr);
+        }
+        try {
+            if (this.props.custom) {
+                const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', 'instanceObj', 'customObj', '_socket', '_changed', '_href', 'getObject', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
+                const text = await f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.oContext.instanceObj, this.props.customObj, this.props.oContext.socket, this.props.changed, window.location.href, this.getObject);
+                if (noTranslation) {
+                    return text;
+                }
+                return I18n.t(text);
+            }
+            const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', '_alive', '_common', '_socket', '_changed', '_href', 'getObject', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
+            const text = await f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.changed, window.location.href, this.getObject);
+            if (noTranslation) {
+                return text;
+            }
+            return I18n.t(text);
+        }
+        catch (e) {
+            console.error(`Cannot execute ${patternStr}: ${e}`);
+            return patternStr;
+        }
+    }
     getPattern(pattern, data, noTranslation) {
         data ||= this.props.data;
         if (!pattern) {
@@ -647,13 +728,21 @@ export default class ConfigGeneric extends Component {
         else {
             patternStr = pattern;
         }
+        if (patternStr.includes('getObject(')) {
+            // ensure, that await is placed in front of getObject
+            console.log(`It is not possible to use getObject function in text patterns: ${patternStr}`);
+        }
         try {
             if (this.props.custom) {
-                const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', 'instanceObj', 'customObj', '_socket', '_changed', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
-                return f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.oContext.instanceObj, this.props.customObj, this.props.oContext.socket, this.props.changed);
+                const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', 'instanceObj', 'customObj', '_socket', '_changed', '_href', 'getObject', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
+                const text = f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.oContext.instanceObj, this.props.customObj, this.props.oContext.socket, this.props.changed, window.location.href, this.getObject);
+                if (noTranslation) {
+                    return text;
+                }
+                return I18n.t(text);
             }
-            const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', '_alive', '_common', '_socket', '_changed', '_href', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
-            const text = f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.changed, window.location.href);
+            const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', '_alive', '_common', '_socket', '_changed', '_href', 'getObject', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
+            const text = f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.changed, window.location.href, this.getObject);
             if (noTranslation) {
                 return text;
             }
@@ -664,6 +753,28 @@ export default class ConfigGeneric extends Component {
             return patternStr;
         }
     }
+    updateCalculatedValues() {
+        if (this.calculateTimeout) {
+            clearTimeout(this.calculateTimeout);
+        }
+        this.calculateTimeout = setTimeout(async () => {
+            this.calculateTimeout = null;
+            const schema = this.props.schema;
+            if (!schema) {
+                return null;
+            }
+            const { error, disabled, hidden, defaultValue } = await this.calculate(schema);
+            if (!this.state.calculatedValues ||
+                this.state.calculatedValues.error !== error ||
+                this.state.calculatedValues.disabled !== disabled ||
+                this.state.calculatedValues.hidden !== hidden ||
+                this.state.calculatedValues.defaultValue !== defaultValue) {
+                this.setState({
+                    calculatedValues: { error, disabled, hidden, defaultValue },
+                });
+            }
+        }, 50);
+    }
     render() {
         const schema = this.props.schema;
         if (!schema) {
@@ -674,13 +785,16 @@ export default class ConfigGeneric extends Component {
             return null;
         }
         if (this.props.alive && this.defaultSendToDone === false) {
-            this.sendToTimeout = setTimeout(() => {
+            this.sendToTimeout = setTimeout(async () => {
                 this.sendToTimeout = null;
-                this.sendTo();
+                await this.sendTo();
             }, 200);
         }
-        const { error, disabled, hidden, defaultValue } = this.calculate(schema);
-        if (hidden) {
+        this.updateCalculatedValues();
+        if (!this.state.calculatedValues) {
+            return null;
+        }
+        if (this.state.calculatedValues.hidden) {
             // Remove all errors if an element is hidden
             if (Object.keys(this.isError).length) {
                 setTimeout(isError => Object.keys(isError).forEach(attr => this.props.onError(attr)), 100, JSON.parse(JSON.stringify(this.isError)));
@@ -719,18 +833,18 @@ export default class ConfigGeneric extends Component {
         }
         // Add error
         if (schema.validatorNoSaveOnError) {
-            if (error && !Object.keys(this.isError).length) {
+            if (this.state.calculatedValues.error && !Object.keys(this.isError).length) {
                 this.isError = {
                     [this.props.attr]: schema.validatorErrorText ? I18n.t(schema.validatorErrorText) : true,
                 };
                 setTimeout(isError => Object.keys(isError).forEach(attr => this.props.onError(attr, isError[attr])), 100, JSON.parse(JSON.stringify(this.isError)));
             }
-            else if (!error && Object.keys(this.isError).length) {
+            else if (!this.state.calculatedValues.error && Object.keys(this.isError).length) {
                 setTimeout(isError => Object.keys(isError).forEach(attr => this.props.onError(attr)), 100, JSON.parse(JSON.stringify(this.isError)));
                 this.isError = {};
             }
         }
-        const renderedItem = this.renderItem(error, disabled || this.props.commandRunning || this.props.disabled, defaultValue);
+        const renderedItem = this.renderItem(this.state.calculatedValues.error, this.state.calculatedValues.disabled || this.props.commandRunning || this.props.disabled, this.state.calculatedValues.defaultValue);
         if (this.noPlaceRequired) {
             return renderedItem;
         }
@@ -749,7 +863,7 @@ export default class ConfigGeneric extends Component {
             } }, this.props.schema.defaultSendTo && this.props.schema.button ? (React.createElement(Grid2, { container: true, style: { width: '100%' } },
             React.createElement(Grid2, { flex: 1 }, renderedItem),
             React.createElement(Grid2, null,
-                React.createElement(Button, { disabled: disabled, variant: "outlined", onClick: () => this.sendTo(), title: this.props.schema.buttonTooltip
+                React.createElement(Button, { disabled: this.state.calculatedValues.disabled, variant: "outlined", onClick: () => this.sendTo(), title: this.props.schema.buttonTooltip
                         ? this.getText(this.props.schema.buttonTooltip, this.props.schema.buttonTooltipNoTranslation)
                         : I18n.t('ra_Request data by instance') }, this.getText(this.props.schema.button))))) : (renderedItem)));
         if (schema.newLine) {