iobroker.rest-api 0.3.2 → 0.3.3

package/README.md

@@ -46,7 +46,7 @@ This adapter can run as web-extension. In this case the path is available under
 -->
 
 ## Changelog
-### 0.3.2 (2022-04-19)
+### 0.3.3 (2022-04-20)
 * (bluefox) Corrected subscription
 
 ### 0.3.1 (2022-04-15)

package/io-package.json

@@ -1,8 +1,20 @@
 {
   "common": {
     "name": "rest-api",
-    "version": "0.3.2",
+    "version": "0.3.3",
     "news": {
+      "0.3.3": {
+        "en": "Corrected subscription",
+        "de": "Abonnement korrigiert",
+        "ru": "Исправлена подписка",
+        "pt": "Assinatura corrigida",
+        "nl": "Gecorrigeerd abonnement",
+        "fr": "Abonnement corrigé",
+        "it": "Abbonamento corretto",
+        "es": "Suscripción corregida",
+        "pl": "Poprawiona subskrypcja",
+        "zh-cn": "更正订阅"
+      },
       "0.3.2": {
         "en": "Corrected subscription",
         "de": "Abonnement korrigiert",

package/lib/api/controllers/state.js

@@ -69,7 +69,11 @@ function subscribeState(req, res) {
                 } else if (obj.type !== 'state') {
                     res.status(500).json({error: 'Cannot subscribe on non-state', stateId: params.stateId, type: obj.type, url: req.body.url});
                 } else {
-                    const error = await req._swaggerObject.registerSubscribe(url, params.stateId, 'state', req._user, (req.query && req.query.method) || (req.body && req.body.method));
+                    const error = await req._swaggerObject.registerSubscribe(url, params.stateId, 'state', req._user, {
+                        method: (req.query && req.query.method) || (req.body && req.body.method),
+                        delta: (req.query && req.query.delta) || (req.body && req.body.delta),
+                        onchange: (req.query && req.query.onchange) || (req.body && req.body.onchange),
+                    });
                     if (error) {
                         res.status(500).json({error, stateId: params.stateId, url: req.body.url});
                         return;
@@ -376,7 +380,11 @@ module.exports = {
                     return;
                 }
                 try {
-                    await req._swaggerObject.registerSubscribe(url, req.body.pattern, 'state', req._user, req.body.method);
+                    await req._swaggerObject.registerSubscribe(url, req.body.pattern, 'state', req._user, {
+                        method: req.body.method,
+                        onchange: req.body.onchange === 'true',
+                        delta: req.body.delta !== undefined ? parseFloat(req.body.delta) : undefined,
+                    });
                 } catch (error) {
                     res.status(500).json({error, pattern: req.body.pattern, url: req.body.url});
                 }
@@ -410,4 +418,4 @@ module.exports = {
             }
         });
     },
-};
+};

package/lib/api/swagger/swagger.yaml

@@ -168,6 +168,14 @@ paths:
           description: "method=polling forces subscribe via long polling"
           enum: [polling]
           type: "string"
+        - name: "onchange"
+          type: "boolean"
+          description: "If the updates must be delivered if the value changed"
+          in: "query"
+        - name: "delta"
+          type: "number"
+          description: "Minimal delta to trigger the event"
+          in: "query"
       responses:
         200:
           description: "successful operation"
@@ -304,7 +312,7 @@ paths:
           description: "URL of web hook and the unsubscribe pattern"
           required: true
           schema:
-            $ref: "#/definitions/UrlHookWithPattern"
+            $ref: "#/definitions/UrlHook"
       responses:
         200:
           description: "successful operation"
@@ -520,7 +528,7 @@ paths:
           description: "URL of web hook and the unsubscribe pattern"
           required: true
           schema:
-            $ref: "#/definitions/UrlHookWithPattern"
+            $ref: "#/definitions/UrlHook"
       responses:
         200:
           description: "successful operation"
@@ -775,7 +783,7 @@ definitions:
       method:
         type: "string"
         description: "HTTP Method"
-        enum: [ POST, GET, PUT, PATCH ]
+        enum: [ POST, GET, PUT, PATCH, polling ]
   UrlHookWithPattern:
     type: "object"
     required: [pattern]
@@ -783,13 +791,16 @@ definitions:
       url:
         type: "string"
         description: "URL"
+      onchange:
+        type: "boolean"
+        description: "If the updates must be delivered if the value changed"
       pattern:
         type: "string"
         description: "Subscribe pattern like: \"system.adapter.admin.0.*\""
       method:
         type: "string"
         description: "HTTP Method"
-        enum: [ POST, GET, PUT, PATCH, POLLING ]
+        enum: [ POST, GET, PUT, PATCH, polling ]
   HistoryOptions:
     type: "object"
     #required: [pattern]
@@ -913,4 +924,4 @@ definitions:
         description: "Error description"
 externalDocs:
   description: "Find out more about ioBroker"
-  url: "https://www.iobroker.net"
+  url: "https://www.iobroker.net"

package/lib/rest-api.js

@@ -277,27 +277,57 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
         this.gcInterval = this.gcInterval || setInterval(() => this._executeGC(), 30000);
     }
 
