feat(sync): add dump surveys config for debugging (#18)

README.md

@@ -83,6 +83,7 @@ module.exports = {
 | :bangbang: | `AUTH_CLIENT_SECRET` | The secret to validate the JWT.         |                             |
 |            | `SURVEYS_COLLECTION` | The surveys collection name on MongoDB  | `surveyAddresses`           |
 |            | `SURVEYS_HISTORY`    | Keeps a history of survey changes       | `true`                      |
+|            | `SURVEYS_DUMP`       | Dumps every request to a collection     | `false`                     |
 |            | `MORGAN_FORMAT`      | Log format used by Morgan package       | `dev` on `NODE_ENV=development`, `combined` on `NODE_ENV=production` |
 |            | `DEBUG`              | Set to `sivy` to turn on debug logging. |                             |
 

src/controllers/sync.js

@@ -1,13 +1,15 @@
 const debug = require('debug')('sivy');
-const {map} = require('lodash');
+const {map, size, isEmpty} = require('lodash');
+
 const {SurveyAddress, surveyAddressState, SyncLog} = require('../model');
 const syncHandlers = require('../helpers/syncHandlers');
+const {SyncService} = require('../services');
 
 const setSurvey = async (survey, syncLog, user) => {
     if (survey.closed) {
         syncLog.closed++;
     }
-    if (survey.visits && survey.visits.length) {
+    if (!isEmpty(survey.visits)) {
         syncLog.visited++;
     }
     if (!survey.synced) {
@@ -42,6 +44,17 @@ const getSurvey = async surveyAddress => {
 };
 
 class SyncController {
+    static async dumpSurveys(req, res, next) {
+        try {
+            debug(`Dumping ${size(req.body.surveys)} surveys from user ${req.user._id}...`);
+            await SyncService.dumpSurveys(req.user._id, req.body.surveys);
+            next();
+        } catch (err) {
+            debug(`An error dumping the surveys for user ${req.user._id} has occurred.`);
+            next(err);
+        }
+    }
+
     static initSyncLog(req, res, next) {
         debug(`Init a syncLog for user ${req.user._id}.`);
         req.syncLog = new SyncLog({
@@ -59,12 +72,12 @@ class SyncController {
     static async setSurveys(req, res, next) {
         try {
             const surveys = req.body.surveys;
-            const surveysCount = surveys ? surveys.length : 0;
+            const surveysCount = size(surveys);
             debug(`Received ${surveysCount} surveys from user ${req.user._id}.`);
             if (surveysCount === 0) {
                 return next();
             }
-            req.syncLog.received = surveys.length;
+            req.syncLog.received = surveysCount;
             await syncHandlers.receiveSurveys(surveys, req.syncLog);
             await Promise.all(map(surveys, survey => setSurvey(survey, req.syncLog, req.user)));
             debug(`Saved ${surveysCount} surveys from user ${req.user._id}.`);
@@ -82,8 +95,8 @@ class SyncController {
                 user: req.user._id,
                 surveyAddressState: {$lt: surveyAddressState.CLOSED}
             }).populate('address').exec();
-            debug(`Sending ${surveyAddresses.length} surveys for user ${req.user._id}...`);
-            req.syncLog.sent = surveyAddresses.length;
+            req.syncLog.sent = size(surveyAddresses);
+            debug(`Sending ${req.syncLog.sent} surveys for user ${req.user._id}...`);
             await syncHandlers.getSurveys(surveyAddresses, req.syncLog);
             res.surveyAddresses = await Promise.all(map(surveyAddresses, getSurvey));
             next();

src/helpers/dotenv.js

@@ -12,6 +12,7 @@ process.env.MONGODB_URI = process.env.MONGODB_URI || 'mongodb://localhost';
 process.env.RECEIVE_ONLY = process.env.RECEIVE_ONLY || false;
 process.env.SURVEYS_COLLECTION = process.env.SURVEYS_COLLECTION || 'surveyAddresses';
 process.env.SURVEYS_HISTORY = process.env.SURVEYS_HISTORY || true;
+process.env.SURVEYS_DUMP = process.env.SURVEYS_DUMP || false;
 
 if (!process.env.MORGAN_FORMAT) {
     process.env.MORGAN_FORMAT = process.env.NODE_ENV === 'development' ? 'dev' : 'combined';

src/model/index.js

@@ -1,4 +1,5 @@
 exports.address = require('./address');
 exports.surveyAddressState = require('./surveyAddressState');
 exports.SurveyAddress = require('./surveyAddress');
+exports.SurveyDump = require('./surveyDump');
 exports.SyncLog = require('./syncLog');

src/model/surveyDump.js

@@ -0,0 +1,9 @@
+const {SURVEYS_COLLECTION} = process.env;
+const mongoose = require('mongoose');
+
+const {Mixed, ObjectId, Schema} = mongoose;
+
+module.exports = mongoose.model('SurveyDump', new Schema({
+    user: {type: ObjectId, required: true, ref: 'User'},
+    surveys: {type: Mixed}
+}, {collection: `${SURVEYS_COLLECTION}_dump`, strict: false, timestamps: true}));

src/routes/sync.js

@@ -1,4 +1,4 @@
-const {RECEIVE_ONLY} = process.env;
+const {RECEIVE_ONLY, SURVEYS_DUMP} = process.env;
 
 const logger = require('../helpers/logger');
 const {SyncController} = require('../controllers');
@@ -7,22 +7,26 @@ module.exports = router => {
     const receiveOnly = RECEIVE_ONLY === true.toString();
     logger.info(`Sync mode: ${receiveOnly ? 'receive-only' : 'send+receive'}.`);
 
-    if (receiveOnly) {
-        router.post('/',
-            SyncController.initSyncLog,
-            SyncController.setSurveys,
-            SyncController.saveSyncLog,
-            (req, res) => res.end()
-        );
-    } else {
-        router.post('/',
-            SyncController.initSyncLog,
-            SyncController.setSurveys,
-            SyncController.getSurveys,
-            SyncController.saveSyncLog,
-            (req, res) => res.send({surveyAddresses: res.surveyAddresses})
-        );
+    const surveysDump = SURVEYS_DUMP === true.toString();
+    logger.info(`Surveys dump is turned ${surveysDump ? 'on' : 'off'}.`);
+
+    const middlewares = [];
+    if (surveysDump) {
+        middlewares.push(SyncController.dumpSurveys);
+    }
+    middlewares.push(SyncController.initSyncLog, SyncController.setSurveys);
+
+    if (!receiveOnly) {
+        middlewares.push(SyncController.getSurveys);
     }
+    middlewares.push(SyncController.saveSyncLog);
+
+    middlewares.push(receiveOnly
+        ? (req, res) => res.end()
+        : (req, res) => res.send({surveyAddresses: res.surveyAddresses})
+    );
+
+    router.post('/', middlewares);
 
     return router;
 };

src/services/index.js

@@ -1 +1,2 @@
 exports.StatusService = require('./status');
+exports.SyncService = require('./sync');

src/services/sync.js

@@ -0,0 +1,10 @@
+const {SurveyDump} = require('../model');
+
+class SyncService {
+    static dumpSurveys(user, surveys) {
+        const surveyDump = new SurveyDump({user, surveys});
+        return surveyDump.save();
+    }
+}
+
+module.exports = SyncService;