Cache Mongo-DB calls (in-memory and/or Redis)

lib/services/devices/deviceRegistryMongoDB.js

@@ -21,18 +21,45 @@
  * please contact with::[email protected]
  */
 
-var logger = require('logops'),
-    dbService = require('../../model/dbConn'),
-    config = require('../../commonConfig'),
-    fillService = require('./../common/domain').fillService,
-    alarmsInt = require('../common/alarmManagement').intercept,
-    errors = require('../../errors'),
-    constants = require('../../constants'),
-    Device = require('../../model/Device'),
-    async = require('async'),
-    context = {
-        op: 'IoTAgentNGSI.MongoDBDeviceRegister'
-    };
+const logger = require('logops');
+const dbService = require('../../model/dbConn');
+const config = require('../../commonConfig');
+const fillService = require('./../common/domain').fillService;
+const alarmsInt = require('../common/alarmManagement').intercept;
+const errors = require('../../errors');
+const constants = require('../../constants');
+const Device = require('../../model/Device');
+const async = require('async');
+const cacheManager = require('cache-manager');
+const memoryCache = cacheManager.caching({store: 'memory', max: 1000, ttl: 10/*seconds*/});
+let context = {
+    op: 'IoTAgentNGSI.MongoDBDeviceRegister'
+};
+
+const attributeList = [
+    'id',
+    'type',
+    'name',
+    'service',
+    'subservice',
+    'lazy',
+    'commands',
+    'staticAttributes',
+    'active',
+    'registrationId',
+    'internalId',
+    'internalAttributes',
+    'resource',
+    'apikey',
+    'protocol',
+    'endpoint',
+    'transport',
+    'polling',
+    'timestamp',
+    'autoprovision',
+    'explicitAttrs',
+    'expressionLanguage'
+];
 
 /**
  * Generates a handler for the save device operations. The handler will take the customary error and the saved device
@@ -52,20 +79,24 @@ function saveDeviceHandler(callback) {
     };
 }
 
+/**
+ * Empties the memory cache
+ */
+function clearCache(){
+    memoryCache.reset();
+}
+
 /**
  * Create a new register for a device. The device object should contain the id, type and registrationId
  *
  * @param {Object} newDevice           Device object to be stored
  */
 function storeDevice(newDevice, callback) {
-    var deviceObj = new Device.model(),
-        attributeList = ['id', 'type', 'name', 'service', 'subservice', 'lazy', 'commands', 'staticAttributes',
-            'active', 'registrationId', 'internalId', 'internalAttributes', 'resource', 'apikey', 'protocol',
-            'endpoint', 'transport', 'polling', 'timestamp', 'autoprovision', 'explicitAttrs', 'expressionLanguage'];
+    const deviceObj = new Device.model();
 
-    for (var i = 0; i < attributeList.length; i++) {
-        deviceObj[attributeList[i]] = newDevice[attributeList[i]];
-    }
+    attributeList.forEach((key) => {
+        deviceObj[key] = newDevice[key];
+    });
 
     // Ensure protocol is in newDevice
     if ( !newDevice.protocol && config.getConfig().iotManager && config.getConfig().iotManager.protocol) {
@@ -99,7 +130,7 @@ function storeDevice(newDevice, callback) {
  * @param {String} subservice   Subservice inside the service for the removed device.
  */
 function removeDevice(id, service, subservice, callback) {
-    var condition = {
+    const condition = {
         id: id,
         service: service,
         subservice: subservice
@@ -114,7 +145,7 @@ function removeDevice(id, service, subservice, callback) {
             callback(new errors.InternalDbError(error));
         } else {
             logger.debug(context, 'Device [%s] successfully removed.', id);
-
+            clearCache();
             callback(null);
         }
     });
@@ -130,8 +161,8 @@ function removeDevice(id, service, subservice, callback) {
  * @param {Number} offset       Number of entries to skip for pagination.
  */
 function listDevices(type, service, subservice, limit, offset, callback) {
-    var condition = {},
-        query;
+    const condition = {};
+    let query;
 
     if (type) {
         condition.type = type;
@@ -174,32 +205,36 @@ function listDevices(type, service, subservice, limit, offset, callback) {
  * @param {String} subservice   Division inside the service (optional).
  */
 function getDeviceById(id, service, subservice, callback) {
-    var query,
-        queryParams = {
-            id: id,
-            service: service,
-            subservice: subservice
-        };
+    let query;
+    const queryParams = {
+        id: id,
+        service: service,
+        subservice: subservice
+    };
     context = fillService(context, queryParams);
     logger.debug(context, 'Looking for device with id [%s].', id);
 
-    query = Device.model.findOne(queryParams);
-    query.select({__v: 0});
+    memoryCache.wrap(JSON.stringify(queryParams), function (cacheCallback) {
+        query = Device.model.findOne(queryParams);
+        query.select({__v: 0});
 
-    query.exec(function handleGet(error, data) {
-        if (error) {
-            logger.debug(context, 'Internal MongoDB Error getting device: %s', error);
+        query.exec(function handleGet(error, data) {
+            if (error) {
+                logger.debug(context, 'Internal MongoDB Error getting device: %s', error);
 
-            callback(new errors.InternalDbError(error));
-        } else if (data) {
-            context = fillService(context, data);
-            logger.debug(context, 'Device data found: %j', data);
-            callback(null, data);
-        } else {
-            logger.debug(context, 'Device [%s] not found.', id);
+                cacheCallback(new errors.InternalDbError(error));
+            } else if (data) {
+                context = fillService(context, data);
+                logger.debug(context, 'Device data found: %j', data);
+                cacheCallback(null, data);
+            } else {
+                logger.debug(context, 'Device [%s] not found.', id);
 
-            callback(new errors.DeviceNotFound(id));
-        }
+                cacheCallback(new errors.DeviceNotFound(id));
+            }
+        });
+    }, (error, data) => {
+        callback(error, data);
     });
 }
 
@@ -222,7 +257,7 @@ function getDevice(id, service, subservice, callback) {
 }
 
 function getByName(name, service, servicepath, callback) {
-    var query;
+    let query;
     context = fillService(context, { service: service, subservice: servicepath});
     logger.debug(context, 'Looking for device with name [%s].', name);
 
@@ -250,8 +285,9 @@ function getByName(name, service, servicepath, callback) {
 }
 
 /**
- * Updates the given device into the database. Only the following attributes: lazy, active and internalId will be
- * updated.
+ * Updates the given device into the database. Only the following attributes: 
+ * lazy, active and internalId, commanda, endpoint, name, type, explicitAttrs
+ * will be updated.
  *
  * @param {Object} device       Device object with the new values to write.
  */
@@ -260,6 +296,7 @@ function update(device, callback) {
         if (error) {
             callback(error);
         } else {
+            clearCache();
             data.lazy = device.lazy;
             data.active = device.active;
             data.internalId = device.internalId;
@@ -269,7 +306,6 @@ function update(device, callback) {
             data.name = device.name;
             data.type = device.type;
             data.explicitAttrs = device.explicitAttrs;
-
             data.save(saveDeviceHandler(callback));
         }
     });
@@ -291,8 +327,8 @@ function itemToObject(i) {
 }
 
 function getDevicesByAttribute(name, value, service, subservice, callback) {
-    var query,
-        filter = {};
+    let query;
+    const filter = {};
 
     if (service) {
         filter.service = service;
@@ -324,6 +360,7 @@ function getDevicesByAttribute(name, value, service, subservice, callback) {
     });
 }
 
+
 exports.getDevicesByAttribute = alarmsInt(constants.MONGO_ALARM, getDevicesByAttribute);
 exports.store = alarmsInt(constants.MONGO_ALARM, storeDevice);
 exports.update = alarmsInt(constants.MONGO_ALARM, update);
@@ -333,3 +370,4 @@ exports.get = alarmsInt(constants.MONGO_ALARM, getDevice);
 exports.getSilently = getDevice;
 exports.getByName = alarmsInt(constants.MONGO_ALARM, getByName);
 exports.clear = alarmsInt(constants.MONGO_ALARM, clear);
+exports.clearCache = clearCache;