iotagent-node-lib 2.23.0 → 2.24.0

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

@@ -387,8 +387,13 @@ function removeHiddenAttrsFromMultiEntity(entities, typeInformation, payload) {
                     ...jexlParser.extractContext(attsArray),
                     ...extractContextFromPayload(payload)
                 }; //maybe overlapping between this two objects.
-                const res = jexlParser.applyExpression(typeInformation.explicitAttrs, ctx, typeInformation);
-                explicitAttrsList = explicitAttrsList.concat(res);
+                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;
             });
         }
     }
@@ -438,8 +443,13 @@ function removeHiddenAttrs(result, typeInformation, payload) {
             ...jexlParser.extractContext(attsArray),
             ...extractContextFromPayload(payload)
         }; //maybe overlapping between this two objects. Measures not in active attrs.
-        const res = jexlParser.applyExpression(typeInformation.explicitAttrs, ctx, typeInformation);
-        explicitAttrsList = res;
+        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);

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

@@ -46,6 +46,21 @@ const overwritePaths = ['/ngsi-ld/v1/entities/:entity/attrs', '/ngsi-ld/v1/entit
 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.
@@ -59,6 +74,7 @@ function generateUpdateActionsNgsiLD(req, contextElement, callback) {
 
     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) {
@@ -75,19 +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(device.commands[j].name)) {
-                    commands.push({
-                        type: device.commands[j].type,
-                        value: req.body[device.commands[j].name].value,
-                        name: device.commands[j].name
-                    });
+                } 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;
                 }
             }
@@ -290,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);
@@ -316,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, []);
         }
     }
 
@@ -472,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])
+                        });
+                    }
                 }
             }
         }
@@ -563,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).
  *
@@ -601,6 +676,7 @@ function loadContextRoutesNGSILD(router) {
         handleNotificationNgsiLD,
         queryErrorHandlingNgsiLD
     ]);
+    loadUnsupportedEndpointsNGSILD(router);
 }
 
 exports.loadContextRoutes = loadContextRoutesNGSILD;

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

@@ -286,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);
                 }

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.23.0",
+  "version": "2.24.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",

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/mongodb-group-registry-test.js

@@ -448,4 +448,28 @@ describe('MongoDB Group Registry test', function () {
             });
         });
     });
+    
+    describe('When the device info request with name and type', function () {
+        beforeEach(function (done) {
+            async.series([async.apply(request, optionsCreation)], done);
+        });
+        
+        afterEach(function (done) {
+            iotAgentLib.clearRegistry(done);
+        });
+        
+        it('should return the name and type of device', function (done) {
+            request(optionsGet, function (error, response, body) {
+                should.exist(body);
+                should.exist(body.count);
+                body.count.should.equal(1);
+                should.exist(body.services);
+                should.exist(body.services.length);
+                body.services.length.should.equal(1);
+                should.exist(body.services[0].entity_type);
+                body.services[0].entity_type.should.equal('Light');
+                done();
+            });
+        });
+    });
 });

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

@@ -507,4 +507,53 @@ describe('NGSI-v2 - MongoDB Device Registry', function () {
             });
         });
     });
+    
+     describe('When the device is queried with the name and type', function () {
+        beforeEach(function (done) {
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .post('/v2/entities?options=upsert')
+                .times(10)
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .reply(204);
+
+            const devices = [];
+
+            for (let i = 0; i < 10; i++) {
+                devices.push({
+                    id: 'id' + i,
+                    type: 'Light' + i,
+                    internalId: 'internal' + i,
+                    service: 'smartgondor',
+                    subservice: 'gardens',
+                    active: [
+                        {
+                            id: 'attrId',
+                            type: 'attrType' + i,
+                            value: i
+                        }
+                    ]
+                });
+            }
+            iotAgentLib.activate(iotAgentConfig, function (error) {
+                async.map(devices, iotAgentLib.register, function (error, results) {
+                    done();
+                });
+            });
+        });
+        afterEach(function (done) {
+            iotAgentLib.clearRegistry(done);
+        });
+        it('should return the device with name and type', function (done) {
+            iotAgentLib.getDeviceByNameAndType('Light4:id4', 'Light4', 'smartgondor', 'gardens', function ( error, device ) {
+                should.not.exist(error);
+                should.exist(device);
+                should.exist(device.name);
+                should.exist(device.type);
+                device.name.should.equal('Light4:id4');
+                device.type.should.equal('Light4');
+                done();
+            });
+        });
+    });
 });

package/test/unit/ngsi-ld/examples/subscriptionRequests/bidirectionalNotificationWithDatasetId.json

@@ -0,0 +1,21 @@
+{
+    "data": [
+        {
+            "id": "TheFirstLight",
+            "location": [
+              {
+                    "type": "GeoProperty",
+                    "value": "12.4, -9.6",
+                    "datasetId": "urn:ngsi-ld:Property:do-this"
+              },
+              {
+                    "type": "GeoProperty",
+                    "value": "6, 10",
+                    "datasetId": "urn:ngsi-ld:Property:then-do-this"
+              }
+            ],
+            "type": "TheLightType"
+        }
+    ],
+    "subscriptionId": "51c0ac9ed714fb3b37d7d5a8"
+}

package/test/unit/ngsi-ld/examples/subscriptionRequests/bidirectionalNotificationWithMetadata.json

@@ -0,0 +1,17 @@
+{
+    "data": [
+        {
+            "id": "TheFirstLight",
+            "location": {
+                "type": "GeoProperty",
+                "value": "12.4, -9.6",
+                "qos": {
+                  "type": "Property",
+                  "value": 1
+                }
+            },
+            "type": "TheLightType"
+        }
+    ],
+    "subscriptionId": "51c0ac9ed714fb3b37d7d5a8"
+}