Fiqare perseo-fe improvements

lib/alarm.js

@@ -30,6 +30,7 @@ var util = require('util'),
 function raise(alarm, context, message) {
     var state = alarms[alarm];
     context = (process.domain && process.domain.context) || {};
+
     if (typeof message === 'object' && message) {
         message = util.format('%j', message);
     }
@@ -43,6 +44,7 @@ function raise(alarm, context, message) {
 function release(alarm, context, message) {
     var state = alarms[alarm];
     context = (process.domain && process.domain.context) || {};
+
     if (typeof message === 'object' && message) {
         message = util.format('%j', message);
     }

lib/models/actions.js

@@ -81,6 +81,9 @@ function validateAction(axn) {
                 return new errors.IdAsAttribute(JSON.stringify(axnElem.parameters));
             } else if (axnElem.parameters.name === 'type') {
                 return new errors.IdAsAttribute(JSON.stringify(axnElem.parameters));
+            } else {
+                //Added default else clause
+                return null;
             }
         }
     }
@@ -227,6 +230,7 @@ function DoAction(event, callback) {
 
     actionStore.Find(service, subservice, ruleName, function(err, actions) {
         var localError, queue;
+
         if (err) {
             return callback(err, null);
         }

lib/models/actionsStore.js

@@ -40,8 +40,10 @@ module.exports = {
                 localError = new errors.NotFoundAction(data);
                 myutils.logErrorIf(localError);
                 return callback(localError, null);
+            } else {
+                //Added default else clause
+                return callback(null, data.action);
             }
-            return callback(null, data.action);
         });
     }
 };

lib/models/emailAction.js

@@ -25,13 +25,12 @@
 var util = require('util'),
     nodemailer = require('nodemailer'),
     logger = require('logops'),
-    smtpTransport = require('nodemailer-smtp-transport'),
     config = require('../../config'),
     myutils = require('../myutils'),
     alarm = require('../alarm'),
     metrics = require('./metrics');
 
