@autofleet/node-common 1.0.9 → 1.1.2

package/.eslintrc.json

@@ -0,0 +1,11 @@
+{
+  "extends": [
+    "airbnb/base"
+  ],
+  "env": {
+    "jest": true
+  },
+  "rules": {
+    "semi": ["error", "never"]
+  }
+}

package/logger/example.js

@@ -1,4 +1,6 @@
 const logger = require('./index')('debug')
+
 logger.info('it is working')
 logger.error('errors displayed in logs/error.log')
-logger.debug('debug with object', {a: 5})
+logger.debug('debug with object', { a: 5 })
+logger.debug('debug with 2 objects', { 1: { a: 5 }, 2: { b: 2 } })

package/logger/index.js

@@ -1,32 +1,55 @@
-require('dotenv').config();
-const winston = require('winston')
+const { createLogger, transports, format } = require('winston')
+
+const { combine, timestamp, printf } = format
+
+require('dotenv').config()
+
 const { env } = process
 
 const getLevel = (logLevel) => {
   if (logLevel) return logLevel
-  if (env.LOG_LEVEL) return  env.LOG_LEVEL
-  if (env.NODE_ENV === 'development')  return 'debug'
+  if (env.LOG_LEVEL) return env.LOG_LEVEL
+  if (env.NODE_ENV === 'development') return 'debug'
   // test and producion will return info
   return 'info'
 }
 
 const getTransporters = () => {
-  let transporters = [new winston.transports.Console()]
+  const consoleTrasporter = new transports.Console()
+  let transporters = [consoleTrasporter]
   if (env.USE_LOG_FILES === 'true') {
     transporters = transporters.concat([
-      new winston.transports.File({ filename: 'logs/error.log', level: 'error' }),
-      new winston.transports.File({ filename: 'logs/all.log' })
+      new transports.File({ filename: 'logs/error.log', level: 'error' }),
+      new transports.File({ filename: 'logs/all.log' }),
     ])
   }
   return transporters
 }
 
