Merge pull request #995 from jason-fox/feature/ngsi-v1

Fix #966 - Remove Legacy NGSI-v1 from codebase

Author: fgalan

CHANGES_NEXT_RELEASE

@@ -1,3 +1,4 @@
+- Remove: NGSI-v1 implementation (#966)
 - FIx: export fillDomains function to iotagent-node-lib available functions (needed to fix logs in iotagent-json#587 and iotagent-ul#508)
 - Fix: keep internalAttributes stored in device mongo collection when update it (#1092)
 - Add: new JEXL get TimeZone Offset (valid for summer winter schedulles) and binary shifting for bitwise operator

lib/commonConfig.js

@@ -525,19 +525,7 @@ function ngsiVersion() {
     return 'unknown';
 }
 
-/**
- * It checks if the configuration file states a non-legacy format,
- * either v2, LD or mixed.
- *
- * @return     {boolean}  Result of the checking
- */
-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
  *
@@ -566,7 +554,6 @@ exports.setCommandRegistry = setCommandRegistry;
 exports.getCommandRegistry = getCommandRegistry;
 exports.ngsiVersion = ngsiVersion;
 exports.checkNgsiLD = checkNgsiLD;
-exports.isCurrentNgsi = isCurrentNgsi;
 exports.setSecurityService = setSecurityService;
 exports.getSecurityService = getSecurityService;
 exports.getSecretData = getSecretData;

lib/errors.js

@@ -96,13 +96,6 @@ class DeviceNotFound {
         this.code = 404;
     }
 }
-class AttributeNotFound {
-    constructor() {
-        this.name = 'ATTRIBUTE_NOT_FOUND';
-        this.message = 'Some of the attributes does not exist';
-        this.code = 404;
-    }
-}
 class DuplicateDeviceId {
     constructor(id) {
         this.name = 'DUPLICATE_DEVICE_ID';
@@ -190,13 +183,6 @@ class MissingConfigParams {
         this.code = 400;
     }
 }
-class NotificationError {
-    constructor(code) {
-        this.name = 'NOTIFICATION_ERROR';
-        this.message = 'Incoming notification with non-200 status code: ' + code;
-        this.code = 400;
-    }
-}
 class DeviceGroupNotFound {
     constructor(fields, values) {
         this.name = 'DEVICE_GROUP_NOT_FOUND';
@@ -269,7 +255,6 @@ module.exports = {
     TypeNotFound,
     MissingAttributes,
     DeviceNotFound,
-    AttributeNotFound,
     DuplicateDeviceId,
     DuplicateGroup,
     SecurityInformationMissing,
@@ -282,7 +267,6 @@ module.exports = {
     WrongSyntax,
     CommandNotFound,
     MissingConfigParams,
-    NotificationError,
     DeviceGroupNotFound,
     GroupNotFound,
     WrongExpressionType,

lib/plugins/attributeAlias.js

@@ -23,7 +23,6 @@
  * Modified by: Daniel Calvo - ATOS Research & Innovation
  */
 
-const config = require('../commonConfig');
 const utils = require('./pluginUtils');
 /* eslint-disable no-unused-vars */
 const logger = require('logops');
@@ -73,10 +72,7 @@ function extractAllMappings(typeInformation) {
 function applyAlias(mappings) {
     return function aliasApplier(attribute) {
         if (mappings.direct[attribute.name]) {
-            if (config.isCurrentNgsi()) {
-                /*jshint camelcase: false */
-                attribute.object_id = attribute.name; // inverse not usefull due to collision
-            }
+            attribute.object_id = attribute.name;
             attribute.metadata = mappings.metadata[attribute.name];
             attribute.type = mappings.types[attribute.name];
             attribute.name = mappings.direct[attribute.name];
@@ -93,14 +89,11 @@ function applyAlias(mappings) {
  */
 function updateAttribute(entity, typeInformation, callback) {
     const mappings = extractAllMappings(typeInformation);
-    if (config.isCurrentNgsi()) {
-        let attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
-        attsArray = attsArray.map(applyAlias(mappings));
-        entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);
-        ngsiUtils.castJsonNativeAttributes(entity);
-    } else {
-        entity.contextElements[0].attributes = entity.contextElements[0].attributes.map(applyAlias(mappings));
-    }
+
+    let attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
+    attsArray = attsArray.map(applyAlias(mappings));
+    entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);
+    ngsiUtils.castJsonNativeAttributes(entity);
 
     callback(null, entity, typeInformation);
 }

lib/plugins/bidirectionalData.js

@@ -33,7 +33,6 @@ const deviceService = require('../services/devices/deviceService');
 const context = {
     op: 'IoTAgentNGSI.BidirectionalPlugin'
 };
-const config = require('../commonConfig');
 
 /**
  * Extract a list of all the bidirectional attributes (those containing reverse expressions) from a device object.
@@ -98,21 +97,6 @@ function extractVariables(item) {
  * @param {Array} attributeList     List of active attributes for subscription.
  */
 function sendSubscriptions(device, attributeList, callback) {
-    function sendSingleSubscriptionNgsi1(item, innerCb) {
-        const variables = extractVariables(item);
-
-        subscriptions.subscribe(device, [item.name], variables, function handleSubscription(error, subId) {
-            if (error) {
-                innerCb(error);
-            } else {
-                innerCb(null, {
-                    id: subId,
-                    triggers: [item.name]
-                });
-            }
-        });
-    }
-
     function sendSingleSubscriptionNgsi2(item, innerCb) {
         const variables = extractVariables(item);
 
@@ -130,11 +114,7 @@ function sendSubscriptions(device, attributeList, callback) {
 
     logger.debug(context, 'Sending bidirectionality subscriptions for device [%s]', device.id);
 
-    if (config.isCurrentNgsi()) {
-        async.map(attributeList, sendSingleSubscriptionNgsi2, callback);
-    } else {
-        async.map(attributeList, sendSingleSubscriptionNgsi1, callback);
-    }
+    async.map(attributeList, sendSingleSubscriptionNgsi2, callback);
 }
 
 /**

lib/plugins/expressionParser.js

@@ -28,7 +28,6 @@
 const Parser = require('jison').Parser;
 const errors = require('../errors');
 const logger = require('logops');
-const config = require('../commonConfig');
 const _ = require('underscore');
 const logContext = {
     op: 'IoTAgentNGSI.Expression'
@@ -192,7 +191,7 @@ function expressionApplier(context, typeInformation) {
         };
 
         /*jshint camelcase: false */
-        if (config.isCurrentNgsi() && attribute.object_id) {
+        if (attribute.object_id) {
             newAttribute.object_id = attribute.object_id;
         }
 

lib/plugins/expressionPlugin.js

@@ -90,23 +90,6 @@ function update(entity, typeInformation, callback) {
         return false;
     }
 
-    function processEntityUpdateNgsi1(entity) {
-        let parser = legacyParser;
-        if (checkJexl(typeInformation)) {
-            parser = jexlParser;
-        }
-        let expressionAttributes = [];
-        const ctx = parser.extractContext(entity.attributes);
-
-        if (typeInformation.active) {
-            expressionAttributes = parser.processExpressionAttributes(typeInformation, typeInformation.active, ctx);
-        }
-
-        entity.attributes = mergeAttributes(entity.attributes, expressionAttributes);
-
-        return entity;
-    }
-
     function processEntityUpdateNgsi2(attributes) {
         let parser = legacyParser;
         if (checkJexl(typeInformation)) {
@@ -124,13 +107,9 @@ function update(entity, typeInformation, callback) {
     }
 
     try {
-        if (config.isCurrentNgsi()) {
-            let attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
-            attsArray = processEntityUpdateNgsi2(attsArray);
-            entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);
-        } else {
-            entity.contextElements = entity.contextElements.map(processEntityUpdateNgsi1);
-        }
+        let attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
+        attsArray = processEntityUpdateNgsi2(attsArray);
+        entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);
 
         callback(null, entity, typeInformation);
     } catch (e) {

lib/plugins/jexlParser.js

@@ -96,7 +96,7 @@ function extractContext(attributeList) {
 function applyExpression(expression, context, typeInformation) {
     const result = jexl.evalSync(expression, context);
     logger.debug(logContext, 'applyExpression "[%j]" over "[%j]" result "[%j]" ', expression, context, result);
-    let expressionResult = result !== undefined ? result : expression;
+    const expressionResult = result !== undefined ? result : expression;
     return expressionResult;
 }
 
@@ -118,7 +118,7 @@ function expressionApplier(context, typeInformation) {
         };
 
         /*jshint camelcase: false */
-        if (config.isCurrentNgsi() && attribute.object_id) {
+        if (attribute.object_id) {
             newAttribute.object_id = attribute.object_id;
         }
 

lib/plugins/multiEntity.js

@@ -69,19 +69,6 @@ function ensureEntityId(entityName, originalEntityName) {
     return entityName ? entityName : originalEntityName;
 }
 
-/**
- * Return a list of all the attributes that don't have a multientity option. It considers NGSIv1.
- *
- * @param {Array} originalAttrs        Array of original attributes coming from the single-entity device.
- * @param {Array} meAttributes         Array of all the multientity attributes.
- * @return {Array}                     List of all the attrbiutes without multientity flag.
- */
-function filterOutMultientitiesNgsi1(originalAttrs, meAttributes) {
-    return originalAttrs.filter(function (item) {
-        return !_.contains(meAttributes, item.name);
-    });
-}
-
 /**
  * Return a list of all the attributes that don't have a multientity option. It considers NGSIv2.
  *
@@ -121,59 +108,6 @@ function filterOutMultientitiesNgsi2(originalAttrs, meAttributes) {
     return result;
 }
 
-/**
- * Generate new Context Elements for each new Entity, with the attributes of the original entity matching its
- * entity_name. It considers Ngsiv1.
- *
- * @param {Object} entity                   The original entity
- * @param {Array} newEntities               List of the new entities that will be generated
- * @param {Array} entityTypes               Map of the types for each entity ID
- * @param {Object} typeInformation          Object with all the data about the device type
- * @param {Array} multiEntityAttributes     List of attributes with multientity option
- * @return {Array}                          List of the new Context Entities
- */
-function generateNewCEsNgsi1(entity, newEntities, entityTypes, typeInformation, multiEntityAttributes) {
-    const result = [];
-    let newEntityAttributes;
-    let newEntityAttributeNames;
-    let entityName;
-    let parser = legacyParser;
-    if (checkJexl(typeInformation)) {
-        parser = jexlParser;
-    }
-    function filterByEntityName(entityName) {
-        return function (item) {
-            return item.entity_name === entityName;
-        };
-    }
-
-    function filterByAttributeNames(item) {
-        return _.contains(newEntityAttributeNames, item.name);
-    }
-
-    const ctx = parser.extractContext(entity.contextElements[0].attributes);
-
-    for (let i = 0; i < newEntities.length; i++) {
-        newEntityAttributeNames = _.pluck(multiEntityAttributes.filter(filterByEntityName(newEntities[i])), 'name');
-
-        newEntityAttributes = entity.contextElements[0].attributes.filter(filterByAttributeNames);
-        // Fix duplicated attributes in entity
-        newEntityAttributes = _.uniq(newEntityAttributes, JSON.stringify);
-        if (parser.contextAvailable(newEntities[i], ctx)) {
-            entityName = parser.applyExpression(newEntities[i], ctx, typeInformation);
-        }
-
-        result.push({
-            type: entityTypes[newEntities[i]],
-            isPattern: 'false',
-            id: ensureEntityId(entityName, newEntities[i]),
-            attributes: newEntityAttributes
-        });
-    }
-
-    return result;
-}
-
 /**
  * Generate new Context Elements for each new Entity, with the attributes of the original entity matching its
  * entity_name. It considers Ngsiv2.
@@ -295,25 +229,7 @@ function propagateTimestamp(entity, entities) {
     });
 }
 
-function updateAttributeNgsi1(entity, typeInformation, callback) {
-    if (typeInformation.active) {
-        const multiEntityAttributes = typeInformation.active.filter(hasEntityName);
-        const newEntities = _.uniq(_.pluck(multiEntityAttributes, 'entity_name'));
-        const attributesList = _.pluck(multiEntityAttributes, 'name');
-        const entityTypes = extractTypes(multiEntityAttributes, entity.contextElements[0].type);
-        const resultAttributes = filterOutMultientitiesNgsi1(entity.contextElements[0].attributes, attributesList);
-
-        entity.contextElements = entity.contextElements.concat(
-            generateNewCEsNgsi1(entity, newEntities, entityTypes, typeInformation, multiEntityAttributes)
-        );
-
-        entity.contextElements[0].attributes = resultAttributes;
-    }
-
-    callback(null, entity, typeInformation);
-}
-
-function updateAttributeNgsi2(entity, typeInformation, callback) {
+function updateAttribute(entity, typeInformation, callback) {
     let entities = [];
     entities.push(entity);
     if (typeInformation.active) {
@@ -341,12 +257,4 @@ function updateAttributeNgsi2(entity, typeInformation, callback) {
     callback(null, entities, typeInformation);
 }
 
-function updateAttribute(entity, typeInformation, callback) {
-    if (config.isCurrentNgsi()) {
-        updateAttributeNgsi2(entity, typeInformation, callback);
-    } else {
-        updateAttributeNgsi1(entity, typeInformation, callback);
-    }
-}
-
 exports.update = updateAttribute;