iotagent-node-lib 2.25.0 → 3.0.0

package/lib/services/ngsi/ngsiUtils.js

@@ -90,10 +90,10 @@ function isFloat(value) {
 }
 
 /**
- * It casts attribute values which are reported using JSON native types
+ * It casts attribute values which are reported using JSON parsing
  *
  * @param      {String}  payload  The payload
- * @return     {String}           New payload where attributes's values are casted to the corresponding JSON types
+ * @return     {String}           New payload where attributes's values are casted to the corresponding JSON values
  */
 function castJsonNativeAttributes(payload) {
     if (!config.getConfig().autocast) {
@@ -105,28 +105,13 @@ function castJsonNativeAttributes(payload) {
             /* eslint-disable-next-line  no-prototype-builtins */
             payload.hasOwnProperty(key) &&
             payload[key].value &&
-            payload[key].type &&
             typeof payload[key].value === 'string'
         ) {
-            if (payload[key].type === 'Number' && isFloat(payload[key].value)) {
-                payload[key].value = Number.parseFloat(payload[key].value);
-            } else if (payload[key].type === 'Number' && Number.parseInt(payload[key].value)) {
-                payload[key].value = Number.parseInt(payload[key].value);
-            } else if (payload[key].type === 'Boolean') {
-                payload[key].value = payload[key].value === 'true' || payload[key].value === '1';
-            } else if (payload[key].type === 'None') {
-                payload[key].value = null;
-            } else if (payload[key].type === 'Array' || payload[key].type === 'Object') {
-                try {
-                    const parsedValue = JSON.parse(payload[key].value);
-                    payload[key].value = parsedValue;
-                } catch (e) {
-                    logger.error(
-                        context,
-                        'Bad attribute value type. Expecting JSON Array or JSON Object. Received:%s',
-                        payload[key].value
-                    );
-                }
+            try {
+                const parsedValue = JSON.parse(payload[key].value);
+                payload[key].value = parsedValue;
+            } catch (e) {
+                // Keep value as is
             }
         }
     }
@@ -223,6 +208,14 @@ function getMetaData(typeInformation, name, metadata) {
             }
         }
     }
