telefonicaid · fgalan · Dec 18, 2020 · Jul 21, 2020 · Nov 27, 2020 · Dec 4, 2020
diff --git a/CHANGES_NEXT_RELEASE b/CHANGES_NEXT_RELEASE
@@ -19,4 +19,5 @@ Add husky and lint-staged
 Fix: Add support for lazy and internal_attributes in service notifications to Manager (#768)
 Fix: combine multi-entity and expressions with duplicate attribute name, by enabling expression over object_id (which are not duplicated in a attribute mapping contrary to name) (#941)
 Fix: bug in legacy and JEXL expression that was not converting "0" to 0
-Fix: support for mapping different attributes to the same entity_name
+Fix: support for mapping different attributes to the same entity_name
+Fix: Ensure GeoJSON is correctly encoded in NGSI-v2 requests (#961)
diff --git a/doc/advanced-topics.md b/doc/advanced-topics.md
@@ -46,6 +46,64 @@ curl http://${KEYSTONE_HOST}/v3/OS-TRUST/trusts \
 Apart from the generation of the trust, the use of secured Context Brokers should be transparent to the user of the IoT
 Agent.
 
+### GeoJSON support
+
+The defined `type` of any GeoJSON attribute can be any set to any of the standard NGSI-v2 GeoJSON types - (e.g.
+`geo:json`, `geo:point`). NGSI-LD formats such as `GeoProperty`, `Point` and `LineString` are also accepted `type`
+values. If the latitude and longitude are received as separate measures, the
+[expression language](expressionLanguage.md) can be used to concatenate them.
+
+````json
+{
+    "entity_type": "GPS",
+    "resource":    "/iot/d",
+    "protocol":    "PDI-IoTA-JSON",
+..etc
+    "attributes": [
+        {
+            "name": "location",
+            "type": "geo:json",
+            "expression": "${@lng}, ${@lat}"
+        }
+    ]
+}
+```json
+
+
+For `attributes` and `static_attributes` which need to be formatted as GeoJSON values, three separate input
+formats are accepted. Provided the `type` is provisioned correctly, the `value` may be defined using any of
+the following formats:
+
+-  a comma delimited string
+
+```json
+{
+  "name": "location",
+  "value": "23, 12.5"
+}
+````
+
+-   an array of numbers
+
+```json
+{
+    "name": "location",
+    "value": [23, 12.5]
+}
+```
+
+-   an fully formatted GeoJSON object
+
+```json
+{
+    "name": "location",
+    "value": {
+        "type": "Point",
+        "coordinates": [23, 12.5]
+    }
+}
+```
+
 ### Metadata support
 
 Both `attributes` and `static_attributes` may be supplied with metadata when provisioning an IoT Agent, so that the

diff --git a/lib/services/devices/devices-NGSI-v2.js b/lib/services/devices/devices-NGSI-v2.js
@@ -25,6 +25,8 @@
  * Modified by: Jason Fox - FIWARE Foundation
  */
 
+/* eslint-disable consistent-return */
+
 const request = require('request');
 const async = require('async');
 const apply = async.apply;
@@ -38,6 +40,7 @@ const config = require('../../commonConfig');
 const registrationUtils = require('./registrationUtils');
 const _ = require('underscore');
 const utils = require('../northBound/restUtils');
+const NGSIv2 = require('../ngsi/entities-NGSI-v2');
 const moment = require('moment');
 const context = {
     op: 'IoTAgentNGSI.Devices-v2'
@@ -232,6 +235,15 @@ function createInitialEntityNgsi2(deviceData, newDevice, callback) {
     jsonConcat(options.json, formatAttributesNgsi2(deviceData.staticAttributes, true));
     jsonConcat(options.json, formatCommandsNgsi2(deviceData.commands));
 
+    for (const att in options.json) {
+        try {
+            // Format any GeoJSON attrs properly
+            options.json[att] = NGSIv2.formatGeoAttrs(options.json[att]);
+        } catch (error) {
+            return callback(new errors.BadGeocoordinates(JSON.stringify(options.json)));
+        }
+    }
+
     logger.debug(context, 'deviceData: %j', deviceData);
     if (
         ('timestamp' in deviceData && deviceData.timestamp !== undefined
@@ -281,6 +293,15 @@ function updateEntityNgsi2(deviceData, updatedDevice, callback) {
     jsonConcat(options.json, formatAttributesNgsi2(deviceData.staticAttributes, true));
     jsonConcat(options.json, formatCommandsNgsi2(deviceData.commands));
 
+    for (const att in options.json) {
+        try {
+            // Format any GeoJSON attrs properly
+            options.json[att] = NGSIv2.formatGeoAttrs(options.json[att]);
+        } catch (error) {
+            return callback(new errors.BadGeocoordinates(JSON.stringify(options.json)));
+        }
+    }
+
     if (
         ('timestamp' in deviceData && deviceData.timestamp !== undefined
             ? deviceData.timestamp

diff --git a/lib/services/ngsi/entities-NGSI-LD.js b/lib/services/ngsi/entities-NGSI-LD.js
@@ -56,45 +56,6 @@ function valueOfOrNull(value) {
     return isNaN(value) ? NGSI_LD_NULL : value;
 }
 
-/**
- * @param      {String/Array}   value       Comma separated list or array of values
- * @return     {Array}                      Array of Lat/Lngs for use as GeoJSON
- */
-function splitLngLat(value) {
-    const lngLats = typeof value === 'string' || value instanceof String ? value.split(',') : value;
-    lngLats.forEach((element, index, lngLats) => {
-        if (Array.isArray(element)) {
-            lngLats[index] = splitLngLat(element);
-        } else if ((typeof element === 'string' || element instanceof String) && element.includes(',')) {
-            lngLats[index] = splitLngLat(element);
-        } else {
-            lngLats[index] = Number.parseFloat(element);
-        }
-    });
-    return lngLats;
-}
-
-/**
- * @param      {String}   value       Value to be analyzed
- * @return     {Array}                split pairs of GeoJSON coordinates
- */
-function getLngLats(value) {
-    const lngLats = _.flatten(splitLngLat(value));
-    if (lngLats.length === 2) {
-        return lngLats;
-    }
-
-    if (lngLats.length % 2 !== 0) {
-        logger.error(context, 'Bad attribute value type. Expecting geo-coordinates. Received:%s', value);
-        throw Error();
-    }
-    const arr = [];
-    for (let i = 0, len = lngLats.length; i < len; i = i + 2) {
-        arr.push([lngLats[i], lngLats[i + 1]]);
-    }
-    return arr;
-}
-
 /**
  * Amends an NGSIv2 attribute to NGSI-LD format
  * All native JSON types are respected and cast as Property values
@@ -155,33 +116,34 @@ function convertNGSIv2ToLD(attr) {
         case 'geoproperty':
         case 'point':
         case 'geo:point':
+        case 'geo:json':
             obj.type = 'GeoProperty';
-            obj.value = { type: 'Point', coordinates: getLngLats(attr.value) };
+            obj.value = NGSIUtils.getLngLats('Point', attr.value);
             break;
         case 'linestring':
         case 'geo:linestring':
             obj.type = 'GeoProperty';
-            obj.value = { type: 'LineString', coordinates: getLngLats(attr.value) };
+            obj.value = NGSIUtils.getLngLats('LineString', attr.value);
             break;
         case 'polygon':
         case 'geo:polygon':
             obj.type = 'GeoProperty';
-            obj.value = { type: 'Polygon', coordinates: getLngLats(attr.value) };
+            obj.value = NGSIUtils.getLngLats('Polygon', attr.value);
             break;
         case 'multipoint':
         case 'geo:multipoint':
             obj.type = 'GeoProperty';
-            obj.value = { type: 'MultiPoint', coordinates: getLngLats(attr.value) };
+            obj.value = NGSIUtils.getLngLats('MultiPoint', attr.value);;
             break;
         case 'multilinestring':
         case 'geo:multilinestring':
             obj.type = 'GeoProperty';
-            obj.value = { type: 'MultiLineString', coordinates: attr.value };
+            obj.value = NGSIUtils.getLngLats( 'MultiLineString', attr.value);
             break;
         case 'multipolygon':
         case 'geo:multipolygon':
             obj.type = 'GeoProperty';
-            obj.value = { type: 'MultiPolygon', coordinates: attr.value };
+            obj.value = NGSIUtils.getLngLats( 'MultiPolygon', attr.value);
             break;
 
         // Relationships

diff --git a/lib/services/ngsi/entities-NGSI-v2.js b/lib/services/ngsi/entities-NGSI-v2.js
@@ -25,6 +25,8 @@
  * Modified by: Jason Fox - FIWARE Foundation
  */
 
+/* eslint-disable consistent-return */
+
 const request = require('request');
 const statsService = require('./../stats/statsRegistry');
 const async = require('async');
@@ -35,11 +37,59 @@ const utils = require('../northBound/restUtils');
 const config = require('../../commonConfig');
 const constants = require('../../constants');
 const moment = require('moment-timezone');
+const NGSIUtils = require('./ngsiUtils');
 const logger = require('logops');
 const context = {
     op: 'IoTAgentNGSI.Entities-v2'
 };
-const NGSIUtils = require('./ngsiUtils');
+
+/**
+ * Amends an NGSIv2 Geoattribute from String to GeoJSON format
+ *
+ * @param      {Object}   attr       Attribute to be analyzed
+ * @return     {Object}              GeoJSON version of the attribute
+ */
+function formatGeoAttrs(attr) {
+    const obj = attr;
+    if (attr.type) {
+        switch (attr.type.toLowerCase()) {
+            // GeoProperties
+            case 'geo:json':
+            case 'geoproperty':
+            case 'point':
+            case 'geo:point':
+                obj.type = 'geo:json';
+                obj.value = NGSIUtils.getLngLats('Point', attr.value);
+                break;
+            case 'linestring':
+            case 'geo:linestring':
+                obj.type = 'geo:json';
+                obj.value = NGSIUtils.getLngLats('LineString', attr.value);
+                break;
+            case 'polygon':
+            case 'geo:polygon':
+                obj.type = 'geo:json';
+                obj.value = NGSIUtils.getLngLats('Polygon', attr.value);
+                break;
+            case 'multipoint':
+            case 'geo:multipoint':
+                obj.type = 'geo:json';
+                obj.value = NGSIUtils.getLngLats('MultiPoint', attr.value);
+                break;
+            case 'multilinestring':
+            case 'geo:multilinestring':
+                obj.type = 'geo:json';
+                obj.value = NGSIUtils.getLngLats('MultiLineString', attr.value);
+                break;
+            case 'multipolygon':
+            case 'geo:multipolygon':
+                obj.type = 'geo:json';
+                obj.value = NGSIUtils.getLngLats('MultiPolygon', attr.value);
+                break;
+        }
+    }
+    return obj;
+}
 
 function addTimestampNgsi2(payload, timezone) {
     function addTimestampEntity(entity, timezone) {
@@ -387,6 +437,13 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
                             if (options.json.entities[entity][att].name) {
                                 delete options.json.entities[entity][att].name;
                             }
+
+                            try {
+                                // Format any GeoJSON attrs properly
+                                options.json.entities[entity][att] = formatGeoAttrs(options.json.entities[entity][att]);
+                            } catch (error) {
+                                return callback(new errors.BadGeocoordinates(JSON.stringify(options.json)));
+                            }
                         }
                     }
                 } else {
@@ -402,6 +459,13 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
                         if (options.json[att].name) {
                             delete options[att].name;
                         }
+
+                        try {
+                            // Format any GeoJSON attrs properly
+                            options.json[att] = formatGeoAttrs(options.json[att]);
+                        } catch (error) {
+                            return callback(new errors.BadGeocoordinates(JSON.stringify(options.json)));
+                        }
                     }
                 }
 
@@ -424,3 +488,4 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
 exports.sendQueryValue = sendQueryValueNgsi2;
 exports.sendUpdateValue = sendUpdateValueNgsi2;
 exports.addTimestamp = addTimestampNgsi2;
+exports.formatGeoAttrs = formatGeoAttrs;
diff --git a/lib/services/ngsi/ngsiUtils.js b/lib/services/ngsi/ngsiUtils.js
@@ -34,6 +34,51 @@ const _ = require('underscore');
 const config = require('../../commonConfig');
 const updateMiddleware = [];
 const queryMiddleware = [];
+
+/**
+ * @param      {String/Array}   value       Comma separated list or array of values
+ * @return     {Array}                      Array of Lat/Lngs for use as GeoJSON
+ */
+function splitLngLat(value) {
+    const lngLats = typeof value === 'string' || value instanceof String ? value.split(',') : value;
+    lngLats.forEach((element, index, lngLats) => {
+        if (Array.isArray(element)) {
+            lngLats[index] = splitLngLat(element);
+        } else if ((typeof element === 'string' || element instanceof String) && element.includes(',')) {
+            lngLats[index] = splitLngLat(element);
+        } else {
+            lngLats[index] = Number.parseFloat(element);
+        }
+    });
+    return lngLats;
+}
+
+/**
+ * @param      {String}   type        GeoJSON
+ * @param      {String}   value       Value to be analyzed
+ * @return     {Array}                split pairs of GeoJSON coordinates
+ */
+function getLngLats(type, value) {
+    if (typeof value !== 'string' && Array.isArray(value) === false) {
+        return value;
+    }
+
+    const lngLats = _.flatten(splitLngLat(value));
+    if (lngLats.length === 2) {
+        return { type, coordinates: lngLats };
+    }
+
+    if (lngLats.length % 2 !== 0) {
+        logger.error(context, 'Bad attribute value type. Expecting geo-coordinates. Received:%s', value);
+        throw Error();
+    }
+    const arr = [];
+    for (let i = 0, len = lngLats.length; i < len; i = i + 2) {
+        arr.push([lngLats[i], lngLats[i + 1]]);
+    }
+    return { type, coordinates: arr };
+}
+
 /**
  * Determines if a value is of type float
  *
@@ -212,6 +257,7 @@ exports.getErrorField = intoTrans(context, getErrorField);
 exports.createRequestObject = createRequestObject;
 exports.applyMiddlewares = applyMiddlewares;
 exports.getMetaData = getMetaData;
+exports.getLngLats = getLngLats;
 exports.castJsonNativeAttributes = castJsonNativeAttributes;
 exports.isFloat = isFloat;
 exports.updateMiddleware = updateMiddleware;

diff --git a/package.json b/package.json
@@ -37,7 +37,7 @@
     "prettier": "prettier --config .prettierrc.json --write '**/**/**/**/*.js' '**/**/**/*.js' '**/**/*.js' '**/*.js' '*.js'",
     "prettier:text": "prettier 'README.md' 'doc/*.md' 'doc/**/*.md' --no-config --tab-width 4 --print-width 120 --write --prose-wrap always",
     "test": "nyc --reporter=text mocha --recursive 'test/**/*.js' --reporter spec --timeout 5000 --ui bdd --exit --color true",
-    "test:debug": "mocha --recursive 'test/**/*.js' --reporter spec --inspect-brk --timeout 30000 --ui bdd --exit" ,
+    "test:debug": "mocha --recursive 'test/**/*.js' --reporter spec --inspect-brk --timeout 30000 --ui bdd --exit",
     "test:coverage": "nyc --reporter=lcov mocha -- --recursive 'test/**/*.js' --reporter spec --timeout 5000 --exit",
     "test:coveralls": "npm run test:coverage && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage",
     "test:watch": "npm run test -- -w ./lib",