iotagent-node-lib 2.20.0 → 2.23.0

package/docker/Mosquitto/Dockerfile

@@ -1,19 +1,35 @@
-FROM centos:7.9.2009
+ARG  IMAGE_TAG=11.3-slim
+FROM debian:${IMAGE_TAG}
 
-COPY aclfile /root/
-COPY startMosquitto.sh /bin
+ARG CLEAN_DEV_TOOLS
+ENV CLEAN_DEV_TOOLS ${CLEAN_DEV_TOOLS:-1}
 
 ENV CONGIF_FROM_ENV true
 
-RUN yum update -y && yum install -y wget \
-  && yum install -y epel-release \
-  && yum update -y epel-release \
-  && yum install -y mosquitto \
-  && cp /etc/mosquitto/mosquitto.conf /etc/mosquitto/mosquitto.conf.orig \
-  && chmod 755 /bin/startMosquitto.sh \
-  && mkdir /var/log/mosquitto \
-  && chown mosquitto:mosquitto /var/log/mosquitto \
-  && yum clean all
+COPY aclfile /root/
+COPY startMosquitto.sh /bin
+
+RUN \
+    # Install security updates
+    apt-get -y update && \
+    apt-get -y upgrade && \
+    # Install dependencies
+    apt-get -y install \
+       wget \
+       mosquitto && \
+    cp /etc/mosquitto/mosquitto.conf /etc/mosquitto/mosquitto.conf.orig && \
+    chmod 755 /bin/startMosquitto.sh && \
+    mkdir -p /var/log/mosquitto && \
+    chown mosquitto:mosquitto /var/log/mosquitto && \
+    mkdir -p /var/run/mosquitto/ && \
+    chown mosquitto:mosquitto /var/run/mosquitto && \
+    echo "INFO: Cleaning unused software..." && \
+    apt-get clean && \
+    apt-get -y autoremove --purge && \
+    if [ ${CLEAN_DEV_TOOLS} -eq 0 ] ; then exit 0 ; fi && \
+    # remove the same packages we installed at the beginning to build Orch
+    apt-get -y autoremove --purge \
+        wget
 
 
 EXPOSE 1883

package/docker/Mosquitto/Dockerfile.debian

