Merge pull request #668 from prikshittekta/guidelines

guidelines fixes - views, web, systemlogs, enterpriseinfo

Author: ar2rsawseen

api/utils/render.js

@@ -29,6 +29,11 @@ var chromePath = "";
  */
 exports.renderView = function(options, cb) {
     Promise.coroutine(function * () {
+        /**
+         * Function to set a timeout
+         * @param  {number} ms - Total milliseconds
+         * @returns {Promise} Promise
+         */
         function timeout(ms) {
             return new Promise(function(resolve) {
                 setTimeout(resolve, ms);
@@ -110,7 +115,7 @@ exports.renderView = function(options, cb) {
         if (id) {
             var rect = yield page.evaluate(function(selector) {
                 var element = document.querySelector(selector);
-                var dimensions = element.getBoundingClientRect();
+                dimensions = element.getBoundingClientRect();
                 return {
                     left: dimensions.x,
                     top: dimensions.y,
@@ -160,23 +165,26 @@ exports.renderView = function(options, cb) {
         }
     });
 };
-
+/**
+ * Function to fetch Chrome executable
+ * @returns {Promise} Promise
+ */
 function fetchChromeExecutablePath() {
-    return new Promise(function(resolve, reject) {
-        exec('ls /etc/ | grep -i "redhat-release" | wc -l', function(error, stdout, stderr) {
-            if (error || stdout != 1) {
-                if (stderr) {
-                    console.log(stderr);
+    return new Promise(function(resolve) {
+        exec('ls /etc/ | grep -i "redhat-release" | wc -l', function(error1, stdout1, stderr1) {
+            if (error1 || parseInt(stdout1) !== 1) {
+                if (stderr1) {
+                    console.log(stderr1);
                 }
 
                 alternateChrome = false;
                 return resolve();
             }
 
-            exec('cat /etc/redhat-release | grep -i "release 6" | wc -l', function(error, stdout, stderr) {
-                if (error || stdout != 1) {
-                    if (stderr) {
-                        console.log(stderr);
+            exec('cat /etc/redhat-release | grep -i "release 6" | wc -l', function(error2, stdout2, stderr2) {
+                if (error2 || parseInt(stdout2) !== 1) {
+                    if (stderr2) {
+                        console.log(stderr2);
                     }
 
                     alternateChrome = false;

plugins/enterpriseinfo/api/api.js

@@ -1,14 +1,12 @@
-var plugin = {},
-    common = require('../../../api/utils/common.js'),
-    plugins = require('../../pluginManager.js');
+var pluginOb = {};
 
-(function(plugin) {
+(function() {
     //write api call
     /*
 	plugins.register("/i", function(ob){
 		
 	});
 	*/
-}(plugin));
+}(pluginOb));
 
-module.exports = plugin;
+module.exports = pluginOb;

plugins/enterpriseinfo/frontend/app.js

@@ -1,4 +1,4 @@
-var plugin = {},
+var exported = {},
     countlyConfig = require('../../../frontend/express/config', 'dont-enclose'),
     versionInfo = require('../../../frontend/express/version.info'),
     path = require('path'),
@@ -7,14 +7,18 @@ var plugin = {},
 
 (function(plugin) {
     plugin.init = function(app, countlyDb) {
+        /**
+         * Function to get total users
+         * @param  {Function} callback - Callback function
+         */
         function getTotalUsers(callback) {
-            countlyDb.collection("apps").find({}, {_id: 1}).toArray(function(err, allApps) {
-                if (err || !allApps) {
+            countlyDb.collection("apps").find({}, {_id: 1}).toArray(function(err1, allApps) {
+                if (err1 || !allApps) {
                     callback(0, 0);
                 }
                 else {
-                    async.map(allApps, getUserCountForApp, function(err, results) {
-                        if (err) {
+                    async.map(allApps, getUserCountForApp, function(err2, results) {
+                        if (err2) {
                             callback(0, 0);
                         }
 
@@ -29,9 +33,13 @@ var plugin = {},
                 }
             });
         }
-
-        function getUserCountForApp(app, callback) {
-            countlyDb.collection("app_users" + app._id).find({}).count(function(err, count) {
+        /**
+         * Function to get user count for app
+         * @param  {Object} appData - App data object
+         * @param  {Function} callback - Callback function
+         */
+        function getUserCountForApp(appData, callback) {
+            countlyDb.collection("app_users" + appData._id).find({}).count(function(err, count) {
                 if (err || !count) {
                     callback(0);
                 }
@@ -52,11 +60,11 @@ var plugin = {},
             });
         });
         app.get(countlyConfig.path + '/dashboard', function(req, res, next) {
-            if (req.session.uid && versionInfo.type == "777a2bf527a18e0fffe22fb5b3e322e68d9c07a6" && !versionInfo.footer) {
+            if (req.session.uid && versionInfo.type === "777a2bf527a18e0fffe22fb5b3e322e68d9c07a6" && !versionInfo.footer) {
                 countlyDb.collection('members').findOne({"_id": countlyDb.ObjectID(req.session.uid)}, function(err, member) {
                     if (member && (typeof member.offer === "undefined" || member.offer < 2)) {
-                        countlyDb.collection('members').findAndModify({_id: countlyDb.ObjectID(req.session.uid)}, {}, {$inc: {offer: 1}}, function(err, member) {});
-                        getTotalUsers(function(totalUsers, totalApps) {
+                        countlyDb.collection('members').findAndModify({_id: countlyDb.ObjectID(req.session.uid)}, {}, {$inc: {offer: 1}}, function() {});
+                        getTotalUsers(function(totalUsers) {
                             if (totalUsers > 5000) {
                                 res.expose({
                                     discount: "AWESOMECUSTOMER20"
@@ -69,6 +77,6 @@ var plugin = {},
             next();
         });
     };
-}(plugin));
+}(exported));
 
-module.exports = plugin;
+module.exports = exported;

plugins/enterpriseinfo/frontend/public/javascripts/countly.views.js

@@ -1,3 +1,5 @@
+/*global CountlyHelpers, EnterpriseView, countlyGlobalEE, countlyView, countlyGlobal, Handlebars, app, $, jQuery*/
+
 window.EnterpriseView = countlyView.extend({
     initialize: function() {},
     beforeRender: function() {
@@ -52,9 +54,9 @@ app.route("/enterprise", "enterprise", function() {
 
 $(document).ready(function() {
     if (countlyGlobal.plugins.indexOf("drill") < 0) {
-  	if (typeof countlyGlobalEE !== "undefined" && countlyGlobalEE.discount) {
-  		var msg = {title: "5000+ users reached", message: "<a href='https://count.ly/enterprise-edition/' target='_blank'>To get 20% off Enterprise edition contact us with code:<br/><strong>" + countlyGlobalEE.discount + "</strong></a>", info: "Thank you for being with us", sticky: true, closeOnClick: false};
-  		CountlyHelpers.notify(msg);
+        if (typeof countlyGlobalEE !== "undefined" && countlyGlobalEE.discount) {
+            var msg = {title: "5000+ users reached", message: "<a href='https://count.ly/enterprise-edition/' target='_blank'>To get 20% off Enterprise edition contact us with code:<br/><strong>" + countlyGlobalEE.discount + "</strong></a>", info: "Thank you for being with us", sticky: true, closeOnClick: false};
+            CountlyHelpers.notify(msg);
         }
 
         var badge = '<a id="enterprise-badge" href="#/enterprise"><div data-localize="enterpriseinfo.badge">Get Enterprise</div></a>';

plugins/systemlogs/api/api.js

@@ -1,15 +1,15 @@
-var plugin = {},
+var pluginOb = {},
     common = require('../../../api/utils/common.js'),
     countlyCommon = require('../../../api/lib/countly.common.js'),
     plugins = require('../../pluginManager.js');
 
-(function(plugin) {
+(function() {
 
     //read api call
     plugins.register("/o", function(ob) {
         var params = ob.params;
         var validate = ob.validateUserForGlobalAdmin;
-        if (params.qstring.method == 'systemlogs') {
+        if (params.qstring.method === 'systemlogs') {
             var query = {};
             if (typeof params.qstring.query === "string") {
                 try {
@@ -20,7 +20,7 @@ var plugin = {},
                     query = {};
                 }
             }
-            if (params.qstring.sSearch && params.qstring.sSearch != "") {
+            if (params.qstring.sSearch && params.qstring.sSearch !== "") {
                 query.i = {"$regex": new RegExp(".*" + params.qstring.sSearch + ".*", 'i')};
                 //filter["$text"] = { "$search": "\""+params.qstring.sSearch+"\"" };
             }
@@ -29,51 +29,51 @@ var plugin = {},
                 query.ts = countlyCommon.getTimestampRangeQuery(params, true);
             }
             query._id = {$ne: "meta_v2"};
-            validate(params, function(params) {
+            validate(params, function(paramsNew) {
                 var columns = ["ts", "u", "a", "ip", "i"];
-                common.db.collection('systemlogs').count({}, function(err, total) {
+                common.db.collection('systemlogs').count({}, function(err1, total) {
                     total--;
                     var cursor = common.db.collection('systemlogs').find(query);
-                    cursor.count(function(err, count) {
-                        if (params.qstring.iDisplayStart && params.qstring.iDisplayStart != 0) {
-                            cursor.skip(parseInt(params.qstring.iDisplayStart));
+                    cursor.count(function(err2, count) {
+                        if (paramsNew.qstring.iDisplayStart && parseInt(paramsNew.qstring.iDisplayStart) !== 0) {
+                            cursor.skip(parseInt(paramsNew.qstring.iDisplayStart));
                         }
-                        if (params.qstring.iDisplayLength && params.qstring.iDisplayLength != -1) {
-                            cursor.limit(parseInt(params.qstring.iDisplayLength));
+                        if (paramsNew.qstring.iDisplayLength && parseInt(paramsNew.qstring.iDisplayLength) !== -1) {
+                            cursor.limit(parseInt(paramsNew.qstring.iDisplayLength));
                         }
-                        if (params.qstring.iSortCol_0 && params.qstring.sSortDir_0) {
-                            var ob = {};
-                            ob[columns[params.qstring.iSortCol_0]] = (params.qstring.sSortDir_0 == "asc") ? 1 : -1;
-                            cursor.sort(ob);
+                        if (paramsNew.qstring.iSortCol_0 && paramsNew.qstring.sSortDir_0) {
+                            var obj = {};
+                            obj[columns[paramsNew.qstring.iSortCol_0]] = (paramsNew.qstring.sSortDir_0 === "asc") ? 1 : -1;
+                            cursor.sort(obj);
                         }
 
-                        cursor.toArray(function(err, res) {
-                            if (err) {
-                                console.log(err);
+                        cursor.toArray(function(err3, res) {
+                            if (err3) {
+                                console.log(err3);
                             }
                             res = res || [];
-                            common.returnOutput(params, {sEcho: params.qstring.sEcho, iTotalRecords: total, iTotalDisplayRecords: count, aaData: res});
+                            common.returnOutput(paramsNew, {sEcho: paramsNew.qstring.sEcho, iTotalRecords: total, iTotalDisplayRecords: count, aaData: res});
                         });
                     });
                 });
             });
             return true;
         }
-        else if (params.qstring.method == 'systemlogs_meta') {
-            validate(params, function(params) {
+        else if (params.qstring.method === 'systemlogs_meta') {
+            validate(params, function(paramsNew) {
                 //get all users
-                common.db.collection('members').find({}, {username: 1, email: 1, full_name: 1}).toArray(function(err, users) {
-                    common.db.collection('systemlogs').findOne({_id: "meta_v2"}, {_id: 0}, function(err, res) {
+                common.db.collection('members').find({}, {username: 1, email: 1, full_name: 1}).toArray(function(err1, users) {
+                    common.db.collection('systemlogs').findOne({_id: "meta_v2"}, {_id: 0}, function(err2, res) {
                         var result = {};
-                        if (!err && res) {
+                        if (!err2 && res) {
                             for (var i in res) {
                                 result[i] = Object.keys(res[i]).map(function(arg) {
                                     return common.db.decode(arg);
                                 });
                             }
                         }
                         result.users = users || [];
-                        common.returnOutput(params, result);
+                        common.returnOutput(paramsNew, result);
                     });
                 });
             });
@@ -112,7 +112,6 @@ var plugin = {},
     });
 
     plugins.register("/i/apps/update", function(ob) {
-        var appId = ob.appId;
         var data = {};
         data.before = {};
         data.after = {};
@@ -200,7 +199,7 @@ var plugin = {},
         if (typeof ob.data.before !== "undefined" && typeof ob.data.update !== "undefined") {
             var data = {};
             for (var i in ob.data) {
-                if (i != "before" && i != "after") {
+                if (i !== "before" && i !== "after") {
                     data[i] = ob.data[i];
                 }
             }
@@ -214,20 +213,26 @@ var plugin = {},
         }
     });
 
-    //recursive function to compare changes
+    /**
+     * recursive function to compare changes
+     * @param  {Object} dataafter - after data values
+     * @param  {Object} databefore - before data values
+     * @param  {Object} before - before
+     * @param  {Object} after - after
+     */
     function compareChangesInside(dataafter, databefore, before, after) {
         var keys = Object.keys(after);
         var keys2 = Object.keys(before);
-        for (var i = 0; i < keys2.length; i++) {
+        for (let i = 0; i < keys2.length; i++) {
             if (!after[keys2[i]]) {
                 keys.push(keys2[i]);
             }
         }
 
-        for (var i = 0; i < keys.length; i++) {
+        for (let i = 0; i < keys.length; i++) {
             if (typeof after[keys[i]] !== "undefined" && typeof before[keys[i]] !== "undefined") {
                 if (typeof after[keys[i]] === "object") {
-                    if (Array.isArray(after[keys[i]]) && JSON.stringify(after[keys[i]]) != JSON.stringify(before[keys[i]])) {
+                    if (Array.isArray(after[keys[i]]) && JSON.stringify(after[keys[i]]) !== JSON.stringify(before[keys[i]])) {
                         databefore[keys[i]] = before[keys[i]];
                         dataafter[keys[i]] = after[keys[i]];
                     }
@@ -240,14 +245,14 @@ var plugin = {},
                         }
 
                         compareChangesInside(dataafter[keys[i]], databefore[keys[i]], before[keys[i]], after[keys[i]]);
-                        if (typeof dataafter[keys[i]] === "object" && typeof databefore[keys[i]] === "object" && Object.keys(dataafter[keys[i]]) == 0 && Object.keys(databefore[keys[i]]) == 0) {
+                        if (typeof dataafter[keys[i]] === "object" && typeof databefore[keys[i]] === "object" && (Object.keys(dataafter[keys[i]])).length === 0 && (Object.keys(databefore[keys[i]])).length === 0) {
                             delete databefore[keys[i]];
                             delete dataafter[keys[i]];
                         }
                     }
                 }
                 else {
-                    if (after[keys[i]] != before[keys[i]]) {
+                    if (after[keys[i]] !== before[keys[i]]) {
                         databefore[keys[i]] = before[keys[i]];
                         dataafter[keys[i]] = after[keys[i]];
                     }
@@ -265,7 +270,12 @@ var plugin = {},
             }
         }
     }
-
+    /**
+     * Function to compare changes
+     * @param  {Object} data - data object
+     * @param  {Object} before - before values
+     * @param  {Object} after - after values
+     */
     function compareChanges(data, before, after) {
         if (before && after) {
             if (typeof before._id !== "undefined") {
@@ -277,7 +287,13 @@ var plugin = {},
             compareChangesInside(data.after, data.before, before, after);
         }
     }
-
+    /**
+     * Function to record action
+     * @param  {Object} params -  Default parameters object
+     * @param  {Object} user - user object
+     * @param  {String} action - action
+     * @param  {Object} data - data object
+     */
     function recordAction(params, user, action, data) {
         var log = {};
         log.a = action;
@@ -291,7 +307,7 @@ var plugin = {},
         }
         if (user._id) {
             log.user_id = user._id + "";
-            if (log.u == "") {
+            if (log.u === "") {
                 common.db.collection('members').findOne({_id: common.db.ObjectID.createFromHexString(user._id)}, function(err, res) {
                     if (!err && res) {
                         log.u = res.email || res.username;
@@ -318,7 +334,7 @@ var plugin = {},
                 common.db.collection('members').findOne(query, function(err, res) {
                     if (!err && res) {
                         log.user_id = res._id + "";
-                        if (log.u == "") {
+                        if (log.u === "") {
                             log.u = res.email || res.username;
                         }
                     }
@@ -333,6 +349,6 @@ var plugin = {},
         update["a." + common.db.encode(action)] = true;
         common.db.collection("systemlogs").update({_id: "meta_v2"}, {$set: update}, {upsert: true}, function() {});
     }
-}(plugin));
+}(pluginOb));
 
-module.exports = plugin;
+module.exports = pluginOb;