iotagent-node-lib 4.2.0 → 4.3.0

package/lib/services/devices/devices-NGSI-v2.js

@@ -89,7 +89,13 @@ function updateEntityHandlerNgsi2(deviceData, updatedDevice, callback) {
                 body
             );
 
-            const errorObj = new errors.EntityGenericError(deviceData.id, deviceData.type, body, response.statusCode);
+            const errorObj = new errors.EntityGenericError(
+                deviceData.id,
+                deviceData.type,
+                deviceData,
+                body,
+                response.statusCode
+            );
 
             callback(errorObj);
         }
@@ -204,7 +210,7 @@ function updateEntityNgsi2(deviceData, updatedDevice, callback) {
             // Format any GeoJSON attrs properly
             options.json[att] = NGSIv2.formatGeoAttrs(options.json[att]);
         } catch (error) {
-            return callback(new errors.BadGeocoordinates(JSON.stringify(options.json)));
+            return callback(new errors.BadGeocoordinates(JSON.stringify(options.json), deviceData));
         }
     }
 
@@ -243,7 +249,7 @@ function updateEntityNgsi2(deviceData, updatedDevice, callback) {
  */
 function updateRegisterDeviceNgsi2(deviceObj, entityInfoUpdated, callback) {
     if (!deviceObj.id || !deviceObj.type) {
-        callback(new errors.MissingAttributes('Id or device missing'));
+        callback(new errors.MissingAttributes('Id or device missing', deviceObj));
         return;
     }
 
@@ -282,7 +288,7 @@ function updateRegisterDeviceNgsi2(deviceObj, entityInfoUpdated, callback) {
 
             callback(null, oldDevice);
         } else {
-            callback(new errors.DeviceNotFound(newDevice.id));
+            callback(new errors.DeviceNotFound(newDevice.id, newDevice));
         }
     }
 

package/lib/services/groups/groupRegistryMemory.js

@@ -50,7 +50,7 @@ function exists(group) {
 
 function createGroup(group, callback) {
     if (exists(group)) {
-        callback(new errors.DuplicateGroup(group.resource, group.apikey));
+        callback(new errors.DuplicateGroup(group));
     } else {
         const storeGroup = _.clone(group);
 

package/lib/services/groups/groupRegistryMongoDB.js

@@ -110,7 +110,7 @@ function createGroup(group, callback) {
                     group.apikey
                 );
 
-                callback(new errors.DuplicateGroup(group.resource, group.apikey));
+                callback(new errors.DuplicateGroup(group));
             } else {
                 logger.debug(context, 'Error storing device group information: %s', error);
 

package/lib/services/groups/groupService.js

@@ -48,7 +48,7 @@ function validateGroup(group, callback) {
         return function (error, foundGroup) {
             logger.debug(context, 'generateDuplicateHander error %j and foundGroup %j', error, foundGroup);
             if (!error || (foundGroup && foundGroup.count > 0)) {
-                innerCb(new errors.DuplicateGroup(group.resource, group.apikey));
+                innerCb(new errors.DuplicateGroup(group));
             } else {
                 innerCb();
             }
@@ -291,8 +291,14 @@ function getEffectiveApiKey(service, subservice, type, callback) {
             logger.debug(context, 'Using default API Key: %s', config.getConfig().defaultKey);
             callback(null, config.getConfig().defaultKey);
         } else {
-            logger.error(context, 'Could not find any API Key information for device.');
-            callback(new errors.GroupNotFound(service, subservice));
+            logger.error(
+                context,
+                'Could not find any APIKey information for device in service %s subservice %s and type %s',
+                service,
+                subservice,
+                type
+            );
+            callback(new errors.GroupNotFound(service, subservice, type));
         }
     }
 

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

@@ -381,9 +381,9 @@ function generateNGSILDOperationHandler(operationName, entityName, typeInformati
             }
 
             if (errorField !== undefined) {
-                callback(new errors.DeviceNotFound(entityName));
+                callback(new errors.DeviceNotFound(entityName, typeInformation));
             } else {
-                callback(new errors.EntityGenericError(entityName, typeInformation.type, body));
+                callback(new errors.EntityGenericError(entityName, typeInformation.type, typeInformation, body));
             }
         } else {
             logger.debug(context, 'Unknown error executing ' + operationName + ' operation');
@@ -391,7 +391,15 @@ function generateNGSILDOperationHandler(operationName, entityName, typeInformati
                 body = JSON.parse(body);
             }
 
-            callback(new errors.EntityGenericError(entityName, typeInformation.type, body, response.statusCode));
+            callback(
+                new errors.EntityGenericError(
+                    entityName,
+                    typeInformation.type,
+                    typeInformation,
+                    body,
+                    response.statusCode
+                )
+            );
         }
     };
 }
@@ -416,7 +424,7 @@ function sendQueryValueNgsiLD(entityName, attributes, typeInformation, token, ca
     options.method = 'GET';
 
     if (!typeInformation || !typeInformation.type) {
-        callback(new errors.TypeNotFound(null, entityName));
+        callback(new errors.TypeNotFound(null, entityName, typeInformation));
         return;
     }
 
@@ -529,7 +537,7 @@ function sendUpdateValueNgsiLD(entityName, attributes, typeInformation, token, c
     }
 
     if (!typeInformation || !typeInformation.type) {
-        callback(new errors.TypeNotFound(null, entityName));
+        callback(new errors.TypeNotFound(null, entityName, typeInformation));
         return;
     }
     const idTypeSSSList = pluginUtils.getIdTypeServSubServiceFromDevice(typeInformation);
@@ -1015,7 +1023,7 @@ function sendUpdateValueNgsiLD(entityName, attributes, typeInformation, token, c
                 } else if (!utils.IsValidTimestampedNgsi2(payload[n])) {
                     // legacy check needed?
                     logger.error(context, 'Invalid timestamp:%s', JSON.stringify(payload[0]));
-                    callback(new errors.BadTimestamp(payload, entityName));
+                    callback(new errors.BadTimestamp(payload, entityName, typeInformation));
                     return;
                 }
             }
@@ -1044,7 +1052,7 @@ function sendUpdateValueNgsiLD(entityName, attributes, typeInformation, token, c
             options.json = [formatAsNGSILD(options.json)];
         }
     } catch (error) {
-        return callback(new errors.BadGeocoordinates(JSON.stringify(payload)));
+        return callback(new errors.BadGeocoordinates(JSON.stringify(payload), typeInformation));
     }
 
     if (typeInformation.active) {

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

@@ -31,7 +31,6 @@ const request = require('../../request-shim');
 const alarms = require('../common/alarmManagement');
 const errors = require('../../errors');
 const pluginUtils = require('../../plugins/pluginUtils');
-const config = require('../../commonConfig');
 const constants = require('../../constants');
 const jexlParser = require('../../plugins/jexlParser');
 const expressionPlugin = require('../../plugins/expressionPlugin');
@@ -173,9 +172,9 @@ function generateNGSI2OperationHandler(operationName, entityName, typeInformatio
             }
 
             if (errorField !== undefined) {
-                callback(new errors.DeviceNotFound(entityName));
+                callback(new errors.DeviceNotFound(entityName, typeInformation));
             } else {
-                callback(new errors.EntityGenericError(entityName, typeInformation.type, body));
+                callback(new errors.EntityGenericError(entityName, typeInformation.type, typeInformation, body));
             }
         } else {
             logger.debug(context, 'Unknown error executing ' + operationName + ' operation');
@@ -183,7 +182,15 @@ function generateNGSI2OperationHandler(operationName, entityName, typeInformatio
                 body = JSON.parse(body);
             }
 
-            callback(new errors.EntityGenericError(entityName, typeInformation.type, body, response.statusCode));
+            callback(
+                new errors.EntityGenericError(
+                    entityName,
+                    typeInformation.type,
+                    typeInformation,
+                    body,
+                    response.statusCode
+                )
+            );
         }
     };
 }
