iotagent-node-lib 2.17.0 → 2.20.0

package/lib/services/ngsi/entities-NGSI-v1.js

@@ -1,299 +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: Federico M. Facca - Martel Innovate
- * Modified by: Daniel Calvo - ATOS Research & Innovation
- * Modified by: Jason Fox - FIWARE Foundation
- */
-
-const request = require('request');
-const statsService = require('./../stats/statsRegistry');
-const async = require('async');
-const apply = async.apply;
-const alarms = require('../common/alarmManagement');
-const errors = require('../../errors');
-const utils = require('../northBound/restUtils');
-const config = require('../../commonConfig');
-const constants = require('../../constants');
-const moment = require('moment-timezone');
-const logger = require('logops');
-const context = {
-    op: 'IoTAgentNGSI.Entities-v1'
-};
-const ngsiUtils = require('./ngsiUtils');
-
-/**
- * Generate an operation handler for NGSI-based operations (query and update). The handler takes care of identifiying
- * the errors and calling the appropriate callback with a success or a failure depending on how the operation ended.
- *
- * Most of the parameters are passed for debugging purposes mainly.
- *
- * @param {String} operationName        Name of the NGSI operation being performed.
- * @param {String} entityName           Name of the entity that was the target of the operation.
- * @param {Object} typeInformation      Information about the device the entity represents.
- * @param {String} token                Security token used to access the entity.
- * @param {Object} options              Object holding all the information about the HTTP request.
-
- * @return {Function}                  The generated handler.
- */
-function generateNGSIOperationHandler(operationName, entityName, typeInformation, token, options, callback) {
-    return function (error, response, body) {
-        if (error) {
-            logger.error(context, 'Error found executing ' + operationName + ' action in Context Broker: %s', error);
-
-            alarms.raise(constants.ORION_ALARM, error);
-            callback(error);
-        } else if (body && body.orionError) {
-            logger.debug(
-                context,
-                'Orion error found executing ' + operationName + ' action in Context Broker: %j',
-                body.orionError
-            );
-
-            callback(new errors.BadRequest(body.orionError.details));
-        } else if (response && body && response.statusCode === 200) {
-            const errorField = ngsiUtils.getErrorField(body);
-
-            logger.debug(
-                context,
-                'Received the following request from the CB:\n\n%s\n\n',
-                JSON.stringify(body, null, 4)
-            );
-
-            if (errorField) {
-                logger.error(
-                    context,
-                    'Operation ' + operationName + ' error connecting to the Context Broker: %j',
-                    errorField
-                );
-
-                if (
-                    errorField.code &&
-                    errorField.code === '404' &&
-                    errorField.details &&
-                    errorField.details.includes(typeInformation.type)
-                ) {
-                    callback(new errors.DeviceNotFound(entityName));
-                } else if (errorField.code && errorField.code === '404') {
-                    callback(new errors.AttributeNotFound());
-                } else {
-                    callback(new errors.EntityGenericError(entityName, typeInformation.type, errorField));
-                }
-            } else {
-                logger.debug(context, 'Value updated successfully');
-                alarms.release(constants.ORION_ALARM);
-                callback(null, body);
-            }
-        } else if (response && (response.statusCode === 403 || response.statusCode === 401)) {
-            logger.debug(context, 'Access forbidden executing ' + operationName + ' operation');
-            callback(
-                new errors.AccessForbidden(
-                    token,
-                    options.headers['fiware-service'],
-                    options.headers['fiware-servicepath']
-                )
-            );
-        } else {
-            logger.debug(context, 'Unknown error executing ' + operationName + ' operation');
-
-            callback(
-                new errors.EntityGenericError(
-                    entityName,
-                    typeInformation.type,
-                    {
-                        details: body
-                    },
-                    response.statusCode
-                )
-            );
-        }
-    };
-}
-
-function addTimestamp(payload, timezone) {
-    const timestamp = {
-        name: constants.TIMESTAMP_ATTRIBUTE,
-        type: constants.TIMESTAMP_TYPE
-    };
-
-    if (!timezone) {
-        timestamp.value = new Date().toISOString();
-    } else {
-        timestamp.value = moment().tz(timezone).format('YYYY-MM-DD[T]HH:mm:ss.SSSZ');
-    }
-
-    function addMetadata(attribute) {
-        let timestampFound = false;
-
-        if (!attribute.metadatas) {
-            attribute.metadatas = [];
-        }
-
-        for (let i = 0; i < attribute.metadatas.length; i++) {
-            if (
-                attribute.metadatas[i].type === constants.TIMESTAMP_TYPE &&
-                attribute.metadatas[i].name === constants.TIMESTAMP_ATTRIBUTE
-            ) {
-                attribute.metadatas[i].value = timestamp.value;
-                timestampFound = true;
-                break;
-            }
-        }
-
-        if (!timestampFound) {
-            attribute.metadatas.push(timestamp);
-        }
-
-        return attribute;
-    }
-
-    payload.contextElements[0].attributes.map(addMetadata);
-    payload.contextElements[0].attributes.push(timestamp);
-    return payload;
-}
-
-/**
- * Makes a query to the Device's entity in the context broker using NGSIv1, with the list of
- * attributes given by the 'attributes' array.
- *
- * @param {String} entityName       Name of the entity to query.
- * @param {Array} attributes        Attribute array containing the names of the attributes to query.
- * @param {Object} typeInformation  Configuration information for the device.
- * @param {String} token            User token to identify against the PEP Proxies (optional).
- */
-function sendQueryValueNgsi1(entityName, attributes, typeInformation, token, callback) {
-    const options = ngsiUtils.createRequestObject('/v1/queryContext', typeInformation, token);
-
-    if (!typeInformation || !typeInformation.type) {
-        callback(new errors.TypeNotFound(null, entityName));
-        return;
-    }
-
-    options.json = {
-        entities: [
-            {
-                type: typeInformation.type,
-                isPattern: 'false',
-                id: entityName
-            }
-        ],
-        attributes
-    };
-
-    logger.debug(context, 'Querying values of the device in the Context Broker at [%s]', options.url);
-    logger.debug(context, 'Using the following request:\n\n%s\n\n', JSON.stringify(options, null, 4));
-
-    request(
-        options,
-        generateNGSIOperationHandler('query', entityName, typeInformation, token, options, function (error, result) {
-            if (error) {
-                callback(error);
-            } else {
-                ngsiUtils.applyMiddlewares(ngsiUtils.queryMiddleware, result, typeInformation, callback);
-            }
-        })
-    );
-}
-
-/**
- * Makes an update in the Device's entity in the context broker, with the values given in the 'attributes' array. This
- * array should comply to the NGSIv1's attribute format.
- *
- * @param {String} entityName       Name of the entity to register.
- * @param {Array} attributes        Attribute array containing the values to update.
- * @param {Object} typeInformation  Configuration information for the device.
- * @param {String} token            User token to identify against the PEP Proxies (optional).
- */
-function sendUpdateValueNgsi1(entityName, attributes, typeInformation, token, callback) {
-    const options = ngsiUtils.createRequestObject('/v1/updateContext', typeInformation, token);
-
-    if (typeInformation && typeInformation.staticAttributes) {
-        attributes = attributes.concat(typeInformation.staticAttributes);
-    }
-
-    if (!typeInformation || !typeInformation.type) {
-        callback(new errors.TypeNotFound(null, entityName));
-        return;
-    }
-
-    const payload = {
-        contextElements: [
-            {
-                type: typeInformation.type,
-                isPattern: 'false',
-                id: entityName,
-                attributes
-            }
-        ]
-    };
-    if (config.getConfig().appendMode === true) {
-        payload.updateAction = 'APPEND';
-    } else {
-        payload.updateAction = 'UPDATE';
-    }
-    async.waterfall(
-        [
-            apply(statsService.add, 'measureRequests', 1),
-            apply(ngsiUtils.applyMiddlewares, ngsiUtils.updateMiddleware, payload, typeInformation)
-        ],
-        function (error, result) {
-            if (error) {
-                callback(error);
-            } else {
-                if (result) {
-                    options.json = result;
-                } else {
-                    options.json = payload;
-                }
-
-                if (
-                    'timestamp' in typeInformation && typeInformation.timestamp !== undefined
-                        ? typeInformation.timestamp
-                        : config.getConfig().timestamp
-                ) {
-                    if (!utils.isTimestamped(options.json)) {
-                        options.json = addTimestamp(options.json, typeInformation.timezone);
-                    } else if (!utils.IsValidTimestamped(options.json)) {
-                        logger.error(context, 'Invalid timestamp:%s', JSON.stringify(options.json));
-                        callback(new errors.BadTimestamp(options.json));
-                        return;
-                    }
-                }
-
-                logger.debug(context, 'Updating device value in the Context Broker at [%s]', options.url);
-                logger.debug(
-                    context,
-                    'Using the following NGSI-v1 request:\n\n%s\n\n',
-                    JSON.stringify(options, null, 4)
-                );
-
-                request(
-                    options,
-                    generateNGSIOperationHandler('update', entityName, typeInformation, token, options, callback)
-                );
-            }
-        }
-    );
-}
-
-exports.sendQueryValue = sendQueryValueNgsi1;
-exports.sendUpdateValue = sendUpdateValueNgsi1;

