add logs (#70)

Author: ecarriou

src/history.js

@@ -21,12 +21,14 @@
 /**
  * @module history
  * @requires db
+ * @requires log
  * @description This module manages the history of all components lifecycle
  */
 
 'use strict';
 
 var $db = require('./db.js');
+var $log = require('./log.js');
 
 /* Private property */
 
@@ -93,9 +95,15 @@ exports.back = function back() {
         $db[state.collection].remove({
           _id: state.id
         });
+        $log.historyDocumentRemoved(state.id, state.collection);
         break;
       case 'remove':
         $db[state.collection].insert(JSON.parse(state.oldValue));
+        $log.historyDocumentInserted(
+          state.id,
+          state.collection,
+          state.oldValue
+        );
         break;
       case 'update':
         update[state.field] = JSON.parse(state.oldValue);
@@ -106,6 +114,12 @@ exports.back = function back() {
           },
           update
         );
+        $log.historyDocumentUpdated(
+          state.id,
+          state.collection,
+          state.field,
+          state.oldValue
+        );
         break;
       default:
         break;
@@ -129,11 +143,13 @@ exports.forward = function forward() {
     switch (state.action) {
       case 'insert':
         $db[state.collection].insert(JSON.parse(state.value));
+        $log.historyDocumentInserted(state.id, state.collection, state.value);
         break;
       case 'remove':
         $db[state.collection].remove({
           _id: state.id
         });
+        $log.historyDocumentRemoved(state.id, state.collection);
         break;
       case 'update':
         update[state.field] = JSON.parse(state.value);
@@ -144,6 +160,12 @@ exports.forward = function forward() {
           },
           update
         );
+        $log.historyDocumentUpdated(
+          state.id,
+          state.collection,
+          state.field,
+          state.value
+        );
         break;
       default:
         break;

src/log.js

@@ -1137,3 +1137,72 @@ exports.unknownContext = function unknownContext(className, methodName) {
       "' without a valid context"
   );
 };
+
+/**
+ * @method historyDocumentInserted
+ * @param {Object} id id of the component
+ * @param {String} collectionName collectionName of the component
+ * @param {String} document
+ * @description Created document from history
+ */
+exports.historyDocumentInserted = function historyDocumentInserted(
+  id,
+  collectionName,
+  doc
+) {
+  getLogger().debug(
+    "Created component of id '" +
+      id +
+      "' (collection '" +
+      collectionName +
+      "') with document '" +
+      doc +
+      "'"
+  );
+};
+
+/**
+ * @method historyDocumentRemoved
+ * @param {Object} id id of the component
+ * @param {String} collectionName collectionName of the component
+ * @description Removed document from history
+ */
+exports.historyDocumentRemoved = function historyDocumentRemoved(
+  id,
+  collectionName
+) {
+  getLogger().debug(
+    "Destroyed component of id '" +
+      id +
+      "' (collection '" +
+      collectionName +
+      "')"
+  );
+};
+
+/**
+ * @method historyDocumentUpdated
+ * @param {Object} id id of the component
+ * @param {String} collectionName collectionName of the component
+ * @param {String} fieldName field name of the component
+ * @param {String} value value of the field
+ * @description Updated document from history
+ */
+exports.historyDocumentUpdated = function historyDocumentRemoved(
+  id,
+  collectionName,
+  fieldName,
+  value
+) {
+  getLogger().debug(
+    "Updated field '" +
+      fieldName +
+      "' of component of id '" +
+      id +
+      "' (collection '" +
+      collectionName +
+      "') with value '" +
+      value +
+      "'"
+  );
+};