@@ -0,0 +1,38 @@
+ARG  IMAGE_TAG=11.2-slim
+FROM debian:${IMAGE_TAG}
+
+ARG CLEAN_DEV_TOOLS
+ENV CLEAN_DEV_TOOLS ${CLEAN_DEV_TOOLS:-1}
+
+ENV CONGIF_FROM_ENV true
+
+COPY aclfile /root/
+COPY startMosquitto.sh /bin
+
+RUN \
+    # Install security updates
+    apt-get -y update && \
+    apt-get -y upgrade && \
+    # Install dependencies
+    apt-get -y install \
+       wget \
+       mosquitto && \
+    cp /etc/mosquitto/mosquitto.conf /etc/mosquitto/mosquitto.conf.orig && \
+    chmod 755 /bin/startMosquitto.sh && \
+    mkdir -p /var/log/mosquitto && \
+    chown mosquitto:mosquitto /var/log/mosquitto && \
+    echo "INFO: Cleaning unused software..." && \
+    apt-get clean && \
+    apt-get -y autoremove --purge && \
+    if [ ${CLEAN_DEV_TOOLS} -eq 0 ] ; then exit 0 ; fi && \
+    # remove the same packages we installed at the beginning to build Orch
+    apt-get -y autoremove --purge \
+        wget && \
+    # Don't need old log files inside docker images
+    rm -f /var/log/*log
+
+
+EXPOSE 1883
+EXPOSE 9001
+
+ENTRYPOINT /bin/startMosquitto.sh

package/docker/Mosquitto/Dockerfile.debian~

@@ -0,0 +1,23 @@
+ARG  IMAGE_TAG=11.2-slim
+FROM debian:${IMAGE_TAG}
+
+COPY aclfile /root/
+COPY startMosquitto.sh /bin
+
+ENV CONGIF_FROM_ENV true
+
+RUN yum update -y && yum install -y wget \
+  && yum install -y epel-release \
+  && yum update -y epel-release \
+  && yum install -y mosquitto \
+  && cp /etc/mosquitto/mosquitto.conf /etc/mosquitto/mosquitto.conf.orig \
+  && chmod 755 /bin/startMosquitto.sh \
+  && mkdir /var/log/mosquitto \
+  && chown mosquitto:mosquitto /var/log/mosquitto \
+  && yum clean all
+
+
+EXPOSE 1883
+EXPOSE 9001
+
+ENTRYPOINT /bin/startMosquitto.sh

package/docker/Mosquitto/README.md

@@ -2,10 +2,11 @@ Thi directory containts the Dockerfile (and associated files) for a container of
 This container is provide as a help for users to test with MQTT, but it is just an auxiliary material in this repository.
 
 The following releases matches with eclipse-mosquitto version:
-- 1.6.0 uses mosquitto-1.6.10-1.el7.x86_64
-- 1.5.0 uses mosquitto-1.6.10-1.el7.x86_64
-- 1.4.0 uses mosquitto-1.6.10-1.el7.x86_64
-- 1.3.0 uses mosquitto-1.6.8-1.el7.x86_64
-- 1.2.0 uses mosquitto-1.6.7-1.el7.x86_64
-- 1.1.0 uses mosquitto-1.5.8-1.el7.x86_64
-- 1.0.0 uses mosquitto-1.4.8-1.el7.x86_64
+- 2.0.0 uses mosquitto-2.0.11 from Debian 11
+- 1.6.0 uses mosquitto-1.6.10-1.el7.x86_64 (from Centos7)
+- 1.5.0 uses mosquitto-1.6.10-1.el7.x86_64 (from Centos7)
+- 1.4.0 uses mosquitto-1.6.10-1.el7.x86_64 (from Centos7)
+- 1.3.0 uses mosquitto-1.6.8-1.el7.x86_64 (from Centos7)
+- 1.2.0 uses mosquitto-1.6.7-1.el7.x86_64 (from Centos7)
+- 1.1.0 uses mosquitto-1.5.8-1.el7.x86_64 (from Centos7)
+- 1.0.0 uses mosquitto-1.4.8-1.el7.x86_64 (from Centos7)

package/docker/Mosquitto/startMosquitto.sh

@@ -1,7 +1,10 @@
 #!/usr/bin/env bash
 
+echo "INFO: startMosquitto..."
+
 if [ "${CONGIF_FROM_ENV}" = true ] ; then
     cp /etc/mosquitto/mosquitto.conf.orig /etc/mosquitto/mosquitto.conf
+    sed -i 's/log_dest file \/var\/log\/mosquitto\/mosquitto.log/log_dest stderr/g' /etc/mosquitto/mosquitto.conf
     echo "log_timestamp true" >> /etc/mosquitto/mosquitto.conf
     echo "log_timestamp_format %Y-%m-%dT%H:%M:%S" >> /etc/mosquitto/mosquitto.conf
     echo 'listener 9001' >> /etc/mosquitto/mosquitto.conf
@@ -18,4 +21,9 @@ if [ "${CONGIF_FROM_ENV}" = true ] ; then
     fi
 fi
 
+echo "INFO: content /etc/mosquitto/mosquitto.conf: "
+cat /etc/mosquitto/mosquitto.conf
+
+echo "INFO: start: startMosquitto -c /etc/mosquitto/mosquitto.conf"
+
 /usr/sbin/mosquitto -c /etc/mosquitto/mosquitto.conf

package/lib/fiware-iotagent-lib.js

@@ -314,6 +314,7 @@ exports.listDevices = deviceService.listDevices;
 exports.getDevice = deviceService.getDevice;
 exports.getDeviceSilently = deviceService.getDeviceSilently;
 exports.getDeviceByName = deviceService.getDeviceByName;
+exports.getDeviceByNameAndType = deviceService.getDeviceByNameAndType;
 exports.getDevicesByAttribute = deviceService.getDevicesByAttribute;
 exports.mergeDeviceWithConfiguration = deviceService.mergeDeviceWithConfiguration;
 exports.retrieveDevice = deviceService.retrieveDevice;

package/lib/jexlTranformsMap.js

@@ -65,7 +65,9 @@ const map = {
         let s = new Set(arr);
         s.delete(x);
         return Array.from(s);
-    }
+    },
+    touppercase: (val) => String(val).toUpperCase(),
+    tolowercase: (val) => String(val).toLowerCase()
 };
 
 exports.map = map;

package/lib/model/Group.js

@@ -62,7 +62,8 @@ const Group = new Schema({
     expressionLanguage: String,
     explicitAttrs: ExplicitAttrsType,
     defaultEntityNameConjunction: String,
-    ngsiVersion: String
+    ngsiVersion: String,
+    entityNameExp: String
 });
 
 function load(db) {

package/lib/model/dbConn.js

@@ -113,6 +113,10 @@ function init(host, db, port, options, callback) {
             options,
             retries
         );
+        // FIXME: useNewUrlParser is no longer used in underlying mongodb driver 4.x
+        // (see https://github.com/mongodb/node-mongodb-native/blob/HEAD/etc/notes/CHANGES_4.0.0.md)
+        // but not sure if current mongoose version is still using mongodb 3.x internally
+        // probably mongodb-connectionoptions-test.js needs to be fixed if useNewUrlParser is removed at the end
         options.useNewUrlParser = true;
         mongoose.set('useCreateIndex', true);
         /* eslint-disable-next-line no-unused-vars */

