Merge pull request telefonicaid#1582 from telefonicaid/task/add_typeI…

…nformation_in_errors

add device/group information to error log about some errors

CHANGES_NEXT_RELEASE

@@ -1,3 +1,4 @@
+- Add: log and return device/group information when EntityGenericError, TypeNotFound, DeviceNotFound, BadTimestamp, BadGeocoordinates, CommandNotFound, GroupNotFound, MissingAttributes, DuplicateDeviceId and DuplicateGroup errors (iotagent-json#815)
 - Hardening: simplify implementation so typeInformation contains global config values (#1515)
 - Add: `POST /iot/op/delete` operation to delete multiple devices at once (#1578)
 - Fix: store device subscriptions updates (#1086)

lib/errors.js

@@ -36,9 +36,15 @@ class UnregistrationError {
     }
 }
 class EntityGenericError {
-    constructor(id, type, details, code) {
+    constructor(id, type, typeInformation, details, code) {
         this.name = 'ENTITY_GENERIC_ERROR';
-        this.message = 'Error accesing entity data for device: ' + id + ' of type: ' + type;
+        this.message =
+            'Error accesing entity data for device: ' +
+            id +
+            ' of type: ' +
+            type +
+            ' and ' +
+            JSON.stringify(typeInformation);
         this.details = details || {};
         this.code = code || 200;
     }
@@ -77,36 +83,44 @@ class UnsupportedContentType {
     }
 }
 class TypeNotFound {
-    constructor(id, type) {
+    constructor(id, type, typeInformation) {
         this.name = 'TYPE_NOT_FOUND';
-        this.message = 'Type : ' + type + ' not found for device with id: ' + id;
+        this.message =
+            'Type : ' + type + ' not found for device with id: ' + id + ' with: ' + JSON.stringify(typeInformation);
         this.code = 500;
     }
 }
 class MissingAttributes {
-    constructor(msg) {
+    constructor(msg, device) {
         this.name = 'MISSING_ATTRIBUTES';
-        this.message = 'The request was not well formed:' + msg;
+        this.message = 'The request was not well formed:' + msg + ' with: ' + JSON.stringify(device);
     }
 }
 class DeviceNotFound {
-    constructor(id) {
+    constructor(id, typeInformation) {
         this.name = 'DEVICE_NOT_FOUND';
-        this.message = 'No device was found with id:' + id;
+        this.message = 'No device was found with id:' + id + ' and ' + JSON.stringify(typeInformation);
         this.code = 404;
     }
 }
 class DuplicateDeviceId {
-    constructor(id) {
+    constructor(device) {
         this.name = 'DUPLICATE_DEVICE_ID';
-        this.message = 'A device with the same pair (Service, DeviceId) was found:' + id;
+        this.message =
+            'A device with the same pair (Service, DeviceId) was found:' + device.id + ' and ' + JSON.stringify(device);
         this.code = 409;
     }
 }
 class DuplicateGroup {
-    constructor(res, key) {
+    constructor(group) {
         this.name = 'DUPLICATE_GROUP';
-        this.message = 'A device configuration already exists for resource ' + res + ' and API Key ' + key;
+        this.message =
+            'A device configuration already exists for resource ' +
+            group.resource +
+            ' and API Key ' +
+            group.apikey +
+            ' and ' +
+            JSON.stringify(group);
         this.code = 409;
     }
 }
@@ -170,9 +184,13 @@ class WrongSyntax {
     }
 }
 class CommandNotFound {
-    constructor(name) {
+    constructor(name, typeInformation) {
         this.name = 'COMMAND_NOT_FOUND';
-        this.message = "Couldn't update the command because no command with the name [" + name + '] was found.';
+        this.message =
+            "Couldn't update the command because no command with the name [" +
+            name +
+            '] was found with ' +
+            JSON.stringify(typeInformation);
         this.code = 400;
     }
 }
@@ -201,9 +219,10 @@ class DeviceGroupNotFound {
     }
 }
 class GroupNotFound {
-    constructor(service, subservice) {
+    constructor(service, subservice, type) {
         this.name = 'GROUP_NOT_FOUND';
-        this.message = 'Group not found for service [' + service + '] and subservice [' + subservice + ']';
+        this.message =
+            'Group not found for service [' + service + '] subservice [' + subservice + '] and type [' + type + ']';
         this.code = 404;
     }
 }
@@ -229,16 +248,22 @@ class BadAnswer {
     }
 }
 class BadTimestamp {
-    constructor(payload, entityName) {
+    constructor(payload, entityName, typeInformation) {
         this.name = 'BAD_TIMESTAMP';
-        this.message = 'Invalid ISO8601 timestamp [' + payload + '] in [' + entityName + ']';
+        this.message =
+            'Invalid ISO8601 timestamp [' +
+            payload +
+            '] in [' +
+            entityName +
+            '] with: ' +
+            JSON.stringify(typeInformation);
         this.code = 400;
     }
 }
 class BadGeocoordinates {
-    constructor(payload) {
+    constructor(payload, device) {
         this.name = 'BAD_GEOCOORDINATES';
-        this.message = 'Invalid rfc7946 coordinates [' + payload + ']';
+        this.message = 'Invalid rfc7946 coordinates [' + payload + '] in ' + JSON.stringify(device);
         this.code = 400;
     }
 }

lib/services/commands/commandRegistryMemory.js

@@ -75,7 +75,12 @@ function updateCommand(service, subservice, deviceId, command, callback) {
 
         callback(null, foundCommand);
     } else {
-        callback(new errors.CommandNotFound(command.name));
+        const deviceInfo = {
+            service,
+            subservice,
+            deviceId
+        };
+        callback(new errors.CommandNotFound(command.name, deviceInfo));
     }
 }
 
@@ -144,7 +149,12 @@ function remove(service, subservice, deviceId, name, callback) {
         delete registeredCommands[foundCommand._id];
         callback(null, foundCommand);
     } else {
-        callback(new errors.CommandNotFound(name));
+        const deviceInfo = {
+            service,
+            subservice,
+            deviceId
+        };
+        callback(new errors.CommandNotFound(name, deviceInfo));
     }
 }
 

lib/services/commands/commandRegistryMongoDB.js

@@ -39,7 +39,7 @@ function findCommand(service, subservice, deviceId, name, callback) {
         name
     };
 
-    logger.debug(context, 'Looking for command [%s] for device [%s]', name, deviceId);
+    logger.debug(context, 'Looking for command [%s] for device [%s] with [%j]', name, deviceId, queryObj);
 
     const query = Command.model.findOne(queryObj);
 
@@ -53,8 +53,14 @@ function findCommand(service, subservice, deviceId, name, callback) {
         } else if (data) {
             callback(null, data);
         } else {
-            logger.debug(context, 'Command for DeviceID [%j] with name [%j] not found', deviceId, name);
-            callback(new errors.CommandNotFound(name));
+            logger.debug(
+                context,
+                'Command for DeviceID [%j] with name [%j] not found with [%j]',
+                deviceId,
+                name,
+                queryObj
+            );
+            callback(new errors.CommandNotFound(name, queryObj));
         }
     });
 }
@@ -124,15 +130,15 @@ function listCommands(service, subservice, deviceId, callback) {
 
     const query = Command.model.find(condition).sort();
 
-    async.series([query.exec.bind(query), Command.model.countDocuments.bind(Command.model, condition)], function (
-        error,
-        results
-    ) {
-        callback(error, {
-            count: results[1],
-            commands: results[0].map(toObjectFn)
-        });
-    });
+    async.series(
+        [query.exec.bind(query), Command.model.countDocuments.bind(Command.model, condition)],
+        function (error, results) {
+            callback(error, {
+                count: results[1],
+                commands: results[0].map(toObjectFn)
+            });
+        }
+    );
 }
 
 function remove(service, subservice, deviceId, name, callback) {
@@ -159,9 +165,14 @@ function remove(service, subservice, deviceId, name, callback) {
 
                     callback(null, commandResult);
                 } else {
-                    logger.debug(context, 'Command [%s] not found for removal.', name);
-
-                    callback(new errors.CommandNotFound(name));
+                    const deviceInfo = {
+                        service,
+                        subservice,
+                        deviceId,
+                        name
+                    };
+                    logger.debug(context, 'Command [%s] not found for removal with %j', name, deviceInfo);
+                    callback(new errors.CommandNotFound(name, deviceInfo));
                 }
             });
         }

lib/services/devices/deviceRegistryMemory.js

@@ -54,7 +54,7 @@ function storeDevice(newDevice, callback) {
     }
 
     if (registeredDevices[newDevice.service][newDevice.id]) {
-        callback(new errors.DuplicateDeviceId(newDevice.id));
+        callback(new errors.DuplicateDeviceId(newDevice));
     } else {
         registeredDevices[newDevice.service][newDevice.id] = deepClone(newDevice);
         registeredDevices[newDevice.service][newDevice.id].creationDate = Date.now();

lib/services/devices/deviceRegistryMongoDB.js

@@ -102,7 +102,7 @@ function storeDevice(newDevice, callback) {
             if (error.code === 11000) {
                 logger.debug(context, 'Tried to insert a device with duplicate ID in the database: %s', error);
 
-                callback(new errors.DuplicateDeviceId(newDevice.id));
+                callback(new errors.DuplicateDeviceId(newDevice));
             } else {
                 logger.debug(context, 'Error storing device information: %s', error);
 
@@ -206,7 +206,7 @@ function findOneInMongoDB(queryParams, id, callback) {
         } else {
             logger.debug(context, 'Device [%s] not found.', id);
 
-            callback(new errors.DeviceNotFound(id));
+            callback(new errors.DeviceNotFound(id, queryParams));
         }
     });
 }
@@ -282,7 +282,7 @@ function getByNameAndType(name, type, service, servicepath, callback) {
         } else {
             logger.debug(context, 'Device [%s] not found.', name);
 
-            callback(new errors.DeviceNotFound(name));
+            callback(new errors.DeviceNotFound(name, optionsQuery));
         }
     });
 }
