From 0435df2ef3ec775a07566a4536a508c71456a94e Mon Sep 17 00:00:00 2001
From: rubo77 <github@r.z11.de>
Date: Sun, 24 Jul 2016 13:36:56 +0200
Subject: [PATCH] Documents the main structure, that sends out emails for
 offline nodes

---
 server/services/monitoringService.js | 38 ++++++++++++++++++----------
 1 file changed, 25 insertions(+), 13 deletions(-)

diff --git a/server/services/monitoringService.js b/server/services/monitoringService.js
index 02e39fa..c5c7fac 100644
--- a/server/services/monitoringService.js
+++ b/server/services/monitoringService.js
@@ -22,6 +22,9 @@ angular.module('ffffng')
 ) {
     var MONITORING_STATE_MACS_CHUNK_SIZE = 100;
     var MONITORING_MAILS_DB_BATCH_SIZE = 50;
+    /**
+     * Defines the intervals emails are sent if a node is offline
+     */
     var MONITORING_OFFLINE_MAILS_SCHEDULE = {
         1: { amount: 3, unit: 'hours' },
         2: { amount: 1, unit: 'days' },
@@ -193,20 +196,20 @@ angular.module('ffffng')
         callback(null, data);
     }
 
-        function updateSkippedNode(id, node, callback) {
-            Database.run(
-                'UPDATE node_state ' +
-                'SET hostname = ?, monitoring_state = ?, modified_at = ?' +
-                'WHERE id = ?',
-                [
-                    node ? node.hostname : '', node ? node.monitoringState : '', moment().unix(),
-                    id
-                ],
-                callback
-            );
-        }
+    function updateSkippedNode(id, node, callback) {
+        Database.run(
+            'UPDATE node_state ' +
+            'SET hostname = ?, monitoring_state = ?, modified_at = ?' +
+            'WHERE id = ?',
+            [
+                node ? node.hostname : '', node ? node.monitoringState : '', moment().unix(),
+                id
+            ],
+            callback
+        );
+    }
 
-        function sendMonitoringMailsBatched(name, mailType, findBatchFun, callback) {
+    function sendMonitoringMailsBatched(name, mailType, findBatchFun, callback) {
         Logger.tag('monitoring', 'mail-sending').debug('Sending "%s" mails...', name);
 
         var sendNextBatch = function (err) {
@@ -327,11 +330,20 @@ angular.module('ffffng')
         );
     }
 
+    /**
+     * sends one of three mails if a node is offline
+     * @param  {moment}   startTime  the moment the job started
+     * @param  {Number}   mailNumber which of three mails
+     * @param  {Function} callback   gets all nodes that are offline
+     */
     function sendOfflineMails(startTime, mailNumber, callback) {
         sendMonitoringMailsBatched(
             'offline ' + mailNumber,
             'monitoring-offline-' + mailNumber,
             function (findBatchCallback) {
+                /**
+                 * descriptive string that stores, which was the last mail type, stored in the database as last_status_mail_type
+                 */
                 var previousType =
                     mailNumber === 1
                         ? 'monitoring-online-again'