iotagent-node-lib 4.6.0 → 4.8.0

package/lib/services/groups/groupRegistryMongoDB.js

@@ -24,7 +24,7 @@
  */
 
 const logger = require('logops');
-const dbService = require('../../model/dbConn');
+const mongoose = require('mongoose');
 const intoTrans = require('../common/domain').intoTrans;
 const fillService = require('./../common/domain').fillService;
 const alarmsInt = require('../common/alarmManagement').intercept;
@@ -61,28 +61,11 @@ const attributeList = [
     'defaultEntityNameConjunction',
     'ngsiVersion',
     'entityNameExp',
-    'payloadType'
+    'payloadType',
+    'useCBflowControl',
+    'storeLastMeasure'
 ];
 
-/**
- * Generates a handler for the save device group operations. The handler will take the customary error and the saved
- * device group as the parameters (and pass the serialized DAO as the callback value).
- *
- * @return {Function}       The generated handler.
- */
-function saveGroupHandler(groupDAO, callback) {
-    /* eslint-disable-next-line no-unused-vars */
-    return function saveHandler(error, result) {
-        if (error) {
-            logger.debug(fillService(context, groupDAO), 'Error storing device group information: %s', error);
-
-            callback(new errors.InternalDbError(error));
-        } else {
-            callback(null, groupDAO.toObject());
-        }
-    };
-}
-
 function createGroup(group, callback) {
     /* eslint-disable-next-line  new-cap */
     const groupObj = new Group.model();
@@ -99,9 +82,12 @@ function createGroup(group, callback) {
         groupObj.apikey,
         groupObj.resource
     );
-
-    groupObj.save(function saveHandler(error, groupDAO) {
-        if (error) {
+    groupObj
+        .save({})
+        .then((groupDAO) => {
+            callback(null, groupDAO.toObject());
+        })
+        .catch((error) => {
             if (error.code === 11000) {
                 logger.debug(
                     context,
@@ -109,17 +95,12 @@ function createGroup(group, callback) {
                     group.resource,
                     group.apikey
                 );
-
                 callback(new errors.DuplicateGroup(group));
             } else {
                 logger.debug(context, 'Error storing device group information: %s', error);
-
                 callback(new errors.InternalDbError(error));
             }
-        } else {
-            callback(null, groupDAO.toObject());
-        }
-    });
+        });
 }
 
 /**
@@ -141,7 +122,7 @@ function listGroups(service, limit, offset, callback) {
     }
 
     const query = Group.model.find(condition).sort();
-
+    const queryCount = Group.model.countDocuments(condition);
     if (limit) {
         query.limit(parseInt(limit, 10));
     }
@@ -149,16 +130,32 @@ function listGroups(service, limit, offset, callback) {
     if (offset) {
         query.skip(parseInt(offset, 10));
     }
-
-    async.series(
-        [query.exec.bind(query), Group.model.countDocuments.bind(Group.model, condition)],
-        function (error, results) {
-            callback(error, {
-                count: results[1],
-                services: results[0].map(toObjectFn)
+    function funcQuery(cb) {
+        query
+            .exec({})
+            .then((res) => {
+                cb(null, res);
+            })
+            .catch((error) => {
+                cb(error);
             });
-        }
-    );
+    }
+    function funcQueryCount(cb) {
+        queryCount
+            .exec({})
+            .then((res) => {
+                cb(null, res);
+            })
+            .catch((error) => {
+                cb(error);
+            });
+    }
+    async.series([funcQuery, funcQueryCount], function (error, results) {
+        callback(error, {
+            count: results[1],
+            services: results[0].map(toObjectFn)
+        });
+    });
 }
 
 function getById(id, callback) {
@@ -168,21 +165,22 @@ function getById(id, callback) {
     const query = Group.model.findOne({ _id: id });
     query.select({ __v: 0 });
 
-    query.lean().exec(function handleGet(error, data) {
-        if (error) {
+    query
+        .exec({})
+        .then((data) => {
+            if (data) {
+                context = fillService(context, data);
+                logger.debug(context, 'Device group data found: %j', data);
+                callback(null, data);
+            } else {
+                logger.debug(context, 'Device group [%s] not found.', id);
+                callback(new errors.DeviceGroupNotFound(id));
+            }
+        })
+        .catch((error) => {
             logger.debug(context, 'Internal MongoDB Error getting group: %s', error);
-
             callback(new errors.InternalDbError(error));
-        } else if (data) {
-            context = fillService(context, data);
-            logger.debug(context, 'Device group data found: %j', data);
-            callback(null, data);
-        } else {
-            logger.debug(context, 'Device group [%s] not found.', id);
-
-            callback(new errors.DeviceGroupNotFound(id));
-        }
-    });
+        });
 }
 
 /**
@@ -203,34 +201,56 @@ function find(service, subservice, callback) {
     condition.subservice = subservice;
 
     const query = Group.model.find(condition).sort();
-
-    async.series(
-        [query.exec.bind(query), Group.model.countDocuments.bind(Group.model, condition)],
-        function (error, results) {
-            callback(error, {
-                count: results[1],
-                services: results[0].map(toObjectFn)
+    const queryCount = Group.model.countDocuments(condition);
+    function funcQuery(cb) {
+        query
+            .exec({})
+            .then((res) => {
+                cb(null, res);
+            })
+            .catch((error) => {
+                cb(error);
             });
-        }
-    );
+    }
+    function funcQueryCount(cb) {
+        queryCount
+            .exec({})
+            .then((res) => {
+                cb(null, res);
+            })
+            .catch((error) => {
+                cb(error);
+            });
+    }
+    async.series([funcQuery, funcQueryCount], function (error, results) {
+        callback(error, {
+            count: results[1],
+            services: results[0].map(toObjectFn)
+        });
+    });
 }
 
 function findOneInMongoDB(queryObj, fields, callback) {
     const query = Group.model.findOne(queryObj);
     query.select({ __v: 0 });
-    query.lean().exec(function handleGet(error, data) {
-        if (error) {
+    query.lean();
+
+    query
+        .exec({})
+        .then((data) => {
+            if (data) {
+                context = fillService(context, data);
+                logger.debug(context, 'Device group data found: %j', data);
+                callback(null, data);
+            } else {
+                logger.debug(context, 'Device group for fields [%j] not found: [%j]', fields, queryObj);
+                callback(new errors.DeviceGroupNotFound(fields, queryObj));
+            }
+        })
+        .catch((error) => {
             logger.debug(context, 'Internal MongoDB Error getting group: %s', error);
             callback(new errors.InternalDbError(error));
-        } else if (data) {
-            context = fillService(context, data);
-            logger.debug(context, 'Device group data found: %j', data);
-            callback(null, data);
-        } else {
-            logger.debug(context, 'Device group for fields [%j] not found: [%j]', fields, queryObj);
-            callback(new errors.DeviceGroupNotFound(fields, queryObj));
-        }
-    });
+        });
 }
 
 function findBy(fields) {
@@ -269,7 +289,15 @@ function update(id, body, callback) {
             /* eslint-disable-next-line  new-cap */
             const groupObj = new Group.model(group);
             groupObj.isNew = false;
-            groupObj.save(saveGroupHandler(groupObj, callback));
+            groupObj
+                .save({})
+                .then((groupDAO) => {
+                    callback(null, groupDAO.toObject());
+                })
+                .catch((error) => {
+                    logger.debug(fillService(context, group), 'Error storing device group information: %s', error);
+                    callback(new errors.InternalDbError(error));
+                });
         }
     });
 }