@@ -373,7 +373,7 @@ function getDevicesByAttribute(name, value, service, subservice, callback) {
         } else {
             logger.debug(context, 'Device [%s] not found.', name);
 
-            callback(new errors.DeviceNotFound(name));
+            callback(new errors.DeviceNotFound(name, filter));
         }
     });
 }

lib/services/devices/deviceService.js

@@ -244,7 +244,7 @@ function registerDevice(deviceObj, callback) {
             /* eslint-disable-next-line no-unused-vars */
             function (error, device) {
                 if (!error) {
-                    innerCb(new errors.DuplicateDeviceId(deviceObj.id));
+                    innerCb(new errors.DuplicateDeviceId(deviceObj));
                 } else {
                     innerCb();
                 }
@@ -646,7 +646,7 @@ function findOrCreate(deviceId, apikey, group, callback) {
                     newDevice,
                     group
                 );
-                callback(new errors.DeviceNotFound(deviceId));
+                callback(new errors.DeviceNotFound(deviceId, newDevice));
             }
         } else {
             callback(error);
@@ -671,7 +671,7 @@ function retrieveDevice(deviceId, apiKey, callback) {
             } else {
                 logger.error(context, "Couldn't find device data for APIKey [%s] and DeviceId[%s]", deviceId, apiKey);
 
-                callback(new errors.DeviceNotFound(deviceId));
+                callback(new errors.DeviceNotFound(deviceId, { apikey: apiKey }));
             }
         });
     } else {

lib/services/devices/devices-NGSI-LD.js

@@ -93,7 +93,7 @@ function updateEntityHandlerNgsiLD(deviceData, updatedDevice, callback) {
                 body
             );
 
-            const errorObj = new errors.EntityGenericError(deviceData.id, deviceData.type, body);
+            const errorObj = new errors.EntityGenericError(deviceData.id, deviceData.type, deviceData, body);
 
             callback(errorObj);
         }
@@ -184,7 +184,7 @@ function updateEntityNgsiLD(deviceData, updatedDevice, callback) {
  */
 function updateRegisterDeviceNgsiLD(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;
     }
 
@@ -216,7 +216,7 @@ function updateRegisterDeviceNgsiLD(deviceObj, entityInfoUpdated, callback) {
 
             callback(null, oldDevice);
         } else {
-            callback(new errors.DeviceNotFound(newDevice.id));
+            callback(new errors.DeviceNotFound(newDevice.id, newDevice));
         }
     }
 

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));
         }
     }
 

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);
 

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);