-const createLogger = (level, transporters) => {
-  const logger = winston.createLogger({
+const newLogger = (level, transporters) => {
+  const customFormat = printf((info) => {
+    const level = info.level
+    const message = info.message
+    const timestamp = info.timestamp
+    delete info.level
+    delete info.message
+    delete info.timestamp
+    const params = JSON.stringify(info, null, 2)
+    return `${level}: ${message} ${timestamp} \n ${params} \n *****************`
+  })
+
+  const logger = createLogger({
+    format: combine(
+      format.colorize(),
+      // format.json(),
+      format.simple(),
+      // prettyPrint(),
+      timestamp(),
+      customFormat,
+    ),
     level,
-    format: winston.format.simple(),
-    transports: transporters
-  });
+    transports: transporters,
+  })
 
   return logger
 }
@@ -34,7 +57,8 @@ const createLogger = (level, transporters) => {
 const getLogger = (logLevel) => {
   const level = getLevel(logLevel)
   const transporters = getTransporters()
-  return createLogger(level, transporters)
+  return newLogger(level, transporters)
 }
 
-module.exports = getLogger 
+module.exports = getLogger
+

package/logger/index.test.js

@@ -1,57 +1,65 @@
 const Logger = require('./index')
-const fs = require('fs');
-const wait = require('wait-promise');
+const fs = require('fs')
+const wait = require('wait-promise')
 
 const { env } = process
 
-const waitForFileToHaveContent = (filePath) => {
-  return  wait.limit(30).until(() => {
-    if(fs.existsSync(filePath)) {
-      const content = fs.readFileSync(filePath, 'utf8');
-      return content != ''
-    }
-    return false
-  })
+const deleteLogFile = (filePath) => {
+  const dir = 'logs'
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir)
+  }
+  if (fs.existsSync(filePath)) {
+    fs.unlinkSync(filePath)
+  }
 }
 
+const waitForFileToHaveContent = (filePath => wait.limit(30).until(() => {
+  if (fs.existsSync(filePath)) {
+    const content = fs.readFileSync(filePath, 'utf8')
+    return content !== ''
+  }
+  return false
+}))
+
 describe('Logger', () => {
   it('it`s default level is info', () => {
-    env.NODE_ENV=''
+    env.NODE_ENV = ''
     const logger = Logger()
-    expect(logger).toBeDefined();
-    expect(logger.level).toBe('info');
+    expect(logger).toBeDefined()
+    expect(logger.level).toBe('info')
   })
 
   it('its default develpment level is debug', () => {
-    env.NODE_ENV='development'
+    env.NODE_ENV = 'development'
     const logger = Logger()
-    expect(logger.level).toBe('debug');
+    expect(logger.level).toBe('debug')
   })
 
   it('its default test level is info', () => {
-    env.NODE_ENV='test'
+    env.NODE_ENV = 'test'
     const logger = Logger()
-    expect(logger.level).toBe('info');
+    expect(logger.level).toBe('info')
   })
 
   it('its default production level is info', () => {
-    env.NODE_ENV='production'
+    env.NODE_ENV = 'production'
     const logger = Logger()
-    expect(logger.level).toBe('info');
+    expect(logger.level).toBe('info')
   })
 
   it('its level can be override by LOG_LEVEL env variable', () => {
-    env.NODE_ENV='development'
-    env.LOG_LEVEL='warn'
+    env.NODE_ENV = 'development'
+    env.LOG_LEVEL = 'warn'
     const logger = Logger()
-    expect(logger.level).toBe('warn');
+    expect(logger.level).toBe('warn')
   })
 
   it('its level can be override by function variable', () => {
-    env.NODE_ENV='production'
-    env.LOG_LEVEL='warn'
+    env.NODE_ENV = 'production'
+    env.LOG_LEVEL = 'warn'
     const logger = Logger('silly')
-    expect(logger.level).toBe('silly');
+    expect(logger.level).toBe('silly')
   })
 
   it('its has functions for each level', () => {
@@ -65,36 +73,36 @@ describe('Logger', () => {
   })
 
   it('it can have general file transporters', async () => {
-    env.USE_LOG_FILES='true'
+    env.USE_LOG_FILES = 'true'
     const allPath = 'logs/all.log'
-    fs.unlinkSync(allPath)
+    deleteLogFile(allPath)
+
     const logger = Logger()
-    const errorText = "this is error"
+    const errorText = 'this is error'
     logger.error(errorText)
 
     await waitForFileToHaveContent(allPath)
 
     expect(fs.existsSync(allPath)).toBe(true)
-  
-    const contents = fs.readFileSync(allPath, 'utf8');
+
+    const contents = fs.readFileSync(allPath, 'utf8')
     expect(contents).toBe(`error: ${errorText}\n`)
   })
 
   it('it can have general file transporters', async () => {
-    env.USE_LOG_FILES='true'
-
+    env.USE_LOG_FILES = 'true'
     const errorPath = 'logs/error.log'
-    fs.unlinkSync(errorPath)
+    deleteLogFile(errorPath)
+
     expect(fs.existsSync(errorPath)).toBe(false)
 
     const logger = Logger()
-    const errorText = "this is error"
+    const errorText = 'this is error'
     logger.error(errorText)
 
     await waitForFileToHaveContent(errorPath)
 
-    const contents = fs.readFileSync(errorPath, 'utf8');
+    const contents = fs.readFileSync(errorPath, 'utf8')
     expect(contents).toBe(`error: ${errorText}\n`)
   })
-
-});
+})

package/network/index.js

@@ -1,11 +1,12 @@
-const axios = require('axios');
-require('dotenv').config();
+const axios = require('axios')
+const httpAdapter = require('axios/lib/adapters/http')
+require('dotenv').config()
 /**
- * Add support for nock testing 
+ * Add support for nock testing
  * see s://github.com/axios/axios/issues/305
  */
 if (process.env.NODE_ENV === 'test') {
-  axios.defaults.adapter = require('axios/lib/adapters/http')
+  axios.defaults.adapter = httpAdapter
 }
 
 const HTTPMethods = [
@@ -15,12 +16,12 @@ const HTTPMethods = [
   'head',
   'put',
   'patch',
-  'options'
+  'options',
 ]
 
 const defaultSettings = {
   timeout: 2500,
-  headers: { 'X-AF-AUTH': 'ANYONE' }
+  headers: { 'X-AF-AUTH': 'ANYONE' },
 }
 
 module.exports = class Network {
@@ -38,23 +39,25 @@ module.exports = class Network {
   }
 
   createBaseUrl() {
-    let settings = this.settings
+    const { settings } = this
     if (settings.serviceUrl) {
-      settings.baseURL = settings.serviceUrl;
+      settings.baseURL = settings.serviceUrl
     } else if (settings.serviceName) {
       const envServiceHostName = `${settings.serviceName}_SERVICE_HOST`
-      settings.baseURL = 'http://' + process.env[envServiceHostName]
-      if(!settings.baseURL) {
+      settings.baseURL = `http://${process.env[envServiceHostName]}`
+      if (!settings.baseURL) {
         throw new Error(`Missing environment variable: ${envServiceHostName}`)
       }
     }
   }
-  
+
   /**
    * Build class methods that wrap axios methods
    */
   buildClassHttpMethods() {
-    this.axios = axios.create(this.settings);
-    HTTPMethods.map((method) => this[method] = (...args) => this.axios[method](...args))
+    this.axios = axios.create(this.settings)
+    HTTPMethods.forEach((method) => {
+      this[method] = (...args) => this.axios[method](...args)
+    })
   }
 }

package/network/index.test.js

@@ -1,5 +1,5 @@
-const nock = require('nock');
-const Network = require('./index');
+const nock = require('nock')
+const Network = require('./index')
 
 nock('http://www.google.com')
   .get('/resource')
@@ -13,19 +13,19 @@ nock('https://www.apple.com')
 describe('Network', () => {
   it('Making requests by service name from ENV', async () => {
     process.env.TEST_SERVICE_HOST = 'www.google.com'
-    n = new Network({ serviceName: 'TEST' });
-    const response = await n.get('/resource');
-    expect(response).toBeDefined();
-    expect(response.data).toBeDefined();
-    expect(response.data.one).toBe(1);
+    const n = new Network({ serviceName: 'TEST' })
+    const response = await n.get('/resource')
+    expect(response).toBeDefined()
+    expect(response.data).toBeDefined()
+    expect(response.data.one).toBe(1)
   })
 
   it('Making requests by service name from ENV', async () => {
     process.env.TEST_SERVICE_HOST = 'www.google.com'
-    n = new Network({ serviceUrl: 'https://www.apple.com' });
-    const response = await n.get('/resource');
-    expect(response).toBeDefined();
-    expect(response.data).toBeDefined();
-    expect(response.data.two).toBe(2);
+    const n = new Network({ serviceUrl: 'https://www.apple.com' })
+    const response = await n.get('/resource')
+    expect(response).toBeDefined()
+    expect(response.data).toBeDefined()
+    expect(response.data.two).toBe(2)
   })
-});
+})

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@autofleet/node-common",
-  "version": "1.0.9",
+  "version": "1.1.2",
   "description": "",
   "scripts": {
     "coverage": "jest --coverage --forceExit --runInBand",
     "test": "jest --forceExit --runInBand",
-    "test-auto": "jest --watch --runInBand"
+    "test-auto": "jest --watch --runInBand",
+    "linter": "./node_modules/.bin/eslint ."
   },
   "jest": {
     "setupTestFrameworkScriptFile": "jest-extended"
@@ -28,6 +29,9 @@
     "winston": "^3.0.0-rc5"
   },
   "devDependencies": {
+    "eslint": "^4.19.1",
+    "eslint-config-airbnb": "^16.1.0",
+    "eslint-plugin-import": "^2.11.0",
     "jest-extended": "^0.7.1",
     "nock": "^9.2.5"
   }