iotagent-node-lib 2.22.0 → 2.23.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,7 +383,10 @@ function removeHiddenAttrsFromMultiEntity(entities, typeInformation) {
         } else if (typeof typeInformation.explicitAttrs === 'string') {
             entities.forEach((entity) => {
                 const attsArray = pluginUtils.extractAttributesArrayFromNgsi2Entity(entity);
-                const ctx = jexlParser.extractContext(attsArray);
+                const ctx = {
+                    ...jexlParser.extractContext(attsArray),
+                    ...extractContextFromPayload(payload)
+                }; //maybe overlapping between this two objects.
                 const res = jexlParser.applyExpression(typeInformation.explicitAttrs, ctx, typeInformation);
                 explicitAttrsList = explicitAttrsList.concat(res);
             });
@@ -352,7 +394,10 @@ function removeHiddenAttrsFromMultiEntity(entities, typeInformation) {
     }
     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 +406,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,7 +434,10 @@ function removeHiddenAttrs(result, typeInformation) {
         }
     } else if (typeInformation.explicitAttrs && typeof typeInformation.explicitAttrs === 'string') {
         const attsArray = pluginUtils.extractAttributesArrayFromNgsi2Entity(result);
-        const ctx = jexlParser.extractContext(attsArray);
+        const ctx = {
+            ...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;
     }
@@ -481,7 +530,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 +538,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/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.22.0",
+  "version": "2.23.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",

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

@@ -1 +1,12 @@
-{"myattr":{"type": "String","value": "location"}}
+{
+    "mylocation": {
+        "type": "geo:json",
+        "value": {
+            "coordinates": [
+                13,
+                52
+            ],
+            "type": "Point"
+        }
+    }
+}

package/test/unit/ngsiv2/expressions/jexlBasedTransformations-test.js

@@ -271,7 +271,7 @@ const iotAgentConfig = {
                     expression: "{coordinates: [lon,lat], type: 'Point'}"
                 }
             ],
-            explicitAttrs: '[ "location" ]'
+            explicitAttrs: ' location&&price ? [ "location", "price" ] : location ? [ "location" ] : []'
         },
         GPS4: {
             commands: [],
@@ -314,12 +314,14 @@ const iotAgentConfig = {
                     type: 'number'
                 },
                 {
-                    name: 'location',
-                    type: 'geo:json',
-                    expression: "{coordinates: [lon,lat], type: 'Point'}"
+                    object_id: 'theLocation',
+                    name: 'mylocation',
+                    type: 'geo:json'
                 }
             ],
-            explicitAttrs: "[ 'myattr' ]"
+            explicitAttrs: "theLocation ? ['mylocation'] :  []"
+            // #1267 this is not working:
+            //explicitAttrs: "theLocation ? [{object_id: 'theLocation'}] :  []"
         },
         GPS6: {
             commands: [],
@@ -1184,9 +1186,9 @@ describe('Java expression language (JEXL) based transformations plugin', functio
                 value: 13
             },
             {
-                name: 'myattr',
-                type: 'String',
-                value: 'location'
+                name: 'theLocation',
+                type: 'geo:json',
+                value: { coordinates: [13, 52], type: 'Point' }
             },
             {
                 name: 'TimeInstant',