iotagent-node-lib 2.21.0 → 2.24.0

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

@@ -314,13 +314,52 @@ function sendQueryValueNgsi2(entityName, attributes, typeInformation, token, cal
     );
 }
 
+function extractContextFromPayload(payload) {
+    //{b: {value: 3,type: "string"},c: {value: false,type: "string"},d:{value: {g: 45},type: "string"},id: "tamcaysanto",type: "WaterTankMulti"}
+    //to
+    //{b:3,c:false,d:{g:45}}
+
+    let ctx = {};
+    for (const key in payload) {
+        if (key !== 'type' && key !== 'id') {
+            ctx[key] = payload[key].value;
+        }
+    }
+    return ctx;
+}
 /**
  * Remove id, type and any hidden attrs after processing
  *
  * @param {Object} enities           Unprocessed entities
  * @param {Object} typeInformation  Configuration information for the device.
  */
-function removeHiddenAttrsFromMultiEntity(entities, typeInformation) {
+function removeHiddenAttrsFromMultiEntity(entities, typeInformation, payload) {
+    function filterForEntity(entity, explicitAttrsList, typeInformation) {
+        let effectiveList = [];
+        for (const attr of explicitAttrsList) {
+            if (typeof attr === 'string') {
+                effectiveList.push(attr);
+            } else if (typeof attr === 'object' && attr.object_id) {
+                //find objectId in active attributes
+                for (const active of typeInformation.active) {
+                    if (active.object_id === attr.object_id) {
+                        if (
+                            active &&
+                            active.name &&
+                            active.entity_name &&
+                            active.entity_name === entity.id
+                            //if name is an expression it could fail... BUT IT WORKS!
+                        ) {
+                            effectiveList.push(active.name);
+                        }
+                        continue; //object_id must be unique
+                    }
+                }
+            }
+        }
+        return effectiveList;
+    }
+
     let explicitAttrsList;
     if (typeInformation.explicitAttrs) {
         explicitAttrsList = [];
@@ -344,15 +383,26 @@ function removeHiddenAttrsFromMultiEntity(entities, typeInformation) {
         } else if (typeof typeInformation.explicitAttrs === 'string') {
             entities.forEach((entity) => {
                 const attsArray = pluginUtils.extractAttributesArrayFromNgsi2Entity(entity);
-                const ctx = jexlParser.extractContext(attsArray);
-                const res = jexlParser.applyExpression(typeInformation.explicitAttrs, ctx, typeInformation);
-                explicitAttrsList = explicitAttrsList.concat(res);
+                const ctx = {
+                    ...jexlParser.extractContext(attsArray),
+                    ...extractContextFromPayload(payload)
+                }; //maybe overlapping between this two objects.
+                let res = null;
+                try {
+                    res = jexlParser.applyExpression(typeInformation.explicitAttrs, ctx, typeInformation);
+                } catch (e) {
+                    // nothing to do: exception is already logged at info level
+                }
+                explicitAttrsList = res ? explicitAttrsList.concat(res) : explicitAttrsList;
             });
         }
     }
     if (explicitAttrsList && explicitAttrsList.length >= 0) {
         entities.forEach((entity) => {
-            const hidden = _.difference(_.keys(entity), explicitAttrsList);
+            //some attrs are object_ids {object_id:oid} and need to be resolved for this entity
+            //"explicitAttrs" : "attrA?['attrA',{object_id:'foo'}]:['attrB',{object_id:'bar'}]",
+            let efectiveAttrsList = filterForEntity(entity, explicitAttrsList, typeInformation);
+            const hidden = _.difference(_.keys(entity), efectiveAttrsList);
             logger.debug(context, 'removeHiddenAttrsFromMultiEntity %s from entity %s', hidden, entity);
             hidden.forEach((attr) => {
                 delete entity[attr];
@@ -361,13 +411,14 @@ function removeHiddenAttrsFromMultiEntity(entities, typeInformation) {
     }
     return entities;
 }
+
 /**
  * Remove id, type and any hidden attrs after processing
  *
  * @param {Object} result           An Unprocessed entity
  * @param {Object} typeInformation  Configuration information for the device.
  */
-function removeHiddenAttrs(result, typeInformation) {
+function removeHiddenAttrs(result, typeInformation, payload) {
     delete result.id;
     delete result.type;
     let explicitAttrsList;
@@ -388,9 +439,17 @@ function removeHiddenAttrs(result, typeInformation) {
         }
     } else if (typeInformation.explicitAttrs && typeof typeInformation.explicitAttrs === 'string') {
         const attsArray = pluginUtils.extractAttributesArrayFromNgsi2Entity(result);
-        const ctx = jexlParser.extractContext(attsArray);
-        const res = jexlParser.applyExpression(typeInformation.explicitAttrs, ctx, typeInformation);
-        explicitAttrsList = res;
+        const ctx = {
+            ...jexlParser.extractContext(attsArray),
+            ...extractContextFromPayload(payload)
+        }; //maybe overlapping between this two objects. Measures not in active attrs.
+        let res = null;
+        try {
+            res = jexlParser.applyExpression(typeInformation.explicitAttrs, ctx, typeInformation);
+        } catch (e) {
+            // nothing to do: exception is already logged at info level
+        }
+        explicitAttrsList = res ? res : [];
     }
     if (explicitAttrsList && explicitAttrsList.length >= 0) {
         const hidden = _.difference(_.keys(result), explicitAttrsList);
@@ -481,7 +540,7 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
                         }
                         options.json = {
                             actionType: 'append',
-                            entities: removeHiddenAttrsFromMultiEntity(result, typeInformation)
+                            entities: removeHiddenAttrsFromMultiEntity(result, typeInformation, payload)
                         };
                         if (config.getConfig().appendMode === true) {
                             options.json.actionType = 'append';
@@ -489,7 +548,7 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
                             options.json.actionType = 'update';
                         }
                     } else {
-                        options.json = removeHiddenAttrs(result, typeInformation);
+                        options.json = removeHiddenAttrs(result, typeInformation, payload);
                         logger.debug(context, 'typeInformation: %j', typeInformation);
                         if (
                             'timestamp' in typeInformation && typeInformation.timestamp !== undefined

package/lib/services/ngsi/ngsiService.js

@@ -133,7 +133,7 @@ function executeWithDeviceInformation(operationFunction) {
             deviceInformation
         );
         const currentType = type ? type : deviceInformation.type;
-        config.getGroupRegistry().getType(currentType, function (error, deviceGroup) {
+        config.getGroupRegistry().getTypeSilently(currentType, function (error, deviceGroup) {
             let typeInformation;
             const configDeviceInfo = config.getConfig().types[currentType];
             if (error) {

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

@@ -42,9 +42,25 @@ const notificationTemplateNgsiLD = require('../../templates/notificationTemplate
 const contextServerUtils = require('./contextServerUtils');
 const ngsiLD = require('../ngsi/entities-NGSI-LD');
 
-const updatePaths = ['/ngsi-ld/v1/entities/:entity/attrs/:attr'];
+const overwritePaths = ['/ngsi-ld/v1/entities/:entity/attrs', '/ngsi-ld/v1/entities/:entity/attrs/:attr'];
+const updatePaths = ['/ngsi-ld/v1/entities/:entity/attrs', '/ngsi-ld/v1/entities/:entity/attrs/:attr'];
 const queryPaths = ['/ngsi-ld/v1/entities/:entity'];
 
+/**
+ * Extract metadata attributes from input.
+ *
+ * @param {Object} obj                  input object
+ */
+function getMetaData(obj) {
+    const excludedKeys = ['datasetId', 'value', 'type'];
+    const metaData = {};
+    _.keys(obj).forEach((key) => {
+        if (!excludedKeys.includes(key)) {
+            metaData[key] = obj[key];
+        }
+    });
+    return !_.isEmpty(metaData) ? metaData : {};
+}
 /**
  * Generate all the update actions corresponding to a update context request using Ngsi2.
  * Update actions include updates in attributes and execution of commands.
@@ -55,8 +71,11 @@ const queryPaths = ['/ngsi-ld/v1/entities/:entity'];
 function generateUpdateActionsNgsiLD(req, contextElement, callback) {
     let entityId;
     let entityType;
+
     const attribute = req.params.attr;
     const value = req.body.value;
+    const datasetId = req.body.datasetId;
+    const incomingAttrs = !req.params.attr ? _.keys(req.body) : [];
 
     if (contextElement.id && contextElement.type) {
         entityId = contextElement.id;
@@ -72,12 +91,49 @@ function generateUpdateActionsNgsiLD(req, contextElement, callback) {
 
         if (device.commands) {
             for (const j in device.commands) {
-                if (attribute === device.commands[j].name) {
-                    commands.push({
-                        type: device.commands[j].type,
-                        value,
-                        name: attribute
-                    });
+                const name = device.commands[j].name;
+                if (attribute === name) {
+                    if (_.isArray(req.body)) {
+                        req.body[name].forEach((obj) => {
+                            commands.push({
+                                type: device.commands[j].type,
+                                value: obj.value,
+                                name: name,
+                                datasetId: obj.datasetId,
+                                metadata: getMetaData(obj)
+                            });
+                        });
+                    } else {
+                        commands.push({
+                            type: device.commands[j].type,
+                            value,
+                            name,
+                            datasetId,
+                            metadata: getMetaData(req.body)
+                        });
+                    }
+                    found = true;
+                } else if (incomingAttrs.includes(name)) {
+                    if (_.isArray(req.body[name])) {
+                        req.body[name].forEach((obj) => {
+                            commands.push({
+                                type: device.commands[j].type,
+                                value: obj.value,
+                                name: name,
+                                datasetId: obj.datasetId,
+                                metadata: getMetaData(obj)
+                            });
+                        });
+                    } else {
+                        const obj = req.body[name];
+                        commands.push({
+                            type: device.commands[j].type,
+                            value: obj.value,
+                            name: name,
+                            datasetId: obj.datasetId,
+                            metadata: getMetaData(obj)
+                        });
+                    }
                     found = true;
                 }
             }
@@ -280,7 +336,7 @@ function handleQueryNgsiLD(req, res, next) {
 
         if (device.staticAttributes) {
             let selectedAttributes = [];
-            if (attributes === undefined || attributes.length === 0) {
+            if (attributes === null || attributes === undefined || attributes.length === 0) {
                 selectedAttributes = device.staticAttributes;
             } else {
                 selectedAttributes = device.staticAttributes.filter(inAttributes);
@@ -306,8 +362,8 @@ function handleQueryNgsiLD(req, res, next) {
             const results = device.lazy.map(getName);
             callback(null, results);
         } else {
-            logger.debug(context, "Couldn't find any attributes. Handling with null reference");
-            callback(null, null);
+            logger.debug(context, "Couldn't find any attributes. Handling with empty reference");
+            callback(null, []);
         }
     }
 
@@ -462,11 +518,25 @@ function handleNotificationNgsiLD(req, res, next) {
             /* eslint-disable-next-line  no-prototype-builtins */
             if (dataElement.hasOwnProperty(key)) {
                 if (key !== 'id' && key !== 'type') {
-                    const att = {};
-                    att.type = dataElement[key].type;
-                    att.value = dataElement[key].value;
-                    att.name = key;
-                    atts.push(att);
+                    if (_.isArray(dataElement[key])) {
+                        dataElement[key].forEach((obj) => {
+                            atts.push({
+                                type: obj.type,
+                                value: obj.value,
+                                name: key,
+                                datasetId: obj.datasetId,
+                                metadata: getMetaData(obj)
+                            });
+                        });
+                    } else {
+                        atts.push({
+                            type: dataElement[key].type,
+                            value: dataElement[key].value,
+                            name: key,
+                            datasetId: dataElement[key].datasetId,
+                            metadata: getMetaData(dataElement[key])
+                        });
+                    }
                 }
             }
         }
@@ -553,6 +623,21 @@ function updateErrorHandlingNgsiLD(error, req, res, next) {
     });
 }
 
+/**
+ * Load unsupported NGSI-LD entity routes and return proper NGSI-LD not supported responses
+ *
+ * @param {Object} router      Express request router object.
+ */
+function loadUnsupportedEndpointsNGSILD(router) {
+    const unsupportedEndpoint = function (req, res) {
+        return res.status(501).send(new errors.MethodNotSupported(req.method, req.path));
+    };
+    router.get('/ngsi-ld/v1/entities', unsupportedEndpoint);
+    router.post('/ngsi-ld/v1/entities', unsupportedEndpoint);
+    router.delete('/ngsi-ld/v1/entities/:entity', unsupportedEndpoint);
+    router.delete('/ngsi-ld/v1/entities/:entity/attrs/:attr', unsupportedEndpoint);
+}
+
 /**
  * Load the routes related to context dispatching (NGSI10 calls).
  *
@@ -573,6 +658,15 @@ function loadContextRoutesNGSILD(router) {
             updateErrorHandlingNgsiLD
         ]);
     }
+
+    for (i = 0; i < overwritePaths.length; i++) {
+        router.put(overwritePaths[i], [
+            middlewares.ensureType,
+            middlewares.validateJson(updateContextTemplateNgsiLD),
+            handleUpdateNgsiLD,
+            updateErrorHandlingNgsiLD
+        ]);
+    }
     for (i = 0; i < queryPaths.length; i++) {
         router.get(queryPaths[i], [handleQueryNgsiLD, queryErrorHandlingNgsiLD]);
     }
@@ -582,6 +676,7 @@ function loadContextRoutesNGSILD(router) {
         handleNotificationNgsiLD,
         queryErrorHandlingNgsiLD
     ]);
+    loadUnsupportedEndpointsNGSILD(router);
 }
 
 exports.loadContextRoutes = loadContextRoutesNGSILD;

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

@@ -217,7 +217,11 @@ function handleUpdateNgsi2(req, res, next) {
             }
         );
     } else {
-        logger.error(context, 'Tried to handle an update request before the update handler was stablished.');
+        logger.error(
+            context,
+            'Tried to handle an update request [%j] before the update handler was stablished.',
+            req.body
+        );
 
         const errorNotFound = new Error({
             message: 'Update handler not found'
@@ -282,6 +286,7 @@ function handleNotificationNgsi2(req, res, next) {
                     const att = {};
                     att.type = dataElement[key].type;
                     att.value = dataElement[key].value;
+                    att.metadata = dataElement[key].metadata || {};
                     att.name = key;
                     atts.push(att);
                 }
@@ -381,7 +386,7 @@ function queryErrorHandlingNgsi2(error, req, res, next) {
 function updateErrorHandlingNgsi2(error, req, res, next) {
     let code = 500;
 
-    logger.debug(context, 'Update NGSIv2 error [%s] handing request: %s', error.name, error.message);
+    logger.debug(context, 'Update NGSIv2 error [%j] handing request: %j', error, req.body);
 
     if (error.code && String(error.code).match(/^[2345]\d\d$/)) {
         code = error.code;
@@ -533,7 +538,7 @@ function handleQueryNgsi2(req, res, next) {
             logger.debug(context, 'There was an error handling the query: %s.', error);
             next(error);
         } else {
-            logger.debug(context, 'Query from [%s] handled successfully.', req.get('host'));
+            logger.debug(context, 'Query from [%s] handled successfully. req %s', req.get('host'), req);
             res.status(200).json(result);
         }
     }

package/lib/services/northBound/contextServerUtils.js

@@ -41,10 +41,10 @@ const commands = require('../commands/commandService');
  * @return {String}                 The Tenant decribed in the request headers
  */
 function getLDTenant(req) {
-    if (req.headers['NGSILD-Tenant']) {
-        return req.headers['NGSILD-Tenant'];
-    } else if (req.headers['fiware-service']) {
-        return req.headers['fiware-service'];
+    if (req.header('NGSILD-Tenant')) {
+        return req.header('NGSILD-Tenant');
+    } else if (req.header('fiware-service')) {
+        return req.header('fiware-service');
     }
     return config.getConfig().contextBroker.fallbackTenant;
 }
@@ -56,10 +56,10 @@ function getLDTenant(req) {
  * obliged to offer service headers - this is still being defined in the NGSI-LD specifications.
  */
 function getLDPath(req) {
-    if (req.headers['NGSILD-Path']) {
-        return req.headers['NGSILD-Path'];
-    } else if (req.headers['fiware-servicepath']) {
-        return req.headers['fiware-servicepath'];
+    if (req.header('NGSILD-Path')) {
+        return req.header('NGSILD-path');
+    } else if (req.header('fiware-servicepath')) {
+        return req.header('fiware-servicepath');
     }
     return config.getConfig().contextBroker.fallbackPath;
 }
@@ -112,7 +112,7 @@ function executeUpdateSideEffects(device, id, type, service, subservice, attribu
  * @param {Array}  attributes       List of attributes to update with their types and values.
  */
 function pushCommandsToQueue(device, id, type, service, subservice, attributes, callback) {
-    async.map(attributes, apply(commands.add, service, subservice, device.id), callback);
+    async.map(attributes, apply(commands.addCmd, service, subservice, device), callback);
 }
 
 exports.notificationMiddlewares = [];

package/lib/services/northBound/deviceProvisioningServer.js

@@ -63,7 +63,8 @@ const provisioningAPITranslation = {
     autoprovision: 'autoprovision',
     explicitAttrs: 'explicitAttrs',
     expressionLanguage: 'expressionLanguage',
-    ngsiVersion: 'ngsiVersion'
+    ngsiVersion: 'ngsiVersion',
+    entityNameExp: 'entityNameExp'
 };
 
 /**

package/lib/templates/createDevice.json

@@ -41,8 +41,7 @@
             "type": "string"
           },
           "explicitAttrs": {
-            "description": "Flag about only provisioned attributes will be processed to Context Broker",
-            "type": "boolean"
+            "description": "Flag about only provisioned attributes will be processed to Context Broker"
           },
           "ngsiVersion": {
             "description": "NGSI Interface for this device",

package/lib/templates/createDeviceLax.json

@@ -41,8 +41,7 @@
             "type": "boolean"
           },
           "explicitAttrs": {
-            "description": "Flag about only provisioned attributes will be processed to Context Broker",
-            "type": "boolean"
+            "description": "Flag about only provisioned attributes will be processed to Context Broker"
           },
           "ngsiVersion": {
             "description": "NGSI Interface for this device",
@@ -181,4 +180,4 @@
       }
     }
   }
-}
+}

package/lib/templates/updateDevice.json

@@ -198,8 +198,7 @@
       "type": "array"
     },
     "explicitAttrs": {
-      "description": "Flag to decide update of active attributes only",
-      "type": "Boolean"
+      "description": "Flag to decide update of active attributes only"
     },
     "ngsiVersion": {
         "description": "NGSI Interface for this device",

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.21.0",
+  "version": "2.24.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",
@@ -43,41 +43,41 @@
   },
   "dependencies": {
     "async": "2.6.4",
-    "body-parser": "~1.19.0",
-    "express": "~4.16.4",
-    "got": "~11.8.2",
+    "body-parser": "~1.20.0",
+    "express": "~4.18.1",
+    "got": "~11.8.5",
     "jexl": "2.3.0",
     "jison": "0.4.18",
     "logops": "2.1.2",
     "moment": "~2.29.2",
-    "moment-timezone": "~0.5.25",
-    "mongodb": "3.6.12",
-    "mongoose": "5.7.14",
-    "query-string": "6.5.0",
+    "moment-timezone": "~0.5.34",
+    "mongoose": "5.13.14",
+    "query-string": "7.1.1",
     "revalidator": "~0.3.1",
-    "underscore": "~1.12.1",
-    "uuid": "~3.3.2"
+    "underscore": "~1.13.4",
+    "uuid": "~8.3.2"
   },
   "devDependencies": {
-    "coveralls": "~3.1.0",
-    "eslint": "~7.5.0",
-    "eslint-config-tamia": "~7.2.5",
-    "eslint-plugin-prettier": "~3.1.4",
+    "coveralls": "~3.1.1",
+    "eslint": "~8.18.0",
+    "eslint-config-tamia": "~8.0.0",
+    "eslint-plugin-prettier": "~4.0.0",
     "husky": "~4.2.5",
-    "lint-staged": "~10.2.11",
-    "prettier": "~2.0.5",
-    "mocha": "8.0.1",
-    "nock": "13.0.3",
+    "lint-staged": "~12.3.8",
+    "mocha": "10.0.0",
+    "mongodb": "4.7.0",
+    "nock": "13.2.7",
     "nyc": "~15.1.0",
-    "remark-cli": "~8.0.1",
-    "remark-preset-lint-recommended": "~4.0.1",
+    "prettier": "~2.7.1",
+    "remark-cli": "~10.0.1",
+    "remark-preset-lint-recommended": "~6.1.2",
     "should": "13.2.3",
-    "sinon": "~9.0.2",
-    "textlint": "~11.7.6",
+    "sinon": "~14.0.0",
+    "textlint": "~12.2.1",
     "textlint-filter-rule-comments": "~1.2.2",
     "textlint-rule-common-misspellings": "~1.0.1",
-    "textlint-rule-terminology": "~2.1.4",
-    "textlint-rule-write-good": "~1.6.2",
+    "textlint-rule-terminology": "~3.0.2",
+    "textlint-rule-write-good": "~2.0.0",
     "timekeeper": "2.2.0",
     "watch": "~1.0.2"
   },

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

@@ -0,0 +1,14 @@
+{
+  "devices": [
+    {
+      "device_id": "MicroLight1",
+      "protocol": "GENERIC_PROTO",
+      "attributes": [
+        {
+          "name": "attr_name",
+          "type": "string"
+        }
+      ]
+    }
+  ]
+}

package/test/unit/memoryRegistry/deviceRegistryMemory_test.js

@@ -194,4 +194,55 @@ describe('NGSI-v2 - In memory device registry', function () {
             });
         });
     });
+  
+    describe('When a the registry is queried for device in a particular name and type', function (){
+	    beforeEach(function (done) {
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .post('/v2/entities?options=upsert')
+                .times(10)
+                .reply(204);
+
+            const devices = [];
+
+            for (let i = 0; i < 10; i++) 
+            {
+                devices.push(
+                {
+                    id: 'id' + i,
+                    name : 'name' + i,
+                    type: 'Light' + i,
+                    internalId: 'internal' + i,
+                    service: 'smartgondor',
+                    subservice: 'gardens',
+                    active: [ {
+                            id: 'attrId',
+                            type: 'attrType' + i,
+                            value: i
+                        }]
+                });
+            }
+
+            async.map(devices, iotAgentLib.register, function (error, results) {
+                done();
+            });
+        });
+
+        afterEach(function (done) {
+            iotAgentLib.clearRegistry(done);
+        });
+        it('should return the name and type of device', function (done)
+        {
+            iotAgentLib.getDeviceByNameAndType('name5', 'Light5','smartgondor', 'gardens' ,function(error, device)
+            {
+                should.not.exist(error);
+                should.exist(device);
+                should.exist(device.name);
+                should.exist(device.type);
+                device.name.should.equal('name5');
+                device.type.should.equal('Light5');
+                Object.keys(device).length.should.equal(11);
+                done();
+            });
+        });
+    });
 });

package/test/unit/mongodb/mongoDBUtils.js

@@ -29,7 +29,7 @@ const async = require('async');
 function cleanDb(host, name, callback) {
     const url = 'mongodb://' + host + ':27017/' + name;
 
-    MongoClient.connect(url, { useNewUrlParser: true }, function (err, db) {
+    MongoClient.connect(url, function (err, db) {
         if (db && db.db()) {
             db.db().dropDatabase(function (err, result) {
                 db.close();
@@ -46,7 +46,7 @@ function cleanDbs(callback) {
 function populate(host, dbName, entityList, collectionName, callback) {
     const url = 'mongodb://' + host + ':27017/' + dbName;
 
-    MongoClient.connect(url, { useNewUrlParser: true }, function (err, db) {
+    MongoClient.connect(url, function (err, db) {
         if (db) {
             db.db()
                 .collection(collectionName)