@autofleet/network 1.0.0

package/.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2
+jobs:
+  test:
+    docker:
+      - image: circleci/node:8.9.4
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "package.json" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+      - run: npm i
+      - save_cache:
+          paths:
+            - node_modules
+          key: v1-dependencies-{{ checksum "package.json" }}
+      - run: npm run coverage
+      - run: rm -rf ./coverage
+      - run: npm run linter
+
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - test

package/index.js

@@ -0,0 +1,95 @@
+const axios = require('axios');
+const axiosRetry = require('axios-retry');
+const { Logger } = require('@autofleet/node-common');
+const qs = require('qs');
+const httpAdapter = require('axios/lib/adapters/http');
+require('dotenv').config();
+/**
+ * Add support for nock testing
+ * see s://github.com/axios/axios/issues/305
+ */
+if (process.env.NODE_ENV === 'test') {
+  axios.defaults.adapter = httpAdapter;
+}
+
+const HTTPMethods = [
+  'get',
+  'post',
+  'delete',
+  'head',
+  'put',
+  'patch',
+  'options',
+];
+
+const defaultSettings = {
+  timeout: 2500,
+  headers: { 'X-AF-AUTH': 'ANYONE' },
+  paramsSerializer: params => qs.stringify(params, { arrayFormat: 'brackets' }),
+};
+
+module.exports = class Network {
+  constructor(settings = {}) {
+    this.settings = Object.assign({}, defaultSettings, settings);
+    this.createBaseUrl();
+
+    this.axios = axios.create(this.settings);
+    this.addRetry(settings);
+    this.buildClassHttpMethods();
+    this.addLogs();
+  }
+
+  addRetry(settings) {
+    axiosRetry(this.axios, {
+      retries: 0,
+      retryDelay: axiosRetry.exponentialDelay,
+      ...settings,
+    });
+  }
+
+  addLogs() {
+    const logger = Logger();
+    this.axios.interceptors.request.use((request) => {
+      logger.info(`Start Request: [${request.method.toUpperCase()}] ${request.baseURL} ${request.url}`, {
+        headers: request.headers,
+        query: request.query,
+        body: request.body,
+      });
+      return request;
+    });
+
+    this.axios.interceptors.response.use((response) => {
+      logger.info(`Finish Request: [${response.config.method.toUpperCase()} ${response.config.url}`);
+      return response;
+    }, (error) => {
+      logger.error('Finish Request with error', { status: error.status, data: error.response && error.response.data });
+      throw error;
+    });
+  }
+
+  createBaseUrl() {
+    if (!this.settings.serviceUrl && !this.settings.serviceName) {
+      throw new Error('At least one of the settings Missing serviceUrl or serviceName');
+    }
+
+    const { settings } = this;
+    if (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) {
+        throw new Error(`Missing environment variable: ${envServiceHostName}`);
+      }
+    }
+  }
+
+  /**
+   * Build class methods that wrap axios methods
+   */
+  buildClassHttpMethods() {
+    HTTPMethods.forEach((method) => {
+      this[method] = (...args) => this.axios[method](...args);
+    });
+  }
+};

package/index.test.js

@@ -0,0 +1,69 @@
+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 url', async () => {
+    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);
+  });
+
+  it('Getting 404', async () => {
+    const n = new Network({ serviceUrl: 'https://www.apple.com' });
+
+    const action = async () => n.get('/resource', {
+      query: {
+        a: 'b',
+      },
+    });
+
+    expect(action()).rejects.toThrow(Error);
+  });
+
+  test('Retry 1 time', async () => {
+    nock('https://www.apple2.com')
+      .get('/resource')
+      .once()
+      .reply(500);
+
+
+    nock('https://www.apple2.com')
+      .get('/resource')
+      .once()
+      .reply(200, { two: 2 });
+
+    const n = new Network({ serviceUrl: 'https://www.apple2.com' });
+    const response = await n.get('/resource', {
+      query: {
+        a: 'b',
+      },
+      'axios-retry': {
+        retries: 1,
+      },
+    });
+
+    expect(response).toBeDefined();
+    expect(response.data).toBeDefined();
+    expect(response.data.two).toBe(2);
+  });
+});

package/jest.config.js

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

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@autofleet/network",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest --forceExit --runInBand",
+    "test-auto": "jest --watch --runInBand",
+    "linter": "./node_modules/.bin/eslint ."
+  },
+  "author": "Dor Shay",
+  "license": "ISC",
+  "dependencies": {
+    "@autofleet/node-common": "^1.1.50",
+    "axios": "^0.18.0",
+    "axios-retry": "^3.1.1",
+    "dotenv": "^6.0.0",
+    "qs": "^6.5.2"
+  },
+  "devDependencies": {
+    "jest": "22.4.3",
+    "nock": "^10.0.0"
+  }
+}