-    this.registerSubscribe = async (urlHook, id, type, user, method) => {
+    this.registerSubscribe = async (urlHook, id, type, user, options) => {
+        if (typeof options === 'string') {
+            options = {method: options};
+        }
+        if (options.delta) {
+            options.delta = parseFloat(options.delta);
+        } else {
+            delete options.delta;
+        }
+        if (options.onchange) {
+            options.onchange = options.onchange === true || options.onchange === 'true';
+        } else {
+            delete options.onchange;
+        }
+
         const urlHash = crypto.createHash('md5').update(urlHook).digest('hex');
         if (!this.subscribes[urlHash]) {
-            if (method !== 'polling') {
+            if (options.method !== 'polling') {
                 const error = await _validateUrlHook({urlHook});
                 if (error) {
                     return `No valid answer from URL hook: ${error}`;
                 }
             }
-            if (method === 'polling') {
+            if (options.method === 'polling') {
                 this.adapter.log.debug(`[${urlHook}] Subscribe on connection`);
                 this.startGC();
             }
 
-            this.subscribes[urlHash] = {state: [], object: [], urlHook, polling: method === 'polling', ts: Date.now()};
+            this.subscribes[urlHash] = {
+                state: [],
+                object: [],
+                urlHook,
+                polling: options.method === 'polling',
+                ts: Date.now()
+            };
         }
-        if (!this.subscribes[urlHash][type].find(item => item.id === id && (!item.method || item.method === method))) {
-            this.subscribes[urlHash][type].push({id});
+
+        if (!this.subscribes[urlHash][type].find(item => item.id === id && (!item.method || item.method === options.method))) {
+            const item = {id, delta: options.delta, onchange: options.onchange};
+            this.subscribes[urlHash][type].push(item);
             if (type === 'state') {
                 this.adapter.log.debug(`[${urlHook}] Subscribe on state "${id}"`);
                 await this.adapter.subscribeForeignStatesAsync(id, {user});
+                if (options.onchange || options.delta) {
+                    item.val = await this.adapter.getForeignStateAsync(id);
+                    if (item.val) {
+                        item.val = item.val.val;
+                    } else {
+                        item.val = null;
+                    }
+                }
             } else {
                 this.adapter.log.debug(`[${urlHook}] Subscribe on object "${id}"`);
                 await this.adapter.subscribeForeignObjectsAsync(id, {user});
@@ -385,6 +415,21 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
             this.subscribes[urlHash].state.forEach(async item => {
                 // check if id
                 if (typeof item.id === 'string' && item.id === id) {
+                    if (state && item.delta && item.val !== null && Math.abs(item.val - state.val) < item.delta) {
+                        // ignore
+                        this.adapter.log.debug(`State change for "${id}" ignored as delta (${item.val} - ${state.val}) is less than ${item.delta}`);
+                        return;
+                    }
+                    if (state && item.onchange && !item.delta && item.val === state.val) {
+                        // ignore
+                        this.adapter.log.debug(`State change for "${id}" ignored as does not changed (${state.val})`);
+                        return;
+                    }
+                    if (state && (item.delta || item.onchange)) {
+                        // remember last value
+                        item.val = state.val;
+                    }
+
                     await reportChange(this.subscribes[urlHash], {id, state});
                 } else {
                     // todo
@@ -495,15 +540,18 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
         new Promise(resolve => {
             item.promise = {
                 resolve,
-                ts: setTimeout(() => {
-                    item.promise.ts = null;
+                timer: setTimeout(() => {
+                    if (item.promise) {
+                        // could never happen
+                        item.promise.timer = null;
+                    }
                     resolve();
                 }, item ? item.timeout : 30000)};
         })
             .then(data => {
                 if (item.promise) {
-                    item.promise.ts && clearTimeout(item.promise.ts);
-                    item.promise.ts = null;
+                    item.promise.timer && clearTimeout(item.promise.timer);
+                    item.promise.timer = null;
                     item.promise.resolve = null;
                     item.promise = null;
                 } else {
@@ -517,8 +565,8 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
                 this.adapter.log.warn(`[${item && item.urlHook}]Error in polling connection: ${error}`);
             }
             if (item.promise) {
-                item.promise.ts && clearTimeout(item.promise.ts);
-                item.promise.ts = null;
+                item.promise.timer && clearTimeout(item.promise.timer);
+                item.promise.timer = null;
                 item.promise.resolve = null;
                 item.promise = null;
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.rest-api",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "RESTful interface for ioBroker with GUI.",
   "author": {
     "name": "bluefox",