iotagent-node-lib 4.7.0 → 4.9.0

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/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);
     }
@@ -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/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/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,6 +145,10 @@
               "description": "Optional expression for command transformation",
               "type": "string"
           },
+          "headers": {
+              "description": "Optional headers to include with command",
+              "type": "object"
+          },
           "payloadType": {
               "description": "Payload type",
               "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.7.0",
+  "version": "4.9.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",

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/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);
@@ -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/expressions/jexlExpression-test.js

@@ -40,7 +40,12 @@ describe('Jexl expression interpreter', function () {
         object: {
             name: 'John',
             surname: 'Doe'
-        }
+        },
+        invalidJson: '{"name": "John", surname": "Doe"}', // Invalid JSON for jsonparse
+        invalidDate: 'invalid-date', // Invalid date for toisodate and other date functions
+        emptyArray: [], // Empty array for addreduce
+        invalidHex: 'zz', // Invalid hex string for hextostring
+        nonNumeric: 'not-a-number' // Non-numeric input for parseint, parsefloat
     };
 
     describe('When a expression with a single value is parsed', function () {
@@ -392,4 +397,163 @@ describe('Jexl expression interpreter', function () {
             });
         });
     });
+
+    // Check errors
+    describe('When invalid inputs are used', function () {
+        describe('When an invalid JSON string is parsed', function () {
+            it('should return null for jsonparse', function (done) {
+                expressionParser.parse('invalidJson|jsonparse', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+        });
+
+        describe('When an invalid date string is parsed', function () {
+            it('should return null for toisodate', function (done) {
+                expressionParser.parse('invalidDate|toisodate', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+
+            it('should return null for timeoffset', function (done) {
+                expressionParser.parse('invalidDate|timeoffset', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+        });
+
+        describe('When an empty array is processed with addreduce', function () {
+            it('should return null for addreduce', function (done) {
+                expressionParser.parse('emptyArray|addreduce', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+        });
+
+        describe('When a non-numeric string is parsed by parseint and parsefloat', function () {
+            it('should return null for parseint', function (done) {
+                expressionParser.parse('nonNumeric|parseint', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+
+            it('should return null for parsefloat', function (done) {
+                expressionParser.parse('nonNumeric|parsefloat', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+        });
+
+        describe('When an invalid hex string is processed by hextostring', function () {
+            it('should return null for hextostring', function (done) {
+                expressionParser.parse('invalidHex|hextostring', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+        });
+
+        describe('When invalid regular expressions are used in replace functions', function () {
+            it('should return null for replaceregexp with invalid regex', function (done) {
+                expressionParser.parse(
+                    'theString|replaceregexp("[a-z", "replacement")',
+                    scope,
+                    function (error, result) {
+                        should.not.exist(error);
+                        should(result).be.Null();
+                        done();
+                    }
+                );
+            });
+
+            it('should return null for replaceallregexp with invalid regex', function (done) {
+                expressionParser.parse(
+                    'theString|replaceallregexp("[a-z", "replacement")',
+                    scope,
+                    function (error, result) {
+                        should.not.exist(error);
+                        should(result).be.Null();
+                        done();
+                    }
+                );
+            });
+        });
+
+        describe('When tostring is used with null or undefined', function () {
+            it('should return null for tostring(null)', function (done) {
+                expressionParser.parse('null|tostring', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+
+            it('should return null for tostring(undefined)', function (done) {
+                expressionParser.parse('undefined|tostring', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+        });
+
+        describe('When urldecode is used with an invalid URI', function () {
+            it('should return null for urldecode with malformed URI', function (done) {
+                expressionParser.parse('"%%%invalidURI"|urldecode', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+        });
+
+        describe('When tofixed is used with invalid inputs', function () {
+            it('should return null for tofixed with non-numeric value', function (done) {
+                expressionParser.parse('"notANumber"|tofixed(2)', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+
+            it('should return null for tofixed with invalid decimal value', function (done) {
+                expressionParser.parse('"123.456"|tofixed("invalid")', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+        });
+
+        describe('When gettime is used with invalid date', function () {
+            it('should return null for gettime with invalid date string', function (done) {
+                expressionParser.parse('"invalidDate"|gettime', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    done();
+                });
+            });
+
+            it('should return null for gettime with null', function (done) {
+                expressionParser.parse('null|gettime', scope, function (error, result) {
+                    should.not.exist(error);
+                    should(result).be.Null();
+                    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": {

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

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

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

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

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

@@ -5,10 +5,7 @@
         "type": "Light",
         "keep_alive": {
                 "type": "Property",
-                "value": {
-                    "@type": "None",
-                    "@value": "null"
-                }
+                "value": "null"
             }        
     }
 ]

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

@@ -4,10 +4,7 @@
         "id": "urn:ngsi-ld:Light:light1",
         "tags": {
             "type": "Property",
-            "value": {
-                "@type": "Array",
-                "@value": "[\"iot\",\"device\"]"
-            }
+            "value":["iot","device"]
         },
         "type": "Light"
     }

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

@@ -4,8 +4,10 @@
         "configuration": {
             "type": "Property",
             "value": {
-                "@type": "Object",
-                "@value": "{\"firmware\": {\"version\": \"1.1.0\",\"hash\": \"cf23df2207d99a74fbe169e3eba035e633b65d94\"}}"
+                "firmware": {
+                    "version": "1.1.0",
+                    "hash": "cf23df2207d99a74fbe169e3eba035e633b65d94"
+                }
             }
         },
         "id": "urn:ngsi-ld:Light:light1",

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

@@ -3,10 +3,7 @@
         "@context": "http://context.json-ld",
         "configuration": {
             "type": "Property",
-            "value": {
-                "@type": "Object",
-                "@value": "string_value"
-            }
+            "value": "string_value"
         },
         "id": "urn:ngsi-ld:Light:light1",
         "type": "Light"

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

@@ -3,19 +3,13 @@
     "@context": "http://context.json-ld",
     "position_status": {
       "type": "Property",
-      "value": {
-        "@type": "commandStatus",
-        "@value": "ERROR"
-      }
+      "value": "ERROR"
     },
     "position_info": {
       "type": "Property",
-      "value": {
-        "@type": "commandResult",
-        "@value": "Stalled"
-      }
+      "value": "Stalled"
     },
     "id": "urn:ngsi-ld:Robot:r2d2",
     "type": "Robot"
   }
-]
+]

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

@@ -1,21 +1,15 @@
 [
-	{
-		"@context":"http://context.json-ld",
-		"position_status": {
-			"type":"Property",
-			"value": {
-				"@type":"commandStatus",
-				"@value":"ERROR"
-			}
-		},
-		"position_info": {
-			"type":"Property",
-			"value": {
-				"@type":"commandResult",
-				"@value":"EXPIRED"
-			}
-		},
-		"id":"urn:ngsi-ld:Robot:r2d2",
-		"type":"Robot"
-	}
+  {
+    "@context":"http://context.json-ld",
+    "position_status": {
+      "type":"Property",
+      "value": "ERROR"
+    },
+    "position_info": {
+      "type":"Property",
+      "value": "EXPIRED"
+    },
+    "id":"urn:ngsi-ld:Robot:r2d2",
+    "type":"Robot"
+  }
 ]

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

@@ -1,21 +1,15 @@
 [
-	{
-		"@context":"http://context.json-ld",
-		"position_status": {
-			"type":"Property",
-			"value": {
-				"@type":"commandStatus",
-				"@value":"FINISHED"
-			}
-		},
-		"position_info": {
-			"type":"Property",
-			"value": {
-				"@type":"commandResult",
-				"@value":"[72, 368, 1]"
-			}
-		},
-		"id":"urn:ngsi-ld:Robot:r2d2",
-		"type":"Robot"
-	}
+  {
+    "@context":"http://context.json-ld",
+    "position_status": {
+      "type": "Property",
+      "value": "FINISHED"
+    },
+    "position_info": {
+      "type":"Property",
+      "value": [72, 368, 1]
+    },
+    "id":"urn:ngsi-ld:Robot:r2d2",
+    "type":"Robot"
+  }
 ]