feat(debug): Add debug feature for extra output (#41)

* feat(debug): Add debug feature for extra output

* build: Fix build with rollup json

Author: ChrisAlderson

package-lock.json

@@ -6,6 +6,7 @@
     "body-parser": "^1.18.2",
     "commander": "^2.12.2",
     "compression": "^1.7.1",
+    "debug": "^3.1.0",
     "del": "^3.0.0",
     "express": "^4.16.2",
     "express-winston": "git+https://github.com/ChrisAlderson/express-winston.git#3.0.0",
@@ -14,6 +15,7 @@
     "mongoose": "^4.13.7",
     "p-map": "^1.2.0",
     "response-time": "^2.3.2",
+    "rollup-plugin-json": "^2.3.0",
     "winston": "^3.0.0-rc1"
   },
   "devDependencies": {
@@ -30,27 +32,27 @@
     "babel-register": "^6.26.0",
     "chai": "^4.1.2",
     "coveralls": "^3.0.0",
-    "cross-env": "^5.1.1",
+    "cross-env": "^5.1.3",
     "esdoc": "^1.0.4",
     "esdoc-ecmascript-proposal-plugin": "^1.0.0",
     "esdoc-flow-type-plugin": "^1.0.1",
     "esdoc-standard-plugin": "^1.0.0",
-    "eslint": "^4.13.1",
-    "eslint-config-vixo": "^2.0.1",
+    "eslint": "^4.14.0",
+    "eslint-config-vixo": "^2.0.2",
     "flow": "^0.2.3",
     "flow-bin": "^0.61.0",
     "flow-typed": "^2.2.3",
     "husky": "^0.14.3",
     "mocha": "^4.0.1",
-    "nyc": "^11.4.0",
-    "rollup": "^0.52.2",
+    "nyc": "^11.4.1",
+    "rollup": "^0.53.0",
     "rollup-plugin-babel": "^3.0.3",
     "rollup-plugin-node-resolve": "^3.0.0",
     "rollup-plugin-uglify": "^2.0.1",
     "sinon": "^4.1.3",
     "standard-version": "^4.2.0",
     "supertest": "^3.0.0",
-    "uglify-es": "^3.2.2"
+    "uglify-es": "^3.3.2"
   },
   "license": "MIT",
   "scripts": {

package.json

@@ -1,4 +1,5 @@
 import babel from 'rollup-plugin-babel'
+import json from 'rollup-plugin-json'
 import resolve from 'rollup-plugin-node-resolve'
 import uglify from 'rollup-plugin-uglify'
 import { minify } from 'uglify-es'
@@ -22,6 +23,7 @@ export default {
   ],
   plugins: [
     resolve(),
+    json(),
     babel(),
     uglify({}, minify)
   ],

rollup.config.js

@@ -1,5 +1,6 @@
 // Import the necessary modules.
 // @flow
+import debug from 'debug'
 /**
  * Fast, unopinionated, minimalist web framework for node.
  * @external {Express} https://github.com/expressjs/express
@@ -16,6 +17,7 @@ import {
   Routes
 } from './middleware'
 import * as utils from './utils'
+import { name } from '../package.json'
 
 /**
  * The default log directory.
@@ -51,6 +53,12 @@ export default class PopApi {
    */
   static app: $Application = express()
 
+  /**
+   * The debugger for extra  output.
+   * @type {Function}
+   */
+  static debug: Function = debug(name)
+
   /**
    * A map of the installed plugins.
    * @type {Map<any>}

src/PopApi.js

@@ -55,10 +55,10 @@ export default class BaseContentController extends IContentController {
    * Default method to register the routes.
    * @override
    * @param {!Object} router - The router to register the routes to.
-   * @param {?PopApi} [PopApi] - The PopApi instance.
+   * @param {!PopApi} PopApi - The PopApi instance.
    * @returns {undefined}
    */
-  registerRoutes(router: Object, PopApi?: any): void {
+  registerRoutes(router: Object, PopApi: any): void {
     const t = this.basePath
 
     router.get(`/${t}s`, this.getContents.bind(this))

src/controllers/BaseContentController.js

@@ -11,11 +11,11 @@ export default class IController {
    * Default method to register the routes.
    * @abstract
    * @param {!Object} router - The router to register the routes to.
-   * @param {?PopApi} [PopApi] - The PopApi instance.
+   * @param {!PopApi} PopApi - The PopApi instance.
    * @throws {Error} - Using default method: 'registerRoutes'
    * @returns {undefined}
    */
-  registerRoutes(router: Object, PopApi?: any): void {
+  registerRoutes(router: Object, PopApi: any): void {
     throw new Error('Using default method: \'registerRoutes\'')
   }
 

src/controllers/IController.js

@@ -43,6 +43,13 @@ export default class Cli {
    * middleware!
    */
   constructor(PopApi: any, {argv, name, version}: Object): void {
+    const { name: debugName } = this.constructor
+    PopApi.debug(`Registering ${debugName} middleware with options: %o`, {
+      argv,
+      name,
+      version
+    })
+
     if (!name || !version) {
       throw new TypeError('\'name\' and \'version\' are required options for the Cli middleware!')
     }

src/middleware/Cli.js

@@ -70,6 +70,15 @@ export default class Database {
     username,
     password
   }: Object): void {
+    const { name: debugName } = this.constructor
+    PopApi.debug(`Registering ${debugName} middleware with options: %o`, {
+      database,
+      hosts,
+      dbPort,
+      username,
+      password
+    })
+
     if (!database) {
       throw new TypeError('\'database\' is a required option for the Database middleware!')
     }

src/middleware/Database.js

@@ -46,9 +46,15 @@ export default class HttpServer {
    */
   constructor(PopApi: any, {
     app,
-    serverPort = process.env.PORT,
+    serverPort = process.env.PORT || 5000,
     workers = 2
   }: Object): void {
+    const { name: debugName } = this.constructor
+    PopApi.debug(`Registering ${debugName} middleware with options: %o`, {
+      serverPort,
+      workers
+    })
+
     if (!app) {
       throw new TypeError('\'app\' is a required option for the HttpServer middleware!')
     }
@@ -62,7 +68,7 @@ export default class HttpServer {
      * The port on which the API will run on. Default is `5000`.
      * @type {number}
      */
-    this.serverPort = serverPort || 5000
+    this.serverPort = serverPort
     /**
      * The amount of workers on the cluster.
      * @type {number}

src/middleware/HttpServer.js

@@ -65,6 +65,14 @@ export default class Logger {
    * Logger middleware!
    */
   constructor(PopApi: any, {name, logDir, pretty, quiet}: Object): void {
+    const { name: debugName } = this.constructor
+    PopApi.debug(`Registering ${debugName} middleware with options: %o`, {
+      name,
+      logDir,
+      pretty,
+      quiet
+    })
+
     if (!name || !logDir) {
       throw new TypeError('\'name\' and \'logDir\' are required options for the Logger middleware!')
     }

src/middleware/Logger.js

@@ -34,6 +34,11 @@ export default class Routes {
    * middleware!
    */
   constructor(PopApi: any, {app, controllers}: Object): void {
+    const { name: debugName } = this.constructor
+    PopApi.debug(`Registering ${debugName} middleware with options: %o`, {
+      controllers
+    })
+
     if (!app) {
       throw new TypeError('\'app\' is a required option for the Routes middleware!')
     }
@@ -58,6 +63,7 @@ export default class Routes {
       const { Controller, args } = c
       const controller = new Controller(args)
 
+      PopApi.debug(`Registering ${Controller.name} route controller`)
       controller.registerRoutes(app, PopApi)
     })
   }

src/middleware/Routes.js

@@ -23,6 +23,12 @@ describe('PopApi', () => {
     expect(PopApi.app).to.exist
   })
 
+  /** @test {PopApi.debug} */
+  it('should have a debug function for extra output', () => {
+    expect(PopApi.debug).to.exist
+    expect(PopApi.debug).to.be.a('function')
+  })
+
   /** @test {PopApi._installedPlugins} */
   it('should have a static map for the installed plugins', () => {
     expect(PopApi._installedPlugins).to.exist

test/PopApi.spec.js

@@ -10,7 +10,8 @@ import supertest from 'supertest'
 import {
   BaseContentController,
   ContentService,
-  Database
+  Database,
+  PopApi
 } from '../../src'
 import {
   ExampleModel,
@@ -87,7 +88,7 @@ describe('BaseContentController', () => {
     baseContentController.registerRoutes(app)
     request = supertest(app)
 
-    database = new Database({}, {
+    database = new Database(PopApi, {
       database: name
     })
     database.connect()

test/controllers/BaseContentController.spec.js

@@ -5,7 +5,8 @@ import { expect } from 'chai'
 
 import {
   ContentService,
-  Database
+  Database,
+  PopApi
 } from '../../src'
 import {
   ExampleModel,
@@ -41,7 +42,7 @@ describe('ContentService', () => {
       query: {}
     })
 
-    database = new Database({}, {
+    database = new Database(PopApi, {
       database: name
     })
     database.connect()

test/controllers/ContentService.spec.js

@@ -4,7 +4,10 @@
 import sinon from 'sinon'
 import { expect } from 'chai'
 
-import { Cli } from '../../src'
+import {
+  Cli,
+  PopApi
+} from '../../src'
 import {
   name,
   version
@@ -45,7 +48,7 @@ describe('Cli', () => {
     error = sinon.stub(console, 'error')
     info = sinon.stub(console, 'info')
 
-    cli = new Cli({}, {
+    cli = new Cli(PopApi, {
       argv: ['', '', '-m', 'pretty'],
       name,
       version
@@ -54,14 +57,14 @@ describe('Cli', () => {
 
   /** @test {Cli#constructor} */
   it('should create a new Cli instance without arguments to parse', () => {
-    const cli = new Cli({}, {
+    const cli = new Cli(PopApi, {
       name,
       version
     })
     expect(cli).to.be.an('object')
 
     try {
-      new Cli({}, {}) // eslint-disable-line no-new
+      new Cli(PopApi, {}) // eslint-disable-line no-new
       expect(true).to.be.false
     } catch (err) {
       expect(err).to.be.an('Error')

test/middleware/Cli.spec.js

@@ -8,7 +8,10 @@ import sinon from 'sinon'
 import { expect } from 'chai'
 import { join } from 'path'
 
-import { Database } from '../../src'
+import {
+  Database,
+  PopApi
+} from '../../src'
 import { name } from '../../package'
 
 /** @test {Database} */
@@ -56,7 +59,7 @@ describe('Database', () => {
     ])
     mkdirp.sync(logDir)
 
-    database = new Database({}, {
+    database = new Database(PopApi, {
       database: name,
       username: '',
       password: ''
@@ -67,18 +70,18 @@ describe('Database', () => {
   it('should test the use the environment variables to connect', () => {
     const stub = process.env.MONGO_PORT_27017_TCP_ADDR
     process.env.MONGO_PORT_27017_TCP_ADDR = 'localhost'
-    new Database({}, { // eslint-disable-line no-new
+    new Database(PopApi, { // eslint-disable-line no-new
       database: name
     })
 
     process.env.MONGO_PORT_27017_TCP_ADDR = null
-    new Database({}, { // eslint-disable-line no-new
+    new Database(PopApi, { // eslint-disable-line no-new
       database: name
     })
     process.env.MONGO_PORT_27017_TCP_ADDR = stub
 
     try {
-      new Database({}, {}) // eslint-disable-line no-new
+      new Database(PopApi, {}) // eslint-disable-line no-new
       expect(true).to.be.false
     } catch (err) {
       expect(err).to.be.an('Error')
@@ -113,7 +116,7 @@ describe('Database', () => {
     expect(mongoose.connection.readyState).to.equal(0)
 
     try {
-      new Database({}, { // eslint-disable-line no-new
+      new Database(PopApi, { // eslint-disable-line no-new
         database: name
       })
       process.env.NODE_ENV = 'test'
@@ -165,7 +168,7 @@ describe('Database', () => {
     expect(mongoose.connection.readyState).to.be.a('number')
     expect(mongoose.connection.readyState).to.equal(0)
 
-    const database = new Database({}, {
+    const database = new Database(PopApi, {
       database: name,
       username: 'fault',
       password: 'faulty'