Merge pull request #1616 from telefonicaid/task/device_update_handler…

…_with_old_device_value

Task/device update handler with old device value

CHANGES_NEXT_RELEASE

@@ -1,3 +1,4 @@
+- Fix: update device using previous device apikey to avoid error when apikey is updated (iota-json#833)
 - 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 (iotagent-json#825, #1612)
 - Fix: default express limit to 1Mb instead default 100Kb and allow change it throught a conf env var 'IOTA_EXPRESS_LIMIT' (iotagent-json#827)
 - Fix: accept 201 status code from context broker with NGSI-LD interface when first measure is sent and device is created in it (#1617)

lib/services/devices/deviceRegistryMemory.js

@@ -176,7 +176,7 @@ function getByName(name, service, subservice, callback) {
     getByNameAndType(name, null, service, subservice, callback);
 }
 
-function update(device, callback) {
+function update(previousDevice, device, callback) {
     registeredDevices[device.service][device.id] = deepClone(device);
     callback(null, device);
 }

lib/services/devices/deviceRegistryMongoDB.js

@@ -290,9 +290,9 @@ function getByName(name, service, servicepath, callback) {
  *
  * @param {Object} device       Device object with the new values to write.
  */
-function update(device, callback) {
+function update(previousDevice, device, callback) {
     logger.debug(context, 'Storing updated values for device [%s]:\n%s', device.id, JSON.stringify(device, null, 4));
-    getDevice(device.id, device.apikey, device.service, device.subservice, function (error, data) {
+    getDevice(device.id, previousDevice.apikey, device.service, device.subservice, function (error, data) {
         if (error) {
             callback(error);
         } else {

lib/services/devices/deviceService.js

@@ -444,8 +444,8 @@ function unregisterDevice(id, apikey, service, subservice, callback) {
     });
 }
 
-function updateRegisterDevice(deviceObj, entityInfoUpdated, callback) {
-    deviceHandler.updateRegisterDevice(deviceObj, entityInfoUpdated, callback);
+function updateRegisterDevice(deviceObj, previousDevice, entityInfoUpdated, callback) {
+    deviceHandler.updateRegisterDevice(deviceObj, previousDevice, entityInfoUpdated, callback);
 }
 
 /**
@@ -518,7 +518,8 @@ function getDevice(deviceId, apikey, service, subservice, callback) {
  * @param {String} device           JSON object contain the device to update.
  */
 function updateDevice(device, callback) {
-    config.getRegistry().update(device, callback);
+    logger.debug(context, 'updateDevice %j', device);
+    config.getRegistry().update(device, device, callback);
 }
 
 /**

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

@@ -182,7 +182,7 @@ function updateEntityNgsiLD(deviceData, updatedDevice, callback) {
  *
  * @param {Object} deviceObj                    Object with all the device information (mandatory).
  */
-function updateRegisterDeviceNgsiLD(deviceObj, entityInfoUpdated, callback) {
+function updateRegisterDeviceNgsiLD(deviceObj, previousDevice, entityInfoUpdated, callback) {
     if (!deviceObj.id || !deviceObj.type) {
         callback(new errors.MissingAttributes('Id or device missing', deviceObj));
         return;
@@ -280,7 +280,7 @@ function updateRegisterDeviceNgsiLD(deviceObj, entityInfoUpdated, callback) {
                 apply(
                     config.getRegistry().get,
                     deviceObj.id,
-                    deviceObj.apikey,
+                    previousDevice.apikey,
                     deviceObj.service,
                     deviceObj.subservice
                 ),
@@ -289,7 +289,7 @@ function updateRegisterDeviceNgsiLD(deviceObj, entityInfoUpdated, callback) {
                 apply(combineWithNewDevice, deviceObj),
                 apply(registrationUtils.sendRegistrations, false),
                 apply(registrationUtils.processContextRegistration, deviceObj),
-                config.getRegistry().update
+                apply(config.getRegistry().update, previousDevice)
             ],
             callback
         );
@@ -299,7 +299,7 @@ function updateRegisterDeviceNgsiLD(deviceObj, entityInfoUpdated, callback) {
                 apply(
                     config.getRegistry().get,
                     deviceObj.id,
-                    deviceObj.apikey,
+                    previousDevice.apikey,
                     deviceObj.service,
                     deviceObj.subservice
                 ),
@@ -308,7 +308,7 @@ function updateRegisterDeviceNgsiLD(deviceObj, entityInfoUpdated, callback) {
                 apply(combineWithNewDevice, deviceObj),
                 apply(registrationUtils.sendRegistrations, false),
                 apply(registrationUtils.processContextRegistration, deviceObj),
-                config.getRegistry().update
+                apply(config.getRegistry().update, previousDevice)
             ],
             callback
         );

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

@@ -38,11 +38,11 @@ const deviceHandlerV2 = require('./devices-NGSI-v2');
  *
  * @param {Object} deviceObj                    Object with all the device information (mandatory).
  */
-function updateRegisterDeviceNgsiMixed(deviceObj, entityInfoUpdated, callback) {
+function updateRegisterDeviceNgsiMixed(deviceObj, previousDevice, entityInfoUpdated, callback) {
     if (config.checkNgsiLD(deviceObj)) {
-        deviceHandlerLD.updateRegisterDevice(deviceObj, entityInfoUpdated, callback);
+        deviceHandlerLD.updateRegisterDevice(deviceObj, previousDevice, entityInfoUpdated, callback);
     } else {
-        deviceHandlerV2.updateRegisterDevice(deviceObj, entityInfoUpdated, callback);
+        deviceHandlerV2.updateRegisterDevice(deviceObj, previousDevice, entityInfoUpdated, callback);
     }
 }
 

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

@@ -247,7 +247,7 @@ function updateEntityNgsi2(deviceData, updatedDevice, callback) {
  *
  * @param {Object} deviceObj                    Object with all the device information (mandatory).
  */
-function updateRegisterDeviceNgsi2(deviceObj, entityInfoUpdated, callback) {
+function updateRegisterDeviceNgsi2(deviceObj, previousDevice, entityInfoUpdated, callback) {
     if (!deviceObj.id || !deviceObj.type) {
         callback(new errors.MissingAttributes('Id or device missing', deviceObj));
         return;
@@ -352,7 +352,7 @@ function updateRegisterDeviceNgsi2(deviceObj, entityInfoUpdated, callback) {
                 apply(
                     config.getRegistry().get,
                     deviceObj.id,
-                    deviceObj.apikey,
+                    previousDevice.apikey, // it could be updated
                     deviceObj.service,
                     deviceObj.subservice
                 ),
@@ -361,7 +361,7 @@ function updateRegisterDeviceNgsi2(deviceObj, entityInfoUpdated, callback) {
                 apply(combineWithNewDevice, deviceObj),
                 apply(registrationUtils.sendRegistrations, false),
                 apply(registrationUtils.processContextRegistration, deviceObj),
-                config.getRegistry().update
+                apply(config.getRegistry().update, previousDevice)
             ],
             callback
         );
@@ -371,7 +371,7 @@ function updateRegisterDeviceNgsi2(deviceObj, entityInfoUpdated, callback) {
                 apply(
                     config.getRegistry().get,
                     deviceObj.id,
-                    deviceObj.apikey,
+                    previousDevice.apikey,
                     deviceObj.service,
                     deviceObj.subservice
                 ),
@@ -380,7 +380,7 @@ function updateRegisterDeviceNgsi2(deviceObj, entityInfoUpdated, callback) {
                 apply(combineWithNewDevice, deviceObj),
                 apply(registrationUtils.sendRegistrations, false),
                 apply(registrationUtils.processContextRegistration, deviceObj),
-                config.getRegistry().update
+                apply(config.getRegistry().update, previousDevice)
             ],
             callback
         );

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

@@ -89,7 +89,7 @@ function createSubscriptionHandlerNgsiLD(device, triggers, store, callback) {
                 triggers
             });
 
-            config.getRegistry().update(device, callback);
+            config.getRegistry().update(device, device, callback);
         } else {
             callback(null, response.headers.location);
         }
@@ -203,7 +203,7 @@ function createUnsubscribeHandlerNgsiLD(device, id, callback) {
             callback(new errors.BadRequest(body.orionError.details));
         } else {
             device.subscriptions.splice(device.subscriptions.indexOf(id), 1);
-            config.getRegistry().update(device, callback);
+            config.getRegistry().update(device, device, callback);
         }
     };
 }

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

@@ -91,7 +91,7 @@ function createSubscriptionHandlerNgsi2(device, triggers, store, callback) {
                 triggers
             });
 
-            config.getRegistry().update(device, callback);
+            config.getRegistry().update(device, device, callback);
         } else {
             callback(null, response.headers.location);
         }
@@ -203,7 +203,7 @@ function createUnsubscribeHandlerNgsi2(device, id, callback) {
             callback(new errors.BadRequest(body.orionError.details));
         } else {
             device.subscriptions.splice(device.subscriptions.indexOf(id), 1);
-            config.getRegistry().update(device, callback);
+            config.getRegistry().update(device, device, callback);
         }
     };
 }

lib/services/northBound/deviceProvisioningServer.js

@@ -398,11 +398,11 @@ function handleRemoveDevices(req, res, next) {
  * This middleware handles updates in the provisioning devices. The only attribute
  */
 function handleUpdateDevice(req, res, next) {
-    function applyUpdatingHandler(device, callback) {
+    function applyUpdatingHandler(newDevice, oldDevice, callback) {
         if (updatingHandler) {
-            updatingHandler(device, callback);
+            updatingHandler(newDevice, oldDevice, callback);
         } else {
-            callback(null, device);
+            callback(null, newDevice);
         }
     }
 
@@ -429,10 +429,11 @@ function handleUpdateDevice(req, res, next) {
                         isTypeOrNameUpdated = true;
                     }
                     async.waterfall(
-                        [apply(applyUpdatingHandler, newDevice)],
+                        [apply(applyUpdatingHandler, newDevice, device)],
                         function handleUpdating(error, newDeviceUpdated) {
                             deviceService.updateRegister(
                                 newDeviceUpdated,
+                                device,
                                 isTypeOrNameUpdated,
                                 function handleDeviceUpdate(error) {
                                     if (error) {

test/unit/examples/deviceProvisioningRequests/updateProvisionDeviceWithApikey.json

@@ -0,0 +1,4 @@
+{
+    "apikey": "APIKEY2",
+    "timezone": "Europe/Madrid"
+}

test/unit/ngsi-ld/provisioning/device-update-registration_test.js

@@ -186,14 +186,14 @@ describe('NGSI-LD - IoT Agent Device Update Registration', function () {
         });
 
         it('should register as ContextProvider of its lazy attributes', function (done) {
-            iotAgentLib.updateRegister(deviceUpdated, false, function (error) {
+            iotAgentLib.updateRegister(deviceUpdated, device1, false, function (error) {
                 should.not.exist(error);
                 contextBrokerMock.done();
                 done();
             });
         });
         it('should store the new values in the registry', function (done) {
-            iotAgentLib.updateRegister(deviceUpdated, false, function (error, data) {
+            iotAgentLib.updateRegister(deviceUpdated, device1, false, function (error, data) {
                 iotAgentLib.getDevice(deviceUpdated.id, null, 'smartgondor', 'gardens', function (error, deviceResult) {
                     should.not.exist(error);
                     should.exist(deviceResult);
@@ -236,7 +236,7 @@ describe('NGSI-LD - IoT Agent Device Update Registration', function () {
         //     });
         // });
         it('should store the new values in the registry', function (done) {
-            iotAgentLib.updateRegister(deviceCommandUpdated, false, function (error, data) {
+            iotAgentLib.updateRegister(deviceCommandUpdated, device1, false, function (error, data) {
                 iotAgentLib.getDevice(
                     deviceCommandUpdated.id,
                     null,
@@ -257,7 +257,7 @@ describe('NGSI-LD - IoT Agent Device Update Registration', function () {
 
     describe('When a update action is executed in a non registered device', function () {
         it('should return a DEVICE_NOT_FOUND error', function (done) {
-            iotAgentLib.updateRegister(unknownDevice, false, function (error) {
+            iotAgentLib.updateRegister(unknownDevice, device1, false, function (error) {
                 should.exist(error);
                 error.name.should.equal('DEVICE_NOT_FOUND');
                 done();
@@ -273,7 +273,7 @@ describe('NGSI-LD - IoT Agent Device Update Registration', function () {
         });
 
         it('should return a REGISTRATION_ERROR error in the update action', function (done) {
-            iotAgentLib.updateRegister(deviceUpdated, false, function (error) {
+            iotAgentLib.updateRegister(deviceUpdated, device1, false, function (error) {
                 should.exist(error);
                 //error.name.should.equal('UNREGISTRATION_ERROR');
                 done();

test/unit/ngsiv2/provisioning/device-update-registration_test.js

@@ -197,15 +197,15 @@ describe('NGSI-v2 - IoT Agent Device Update Registration', function () {
         });
 
         it('should register as ContextProvider of its lazy attributes', function (done) {
-            iotAgentLib.updateRegister(deviceUpdated, false, function (error) {
+            iotAgentLib.updateRegister(deviceUpdated, device1, false, function (error) {
                 should.not.exist(error);
                 contextBrokerMock.done();
                 done();
             });
         });
 
         it('should store the new values in the registry', function (done) {
-            iotAgentLib.updateRegister(deviceUpdated, false, function (error, data) {
+            iotAgentLib.updateRegister(deviceUpdated, device1, false, function (error, data) {
                 iotAgentLib.getDevice(deviceUpdated.id, null, 'smartgondor', 'gardens', function (error, deviceResult) {
                     should.not.exist(error);
                     should.exist(deviceResult);
@@ -253,15 +253,15 @@ describe('NGSI-v2 - IoT Agent Device Update Registration', function () {
         });
 
         it('should register as ContextProvider of its commands and create the additional attributes', function (done) {
-            iotAgentLib.updateRegister(deviceCommandUpdated, false, function (error) {
+            iotAgentLib.updateRegister(deviceCommandUpdated, device1, false, function (error) {
                 should.not.exist(error);
                 contextBrokerMock.done();
                 done();
             });
         });
 
         it('should store the new values in the registry', function (done) {
-            iotAgentLib.updateRegister(deviceCommandUpdated, false, function (error, data) {
+            iotAgentLib.updateRegister(deviceCommandUpdated, device1, false, function (error, data) {
                 iotAgentLib.getDevice(
                     deviceCommandUpdated.id,
                     null,
@@ -282,7 +282,7 @@ describe('NGSI-v2 - IoT Agent Device Update Registration', function () {
 
     describe('When a update action is executed in a non registered device', function () {
         it('should return a DEVICE_NOT_FOUND error', function (done) {
-            iotAgentLib.updateRegister(unknownDevice, false, function (error) {
+            iotAgentLib.updateRegister(unknownDevice, device1, false, function (error) {
                 should.exist(error);
                 error.name.should.equal('DEVICE_NOT_FOUND');
                 done();
@@ -304,7 +304,7 @@ describe('NGSI-v2 - IoT Agent Device Update Registration', function () {
         });
 
         it('should return a REGISTRATION_ERROR error in the update action', function (done) {
-            iotAgentLib.updateRegister(deviceUpdated, false, function (error) {
+            iotAgentLib.updateRegister(deviceUpdated, device1, false, function (error) {
                 should.exist(error);
                 error.name.should.equal('UNREGISTRATION_ERROR');
                 done();

test/unit/ngsiv2/provisioning/updateProvisionedDevices-test.js

@@ -289,6 +289,41 @@ describe('NGSI-v2 - Device provisioning API: Update provisioned devices', functi
             });
         });
     });
+    describe('When an update request arrives with a new Apikey', function () {
+        const optionsUpdate = {
+            url: 'http://localhost:' + iotAgentConfig.server.port + '/iot/devices/Light1',
+            method: 'PUT',
+            headers: {
+                'fiware-service': 'smartgondor',
+                'fiware-servicepath': '/gardens'
+            },
+            json: utils.readExampleFile(
+                './test/unit/examples/deviceProvisioningRequests/updateProvisionDeviceWithApikey.json'
+            )
+        };
+
+        beforeEach(function () {
+            contextBrokerMock
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', '/gardens')
+                .delete('/v2/registrations/6319a7f5254b05844116584d', '')
+                .reply(204);
+
+            contextBrokerMock
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', '/gardens')
+                .post('/v2/registrations')
+                .reply(201, null, { Location: '/v2/registrations/4419a7f5254b058441165849' });
+        });
+
+        it('should raise a 204 error', function (done) {
+            request(optionsUpdate, function (error, response, body) {
+                should.not.exist(error);
+                response.statusCode.should.equal(204);
+                done();
+            });
+        });
+    });
     describe('When a wrong update request payload arrives', function () {
         const optionsUpdate = {
             url: 'http://localhost:' + iotAgentConfig.server.port + '/iot/devices/Light1',