feat(survey): add support for additional attributes on model (#20)

.eslintrc.json

@@ -9,7 +9,7 @@
     "plugin:promise/recommended"
   ],
   "parserOptions": {
-    "ecmaVersion": 2017
+    "ecmaVersion": 2018
   },
   "env": {
     "es6": true,

README.md

@@ -53,7 +53,9 @@ By default the SurveyAddress has the following Mongoose's schema:
     dwellings: [{type: Mixed}],
     user: {type: ObjectId, required: true},
     address: {type: ObjectId, ref: 'Address', required: true},
-    surveyAddressState: {type: Number}
+    surveyAddressState: {type: Number},
+    state: {type: Number},
+    valid: {type: Number}
 }
 ```
 
@@ -69,6 +71,18 @@ module.exports = {
 
 ```
 
+Also, you can add additional attributes to the SurveyAddress's schema defining a `model/surveyAddress.js` as the following:
+
+```js
+module.exports = {
+    visits: [{
+        order: {type: Number, required: true},
+        date: {type: Date, required: true},
+        comments: {type:String}
+    }]
+};
+``` 
+
 ### Environment variables
 
 | Required   | Variable             | Description                             | Defaults to                 |

src/controllers/sync.js

@@ -3,7 +3,7 @@ const {map, size, isEmpty} = require('lodash');
 
 const {SurveyAddress, surveyAddressState, SyncLog} = require('../model');
 const syncHandlers = require('../helpers/syncHandlers');
-const {SyncService} = require('../services');
+const {SurveyService, SyncService} = require('../services');
 
 const setSurvey = async (survey, syncLog, user) => {
     if (survey.closed) {
@@ -24,12 +24,7 @@ const setSurvey = async (survey, syncLog, user) => {
     if (!surveyAddress) {
         return;
     }
-    surveyAddress.surveyAddressState = survey.closed ? surveyAddressState.RESOLVED : surveyAddressState.IN_PROGRESS;
-    surveyAddress.visits = survey.visits;
-    surveyAddress.dwellings = survey.dwellings;
-    if (survey.valid >= 0) {
-        surveyAddress.valid = survey.valid;
-    }
+    SurveyService.assign(surveyAddress, survey);
     await syncHandlers.preSaveSurvey(surveyAddress, syncLog);
     await surveyAddress.save();
 };

src/model/dwelling.js

@@ -1,16 +1,15 @@
-const path = require('path');
-const fs = require('fs');
 const mongoose = require('mongoose');
 
 const logger = require('../helpers/logger');
+const UtilService = require('../services/util');
 
 const {Mixed} = mongoose;
 
-const dwellingFile = path.resolve('./model/dwelling.js');
+const dwelling = UtilService.tryRequire('./model/dwelling.js');
 
-if (fs.existsSync(dwellingFile)) {
-    module.exports = require(dwellingFile);
-    logger.info('Loading dwelling model...');
+if (dwelling) {
+    logger.info('Loading Dwelling model...');
+    module.exports = dwelling;
 } else {
     logger.warn('Dwelling model not found. Using Mixed type...');
     module.exports = {type: Mixed};

src/model/index.js

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

src/model/surveyAddress.js

@@ -3,6 +3,7 @@ const mongoose = require('mongoose');
 
 const logger = require('../helpers/logger');
 const dwelling = require('./dwelling');
+const surveyAddressAdditionalAttributes = require('./surveyAddressAdditionalAttributes');
 
 const {ObjectId, Schema} = mongoose;
 
@@ -12,11 +13,14 @@ const surveyAddressSchema = new Schema({
     dwellings: [dwelling],
     user: {type: ObjectId, required: true},
     address: {type: ObjectId, ref: 'Address', required: true},
-    state: {type: Number}
+    surveyAddressState: {type: Number},
+    state: {type: Number},
+    valid: {type: Number},
+    ...surveyAddressAdditionalAttributes
 }, {collection: SURVEYS_COLLECTION, timestamps: true});
 
 const surveysHistory = SURVEYS_HISTORY === true.toString();
-logger.info(`Surveys history is turned ${surveysHistory ? 'on' : 'off'}.`);
+logger.info(`Surveys history is turned ${surveysHistory ? 'ON' : 'off'}.`);
 
 if (surveysHistory) {
     surveyAddressSchema.plugin(require('mongoose-history'));

src/model/surveyAddressAdditionalAttributes.js

@@ -0,0 +1,9 @@
+const logger = require('../helpers/logger');
+const UtilService = require('../services/util');
+
+const surveyAddress = UtilService.tryRequire('./model/surveyAddress.js');
+
+if (surveyAddress) {
+    logger.info('Loading SurveyAddress additional attributes...');
+    module.exports = surveyAddress;
+}

src/routes/sync.js

@@ -8,7 +8,7 @@ module.exports = router => {
     logger.info(`Sync mode: ${receiveOnly ? 'receive-only' : 'send+receive'}.`);
 
     const surveysDump = SURVEYS_DUMP === true.toString();
-    logger.info(`Surveys dump is turned ${surveysDump ? 'on' : 'off'}.`);
+    logger.info(`Surveys dump is turned ${surveysDump ? 'ON' : 'off'}.`);
 
     const middlewares = [];
     if (surveysDump) {

src/services/index.js

@@ -1,2 +1,4 @@
 exports.StatusService = require('./status');
+exports.SurveyService = require('./survey');
 exports.SyncService = require('./sync');
+exports.UtilService = require('./util');

src/services/status.js

@@ -1,9 +1,10 @@
-const path = require('path');
 const mongoose = require('mongoose');
 const {every, concat} = require('lodash');
 
+const UtilService = require('./util');
+
 const sivyPkg = require('../../package');
-const pkg = require(path.resolve('./package.json'));
+const pkg = UtilService.tryRequire('./package.json') || {};
 
 /**
  * Creates the status object

src/services/survey.js

@@ -0,0 +1,20 @@
+const {forEach, keys} = require('lodash');
+
+const {SurveyAddressAdditionalAttributes, surveyAddressState} = require('../model');
+
+class SurveyService {
+    static assign(surveyAddress, survey) {
+        surveyAddress.surveyAddressState = survey.closed ? surveyAddressState.RESOLVED : surveyAddressState.IN_PROGRESS;
+        surveyAddress.dwellings = survey.dwellings;
+        surveyAddress.valid = survey.valid;
+
+        forEach(
+            keys(SurveyAddressAdditionalAttributes),
+            key => {
+                surveyAddress[key] = survey[key];
+            }
+        );
+    }
+}
+
+module.exports = SurveyService;

src/services/util.js

@@ -0,0 +1,15 @@
+const path = require('path');
+const fs = require('fs');
+
+class UtilService {
+    /**
+     * Try to require a file if that exists.
+     * @param {String} from The path to the required file.
+     */
+    static tryRequire(from) {
+        const file = path.resolve(from);
+        return fs.existsSync(file) ? require(file) : null;
+    }
+}
+
+module.exports = UtilService;