iotagent-node-lib 4.9.0 → 4.11.0

package/lib/services/groups/groupRegistryMongoDB.js

@@ -63,7 +63,8 @@ const attributeList = [
     'entityNameExp',
     'payloadType',
     'useCBflowControl',
-    'storeLastMeasure'
+    'storeLastMeasure',
+    'cmdMode'
 ];
 
 function createGroup(group, callback) {

package/lib/services/ngsi/subscription-NGSI-LD.js

@@ -105,7 +105,7 @@ function createSubscriptionHandlerNgsiLD(device, triggers, store, callback) {
  * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription
  * @param {Object} content      Array with the names of the attributes to retrieve in the notification.
  */
-function subscribeNgsiLD(device, triggers, content, callback) {
+function subscribeNgsiLD(device, triggers, content, attrsFormat, callback) {
     const options = {
         method: 'POST',
         headers: {
@@ -132,7 +132,7 @@ function subscribeNgsiLD(device, triggers, content, callback) {
                     accept: 'application/json'
                 },
                 attributes: content || [],
-                format: 'normalized'
+                format: attrsFormat
             }
         }
     };

package/lib/services/ngsi/subscription-NGSI-mixed.js

@@ -36,11 +36,11 @@ const subscriptionHandlerV2 = require('./subscription-NGSI-v2');
  * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription
  * @param {Object} content      Array with the names of the attributes to retrieve in the notification.
  */
-function subscribeNgsiMixed(device, triggers, content, callback) {
+function subscribeNgsiMixed(device, triggers, content, attrsFormat, callback) {
     if (config.checkNgsiLD(device)) {
-        subscriptionHandlerLD.subscribe(device, triggers, content, callback);
+        subscriptionHandlerLD.subscribe(device, triggers, content, attrsFormat, callback);
     } else {
-        subscriptionHandlerV2.subscribe(device, triggers, content, callback);
+        subscriptionHandlerV2.subscribe(device, triggers, content, attrsFormat, callback);
     }
 }
 

package/lib/services/ngsi/subscription-NGSI-v2.js

@@ -93,7 +93,9 @@ function createSubscriptionHandlerNgsi2(device, triggers, store, callback) {
 
             config.getRegistry().update(device, device, callback);
         } else {
-            callback(null, response.headers.location);
+            callback(null, {
+                subscriptionId: response.headers.location.substr(response.headers.location.lastIndexOf('/') + 1)
+            });
         }
     };
 }
@@ -107,7 +109,7 @@ function createSubscriptionHandlerNgsi2(device, triggers, store, callback) {
  * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription
  * @param {Object} content      Array with the names of the attributes to retrieve in the notification.
  */
-function subscribeNgsi2(device, triggers, content, callback) {
+function subscribeNgsi2(device, triggers, content, attrsFormat, callback) {
     const options = {
         method: 'POST',
         headers: {
@@ -115,6 +117,7 @@ function subscribeNgsi2(device, triggers, content, callback) {
             'fiware-servicepath': device.subservice
         },
         json: {
+            description: 'Managed by IOTA: ' + device.name + ' ' + device.type + ' ' + triggers.join(','),
             subject: {
                 entities: [
                     {
@@ -132,7 +135,8 @@ function subscribeNgsi2(device, triggers, content, callback) {
                     url: config.getConfig().providerUrl + '/notify'
                 },
                 attrs: content || [],
-                attrsFormat: 'normalized'
+                attrsFormat: attrsFormat,
+                onlyChangedAttrs: true
             }
         }
     };
@@ -167,7 +171,7 @@ function createUnsubscribeHandlerNgsi2(device, id, callback) {
         if (error) {
             logger.debug(
                 context,
-                'Transport error found subscribing device with id [%s] to entity [%s]',
+                'Transport error found unsubscribing device with id [%s] to entity [%s]',
                 device.id,
                 device.name
             );
@@ -176,7 +180,9 @@ function createUnsubscribeHandlerNgsi2(device, id, callback) {
         } else if (response.statusCode !== 204) {
             logger.debug(
                 context,
-                'Unknown error subscribing device with id [%s] to entity [%s]: $s',
+                'Unknown error unsubscribing device with id [%s] to entity [%s]: %s',
+                device.id,
+                device.name,
                 response.statusCode
             );
 
@@ -202,7 +208,15 @@ function createUnsubscribeHandlerNgsi2(device, id, callback) {
 
             callback(new errors.BadRequest(body.orionError.details));
         } else {
-            device.subscriptions.splice(device.subscriptions.indexOf(id), 1);
+            logger.debug(context, 'removing subscription %s from device %j', id, device);
+            if (device.subscriptions) {
+                // check before try to eliminates
+                const index = device.subscriptions.indexOf(id);
+                if (index !== -1) {
+                    // only eliminates if exits
+                    device.subscriptions.splice(index, 1);
+                }
+            }
             config.getRegistry().update(device, device, callback);
         }
     };

package/lib/services/ngsi/subscriptionService.js

@@ -57,8 +57,8 @@ function init() {
  * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription
  * @param {Object} content      Array with the names of the attributes to retrieve in the notification.
  */
-function subscribe(device, triggers, content, callback) {
-    subscriptionHandler.subscribe(device, triggers, content, callback);
+function subscribe(device, triggers, content, attrsFormat, callback) {
+    subscriptionHandler.subscribe(device, triggers, content, attrsFormat, callback);
 }
 
 /**

package/lib/services/northBound/contextServer-NGSI-v2.js

@@ -293,8 +293,10 @@ function handleNotificationNgsi2(req, res, next) {
             }
         }
         logger.debug(context, 'extracted atts %j from dataElement %j', atts, dataElement);
-        var id = null;
-        var type = null;
+        // FIXME: command execution entity for advancedNotification is still not implemented
+        var id = dataElement.id;
+        var type = dataElement.type;
+
         if (dataElement.targetEntityId && dataElement.targetEntityId.value) {
             id = dataElement.targetEntityId.value;
         }

package/lib/services/northBound/deviceProvisioningServer.js

@@ -67,7 +67,8 @@ const provisioningAPITranslation = {
     payloadType: 'payloadType',
     useCBflowControl: 'useCBflowControl',
     storeLastMeasure: 'storeLastMeasure',
-    lastMeasure: 'lastMeasure'
+    lastMeasure: 'lastMeasure',
+    cmdMode: 'cmdMode'
 };
 
 /**
@@ -149,7 +150,8 @@ function handleProvision(req, res, next) {
             payloadType: body.payloadType,
             useCBflowControl: body.useCBflowControl,
             storeLastMeasure: body.storeLastMeasure,
-            lastMeasure: body.lastMeasure
+            lastMeasure: body.lastMeasure,
+            cmdMode: body.cmdMode
         });
     }
 
@@ -229,7 +231,8 @@ function toProvisioningAPIFormat(device) {
         payloadType: device.payloadType,
         useCBflowControl: device.useCBflowControl,
         storeLastMeasure: device.storeLastMeasure,
-        lastMeasure: device.lastMeasure
+        lastMeasure: device.lastMeasure,
+        cmdMode: device.cmdMode
     };
 }
 

package/lib/templates/updateDevice.json

@@ -157,6 +157,10 @@
               "description": "use CB flowControl option",
               "type": "boolean"
           },
+          "cmdMode": {
+              "description": "CB commands mode",
+              "type": "string"
+          },
           "contentType": {
               "description": "Content type",
               "type": "string"
@@ -203,6 +207,10 @@
         "description": "Payload type allowed for measures for this device",
         "type": "string"
     },
+    "useCBflowControl": {
+        "description": "use CB flowControl option",
+        "type": "boolean"
+    },
     "storeLastMeasure": {
       "description": "Store last measure",
       "type": "boolean"
@@ -210,6 +218,10 @@
     "lastMeasure": {
       "description": "last measure",
       "type": "object"
+    },
+    "cmdMode": {
+        "description": "CB commands mode",
+        "type": "string"
     }
   }
 }

package/lib/templates/updateDeviceLax.json

@@ -158,6 +158,10 @@
     "lastMeasure": {
       "description": "last measure",
       "type": "object"
+    },
+    "cmdMode": {
+        "description": "CB commands mode",
+        "type": "string"
     }
   }
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "iotagent-node-lib",
   "license": "AGPL-3.0-only",
   "description": "IoT Agent library to interface with NGSI Context Broker",
-  "version": "4.9.0",
+  "version": "4.11.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",
@@ -23,7 +23,7 @@
   },
   "main": "lib/fiware-iotagent-lib",
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "scripts": {
     "clean": "rm -rf package-lock.json && rm -rf node_modules && rm -rf coverage",

package/test/unit/expressions/jexlExpression-test.js

@@ -398,6 +398,36 @@ describe('Jexl expression interpreter', function () {
         });
     });
 
+    describe('When number localization functions are executed', function () {
+        it('should return the localized string representation of the number', function (done) {
+            const scope = {
+                theNumber: 1234567.89,
+                locale: 'es-ES',
+                options: { minimumFractionDigits: 2, maximumFractionDigits: 2 }
+            };
+
+            expressionParser.parse('theNumber|localestringnumber(locale, options)', scope, function (error, result) {
+                should.not.exist(error);
+                result.should.equal('1.234.567,89');
+                done();
+            });
+        });
+
+        it('should return null for invalid number input', function (done) {
+            const scope = {
+                theNumber: 'not_a_number',
+                locale: 'en-US',
+                options: {}
+            };
+
+            expressionParser.parse('theNumber|localestringnumber(locale, options)', scope, function (error, result) {
+                should.not.exist(error);
+                should.equal(result, null);
+                done();
+            });
+        });
+    });
+
     // Check errors
     describe('When invalid inputs are used', function () {
         describe('When an invalid JSON string is parsed', function () {

package/test/unit/general/contextBrokerKeystoneSecurityAccess-test.js

@@ -295,7 +295,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with Keystone', functio
 
         it('subscribe requests use auth header', function (done) {
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();
@@ -316,7 +316,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with Keystone', functio
                 });
 
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         contextBrokerMock.done();
                         done();

package/test/unit/memoryRegistry/deviceRegistryMemory_test.js

@@ -243,7 +243,7 @@ describe('NGSI-v2 - In memory device registry', function () {
                 should.exist(device.type);
                 device.name.should.equal('name5');
                 device.type.should.equal('Light5');
-                Object.keys(device).length.should.equal(12);
+                Object.keys(device).length.should.equal(13);
                 done();
             });
         });

package/test/unit/ngsi-ld/general/contextBrokerOAuthSecurityAccess-test.js

@@ -309,7 +309,7 @@ describe('NGSI-LD - Secured access to the Context Broker with OAuth2 provider',
 
         it('subscribe requests use auth header', function (done) {
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();
@@ -330,7 +330,7 @@ describe('NGSI-LD - Secured access to the Context Broker with OAuth2 provider',
             contextBrokerMock.delete('/ngsi-ld/v1/subscriptions/51c0ac9ed714fb3b37d7d5a8', '').reply(204);
 
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         contextBrokerMock.done();
                         done();

package/test/unit/ngsi-ld/general/https-support-test.js

@@ -214,7 +214,7 @@ describe('NGSI-LD - HTTPS support tests', function () {
 
         it('should send the appropriate request to the Context Broker', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();

package/test/unit/ngsi-ld/ngsiService/subscriptions-test.js

@@ -94,7 +94,7 @@ describe('NGSI-LD - Subscription tests', function () {
     describe('When a client invokes the subscribe() function for device', function () {
         it('should send the appropriate request to the Context Broker', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();
@@ -105,7 +105,7 @@ describe('NGSI-LD - Subscription tests', function () {
         });
         it('should store the subscription ID in the Device Registry', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
                         should.not.exist(error);
                         should.exist(device);
@@ -131,7 +131,7 @@ describe('NGSI-LD - Subscription tests', function () {
 
         it('should delete the subscription from the CB', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
                             contextBrokerMock.done();
@@ -143,7 +143,7 @@ describe('NGSI-LD - Subscription tests', function () {
         });
         it('should remove the id from the subscriptions array', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
                             should.not.exist(error);
@@ -169,7 +169,7 @@ describe('NGSI-LD - Subscription tests', function () {
 
         it('should delete the subscription from the CB', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     iotAgentLib.unregister(device.id, null, 'smartgondor', '/gardens', function (error) {
                         contextBrokerMock.done();
                         done();
@@ -181,7 +181,7 @@ describe('NGSI-LD - Subscription tests', function () {
     describe('When a new notification comes to the IoTAgent', function () {
         beforeEach(function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     done();
                 });
             });

package/test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands.json

@@ -0,0 +1,24 @@
+{
+    "description": "Managed by IOTA: Robot:r2d2 Robot position",
+    "subject": {
+        "entities":[
+            {
+                "id":"Robot:r2d2","type":"Robot"
+            }
+        ],
+        "condition": {
+            "attrs":["position"]
+        }
+    },
+    "notification":{
+        "http":{
+            "url":"http://smartgondor.com/notify"
+        },
+        "attrs":["position"],
+        "attrsFormat":"normalized",
+        "onlyChangedAttrs":true
+    }
+}
+
+
+

package/test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands2.json

@@ -0,0 +1,24 @@
+{
+    "description": "Managed by IOTA: RobotT:r2d3 RobotT position",
+    "subject": {
+        "entities":[
+            {
+                "id":"RobotT:r2d3","type":"RobotT"
+            }
+        ],
+        "condition": {
+            "attrs":["position"]
+        }
+    },
+    "notification":{
+        "http":{
+            "url":"http://smartgondor.com/notify"
+        },
+        "attrs":["position"],
+        "attrsFormat":"normalized",
+        "onlyChangedAttrs":true
+    }
+}
+
+
+

package/test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands3.json

@@ -0,0 +1,24 @@
+{
+    "description": "Managed by IOTA: RobotT:r2d4 RobotT position",
+    "subject": {
+        "entities":[
+            {
+                "id":"RobotT:r2d4","type":"RobotT"
+            }
+        ],
+        "condition": {
+            "attrs":["position"]
+        }
+    },
+    "notification":{
+        "http":{
+            "url":"http://smartgondor.com/notify"
+        },
+        "attrs":["position"],
+        "attrsFormat":"normalized",
+        "onlyChangedAttrs":true
+    }
+}
+
+
+

package/test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands4.json

@@ -0,0 +1,24 @@
+{
+    "description": "Managed by IOTA: RobotT:r2d3 RobotT reset",
+    "subject": {
+        "entities":[
+            {
+                "id":"RobotT:r2d3","type":"RobotT"
+            }
+        ],
+        "condition": {
+            "attrs":["reset"]
+        }
+    },
+    "notification":{
+        "http":{
+            "url":"http://smartgondor.com/notify"
+        },
+        "attrs":["reset"],
+        "attrsFormat":"normalized",
+        "onlyChangedAttrs":true
+    }
+}
+
+
+

package/test/unit/ngsiv2/examples/contextRequests/updateEntity.json

@@ -0,0 +1,5 @@
+{
+    "id":"Robot:r2d2",
+    "type":"Robot",
+    "position":{"type":"command","value":null}
+}

package/test/unit/ngsiv2/examples/contextRequests/updateEntity2.json

@@ -0,0 +1,5 @@
+{
+    "id":"RobotT:r2d3",
+    "type":"RobotT",
+    "position":{"type":"command","value":null}
+}

package/test/unit/ngsiv2/examples/contextRequests/updateEntity2b.json

@@ -0,0 +1,7 @@
+{
+    "pressure":{"type":"Hgmm","value":null},
+    "reset": {
+        "type": "command",
+        "value": null
+    }
+}

package/test/unit/ngsiv2/examples/contextRequests/updateEntity3.json

@@ -0,0 +1,5 @@
+{
+    "id":"RobotT:r2d4",
+    "type":"RobotT",
+    "position":{"type":"command","value":null}
+}

package/test/unit/ngsiv2/examples/subscriptionRequests/simpleSubscriptionRequest.json

@@ -1,4 +1,5 @@
 {
+  "description": "Managed by IOTA: FirstMicroLight MicroLights attr_name",
   "subject": {
     "entities": [
       {
@@ -17,6 +18,7 @@
       "url": "http://smartgondor.com/notify"
     },
     "attrs": [],
-    "attrsFormat": "normalized"
+      "attrsFormat": "normalized",
+      "onlyChangedAttrs": true
   }
-}
+}

package/test/unit/ngsiv2/examples/subscriptionRequests/simpleSubscriptionRequest2.json

@@ -1,4 +1,5 @@
 {
+  "description": "Managed by IOTA: light1 Light dimming",
   "subject": {
     "entities": [
       {
@@ -17,6 +18,7 @@
       "url": "http://smartgondor.com/notify"
     },
     "attrs": [],
-    "attrsFormat": "normalized"
+    "attrsFormat": "normalized",
+    "onlyChangedAttrs": true
   }
-}
+}

package/test/unit/ngsiv2/general/contextBrokerOAuthSecurityAccess-test.js

@@ -312,7 +312,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with OAuth2 provider',
 
         it('subscribe requests use auth header', function (done) {
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();
@@ -333,7 +333,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with OAuth2 provider',
             contextBrokerMock.delete('/v2/subscriptions/51c0ac9ed714fb3b37d7d5a8', '').reply(204);
 
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         contextBrokerMock.done();
                         done();

package/test/unit/ngsiv2/general/https-support-test.js

@@ -211,7 +211,7 @@ describe('NGSI-v2 - HTTPS support tests', function () {
 
         it('should send the appropriate request to the Context Broker', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();