@@ -281,16 +309,18 @@ function remove(id, callback) {
         if (error) {
             callback(error);
         } else {
-            Group.model.deleteOne({ _id: id }, function (error) {
-                if (error) {
-                    logger.debug(context, 'Internal MongoDB Error getting device: %s', error);
+            const query = Group.model.deleteOne({ _id: id });
+            query
+                .exec({})
+                .then(() => {
+                    logger.debug(context, 'Device group [%s] successfully removed.', id);
+                    callback(null, deviceGroup);
+                })
+                .catch((error) => {
+                    logger.debug(context, 'Internal MongoDB Error getting device group: %s', error);
 
                     callback(new errors.InternalDbError(error));
-                } else {
-                    logger.debug(context, 'Device [%s] successfully removed.', id);
-                    callback(null, deviceGroup);
-                }
-            });
+                });
         }
     });
 }
@@ -300,7 +330,14 @@ function init(newConfig, callback) {
 }
 
 function clear(callback) {
-    dbService.db.db.dropDatabase(callback);
+    mongoose.connection
+        .dropDatabase()
+        .then(() => {
+            callback(null);
+        })
+        .catch((error) => {
+            callback(error);
+        });
 }
 
 exports.create = alarmsInt(constants.MONGO_ALARM + '_01', intoTrans(context, createGroup));

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

