iotagent-node-lib 2.15.1 → 2.19.0

package/lib/services/northBound/deviceProvisioningServer.js

@@ -34,6 +34,7 @@ const context = {
 };
 const apply = async.apply;
 let provisioningHandler;
+let updatingHandler;
 let removeDeviceHandler;
 let updateDeviceTemplate;
 let createDeviceTemplate;
@@ -53,6 +54,7 @@ const provisioningAPITranslation = {
     protocol: 'protocol',
     transport: 'transport',
     endpoint: 'endpoint',
+    polling: 'polling',
     attributes: 'active',
     commands: 'commands',
     lazy: 'lazy',
@@ -181,7 +183,8 @@ function attributeToProvisioningAPIFormat(attribute) {
         reverse: attribute.reverse,
         entity_name: attribute.entity_name,
         entity_type: attribute.entity_type,
-        mqtt: attribute.mqtt
+        mqtt: attribute.mqtt,
+        metadata: attribute.metadata
     };
 }
 
@@ -203,6 +206,7 @@ function toProvisioningAPIFormat(device) {
         timezone: device.timezone,
         timestamp: device.timestamp,
         endpoint: device.endpoint,
+        polling: device.polling,
         transport: device.transport,
         attributes: device.active ? device.active.map(attributeToProvisioningAPIFormat) : undefined,
         lazy: device.lazy ? device.lazy.map(attributeToProvisioningAPIFormat) : undefined,
@@ -316,7 +320,15 @@ function handleRemoveDevice(req, res, next) {
  * This middleware handles updates in the provisioning devices. The only attribute
  */
 function handleUpdateDevice(req, res, next) {
-    if (req.body.deviceId) {
+    function applyUpdatingHandler(device, callback) {
+        if (updatingHandler) {
+            updatingHandler(device, callback);
+        } else {
+            callback(null, device);
+        }
+    }
+
+    if (req.body.device_id) {
         next(new errors.BadRequest("Can't change the ID of a preprovisioned device"));
     } else {
         deviceService.getDevice(
@@ -333,13 +345,23 @@ function handleUpdateDevice(req, res, next) {
                     for (const i in pairs) {
                         newDevice[provisioningAPITranslation[pairs[i][0]]] = pairs[i][1];
                     }
-
-                    deviceService.updateRegister(newDevice, function handleDeviceUpdate(error) {
-                        if (error) {
-                            next(error);
-                        } else {
-                            res.status(204).json({});
-                        }
+                    var isTypeOrNameUpdated = false;
+                    if (req.body.entity_name || req.body.entity_type) {
+                        isTypeOrNameUpdated = true;
+                    }
+                    async.waterfall([apply(applyUpdatingHandler, newDevice)], function handleUpdating(
+                        error,
+                        newDeviceUpdated
+                    ) {
+                        deviceService.updateRegister(newDeviceUpdated, isTypeOrNameUpdated, function handleDeviceUpdate(
+                            error
+                        ) {
+                            if (error) {
+                                next(error);
+                            } else {
+                                res.status(204).json({});
+                            }
+                        });
                     });
                 } else {
                     next(new errors.DeviceNotFound(req.params.deviceId));
@@ -388,6 +410,10 @@ function setProvisioningHandler(newHandler) {
     provisioningHandler = newHandler;
 }
 
+function setUpdatingHandler(newHandler) {
+    updatingHandler = newHandler;
+}
+
 function setRemoveDeviceHandler(newHandler) {
     removeDeviceHandler = newHandler;
 }
@@ -405,6 +431,7 @@ function clear(callback) {
 exports.setConfiguration = setConfiguration;
 exports.loadContextRoutes = intoTrans(context, loadContextRoutes);
 exports.setProvisioningHandler = intoTrans(context, setProvisioningHandler);
+exports.setUpdatingHandler = intoTrans(context, setUpdatingHandler);
 exports.setRemoveDeviceHandler = intoTrans(context, setRemoveDeviceHandler);
 exports.addDeviceProvisionMiddleware = addDeviceProvisionMiddleware;
 exports.clear = clear;

package/lib/services/northBound/northboundServer.js

@@ -31,6 +31,7 @@ const domainUtils = require('../common/domain');
 const middlewares = require('../common/genericMiddleware');
 const intoTrans = domainUtils.intoTrans;
 const deviceProvisioning = require('./deviceProvisioningServer');
+const deviceUpdating = require('./deviceProvisioningServer');
 const groupProvisioning = require('./deviceGroupAdministrationServer');
 const logger = require('logops');
 const context = {
@@ -116,6 +117,7 @@ exports.setNotificationHandler = intoTrans(context, contextServer.setNotificatio
 exports.setConfigurationHandler = intoTrans(context, groupProvisioning.setConfigurationHandler);
 exports.setRemoveConfigurationHandler = intoTrans(context, groupProvisioning.setRemoveConfigurationHandler);
 exports.setProvisioningHandler = intoTrans(context, deviceProvisioning.setProvisioningHandler);
+exports.setUpdatingHandler = intoTrans(context, deviceUpdating.setUpdatingHandler);
 exports.setRemoveDeviceHandler = intoTrans(context, deviceProvisioning.setRemoveDeviceHandler);
 exports.addDeviceProvisionMiddleware = deviceProvisioning.addDeviceProvisionMiddleware;
 exports.addConfigurationProvisionMiddleware = groupProvisioning.addConfigurationProvisionMiddleware;

package/lib/services/northBound/restUtils.js

@@ -35,7 +35,7 @@ const context = {
     op: 'IoTAgentNGSI.RestUtils'
 };
 const _ = require('underscore');
-const request = require('request');
+const request = require('../../request-shim');
 const async = require('async');
 const apply = async.apply;
 const ngsiService = require('../ngsi/ngsiService');
@@ -123,25 +123,6 @@ function checkBody(template) {
     };
 }
 
-/**
- * Checks if the timestamp properties of NGSIv1 entities are valid ISO8601 dates.
- *
- * @param {Object} payload         NGSIv1 payload to be analyzed.
- * @return {Boolean}               true if timestamp attributes are valid ISO8601. false if not.
- */
-function IsValidTimestamped(payload) {
-    for (const i in payload.contextElements[0].attributes) {
-        if (
-            payload.contextElements[0].attributes[i].name === constants.TIMESTAMP_ATTRIBUTE &&
-            !moment(payload.contextElements[0].attributes[i].value, moment.ISO_8601).isValid()
-        ) {
-            return false;
-        }
-    }
-
-    return true;
-}
-
 /**
  * Checks if the timestamp properties of NGSIv2 entities are valid ISO8601 dates.
  *
@@ -173,22 +154,6 @@ function IsValidTimestampedNgsi2(payload) {
     return isValidTimestampedNgsi2Entity(payload);
 }
 
-/**
- * Checks if timestamp attributes are included in NGSIv1 entities.
- *
- * @param {Object} payload         NGSIv1 payload to be analyzed.
- * @return {Boolean}               true if timestamp attributes are included. false if not.
- */
-function isTimestamped(payload) {
-    for (const i in payload.contextElements[0].attributes) {
-        if (payload.contextElements[0].attributes[i].name === constants.TIMESTAMP_ATTRIBUTE) {
-            return true;
-        }
-    }
-
-    return false;
-}
-
 /**
  * Checks if timestamp attributes are included in NGSIv2 entities.
  *
@@ -228,7 +193,7 @@ function isTimestampedNgsi2(payload) {
  */
 function executeWithSecurity(requestOptions, deviceData, callback) {
     logger.debug(context, 'executeWithSecurity');
-    config.getGroupRegistry().getType(deviceData.type, function (error, deviceGroup) {
+    config.getGroupRegistry().getTypeSilently(deviceData.type, function (error, deviceGroup) {
         let typeInformation;
         if (error) {
             logger.debug(context, 'error %j in get group device', error);
@@ -273,7 +238,5 @@ exports.executeWithSecurity = executeWithSecurity;
 exports.checkMandatoryQueryParams = intoTrans(context, checkMandatoryQueryParams);
 exports.checkRequestAttributes = intoTrans(context, checkRequestAttributes);
 exports.checkBody = intoTrans(context, checkBody);
-exports.isTimestamped = isTimestamped;
-exports.IsValidTimestamped = IsValidTimestamped;
 exports.isTimestampedNgsi2 = isTimestampedNgsi2;
 exports.IsValidTimestampedNgsi2 = IsValidTimestampedNgsi2;

package/lib/templates/updateDevice.json

@@ -177,6 +177,10 @@
         }
       }
     },
+    "internal_attributes": {
+      "description": "Free form array of internal attributes for particular IOTAgents",
+      "type": "any"
+    },
     "static_attributes": {
       "description": "Free form array of data to be appended to the target entity",
       "type": "array"

package/lib/templates/updateDeviceLax.json

@@ -149,6 +149,10 @@
         }
       }
     },
+    "internal_attributes": {
+      "description": "Free form array of internal attributes for particular IOTAgents",
+      "type": "any"
+    },
     "static_attributes": {
       "description": "Free form array of data to be appended to the target entity",
       "type": "array"

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": "2.15.1",
+  "version": "2.19.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",
@@ -27,7 +27,7 @@
   },
   "main": "lib/fiware-iotagent-lib",
   "engines": {
-    "node": ">=10"
+    "node": ">=12"
   },
   "scripts": {
     "clean": "rm -rf package-lock.json && rm -rf node_modules && rm -rf coverage",
@@ -36,7 +36,9 @@
     "lint:text": "textlint '*.md' 'doc/*.md'",
     "prettier": "prettier --config .prettierrc.json --write '**/**/**/**/*.js' '**/**/**/*.js' '**/**/*.js' '**/*.js' '*.js'",
     "prettier:text": "prettier 'README.md' 'doc/*.md' 'doc/**/*.md' --no-config --tab-width 4 --print-width 120 --write --prose-wrap always",
-    "test": "nyc --reporter=text mocha --recursive 'test/**/*.js' --reporter spec --timeout 5000 --ui bdd --exit --color true",
+    "test": "nyc --reporter=text mocha --recursive 'test/**/*.js' --reporter spec --timeout 8000 --ui bdd --exit --color true",
+    "test:expression": "nyc --reporter=text mocha --recursive 'test/unit/expressions/*.js' --reporter spec --timeout 5000 --ui bdd --exit --color true",
+    "test:multientity": "nyc --reporter=text mocha --recursive 'test/unit/ngsiv2/plugins/multientity-plugin_test.js' --reporter spec --timeout 5000 --ui bdd --exit --color true",
     "test:debug": "mocha --recursive 'test/**/*.js' --reporter spec --inspect-brk --timeout 30000 --ui bdd --exit",
     "test:coverage": "nyc --reporter=lcov mocha -- --recursive 'test/**/*.js' --reporter spec --timeout 5000 --exit",
     "test:coveralls": "npm run test:coverage && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage",
@@ -48,18 +50,18 @@
     "body-parser": "~1.19.0",
     "command-shell-lib": "1.0.0",
     "express": "~4.16.4",
-    "jexl": "2.1.1",
+    "got": "~11.8.2",
+    "jexl": "2.3.0",
     "jison": "0.4.18",
-    "logops": "2.1.0",
+    "logops": "2.1.2",
     "moment": "~2.24.0",
     "moment-timezone": "~0.5.25",
-    "mongodb": "3.2.3",
-    "mongoose": "5.7.5",
+    "mongodb": "3.6.8",
+    "mongoose": "5.7.7",
     "mu2": "~0.5.20",
     "query-string": "6.5.0",
-    "request": "2.88.0",
     "revalidator": "~0.3.1",
-    "underscore": "~1.9.1",
+    "underscore": "~1.12.1",
     "uuid": "~3.3.2"
   },
   "devDependencies": {
@@ -92,12 +94,10 @@
   },
   "lint-staged": {
     "*.md": [
-      "prettier --parser markdown --tab-width 4 --print-width 120 --write --prose-wrap always",
-      "git add"
+      "prettier --parser markdown --tab-width 4 --print-width 120 --write --prose-wrap always"
     ],
     "*.js": [
-      "prettier --config .prettierrc.json --write",
-      "git add"
+      "prettier --config .prettierrc.json --write"
     ]
   }
 }

package/test/tools/utils.js

@@ -22,6 +22,7 @@
  */
 
 const fs = require('fs');
+const request = require('../../lib/fiware-iotagent-lib').request;
 
 function readExampleFile(name, raw) {
     let text = null;
@@ -36,3 +37,4 @@ function readExampleFile(name, raw) {
 }
 
 exports.readExampleFile = readExampleFile;
+exports.request = request;

package/test/unit/examples/deviceProvisioningRequests/provisionAnotherDevice.json

@@ -3,7 +3,7 @@
     {
       "device_id": "Light2",
       "protocol": "GENERIC_PROTO",
-      "service" : "smartGondor",
+      "service" : "smartgondor",
       "service_path": "gardens",
       "entity_name": "TheSecondLight",
       "entity_type": "TheLightType",

package/test/unit/examples/deviceProvisioningRequests/provisionDeviceMissingParameters.json

@@ -2,7 +2,7 @@
   "devices": [
     {
       "protocol": "GENERIC_PROTO",
-      "service" : "smartGondor",
+      "service" : "smartgondor",
       "entity_name": "TheFirstLight",
       "attributes": [],
       "commands": [

package/test/unit/examples/deviceProvisioningRequests/provisionDuplicatedDev.json

@@ -3,7 +3,7 @@
     {
       "device_id": "Light1",
       "protocol": "GENERIC_PROTO",
-      "service" : "smartGondor",
+      "service" : "smartgondor",
       "service_path": "gardens",
       "entity_name": "TheFirstLight",
       "entity_type": "TheLightType"

package/test/unit/examples/deviceProvisioningRequests/provisionFullDevice.json

@@ -3,7 +3,7 @@
     {
       "device_id": "LightFull",
       "protocol": "GENERIC_PROTO",
-      "service" : "smartGondor",
+      "service" : "smartgondor",
       "service_path": "gardens",
       "entity_name": "TheFullLight",
       "entity_type": "TheLightType",

package/test/unit/examples/deviceProvisioningRequests/provisionNewDeviceMalformed1.json

@@ -1,7 +1,7 @@
 {
   "device_id": "Light1",
   "protocol": "GENERIC_PROTO",
-  "service" : "smartGondor",
+  "service" : "smartgondor",
   "service_path": "gardens",
   "entity_name": "TheFirstLight",
   "entity_type": "TheLightType",

package/test/unit/examples/groupProvisioningRequests/multipleGroupsCreation.json

@@ -41,4 +41,4 @@
       "attributes": []
     }
   ]
-}
+}

package/test/unit/examples/iotamRequests/registrationEmpty.json

@@ -1,7 +1,7 @@
 {
   "protocol": "GENERIC_PROTOCOL",
   "description": "A generic protocol",
-  "iotagent": "http://smartGondor.com/iot",
+  "iotagent": "http://smartgondor.com/iot",
   "resource": "/iot/d",
   "services": []
 }

package/test/unit/examples/iotamRequests/registrationWithGroups.json

@@ -1,7 +1,7 @@
 {
   "protocol": "GENERIC_PROTOCOL",
   "description": "A generic protocol",
-  "iotagent": "http://smartGondor.com/iot",
+  "iotagent": "http://smartgondor.com/iot",
   "resource": "/iot/d",
   "services": [
     {
@@ -10,7 +10,7 @@
       "cbHost":"http://unexistentHost:1026",
       "entity_type": "SensorMachine",
       "resource": "/deviceTest",
-      "service": "theService",
+      "service": "theservice",
       "service_path": "theSubService",
       "attributes": [
         {

package/test/unit/examples/iotamRequests/registrationWithGroupsWithoutCB.json

@@ -1,7 +1,7 @@
 {
   "protocol": "GENERIC_PROTOCOL",
   "description": "A generic protocol",
-  "iotagent": "http://smartGondor.com/iot",
+  "iotagent": "http://smartgondor.com/iot",
   "resource": "/iot/d",
   "services": [
     {
@@ -9,7 +9,7 @@
       "token": "8970A9078A803H3BL98PINEQRW8342HBAMS",
       "entity_type": "SensorMachine",
       "resource": "/deviceTest",
-      "service": "theService",
+      "service": "theservice",
       "service_path": "theSubService",
       "attributes": [
         {

package/test/unit/examples/iotamRequests/registrationWithStaticGroups.json

@@ -1,7 +1,7 @@
 {
   "protocol": "GENERIC_PROTOCOL",
   "description": "A generic protocol",
-  "iotagent": "http://smartGondor.com/iot",
+  "iotagent": "http://smartgondor.com/iot",
   "resource": "/iot/d",
   "services": [
     {
@@ -10,7 +10,7 @@
       "cbHost":"http://unexistentHost:1026",
       "entity_type": "SensorMachine",
       "resource": "/deviceTest",
-      "service": "theService",
+      "service": "theservice",
       "service_path": "theSubService",
       "attributes": [
         {

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

@@ -23,6 +23,7 @@
 
 const should = require('should');
 const expressionParser = require('../../../lib/plugins/jexlParser');
+expressionParser.setTransforms({});
 
 describe('Jexl expression interpreter', function () {
     const scope = {
@@ -203,6 +204,16 @@ describe('Jexl expression interpreter', function () {
         });
     });
 
+    describe('When an slice function is used with an string', function () {
+        it('should work on the expression value', function (done) {
+            expressionParser.parse('"AABBCC"|slice(2,4)', scope, function (error, result) {
+                should.not.exist(error);
+                result.should.equal('BB');
+                done();
+            });
+        });
+    });
+
     describe('When an ternary operator is used with an expression', function () {
         it('should work on the expression value', function (done) {
             expressionParser.parse('value == 6? true : false', scope, function (error, result) {
@@ -243,6 +254,97 @@ describe('Jexl expression interpreter', function () {
         });
     });
 
+    describe('When an transformstion map is provided', function () {
+        const niceMap = {
+            method1: (val) => val,
+            method2: (val) => val
+        };
+
+        const wrongMap = {
+            wrongTransformation1: 'not a function',
+            wrongTransformation2: 666,
+            rightTransformation: (val) => val
+        };
+
+        const noMap = "I'm not what you expect";
+
+        it('it should detect when it is not a map', function (done) {
+            const [error, message, resultMap] = expressionParser.checkTransformationMap(noMap);
+            should.exist(error);
+            message.should.equal('No trasformations were added to JEXL Parser');
+            resultMap.should.eql({});
+            done();
+        });
+
+        it('it should be empty {}', function (done) {
+            const [error, message, resultMap] = expressionParser.checkTransformationMap({});
+            should.not.exist(error);
+            message.should.equal('No trasformations were added to JEXL Parser');
+            resultMap.should.eql({});
+            done();
+        });
+
+        it('it should be empty null', function (done) {
+            const [error, message, resultMap] = expressionParser.checkTransformationMap(null);
+            should.not.exist(error);
+            message.should.equal('No trasformations were added to JEXL Parser');
+            resultMap.should.eql({});
+            done();
+        });
+
+        it('it should detect wrong transformations (not a funtion)', function (done) {
+            const [error, message, resultMap] = expressionParser.checkTransformationMap(wrongMap);
+            should.not.exist(error);
+            message.should.equal('wrongTransformation1,wrongTransformation2 must be a function');
+            should.not.exist(resultMap.wrongTransformation1);
+            should.not.exist(resultMap.wrongTransformation2);
+            should.exist(resultMap.rightTransformation);
+            done();
+        });
+
+        it('it should be correct (map of funtions)', function (done) {
+            const [error, message, resultMap] = expressionParser.checkTransformationMap(niceMap);
+            should.not.exist(error);
+            message.should.equal('Trasformations can be added to JEXL parser');
+            resultMap.should.eql(niceMap);
+            done();
+        });
+    });
+
+    describe('When a JSON parse transformation is applied', function () {
+        it('should work on the expression value', function (done) {
+            expressionParser.parse('"{\\"name\\":\\"John\\",\\"surname\\":\\"Doe\\"}"|jsonparse', scope, function (
+                error,
+                result
+            ) {
+                should.not.exist(error);
+                result.should.eql(scope.object);
+                done();
+            });
+        });
+    });
+
+    describe('When a JSON stringify transformation is applied', function () {
+        it('should work on the expression value', function (done) {
+            expressionParser.parse('{name: "John",surname: "Doe"}|jsonstringify', scope, function (error, result) {
+                should.not.exist(error);
+                result.should.equal(JSON.stringify(scope.object));
+                done();
+            });
+        });
+    });
+
+    describe('When a JSON with an NGSI operator is applied', function () {
+        it('should work on the expression value', function (done) {
+            const scope = { ina: 34, outa: 4 };
+            expressionParser.parse('{$inc:ina-outa}', scope, function (error, result) {
+                should.not.exist(error);
+                result.should.eql({ $inc: 30 });
+                done();
+            });
+        });
+    });
+
     describe('When an expression aims at creating an object', function () {
         it('it should work', function (done) {
             expressionParser.parse('{type:"Point",coordinates: [value,other]}', scope, function (error, result) {
@@ -252,4 +354,21 @@ describe('Jexl expression interpreter', function () {
             });
         });
     });
+
+    describe('When an expression access to non existent property', function () {
+        it('it should return null', function (done) {
+            expressionParser.parse('object["nothing"]', scope, function (error, result) {
+                should.not.exist(error);
+                should.equal(result, null);
+                done();
+            });
+        });
+        it('it should return null', function (done) {
+            expressionParser.parse('object["nothing"]?object["nothing"]:null', scope, function (error, result) {
+                should.not.exist(error);
+                should.equal(result, null);
+                done();
+            });
+        });
+    });
 });

package/test/unit/general/config-multi-core-test.js

@@ -52,7 +52,7 @@ const iotAgentConfig = {
             ]
         }
     },
-    providerUrl: 'http://smartGondor.com',
+    providerUrl: 'http://smartgondor.com',
     deviceRegistrationDuration: 'P1M',
     throttling: 'PT5S'
 };