+    if (typeInformation.lazy) {
+        for (i = 0; i < typeInformation.lazy.length; i++) {
+            /* jshint camelcase: false */
+            if (name === typeInformation.lazy[i].object_id) {
+                return typeInformation.lazy[i].metadata;
+            }
+        }
+    }
     if (typeInformation.staticAttributes) {
         for (i = 0; i < typeInformation.staticAttributes.length; i++) {
             if (name === typeInformation.staticAttributes[i].name) {

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

@@ -31,6 +31,7 @@ const async = require('async');
 const apply = async.apply;
 const logger = require('logops');
 const errors = require('../../errors');
+const constants = require('../../constants');
 const deviceService = require('../devices/deviceService');
 const middlewares = require('../common/genericMiddleware');
 const _ = require('underscore');
@@ -41,11 +42,98 @@ const updateContextTemplateNgsiLD = require('../../templates/updateContextNgsiLD
 const notificationTemplateNgsiLD = require('../../templates/notificationTemplateNgsiLD.json');
 const contextServerUtils = require('./contextServerUtils');
 const ngsiLD = require('../ngsi/entities-NGSI-LD');
+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'];
 
+
+/**
+ * Replacement of NGSI-LD Null placeholders with real null values
+ *
+ */
+function replaceNGSILDNull(payload){
+    Object.keys(payload).forEach((key) =>{
+        const value = payload[key];
+        if ( value === constants.NGSI_LD_NULL){
+           payload[key] = null; 
+        } else if (typeof value === 'object' &&
+            !Array.isArray(value) &&
+            value !== null){
+            payload[key] = replaceNGSILDNull(payload[key]);
+        }
+    })
+    return  payload;
+}
+
+/**
+ * Check to see if the payload or its subattributes contain null values
+ *
+ */
+function containsNulls(payload, result){
+    Object.keys(payload).forEach((key) =>{
+        const value = payload[key];
+        if ( value === null){
+           result.nulls = true; 
+        } else if (typeof value === 'object' &&
+            !Array.isArray(value) &&
+            value !== null){
+            containsNulls(payload[key], result);
+        }
+    })
+    return  result;
+}
+
+/**
+ * An Express middleware for preprocessing NGSI-LD payloads. Converts NGSI-LD Nulls
+ * to real nulls and checks for the presence of null and datasetId
+ *
+ */
+function preprocessNGSILD(req, res, next){
+    res.locals.hasDatasetId =  false;
+    const payload = req.body
+    if (payload && typeof payload === 'object'){
+        Object.keys(payload).forEach((key) =>{
+            if (_.isArray(payload[key])){
+                payload[key].forEach((obj) => {
+                    if (obj.datasetId){
+                        res.locals.hasDatasetId = true;
+                    }
+                });
+            } else if (payload[key] && payload[key].datasetId && payload[key].datasetId !== '@none'){
+               res.locals.hasDatasetId = true;
+            } 
+        });
+        req.body = replaceNGSILDNull(payload);
+        const result = { nulls: false }
+        containsNulls(payload, result);
+        res.locals.hasNulls = result.nulls;
+    }
+    next();
+}
+
+/**
+ * A configurable Middleware that makes additional NGSI-LD checks within the payload.
+
+ *
+ * @param {Boolean} supportNull          Whether to support NGSI-LD nulls in the payload
+ * @param {Boolean} supportDatasetId     Whether to support multiattributes in the payload.
+ * @return {Object}            Express middleware used in request validation.
+ */
+function validateNGSILD(supportNull, supportDatasetId) {
+    return function validate(req, res, next) {
+        if (!supportNull && res.locals.hasNulls) {
+            next(new errors.BadRequest('NGSI-LD Null found within the payload. This IoT Agent does not support nulls for this endpoint.'));
+        } else if (!supportDatasetId && res.locals.hasDatasetId) {
+            next(new errors.BadRequest('datasetId found within the payload. This IoT Agent does not support multi-attribute requests.'));
+        } else {
+            next();
+        }
+    };
+}
+
+
 /**
  * Extract metadata attributes from input.
  *
@@ -318,6 +406,104 @@ function defaultQueryHandlerNgsiLD(id, type, service, subservice, attributes, ca
     });
 }
 
+/**
+ * Generate a merge-patch action corresponding to the request using NGSI-LD.
+ * Merge-patch is an NGSI-LD specific action.
+ *
+ * @param {Object} req                  Update request to generate Actions from
+ */
+function generateMergePatchActionNgsiLD(req, callback) {
+ 
+    const entityId = req.params.entity;
+
+       
+    function addAttributes(deviceData, body, attributes){
+        const keys = Object.keys(body);
+
+        for (const j in deviceData) {
+            if (keys.includes(deviceData[j].name)) {
+                const obj = body[deviceData[j].name]
+                if ( obj === null) {
+                    attributes.push({
+                        type: deviceData[j].type,
+                        value: null,
+                        name: deviceData[j].name
+                    });
+                } else {
+                     attributes.push({
+                        type: deviceData[j].type,
+                        value: obj.value,
+                        name: deviceData[j].name
+                    });
+                }
+            } 
+        }
+        return attributes;
+    }
+    
+
+    deviceService.getDeviceByName(
+        entityId,
+        contextServerUtils.getLDTenant(req),
+        contextServerUtils.getLDPath(req),
+        function (error, deviceObj) {
+            if (error) {
+                callback(error);
+            } else {
+                const attributes = [];
+                addAttributes(deviceObj.commands, req.body, attributes)
+                addAttributes(deviceObj.lazy, req.body, attributes)
+                const executeMergePatchHandler = apply(
+                    contextServerUtils.mergePatchHandler,
+                    entityId,
+                    deviceObj.type,
+                    contextServerUtils.getLDTenant(req),
+                    contextServerUtils.getLDPath(req),
+                    attributes
+                );
+                async.waterfall(
+                    [executeMergePatchHandler],
+                    callback()
+        );
+            }
+        }
+    );
+}
+
+/**
+ * Express middleware to manage incoming merge-patch requests using NGSI-LD.
+ *
+ * @param {Object} req              Request that was handled in first place.
+ * @param {Object} res              Response that will be sent.
+ */
+function handleMergePatchNgsiLD(req, res, next) {
+
+    function handleMergePatchRequest(error, result) {
+        if (error) {
+            logger.debug(context, 'There was an error handling the merge-patch: %s.', error);
+            next(error);
+        } else {
+            logger.debug(context, 'Merge-patch from [%s] handled successfully.', req.get('host'));
+            res.status(200).json(result);
+        }
+    }
+
+    logger.debug(context, 'Handling merge-patch from [%s]', req.get('host'));
+    if ((req.is('json') || req.is('application/ld+json')) === false) {
+        return handleMergePatchRequest(new errors.UnsupportedContentType(req.header('content-type')));
+    }
+    
+    if (req.body) {
+        logger.debug(context, JSON.stringify(req.body, null, 4));
+    }
+
+    if (contextServerUtils.mergePatchHandler){
+        generateMergePatchActionNgsiLD(req, handleMergePatchRequest);
+    } else {
+       return handleMergePatchRequest(new errors.MethodNotSupported(req.method, req.path)) 
+    }
+}
+
 /**
  * Express middleware to manage incoming query context requests using NGSI-LD.
  *
@@ -489,19 +675,21 @@ function handleQueryNgsiLD(req, res, next) {
  * @param {Object} req              Request that was handled in first place.
  * @param {Object} res              Response that will be sent.
  */
-function queryErrorHandlingNgsiLD(error, req, res, next) {
-    let code = 500;
+function ErrorHandlingNgsiLD(action) {
+    return function errorHandle(error, req, res, next) {
+        let code = 500;
 
-    logger.debug(context, 'Query NGSI-LD error [%s] handling request: %s', error.name, error.message);
+        logger.debug(context, action + ' NGSI-LD error [%s] handling request: %s', error.name, error.message);
 
-    if (error.code && String(error.code).match(/^[2345]\d\d$/)) {
-        code = error.code;
-    }
+        if (error.code && String(error.code).match(/^[2345]\d\d$/)) {
+            code = error.code;
+        }
 
-    res.status(code).json({
-        error: error.name,
-        description: error.message.replace(/[<>\"\'=;\(\)]/g, '')
-    });
+        res.status(code).json({
+            error: error.name,
+            description: error.message.replace(/[<>\"\'=;\(\)]/g, '')
+        });
+    }
 }
 
 /**
@@ -601,28 +789,6 @@ function handleNotificationNgsiLD(req, res, next) {
     }
 }
 
-/**
- * Error handler for NGSI-LD update requests.
- *
- * @param {Object} error            Incoming error
- * @param {Object} req              Request that was handled in first place.
- * @param {Object} res              Response that will be sent.
- */
-function updateErrorHandlingNgsiLD(error, req, res, next) {
-    let code = 500;
-
-    logger.debug(context, 'Update NGSI-LD error [%s] handing request: %s', error.name, error.message);
-
-    if (error.code && String(error.code).match(/^[2345]\d\d$/)) {
-        code = error.code;
-    }
-
-    res.status(code).json({
-        error: error.name,
-        description: error.message.replace(/[<>\"\'=;\(\)]/g, '')
-    });
-}
-
 /**
  * Load unsupported NGSI-LD entity routes and return proper NGSI-LD not supported responses
  *
@@ -645,36 +811,53 @@ function loadUnsupportedEndpointsNGSILD(router) {
  */
 function loadContextRoutesNGSILD(router) {
     // In a more evolved implementation, more endpoints could be added to queryPathsNgsi2
-    // according to http://fiware.github.io/specifications/ngsiv2/stable.
-
+    // according to https://www.etsi.org/standards-search#page=1&search=GS%20CIM%20009
+    
+    const support = config.getConfig().server.ldSupport;
     let i;
 
     logger.info(context, 'Loading NGSI-LD Context server routes');
+    // Update Patch endpoints - this endpoint may accept NGSI-LD Null
     for (i = 0; i < updatePaths.length; i++) {
         router.patch(updatePaths[i], [
             middlewares.ensureType,
             middlewares.validateJson(updateContextTemplateNgsiLD),
+            preprocessNGSILD,
+            validateNGSILD(support.null, support.datasetId),
             handleUpdateNgsiLD,
-            updateErrorHandlingNgsiLD
+            ErrorHandlingNgsiLD('Partial Update')
         ]);
     }
+    // Merge Patch endpoints - this endpoint may accept NGSI-LD Null
+    router.patch('/ngsi-ld/v1/entities/:entity', [
+        preprocessNGSILD,
+        validateNGSILD(support.null, support.datasetId),
+        handleMergePatchNgsiLD, 
+        ErrorHandlingNgsiLD('Merge-Patch')
+    ]);
 
+    // Overwrite/PUT endpoints - this endpoint does not accept NGSI-LD Null
     for (i = 0; i < overwritePaths.length; i++) {
         router.put(overwritePaths[i], [
             middlewares.ensureType,
             middlewares.validateJson(updateContextTemplateNgsiLD),
+            preprocessNGSILD,
+            validateNGSILD(false, support.datasetId),
             handleUpdateNgsiLD,
-            updateErrorHandlingNgsiLD
+            ErrorHandlingNgsiLD('Overwrite')
         ]);
     }
+    // Query/GET endpoints - no payload to check.
     for (i = 0; i < queryPaths.length; i++) {
-        router.get(queryPaths[i], [handleQueryNgsiLD, queryErrorHandlingNgsiLD]);
+        router.get(queryPaths[i], [handleQueryNgsiLD, ErrorHandlingNgsiLD('Query')]);
     }
     router.post('/notify', [
         middlewares.ensureType,
         middlewares.validateJson(notificationTemplateNgsiLD),
+        preprocessNGSILD,
+        validateNGSILD(false, support.datasetId),
         handleNotificationNgsiLD,
-        queryErrorHandlingNgsiLD
+        ErrorHandlingNgsiLD('Notify')
     ]);
     loadUnsupportedEndpointsNGSILD(router);
 }

package/lib/services/northBound/contextServer.js

@@ -64,7 +64,7 @@ function setUpdateHandler(newHandler) {
 }
 
 /**
- * Sets the new user handler for commadn execution requests. This handler will be called whenever an update request
+ * Sets the new user handler for command execution requests. This handler will be called whenever an update request
  * arrives to a with the following parameters: (id, type, attributes, callback). The callback is in charge of updating
  * the corresponding values in the devices with the appropriate protocol.
  *
@@ -77,6 +77,18 @@ function setCommandHandler(newHandler) {
     contextServerUtils.commandHandler = newHandler;
 }
 
+/**
+ * Sets the new user handler for NGSI-LD merge-patch requests. This handler will be called whenever an update request
+ * arrives to a with the following parameters: (id, type, attributes, callback). The callback is in charge of updating
+ * the corresponding values in the devices with the appropriate protocol.
+ *
+ *
+ * @param {Function} newHandler         User handler for update requests
+ */
+function setMergePatchHandler(newHandler) {
+    contextServerUtils.mergePatchHandler = newHandler;
+}
+
 /**
  * Sets the new user handler for Entity query requests. This handler will be called whenever an update request arrives
  * with the following parameters: (id, type, attributes, callback). The handler must retrieve all the corresponding
@@ -140,6 +152,7 @@ function clear(callback) {
 exports.clear = clear;
 exports.loadContextRoutes = intoTrans(context, loadContextRoutes);
 exports.setUpdateHandler = intoTrans(context, setUpdateHandler);
+exports.setMergePatchHandler = intoTrans(context, setMergePatchHandler);
 exports.setCommandHandler = intoTrans(context, setCommandHandler);
 exports.setNotificationHandler = intoTrans(context, setNotificationHandler);
 exports.addNotificationMiddleware = intoTrans(context, addNotificationMiddleware);

package/lib/services/northBound/northboundServer.js

@@ -110,6 +110,7 @@ function clear(callback) {
     async.series([deviceProvisioning.clear, groupProvisioning.clear, contextServer.clear], callback);
 }
 
+exports.setMergePatchHandler = intoTrans(context, contextServer.setMergePatchHandler);
 exports.setUpdateHandler = intoTrans(context, contextServer.setUpdateHandler);
 exports.setQueryHandler = intoTrans(context, contextServer.setQueryHandler);
 exports.setCommandHandler = intoTrans(context, contextServer.setCommandHandler);

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": "2.25.0",
+  "version": "3.0.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",

package/test/unit/general/loglevel-api_test.js

@@ -73,8 +73,6 @@ describe('Log level API', function () {
 
         iotAgentLib.activate(iotAgentConfig, function () {
             iotAgentLib.clearAll(function () {
-                iotAgentLib.addUpdateMiddleware(iotAgentLib.dataPlugins.attributeAlias.update);
-                iotAgentLib.addQueryMiddleware(iotAgentLib.dataPlugins.attributeAlias.query);
                 done();
             });
         });

package/test/unit/memoryRegistry/deviceRegistryMemory_test.js

@@ -241,7 +241,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(11);
+                Object.keys(device).length.should.equal(12);
                 done();
             });
         });

package/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent1.json

@@ -1,18 +1,28 @@
 {
-    "@context": "http://context.json-ld",
-    "endpoint": "http://smartgondor.com",
-    "information": [
+  "type": "ContextSourceRegistration",
+  "information": [
+    {
+      "entities": [
         {
-            "entities": [
-                {
-                    "id": "urn:ngsi-ld:Light:light1",
-                    "type": "Light"
-                }
-            ],
-            "properties": [
-                "temperature"
-            ]
+          "type": "Light",
+          "id": "urn:ngsi-ld:Light:light1"
         }
-    ],
-    "type": "ContextSourceRegistration"
+      ],
+      "propertyNames": [
+        "temperature"
+      ]
+    }
+  ],
+  "mode": "exclusive",
+  "operations": [
+    "retrieveOps"
+  ],
+  "endpoint": "http://smartgondor.com",
+  "contextSourceInfo": [
+    {
+      "key": "jsonldContext",
+      "value": "http://context.json-ld"
+    }
+  ],
+  "@context": "http://context.json-ld"
 }

package/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent2.json

@@ -1,18 +1,28 @@
 {
-  "type": "ContextSourceRegistration",
-  "information": [
-    {
-      "entities": [
+    "type": "ContextSourceRegistration",
+    "information": [
         {
-          "type": "Motion",
-          "id": "urn:ngsi-ld:Motion:motion1"
+            "entities": [
+                {
+                    "type": "Motion",
+                    "id": "urn:ngsi-ld:Motion:motion1"
+                }
+            ],
+            "propertyNames": [
+                "moving"
+            ]
         }
-      ],
-      "properties": [
-        "moving"
-      ]
-    }
-  ],
-  "endpoint": "http://smartgondor.com",
-  "@context": "http://context.json-ld"
-}
+    ],
+    "mode": "exclusive",
+    "operations": [
+        "retrieveOps"
+    ],
+    "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
+    "@context": "http://context.json-ld"
+}

package/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent4.json

@@ -4,15 +4,25 @@
     {
       "entities": [
         {
-          "type": "RobotPre",
-          "id": "urn:ngsi-ld:RobotPre:TestRobotPre"
+          "type": "Light",
+          "id": "urn:ngsi-ld:Light:light1"
         }
       ],
-      "properties": [
-        "moving"
+      "propertyNames": [
+        "temperature"
       ]
     }
   ],
+  "mode": "exclusive",
+  "operations": [
+    "retrieveOps"
+  ],
   "endpoint": "http://smartgondor.com",
+  "contextSourceInfo": [
+    {
+      "key": "jsonldContext",
+      "value": "http://context.json-ld"
+    }
+  ],
   "@context": "http://context.json-ld"
-}
+}

package/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgentCommands.json

@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,11 +15,13 @@
                     "type": "Robot"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "position",
                 "orientation"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations" :["updateOps"],
     "type": "ContextSourceRegistration"
 }

package/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgentCommandsAndLazy.json

@@ -0,0 +1,32 @@
+{
+  "type": "ContextSourceRegistration",
+  "information": [
+    {
+      "entities": [
+        {
+          "type": "Robot",
+          "id": "urn:ngsi-ld:Robot:r2d2"
+        }
+      ],
+      "propertyNames": [
+        "batteryLevel",
+        "position",
+        "orientation"
+      ]
+    }
+  ],
+  "mode": "exclusive",
+  "operations": [
+    "retrieveOps",
+    "updateOps",
+    "mergeEntity"
+  ],
+  "endpoint": "http://smartgondor.com",
+  "contextSourceInfo": [
+    {
+      "key": "jsonldContext",
+      "value": "http://context.json-ld"
+    }
+  ],
+  "@context": "http://context.json-ld"
+}

package/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDevice.json

@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,11 +15,16 @@
                     "type": "TheLightType"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "luminance",
                 "commandAttr"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations": [
+        "retrieveOps",
+        "updateOps"
+    ],
     "type": "ContextSourceRegistration"
 }