Merge pull request #826 from telefonicaid/task/send_update_for_multim…

…easure send update for multiple measures
telefonicaid · May 23, 2024 · aaab9ff · aaab9ff
2 parents 84af6f9 + 66711ab
commit aaab9ff
Show file tree

Hide file tree

Showing 14 changed files with 637 additions and 193 deletions.
diff --git a/CHANGES_NEXT_RELEASE b/CHANGES_NEXT_RELEASE
@@ -1 +1,2 @@
-- Fix: default express limit to 1Mb instead default 100Kb and allow change it throught a conf env var 'IOTA_EXPRESS_LIMIT' (#827)
+- Fix: allow send multiple measures to CB in a batch (POST /v2/op/update) and sorted by TimeInstant when possible, instead of using multiples single request (#825, iotagent-node-lib#1612)
+- Fix: default express limit to 1Mb instead default 100Kb and allow change it throught a conf env var 'IOTA_EXPRESS_LIMIT' (#827)
diff --git a/lib/bindings/HTTPBinding.js b/lib/bindings/HTTPBinding.js
@@ -46,6 +46,7 @@ const constants = require('../constants');
 let context = {
     op: 'IOTAJSON.HTTP.Binding'
 };
+
 const config = require('../configService');
 let httpBindingServer;
 const transport = 'HTTP';
@@ -355,19 +356,13 @@ function handleIncomingMeasure(req, res, next) {
         if (attributeArr.length === 0) {
             finishSouthBoundTransaction(next);
         } else {
-            for (const j in attributeArr) {
-                attributeValues = attributeArr[j];
-                config
-                    .getLogger()
-                    .debug(
-                        context,
-                        'Processing measure device %s with attributeArr %j attributeValues %j',
-                        device.name,
-                        attributeArr,
-                        attributeValues
-                    );
-                if (req.isCommand) {
-                    const executions = [];
+            config
+                .getLogger()
+                .debug(context, 'Processing measure device %s with attributeArr %j', device.name, attributeArr);
+            if (req.isCommand) {
+                const executions = [];
+                for (const j in attributeArr) {
+                    attributeValues = attributeArr[j];
                     for (const k in attributeValues) {
                         executions.push(
                             iotAgentLib.setCommandResult.bind(
@@ -382,12 +377,10 @@ function handleIncomingMeasure(req, res, next) {
                             )
                         );
                     }
-                    async.parallel(executions, updateCommandHandler);
-                } else if (attributeValues.length > 0) {
-                    iotAgentLib.update(device.name, device.type, '', attributeValues, device, updateCommandHandler);
-                } else {
-                    finishSouthBoundTransaction(next);
                 }
+                async.parallel(executions, updateCommandHandler);
+            } else {
+                iotAgentLib.update(device.name, device.type, '', attributeArr, device, updateCommandHandler);
             }
         }
     }

diff --git a/lib/commonBindings.js b/lib/commonBindings.js
@@ -296,38 +296,36 @@ function multipleMeasures(apiKey, deviceId, device, messageObj) {
         } else {
             attributesArray = [values];
         }
-        for (const k in attributesArray) {
-            config
-                .getLogger()
-                .debug(
-                    context,
-                    'Processing multiple measures for device %s with apiKey %s values %j',
-                    deviceId,
-                    apiKey,
-                    attributesArray[k]
+        config
+            .getLogger()
+            .debug(
+                context,
+                'Processing multiple measures for device %s with apiKey %s values %j',
+                deviceId,
+                apiKey,
+                attributesArray
+            );
+        iotAgentLib.update(device.name, device.type, '', attributesArray, device, function (error) {
+            if (error) {
+                config.getLogger().error(
+                    ctxt,
+                    /*jshint quotmark: double */
+                    "MEASURES-002: Couldn't send the updated values to the Context Broker due to an error: %j",
+                    /*jshint quotmark: single */
+                    error
                 );
-            iotAgentLib.update(device.name, device.type, '', attributesArray[k], device, function (error) {
-                if (error) {
-                    config.getLogger().error(
+            } else {
+                config
+                    .getLogger()
+                    .info(
                         ctxt,
-                        /*jshint quotmark: double */
-                        "MEASURES-002: Couldn't send the updated values to the Context Broker due to an error: %j",
-                        /*jshint quotmark: single */
-                        error
+                        'Multiple measures for device %s with apiKey %s successfully updated',
+                        deviceId,
+                        apiKey
                     );
-                } else {
-                    config
-                        .getLogger()
-                        .info(
-                            ctxt,
-                            'Multiple measures for device %s with apiKey %s successfully updated',
-                            deviceId,
-                            apiKey
-                        );
-                }
-                finishSouthBoundTransaction(null);
-            });
-        }
+            }
+            finishSouthBoundTransaction(null);
+        });
     }
 }
 

diff --git a/test/unit/ngsiv2/HTTP_receive_ngsild_measures-test.js b/test/unit/ngsiv2/HTTP_receive_ngsild_measures-test.js
@@ -69,7 +69,6 @@ describe('HTTP: NGSILD Measure reception ', function () {
         async.series([iotAgentLib.clearAll, iotaJson.stop], done);
     });
 
-
     describe('When a POST single NGSILD entity measure with NGSILD format arrives for the HTTP binding and NGSILD is the expected payload type', function () {
         const optionsMeasure = {
             url: 'http://localhost:' + config.http.port + '/iot/json/',
@@ -227,16 +226,8 @@ describe('HTTP: NGSILD Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsildPayloadMeasure.json')
-                )
-                .reply(204);
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsildPayloadMeasure2.json')
+                    '/v2/op/update',
+                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsildPayloadMultipleMeasure.json')
                 )
                 .reply(204);
         });

diff --git a/test/unit/ngsiv2/HTTP_receive_ngsiv2_measures-test.js b/test/unit/ngsiv2/HTTP_receive_ngsiv2_measures-test.js
@@ -289,16 +289,8 @@ describe('HTTP: NGSIv2 Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsiv2PayloadMeasure.json')
-                )
-                .reply(204);
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsiv2PayloadMeasure2.json')
+                    '/v2/op/update',
+                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsiv2PayloadMultipleMeasure.json')
                 )
                 .reply(204);
         });
@@ -528,16 +520,8 @@ describe('HTTP: NGSIv2 Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsiv2PayloadMeasure.json')
-                )
-                .reply(204);
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsiv2PayloadMeasure2.json')
+                    '/v2/op/update',
+                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsiv2PayloadMultipleMeasure2.json')
                 )
                 .reply(204);
         });