@@ -347,6 +347,10 @@ function sendUpdateValueNgsi2(entityName, originMeasures, originTypeInformation,
         //metadata static attributes
         jexlctxt = reduceMetadataAttrToPlainObject(typeInformation.staticAttributes, jexlctxt);
 
+        //recover oldctxt
+        if (typeInformation.oldCtxt) {
+            jexlctxt.oldCtxt = typeInformation.oldCtxt;
+        }
         logger.debug(
             context,
             'sendUpdateValueNgsi2 loop with: entityName=%s,  measures=%j,  typeInformation=%j, initial jexlContext=%j, timestamp=%j',
@@ -652,9 +656,15 @@ function sendUpdateValueNgsi2(entityName, originMeasures, originTypeInformation,
                 }
             }
         }
+        //Add jexlctxt to typeInformation without oldCtxt
+        const oldCJexlctxt = { ...jexlctxt };
+        delete oldCJexlctxt.oldCtxt;
+        originTypeInformation['oldCtxt'] = oldCJexlctxt;
     } // end for (let measures of originMeasures)
-
     let url = '/v2/op/update';
+    if (originTypeInformation.useCBflowControl) {
+        url += '?options=flowControl';
+    }
     let options = NGSIUtils.createRequestObject(url, originTypeInformation, token);
     options.json = payload;
 
