Merge branch 'logger'

Author: shengyuan

gulpfile.js

@@ -14,6 +14,7 @@ const base = [
   '../setimmediate/setImmediate.js',
   '../paho/src/mqttws31.js',
   'src/webduino.js',
+  'src/core/Logger.js',
   'src/core/EventEmitter.js',
   'src/core/util.js',
   'src/util/promisify.js',

index.js

@@ -3,6 +3,7 @@ var webduino = require('./src/webduino');
 require('setimmediate');
 
 require('./src/core/EventEmitter')(webduino);
+require('./src/core/Logger')(webduino);
 require('./src/core/util')(webduino);
 require('./src/util/promisify')(webduino);
 require('./src/core/Transport')(webduino);

src/core/Board.js

@@ -12,6 +12,7 @@
   var EventEmitter = scope.EventEmitter,
     TransportEvent = scope.TransportEvent,
     Transport = scope.Transport,
+    Logger = scope.Logger,
     Pin = scope.Pin,
     util = scope.util,
     proto;
@@ -94,6 +95,7 @@
     this._numDigitalPortReportRequests = 0;
     this._transport = null;
     this._pinStateEventCenter = new EventEmitter();
+    this._logger = new Logger('Board');
 
     this._initialVersionResultHandler = onInitialVersionResult.bind(this);
     this._openHandler = onOpen.bind(this);
@@ -126,6 +128,8 @@
 
   function onMessage(data) {
     try {
+      this._logger.info('onMessage', data);
+
       var len = data.length;
 
       if (len) {
@@ -142,6 +146,7 @@
   }
 
   function onError(error) {
+    this._logger.warn('onError', error);
     this._isReady = false;
     this.emit(BoardEvent.ERROR, error);
     setImmediate(this.disconnect.bind(this));
@@ -180,10 +185,6 @@
     }
   }
 
-  function debug(msg) {
-    console && console.log(msg.stack || msg);
-  }
-
   Board.prototype = proto = Object.create(EventEmitter.prototype, {
 
     constructor: {
@@ -263,6 +264,7 @@
 
     switch (command) {
     case DIGITAL_MESSAGE:
+      this._logger.info('processMultiByteCommand digital:', channel, commandData[1], commandData[2]);
       this.processDigitalMessage(channel, commandData[1], commandData[2]);
       break;
     case REPORT_VERSION:
@@ -272,6 +274,7 @@
       });
       break;
     case ANALOG_MESSAGE:
+      this._logger.info('processMultiByteCommand analog:', channel, commandData[1], commandData[2]);
       this.processAnalogMessage(channel, commandData[1], commandData[2]);
       break;
     }
@@ -833,11 +836,11 @@
       resolution;
 
     for (var i = 0; i < len; i++) {
-      debug('Pin ' + i + ':');
+      this._logger.info("reportCapabilities, Pin " + i);
       for (var mode in capabilities[i]) {
         if (capabilities[i].hasOwnProperty(mode)) {
           resolution = capabilities[i][mode];
-          debug('\t' + mode + ' (' + resolution + (resolution > 1 ? ' bits)' : ' bit)'));
+          this._logger.info("reportCapabilities", '\t' + mode + ' (' + resolution + (resolution > 1 ? ' bits)' : ' bit)'));
         }
       }
     }

src/core/Logger.js

@@ -0,0 +1,83 @@
++(function (factory) {
+  if (typeof exports === 'undefined') {
+    factory(webduino || {});
+  } else {
+    module.exports = factory;
+  }
+}(function (scope) {
+  'use strict';
+
+  var DEBUG_STR = 'DEBUG_WEBDUINOJS';
+
+  function Logger(option) {
+    if (!option) {
+      option = '*';
+    }
+    if (typeof option === 'string') {
+      option = { key: option };
+    }
+    this._option = option;
+    this._key = option.key;
+    this._isShow = isShow.bind(this);
+    init.call(this);
+  }
+
+  function hasLocalStorage() {
+    try {
+      return !!localStorage;
+    } catch (err) {
+      return false;
+    }
+  }
+
+  function hasProcess() {
+    try {
+      return !!process;
+    } catch (err) {
+      return false;
+    }
+  }
+
+  function isShow() {
+    var reg = new RegExp();
+    var debugKeys = [];
+    var debugStr;
+
+    if (hasLocalStorage()) {
+      debugStr = localStorage.getItem(DEBUG_STR);
+    }
+
+    if (hasProcess()) {
+      debugStr = process.env[DEBUG_STR];
+    }
+
+    if (debugStr) {
+      debugKeys = debugStr.split(',').map(function (val) {
+        return val.trim();
+      });
+    }
+
+    if (debugKeys.indexOf('*') !== -1 || debugKeys.indexOf(this._key) !== -1) {
+      return true;
+    }
+
+    return false;
+  }
+
+  function init() {
+    var self = this;
+    var methodNames = ['log', 'info', 'warn', 'error'];
+    var noop = function () { };
+    var isCopy = this._isShow();
+    
+    methodNames.forEach(function (name) {
+      if (isCopy) {
+        self[name] = Function.prototype.bind.call(console[name], console);
+      } else {
+        self[name] = noop;
+      }
+    });
+  }
+
+  scope.Logger = Logger;
+}));