diff --git a/test/unit/ngsiv2/HTTP_reveice_measures-test2.js b/test/unit/ngsiv2/HTTP_reveice_measures-test2.js
@@ -142,16 +142,8 @@ describe('HTTP: Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/multipleMeasuresJsonTypes2.json')
-                )
-                .reply(204);
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/multipleMeasuresJsonTypes.json')
+                    '/v2/op/update',
+                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/multipleMeasuresJsonTypes3.json')
                 )
                 .reply(204);
         });
@@ -215,17 +207,8 @@ describe('HTTP: Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures.json')
-                )
-                .reply(204);
-
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures2.json')
+                    '/v2/op/update',
+                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMultipleMeasures.json')
                 )
                 .reply(204);
 
@@ -295,27 +278,9 @@ describe('HTTP: Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures1b.json')
-                )
-                .reply(204);
-
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures2b.json')
-                )
-                .reply(204);
-
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert'
+                    '/v2/op/update'
                     // FIXME: Mock about h atttribute + current timestamp
-                    //utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures.json')
+                    //utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMultipleMeasures1b.json')
                 )
                 .reply(204);
 
@@ -385,25 +350,7 @@ describe('HTTP: Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures1b.json')
-                )
-                .reply(204);
-
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures2b.json')
-                )
-                .reply(204);
-
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert'
+                    '/v2/op/update'
                     // FIXME: Mock about h atttribute + current timestamp
                     //utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures.json')
                 )
@@ -442,7 +389,8 @@ describe('HTTP: Measure reception ', function () {
                     TimeInstant: '2023-03-23T23:33:33Z'
                 },
                 {
-                    h: '111111'
+                    h: '111111',
+                    TimeInstant: '2024-03-23T23:33:33Z'
                 }
             ],
             headers: {
@@ -475,27 +423,8 @@ describe('HTTP: Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures1b.json')
-                )
-                .reply(204);
-
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures2b.json')
-                )
-                .reply(204);
-
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert'
-                    // FIXME: Mock about h atttribute + current timestamp
-                    //utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures.json')
+                    '/v2/op/update',
+                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMultipleMeasures1b.json')
                 )
                 .reply(204);
 
@@ -561,17 +490,8 @@ describe('HTTP: Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures.json')
-                )
-                .reply(204);
-
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMeasures2.json')
+                    '/v2/op/update',
+                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/timeInstantMultipleMeasures.json')
                 )
                 .reply(204);
 
@@ -627,17 +547,8 @@ describe('HTTP: Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/unprovisionedDevice2.json')
-                )
-                .reply(204);
-
-            contextBrokerUnprovMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/unprovisionedDevice.json')
+                    '/v2/op/update',
+                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/unprovisionedDeviceMultiple.json')
                 )
                 .reply(204);
 

diff --git a/test/unit/ngsiv2/MQTT_receive_ngsiv2_measures-test.js b/test/unit/ngsiv2/MQTT_receive_ngsiv2_measures-test.js
@@ -266,16 +266,8 @@ describe('MQTT: NGSIv2 Measure reception ', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsiv2PayloadMeasure.json')
-                )
-                .reply(204);
-            contextBrokerMock
-                .matchHeader('fiware-service', 'smartgondor')
-                .matchHeader('fiware-servicepath', '/gardens')
-                .post(
-                    '/v2/entities?options=upsert',
-                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsiv2PayloadMeasure2.json')
+                    '/v2/op/update',
+                    utils.readExampleFile('./test/unit/ngsiv2/contextRequests/ngsiv2PayloadMultipleMeasure.json')
                 )
                 .reply(204);
         });