@autofleet/node-common 1.0.8 → 1.1.1

package/.eslintrc.json

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

package/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+image: node:8.9.4
+
+stages:
+  - test
+
+before_script:
+    - node -v
+    - npm -v
+    - npm install
+test:
+  stage: test
+  script:
+   - npm run coverage

package/.jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  testEnvironment: 'node',
+  coverageThreshold: {
+    global: {
+      lines: 80,
+    },
+  },
+};

package/logger/index.js

@@ -1,31 +1,41 @@
 const winston = require('winston')
+require('dotenv').config()
 
-const createLogger = (logLevel) => {
-  let level = logLevel ? logLevel : 'info'
-  const logger = winston.createLogger({
-    level,
-    format: winston.format.simple(),
-    transports: [
-      //
-      // - Write to all logs with level `info` and below to `combined.log` 
-      // - Write all logs error (and below) to `error.log`.
-      //
-      new winston.transports.File({ filename: 'logs/error.log', level: 'error' }),
-      new winston.transports.File({ filename: 'logs/combined.log' })
-    ]
-  });
+const { env } = process
 
-  //
-  // If we're not in production then log to the `console` with the format:
-  // `${info.level}: ${info.message} JSON.stringify({ ...rest }) `
-  // 
-  if (process.env.NODE_ENV !== 'production') {
-    logger.add(new winston.transports.Console({
-      format: winston.format.simple()
-    }));
+const getLevel = (logLevel) => {
+  if (logLevel) return logLevel
+  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()]
+  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' }),
+    ])
   }
+  return transporters
+}
+
+const createLogger = (level, transporters) => {
+  const logger = winston.createLogger({
+    level,
+    format: winston.format.json(),
+    transports: transporters,
+  })
 
   return logger
 }
 
-module.exports = createLogger 
+const getLogger = (logLevel) => {
+  const level = getLevel(logLevel)
+  const transporters = getTransporters()
+  return createLogger(level, transporters)
+}
+
+module.exports = getLogger

package/logger/index.test.js

@@ -0,0 +1,110 @@
+const Logger = require('./index')
+const fs = require('fs')
+const wait = require('wait-promise')
+
+const { env } = process
+
+const deleteLogFile = (filePath) => {
+  const dir = 'logs'
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir)
+  }
+  if (fs.existsSync(filePath)) {
+    fs.unlinkSync(filePath)
+  }
+}
+
+const waitForFileToHaveContent = ((filePath) => {
+  return 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=''
+    const logger = Logger()
+    expect(logger).toBeDefined()
+    expect(logger.level).toBe('info')
+  })
+
+  it('its default develpment level is debug', () => {
+    env.NODE_ENV='development'
+    const logger = Logger()
+    expect(logger.level).toBe('debug')
+  })
+
+  it('its default test level is info', () => {
+    env.NODE_ENV='test'
+    const logger = Logger()
+    expect(logger.level).toBe('info')
+  })
+
+  it('its default production level is info', () => {
+    env.NODE_ENV='production'
+    const logger = Logger()
+    expect(logger.level).toBe('info')
+  })
+
+  it('its level can be override by LOG_LEVEL env variable', () => {
+    env.NODE_ENV='development'
+    env.LOG_LEVEL='warn'
+    const logger = Logger()
+    expect(logger.level).toBe('warn')
+  })
+
+  it('its level can be override by function variable', () => {
+    env.NODE_ENV='production'
+    env.LOG_LEVEL='warn'
+    const logger = Logger('silly')
+    expect(logger.level).toBe('silly')
+  })
+
+  it('its has functions for each level', () => {
+    const logger = Logger()
+    expect(logger.error).toBeFunction()
+    expect(logger.warn).toBeFunction()
+    expect(logger.info).toBeFunction()
+    expect(logger.verbose).toBeFunction()
+    expect(logger.debug).toBeFunction()
+    expect(logger.silly).toBeFunction()
+  })
+
+  it('it can have general file transporters', async () => {
+    env.USE_LOG_FILES='true'
+    const allPath = 'logs/all.log'
+    deleteLogFile(allPath)
+
+    const logger = Logger()
+    const errorText = "this is error"
+    logger.error(errorText)
+
+    await waitForFileToHaveContent(allPath)
+
+    expect(fs.existsSync(allPath)).toBe(true)
+  
+    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'
+    const errorPath = 'logs/error.log'
+    deleteLogFile(errorPath)
+
+    expect(fs.existsSync(errorPath)).toBe(false)
+
+    const logger = Logger()
+    const errorText = "this is error"
+    logger.error(errorText)
+
+    await waitForFileToHaveContent(errorPath)
+
+    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 {
@@ -32,29 +33,31 @@ module.exports = class Network {
   }
 
   validate() {
-    if (!this.settings.serviceUrl && ! this.settings.serviceName) {
+    if (!this.settings.serviceUrl && !this.settings.serviceName) {
       throw new Error('At least one of the settings Missing serviceUrl or serviceName')
     }
   }
 
   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

@@ -0,0 +1,31 @@
+const nock = require('nock')
+const Network = require('./index')
+
+nock('http://www.google.com')
+  .get('/resource')
+  .reply(200, { one: 1 })
+
+
+nock('https://www.apple.com')
+  .get('/resource')
+  .reply(200, { two: 2 })
+
+describe('Network', () => {
+  it('Making requests by service name from ENV', async () => {
+    process.env.TEST_SERVICE_HOST = 'www.google.com'
+    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'
+    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,10 +1,15 @@
 {
   "name": "@autofleet/node-common",
-  "version": "1.0.8",
+  "version": "1.1.1",
   "description": "",
-  "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "coverage": "jest --coverage --forceExit --runInBand",
+    "test": "jest --forceExit --runInBand",
+    "test-auto": "jest --watch --runInBand",
+    "linter": "./node_modules/.bin/eslint ."
+  },
+  "jest": {
+    "setupTestFrameworkScriptFile": "jest-extended"
   },
   "repository": {
     "type": "git",
@@ -19,6 +24,15 @@
   "dependencies": {
     "axios": "^0.18.0",
     "dotenv": "^5.0.1",
+    "jest": "^22.4.3",
+    "wait-promise": "^0.4.1",
     "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"
   }
 }