iotagent-node-lib 2.26.0 → 3.1.0

package/lib/plugins/addEvent.js

@@ -1,32 +0,0 @@
-/*
- * Copyright 2016 Telefonica Investigación y Desarrollo, S.A.U
- *
- * This file is part of fiware-iotagent-lib
- *
- * fiware-iotagent-lib is free software: you can redistribute it and/or
- * modify it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the License,
- * or (at your option) any later version.
- *
- * fiware-iotagent-lib is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- * See the GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public
- * License along with fiware-iotagent-lib.
- * If not, see http://www.gnu.org/licenses/.
- *
- * For those usages not covered by the GNU Affero General Public License
- * please contact with::daniel.moranjimenez@telefonica.com
- */
-
-const pluginUtils = require('./pluginUtils');
-const config = require('../commonConfig');
-
-function addEvents() {
-    return new Date().toISOString();
-}
-
-exports.update = pluginUtils.createUpdateFilter(addEvents, config.getConfig().eventType || 'Event');
-exports.query = pluginUtils.identityFilter;

package/lib/plugins/attributeAlias.js

@@ -1,107 +0,0 @@
-/*
- * Copyright 2015 Telefonica Investigación y Desarrollo, S.A.U
- *
- * This file is part of fiware-iotagent-lib
- *
- * fiware-iotagent-lib is free software: you can redistribute it and/or
- * modify it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the License,
- * or (at your option) any later version.
- *
- * fiware-iotagent-lib is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- * See the GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public
- * License along with fiware-iotagent-lib.
- * If not, see http://www.gnu.org/licenses/.
- *
- * For those usages not covered by the GNU Affero General Public License
- * please contact with::daniel.moranjimenez@telefonica.com
- *
- * Modified by: Daniel Calvo - ATOS Research & Innovation
- */
-
-const utils = require('./pluginUtils');
-/* eslint-disable no-unused-vars */
-const logger = require('logops');
-const context = {
-    op: 'IoTAgentNGSI.attributeAlias'
-};
-const ngsiUtils = require('../services/ngsi/ngsiUtils');
-
-function extractSingleMapping(previous, current) {
-    /* jshint camelcase: false */
-    previous.direct[current.object_id] = current.name;
-    previous.types[current.object_id] = current.type;
-    previous.metadata[current.object_id] = current.metadata;
-    previous.inverse[current.name] = current.object_id; // collision using multientity
-    return previous;
-}
-
-/**
- * Extract all the alias information for the attributes from the provisioning information provided for a device.
- *
- * @param {Object} typeInformation          Provisioning information about the device represented by the entity.
- * @return {{direct: {}, inverse: {}}}      Object containing the direct and reverse name mappings.
- */
-function extractAllMappings(typeInformation) {
-    let mappings = { direct: {}, inverse: {}, types: {}, metadata: {} };
-
-    if (typeInformation.active) {
-        mappings = typeInformation.active.reduce(extractSingleMapping, mappings);
-    }
-
-    if (typeInformation.lazy) {
-        mappings = typeInformation.lazy.reduce(extractSingleMapping, mappings);
-    }
-
-    if (typeInformation.commands) {
-        mappings = typeInformation.commands.reduce(extractSingleMapping, mappings);
-    }
-    return mappings;
-}
-
-/**
- * Create a map function to apply a set of mappings to a vector of attributes.
- *
- * @param {Object} mappings             Mappings to be applied.
- * @return {aliasApplier}               Map function that will apply the mappings to collections of objects.
- */
-function applyAlias(mappings) {
-    return function aliasApplier(attribute) {
-        if (mappings.direct[attribute.name]) {
-            attribute.object_id = attribute.name;
-            attribute.metadata = mappings.metadata[attribute.name];
-            attribute.type = mappings.types[attribute.name];
-            attribute.name = mappings.direct[attribute.name];
-        }
-        return attribute;
-    };
-}
-
-/**
- * Filter to map attribute Ids into attribute names based on provisioning information.
- *
- * @param {Object} entity                   The entity to be modified, representing the information in a device.
- * @param {Object} typeInformation          Provisioning information about the device represented by the entity.
- */
-function updateAttribute(entity, typeInformation, callback) {
-    const mappings = extractAllMappings(typeInformation);
-
-    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);
-}
-
-function queryAttribute(entity, typeInformation, callback) {
-    callback(null, entity, typeInformation);
-}
-
-exports.update = updateAttribute;
-exports.query = queryAttribute;
-exports.extractAllMappings = extractAllMappings;

