code cleanup with the right comments

realtime/redisPublisher.js

@@ -14,6 +14,7 @@ const rtUtils = require('./utils');
 const pub = require('../cache/redisCache').client.pub;
 const channelName = require('../config').redis.channelName;
 const sampleEvent = require('./constants').events.sample;
+const featureToggles = require('feature-toggles');
 
 /**
  * When passed an sample object, either a sequelize sample object or
@@ -89,10 +90,11 @@ function publishObject(inst, event, changedKeys, ignoreAttributes) {
 } // publishChange
 
 /**
- * [publishPartialSample description]
- * @param  {[type]} sampleInst [description]
- * @param  {[type]} event      [description]
- * @return {[type]}            [description]
+ * Publishes the sample without attaching the related subject and the aspect to
+ * the redis channel
+ * @param  {Object} sampleInst - The sampel instance to be published
+ * @param  {String} event - The event type that is being published.
+ * @returns {Object} - the sample object
  */
 function publishPartialSample(sampleInst, event) {
   const eventType = event || getSampleEventType(sampleInst);
@@ -116,7 +118,10 @@ function publishPartialSample(sampleInst, event) {
  */
 function publishSample(sampleInst, subjectModel, event, aspectModel) {
   const eventType = event || getSampleEventType(sampleInst);
-  return rtUtils.attachAspectSubject(sampleInst, subjectModel, aspectModel)
+  const useSampleStore =
+    featureToggles.isFeatureEnabled('enableRedisSampleStore');
+  return rtUtils.attachAspectSubject(sampleInst, useSampleStore, subjectModel,
+    aspectModel)
   .then((sample) => {
     publishObject(sample, eventType);
     return sample;

realtime/redisSubscriber.js

@@ -30,14 +30,16 @@ module.exports = (io) => {
     const parsedObj = rtUtils.parseObject(mssgObj[key], key);
     if (featureToggles.isFeatureEnabled('publishPartialSample') &&
     rtUtils.isThisSample(parsedObj)) {
+      const useSampleStore =
+        featureToggles.isFeatureEnabled('enableRedisSampleStore');
       /*
        * assign the subjectModel to the database model if sampleStore is
        * not enabled
        */
       const subjectModel =
-        featureToggles.isFeatureEnabled('enableRedisSampleStore') ? undefined :
+        useSampleStore ? undefined :
           require('../db/index').Subject; // eslint-disable-line global-require
-      rtUtils.attachAspectSubject(parsedObj, subjectModel)
+      rtUtils.attachAspectSubject(parsedObj, useSampleStore, subjectModel)
       .then((obj) => {
         console.log('object to be emitted this is a complete sample', obj);
        /*

realtime/utils.js

@@ -14,7 +14,6 @@ const ip = require('ip');
 const constants = require('./constants');
 const redisClient = require('../cache/redisCache').client.sampleStore;
 const redisStore = require('../cache/sampleStore');
-const featureToggles = require('feature-toggles');
 
 const eventName = {
   add: 'refocus.internal.realtime.subject.add',
@@ -315,16 +314,24 @@ function isIpWhitelisted(addr, whitelist) {
 } // isIpWhitelisted
 
 /**
- * [attachAspectSubject description]
- * @param  {[type]} sampInst [description]
- * @return {[type]}          [description]
+ * When passed in a sample, its related subject and aspect is attached to the
+ * sample. If useSampleStore is set to true, the subject ans aspect is fetched
+ * for the cache instead of the database.
+ * @param {Object} sample - The sample instance.
+ * @param {Boolen} useSampleStore - The sample store flag, the subject and the
+ *   aspect is fetched from the cache if this is set.
+ * @param {Model} subjectModel - The database subject model.
+ * @param {Model} aspectModel - The database aspect model.
+ * @returns {Promise} - which resolves to a complete sample with its subject and
+ *   aspect.
  */
-function attachAspectSubject(sample, subjectModel, aspectModel) {
+function attachAspectSubject(sample, useSampleStore, subjectModel,
+  aspectModel) {
   const nameParts = sample.name.split('|');
   const subName = nameParts[0];
   const aspName = nameParts[1];
   let promiseArr = [];
-  if (featureToggles.isFeatureEnabled('enableRedisSampleStore')) {
+  if (useSampleStore) {
     const subKey = redisStore.toKey('subject', subName);
     const aspKey = redisStore.toKey('aspect', aspName);
     const getAspectPromise = sample.aspect ? Promise.resolve(sample.aspect) :