Enhance logging

Author: Lee Richmond

package.json

@@ -38,7 +38,8 @@
     "tslint-loader": "^3.3.0",
     "typescript": "^2.1.4",
     "webpack": "^1.14.0",
-    "webpack-stream": "^3.2.0"
+    "webpack-stream": "^3.2.0",
+    "winston": "^2.3.0"
   },
   "dependencies": {
     "es6-promise": "^4.0.5",

src/configuration.ts

@@ -2,10 +2,12 @@
 
 import Model from './model';
 import Attribute from './attribute';
+import Logger from './logger';
 
 export default class Config {
   static models: Array<typeof Model> = [];
   static typeMapping: Object = {};
+  static logger: Logger = new Logger();
 
   static bootstrap() : void {
     for (let model of this.models) {

src/logger.ts

@@ -0,0 +1,50 @@
+export default class Logger {
+  private _level = 2;
+  private LEVELS = {
+    debug: 1,
+    info:  2,
+    warn:  3,
+    error: 4
+  }
+
+  get level() {
+    for (let key in this.LEVELS) {
+      let val = this.LEVELS[key];
+      if (val === this._level) return key;
+    }
+  }
+
+  set level(value : string) {
+    let lvlValue = this.LEVELS[value];
+
+    if (lvlValue) {
+      this._level = lvlValue;
+    } else {
+      throw(`Log level must be one of ${Object.keys(this.LEVELS).join(', ')}`)
+    }
+  }
+
+  debug(stmt) {
+    if (this._level <= this.LEVELS.debug) {
+      console.debug(stmt);
+    }
+  }
+
+  info(stmt) {
+    if (this._level <= this.LEVELS.info) {
+      console.info(stmt);
+    }
+  }
+
+  warn(stmt) {
+    if (this._level <= this.LEVELS.warn) {
+      console.warn(stmt);
+    }
+  }
+
+  error(stmt) {
+    if (this._level <= this.LEVELS.warn) {
+      console.error(stmt);
+    }
+  }
+}

src/request.ts

@@ -0,0 +1,17 @@
+import Config from './configuration';
+import colorize from './util/colorize';
+
+export default class Request {
+  get(url : string) : Promise<japiDoc> {
+    Config.logger.info(colorize('cyan', 'GET: ') + colorize('magenta', url));
+
+    return new Promise((resolve, reject) => {
+      fetch(url).then((response) => {
+        response.json().then((json) => {
+          Config.logger.debug(colorize('bold', JSON.stringify(json, null, 4)));
+          resolve(json);
+        });
+      });
+    });
+  }
+}

src/scope.ts

@@ -2,6 +2,8 @@ import Model from './model';
 import Config from './configuration';
 import parameterize from './util/parameterize';
 import IncludeDirective from './util/include-directive';
+import Request from './request';
+import colorize from './util/colorize';
 
 export default class Scope {
   model: typeof Model;
@@ -125,15 +127,9 @@ export default class Scope {
   private _fetch(url : string) : Promise<Object> {
     let qp = this.toQueryParams();
     if (qp) {
-      url = `${url}?${qp}`
+      url = `${url}?${qp}`;
     }
-
-    return new Promise((resolve, reject) => {
-      fetch(url).then((response) => {
-        response.json().then((json) => {
-          resolve(json);
-        });
-      });
-    });
+    let request = new Request();
+    return request.get(url);
   }
 }

src/util/colorize.ts

@@ -0,0 +1,25 @@
+const COLORS = {
+  green:   [32, 39],
+  cyan:    [36, 39],
+  magenta: [35, 39],
+  bold:    [1,  22],
+}
+
+export default function colorize(color : string, text: string) : string {
+  if (supportsColor()) {
+    let map = COLORS[color];
+    return `\u001b[${map[0]}m${text}\u001b[${map[1]}m`;
+  } else {
+    return text;
+  }
+}
+
+function supportsColor() : boolean {
+  if (/^screen|^xterm|^vt100|color|ansi|cygwin|linux/i.test(process.env.TERM)) {
+    return true;
+  } else {
+    return false
+  }
+}
+
+

test/test-helper.ts

@@ -1,5 +1,7 @@
 /// <reference path="../index.d.ts" />
 
+let winston = require('winston');
+
 import * as es6Promise from 'es6-promise';
 import 'isomorphic-fetch';
 import * as sinon from 'sinon';
@@ -8,6 +10,11 @@ es6Promise.polyfill();
 import * as chai from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 import * as chaiThings from 'chai-things';
+import Config from '../src/configuration';
+import Logger from '../src/logger';
+
+winston.level = 'warn';
+Config.logger = winston;
 
 // MUST be in this order
 chai.use(chaiThings);