iotagent-node-lib 2.18.0 → 2.21.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',
@@ -182,6 +184,8 @@ function attributeToProvisioningAPIFormat(attribute) {
         entity_name: attribute.entity_name,
         entity_type: attribute.entity_type,
         mqtt: attribute.mqtt,
+        payloadType: attribute.payloadType,
+        contentType: attribute.contentType,
         metadata: attribute.metadata
     };
 }
@@ -204,6 +208,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,
@@ -317,6 +322,14 @@ function handleRemoveDevice(req, res, next) {
  * This middleware handles updates in the provisioning devices. The only attribute
  */
 function handleUpdateDevice(req, res, next) {
+    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 {
@@ -338,12 +351,19 @@ function handleUpdateDevice(req, res, next) {
                     if (req.body.entity_name || req.body.entity_type) {
                         isTypeOrNameUpdated = true;
                     }
-                    deviceService.updateRegister(newDevice, isTypeOrNameUpdated, function handleDeviceUpdate(error) {
-                        if (error) {
-                            next(error);
-                        } else {
-                            res.status(204).json({});
-                        }
+                    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));
@@ -392,6 +412,10 @@ function setProvisioningHandler(newHandler) {
     provisioningHandler = newHandler;
 }
 
+function setUpdatingHandler(newHandler) {
+    updatingHandler = newHandler;
+}
+
 function setRemoveDeviceHandler(newHandler) {
     removeDeviceHandler = newHandler;
 }
@@ -409,6 +433,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');

package/lib/templates/createDevice.json

@@ -173,6 +173,18 @@
                   "type": "string",
                   "pattern": "^([^<>();'=\"]+)*$"
                 },
+                "expression": {
+                  "description": "Optional expression for command transformation",
+                  "type": "string"
+                },
+                "payloadType": {
+                    "description": "Payload type",
+                    "type": "string"
+                },
+                "contentType": {
+                    "description": "Content type",
+                    "type": "string"
+                },
                 "mqtt": {
                   "description": "Mqtt properties",
                   "type": "object",

package/lib/templates/updateDevice.json

@@ -158,6 +158,18 @@
             "type": "string",
             "pattern": "^([^<>();'=\"]+)*$"
           },
+          "expression": {
+              "description": "Optional expression for command transformation",
+              "type": "string"
+          },
+          "payloadType": {
+              "description": "Payload type",
+              "type": "string"
+          },
+          "contentType": {
+              "description": "Content type",
+              "type": "string"
+          },
           "mqtt": {
               "description": "Mqtt properties",
               "type": "object",

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.18.0",
+  "version": "2.21.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",
@@ -21,22 +21,18 @@
   "bugs": {
     "url": "https://github.com/telefonicaid/iotagent-node-lib/issues"
   },
-  "bin": {
-    "agentConsole": "bin/agentConsole.js",
-    "iotAgentTester": "bin/iotAgentTester.js"
-  },
   "main": "lib/fiware-iotagent-lib",
   "engines": {
     "node": ">=12"
   },
   "scripts": {
     "clean": "rm -rf package-lock.json && rm -rf node_modules && rm -rf coverage",
-    "lint": "eslint lib/ bin/ test/ --cache --fix",
+    "lint": "eslint lib/ test/ --cache --fix",
     "lint:md": "remark  -f '*.md' 'doc/*.md'",
     "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",
@@ -46,20 +42,18 @@
     "watch": "watch 'npm test && npm run lint' ./lib ./test"
   },
   "dependencies": {
-    "async": "2.6.2",
+    "async": "2.6.4",
     "body-parser": "~1.19.0",
-    "command-shell-lib": "1.0.0",
     "express": "~4.16.4",
+    "got": "~11.8.2",
     "jexl": "2.3.0",
     "jison": "0.4.18",
-    "logops": "2.1.0",
-    "moment": "~2.24.0",
+    "logops": "2.1.2",
+    "moment": "~2.29.2",
     "moment-timezone": "~0.5.25",
-    "mongodb": "3.6.8",
-    "mongoose": "5.7.7",
-    "mu2": "~0.5.20",
+    "mongodb": "3.6.12",
+    "mongoose": "5.7.14",
     "query-string": "6.5.0",
-    "request": "2.88.0",
     "revalidator": "~0.3.1",
     "underscore": "~1.12.1",
     "uuid": "~3.3.2"

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/expressions/jexlExpression-test.js

@@ -269,7 +269,7 @@ describe('Jexl expression interpreter', function () {
         const noMap = "I'm not what you expect";
 
         it('it should detect when it is not a map', function (done) {
-            let [error, message, resultMap] = expressionParser.checkTransformationMap(noMap);
+            const [error, message, resultMap] = expressionParser.checkTransformationMap(noMap);
             should.exist(error);
             message.should.equal('No trasformations were added to JEXL Parser');
             resultMap.should.eql({});
@@ -277,7 +277,7 @@ describe('Jexl expression interpreter', function () {
         });
 
         it('it should be empty {}', function (done) {
-            let [error, message, resultMap] = expressionParser.checkTransformationMap({});
+            const [error, message, resultMap] = expressionParser.checkTransformationMap({});
             should.not.exist(error);
             message.should.equal('No trasformations were added to JEXL Parser');
             resultMap.should.eql({});
@@ -285,7 +285,7 @@ describe('Jexl expression interpreter', function () {
         });
 
         it('it should be empty null', function (done) {
-            let [error, message, resultMap] = expressionParser.checkTransformationMap(null);
+            const [error, message, resultMap] = expressionParser.checkTransformationMap(null);
             should.not.exist(error);
             message.should.equal('No trasformations were added to JEXL Parser');
             resultMap.should.eql({});
@@ -293,7 +293,7 @@ describe('Jexl expression interpreter', function () {
         });
 
         it('it should detect wrong transformations (not a funtion)', function (done) {
-            let [error, message, resultMap] = expressionParser.checkTransformationMap(wrongMap);
+            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);
@@ -303,7 +303,7 @@ describe('Jexl expression interpreter', function () {
         });
 
         it('it should be correct (map of funtions)', function (done) {
-            let [error, message, resultMap] = expressionParser.checkTransformationMap(niceMap);
+            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);

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

@@ -25,10 +25,10 @@
 
 const iotAgentLib = require('../../../lib/fiware-iotagent-lib');
 const utils = require('../../tools/utils');
+const request = utils.request;
 const should = require('should');
 const logger = require('logops');
 const nock = require('nock');
-const request = require('request');
 let contextBrokerMock;
 let keystoneMock;
 const iotAgentConfig = {

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

@@ -25,9 +25,9 @@
 
 const iotAgentLib = require('../../../lib/fiware-iotagent-lib');
 const utils = require('../../tools/utils');
+const request = utils.request;
 const should = require('should');
 const nock = require('nock');
-const request = require('request');
 const logger = require('logops');
 const async = require('async');
 const iotAgentConfig = {
@@ -187,14 +187,12 @@ describe('NGSI-v2 - Device Service: utils', function () {
                 .post('/v2/registrations')
                 .reply(201, null, { Location: '/v2/registrations/6319a7f5254b05844116584d' });
 
-
             contextBrokerMock
                 .matchHeader('fiware-service', 'testservice')
                 .matchHeader('fiware-servicepath', '/testingPath')
                 .post('/v2/entities?options=upsert')
                 .reply(204);
 
-
             async.series([request.bind(request, groupCreation), request.bind(request, deviceCreation)], function (
                 error,
                 results
@@ -222,11 +220,10 @@ describe('NGSI-v2 - Device Service: utils', function () {
                 .post('/v2/registrations')
                 .reply(201, null, { Location: '/v2/registrations/6319a7f5254b05844116584d' });
 
-
             contextBrokerMock
                 .matchHeader('fiware-service', 'testservice')
                 .matchHeader('fiware-servicepath', '/testingPath')
-                 .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert')
                 .reply(204);
 
             async.series([request.bind(request, groupCreation)], function (error, results) {

package/test/unit/general/loglevel-api_test.js

@@ -26,7 +26,8 @@
 const iotAgentLib = require('../../../lib/fiware-iotagent-lib');
 const should = require('should');
 const logger = require('logops');
-const request = require('request');
+const utils = require('../../tools/utils');
+const request = utils.request;
 const iotAgentConfig = {
     contextBroker: {
         host: '192.168.1.1',
@@ -129,10 +130,8 @@ describe('Log level API', function () {
 
         it('should return the current log level', function (done) {
             request(options, function (error, response, body) {
-                const parsedBody = JSON.parse(body);
-
-                should.exist(parsedBody.level);
-                parsedBody.level.should.equal('FATAL');
+                should.exist(body.level);
+                body.level.should.equal('FATAL');
 
                 done();
             });
@@ -158,9 +157,7 @@ describe('Log level API', function () {
                 response.statusCode.should.equal(400);
                 should.exist(body);
 
-                const parsedBody = JSON.parse(body);
-
-                parsedBody.error.should.equal('invalid log level');
+                body.error.should.equal('invalid log level');
 
                 done();
             });
@@ -183,9 +180,7 @@ describe('Log level API', function () {
                 response.statusCode.should.equal(400);
                 should.exist(body);
 
-                const parsedBody = JSON.parse(body);
-
-                parsedBody.error.should.equal('log level missing');
+                body.error.should.equal('log level missing');
 
                 done();
             });

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

@@ -28,6 +28,7 @@ const iotAgentLib = require('../../../lib/fiware-iotagent-lib');
 const should = require('should');
 const nock = require('nock');
 const utils = require('../../tools/utils');
+const request = utils.request;
 const config = require('../../../lib/commonConfig');
 const _ = require('underscore');
 const iotAgentConfig = {

package/test/unit/memoryRegistry/deviceRegistryMemory_test.js

@@ -28,6 +28,7 @@ const async = require('async');
 const should = require('should');
 const nock = require('nock');
 const utils = require('../../tools/utils');
+const request = utils.request;
 const iotAgentConfig = {
     logLevel: 'FATAL',
     contextBroker: {

package/test/unit/mongodb/mongodb-group-registry-test.js

@@ -28,8 +28,8 @@
 const iotAgentLib = require('../../../lib/fiware-iotagent-lib');
 const _ = require('underscore');
 const utils = require('../../tools/utils');
+const request = utils.request;
 const async = require('async');
-const request = require('request');
 const should = require('should');
 const iotAgentConfig = {
     logLevel: 'FATAL',

package/test/unit/mongodb/mongodb-registry-test.js

@@ -25,6 +25,7 @@
 
 const iotAgentLib = require('../../../lib/fiware-iotagent-lib');
 const utils = require('../../tools/utils');
+const request = utils.request;
 const should = require('should');
 const logger = require('logops');
 const mongo = require('mongodb').MongoClient;
@@ -375,7 +376,7 @@ describe('NGSI-v2 - MongoDB Device Registry', function () {
 
             contextBrokerMock.post('/v2/entities?options=upsert').reply(204);
 
-            contextBrokerMock.delete('/v2/registrations/6319a7f5254b05844116584d').reply(204);
+            contextBrokerMock.delete('/v2/registrations/6319a7f5254b05844116584d', '').reply(204);
 
             iotAgentLib.activate(iotAgentConfig, function (error) {
                 async.series(

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin12a.json

@@ -0,0 +1,7 @@
+[
+  {
+    "@context": "http://context.json-ld",
+    "id": "urn:ngsi-ld:Light:light1",
+    "type": "Light"
+  }
+]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin13.json

@@ -1,15 +1,15 @@
 [
-    {
-        "@context": "http://context.json-ld",
-        "consumption_x": {
-            "type": "Property",
-            "value": 200
-        },
-        "id": "urn:ngsi-ld:Light:light1",
-        "pressure": {
-            "type": "Property",
-            "value": 10
-        },
-        "type": "Light"
-    }
+  {
+    "@context": "http://context.json-ld",
+    "consumption_x": {
+      "type": "Property",
+      "value": 200
+    },
+    "pressure": {
+      "type": "Property",
+      "value": 10
+    },
+    "id": "urn:ngsi-ld:Light:light1",
+    "type": "Light"
+  }
 ]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin1a.json

@@ -0,0 +1,18 @@
+[
+  {
+    "@context": "http://context.json-ld",
+    "pressure": {
+      "type": "Property",
+      "value": 1040
+    },
+    "weather": {
+      "type": "Property",
+      "value": {
+        "@type": "Summary",
+        "@value": "Humidity NaN and pressure 1040"
+      }
+    },
+    "id": "urn:ngsi-ld:WeatherStation:ws1",
+    "type": "WeatherStation"
+  }
+]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin29.json

@@ -0,0 +1,18 @@
+[
+  {
+    "@context": "http://context.json-ld",
+    "pressure": {
+      "type": "Property",
+      "value": 1040
+    },
+    "weather": {
+      "type": "Property",
+      "value": {
+        "@type": "Summary",
+        "@value": "Humidity NaN and pressure 1040"
+      }
+    },
+    "id": "urn:ngsi-ld:WeatherStation:ws1",
+    "type": "WeatherStation"
+  }
+]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin31.json

@@ -0,0 +1,15 @@
+[
+  {
+    "@context": "http://context.json-ld",
+    "falsy": {
+      "type": "Property",
+      "value": false
+    },
+    "zero": {
+      "type": "Property",
+      "value": 0
+    },
+    "id": "urn:ngsi-ld:WeatherStation:ws1",
+    "type": "WeatherStation"
+  }
+]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin32.json

@@ -0,0 +1,17 @@
+[
+  {
+    "@context": "http://context.json-ld",
+    "location": {
+      "type": "GeoProperty",
+      "value": {
+        "coordinates": [
+          13,
+          52
+        ],
+        "type": "Point"
+      }
+    },
+    "id": "urn:ngsi-ld:GPS:gps1",
+    "type": "GPS"
+  }
+]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin33.json

@@ -0,0 +1,18 @@
+[
+  {
+    "@context": "http://context.json-ld",
+    "location": {
+      "type": "GeoProperty",
+      "value": {
+        "coordinates": [
+          13,
+          52
+        ],
+        "type": "Point"
+      },
+      "observedAt": "2015-08-05T07:35:01.468Z"
+    },
+    "id": "urn:ngsi-ld:GPS:gps1",
+    "type": "GPS"
+  }
+]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin34.json

@@ -0,0 +1,17 @@
+[
+  {
+    "@context": "http://context.json-ld",
+    "location": {
+      "type": "GeoProperty",
+      "value": {
+        "coordinates": [
+          13,
+          52
+        ],
+        "type": "Point"
+      }
+    },
+    "id": "urn:ngsi-ld:GPS:gps1",
+    "type": "GPS"
+  }
+]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin4a.json

@@ -0,0 +1,36 @@
+[
+        {
+            "@context": "http://context.json-ld",
+            "pressure25": {
+                "type": "Property",
+                "value": 52
+            },
+            "humidity12": {
+                "type": "Property",
+                "value": {
+                    "@type": "Percentage",
+                    "@value": "12"
+                }
+            },
+            "weather": {
+                "type": "Property",
+                "value": {
+                    "@type": "Summary",
+                    "@value": "Humidity 6 and pressure 1040"
+                }
+            },
+            "alive": {
+                "type": "Property",
+                "value": {
+                    "@type": "None",
+                    "@value": "undefined"
+                }
+            },
+            "updated": {
+                "type": "Property",
+                "value": true
+            },
+            "id": "urn:ngsi-ld:WeatherStation:ws1",
+            "type": "WeatherStation"
+        }
+    ]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin7.json

@@ -1,18 +1,18 @@
 [
-    {
-        "@context": "http://context.json-ld",
-        "id": "urn:ngsi-ld:Light:light1",
-        "revisions": {
-            "type": "Property",
-            "value": {
-                "@type": "Array",
-                "@value": [
-                    "v0.1",
-                    "v0.2",
-                    "v0.3"
-                ]
-            }
-        },
-        "type": "Light"
-    }
+  {
+    "@context": "http://context.json-ld",
+    "revisions": {
+      "type": "Property",
+      "value": {
+        "@type": "Array",
+        "@value": [
+          "v0.1",
+          "v0.2",
+          "v0.3"
+        ]
+      }
+    },
+    "id": "urn:ngsi-ld:Light:light1",
+    "type": "Light"
+  }
 ]