package/lib/plugins/multiEntity.js

@@ -1,255 +0,0 @@
-/*
- * Copyright 2016 Telefonica Investigación y Desarrollo, S.A.U
- *
- * This file is part of fiware-iotagent-lib
- *
- * fiware-iotagent-lib is free software: you can redistribute it and/or
- * modify it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the License,
- * or (at your option) any later version.
- *
- * fiware-iotagent-lib is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- * See the GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public
- * License along with fiware-iotagent-lib.
- * If not, see http://www.gnu.org/licenses/.
- *
- * For those usages not covered by the GNU Affero General Public License
- * please contact with::daniel.moranjimenez@telefonica.com
- *
- * Modified by: Daniel Calvo - ATOS Research & Innovation
- */
-
-/* eslint-disable no-prototype-builtins */
-/* eslint-disable array-callback-return */
-
-const _ = require('underscore');
-const constants = require('../constants');
-const legacyParser = require('./expressionParser');
-const jexlParser = require('./jexlParser');
-const expressionPlugin = require('./expressionPlugin');
-/* eslint-disable-next-line  no-unused-vars */
-const logger = require('logops');
-/* eslint-disable-next-line  no-unused-vars */
-const context = {
-    op: 'IoTAgentNGSI.MultiEntityPlugin'
-};
-const utils = require('./pluginUtils');
-/* eslint-disable-next-line  no-unused-vars */
-const aliasPlugin = require('./attributeAlias');
-
-function hasEntityNameOrEntityType(item) {
-    return item.entity_name || item.entity_type;
-}
-
-/**
- * Return a list of all the attributes that don't have a multientity option. It considers NGSIv2.
- *
- * @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 filterOutMultientitiesNgsi2(originalAttrs, meAttributes) {
-    const result = {};
-    const meNamesList = _.pluck(meAttributes, 'name');
-    const meObjectsList = _.pluck(meAttributes, 'object_id');
-    let toBeFilteredByObj = [];
-
-    for (const att in originalAttrs) {
-        if (originalAttrs.hasOwnProperty(att)) {
-            if (!_.contains(meNamesList, att)) {
-                result[att] = originalAttrs[att];
-            }
-            if (originalAttrs[att].hasOwnProperty('multi')) {
-                let cleanAttributes = _.union([_.clone(originalAttrs[att])], originalAttrs[att].multi);
-                delete cleanAttributes[0].multi;
-                cleanAttributes = _.map(cleanAttributes, function (val) {
-                    val['name'] = att;
-                    return val;
-                });
-                toBeFilteredByObj = _.union(toBeFilteredByObj, cleanAttributes);
-            }
-        }
-    }
-
-    for (const att in toBeFilteredByObj) {
-        if (!_.contains(meObjectsList, toBeFilteredByObj[att].object_id)) {
-            result[toBeFilteredByObj[att].name] = toBeFilteredByObj[att];
-        }
-    }
-
-    return result;
-}
-
-/**
- * Generate new Context Elements for each new Entity, with the attributes of the original entity matching its
- * entity_name. It considers Ngsiv2.
- *
- * @param {Object} entity                   The original entity
- * @param {Array} newEntities               List of the new entities that will be generated
- * @param {Array} multiEntityAttributes     List of attributes with multientity option
- * @return {Array}                          List of the new Context Entities
- */
-function generateNewCEsNgsi2(entity, newEntities, multiEntityAttributes) {
-    const result = [];
-    let newEntityAttributes;
-    let newEntityAttributeNames;
-    let newEntityAttributeObjectIds;
-    function filterByEntityNameandType(entityNameType) {
-        return function (item) {
-            return (
-                item.entity_name === entityNameType.entity_name &&
-                (!item.entity_type || item.entity_type === entityNameType.entity_type)
-            );
-        };
-    }
-
-    function filterByAttributeObjectIds(entity, newEntityAttributeNames, newEntityAttributeObjectIds) {
-        const result = {};
-        for (const att in entity) {
-            if (entity.hasOwnProperty(att)) {
-                if (_.contains(newEntityAttributeNames, att)) {
-                    if (entity[att].object_id && _.contains(newEntityAttributeObjectIds, entity[att].object_id)) {
-                        result[att] = entity[att];
-                        delete entity[att].object_id;
-                    } else if (entity[att].multi) {
-                        for (const j in entity[att].multi) {
-                            if (
-                                entity[att].multi[j].object_id &&
-                                _.contains(newEntityAttributeObjectIds, entity[att].multi[j].object_id)
-                            ) {
-                                result[att] = entity[att].multi[j];
-                                delete entity[att].multi[j].object_id;
-                                break; // stop in first ocurrence (#635)
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return result;
-    }
-
-    for (let i = 0; i < newEntities.length; i++) {
-        newEntityAttributeNames = _.pluck(
-            multiEntityAttributes.filter(filterByEntityNameandType(newEntities[i])),
-            'name'
-        );
-        newEntityAttributeObjectIds = _.pluck(
-            multiEntityAttributes.filter(filterByEntityNameandType(newEntities[i])),
-            'object_id'
-        );
-        newEntityAttributes = filterByAttributeObjectIds(entity, newEntityAttributeNames, newEntityAttributeObjectIds);
-        newEntityAttributes.type = newEntities[i].entity_type;
-        newEntityAttributes.id = newEntities[i].entity_name;
-        result.push(newEntityAttributes);
-    }
-    return result;
-}
-
-function extractNewEntities(multiEntityAttributes, defaultType) {
-    let newEntitieswithDuplicates = multiEntityAttributes.map((elem) => {
-        return { entity_name: elem.entity_name, entity_type: elem.entity_type || defaultType };
-    });
-    let auxOverwriteTree = {};
-    for (let entityItem in newEntitieswithDuplicates) {
-        if (!auxOverwriteTree[newEntitieswithDuplicates[entityItem].entity_name]) {
-            auxOverwriteTree[newEntitieswithDuplicates[entityItem].entity_name] = {};
-        }
-        auxOverwriteTree[newEntitieswithDuplicates[entityItem].entity_name][
-            newEntitieswithDuplicates[entityItem].entity_type
-        ] = null;
-    }
-    let flatNewEntities = [];
-    for (let entityItem in auxOverwriteTree) {
-        for (let typeItem in auxOverwriteTree[entityItem]) {
-            flatNewEntities.push({ entity_name: entityItem, entity_type: typeItem });
-        }
-    }
-    return flatNewEntities;
-}
-/**
- * Propagates the same timestamp used in entity to entities. This is needed given that timestamp processing
- * plugin runs before multientity plugin, so we could have issues as the one described here:
- * https://github.com/telefonicaid/iotagent-node-lib/issues/748
- *
- * Note that this kind of timestamp propagation only works for NGSIv2. That is intentional: NGSIv1 is
- * deprecated so we don't want to spend effort on it.
- *
- * @param entity entity which is the source of timestamp
- * @param entities array to adjust
- *
- */
-function propagateTimestamp(entity, entities) {
-    const ts = entity[constants.TIMESTAMP_ATTRIBUTE];
-    if (!ts) {
-        return;
-    }
-
-    entities.map(function (en) {
-        let att;
-        // Set timestamp metadata in attributes (except TimeInstant attribute itself)
-        for (att in en && att !== constants.TIMESTAMP_ATTRIBUTE) {
-            if (en.hasOwnProperty(att) && att !== 'id' && att !== 'type') {
-                if (!en[att].metadata) {
-                    en[att].metadata = {};
-                }
-                en[att].metadata[constants.TIMESTAMP_ATTRIBUTE] = ts;
-            }
-        }
-        // Set timestamp attribute inm the entity itself
-        en[constants.TIMESTAMP_ATTRIBUTE] = ts;
-    });
-}
-
-function updateAttribute(entity, typeInformation, callback) {
-    try {
-        logger.debug(context, 'multiEntityPlugin entity %j', entity);
-        let parser = jexlParser;
-        if (!expressionPlugin.checkJexl(typeInformation)) {
-            parser = legacyParser;
-        }
-        // The context for the JEXL expression should be the ID, TYPE, S, SS
-        let attrList = utils.getIdTypeServSubServiceFromDevice(typeInformation);
-        const attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
-        attrList = attrList.concat(attsArray);
-        const ctx = parser.extractContext(attrList);
-        let entities = [entity];
-        if (typeInformation.active) {
-            const multiEntityAttributes = typeInformation.active.filter(hasEntityNameOrEntityType);
-            for (let i in multiEntityAttributes) {
-                if (!multiEntityAttributes[i].entity_name) {
-                    // Then hasEntityType and entity_name should be device.name
-                    multiEntityAttributes[i].entity_name = typeInformation.name;
-                }
-                if (parser.contextAvailable(multiEntityAttributes[i].entity_name, ctx)) {
-                    let entityName = parser.applyExpression(multiEntityAttributes[i].entity_name, ctx, typeInformation);
-                    // An entity_name could not be null, but a result or expression could be null
-                    if (entityName !== null) {
-                        multiEntityAttributes[i].entity_name = entityName;
-                    }
-                }
-            }
-            const newEntities = extractNewEntities(multiEntityAttributes, typeInformation.type);
-
-            if (multiEntityAttributes.length > 0) {
-                let resultAttributes = filterOutMultientitiesNgsi2(entity, multiEntityAttributes);
-                const newCes = generateNewCEsNgsi2(entity, newEntities, multiEntityAttributes);
-                entities = [resultAttributes].concat(newCes);
-                propagateTimestamp(entity, entities);
-            } else {
-                entities = entity;
-            }
-        }
-        callback(null, entities, typeInformation);
-    } catch (e) {
-        logger.info(context, 'multiEntityPlugin error %j procesing entity %j', e, entity);
-        callback(e);
-        return;
-    }
-}
-
-exports.update = updateAttribute;

package/lib/plugins/timestampProcessPlugin.js

@@ -1,95 +0,0 @@
-/*
- * Copyright 2016 Telefonica Investigación y Desarrollo, S.A.U
- *
- * This file is part of fiware-iotagent-lib
- *
- * fiware-iotagent-lib is free software: you can redistribute it and/or
- * modify it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the License,
- * or (at your option) any later version.
- *
- * fiware-iotagent-lib is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- * See the GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public
- * License along with fiware-iotagent-lib.
- * If not, see http://www.gnu.org/licenses/.
- *
- * For those usages not covered by the GNU Affero General Public License
- * please contact with::daniel.moranjimenez@telefonica.com
- *
- * Modified by: Daniel Calvo - ATOS Research & Innovation
- */
-
-/* eslint-disable no-prototype-builtins */
-
-const errors = require('../errors');
-const constants = require('../constants');
-const logger = require('logops');
-const context = {
-    op: 'IoTAgentNGSI.TimestampProcessPlugin'
-};
-const utils = require('./pluginUtils');
-
-/**
- * Looks for Thinking Thing modules and parses them, updating the entity (NGSIv2) with the transformed value.
- *
- * @param {Object} entity           NGSI Entity as it would have been sent before the plugin.
- */
-function updatePluginNgsi2(entity, entityType, callback) {
-    let timestamp;
-
-    function insertMetadata(element) {
-        if (element.name !== constants.TIMESTAMP_ATTRIBUTE) {
-            const metadata = element.metadata || {};
-            metadata[constants.TIMESTAMP_ATTRIBUTE] = {
-                type: constants.TIMESTAMP_TYPE_NGSI2,
-                value: timestamp.value
-            };
-            element.metadata = metadata;
-        }
-
-        return element;
-    }
-
-    function updateSingleEntity(entity) {
-        let attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
-
-        if (entity && entity[constants.TIMESTAMP_ATTRIBUTE]) {
-            if (entity.hasOwnProperty(constants.TIMESTAMP_ATTRIBUTE)) {
-                timestamp = entity[constants.TIMESTAMP_ATTRIBUTE];
-            }
-        } else if (!entity) {
-            logger.error(context, 'Bad payload received while processing timestamps');
-            callback(new errors.WrongSyntax(entity));
-        }
-
-        if (timestamp) {
-            attsArray = attsArray.map(insertMetadata);
-        }
-        timestamp = false; // reset for possible next entity
-        entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray);
-        return entity;
-    }
-
-    if (entity instanceof Array) {
-        const results = entity.map(updateSingleEntity);
-        callback(null, results, entityType);
-    } else {
-        const newEntity = updateSingleEntity(entity);
-        callback(null, newEntity, entityType);
-    }
-}
-
-/**
- * Looks for Thinking Thing modules and parses them, updating the entity with the transformed value.
- *
- * @param {Object} entity           NGSI Entity as it would have been sent before the plugin.
- */
-function updatePlugin(entity, entityType, callback) {
-    updatePluginNgsi2(entity, entityType, callback);
-}
-
-exports.update = updatePlugin;

package/test/unit/ngsi-ld/plugins/event-plugin_test.js

@@ -1,116 +0,0 @@
-/*
- * Copyright 2020 Telefonica Investigación y Desarrollo, S.A.U
- *
- * This file is part of fiware-iotagent-lib
- *
- * fiware-iotagent-lib is free software: you can redistribute it and/or
- * modify it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the License,
- * or (at your option) any later version.
- *
- * fiware-iotagent-lib is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- * See the GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public
- * License along with fiware-iotagent-lib.
- * If not, see http://www.gnu.org/licenses/.
- *
- * For those usages not covered by the GNU Affero General Public License
- * please contact with::daniel.moranjimenez@telefonica.com
- *
- * Modified by: Jason Fox - FIWARE Foundation
- */
-
-const iotAgentLib = require('../../../../lib/fiware-iotagent-lib');
-const should = require('should');
-const logger = require('logops');
-const nock = require('nock');
-let contextBrokerMock;
-const iotAgentConfig = {
-    contextBroker: {
-        host: '192.168.1.1',
-        port: '1026',
-        ngsiVersion: 'ld',
-        jsonLdContext: 'http://context.json-ld'
-    },
-    server: {
-        port: 4041
-    },
-    types: {
-        Light: {
-            commands: [],
-            type: 'Light',
-            lazy: [
-                {
-                    name: 'temperature',
-                    type: 'centigrades'
-                }
-            ],
-            active: [
-                {
-                    name: 'pressure',
-                    type: 'Hgmm'
-                }
-            ]
-        }
-    },
-    service: 'smartgondor',
-    subservice: 'gardens',
-    providerUrl: 'http://smartgondor.com'
-};
-
-describe('NGSI-LD - Event plugin', function () {
-    beforeEach(function (done) {
-        logger.setLevel('FATAL');
-
-        iotAgentLib.activate(iotAgentConfig, function () {
-            iotAgentLib.clearAll(function () {
-                iotAgentLib.addUpdateMiddleware(iotAgentLib.dataPlugins.addEvents.update);
-                iotAgentLib.addQueryMiddleware(iotAgentLib.dataPlugins.addEvents.query);
-                done();
-            });
-        });
-    });
-
-    afterEach(function (done) {
-        iotAgentLib.clearAll(function () {
-            iotAgentLib.deactivate(done);
-        });
-    });
-    describe('When an update comes with an event to the plugin', function () {
-        const values = [
-            {
-                name: 'state',
-                type: 'Boolean',
-                value: 'true'
-            },
-            {
-                name: 'activation',
-                type: 'Event',
-                value: '1'
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post('/ngsi-ld/v1/entityOperations/upsert/?options=update', function (body) {
-                    const dateRegex = /\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z/;
-                    return body[0].activation.value['@value'].match(dateRegex);
-                })
-                .reply(204);
-        });
-
-        it('should return an entity with all its timestamps expanded to have separators', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-});