package/lib/services/ngsi/subscription-NGSI-v1.js

@@ -1,234 +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: Federico M. Facca - Martel Innovate
- * Modified by: Daniel Calvo - ATOS Research & Innovation
- * Modified by: Jason Fox - FIWARE Foundation
- */
-
-const errors = require('../../errors');
-const logger = require('logops');
-const config = require('../../commonConfig');
-const utils = require('../northBound/restUtils');
-const context = {
-    op: 'IoTAgentNGSI.Subscription-v1'
-};
-
-/**
- * Generate a new subscription request handler using NGSIv1, based on the device and triggers given to the function.
- *
- * @param {Object} device       Object containing all the information about a particular device.
- * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription.
- * @param {Boolean} store       If set, store the subscription result in the device. Otherwise, return the ID.
- * @param {Function} callback   Callback to be called when the subscription handler ends.
- * @return {Function}           Returns a request handler for the given data.
- */
-function createSubscriptionHandlerNgsi1(device, triggers, store, callback) {
-    return function (error, response, body) {
-        if (error || !body) {
-            logger.debug(
-                context,
-                'Transport error found subscribing device with id [%s] to entity [%s]',
-                device.id,
-                device.name
-            );
-
-            callback(error);
-        } else if (response.statusCode !== 200 && response.statusCode !== 201) {
-            logger.debug(
-                context,
-                'Unknown error subscribing device with id [%s] to entity [%s]: $s',
-                response.statusCode
-            );
-
-            callback(
-                new errors.EntityGenericError(
-                    device.name,
-                    device.type,
-                    {
-                        details: body
-                    },
-                    response.statusCode
-                )
-            );
-        } else if (body && body.orionError) {
-            logger.debug(
-                context,
-                'Orion found subscribing device with id [%s] to entity [%s]: %s',
-                device.id,
-                device.name,
-                body.orionError
-            );
-
-            callback(new errors.BadRequest(body.orionError.details));
-        } else if (store) {
-            if (!device.subscriptions) {
-                device.subscriptions = [];
-            }
-
-            device.subscriptions.push({
-                id: body.subscribeResponse.subscriptionId,
-                triggers
-            });
-
-            config.getRegistry().update(device, callback);
-        } else {
-            callback(null, body.subscribeResponse.subscriptionId);
-        }
-    };
-}
-
-/**
- * Makes a subscription for the given device's entity using NGSIv1, triggered by the given attributes.
- * The contents of the notification can be selected using the "content" array (that can be left blank
- * to notify the complete entity).
- *
- * @param {Object} device       Object containing all the information about a particular device.
- * @param {Object} triggers     Array with the names of the attributes that would trigger the subscription
- * @param {Object} content      Array with the names of the attributes to retrieve in the notification.
- */
-function subscribeNgsi1(device, triggers, content, callback) {
-    const options = {
-        method: 'POST',
-        headers: {
-            'fiware-service': device.service,
-            'fiware-servicepath': device.subservice
-        },
-        json: {
-            entities: [
-                {
-                    type: device.type,
-                    isPattern: 'false',
-                    id: device.name
-                }
-            ],
-            reference: config.getConfig().providerUrl + '/notify',
-            duration: config.getConfig().deviceRegistrationDuration || 'P100Y',
-            notifyConditions: [
-                {
-                    type: 'ONCHANGE',
-                    condValues: triggers
-                }
-            ]
-        }
-    };
-    let store = true;
-
-    if (content) {
-        options.json.attributes = content;
-        store = false;
-    }
-
-    if (device.cbHost && device.cbHost.indexOf('://') !== -1) {
-        options.uri = device.cbHost + '/v1/subscribeContext';
-    } else if (device.cbHost && device.cbHost.indexOf('://') === -1) {
-        options.uri = 'http://' + device.cbHost + '/v1/subscribeContext';
-    } else {
-        options.uri = config.getConfig().contextBroker.url + '/v1/subscribeContext';
-    }
-    utils.executeWithSecurity(options, device, createSubscriptionHandlerNgsi1(device, triggers, store, callback));
-}
-
-/**
- * Generate a new unsubscription request handler using NGSIv1, based on the device and subscription ID
- * given to the function.
- *
- * @param {Object} device       Object containing all the information about a particular device.
- * @param {String} id           ID of the subscription to remove.
- * @param {Function} callback   Callback to be called when the subscription handler ends.
- * @return {Function}           Returns a request handler for the given data.
- */
-function createUnsubscribeHandlerNgsi1(device, id, callback) {
-    return function (error, response, body) {
-        if (error || !body) {
-            logger.debug(
-                context,
-                'Transport error found subscribing device with id [%s] to entity [%s]',
-                device.id,
-                device.name
-            );
-
-            callback(error);
-        } else if (response.statusCode !== 200 && response.statusCode !== 201) {
-            logger.debug(
-                context,
-                'Unknown error subscribing device with id [%s] to entity [%s]: $s',
-                response.statusCode
-            );
-
-            callback(
-                new errors.EntityGenericError(
-                    device.name,
-                    device.type,
-                    {
-                        details: body
-                    },
-                    response.statusCode
-                )
-            );
-        } else if (body && body.orionError) {
-            logger.debug(
-                context,
-                'Orion found subscribing device with id [%s] to entity [%s]: %s',
-                device.id,
-                device.name,
-                body.orionError
-            );
-
-            callback(new errors.BadRequest(body.orionError.details));
-        } else {
-            device.subscriptions.splice(device.subscriptions.indexOf(id), 1);
-            config.getRegistry().update(device, callback);
-        }
-    };
-}
-
-/**
- * Remove the subscription with the given ID from the Context Broker and from the device repository using NGSIv1.
- *
- * @param {Object} device       Object containing all the information about a particular device.
- * @param {String} id           ID of the subscription to remove.
- */
-function unsubscribeNgsi1(device, id, callback) {
-    const options = {
-        method: 'POST',
-        headers: {
-            'fiware-service': device.service,
-            'fiware-servicepath': device.subservice
-        },
-        json: {
-            subscriptionId: id
-        }
-    };
-
-    if (device.cbHost && device.cbHost.indexOf('://') !== -1) {
-        options.uri = device.cbHost + '/v1/unsubscribeContext';
-    } else if (device.cbHost && device.cbHost.indexOf('://') === -1) {
-        options.uri = 'http://' + device.cbHost + '/v1/unsubscribeContext';
-    } else {
-        options.uri = config.getConfig().contextBroker.url + '/v1/unsubscribeContext';
-    }
-    utils.executeWithSecurity(options, device, createUnsubscribeHandlerNgsi1(device, id, callback));
-}
-
-exports.subscribe = subscribeNgsi1;
-exports.unsubscribe = unsubscribeNgsi1;