iotagent-node-lib 4.8.0 → 4.10.0

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

@@ -59,10 +59,13 @@ function convertAttrNGSILD(attr) {
         return undefined;
     }
     let obj = { type: 'Property', value: attr.value };
+    let hasValueType = true;
 
     switch (attr.type.toLowerCase()) {
         // Properties
         case 'property':
+            hasValueType = false;
+            break;
         case 'string':
         case 'text':
         case 'textunrestricted':
@@ -96,24 +99,26 @@ function convertAttrNGSILD(attr) {
             }
             break;
 
+        case 'object':
+        case 'array':
+            try {
+                obj.value = JSON.parse(attr.value);
+            } catch (e) {
+                // Do nothing
+            }
+            break;
+
         // Temporal Properties
         case 'datetime':
-            obj.value = {
-                '@type': 'DateTime',
-                '@value': moment.tz(attr.value, 'Etc/UTC').toISOString()
-            };
+            obj.value = moment.tz(attr.value, 'Etc/UTC').toISOString();
             break;
         case 'date':
-            obj.value = {
-                '@type': 'Date',
-                '@value': moment.tz(attr.value, 'Etc/UTC').format(moment.HTML5_FMT.DATE)
-            };
+            obj.value = moment.tz(attr.value, 'Etc/UTC').format(moment.HTML5_FMT.DATE);
             break;
         case 'time':
-            obj.value = {
-                '@type': 'Time',
-                '@value': moment.tz(attr.value, 'Etc/UTC').format(moment.HTML5_FMT.TIME_SECONDS)
-            };
+            obj.value = moment
+                .tz(new Date('0000-01-01 ' + attr.value), 'Etc/UTC')
+                .format(moment.HTML5_FMT.TIME_SECONDS);
             break;
 
         // GeoProperties
@@ -121,37 +126,44 @@ function convertAttrNGSILD(attr) {
         case 'point':
         case 'geo:point':
         case 'geo:json':
+            hasValueType = false;
             obj.type = 'GeoProperty';
             obj.value = NGSIUtils.getLngLats('Point', attr.value);
             break;
         case 'linestring':
         case 'geo:linestring':
+            hasValueType = false;
             obj.type = 'GeoProperty';
             obj.value = NGSIUtils.getLngLats('LineString', attr.value);
             break;
         case 'polygon':
         case 'geo:polygon':
+            hasValueType = false;
             obj.type = 'GeoProperty';
             obj.value = NGSIUtils.getLngLats('Polygon', attr.value);
             break;
         case 'multipoint':
         case 'geo:multipoint':
+            hasValueType = false;
             obj.type = 'GeoProperty';
             obj.value = NGSIUtils.getLngLats('MultiPoint', attr.value);
             break;
         case 'multilinestring':
         case 'geo:multilinestring':
+            hasValueType = false;
             obj.type = 'GeoProperty';
             obj.value = NGSIUtils.getLngLats('MultiLineString', attr.value);
             break;
         case 'multipolygon':
         case 'geo:multipolygon':
+            hasValueType = false;
             obj.type = 'GeoProperty';
             obj.value = NGSIUtils.getLngLats('MultiPolygon', attr.value);
             break;
 
         // Relationships
         case 'relationship':
+            hasValueType = false;
             obj.type = 'Relationship';
             obj.object = attr.value;
             delete obj.value;
@@ -159,13 +171,57 @@ function convertAttrNGSILD(attr) {
 
         // LanguageProperties
         case 'languageproperty':
+            hasValueType = false;
             obj.type = 'LanguageProperty';
             obj.languageMap = attr.value;
             delete obj.value;
             break;
 
+        // VocabProperties
+        case 'vocabproperty':
+            hasValueType = false;
+            obj.type = 'VocabProperty';
+            obj.vocab = attr.value;
+            delete obj.value;
+            break;
+        // JsonProperties
+        case 'jsonproperty':
+            hasValueType = false;
+            obj.type = 'JsonProperty';
+            obj.json = attr.value;
+            delete obj.value;
+            break;
+        // ListProperties
+        case 'listproperty':
+            hasValueType = false;
+            obj.type = 'ListProperty';
+            obj.listValue = attr.value;
+            delete obj.value;
+            break;
+        // ListRelationship
+        case 'listrelationship':
+            hasValueType = false;
+            obj.type = 'ListRelationship';
+            obj.listObject = attr.value;
+            delete obj.value;
+            break;
+
         default:
-            obj.value = { '@type': attr.type, '@value': attr.value };
+            obj.value = attr.value;
+    }
+
+    if (hasValueType) {
+        switch (config.getConfig().server.ldSupport.dataType) {
+            case '@type':
+                obj.value = {
+                    '@type': attr.type,
+                    '@value': obj.value
+                };
+                break;
+            case 'valueType':
+                obj.valueType = attr.type;
+                break;
+        }
     }
 
     if (!!obj && attr.metadata) {

package/lib/services/ngsi/ngsiService.js

@@ -95,7 +95,9 @@ function sendUpdateValue(entityName, attributes, typeInformation, token, callbac
     // check config about store last measure
     if (typeInformation.storeLastMeasure) {
         logger.debug(context, 'StoreLastMeasure for %j', typeInformation);
-        deviceService.storeDeviceField('lastMeasure', attributes, typeInformation, function () {
+        let originalMeasure = typeInformation.originalMeasure ? typeInformation.originalMeasure : null;
+        deviceService.storeDeviceField('lastMeasure', originalMeasure, typeInformation, function () {
+            delete typeInformation.originalMeasure;
             return entityHandler.sendUpdateValue(entityName, attributes, typeInformation, token, wrappedNewCallback);
         });
     } else {

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

@@ -105,7 +105,7 @@ function createSubscriptionHandlerNgsiLD(device, triggers, store, callback) {
  * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription
  * @param {Object} content      Array with the names of the attributes to retrieve in the notification.
  */
-function subscribeNgsiLD(device, triggers, content, callback) {
+function subscribeNgsiLD(device, triggers, content, attrsFormat, callback) {
     const options = {
         method: 'POST',
         headers: {
@@ -132,7 +132,7 @@ function subscribeNgsiLD(device, triggers, content, callback) {
                     accept: 'application/json'
                 },
                 attributes: content || [],
-                format: 'normalized'
+                format: attrsFormat
             }
         }
     };

package/lib/services/ngsi/subscription-NGSI-mixed.js

@@ -36,11 +36,11 @@ const subscriptionHandlerV2 = require('./subscription-NGSI-v2');
  * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription
  * @param {Object} content      Array with the names of the attributes to retrieve in the notification.
  */
-function subscribeNgsiMixed(device, triggers, content, callback) {
+function subscribeNgsiMixed(device, triggers, content, attrsFormat, callback) {
     if (config.checkNgsiLD(device)) {
-        subscriptionHandlerLD.subscribe(device, triggers, content, callback);
+        subscriptionHandlerLD.subscribe(device, triggers, content, attrsFormat, callback);
     } else {
-        subscriptionHandlerV2.subscribe(device, triggers, content, callback);
+        subscriptionHandlerV2.subscribe(device, triggers, content, attrsFormat, callback);
     }
 }
 

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

@@ -93,7 +93,9 @@ function createSubscriptionHandlerNgsi2(device, triggers, store, callback) {
 
             config.getRegistry().update(device, device, callback);
         } else {
-            callback(null, response.headers.location);
+            callback(null, {
+                subscriptionId: response.headers.location.substr(response.headers.location.lastIndexOf('/') + 1)
+            });
         }
     };
 }
@@ -107,7 +109,7 @@ function createSubscriptionHandlerNgsi2(device, triggers, store, callback) {
  * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription
  * @param {Object} content      Array with the names of the attributes to retrieve in the notification.
  */
-function subscribeNgsi2(device, triggers, content, callback) {
+function subscribeNgsi2(device, triggers, content, attrsFormat, callback) {
     const options = {
         method: 'POST',
         headers: {
@@ -115,6 +117,7 @@ function subscribeNgsi2(device, triggers, content, callback) {
             'fiware-servicepath': device.subservice
         },
         json: {
+            description: 'Managed by IOTA: ' + device.name + ' ' + device.type + ' ' + triggers.join(','),
             subject: {
                 entities: [
                     {
@@ -132,7 +135,8 @@ function subscribeNgsi2(device, triggers, content, callback) {
                     url: config.getConfig().providerUrl + '/notify'
                 },
                 attrs: content || [],
-                attrsFormat: 'normalized'
+                attrsFormat: attrsFormat,
+                onlyChangedAttrs: true
             }
         }
     };
@@ -167,7 +171,7 @@ function createUnsubscribeHandlerNgsi2(device, id, callback) {
         if (error) {
             logger.debug(
                 context,
-                'Transport error found subscribing device with id [%s] to entity [%s]',
+                'Transport error found unsubscribing device with id [%s] to entity [%s]',
                 device.id,
                 device.name
             );
@@ -176,7 +180,9 @@ function createUnsubscribeHandlerNgsi2(device, id, callback) {
         } else if (response.statusCode !== 204) {
             logger.debug(
                 context,
-                'Unknown error subscribing device with id [%s] to entity [%s]: $s',
+                'Unknown error unsubscribing device with id [%s] to entity [%s]: %s',
+                device.id,
+                device.name,
                 response.statusCode
             );
 
@@ -202,7 +208,15 @@ function createUnsubscribeHandlerNgsi2(device, id, callback) {
 
             callback(new errors.BadRequest(body.orionError.details));
         } else {
-            device.subscriptions.splice(device.subscriptions.indexOf(id), 1);
+            logger.debug(context, 'removing subscription %s from device %j', id, device);
+            if (device.subscriptions) {
+                // check before try to eliminates
+                const index = device.subscriptions.indexOf(id);
+                if (index !== -1) {
+                    // only eliminates if exits
+                    device.subscriptions.splice(index, 1);
+                }
+            }
             config.getRegistry().update(device, device, callback);
         }
     };

package/lib/services/ngsi/subscriptionService.js

@@ -57,8 +57,8 @@ function init() {
  * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription
  * @param {Object} content      Array with the names of the attributes to retrieve in the notification.
  */
-function subscribe(device, triggers, content, callback) {
-    subscriptionHandler.subscribe(device, triggers, content, callback);
+function subscribe(device, triggers, content, attrsFormat, callback) {
+    subscriptionHandler.subscribe(device, triggers, content, attrsFormat, callback);
 }
 
 /**

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

@@ -46,7 +46,7 @@ const config = require('../../commonConfig');
 
 const overwritePaths = ['/ngsi-ld/v1/entities/:entity/attrs', '/ngsi-ld/v1/entities/:entity/attrs/:attr'];
 const updatePaths = ['/ngsi-ld/v1/entities/:entity/attrs', '/ngsi-ld/v1/entities/:entity/attrs/:attr'];
-const queryPaths = ['/ngsi-ld/v1/entities/:entity'];
+const queryPaths = ['/ngsi-ld/v1/entities/:entity', '/ngsi-ld/v1/entities'];
 
 /**
  * Replacement of NGSI-LD Null placeholders with real null values
@@ -506,6 +506,9 @@ function handleMergePatchNgsiLD(req, res, next) {
  * @param {Object} res              Response that will be sent.
  */
 function handleQueryNgsiLD(req, res, next) {
+    const returnAsArray = req.query.id;
+    req.params.entity = req.params.entity || req.query.id || '';
+
     function getName(element) {
         return element.name;
     }
@@ -641,7 +644,7 @@ function handleQueryNgsiLD(req, res, next) {
             next(error);
         } else {
             logger.debug(context, 'Query from [%s] handled successfully.', req.get('host'));
-            res.status(200).json(result);
+            res.status(200).json(returnAsArray ? [result] : result);
         }
     }
 
@@ -793,7 +796,6 @@ function loadUnsupportedEndpointsNGSILD(router) {
     const unsupportedEndpoint = function (req, res) {
         return res.status(501).send(new errors.MethodNotSupported(req.method, req.path));
     };
-    router.get('/ngsi-ld/v1/entities', unsupportedEndpoint);
     router.post('/ngsi-ld/v1/entities', unsupportedEndpoint);
     router.delete('/ngsi-ld/v1/entities/:entity', unsupportedEndpoint);
     router.delete('/ngsi-ld/v1/entities/:entity/attrs/:attr', unsupportedEndpoint);

package/lib/services/northBound/deviceProvisioningServer.js

@@ -67,7 +67,8 @@ const provisioningAPITranslation = {
     payloadType: 'payloadType',
     useCBflowControl: 'useCBflowControl',
     storeLastMeasure: 'storeLastMeasure',
-    lastMeasure: 'lastMeasure'
+    lastMeasure: 'lastMeasure',
+    cmdMode: 'cmdMode'
 };
 
 /**
@@ -149,7 +150,8 @@ function handleProvision(req, res, next) {
             payloadType: body.payloadType,
             useCBflowControl: body.useCBflowControl,
             storeLastMeasure: body.storeLastMeasure,
-            lastMeasure: body.lastMeasure
+            lastMeasure: body.lastMeasure,
+            cmdMode: body.cmdMode
         });
     }
 
@@ -229,7 +231,8 @@ function toProvisioningAPIFormat(device) {
         payloadType: device.payloadType,
         useCBflowControl: device.useCBflowControl,
         storeLastMeasure: device.storeLastMeasure,
-        lastMeasure: device.lastMeasure
+        lastMeasure: device.lastMeasure,
+        cmdMode: device.cmdMode
     };
 }
 

package/lib/services/northBound/northboundServer.js

@@ -59,7 +59,7 @@ function start(config, callback) {
     northboundServer.app.use(domainUtils.requestDomain);
     northboundServer.app.use(bodyParser.json({ limit: config.expressLimit }));
     northboundServer.app.use(bodyParser.json({ type: 'application/*+json', limit: config.expressLimit }));
-
+    northboundServer.app.set('trust proxy', true); // populate req.ip
     if (config.logLevel && config.logLevel === 'DEBUG') {
         northboundServer.app.use(middlewares.traceRequest);
     }

package/lib/services/northBound/restUtils.js

@@ -30,7 +30,6 @@ const errors = require('../../errors');
 const constants = require('../../constants');
 const intoTrans = require('../common/domain').intoTrans;
 const revalidator = require('revalidator');
-const moment = require('moment');
 const context = {
     op: 'IoTAgentNGSI.RestUtils'
 };
@@ -121,6 +120,11 @@ function checkBody(template) {
     };
 }
 
+function isISOString(val) {
+    const d = new Date(val);
+    return !Number.isNaN(d.valueOf()) && d.toISOString() === val;
+}
+
 /**
  * Checks if the timestamp properties of NGSIv2 entities are valid ISO8601 dates.
  *
@@ -131,7 +135,7 @@ function IsValidTimestampedNgsi2(payload) {
     function isValidTimestampedNgsi2Entity(entity) {
         for (const i in entity) {
             if (entity.hasOwnProperty(i)) {
-                if (i === constants.TIMESTAMP_ATTRIBUTE && !moment(entity[i].value, moment.ISO_8601).isValid()) {
+                if (i === constants.TIMESTAMP_ATTRIBUTE && !isISOString(entity[i].value)) {
                     return false;
                 }
             }

package/lib/templates/updateDevice.json

@@ -157,6 +157,10 @@
               "description": "use CB flowControl option",
               "type": "boolean"
           },
+          "cmdMode": {
+              "description": "CB commands mode",
+              "type": "string"
+          },
           "contentType": {
               "description": "Content type",
               "type": "string"
@@ -203,6 +207,10 @@
         "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"
@@ -210,6 +218,10 @@
     "lastMeasure": {
       "description": "last measure",
       "type": "object"
+    },
+    "cmdMode": {
+        "description": "CB commands mode",
+        "type": "string"
     }
   }
 }

package/lib/templates/updateDeviceLax.json

@@ -158,6 +158,10 @@
     "lastMeasure": {
       "description": "last measure",
       "type": "object"
+    },
+    "cmdMode": {
+        "description": "CB commands mode",
+        "type": "string"
     }
   }
 }

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.8.0",
+  "version": "4.10.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",
@@ -23,7 +23,7 @@
   },
   "main": "lib/fiware-iotagent-lib",
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "scripts": {
     "clean": "rm -rf package-lock.json && rm -rf node_modules && rm -rf coverage",

package/test/functional/config-test.js

@@ -45,7 +45,7 @@ config.amqp = {
 };
 
 config.iota = {
-    logLevel: 'DEBUG',
+    logLevel: 'FATAL',
     contextBroker: {
         host: '192.168.1.1',
         port: '1026',

package/test/unit/general/contextBrokerKeystoneSecurityAccess-test.js

@@ -295,7 +295,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with Keystone', functio
 
         it('subscribe requests use auth header', function (done) {
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();
@@ -316,7 +316,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with Keystone', functio
                 });
 
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         contextBrokerMock.done();
                         done();

package/test/unit/memoryRegistry/deviceRegistryMemory_test.js

@@ -243,7 +243,7 @@ describe('NGSI-v2 - In memory device registry', function () {
                 should.exist(device.type);
                 device.name.should.equal('name5');
                 device.type.should.equal('Light5');
-                Object.keys(device).length.should.equal(12);
+                Object.keys(device).length.should.equal(13);
                 done();
             });
         });

package/test/unit/ngsi-ld/examples/contextRequests/createDatetimeProvisionedDevice.json

@@ -4,10 +4,7 @@
         "id": "urn:ngsi-ld:MicroLights:FirstMicroLight",
         "timestamp": {
             "type": "Property",
-            "value": {
-                "@type": "DateTime",
-                "@value": "1970-01-01T00:00:00.000Z"
-            }
+            "value": "1970-01-01T00:00:00.000Z"
         },
         "type": "MicroLights"
     }

package/test/unit/ngsi-ld/examples/contextRequests/createProvisionedDevice.json

@@ -3,24 +3,15 @@
         "@context": "http://context.json-ld",
         "commandAttr_info": {
             "type": "Property",
-            "value": {
-                "@type": "commandResult",
-                "@value": " "
-            }
+            "value": " "
         },
         "commandAttr_status": {
             "type": "Property",
-            "value": {
-                "@type": "commandStatus",
-                "@value": "UNKNOWN"
-            }
+            "value":  "UNKNOWN"
         },
         "hardcodedAttr": {
             "type": "Property",
-            "value": {
-                "@type": "hardcodedType",
-                "@value": "hardcodedValue"
-            }
+            "value": "hardcodedValue"
         },
         "id": "urn:ngsi-ld:TheLightType:TheFirstLight",
         "type": "TheLightType"

package/test/unit/ngsi-ld/examples/contextRequests/createProvisionedDeviceMultientity.json

@@ -3,24 +3,15 @@
         "@context": "http://context.json-ld",
         "commandAttr_info": {
             "type": "Property",
-            "value": {
-                "@type": "commandResult",
-                "@value": " "
-            }
+            "value":  " "
         },
         "commandAttr_status": {
             "type": "Property",
-            "value": {
-                "@type": "commandStatus",
-                "@value": "UNKNOWN"
-            }
+            "value": "UNKNOWN"
         },
         "hardcodedAttr": {
             "type": "Property",
-            "value": {
-                "@type": "hardcodedType",
-                "@value": "hardcodedValue"
-            }
+            "value":  "hardcodedType"
         },
         "id": "urn:ngsi-ld:TheLightType:TheFirstLight",
         "type": "TheLightType"

package/test/unit/ngsi-ld/examples/contextRequests/createProvisionedDeviceWithGroupAndStatic.json

@@ -5,45 +5,27 @@
     "type": "TheLightType",
     "hardcodedAttr": {
       "type": "Property",
-      "value": {
-        "@type": "hardcodedType",
-        "@value": "hardcodedValue"
-      }
+      "value": "hardcodedType"
     },
     "bootstrapServer": {
       "type": "Property",
-      "value": {
-        "@type": "Address",
-        "@value": "127.0.0.1"
-      }
+      "value": "127.0.0.1"
     },
     "commandAttr_status": {
       "type": "Property",
-      "value": {
-        "@type": "commandStatus",
-        "@value": "UNKNOWN"
-      }
+      "value":  "UNKNOWN"
     },
     "commandAttr_info": {
       "type": "Property",
-      "value": {
-        "@type": "commandResult",
-        "@value": " "
-      }
+      "value":  "commandResult",
     },
     "wheel1_status": {
       "type": "Property",
-      "value": {
-        "@type": "commandStatus",
-        "@value": "UNKNOWN"
-      }
+      "value":  "commandStatus"
     },
     "wheel1_info": {
       "type": "Property",
-      "value": {
-        "@type": "commandResult",
-        "@value": " "
-      }
+      "value": "commandResult"
     }
   }
 ]

package/test/unit/ngsi-ld/examples/contextRequests/createProvisionedDeviceWithGroupAndStatic2.json

@@ -9,10 +9,7 @@
     },
     "bootstrapServer": {
       "type": "Property",
-      "value": {
-        "@type": "Address",
-        "@value": "127.0.0.1"
-      }
+      "value": "127.0.0.1"
     }
   }
 ]

package/test/unit/ngsi-ld/examples/contextRequests/updateContext1.json

@@ -3,10 +3,7 @@
         "@context": "http://context.json-ld",
         "dimming": {
             "type": "Property",
-            "value": {
-                "@type": "Percentage",
-                "@value": "87"
-            }
+            "value":  "87"
         },
         "id": "urn:ngsi-ld:Light:light1",
         "state": {

package/test/unit/ngsi-ld/examples/contextRequests/updateContext3WithStatic.json

@@ -3,10 +3,7 @@
         "@context": "http://context.json-ld",
         "bootstrapServer": {
             "type": "Property",
-            "value": {
-                "@type": "Address",
-                "@value": "127.0.0.1"
-            }
+            "value": "127.0.0.1"
         },
         "id": "urn:ngsi-ld:SensorMachine:machine1",
         "status": {