iotagent-node-lib 3.4.4 → 4.0.1

package/lib/services/common/genericMiddleware.js

@@ -24,8 +24,9 @@
 const logger = require('logops');
 const revalidator = require('revalidator');
 const errors = require('../../errors');
+const fillService = require('./domain').fillService;
 let iotaInformation;
-const context = {
+let context = {
     op: 'IoTAgentNGSI.GenericMiddlewares'
 };
 
@@ -39,7 +40,10 @@ const context = {
 /* eslint-disable-next-line  no-unused-vars */
 function handleError(error, req, res, next) {
     let code = 500;
-
+    context = fillService(context, {
+        service: req.headers['fiware-service'],
+        subservice: req.headers['fiware-servicepath']
+    });
     logger.debug(context, 'Error [%s] handling request: %s', error.name, error.message);
 
     if (error.code && String(error.code).match(/^[2345]\d\d$/)) {
@@ -56,6 +60,10 @@ function handleError(error, req, res, next) {
  *  Express middleware for tracing the complete request arriving to the IoTA in debug mode.
  */
 function traceRequest(req, res, next) {
+    context = fillService(context, {
+        service: req.headers['fiware-service'],
+        subservice: req.headers['fiware-servicepath']
+    });
     logger.debug(context, 'Request for path [%s] query [%j] from [%s]', req.path, req.query, req.get('host'));
 
     if (req.is('json') || req.is('application/ld+json')) {
@@ -129,6 +137,10 @@ function validateJson(template) {
             if (errorList.valid) {
                 next();
             } else {
+                context = fillService(context, {
+                    service: req.headers['fiware-service'],
+                    subservice: req.headers['fiware-servicepath']
+                });
                 logger.debug(context, 'Errors found validating request: %j', errorList);
                 next(new errors.BadRequest('Errors found validating request.'));
             }

package/lib/services/common/iotManagerService.js

@@ -60,7 +60,8 @@ function register(callback) {
             explicitAttrs: service.explicitAttrs,
             defaultEntityNameConjunction: service.defaultEntityNameConjunction,
             ngsiVersion: service.ngsiVersion,
-            entityNameExp: service.entityNameExp
+            entityNameExp: service.entityNameExp,
+            payloadType: service.payloadType
         };
     }
 

package/lib/services/devices/deviceRegistryMongoDB.js

@@ -55,7 +55,8 @@ const attributeList = [
     'polling',
     'timestamp',
     'explicitAttrs',
-    'ngsiVersion'
+    'ngsiVersion',
+    'payloadType'
 ];
 
 /**
@@ -316,6 +317,7 @@ function update(device, callback) {
             data.explicitAttrs = device.explicitAttrs;
             data.ngsiVersion = device.ngsiVersion;
             data.timestamp = device.timestamp;
+            data.payloadType = device.payloadType;
 
             /* eslint-disable-next-line  new-cap */
             const deviceObj = new Device.model(data);

package/lib/services/devices/deviceService.js

@@ -173,13 +173,18 @@ function mergeDeviceWithConfiguration(fields, defaults, deviceData, configuratio
     if (configuration && configuration.entityNameExp !== undefined) {
         deviceData.entityNameExp = configuration.entityNameExp;
     }
+    if (configuration && configuration.timestamp !== undefined && deviceData.timestamp === undefined) {
+        deviceData.timestamp = configuration.timestamp;
+    }
+    if (configuration && configuration.payloadType !== undefined && deviceData.payloadType === undefined) {
+        deviceData.payloadType = configuration.payloadType;
+    }
     logger.debug(context, 'deviceData after merge with conf: %j', deviceData);
     callback(null, deviceData);
 }
 
 /**
- * Find the configuration group belonging to a given device, with a different criteria depending on whether the
- * agent is in single configuration mode or node.
+ * Find the configuration group belonging to a given device
  *
  * @param {Object} deviceObj        Device data.
  */
@@ -206,19 +211,15 @@ function findConfigurationGroup(deviceObj, callback) {
         callback(null, effectiveGroup);
     }
 
-    if (config.getConfig().singleConfigurationMode === true) {
-        config.getGroupRegistry().find(deviceObj.service, deviceObj.subservice, handlerGroupFind);
-    } else {
-        config
-            .getGroupRegistry()
-            .findTypeSilently(
-                deviceObj.service,
-                deviceObj.subservice,
-                deviceObj.type,
-                deviceObj.apikey,
-                handlerGroupFindByType
-            );
-    }
+    config
+        .getGroupRegistry()
+        .findTypeSilently(
+            deviceObj.service,
+            deviceObj.subservice,
+            deviceObj.type,
+            deviceObj.apikey,
+            handlerGroupFindByType
+        );
 }
 
 /**
@@ -353,12 +354,6 @@ function registerDevice(deviceObj, callback) {
                     deviceObj.staticAttributes = deviceObj.staticAttributes ? deviceObj.staticAttributes : [];
                     deviceObj.commands = deviceObj.commands ? deviceObj.commands : [];
                     deviceObj.lazy = deviceObj.lazy ? deviceObj.lazy : [];
-                    if ('timestamp' in deviceData && deviceData.timestamp !== undefined) {
-                        deviceObj.timestamp = deviceData.timestamp;
-                    }
-                    if ('explicitAttrs' in deviceData && deviceData.explicitAttrs !== undefined) {
-                        deviceObj.explicitAttrs = deviceData.explicitAttrs;
-                    }
                     if ('apikey' in deviceData && deviceData.apikey !== undefined) {
                         deviceObj.apikey = deviceData.apikey;
                     }

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

@@ -56,53 +56,6 @@ function jsonConcat(json1, json2) {
     }
 }
 
-/**
- * Creates the response handler for the initial entity creation request using NGSI-LD.
- * This handler basically deals with the errors that could have been rised during
- * the communication with the Context Broker.
- *
- * @param {Object} deviceData       Object containing all the deviceData needed to send the registration.
- * @param {Object} newDevice        Device object that will be stored in the database.
- * @return {function}               Handler to pass to the request() function.
- */
-function createInitialEntityHandlerNgsiLD(deviceData, newDevice, callback) {
-    return function handleInitialEntityResponse(error, response, body) {
-        if (error) {
-            logger.error(
-                context,
-                'ORION-001: Connection error creating inital entity in the Context Broker: %s',
-                error
-            );
-
-            alarms.raise(constants.ORION_ALARM, error);
-
-            callback(error);
-        }
-        // Handling different response codes for batch entity upsert in NGSI-LD specification:
-        // - In v1.2.1, response code is 200
-        // - In v1.3.1, response code is 201 if some created entities, 204 if just updated existing
-        else if (
-            response &&
-            (response.statusCode === 200 || response.statusCode === 201 || response.statusCode === 204)
-        ) {
-            alarms.release(constants.ORION_ALARM);
-            logger.debug(context, 'Initial entity created successfully.');
-            callback(null, newDevice);
-        } else {
-            logger.error(
-                context,
-                'Protocol error connecting to the Context Broker [%d]: %s',
-                response.statusCode,
-                body
-            );
-
-            const errorObj = new errors.EntityGenericError(deviceData.id, deviceData.type, body);
-
-            callback(errorObj);
-        }
-    };
-}
-
 /**
  * Creates the response handler for the update entity request using NGSI-LD.
  * This handler basically deals with the errors
@@ -154,54 +107,8 @@ function updateEntityHandlerNgsiLD(deviceData, updatedDevice, callback) {
  * @param {Object} deviceData       Object containing all the deviceData needed to send the registration.
  * @param {Object} newDevice        Device object that will be stored in the database.
  */
-function createInitialEntityNgsiLD(deviceData, newDevice, callback) {
-    let json = {
-        id: String(deviceData.name),
-        type: deviceData.type
-    };
-
-    jsonConcat(json, NGSIv2.formatAttributes(deviceData.active, false));
-    jsonConcat(json, NGSIv2.formatAttributes(deviceData.staticAttributes, true));
-    jsonConcat(json, NGSIv2.formatCommands(deviceData.commands));
-
-    if (
-        ('timestamp' in deviceData && deviceData.timestamp !== undefined
-            ? deviceData.timestamp
-            : config.getConfig().timestamp) &&
-        !utils.isTimestampedNgsi2(json)
-    ) {
-        logger.debug(context, 'config.timestamp %s %s', deviceData.timestamp, config.getConfig().timestamp);
-
-        json[constants.TIMESTAMP_ATTRIBUTE] = {
-            type: constants.TIMESTAMP_TYPE_NGSI2,
-            value: moment()
-        };
-    }
-
-    json = ngsiLD.formatAsNGSILD(json);
-
-    const options = {
-        url: config.getConfig().contextBroker.url + '/ngsi-ld/v1/entityOperations/upsert/',
-        method: 'POST',
-        json: [json],
-        headers: {
-            'fiware-service': deviceData.service,
-            'fiware-servicepath': deviceData.subservice,
-            'NGSILD-Tenant': deviceData.service,
-            'NGSILD-Path': deviceData.subservice,
-            'Content-Type': 'application/ld+json'
-        }
-    };
-
-    if (deviceData.cbHost && deviceData.cbHost.indexOf('://') !== -1) {
-        options.url = deviceData.cbHost + '/ngsi-ld/v1/entityOperations/upsert/';
-    } else if (deviceData.cbHost && deviceData.cbHost.indexOf('://') === -1) {
-        options.url = 'http://' + deviceData.cbHost + '/ngsi-ld/v1/entityOperations/upsert/';
-    }
-
-    logger.debug(context, 'deviceData: %j', deviceData);
-    logger.debug(context, 'Creating initial entity in the Context Broker:\n %s', JSON.stringify(options, null, 4));
-    utils.executeWithSecurity(options, newDevice, createInitialEntityHandlerNgsiLD(deviceData, newDevice, callback));
+function createInitialEntityNgsiLDFake(deviceData, newDevice, callback) {
+    callback(null, newDevice);
 }
 
 /**
@@ -281,9 +188,10 @@ function updateRegisterDeviceNgsiLD(deviceObj, entityInfoUpdated, callback) {
         return;
     }
 
-    logger.debug(context, 'Update provisioned LD device in Device Service');
+    logger.debug(context, 'Update provisioned LD device in Device Service %j %j', deviceObj, entityInfoUpdated);
 
     function combineWithNewDevice(newDevice, oldDevice, callback) {
+        logger.debug(context, 'combineWithNewDevice %j %j', newDevice, oldDevice);
         if (oldDevice) {
             oldDevice.internalId = newDevice.internalId;
             oldDevice.lazy = newDevice.lazy;
@@ -377,7 +285,7 @@ function updateRegisterDeviceNgsiLD(deviceObj, entityInfoUpdated, callback) {
                     deviceObj.subservice
                 ),
                 apply(extractDeviceDifference, deviceObj),
-                createInitialEntityNgsiLD,
+                createInitialEntityNgsiLDFake,
                 apply(combineWithNewDevice, deviceObj),
                 apply(registrationUtils.sendRegistrations, false),
                 apply(registrationUtils.processContextRegistration, deviceObj),
@@ -407,5 +315,4 @@ function updateRegisterDeviceNgsiLD(deviceObj, entityInfoUpdated, callback) {
     }
 }
 
-exports.createInitialEntity = createInitialEntityNgsiLD;
 exports.updateRegisterDevice = updateRegisterDeviceNgsiLD;

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

@@ -27,19 +27,6 @@ const config = require('../../commonConfig');
 const deviceHandlerLD = require('./devices-NGSI-LD');
 const deviceHandlerV2 = require('./devices-NGSI-v2');
 
-/**
- * Creates the initial entity representing the device in the Context Broker using both NGSI-LD and NGSI-v2
- * This is important mainly to allow the rest of the updateContext operations to be performed.
- *
- * @param {Object} deviceData       Object containing all the deviceData needed to send the registration.
- * @param {Object} newDevice        Device object that will be stored in the database.
- */
-function createInitialEntityNgsiMixed(deviceData, newDevice, callback) {
-    if (config.checkNgsiLD(deviceData)) {
-        deviceHandlerLD.createInitialEntity(deviceData, newDevice, callback);
-    }
-}
-
 /**
  * Updates the register of an existing device identified by the Id and Type in the Context Broker, and the internal
  * registry. It uses both NGSI-LD and NGSI-v2
@@ -59,5 +46,4 @@ function updateRegisterDeviceNgsiMixed(deviceObj, entityInfoUpdated, callback) {
     }
 }
 
-exports.createInitialEntity = createInitialEntityNgsiMixed;
 exports.updateRegisterDevice = updateRegisterDeviceNgsiMixed;

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

@@ -270,6 +270,9 @@ function updateRegisterDeviceNgsi2(deviceObj, entityInfoUpdated, callback) {
             if ('apikey' in newDevice && newDevice.apikey !== undefined) {
                 oldDevice.apikey = newDevice.apikey;
             }
+            if ('payloadType' in newDevice && newDevice.payloadType !== undefined) {
+                oldDevice.payloadType = newDevice.payloadType;
+            }
             oldDevice.endpoint = newDevice.endpoint || oldDevice.endpoint;
 
             callback(null, oldDevice);

package/lib/services/groups/groupRegistryMemory.js

@@ -27,7 +27,6 @@ let registeredGroups = {};
 const logger = require('logops');
 const intoTrans = require('../common/domain').intoTrans;
 const errors = require('../../errors');
-const config = require('../../commonConfig');
 const _ = require('underscore');
 const context = {
     op: 'IoTAgentNGSI.InMemoryGroupRegister'
@@ -131,31 +130,7 @@ function clear(callback) {
     callback();
 }
 
-function findSingleConfigurationMode(service, subservice, callback) {
-    let result;
-
-    for (const i in registeredGroups) {
-        if (
-            registeredGroups.hasOwnProperty(i) &&
-            registeredGroups[i].service === service &&
-            registeredGroups[i].subservice === subservice
-        ) {
-            result = registeredGroups[i];
-            break;
-        }
-    }
-
-    if (result) {
-        callback(null, result);
-    } else {
-        callback(new errors.DeviceGroupNotFound(service, subservice));
-    }
-}
-
 function find(service, subservice, callback) {
-    if (config.getConfig().singleConfigurationMode === true) {
-        return findSingleConfigurationMode(service, subservice, callback);
-    }
     const result = [];
 
     for (const i in registeredGroups) {

package/lib/services/groups/groupRegistryMongoDB.js

@@ -58,7 +58,8 @@ const attributeList = [
     'expressionLanguage',
     'defaultEntityNameConjunction',
     'ngsiVersion',
-    'entityNameExp'
+    'entityNameExp',
+    'payloadType'
 ];
 
 /**
@@ -147,15 +148,15 @@ function listGroups(service, limit, offset, callback) {
         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)
-        });
-    });
+    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 getById(id, callback) {
@@ -201,15 +202,15 @@ function find(service, subservice, callback) {
 
     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)
-        });
-    });
+    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 findOneInMongoDB(queryObj, fields, callback) {

package/lib/services/groups/groupService.js

@@ -59,10 +59,6 @@ function validateGroup(group, callback) {
         config.getGroupRegistry().getSilently(group.resource, group.apikey, generateDuplicateHandler(innerCb));
     }
 
-    function checkServiceAndSubservice(innerCb) {
-        config.getGroupRegistry().find(group.service, group.subservice, generateDuplicateHandler(innerCb));
-    }
-
     function checkMandatoryParams(innerCb) {
         if (!group.service) {
             innerCb(new errors.MissingConfigParams(['service']));
@@ -74,22 +70,15 @@ function validateGroup(group, callback) {
             return;
         }
 
-        if (config.getConfig().singleConfigurationMode === false) {
-            if (!group.type) {
-                innerCb(new errors.MissingConfigParams(['type']));
-                return;
-            }
+        if (!group.type) {
+            innerCb(new errors.MissingConfigParams(['type']));
+            return;
         }
 
         innerCb();
     }
 
     validations.push(checkApiKeyAndResource);
-
-    if (config.getConfig().singleConfigurationMode === true) {
-        validations.push(checkServiceAndSubservice);
-    }
-
     validations.push(checkMandatoryParams);
 
     async.series(validations, callback);

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

@@ -41,11 +41,87 @@ const _ = require('underscore');
 const context = {
     op: 'IoTAgentNGSI-LD'
 };
-const NGSIv2 = require('./entities-NGSI-v2');
 const NGSIUtils = require('./ngsiUtils');
 
 const NGSI_LD_URN = 'urn:ngsi-ld:';
 
+/**
+ * Adds timestamp to ngsi payload entities accoding to timezone, and an optional timestampvalue.
+ *
+ * @param      {Object}   payload         NGSIv2 payload with one or more entities
+ * @param      String     timezone        TimeZone value (optional)
+ * @param      String     timestampValue  Timestamp value (optional). If not provided current timestamp is used
+ * @param     Boolean     skipMetadataAtt  An optional flag to indicate if timestamp should be added to each metadata attribute. Default is false
+ * @return     {Object}                   NGSIv2 payload entities with timestamp
+ */
+function addTimestamp(payload, timezone, timestampValue) {
+    function addTimestampEntity(entity, timezone, timestampValue) {
+        const timestamp = {
+            type: constants.TIMESTAMP_TYPE_NGSI2
+        };
+
+        if (timestampValue) {
+            timestamp.value = timestampValue;
+        } else if (!timezone) {
+            timestamp.value = new Date().toISOString();
+        } else {
+            timestamp.value = moment().tz(timezone).format('YYYY-MM-DD[T]HH:mm:ss.SSSZ');
+        }
+
+        function addMetadata(attribute) {
+            let timestampFound = false;
+
+            if (!attribute.metadata) {
+                attribute.metadata = {};
+            }
+
+            for (let i = 0; i < attribute.metadata.length; i++) {
+                if (attribute.metadata[i] === constants.TIMESTAMP_ATTRIBUTE) {
+                    if (
+                        attribute.metadata[constants.TIMESTAMP_ATTRIBUTE].type === constants.TIMESTAMP_TYPE_NGSI2 &&
+                        attribute.metadata[constants.TIMESTAMP_ATTRIBUTE].value === timestamp.value
+                    ) {
+                        timestampFound = true;
+                        break;
+                    }
+                }
+            }
+
+            if (!timestampFound) {
+                attribute.metadata[constants.TIMESTAMP_ATTRIBUTE] = timestamp;
+            }
+
+            return attribute;
+        }
+        let keyCount = 0;
+        for (const key in entity) {
+            /* eslint-disable-next-line  no-prototype-builtins */
+            if (entity.hasOwnProperty(key) && key !== 'id' && key !== 'type') {
+                addMetadata(entity[key]);
+                keyCount += 1;
+            }
+        }
+        // Add timestamp just to entity with attrs: multientity plugin could
+        // create empty entities just with id and type.
+        if (keyCount > 0) {
+            entity[constants.TIMESTAMP_ATTRIBUTE] = timestamp;
+        }
+
+        return entity;
+    }
+
+    if (payload instanceof Array) {
+        for (let i = 0; i < payload.length; i++) {
+            if (!utils.isTimestampedNgsi2(payload[i])) {
+                payload[i] = addTimestampEntity(payload[i], timezone, timestampValue);
+            }
+        }
+
+        return payload;
+    }
+    return addTimestampEntity(payload, timezone, timestampValue);
+}
+
 /**
  * Amends an NGSIv2 attribute to NGSI-LD format
  * All native JSON types are respected and cast as Property values
@@ -843,7 +919,7 @@ function sendUpdateValueNgsiLD(entityName, attributes, typeInformation, token, c
                             ? config.getConfig().timestamp
                             : timestampValue !== undefined
                     ) {
-                        newEntity = NGSIv2.addTimestamp(newEntity, typeInformation.timezone, timestampValue);
+                        newEntity = addTimestamp(newEntity, typeInformation.timezone, timestampValue);
                         logger.debug(context, 'sendUpdateValueNgsiLD \n timestamped newEntity=%j', newEntity);
                     }
                     payload.push(newEntity);
@@ -927,19 +1003,19 @@ function sendUpdateValueNgsiLD(entityName, attributes, typeInformation, token, c
             // timeInstant is provided as measure
             if (Object.keys(payload[0]).length > 1) {
                 // include metadata with TimeInstant in attrs when TimeInstant is provided as measure in all entities
-                payload[0] = NGSIv2.addTimestamp(payload[0], typeInformation.timezone, timestampValue);
+                payload[0] = addTimestamp(payload[0], typeInformation.timezone, timestampValue);
             }
         } else {
             // jshint maxdepth:5
             for (let n = 0; n < payload.length; n++) {
                 if (!utils.isTimestampedNgsi2(payload[n])) {
                     // legacy check needed?
-                    payload[n] = NGSIv2.addTimestamp(payload[n], typeInformation.timezone);
+                    payload[n] = addTimestamp(payload[n], typeInformation.timezone);
                     // jshint maxdepth:5
                 } else if (!utils.IsValidTimestampedNgsi2(payload[n])) {
                     // legacy check needed?
                     logger.error(context, 'Invalid timestamp:%s', JSON.stringify(payload[0]));
-                    callback(new errors.BadTimestamp(payload));
+                    callback(new errors.BadTimestamp(payload, entityName));
                     return;
                 }
             }
@@ -955,9 +1031,8 @@ function sendUpdateValueNgsiLD(entityName, attributes, typeInformation, token, c
                 delete payload[m][key].object_id;
             }
         }
-        payload[m] = NGSIUtils.castJsonNativeAttributes(payload[m]); // native types
     }
-    logger.debug(context, 'sendUpdateValueNgsiLD \n payload with native types and without object_id %j', payload);
+    logger.debug(context, 'sendUpdateValueNgsiLD \n payload and without object_id %j', payload);
 
     options.json = payload;
     try {