Add mixed mode

Author: jason-fox

doc/api.md

@@ -29,7 +29,8 @@ These are the parameters that can be configured in the global section:
     ngsiVersion: 'v2'
 }
 ```
--   If you want to use NGSI-LD (experimental):
+
+-   If you want to use **NGSI-LD** (experimental):
 
 ```javascript
 {
@@ -40,8 +41,20 @@ These are the parameters that can be configured in the global section:
 }
 ```
 
-Where `http://context.json-ld` is the location of the NGSI-LD `@context` element which provides additional information allowing the computer to
-interpret the rest of the data with more clarity and depth. Read the [JSON-LD specification](https://w3c.github.io/json-ld-syntax/#the-context) for more informtaion.
+-   If you want to support a "mixed" mode with both **NGSI-v2** and **NGSI-LD** (experimental):
+
+```javascript
+{
+    host: '192.168.56.101',
+    port: '1026',
+    ngsiVersion: 'mixed',
+    jsonLdContext: 'http://context.json-ld' // or ['http://context1.json-ld','http://context2.json-ld'] if you need more than one
+}
+```
+
+Where `http://context.json-ld` is the location of the NGSI-LD `@context` element which provides additional information
+allowing the computer to interpret the rest of the data with more clarity and depth. Read the
+[JSON-LD specification](https://w3c.github.io/json-ld-syntax/#the-context) for more informtaion.
 
 -   **server**: configuration used to create the Context Server (port where the IoT Agent will be listening as a Context
     Provider and base root to prefix all the paths). The `port` attribute is required. If no `baseRoot` attribute is

doc/installationguide.md

@@ -244,7 +244,7 @@ function processEnvironmentVariables() {
 
     if (process.env.IOTA_CB_NGSI_VERSION) {
         config.contextBroker.ngsiVersion = process.env.IOTA_CB_NGSI_VERSION;
-    }
+    }    
 
     if (process.env.IOTA_JSON_LD_CONTEXT){
         config.contextBroker.jsonLdContext = process.env.IOTA_JSON_LD_CONTEXT.split(',').map(ctx => ctx.trim());
@@ -522,37 +522,41 @@ function getCommandRegistry() {
 }
 
 /**
- * It checks if the configuration file states the use of NGSIv2
+ * Returns the supported NGSI format
  *
- * @return     {boolean}  Result of the checking
+ * @return     {string}  the supported NGSI format
  */
-function checkNgsi2() {
-    if (
-        config.contextBroker &&
-        config.contextBroker.ngsiVersion &&
-        config.contextBroker.ngsiVersion === 'v2'
-    ) {
-        return true;
+function ngsiVersion() {
+    if (config && config.contextBroker && config.contextBroker.ngsiVersion) {
+        return config.contextBroker.ngsiVersion.toLowerCase();
     }
-
-    return false;
+    return 'unknown';
 }
 
 /**
- * It checks if the configuration file states the use of NGSI-LD
+ * It checks if the configuration file states a non-legacy format,
+ * either v2, LD or mixed.
  *
  * @return     {boolean}  Result of the checking
  */
-function checkNgsiLD() {
-    if (
-        config.contextBroker &&
-        config.contextBroker.ngsiVersion &&
-        config.contextBroker.ngsiVersion === 'ld') {
-        return true;
+function isCurrentNgsi() {
+    if (config.contextBroker && config.contextBroker.ngsiVersion) {
+        const version = config.contextBroker.ngsiVersion.toLowerCase();
+        return (version === 'v2' || version === 'ld' ||  version === 'mixed');
     }
-
     return false;
 }
+/**
+ * It checks if a combination of typeInformation or common Config is LD
+ *
+ * @return     {boolean}  Result of the checking
+ */
+function checkNgsiLD(typeInformation){
+    const format  = typeInformation.ngsiVersion || ngsiVersion();  
+    return (format.toLowerCase() === 'ld');
+}
+
+
 function setSecurityService(newSecurityService) {
     securityService = newSecurityService;
 }
@@ -570,8 +574,9 @@ exports.setGroupRegistry = setGroupRegistry;
 exports.getGroupRegistry = getGroupRegistry;
 exports.setCommandRegistry = setCommandRegistry;
 exports.getCommandRegistry = getCommandRegistry;
-exports.checkNgsi2 = checkNgsi2;
+exports.ngsiVersion = ngsiVersion;
 exports.checkNgsiLD = checkNgsiLD;
+exports.isCurrentNgsi = isCurrentNgsi;
 exports.setSecurityService = setSecurityService;
 exports.getSecurityService = getSecurityService;
 exports.getSecretData = getSecretData;

lib/commonConfig.js

@@ -29,7 +29,6 @@ var async = require('async'),
     intoTrans = require('./services/common/domain').intoTrans,
     middlewares = require('./services/common/genericMiddleware'),
     db = require('./model/dbConn'),
-    ngsiService = require('./services/ngsi/ngsiService'),
     subscriptions = require('./services/ngsi/subscriptionService'),
     statsRegistry = require('./services/stats/statsRegistry'),
     domainUtils = require('./services/common/domain'),
@@ -183,7 +182,7 @@ function doActivate(newConfig, callback) {
     deviceService.init();
     subscriptions.init();
     contextServer.init();
-    ngsiService.init();
+    ngsi.init();
 
     commands.start();
 

lib/fiware-iotagent-lib.js

@@ -50,7 +50,8 @@ var Device = new Schema({
     internalAttributes: Object,
     autoprovision: Boolean,
     expressionLanguage: String,
-    explicitAttrs: Boolean
+    explicitAttrs: Boolean,
+    ngsiVersion: String
 });
 
 function load(db) {

lib/model/Device.js

@@ -44,7 +44,8 @@ var Group = new Schema({
     internalAttributes: Array,
     autoprovision: Boolean,
     expressionLanguage: String,
-    explicitAttrs: Boolean
+    explicitAttrs: Boolean,
+    ngsiVersion: String
 });
 
 function load(db) {

lib/model/Group.js

@@ -76,7 +76,7 @@ function extractAllMappings(typeInformation) {
 function applyAlias(mappings) {
     return function aliasApplier(attribute) {
         if (mappings.direct[attribute.name]) {
-            if (config.checkNgsi2() || config.checkNgsiLD()) {
+            if (config.isCurrentNgsi()) {
                 /*jshint camelcase: false */
                 attribute.object_id = attribute.name; // inverse not usefull due to collision
             }
@@ -96,7 +96,7 @@ function applyAlias(mappings) {
  */
 function updateAttribute(entity, typeInformation, callback) {
     var mappings = extractAllMappings(typeInformation);
-    if (config.checkNgsi2() || config.checkNgsiLD()) {
+    if (config.isCurrentNgsi()) {
         var attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
         attsArray = attsArray.map(applyAlias(mappings));
         entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);

lib/plugins/attributeAlias.js

@@ -134,7 +134,7 @@ function sendSubscriptions(device, attributeList, callback) {
 
     logger.debug(context, 'Sending bidirectionality subscriptions for device [%s]', device.id);
 
-    if (config.checkNgsi2() || config.checkNgsiLD()) {
+    if (config.isCurrentNgsi()) {
         async.map(attributeList, sendSingleSubscriptionNgsi2, callback);
     } else {
         async.map(attributeList, sendSingleSubscriptionNgsi1, callback);

lib/plugins/bidirectionalData.js

@@ -177,7 +177,7 @@ function expressionApplier(context, typeInformation) {
         };
 
         /*jshint camelcase: false */
-        if ((config.checkNgsi2() || config.checkNgsiLD()) && attribute.object_id) {
+        if ((config.isCurrentNgsi()) && attribute.object_id) {
             newAttribute.object_id = attribute.object_id;
         }
 

lib/plugins/expressionParser.js

@@ -114,7 +114,7 @@ function update(entity, typeInformation, callback) {
     }
 
     try {
-        if (config.checkNgsi2() || config.checkNgsiLD()) {
+        if (config.isCurrentNgsi()) {
             var attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
             attsArray = processEntityUpdateNgsi2(attsArray);
             entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);