iotagent-node-lib 2.17.0 → 2.20.0

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

@@ -25,7 +25,7 @@
 
 /* eslint-disable consistent-return */
 
-const request = require('request');
+const request = require('../../request-shim');
 const statsService = require('./../stats/statsRegistry');
 const async = require('async');
 const apply = async.apply;
@@ -34,6 +34,7 @@ const errors = require('../../errors');
 const utils = require('../northBound/restUtils');
 const config = require('../../commonConfig');
 const constants = require('../../constants');
+const jexlParser = require('../../plugins/jexlParser');
 const moment = require('moment-timezone');
 const logger = require('logops');
 const _ = require('underscore');
@@ -43,19 +44,8 @@ const context = {
 const NGSIv2 = require('./entities-NGSI-v2');
 const NGSIUtils = require('./ngsiUtils');
 
-const NGSI_LD_NULL = { '@type': 'Intangible', '@value': null };
 const NGSI_LD_URN = 'urn:ngsi-ld:';
 
-/**
- * Determines if a value is a number - Not a Number replaced by Null
- *
- * @param      {String}   value       Value to be analyzed
- * @return     {Number}
- */
-function valueOfOrNull(value) {
-    return isNaN(value) ? NGSI_LD_NULL : value;
-}
-
 /**
  * Amends an NGSIv2 attribute to NGSI-LD format
  * All native JSON types are respected and cast as Property values
@@ -66,100 +56,112 @@ function valueOfOrNull(value) {
  *                                   format
  */
 
-function convertNGSIv2ToLD(attr) {
-    const obj = { type: 'Property', value: attr.value };
-
-    if (attr.value === null){
-        obj.value = NGSI_LD_NULL;
-    } else {
-        switch (attr.type.toLowerCase()) {
-            // Properties
-            case 'property':
-            case 'string':
-                break;
-
-            // Other Native JSON Types
-            case 'boolean':
-                obj.value = !!attr.value;
-                break;
-            case 'float':
-                obj.value = valueOfOrNull(Number.parseFloat(attr.value));
-                break;
-            case 'integer':
-                obj.value = valueOfOrNull(Number.parseInt(attr.value));
-                break;
-            case 'number':
-                if (NGSIUtils.isFloat(attr.value)) {
-                    obj.value = valueOfOrNull(Number.parseFloat(attr.value));
-                } else {
-                    obj.value = valueOfOrNull(Number.parseInt(attr.value));
-                }
-                break;
-
-            // Temporal Properties
-            case 'datetime':
-                obj.value = {
-                    '@type': 'DateTime',
-                    '@value': moment.tz(attr.value, 'Etc/UTC').toISOString()
-                };
-                break;
-            case 'date':
-                obj.value = {
-                    '@type': 'Date',
-                    '@value': moment.tz(attr.value, 'Etc/UTC').format(moment.HTML5_FMT.DATE)
-                };
-                break;
-            case 'time':
-                obj.value = {
-                    '@type': 'Time',
-                    '@value': moment.tz(attr.value, 'Etc/UTC').format(moment.HTML5_FMT.TIME_SECONDS)
-                };
-                break;
-
-            // GeoProperties
-            case 'geoproperty':
-            case 'point':
-            case 'geo:point':
-            case 'geo:json':
-                obj.type = 'GeoProperty';
-                obj.value = NGSIUtils.getLngLats('Point', attr.value);
-                break;
-            case 'linestring':
-            case 'geo:linestring':
-                obj.type = 'GeoProperty';
-                obj.value = NGSIUtils.getLngLats('LineString', attr.value);
-                break;
-            case 'polygon':
-            case 'geo:polygon':
-                obj.type = 'GeoProperty';
-                obj.value = NGSIUtils.getLngLats('Polygon', attr.value);
-                break;
-            case 'multipoint':
-            case 'geo:multipoint':
-                obj.type = 'GeoProperty';
-                obj.value = NGSIUtils.getLngLats('MultiPoint', attr.value);;
-                break;
-            case 'multilinestring':
-            case 'geo:multilinestring':
-                obj.type = 'GeoProperty';
-                obj.value = NGSIUtils.getLngLats( 'MultiLineString', attr.value);
-                break;
-            case 'multipolygon':
-            case 'geo:multipolygon':
-                obj.type = 'GeoProperty';
-                obj.value = NGSIUtils.getLngLats( 'MultiPolygon', attr.value);
-                break;
-
-            // Relationships
-            case 'relationship':
-                obj.type = 'Relationship';
-                obj.object = attr.value;
-                delete obj.value;
-                break;
+function convertAttrNGSILD(attr) {
+    // eslint eqeqeq - deliberate double equals to include undefined.
+    if (attr.value == null || Number.isNaN(attr.value)) {
+        return undefined;
+    }
+    let obj = { type: 'Property', value: attr.value };
+
+    switch (attr.type.toLowerCase()) {
+        // Properties
+        case 'property':
+        case 'string':
+        case 'text':
+        case 'textunrestricted':
+            break;
+
+        // Other Native JSON Types
+        case 'boolean':
+            obj.value = !!attr.value;
+            break;
+        case 'float':
+            if (isNaN(attr.value)) {
+                obj = undefined;
+            } else {
+                obj.value = Number.parseFloat(attr.value);
+            }
+            break;
+        case 'integer':
+            if (isNaN(attr.value)) {
+                obj = undefined;
+            } else {
+                obj.value = Number.parseInt(attr.value);
+            }
+            break;
+        case 'number':
+            if (isNaN(attr.value)) {
+                obj = undefined;
+            } else if (NGSIUtils.isFloat(attr.value)) {
+                obj.value = Number.parseFloat(attr.value);
+            } else {
+                obj.value = Number.parseInt(attr.value);
+            }
+            break;
 
-            default:
-                obj.value = { '@type': attr.type, '@value': attr.value };
-        }
+        // Temporal Properties
+        case 'datetime':
+            obj.value = {
+                '@type': 'DateTime',
+                '@value': moment.tz(attr.value, 'Etc/UTC').toISOString()
+            };
+            break;
+        case 'date':
+            obj.value = {
+                '@type': 'Date',
+                '@value': moment.tz(attr.value, 'Etc/UTC').format(moment.HTML5_FMT.DATE)
+            };
+            break;
+        case 'time':
+            obj.value = {
+                '@type': 'Time',
+                '@value': moment.tz(attr.value, 'Etc/UTC').format(moment.HTML5_FMT.TIME_SECONDS)
+            };
+            break;
+
+        // GeoProperties
+        case 'geoproperty':
+        case 'point':
+        case 'geo:point':
+        case 'geo:json':
+            obj.type = 'GeoProperty';
+            obj.value = NGSIUtils.getLngLats('Point', attr.value);
+            break;
+        case 'linestring':
+        case 'geo:linestring':
+            obj.type = 'GeoProperty';
+            obj.value = NGSIUtils.getLngLats('LineString', attr.value);
+            break;
+        case 'polygon':
+        case 'geo:polygon':
+            obj.type = 'GeoProperty';
+            obj.value = NGSIUtils.getLngLats('Polygon', attr.value);
+            break;
+        case 'multipoint':
+        case 'geo:multipoint':
+            obj.type = 'GeoProperty';
+            obj.value = NGSIUtils.getLngLats('MultiPoint', attr.value);
+            break;
+        case 'multilinestring':
+        case 'geo:multilinestring':
+            obj.type = 'GeoProperty';
+            obj.value = NGSIUtils.getLngLats('MultiLineString', attr.value);
+            break;
+        case 'multipolygon':
+        case 'geo:multipolygon':
+            obj.type = 'GeoProperty';
+            obj.value = NGSIUtils.getLngLats('MultiPolygon', attr.value);
+            break;
+
+        // Relationships
+        case 'relationship':
+            obj.type = 'Relationship';
+            obj.object = attr.value;
+            delete obj.value;
+            break;
+
+        default:
+            obj.value = { '@type': attr.type, '@value': attr.value };
     }
 
     if (attr.metadata) {
@@ -178,7 +180,7 @@ function convertNGSIv2ToLD(attr) {
                     obj.unitCode = attr.metadata[key].value;
                     break;
                 default:
-                    obj[key] = convertNGSIv2ToLD(attr.metadata[key]);
+                    obj[key] = convertAttrNGSILD(attr.metadata[key]);
             }
         });
         delete obj.TimeInstant;
@@ -201,7 +203,7 @@ function formatAsNGSILD(json) {
             case 'id':
                 id = json[key];
                 obj[key] = id;
-                if (!id.startsWith(NGSI_LD_URN)){
+                if (!id.startsWith(NGSI_LD_URN)) {
                     obj[key] = NGSI_LD_URN + json.type + ':' + id;
                     logger.debug(context, 'Amending id to a valid URN: %s', obj[key]);
                 }
@@ -214,7 +216,7 @@ function formatAsNGSILD(json) {
                 // element for NSGI-LD.
                 break;
             default:
-                obj[key] = convertNGSIv2ToLD(json[key]);
+                obj[key] = convertAttrNGSILD(json[key]);
         }
     });
 
@@ -288,18 +290,15 @@ function generateNGSILDOperationHandler(operationName, entityName, typeInformati
             );
         } else if (response && body && response.statusCode === 404) {
             logger.info(context, 'Received the following response from the CB:\n\n%s\n\n', bodyAsString);
-
             logger.error(context, 'Operation ' + operationName + ' error connecting to the Context Broker: %j', body);
 
-            const errorField = NGSIUtils.getErrorField(body);
-            if (
-                response.statusCode &&
-                response.statusCode === 404 &&
-                errorField.details.includes(typeInformation.type)
-            ) {
+            let errorField = body.error;
+            if (body.description) {
+                errorField += ':' + body.description;
+            }
+
+            if (errorField !== undefined) {
                 callback(new errors.DeviceNotFound(entityName));
-            } else if (errorField.code && errorField.code === '404') {
-                callback(new errors.AttributeNotFound());
             } else {
                 callback(new errors.EntityGenericError(entityName, typeInformation.type, body));
             }
@@ -332,7 +331,6 @@ function sendQueryValueNgsiLD(entityName, attributes, typeInformation, token, ca
 
     const options = NGSIUtils.createRequestObject(url, typeInformation, token);
     options.method = 'GET';
-    options.json = true;
 
     if (!typeInformation || !typeInformation.type) {
         callback(new errors.TypeNotFound(null, entityName));
@@ -376,7 +374,7 @@ function addLinkedEntities(typeInformation, json) {
         return calculatedType;
     }
     const linkedTypeInfo = {};
-    if(typeInformation.staticAttributes){
+    if (typeInformation.staticAttributes) {
         typeInformation.staticAttributes.forEach((item) => {
             if (item.link) {
                 linkedTypeInfo[item.name] = item.link;
@@ -405,6 +403,90 @@ function addLinkedEntities(typeInformation, json) {
     });
 }
 
+/**
+ * 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) {
+    var explicitAttrsList = [];
+    if (typeInformation.explicitAttrs) {
+        explicitAttrsList.push('type');
+        explicitAttrsList.push('id');
+        if (typeof typeInformation.explicitAttrs === 'boolean') {
+            if (typeInformation.timestamp) {
+                explicitAttrsList.push(constants.TIMESTAMP_ATTRIBUTE);
+            }
+            if (typeInformation.active) {
+                typeInformation.active.forEach((attr) => {
+                    explicitAttrsList.push(attr.name);
+                });
+            }
+            if (typeInformation.staticAttributes) {
+                typeInformation.staticAttributes.forEach((attr) => {
+                    explicitAttrsList.push(attr.name);
+                });
+            }
+        } else if (typeof typeInformation.explicitAttrs === 'string') {
+            entities.forEach((entity) => {
+                const attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
+                const ctx = jexlParser.extractContext(attsArray);
+                const res = jexlParser.parse(typeInformation.explicitAttrs, ctx);
+                explicitAttrsList = explicitAttrsList.concat(res);
+            });
+        }
+    }
+    if (explicitAttrsList.length > 0) {
+        entities.forEach((entity) => {
+            const hidden = _.difference(_.keys(entity), explicitAttrsList);
+            hidden.forEach((attr) => {
+                delete entity[attr];
+            });
+        });
+    }
+    return entities;
+}
+
+/**
+ * Remove id, type and any hidden attrs after processing
+ *
+ * @param {Object} result           Unprocessed entity
+ * @param {Object} typeInformation  Configuration information for the device.
+ */
+function removeHiddenAttrs(result, typeInformation) {
+    delete result.id;
+    delete result.type;
+    var explicitAttrsList = [];
+    if (typeInformation.explicitAttrs && typeof typeInformation.explicitAttrs === 'boolean') {
+        if (typeInformation.timestamp) {
+            explicitAttrsList.push(constants.TIMESTAMP_ATTRIBUTE);
+        }
+        if (typeInformation.active) {
+            typeInformation.active.forEach((attr) => {
+                explicitAttrsList.push(attr.name);
+            });
+        }
+        if (typeInformation.staticAttributes) {
+            typeInformation.staticAttributes.forEach((attr) => {
+                explicitAttrsList.push(attr.name);
+            });
+        }
+    } else if (typeInformation.explicitAttrs && typeof typeInformation.explicitAttrs === 'string') {
+        const attsArray = utils.extractAttributesArrayFromNgsi2Entity(result);
+        const ctx = jexlParser.extractContext(attsArray);
+        const res = jexlParser.parse(typeInformation.explicitAttrs, ctx);
+        explicitAttrsList = res;
+    }
+    if (explicitAttrsList.length > 0) {
+        const hidden = _.difference(_.keys(result), explicitAttrsList);
+        hidden.forEach((attr) => {
+            delete result[attr];
+        });
+    }
+    return result;
+}
+
 /**
  * Makes an update in the Device's entity in the context broker, with the values given in the 'attributes' array.
  * This array should comply to the NGSI-LD's attribute format.
@@ -416,7 +498,6 @@ function addLinkedEntities(typeInformation, json) {
  */
 function sendUpdateValueNgsiLD(entityName, attributes, typeInformation, token, callback) {
     let payload = {};
-
     const url = '/ngsi-ld/v1/entityOperations/upsert/?options=update';
 
     const options = NGSIUtils.createRequestObject(url, typeInformation, token);
@@ -477,11 +558,10 @@ function sendUpdateValueNgsiLD(entityName, attributes, typeInformation, token, c
                             }
                         }
 
-                        options.json = result;
+                        options.json = removeHiddenAttrsFromMultiEntity(result, typeInformation);
                     } else {
-                        delete result.id;
-                        delete result.type;
-                        options.json = result;
+                        // Remove id, type and any hidden attrs after processing
+                        options.json = removeHiddenAttrs(result, typeInformation);
                         logger.debug(context, 'typeInformation: %j', typeInformation);
                         if (
                             'timestamp' in typeInformation && typeInformation.timestamp !== undefined
@@ -570,6 +650,7 @@ function sendUpdateValueNgsiLD(entityName, attributes, typeInformation, token, c
     );
 }
 
+exports.convertAttrNGSILD = convertAttrNGSILD;
 exports.formatAsNGSILD = formatAsNGSILD;
 exports.sendUpdateValue = sendUpdateValueNgsiLD;
 exports.sendQueryValue = sendQueryValueNgsiLD;

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

@@ -27,21 +27,24 @@
 
 /* eslint-disable consistent-return */
 
-const request = require('request');
+const request = require('../../request-shim');
 const statsService = require('./../stats/statsRegistry');
 const async = require('async');
 const apply = async.apply;
 const alarms = require('../common/alarmManagement');
 const errors = require('../../errors');
 const utils = require('../northBound/restUtils');
+const pluginUtils = require('../../plugins/pluginUtils');
 const config = require('../../commonConfig');
 const constants = require('../../constants');
+const jexlParser = require('../../plugins/jexlParser');
 const moment = require('moment-timezone');
 const NGSIUtils = require('./ngsiUtils');
 const logger = require('logops');
 const context = {
     op: 'IoTAgentNGSI.Entities-v2'
 };
+const _ = require('underscore');
 
 /**
  * Amends an NGSIv2 Geoattribute from String to GeoJSON format
@@ -234,11 +237,13 @@ function generateNGSI2OperationHandler(operationName, entityName, typeInformatio
 
             logger.error(context, 'Operation ' + operationName + ' error connecting to the Context Broker: %j', body);
 
-            const errorField = NGSIUtils.getErrorFieldV2(body);
-            if (response.statusCode && response.statusCode === 404 && errorField !== undefined) {
+            let errorField = body.error;
+            if (body.description) {
+                errorField += ':' + body.description;
+            }
+
+            if (errorField !== undefined) {
                 callback(new errors.DeviceNotFound(entityName));
-            } else if (errorField.code && errorField.code === '404') {
-                callback(new errors.AttributeNotFound());
             } else {
                 callback(new errors.EntityGenericError(entityName, typeInformation.type, body));
             }
@@ -288,7 +293,6 @@ function sendQueryValueNgsi2(entityName, attributes, typeInformation, token, cal
 
     const options = NGSIUtils.createRequestObject(url, typeInformation, token);
     options.method = 'GET';
-    options.json = true;
 
     if (!typeInformation || !typeInformation.type) {
         callback(new errors.TypeNotFound(null, entityName));
@@ -310,6 +314,92 @@ function sendQueryValueNgsi2(entityName, attributes, typeInformation, token, cal
     );
 }
 
+/**
+ * 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) {
+    var explicitAttrsList = [];
+    if (typeInformation.explicitAttrs) {
+        explicitAttrsList.push('type');
+        explicitAttrsList.push('id');
+        if (typeof typeInformation.explicitAttrs === 'boolean') {
+            if (typeInformation.timestamp) {
+                explicitAttrsList.push(constants.TIMESTAMP_ATTRIBUTE);
+            }
+
+            if (typeInformation.active) {
+                typeInformation.active.forEach((attr) => {
+                    explicitAttrsList.push(attr.name);
+                });
+            }
+            if (typeInformation.staticAttributes) {
+                typeInformation.staticAttributes.forEach((attr) => {
+                    explicitAttrsList.push(attr.name);
+                });
+            }
+        } 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);
+            });
+        }
+    }
+    if (explicitAttrsList.length > 0) {
+        logger.debug(context, 'removeHiddenAttrsFromMultiEntity %s', explicitAttrsList);
+        entities.forEach((entity) => {
+            const hidden = _.difference(_.keys(entity), explicitAttrsList);
+            hidden.forEach((attr) => {
+                delete entity[attr];
+            });
+        });
+    }
+    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) {
+    delete result.id;
+    delete result.type;
+    var explicitAttrsList = [];
+    if (typeInformation.explicitAttrs && typeof typeInformation.explicitAttrs === 'boolean') {
+        if (typeInformation.timestamp) {
+            explicitAttrsList.push(constants.TIMESTAMP_ATTRIBUTE);
+        }
+        if (typeInformation.active) {
+            typeInformation.active.forEach((attr) => {
+                explicitAttrsList.push(attr.name);
+            });
+        }
+        if (typeInformation.staticAttributes) {
+            typeInformation.staticAttributes.forEach((attr) => {
+                explicitAttrsList.push(attr.name);
+            });
+        }
+    } 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;
+    }
+    if (explicitAttrsList.length > 0) {
+        logger.debug(context, 'removeHiddenAttrs %s', explicitAttrsList);
+        const hidden = _.difference(_.keys(result), explicitAttrsList);
+        hidden.forEach((attr) => {
+            delete result[attr];
+        });
+    }
+    return result;
+}
+
 /**
  * Makes an update in the Device's entity in the context broker, with the values given in the 'attributes' array. This
  * array should comply to the NGSIv2's attribute format.
@@ -324,7 +414,7 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
 
     let url = '/v2/entities/' + entityName + '/attrs';
 
-    if (typeInformation.type) {
+    if (typeInformation && typeInformation.type) {
         url += '?type=' + typeInformation.type;
     }
 
@@ -339,9 +429,6 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
         return;
     }
 
-    payload.id = entityName;
-    payload.type = typeInformation.type;
-
     for (let i = 0; i < attributes.length; i++) {
         if (attributes[i].name && attributes[i].type) {
             payload[attributes[i].name] = {
@@ -357,7 +444,9 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
             return;
         }
     }
-
+    //overwritte if id or type missnamed atributes reach this point
+    payload.id = entityName;
+    payload.type = typeInformation.type;
     payload = NGSIUtils.castJsonNativeAttributes(payload);
     async.waterfall(
         [
@@ -390,7 +479,7 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
                         }
                         options.json = {
                             actionType: 'append',
-                            entities: result
+                            entities: removeHiddenAttrsFromMultiEntity(result, typeInformation)
                         };
                         if (config.getConfig().appendMode === true) {
                             options.json.actionType = 'append';
@@ -398,9 +487,7 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
                             options.json.actionType = 'update';
                         }
                     } else {
-                        delete result.id;
-                        delete result.type;
-                        options.json = result;
+                        options.json = removeHiddenAttrs(result, typeInformation);
                         logger.debug(context, 'typeInformation: %j', typeInformation);
                         if (
                             'timestamp' in typeInformation && typeInformation.timestamp !== undefined
@@ -429,6 +516,13 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
                 // Purge object_id from entities before sent to CB
                 // object_id was added by createNgsi2Entity to allow multientity
                 // with duplicate attribute names.
+
+                //some entities may be empty if they had only wrong attributes id-type
+                //we filter the array
+                if (options.json.entities) {
+                    options.json.entities = options.json.entities.filter((value) => Object.keys(value).length > 0);
+                }
+
                 let att;
                 if (options.json.entities) {
                     for (let entity = 0; entity < options.json.entities.length; entity++) {

package/lib/services/ngsi/ngsiService.js

@@ -49,14 +49,11 @@ function init() {
         case 'ld':
             entityHandler = require('./entities-NGSI-LD');
             break;
-        case 'v2':
-            entityHandler = require('./entities-NGSI-v2');
-            break;
         case 'mixed':
             entityHandler = require('./entities-NGSI-mixed');
             break;
         default:
-            entityHandler = require('./entities-NGSI-v1');
+            entityHandler = require('./entities-NGSI-v2');
     }
 }
 
@@ -135,9 +132,10 @@ function executeWithDeviceInformation(operationFunction) {
             attributes,
             deviceInformation
         );
-        config.getGroupRegistry().getType(type, function (error, deviceGroup) {
+        const currentType = type ? type : deviceInformation.type;
+        config.getGroupRegistry().getType(currentType, function (error, deviceGroup) {
             let typeInformation;
-            const configDeviceInfo = config.getConfig().types[type];
+            const configDeviceInfo = config.getConfig().types[currentType];
             if (error) {
                 logger.debug(context, 'error %j in get group device', error);
             }