@@ -225,7 +232,7 @@ function sendQueryValueNgsi2(entityName, attributes, typeInformation, token, cal
     options.method = 'GET';
 
     if (!typeInformation || !typeInformation.type) {
-        callback(new errors.TypeNotFound(null, entityName));
+        callback(new errors.TypeNotFound(null, entityName, typeInformation));
         return;
     }
 
@@ -279,7 +286,7 @@ function sendUpdateValueNgsi2(entityName, measures, typeInformation, token, call
 
     //Check mandatory information: type
     if (!typeInformation || !typeInformation.type) {
-        callback(new errors.TypeNotFound(null, entityName));
+        callback(new errors.TypeNotFound(null, entityName, typeInformation));
         return;
     }
     //Rename all measures with matches with id and type to measure_id and measure_type
@@ -301,11 +308,9 @@ function sendUpdateValueNgsi2(entityName, measures, typeInformation, token, call
     jexlctxt = reduceAttrToPlainObject(idTypeSSSList, jexlctxt);
 
     //Managing timestamp (mustInsertTimeInstant flag to decide if we should insert Timestamp later on)
-    const mustInsertTimeInstant =
-        typeInformation.timestamp !== undefined
-            ? typeInformation.timestamp
-            : config.getConfig().timestamp !== undefined
-            ? config.getConfig().timestamp
+    const mustInsertTimeInstant = 
+        typeInformation.timestamp !== undefined 
+            ? typeInformation.timestamp 
             : false;
 
     if (mustInsertTimeInstant) {
@@ -317,7 +322,10 @@ function sendUpdateValueNgsi2(entityName, measures, typeInformation, token, call
             if (moment(plainMeasures[constants.TIMESTAMP_ATTRIBUTE], moment.ISO_8601, true).isValid()) {
                 timestamp.value = plainMeasures[constants.TIMESTAMP_ATTRIBUTE];
             } else {
-                callback(new errors.BadTimestamp(plainMeasures[constants.TIMESTAMP_ATTRIBUTE], entityName));
+                callback(
+                    new errors.BadTimestamp(plainMeasures[constants.TIMESTAMP_ATTRIBUTE], entityName, typeInformation)
+                );
+                return;
             }
         } else if (!typeInformation.timezone) {
             timestamp.value = new Date().toISOString();

package/lib/services/ngsi/ngsiService.js

@@ -144,9 +144,9 @@ function executeWithDeviceInformation(operationFunction) {
             // For preregistered devices, augment the existing deviceInformation with selected attributes.
             if (!callback) {
                 callback = deviceInformation;
-                typeInformation = deviceGroup || configDeviceInfo;
+                typeInformation = deviceGroup || { ...config.getConfig(), ...configDeviceInfo };
             } else {
-                typeInformation = deviceInformation;
+                typeInformation = { ...config.getConfig(), ...deviceInformation };
                 attributeList.forEach((key) => {
                     typeInformation[key] =
                         typeInformation[key] || (deviceGroup || {})[key] || (configDeviceInfo || {})[key];
@@ -236,7 +236,7 @@ function setCommandResult(
         if (commandInfo.length === 1) {
             exports.update(entityName, typeInformation.type, apikey, attributes, typeInformation, callback);
         } else {
-            callback(new errors.CommandNotFound(commandName));
+            callback(new errors.CommandNotFound(commandName, typeInformation));
         }
     });
 }

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

@@ -62,6 +62,7 @@ function createSubscriptionHandlerNgsiLD(device, triggers, store, callback) {
                 new errors.EntityGenericError(
                     device.name,
                     device.type,
+                    device,
                     {
                         details: body
                     },
@@ -183,6 +184,7 @@ function createUnsubscribeHandlerNgsiLD(device, id, callback) {
                 new errors.EntityGenericError(
                     device.name,
                     device.type,
+                    device,
                     {
                         details: body
                     },

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

@@ -64,6 +64,7 @@ function createSubscriptionHandlerNgsi2(device, triggers, store, callback) {
                 new errors.EntityGenericError(
                     device.name,
                     device.type,
+                    device,
                     {
                         details: body
                     },
@@ -183,6 +184,7 @@ function createUnsubscribeHandlerNgsi2(device, id, callback) {
                 new errors.EntityGenericError(
                     device.name,
                     device.type,
+                    device,
                     {
                         details: body
                     },

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

@@ -48,41 +48,36 @@ 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'];
 
-
 /**
  * Replacement of NGSI-LD Null placeholders with real null values
  *
  */
-function replaceNGSILDNull(payload){
-    Object.keys(payload).forEach((key) =>{
+function replaceNGSILDNull(payload) {
+    Object.keys(payload).forEach((key) => {
         const value = payload[key];
-        if ( value === constants.NGSI_LD_NULL){
-           payload[key] = null; 
-        } else if (typeof value === 'object' &&
-            !Array.isArray(value) &&
-            value !== null){
+        if (value === constants.NGSI_LD_NULL) {
+            payload[key] = null;
+        } else if (typeof value === 'object' && !Array.isArray(value) && value !== null) {
             payload[key] = replaceNGSILDNull(payload[key]);
         }
-    })
-    return  payload;
+    });
+    return payload;
 }
 
 /**
  * Check to see if the payload or its subattributes contain null values
  *
  */
-function containsNulls(payload, result){
-    Object.keys(payload).forEach((key) =>{
+function containsNulls(payload, result) {
+    Object.keys(payload).forEach((key) => {
         const value = payload[key];
-        if ( value === null){
-           result.nulls = true; 
-        } else if (typeof value === 'object' &&
-            !Array.isArray(value) &&
-            value !== null){
+        if (value === null) {
+            result.nulls = true;
+        } else if (typeof value === 'object' && !Array.isArray(value) && value !== null) {
             containsNulls(payload[key], result);
         }
-    })
-    return  result;
+    });
+    return result;
 }
 
 /**
@@ -90,23 +85,23 @@ function containsNulls(payload, result){
  * to real nulls and checks for the presence of null and datasetId
  *
  */
-function preprocessNGSILD(req, res, next){
-    res.locals.hasDatasetId =  false;
-    const payload = req.body
-    if (payload && typeof payload === 'object'){
-        Object.keys(payload).forEach((key) =>{
-            if (_.isArray(payload[key])){
+function preprocessNGSILD(req, res, next) {
+    res.locals.hasDatasetId = false;
+    const payload = req.body;
+    if (payload && typeof payload === 'object') {
+        Object.keys(payload).forEach((key) => {
+            if (_.isArray(payload[key])) {
                 payload[key].forEach((obj) => {
-                    if (obj.datasetId){
+                    if (obj.datasetId) {
                         res.locals.hasDatasetId = true;
                     }
                 });
-            } else if (payload[key] && payload[key].datasetId && payload[key].datasetId !== '@none'){
-               res.locals.hasDatasetId = true;
-            } 
+            } else if (payload[key] && payload[key].datasetId && payload[key].datasetId !== '@none') {
+                res.locals.hasDatasetId = true;
+            }
         });
         req.body = replaceNGSILDNull(payload);
-        const result = { nulls: false }
+        const result = { nulls: false };
         containsNulls(payload, result);
         res.locals.hasNulls = result.nulls;
     }
@@ -124,16 +119,23 @@ function preprocessNGSILD(req, res, next){
 function validateNGSILD(supportNull, supportDatasetId) {
     return function validate(req, res, next) {
         if (!supportNull && res.locals.hasNulls) {
-            next(new errors.BadRequest('NGSI-LD Null found within the payload. This IoT Agent does not support nulls for this endpoint.'));
+            next(
+                new errors.BadRequest(
+                    'NGSI-LD Null found within the payload. This IoT Agent does not support nulls for this endpoint.'
+                )
+            );
         } else if (!supportDatasetId && res.locals.hasDatasetId) {
-            next(new errors.BadRequest('datasetId found within the payload. This IoT Agent does not support multi-attribute requests.'));
+            next(
+                new errors.BadRequest(
+                    'datasetId found within the payload. This IoT Agent does not support multi-attribute requests.'
+                )
+            );
         } else {
             next();
         }
     };
 }
 
-
 /**
  * Extract metadata attributes from input.
  *
@@ -413,34 +415,31 @@ function defaultQueryHandlerNgsiLD(id, type, service, subservice, attributes, ca
  * @param {Object} req                  Update request to generate Actions from
  */
 function generateMergePatchActionNgsiLD(req, callback) {
- 
     const entityId = req.params.entity;
 
-       
-    function addAttributes(deviceData, body, attributes){
+    function addAttributes(deviceData, body, attributes) {
         const keys = Object.keys(body);
 
         for (const j in deviceData) {
             if (keys.includes(deviceData[j].name)) {
-                const obj = body[deviceData[j].name]
-                if ( obj === null) {
+                const obj = body[deviceData[j].name];
+                if (obj === null) {
                     attributes.push({
                         type: deviceData[j].type,
                         value: null,
                         name: deviceData[j].name
                     });
                 } else {
-                     attributes.push({
+                    attributes.push({
                         type: deviceData[j].type,
                         value: obj.value,
                         name: deviceData[j].name
                     });
                 }
-            } 
+            }
         }
         return attributes;
     }
-    
 
     deviceService.getDeviceByName(
         entityId,
@@ -451,8 +450,8 @@ function generateMergePatchActionNgsiLD(req, callback) {
                 callback(error);
             } else {
                 const attributes = [];
-                addAttributes(deviceObj.commands, req.body, attributes)
-                addAttributes(deviceObj.lazy, req.body, attributes)
+                addAttributes(deviceObj.commands, req.body, attributes);
+                addAttributes(deviceObj.lazy, req.body, attributes);
                 const executeMergePatchHandler = apply(
                     contextServerUtils.mergePatchHandler,
                     entityId,
@@ -461,10 +460,7 @@ function generateMergePatchActionNgsiLD(req, callback) {
                     contextServerUtils.getLDPath(req),
                     attributes
                 );
-                async.waterfall(
-                    [executeMergePatchHandler],
-                    callback()
-        );
+                async.waterfall([executeMergePatchHandler], callback());
             }
         }
     );
@@ -477,7 +473,6 @@ function generateMergePatchActionNgsiLD(req, callback) {
  * @param {Object} res              Response that will be sent.
  */
 function handleMergePatchNgsiLD(req, res, next) {
-
     function handleMergePatchRequest(error, result) {
         if (error) {
             logger.debug(context, 'There was an error handling the merge-patch: %s.', error);
@@ -492,15 +487,15 @@ function handleMergePatchNgsiLD(req, res, next) {
     if ((req.is('json') || req.is('application/ld+json')) === false) {
         return handleMergePatchRequest(new errors.UnsupportedContentType(req.header('content-type')));
     }
-    
+
     if (req.body) {
         logger.debug(context, JSON.stringify(req.body, null, 4));
     }
 
-    if (contextServerUtils.mergePatchHandler){
+    if (contextServerUtils.mergePatchHandler) {
         generateMergePatchActionNgsiLD(req, handleMergePatchRequest);
     } else {
-       return handleMergePatchRequest(new errors.MethodNotSupported(req.method, req.path)) 
+        return handleMergePatchRequest(new errors.MethodNotSupported(req.method, req.path));
     }
 }
 
@@ -610,7 +605,7 @@ function handleQueryNgsiLD(req, res, next) {
         getFunction(function handleFindDevice(error, innerDevice) {
             let deviceList = [];
             if (!innerDevice) {
-                return callback(new errors.DeviceNotFound(contextEntity.id));
+                return callback(new errors.DeviceNotFound(contextEntity.id, contextEntity));
             }
 
             if (innerDevice.count) {
@@ -689,7 +684,7 @@ function ErrorHandlingNgsiLD(action) {
             error: error.name,
             description: error.message.replace(/[<>\"\'=;\(\)]/g, '')
         });
-    }
+    };
 }
 
 /**
@@ -812,7 +807,7 @@ function loadUnsupportedEndpointsNGSILD(router) {
 function loadContextRoutesNGSILD(router) {
     // In a more evolved implementation, more endpoints could be added to queryPathsNgsi2
     // according to https://www.etsi.org/standards-search#page=1&search=GS%20CIM%20009
-    
+
     const support = config.getConfig().server.ldSupport;
     let i;
 
@@ -832,7 +827,7 @@ function loadContextRoutesNGSILD(router) {
     router.patch('/ngsi-ld/v1/entities/:entity', [
         preprocessNGSILD,
         validateNGSILD(support.null, support.datasetId),
-        handleMergePatchNgsiLD, 
+        handleMergePatchNgsiLD,
         ErrorHandlingNgsiLD('Merge-Patch')
     ]);
 

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

@@ -503,7 +503,7 @@ function handleQueryNgsi2(req, res, next) {
         getFunction(function handleFindDevice(error, innerDevice) {
             let deviceList = [];
             if (!innerDevice) {
-                return callback(new errors.DeviceNotFound(contextEntity.id));
+                return callback(new errors.DeviceNotFound(contextEntity.id), contextEntity);
             }
 
             if (innerDevice.count) {