-var transporter = nodemailer.createTransport(smtpTransport(config.smtp));
+var transporter = nodemailer.createTransport(config.smtp);
 
 function buildMailOptions(action, event) {
     return {
@@ -50,7 +49,7 @@ function SendMail(action, event, callback) {
 
         metrics.IncMetrics(event.service, event.subservice, metrics.actionEmail);
 
-        transporter.sendMail(mailOptions, function(err, info) {
+        transporter.sendMail(mailOptions, (err, info) => {
             logger.debug('emailAction.SendMail %j %j %j', mailOptions, err, info);
             // Not an HTTP request, so outgoingTransacion hasn't already counted and must be counted now
             metrics.IncMetrics(event.service, event.subservice, metrics.outgoingTransactions);

lib/models/entitiesStore.js

@@ -52,6 +52,9 @@ function findSilentEntities(service, subservice, ruleData, func, callback) {
         } catch (e) {
             return callback(e, null);
         }
+    } else {
+        //Added default else clause
+        logger.debug('findSilentEntities() - Default else clause');
     }
     if (ruleData.type) {
         criterion['_id.type'] = ruleData.type;

lib/models/paths.js

@@ -38,6 +38,10 @@ function validComponent(component) {
     } else if (!componentPattern.test(component)) {
         err = new errors.InvalidCharacter(component);
     }
+    else {
+    	//Added default else clause
+    	return err;
+    }
     return err;
 }
 function validService(service) {

lib/models/postAction.js

@@ -39,6 +39,10 @@ function buildPostOptions(action, event) {
     } else if (action.template) {
         options.text = myutils.expandVar(action.template, event, true);
     }
+    else {
+    	//Added default else clause
+    	return options;
+    }
 
     return options;
 }
@@ -58,6 +62,10 @@ function doIt(action, event, callback) {
         } else if (options.text) {
             requestOptions.body = options.text;
         }
+        else {
+            //Added default else clause
+            logger.debug('doIt() - Default else clause');	
+        }
 
         metrics.IncMetrics(event.service, event.subservice, metrics.actionHttpPost);
 

lib/models/rules.js

@@ -33,7 +33,8 @@ var util = require('util'),
     actions = require('./actions'),
     namePattern = /^[a-zA-Z0-9_-]+$/,
     MaxNameLength = 50,
-    errors = {};
+    errors = {},
+    logger = require('logops');
 
 function validNSRule(rule) {
     var checkInterval = parseInt(rule.nosignal.checkInterval, 10);
@@ -58,6 +59,9 @@ function validRule(rule) {
         return new errors.InvalidRuleName(rule.name);
     } else if (!rule.text && !rule.nosignal) {
         return new errors.EmptyRule(JSON.stringify(rule));
+    } else {
+        //Added default else clause
+        logger.debug('validRule() - Default else clause');
     }
     if (rule.nosignal) {
         //Specific checks for no-signal rules
@@ -218,6 +222,7 @@ module.exports = {
     },
     Save: function(rule, callback) {
         var localError;
+
         localError = validRule(rule);
         if (localError !== null) {
             myutils.logErrorIf(localError);
@@ -244,7 +249,12 @@ module.exports = {
                 rulesStore.Save.bind(null, rule),
                 function(cb) {
                     if (rule.nosignal) {
-                        noSignal.AddNSRule(rule.service, rule.subservice, rule.name, rule.nosignal);
+                        noSignal.AddNSRule(
+                            rule.service,
+                            rule.subservice,
+                            rule.name,
+                            rule.nosignal
+                        );
                     }
                     cb(null);
                 }
@@ -294,14 +304,23 @@ module.exports = {
                 delR2core.bind(null, rule),
                 function(cb) {
                     if (rule.nosignal) {
-                        noSignal.DeleteNSRule(rule.service, rule.subservice, rule.name);
+                        noSignal.DeleteNSRule(
+                            rule.service,
+                            rule.subservice,
+                            rule.name
+                        );
                     }
                     cb(null);
                 },
                 postR2core.bind(null, rule),
                 function(cb) {
                     if (rule.nosignal) {
-                        noSignal.AddNSRule(rule.service, rule.subservice, rule.name, rule.nosignal);
+                        noSignal.AddNSRule(
+                            rule.service,
+                            rule.subservice,
+                            rule.name,
+                            rule.nosignal
+                        );
                     }
                     cb(null);
                 },

lib/models/rulesStore.js

@@ -97,7 +97,7 @@ function search(rule, callback) {
 
 function findAll(service, subservice, callback) {
     var criterion = {};
-
+    
     if (typeof service === 'function') {
         callback = service;
     } else {

lib/models/updateAction.js

@@ -188,8 +188,9 @@ function doRequest(action, event, token, callback) {
             }
             if (!err && data.body && data.body.orionError) {
                 err = new errors.OrionError(JSON.stringify(data.body.orionError));
+            } else {
+                callback(err, data);
             }
-            callback(err, data);
         }
     );
 }
@@ -266,6 +267,8 @@ function processOptionParams(action, event) {
                 case 'None':
                     theValue = null;
                     break;
+                default:
+                    //Nothing to do
             }
         }
         var key = myutils.expandVar(attr.name, event);

lib/models/visualRules.js

@@ -35,7 +35,8 @@ var util = require('util'),
         MINOR_OR_EQUAL_THAN: ' <= ',
         MATCH: ' regexp '
     },
-    errors = {};
+    errors = {},
+    logger = require('logops');
 
 function errorOperator(op) {
     if (operatorMap[op] === undefined) {
@@ -118,7 +119,6 @@ function vr2rule(cardRule) {
                                     false
                                 )
                             );
-
                             break;
                         case 'XPATH':
                             errOp = errorOperator(card.conditionList[0].operator);
@@ -143,18 +143,27 @@ function vr2rule(cardRule) {
                                 }
                             } else if (card.conditionList[0].parameterName === 'type') {
                                 type = card.conditionList[0].parameterValue;
+                            } else {
+                                //Added default else clause
+                                logger.debug('vr2rule() - Default else clause');
                             }
                             break;
                         case 'OBSERVATION':
                             errOp = errorOperator(card.conditionList[0].operator);
+
                             if (errOp) {
                                 return errOp;
                             }
+
                             if (card.sensorData.measureName === 'id') {
                                 return new errors.IdAsAttribute('');
                             } else if (card.sensorData.measureName === 'type') {
                                 return new errors.TypeAsAttribute('');
+                            } else {
+                                //Added default else clause
+                                logger.debug('vr2rule() - Default else clause');
                             }
+
                             conditions.push(
                                 makeObservationCondition(
                                     card.sensorData.measureName,
@@ -163,6 +172,7 @@ function vr2rule(cardRule) {
                                     card.sensorData.dataType === 'Quantity'
                                 )
                             );
+
                             break;
                         case 'LAST_MEASURE':
                             checkInterval = parseInt(card.timeData.interval, 10);
@@ -225,10 +235,15 @@ function vr2rule(cardRule) {
                             case 'timeElapsed': // Minimal interval for actions
                                 action.interval = card.timeData.interval;
                                 break;
+                            default:
+                            //nothing to do
                         }
                     } else {
                         return new errors.MissingConfigDataInTimeCard(JSON.stringify(card));
                     }
+                    break;
+                default:
+                //nothing to do
             }
         }
 

lib/myutils.js

@@ -88,6 +88,9 @@ function expandObject(templateObj, dictionary) {
                 res[expandVar(key, dictionary)] = expandVar(templateObj[key], dictionary);
             } else if (typeof templateObj[key] === 'object') {
                 res[expandVar(key, dictionary)] = expandObject(templateObj[key], dictionary);
+            } else {
+                //Added default else clause
+                logger.debug('expandObject() - Default else clause');
             }
         });
     }

lib/perseo.js

@@ -48,7 +48,9 @@ var domain = require('domain'),
     serviceMiddleware = require('./middleware/service'),
     errorMiddleware = require('./middleware/error'),
     myutils = require('./myutils'),
-    d = domain.create();
+    d = domain.create(),
+    swaggerJsdoc = require('swagger-jsdoc'),
+    swaggerUi = require('swagger-ui-express');
 
 function start(callbackStart) {
     var context = { op: 'start', comp: constants.COMPONENT_NAME };
@@ -98,6 +100,22 @@ function start(callbackStart) {
         versionRoutes.AddTo(app);
         metricsRoutes.AddTo(app);
 
+        const options = {
+            definition: {
+                swagger: '2.0', // Specification (optional, defaults to swagger: '2.0')
+                info: {
+                    title: 'Perseo Front-End', // Title (required)
+                    version: '1.7.0-fiqare' // Version (required)
+                }
+            },
+            // Path to the API docs
+            apis: ['./lib/routes/*.js']
+        };
+
+        const specs = swaggerJsdoc(options);
+
+        app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
+
         async.series(
             [
                 function(callback) {

lib/routes/noticesController.js

@@ -47,6 +47,75 @@ function PostNotice(req, resp) {
 }
 
 function AddTo(app) {
+    /**
+     * @swagger
+     *
+     * /notices:
+     *   post:
+     *     tags:
+     *       - Notices
+     *     description: Send an event/notification to perseo
+     *     produces:
+     *      - application/json
+     *     parameters:
+     *       - name: fiware-service
+     *         description: Fiware service.
+     *         in: header
+     *         required: true
+     *         type: string
+     *       - name: fiware-servicepath
+     *         description: Fiware service path.
+     *         in: header
+     *         required: true
+     *         type: string
+     *       - name: body
+     *         in: body
+     *         schema:
+     *           type: object
+     *           properties:
+     *             subscriptionId:
+     *               type: string
+     *               description: Subscription Id
+     *               example:
+     *                 - 5c7e63939859f248791984e0
+     *             data:
+     *               type: object
+     *               properties:
+     *                 id:
+     *                   type: string
+     *                   description: Entity Id
+     *                   example:
+     *                     - urn:ngsi-ld:Door:001
+     *                 type:
+     *                   type: string
+     *                   description: Entity type
+     *                   example:
+     *                     - Door
+     *                 state:
+     *                   type: object
+     *                   properties:
+     *                     type:
+     *                       type: string
+     *                       description: State type
+     *                       example:
+     *                         - Text
+     *                     value:
+     *                       type: string
+     *                       description: State value
+     *                       example:
+     *                         - OPEN
+     *                     metadata:
+     *                       type: object
+     *                       description: State metadata
+     *                       example:
+     *                         - {"TimeInstant":{"type":"ISO8601", "value":"2019-03-05T10:49:16.402Z"}}
+     *           required:
+     *               - subscriptionId
+     *               - data
+     *     responses:
+     *       200:
+     *         description: rules
+     */
     app.post(config.endpoint.noticesPath, PostNotice);
 }