Re-introduce GeoJSON conversion under a flag

CHANGES_NEXT_RELEASE

@@ -1,6 +1,6 @@
 - Add: add getTypeSilently for device group and use in device registration to avoid false mongo alarm
 - Fix: group command is not provisioned in device when entity_type is different (#1011)
-- Hotfix: avoid automatic conversion from geo:xxxx ('xxxx' diferent from 'json') to geo:json (reverts the work done in PR  #854)
+- Hotfix: avoid automatic conversion from geo:xxxx ('xxxx' diferent from 'json') to geo:json (reverts some of the work done in PR  #854)
 - Add: use getDeviceSilently in checkDuplicates to avoid raise a false mongo alarm.
 - Add: expose getConfigurationSilently to enable retrieve a configuration without raise a false mongo alarm (#1007)
 - Add: db uri and options in mongo connection log INFO trace

doc/advanced-topics.md

@@ -46,10 +46,10 @@ 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 (this only applies for NGSI-LD, not for NGSIv1 and NGSIv2)
+### 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`
+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.
 
@@ -69,15 +69,16 @@ values. If the latitude and longitude are received as separate measures, the
 }
 ```
 
-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:
+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
+-  a comma delimited string
 
 ```json
 {
-    "name": "location",
-    "value": "23, 12.5"
+  "name": "location",
+  "value": "23, 12.5"
 }
 ```
 
@@ -102,6 +103,27 @@ accepted. Provided the `type` is provisioned correctly, the `value` may be defin
 }
 ```
 
+Because GeoJSON types (e.g. `Point`, `LineString` etc.) are native types in **NGSI-LD**, automatic GeoJSON conversion is switched on for NGSI-LD by default.
+
+With **NGSI-v2**, for backwards compatibility reasons, automatic GeoJSON conversion for types other than `geo:json` is turned off by default.
+Add the `autocastGeoJSON` configuration to the attribute to enable GeoJSON conversion. Each GeoJSON attribute can be provisioned as shown:
+
+```json
+{
+    "entity_type": "GPS",
+    "resource":    "/iot/d",
+    "protocol":    "PDI-IoTA-JSON",
+..etc
+    "attributes": [
+        {
+            "name": "observationSpace",
+            "type": "Polygon",
+            "autocastGeoJSON" : "true"
+        }
+    ]
+}
+```
+
 ### Metadata support
 
 Both `attributes` and `static_attributes` may be supplied with metadata when provisioning an IoT Agent, so that the
@@ -149,7 +171,7 @@ following:
 -   Temporal Properties (e.g. `Datetime`, `Date` , `Time`)
 -   GeoJSON types (e.g `Point`, `LineString`, `Polygon`, `MultiPoint`, `MultiLineString`, `MultiPolygon`)
 
-Most NGSI-LD attributes are sent to the Context Broker as _properties_. If a GeoJSON type or native JSON type is
+Most **NGSI-LD** attributes are sent to the Context Broker as _properties_. If a GeoJSON type or native JSON type is
 defined, the data will be converted to the appropriate type. Temporal properties should always be expressed in UTC,
 using ISO 8601. This ISO 8601 conversion is applied automatically for the `observedAt` _property-of-a-property_ metadata
 where present.
@@ -183,12 +205,11 @@ Other unrecognised `type` attributes will be passed as NGSI-LD data using the fo
     }
 ```
 
+
 ### NGSI-LD Linked Data support
 
-`static_attributes` may be supplied with an additional `link` data element when provisioning an IoT Agent to ensure that
-active attributes from the provisioned IoT Device may be maintained in parallel with a linked data entity . Take for
-example a temperature gauge placed within a building. The **Device** data model literally represents the IoT device
-itself, but the `temperature` attribute also needs to be shared with the **Building** entity
+`static_attributes` may be supplied with an additional `link` data element when provisioning an IoT Agent to ensure that active attributes from the provisioned IoT Device may be maintained in parallel with a linked data entity . Take for example a temperature gauge placed within a building.
+The **Device** data model literally represents the IoT device itself, but the `temperature` attribute also needs to be shared with the **Building** entity
 
 A `link` between them can be provisioned as shown:
 
@@ -222,8 +243,7 @@ e.g.:
   }
 ```
 
-Whenever a `temperature` measure is received **Device** is updated, and entity `urn:ngsi-ld:Building:001` is also
-updated as shown:
+Whenever a `temperature` measure is received **Device** is updated,  and entity `urn:ngsi-ld:Building:001` is also updated as shown:
 
 ```json
 "temperature": {
@@ -292,7 +312,7 @@ The library provides some plugins out of the box, in the `dataPlugins` collectio
 use the `addQueryMiddleware` and `addUpdateMiddleware` functions with the selected plugin, as in the example:
 
 ```javascript
-var iotaLib = require('iotagent-node-lib');
+var iotaLib = require("iotagent-node-lib");
 
 iotaLib.addUpdateMiddleware(iotaLib.dataPlugins.compressTimestamp.update);
 iotaLib.addQueryMiddleware(iotaLib.dataPlugins.compressTimestamp.query);
@@ -302,7 +322,7 @@ iotaLib.addQueryMiddleware(iotaLib.dataPlugins.compressTimestamp.query);
 
 This plugins change all the timestamp attributes found in the entity, and all the timestamp metadata found in any
 attribute, from the basic complete calendar timestamp of the ISO8601 (e.g.: 20071103T131805) to the extended complete
-calendar timestamp (e.g.: +002007-11-03T13:18). The middleware expects to receive the basic format in updates and return
+calendar timestamp (e.g.: `+002007-11-03T13:18`). The middleware expects to receive the basic format in updates and return
 it in queries (and viceversa, receive the extended one in queries and return it in updates).
 
 ##### Attribute Alias plugin (attributeAlias)

doc/installationguide.md

@@ -278,8 +278,8 @@ used for the same purpose. For instance:
     standard, but the final decision has yet been confirmed), take into account it could change
 -   **explicitAttrs**: if this flag is activated, only provisioned attributes will be processed to Context Broker. This
     flag is overwritten by `explicitAttrs` flag in group or device provision.
--   **defaultEntityNameConjunction**: the default conjunction string used to compose a default `entity_name` when is not 
-    provided at device provisioning time; in that case `entity_name` is composed by `type` + `:` + `device_id`. 
+-   **defaultEntityNameConjunction**: the default conjunction string used to compose a default `entity_name` when is not
+    provided at device provisioning time; in that case `entity_name` is composed by `type` + `:` + `device_id`.
     Default value is `:`. This value is overwritten by `defaultEntityNameConjunction` in group provision.
 -   **relaxTemplateValidation**: if this flag is activated, `objectId` attributes for incoming devices are not
     validated, and may exceptionally include characters (such as semi-colons) which are

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

@@ -238,7 +238,8 @@ function createInitialEntityNgsi2(deviceData, newDevice, callback) {
     for (const att in options.json) {
         try {
             // Format any GeoJSON attrs properly
-            options.json[att] = NGSIv2.formatGeoAttrs(options.json[att]);
+            const attrInfo = _.findWhere(deviceData.active, {name: att})
+            options.json[att] = NGSIv2.formatGeoAttrs(options.json[att], attrInfo);
         } catch (error) {
             return callback(new errors.BadGeocoordinates(JSON.stringify(options.json)));
         }
@@ -296,7 +297,8 @@ function updateEntityNgsi2(deviceData, updatedDevice, callback) {
     for (const att in options.json) {
         try {
             // Format any GeoJSON attrs properly
-            options.json[att] = NGSIv2.formatGeoAttrs(options.json[att]);
+            const attrInfo = _.findWhere(deviceData.active, {name: att});
+            options.json[att] = NGSIv2.formatGeoAttrs(options.json[att], attrInfo);
         } catch (error) {
             return callback(new errors.BadGeocoordinates(JSON.stringify(options.json)));
         }

lib/services/ngsi/entities-NGSI-v2.js

@@ -27,6 +27,7 @@
 
 /* eslint-disable consistent-return */
 
+const _ = require('underscore');
 const request = require('request');
 const statsService = require('./../stats/statsRegistry');
 const async = require('async');
@@ -49,45 +50,51 @@ const context = {
  * @param      {Object}   attr       Attribute to be analyzed
  * @return     {Object}              GeoJSON version of the attribute
  */
-function formatGeoAttrs(attr) {
+function formatGeoAttrs(attr , attrInfo) {
+
+
     const obj = attr;
+
     if (attr.type) {
-        switch (attr.type.toLowerCase()) {
+        if (attr.value && attrInfo && attrInfo.autocastGeoJSON){
+            switch (attr.type.toLowerCase()) {
             // GeoProperties
-            case 'geo:json':
-                // FIXME: #1012
-                // case 'geoproperty':
-                // case 'point':
-                // case 'geo:point':
+            case 'geoproperty':
+            case 'point':
+            case 'geo:point':
                 obj.type = 'geo:json';
                 obj.value = NGSIUtils.getLngLats('Point', attr.value);
                 break;
-            // FIXME: #1012
-            // 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;
+            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;
+            }
+        } else if ( attr.type.toLowerCase() === 'geo:json'){
+            // cast GeoJSON by default
+            obj.type = 'geo:json';
+            obj.value = NGSIUtils.getLngLats('Point', attr.value);
         }
     }
     return obj;
@@ -442,7 +449,8 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
 
                             try {
                                 // Format any GeoJSON attrs properly
-                                options.json.entities[entity][att] = formatGeoAttrs(options.json.entities[entity][att]);
+                                const attrInfo = _.findWhere(typeInformation.active, {name: att});
+                                options.json.entities[entity][att] = formatGeoAttrs(options.json.entities[entity][att], attrInfo);
                             } catch (error) {
                                 return callback(new errors.BadGeocoordinates(JSON.stringify(options.json)));
                             }
@@ -464,7 +472,8 @@ function sendUpdateValueNgsi2(entityName, attributes, typeInformation, token, ca
 
                         try {
                             // Format any GeoJSON attrs properly
-                            options.json[att] = formatGeoAttrs(options.json[att]);
+                            const attrInfo = _.findWhere(typeInformation.active, {name: att});
+                            options.json[att] = formatGeoAttrs(options.json[att], attrInfo);
                         } catch (error) {
                             return callback(new errors.BadGeocoordinates(JSON.stringify(options.json)));
                         }

lib/templates/createDevice.json

@@ -99,6 +99,11 @@
                   "type": "string",
                   "pattern": "^([^<>();'=\"]+)+$"
                 },
+                "autocastGeoJSON": {
+                  "required": false,
+                  "description": "Whether to autocast this value as a GeoJSON type",
+                  "type": "boolean"
+                },
                 "expression": {
                   "description": "Optional expression for measurement transformation",
                   "type": "string"

lib/templates/createDeviceLax.json

@@ -97,6 +97,11 @@
                   "type": "string",
                   "pattern": "^([^<>();'=\"]+)+$"
                 },
+                "autocastGeoJSON": {
+                  "required": false,
+                  "description": "Whether to autocast this value as a GeoJSON type",
+                  "type": "boolean"
+                },
                 "expression": {
                   "description": "Optional expression for measurement transformation",
                   "type": "string",
@@ -121,7 +126,7 @@
                     "properties": {
                       "object_id": {
                         "description": "ID of the attribute in the device",
-                        "type": "string"                      
+                        "type": "string"
                       },
                       "type": {
                         "description": "Type of the attribute in the target entity",
@@ -181,4 +186,4 @@
       }
     }
   }
-}
+}

lib/templates/updateDevice.json

@@ -84,6 +84,11 @@
             "type": "string",
             "pattern": "^([^<>();'=\"]+)+$"
           },
+          "autocastGeoJSON": {
+            "required": false,
+            "description": "Whether to autocast this value as a GeoJSON type",
+            "type": "boolean"
+          },
           "expression": {
             "description": "Optional expression for measurement transformation",
             "type": "string"

lib/templates/updateDeviceLax.json

@@ -77,6 +77,11 @@
             "type": "string",
             "pattern": "^([^<>();'=\"]+)+$"
           },
+          "autocastGeoJSON": {
+            "required": false,
+            "description": "Whether to autocast this value as a GeoJSON type",
+            "type": "boolean"
+          },
           "expression": {
             "description": "Optional expression for measurement transformation",
             "type": "string",
@@ -154,4 +159,4 @@
       "type": "array"
     }
   }
-}
+}

test/unit/ngsiv2/examples/contextRequests/createBidirectionalDevice.json

@@ -2,7 +2,7 @@
   "id": "TheFirstLight",
   "type": "TheLightType",
   "location": {
-    "type": "geo:point",
-    "value": "0, 0"
+      "type": "geo:point",
+      "value": "0, 0"
   }
 }

test/unit/ngsiv2/examples/contextRequests/updateContextGeopropertiesAsString.json

@@ -0,0 +1,7 @@
+{
+    "location": {
+        "value": "23,12.5",
+        "type": "Point"
+    }
+}
+