@@ -680,6 +690,9 @@ function sendUpdateValueNgsi2(entityName, originMeasures, originTypeInformation,
         if (!multi) {
             // recreate options object to use single entity update
             url = '/v2/entities?options=upsert';
+            if (originTypeInformation.useCBflowControl) {
+                url += ',flowControl';
+            }
             options = NGSIUtils.createRequestObject(url, originTypeInformation, token);
             delete payload.actionType;
 

package/lib/services/ngsi/ngsiService.js

@@ -27,6 +27,7 @@
 const async = require('async');
 const apply = async.apply;
 const statsRegistry = require('../stats/statsRegistry');
+const deviceService = require('../devices/deviceService');
 const intoTrans = require('../common/domain').intoTrans;
 const fillService = require('./../common/domain').fillService;
 const errors = require('../../errors');
@@ -69,7 +70,37 @@ function init() {
  */
 function sendUpdateValue(entityName, attributes, typeInformation, token, callback) {
     const newCallback = statsRegistry.withStats('updateEntityRequestsOk', 'updateEntityRequestsError', callback);
-    entityHandler.sendUpdateValue(entityName, attributes, typeInformation, token, newCallback);
+    const additionalCallback = (data, next) => {
+        if (typeInformation.oldCtxt) {
+            logger.debug(context, 'StoreOldCtxt %j', typeInformation.oldCtxt);
+            deviceService.storeDeviceField('oldCtxt', typeInformation.oldCtxt, typeInformation, function () {
+                next(null, data);
+            });
+        } else {
+            next(null, data);
+        }
+    };
+    const wrappedNewCallback = (err, result) => {
+        if (err) {
+            newCallback(err);
+        } else {
+            additionalCallback(result, (additionalErr, modifiedResult) => {
+                if (additionalErr) {
+                    newCallback(additionalErr);
+                }
+                newCallback(null, modifiedResult || result);
+            });
+        }
+    };
+    // check config about store last measure
+    if (typeInformation.storeLastMeasure) {
+        logger.debug(context, 'StoreLastMeasure for %j', typeInformation);
+        deviceService.storeDeviceField('lastMeasure', attributes, typeInformation, function () {
+            return entityHandler.sendUpdateValue(entityName, attributes, typeInformation, token, wrappedNewCallback);
+        });
+    } else {
+        entityHandler.sendUpdateValue(entityName, attributes, typeInformation, token, wrappedNewCallback);
+    }
 }
 
 /**

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

@@ -292,9 +292,18 @@ function handleNotificationNgsi2(req, res, next) {
                 }
             }
         }
+        logger.debug(context, 'extracted atts %j from dataElement %j', atts, dataElement);
+        var id = null;
+        var type = null;
+        if (dataElement.targetEntityId && dataElement.targetEntityId.value) {
+            id = dataElement.targetEntityId.value;
+        }
+        if (dataElement.targetEntityType && dataElement.targetEntityType.value) {
+            type = dataElement.targetEntityType.value;
+        }
         deviceService.getDeviceByNameAndType(
-            dataElement.id,
-            dataElement.type,
+            id,
+            type,
             req.headers['fiware-service'],
             req.headers['fiware-servicepath'],
             function (error, device) {
@@ -336,7 +345,7 @@ function handleNotificationNgsi2(req, res, next) {
             logger.error(context, 'Error found when processing notification: %j', error);
             next(error);
         } else {
-            res.status(200).json({});
+            res.status(204).json();
         }
     }
 

package/lib/services/northBound/contextServer.js

@@ -30,7 +30,7 @@ const context = {
     op: 'IoTAgentNGSI.ContextServer'
 };
 const contextServerUtils = require('./contextServerUtils');
-
+const executeUpdateSideEffects = contextServerUtils.executeUpdateSideEffects;
 let contextServerHandler;
 
 /**
@@ -157,4 +157,5 @@ exports.setCommandHandler = intoTrans(context, setCommandHandler);
 exports.setNotificationHandler = intoTrans(context, setNotificationHandler);
 exports.addNotificationMiddleware = intoTrans(context, addNotificationMiddleware);
 exports.setQueryHandler = intoTrans(context, setQueryHandler);
+exports.executeUpdateSideEffects = intoTrans(context, executeUpdateSideEffects);
 exports.init = init;

package/lib/services/northBound/deviceProvisioningServer.js

@@ -64,7 +64,10 @@ const provisioningAPITranslation = {
     explicitAttrs: 'explicitAttrs',
     ngsiVersion: 'ngsiVersion',
     entityNameExp: 'entityNameExp',
-    payloadType: 'payloadType'
+    payloadType: 'payloadType',
+    useCBflowControl: 'useCBflowControl',
+    storeLastMeasure: 'storeLastMeasure',
+    lastMeasure: 'lastMeasure'
 };
 
 /**
@@ -143,7 +146,10 @@ function handleProvision(req, res, next) {
             autoprovision: body.autoprovision,
             explicitAttrs: body.explicitAttrs,
             ngsiVersion: body.ngsiVersion,
-            payloadType: body.payloadType
+            payloadType: body.payloadType,
+            useCBflowControl: body.useCBflowControl,
+            storeLastMeasure: body.storeLastMeasure,
+            lastMeasure: body.lastMeasure
         });
     }
 
@@ -220,7 +226,10 @@ function toProvisioningAPIFormat(device) {
         autoprovision: device.autoprovision,
         explicitAttrs: device.explicitAttrs,
         ngsiVersion: device.ngsiVersion,
-        payloadType: device.payloadType
+        payloadType: device.payloadType,
+        useCBflowControl: device.useCBflowControl,
+        storeLastMeasure: device.storeLastMeasure,
+        lastMeasure: device.lastMeasure
     };
 }
 

package/lib/services/northBound/northboundServer.js

@@ -125,6 +125,7 @@ exports.setRemoveDeviceHandler = intoTrans(context, deviceProvisioning.setRemove
 exports.addDeviceProvisionMiddleware = deviceProvisioning.addDeviceProvisionMiddleware;
 exports.addConfigurationProvisionMiddleware = groupProvisioning.addConfigurationProvisionMiddleware;
 exports.addNotificationMiddleware = contextServer.addNotificationMiddleware;
+exports.executeUpdateSideEffects = contextServer.executeUpdateSideEffects;
 exports.clear = clear;
 exports.start = intoTrans(context, start);
 exports.stop = intoTrans(context, stop);

package/lib/templates/createDevice.json

@@ -167,6 +167,10 @@
                     "description": "Content type",
                     "type": "string"
                 },
+                "headers": {
+                  "description": "Optional headers to include with command",
+                  "type": "object"
+                },
                 "mqtt": {
                   "description": "Mqtt properties",
                   "type": "object",

package/lib/templates/updateDevice.json

@@ -145,10 +145,18 @@
               "description": "Optional expression for command transformation",
               "type": "string"
           },
+          "headers": {
+              "description": "Optional headers to include with command",
+              "type": "object"
+          },
           "payloadType": {
               "description": "Payload type",
               "type": "string"
           },
+          "useCBflowControl": {
+              "description": "use CB flowControl option",
+              "type": "boolean"
+          },
           "contentType": {
               "description": "Content type",
               "type": "string"
@@ -194,6 +202,14 @@
     "payloadType": {
         "description": "Payload type allowed for measures for this device",
         "type": "string"
+    },
+    "storeLastMeasure": {
+      "description": "Store last measure",
+      "type": "boolean"
+    },
+    "lastMeasure": {
+      "description": "last measure",
+      "type": "object"
     }
   }
 }

package/lib/templates/updateDeviceLax.json

@@ -146,6 +146,18 @@
     "payloadType": {
         "description": "Payload type allowed for measures for this device",
         "type": "string"
+    },
+    "useCBflowControl": {
+        "description": "use CB flowControl option",
+        "type": "boolean"
+    },
+    "storeLastMeasure": {
+      "description": "Store last measure",
+      "type": "boolean"
+    },
+    "lastMeasure": {
+      "description": "last measure",
+      "type": "object"
     }
   }
 }

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.6.0",
+  "version": "4.8.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",
@@ -45,14 +45,14 @@
   "dependencies": {
     "async": "2.6.4",
     "body-parser": "~1.20.3",
-    "express": "~4.19.2",
+    "express": "~4.21.2",
     "got": "~11.8.5",
     "jexl": "2.3.0",
     "jison": "0.4.18",
     "logops": "2.1.2",
     "moment": "~2.29.2",
     "moment-timezone": "~0.5.34",
-    "mongoose": "5.13.20",
+    "mongoose": "8.9.5",
     "query-string": "7.1.1",
     "revalidator": "~0.3.1",
     "underscore": "~1.13.4",
@@ -69,7 +69,7 @@
     "husky": "~4.2.5",
     "lint-staged": "~12.3.8",
     "mocha": "10.0.0",
-    "mongodb": "4.17.1",
+    "mongodb": "4.17.2",
     "nock": "13.2.7",
     "nyc": "~15.1.0",
     "prettier": "~2.7.1",

package/test/functional/config-test.js

@@ -45,7 +45,7 @@ config.amqp = {
 };
 
 config.iota = {
-    logLevel: 'FATAL',
+    logLevel: 'DEBUG',
     contextBroker: {
         host: '192.168.1.1',
         port: '1026',
@@ -61,7 +61,8 @@ config.iota = {
     service: 'smartgondor',
     subservice: '/gardens',
     providerUrl: 'http://localhost:4041',
-    types: {}
+    types: {},
+    useCBflowControl: true
 };
 
 config.defaultKey = '1234';

package/test/functional/testUtils.js

@@ -74,16 +74,27 @@ function sendMeasureIotaLib(measure, provision) {
          *  This is not a problem for the tests using other transports than Lib, in that case, the type will be retrieved
          *  from the real provision.
          */
+        let typeInformation = {
+            service: provision.headers['fiware-service'],
+            subservice: provision.headers['fiware-servicepath']
+        };
         let type;
+        let staticAttrs;
         if (Array.isArray(provision.json.services) && provision.json.services.length > 0) {
             type = provision.json.services[0].entity_type;
+            staticAttrs = provision.json.services[0].static_attributes;
         } else {
             type = DEF_TYPE;
         }
+        typeInformation.type = type;
+        if (staticAttrs) {
+            typeInformation.staticAttributes = staticAttrs;
+        }
+        typeInformation.id = measure.qs.i;
         iotAgentLib.update(
             type + ':' + measure.qs.i,
             type,
-            '',
+            typeInformation,
             jsonToIotaMeasures(measure.json),
             function (error, result, body) {
                 error ? reject(error) : resolve(result);
@@ -204,9 +215,9 @@ async function testCase(measure, expectation, provision, env, config, type, tran
     let cbMockRoute = '';
     // Set the correct route depending if the test is multientity or not
     if (type === 'multientity' || type === 'multimeasure') {
-        cbMockRoute = '/v2/op/update';
+        cbMockRoute = '/v2/op/update?options=flowControl';
     } else {
-        cbMockRoute = '/v2/entities?options=upsert';
+        cbMockRoute = '/v2/entities?options=upsert,flowControl';
     }
 
     // Set the correct mock times depending if the test is multimeasure or not
@@ -230,7 +241,7 @@ async function testCase(measure, expectation, provision, env, config, type, tran
     if (transport === 'MQTT') {
         try {
             let client = await MQTT.connectAsync('mqtt://' + config.mqtt.host);
-            await client.publish('/' + measure.qs.k + '/' + measure.qs.i + '/attrs', JSON.stringify(measure.json));
+            await client.publish('/json/' + measure.qs.k + '/' + measure.qs.i + '/attrs', JSON.stringify(measure.json));
             await client.end();
         } catch (error) {
             expect.fail(ERR_MQTT + error);

package/test/unit/examples/groupProvisioningRequests/provisionFullGroup.json

@@ -6,6 +6,7 @@
       "entity_type": "SensorMachine",
       "trust": "8970A9078A803H3BL98PINEQRW8342HBAMS",
       "cbHost": "http://unexistentHost:1026",
+      "useCBflowControl": true,
       "commands": [
         {
           "name": "wheel1",