iotagent-node-lib 4.2.0 → 4.4.0

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

package/lib/services/northBound/deviceProvisioningServer.js

@@ -263,40 +263,50 @@ function handleGetDevice(req, res, next) {
             } else if (device) {
                 res.status(200).json(toProvisioningAPIFormat(device));
             } else {
-                next(new errors.DeviceNotFound(req.params.deviceId));
+                next(new errors.DeviceNotFound(req.params.deviceId), {
+                    apikey: req.query.apikey,
+                    service: req.headers['fiware-service'],
+                    subservice: req.headers['fiware-servicepath']
+                });
             }
         }
     );
 }
 
-/**
- * This middleware handles the removal of a particular device specified with the deviceId.
- */
-function handleRemoveDevice(req, res, next) {
-    function getDevice(deviceId, apikey, service, subservice, callback) {
-        deviceService.getDevice(deviceId, apikey, service, subservice, function (error, device) {
-            if (error) {
-                callback(error);
-            } else if (device) {
-                callback(null, device);
-            } else {
-                callback(new errors.DeviceNotFound(deviceId));
-            }
-        });
-    }
-
-    function applyRemoveDeviceHandler(device, callback) {
-        if (removeDeviceHandler) {
-            removeDeviceHandler(device, callback);
-        } else {
+function getDevice(deviceId, apikey, service, subservice, callback) {
+    deviceService.getDevice(deviceId, apikey, service, subservice, function (error, device) {
+        if (error) {
+            callback(error);
+        } else if (device) {
             callback(null, device);
+        } else {
+            callback(
+                new errors.DeviceNotFound(deviceId, {
+                    apikey: apikey,
+                    service: service,
+                    subservice: subservice
+                })
+            );
         }
-    }
+    });
+}
 
-    function unregisterDevice(deviceId, apikey, service, subservice, device, callback) {
-        return deviceService.unregister(deviceId, apikey, service, subservice, callback);
+function applyRemoveDeviceHandler(device, callback) {
+    if (removeDeviceHandler) {
+        removeDeviceHandler(device, callback);
+    } else {
+        callback(null, device);
     }
+}
 
+function unregisterDevice(deviceId, apikey, service, subservice, device, callback) {
+    return deviceService.unregister(deviceId, apikey, service, subservice, callback);
+}
+
+/**
+ * This middleware handles the removal of a particular device specified with the deviceId.
+ */
+function handleRemoveDevice(req, res, next) {
     async.waterfall(
         [
             apply(statsRegistry.add, 'deviceRemovalRequests', 1),
@@ -320,7 +330,13 @@ function handleRemoveDevice(req, res, next) {
             if (error && error.code !== 404) {
                 next(error);
             } else if (error && error.code === 404) {
-                next(new errors.DeviceNotFound(req.params.deviceId));
+                next(
+                    new errors.DeviceNotFound(req.params.deviceId, {
+                        apikey: req.query.apikey,
+                        service: req.headers['fiware-service'],
+                        subservice: req.headers['fiware-servicepath']
+                    })
+                );
             } else {
                 res.status(204).send();
             }
@@ -328,6 +344,56 @@ function handleRemoveDevice(req, res, next) {
     );
 }
 
+/**
+ * This middleware handles the removal of several devices specified in a array into a body
+ */
+function handleRemoveDevices(req, res, next) {
+    logger.debug(context, 'Handling delete of devices: %j', req.body);
+    let theErrorOut = false;
+    for (let devicetoRemove of req.body.devices) {
+        let theError = theErrorOut;
+        async.waterfall(
+            [
+                apply(statsRegistry.add, 'deviceRemovalRequests', 1),
+                apply(
+                    getDevice,
+                    devicetoRemove.deviceId,
+                    devicetoRemove.apikey,
+                    req.headers['fiware-service'],
+                    req.headers['fiware-servicepath']
+                ),
+                applyRemoveDeviceHandler,
+                apply(
+                    unregisterDevice,
+                    devicetoRemove.deviceId,
+                    devicetoRemove.apikey,
+                    req.headers['fiware-service'],
+                    req.headers['fiware-servicepath']
+                )
+            ],
+            function (error) {
+                if (error && error.code !== 404) {
+                    theError = !theError ? error : theError;
+                } else if (error && error.code === 404) {
+                    theError = !theError
+                        ? new errors.DeviceNotFound(devicetoRemove.deviceId, {
+                              apikey: devicetoRemove.apikey,
+                              service: req.headers['fiware-service'],
+                              subservice: req.headers['fiware-servicepath']
+                          })
+                        : theError;
+                }
+            }
+        ); // waterfall
+        theErrorOut = theError;
+    } // for
+    if (theErrorOut) {
+        next(theErrorOut);
+    } else {
+        res.status(204).send();
+    }
+}
+
 /**
  * This middleware handles updates in the provisioning devices. The only attribute
  */
@@ -379,7 +445,13 @@ function handleUpdateDevice(req, res, next) {
                         }
                     );
                 } else {
-                    next(new errors.DeviceNotFound(req.params.deviceId));
+                    next(
+                        new errors.DeviceNotFound(req.params.deviceId, {
+                            apikey: req.query.apikey,
+                            service: req.headers['fiware-service'],
+                            subservice: req.headers['fiware-servicepath']
+                        })
+                    );
                 }
             }
         );
@@ -414,6 +486,8 @@ function loadContextRoutes(router) {
         handleUpdateDevice
     );
 
+    router.post('/iot/op/delete', restUtils.checkRequestAttributes('headers', mandatoryHeaders), handleRemoveDevices);
+
     router.delete(
         '/iot/devices/:deviceId',
         restUtils.checkRequestAttributes('headers', mandatoryHeaders),

package/lib/services/northBound/restUtils.js

@@ -65,7 +65,7 @@ function checkMandatoryQueryParams(mandatoryAttributes, body, callback) {
     }
 
     if (missing.length !== 0) {
-        const error = new errors.MissingAttributes('Missing attributes: ' + JSON.stringify(missing));
+        const error = new errors.MissingAttributes('Missing attributes: ' + JSON.stringify(missing), body);
         error.code = '400';
 
         callback(error);

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": "4.2.0",
+  "version": "4.4.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",
@@ -45,7 +45,7 @@
   "dependencies": {
     "async": "2.6.4",
     "body-parser": "~1.20.0",
-    "express": "~4.18.1",
+    "express": "~4.19.2",
     "got": "~11.8.5",
     "jexl": "2.3.0",
     "jison": "0.4.18",

package/scripts/legacy_expression_tool/requirements.txt

@@ -1,3 +1,3 @@
 matplotlib==3.7.1
 pandas==2.0.2
-pymongo==4.3.3
+pymongo==4.6.3