package/lib/plugins/expressionPlugin.js

@@ -30,6 +30,8 @@ const jexlParser = require('./jexlParser');
 const config = require('../commonConfig');
 /* eslint-disable no-unused-vars */
 const logger = require('logops');
+const errors = require('../errors');
+const constants = require('../constants');
 const context = {
     op: 'IoTAgentNGSI.expressionPlugin'
 };
@@ -42,6 +44,22 @@ function setJEXLTransforms(transformationMap) {
     jexlParser.setTransforms(transformationMap);
 }
 
+function applyExpression(expression, context, typeInformation) {
+    let parser = jexlParser;
+    if (!checkJexl(typeInformation)) {
+        parser = legacyParser;
+    }
+    return parser.applyExpression(expression, context, typeInformation);
+}
+
+function extractContext(attributeList, typeInformation) {
+    let parser = jexlParser;
+    if (!checkJexl(typeInformation)) {
+        parser = legacyParser;
+    }
+    return parser.extractContext(attributeList);
+}
+
 function mergeAttributes(attrList1, attrList2) {
     const finalCollection = _.clone(attrList1);
     const additionalItems = [];
@@ -70,26 +88,26 @@ function mergeAttributes(attrList1, attrList2) {
     return finalCollection.concat(additionalItems);
 }
 
-function update(entity, typeInformation, callback) {
-    function checkJexl(typeInformation) {
-        if (
-            config.getConfig().defaultExpressionLanguage === 'jexl' &&
-            typeInformation.expressionLanguage &&
-            typeInformation.expressionLanguage !== 'legacy'
-        ) {
-            return true;
-        } else if (config.getConfig().defaultExpressionLanguage === 'jexl' && !typeInformation.expressionLanguage) {
-            return true;
-        } else if (
-            config.getConfig().defaultExpressionLanguage === 'legacy' &&
-            typeInformation.expressionLanguage &&
-            typeInformation.expressionLanguage === 'jexl'
-        ) {
-            return true;
-        }
-        return false;
+function checkJexl(typeInformation) {
+    if (
+        config.getConfig().defaultExpressionLanguage === 'jexl' &&
+        typeInformation.expressionLanguage &&
+        typeInformation.expressionLanguage !== 'legacy'
+    ) {
+        return true;
+    } else if (config.getConfig().defaultExpressionLanguage === 'jexl' && !typeInformation.expressionLanguage) {
+        return true;
+    } else if (
+        config.getConfig().defaultExpressionLanguage === 'legacy' &&
+        typeInformation.expressionLanguage &&
+        typeInformation.expressionLanguage === 'jexl'
+    ) {
+        return true;
     }
+    return false;
+}
 
+function update(entity, typeInformation, callback) {
     function processEntityUpdateNgsi2(attributes) {
         let parser = legacyParser;
         if (checkJexl(typeInformation)) {
@@ -114,15 +132,32 @@ function update(entity, typeInformation, callback) {
 
     try {
         logger.debug(context, 'expressionPlugin entity %j', entity);
-        let attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
-        attsArray = processEntityUpdateNgsi2(attsArray);
-        entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);
+        const attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
+        // Exclude processing all attr expressions when current attr is of type 'commandStatus' or 'commandResult'
+        const attsArrayFiltered = attsArray.filter((obj) => {
+            return ![constants.COMMAND_STATUS, constants.COMMAND_RESULT].includes(obj.type);
+        });
+        const attsArrayCmd = attsArray.filter((obj) => {
+            // just attr of type 'commandStatus' or 'commandResult'
+            return [constants.COMMAND_STATUS, constants.COMMAND_RESULT].includes(obj.type);
+        });
+        let attsArrayFinal = [];
+        if (attsArrayFiltered.length > 0) {
+            attsArrayFinal = processEntityUpdateNgsi2(attsArrayFiltered);
+        }
+        attsArrayFinal = attsArrayFinal.concat(attsArrayCmd);
+        entity = utils.createNgsi2Entity(entity.id, entity.type, attsArrayFinal, true);
 
         callback(null, entity, typeInformation);
     } catch (e) {
+        logger.info(context, 'expressionPlugin error %j procesing entity %j', e, entity);
         callback(e);
+        return;
     }
 }
 
 exports.update = update;
 exports.setJEXLTransforms = setJEXLTransforms;
+exports.applyExpression = applyExpression;
+exports.extractContext = extractContext;
+exports.checkJexl = checkJexl;

package/lib/plugins/multiEntity.js

@@ -30,7 +30,7 @@ const _ = require('underscore');
 const constants = require('../constants');
 const legacyParser = require('./expressionParser');
 const jexlParser = require('./jexlParser');
-const config = require('../commonConfig');
+const expressionPlugin = require('./expressionPlugin');
 /* eslint-disable-next-line  no-unused-vars */
 const logger = require('logops');
 /* eslint-disable-next-line  no-unused-vars */
@@ -41,27 +41,8 @@ const utils = require('./pluginUtils');
 /* eslint-disable-next-line  no-unused-vars */
 const aliasPlugin = require('./attributeAlias');
 
-function checkJexl(typeInformation) {
-    if (
-        config.getConfig().defaultExpressionLanguage === 'jexl' &&
-        typeInformation.expressionLanguage &&
-        typeInformation.expressionLanguage !== 'legacy'
-    ) {
-        return true;
-    } else if (config.getConfig().defaultExpressionLanguage === 'jexl' && !typeInformation.expressionLanguage) {
-        return true;
-    } else if (
-        config.getConfig().defaultExpressionLanguage === 'legacy' &&
-        typeInformation.expressionLanguage &&
-        typeInformation.expressionLanguage === 'jexl'
-    ) {
-        return true;
-    }
-    return false;
-}
-
-function hasEntityName(item) {
-    return item.entity_name;
+function hasEntityNameOrEntityType(item) {
+    return item.entity_name || item.entity_type;
 }
 
 /**
@@ -225,37 +206,50 @@ function propagateTimestamp(entity, entities) {
 }
 
 function updateAttribute(entity, typeInformation, callback) {
-    let parser = legacyParser;
-    if (checkJexl(typeInformation)) {
-        parser = jexlParser;
-    }
-    const attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
-    const ctx = parser.extractContext(attsArray);
-
-    let entities = [entity];
-    if (typeInformation.active) {
-        const multiEntityAttributes = typeInformation.active.filter(hasEntityName);
-        for (let i in multiEntityAttributes) {
-            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;
+    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;
+            }
         }
-        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;
     }
-    callback(null, entities, typeInformation);
 }
 
 exports.update = updateAttribute;