Merge branch 'dev'

Author: Weffe

.circleci/config.yml

@@ -0,0 +1,37 @@
+# Javascript Node CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-javascript/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/node:10.14.1
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/mongo:3.4.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "package.json" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run: yarn install
+
+      - save_cache:
+          paths:
+            - node_modules
+          key: v1-dependencies-{{ checksum "package.json" }}
+
+      # run tests!
+      - run: yarn test

package.json

@@ -42,6 +42,7 @@
     "axios": "^0.18.0",
     "axios-mock-adapter": "^1.16.0",
     "docsify-cli": "^4.3.0",
+    "http-status-codes": "^1.3.2",
     "jest": "^24.1.0",
     "npm-run-all": "^4.1.5",
     "rimraf": "^2.6.3",
@@ -74,4 +75,4 @@
     },
     "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.ts$"
   }
-}
+}

src/__tests__/axios-api-versioning.mock.ts

@@ -0,0 +1,82 @@
+import axios from 'axios';
+import MockAdapter from 'axios-mock-adapter';
+import * as status from 'http-status-codes';
+import { withVersioning } from '../axios-api-versioning';
+import { IWithVersioningConfig, VersioningStrategy } from '../types';
+import { AxiosInstanceWithVersioning } from '../types/axios';
+
+const test_url = 'http://localhost:3000';
+const MOCK_RES = 'hello_world';
+let mock: MockAdapter;
+let instance: AxiosInstanceWithVersioning;
+
+describe('Testing correct response config of "QueryString" strategy', () => {
+    let versioningConfig: IWithVersioningConfig = {
+        apiVersion: '1.0',
+        versioningStrategy: VersioningStrategy.QueryString
+    };
+
+    beforeAll(() => {
+        instance = withVersioning(axios, versioningConfig);
+        mock = new MockAdapter(instance);
+    })
+
+    test('it should have the "apiVersion" as a query param in the response config', async () => {
+        mock.onGet(test_url)
+            .reply(status.OK, MOCK_RES);
+
+        const res = await instance.get(test_url);
+        const { params } = res.config;
+
+        expect(params).toHaveProperty('api-version');
+        expect(params['api-version']).toBe(versioningConfig.apiVersion);
+    })
+})
+
+describe('Testing correct response config of "MediaType" strategy', () => {
+    let versioningConfig: IWithVersioningConfig = {
+        apiVersion: '1.0',
+        versioningStrategy: VersioningStrategy.MediaType
+    };
+
+    beforeAll(() => {
+        instance = withVersioning(axios, versioningConfig);
+        mock = new MockAdapter(instance);
+    })
+
+    test('it should have the "apiVersion" as an accept-param in the Accept header', async () => {
+        mock.onGet(test_url)
+            .reply(status.OK, MOCK_RES);
+
+        const res = await instance.get(test_url);
+        const { headers } = res.config;
+
+        expect(headers).toHaveProperty('Accept');
+        expect(headers['Accept']).toMatch(`v=${versioningConfig.apiVersion}`)
+    })
+})
+
+describe('Testing correct response config of "UrlPath" strategy', () => {
+    let versioningConfig: IWithVersioningConfig = {
+        apiVersion: '1',
+        versioningStrategy: VersioningStrategy.UrlPath
+    };
+
+    const blank_test_url = test_url + "/v{apiVersion}";
+    const versioned_test_url = test_url + `/v${versioningConfig.apiVersion}`;
+
+    beforeAll(() => {
+        instance = withVersioning(axios, versioningConfig);
+        mock = new MockAdapter(instance);
+    })
+
+    test('it should have the "apiVersion" as a url param in the url', async () => {
+        mock.onGet(versioned_test_url)
+            .reply(status.OK, MOCK_RES);
+
+        const res = await instance.get(blank_test_url);
+        const { url } = res.config;
+
+        expect(url).toBe(versioned_test_url);
+    })
+})

src/__tests__/axios-api-versioning.mocks.ts

@@ -0,0 +1,85 @@
+import axios, { AxiosInstance } from 'axios';
+import { withVersioning } from '../axios-api-versioning';
+import { IWithVersioningConfig, VersioningStrategy } from '../types';
+import { AxiosInstanceWithVersioning } from '../types/axios';
+
+const testVersioningConfig: IWithVersioningConfig = {
+    apiVersion: '1.0',
+    versioningStrategy: VersioningStrategy.QueryString
+}
+
+// define an index type to stop TS from complaining about 
+// accessing key/values with an index lookup
+declare module 'axios' {
+    interface AxiosRequestConfig {
+        [key: string]: any
+    }
+}
+
+describe('Testing no pollution on default exported axios object using withVersioning()', () => {
+    beforeAll(() => {
+        const instance = withVersioning(axios, testVersioningConfig);
+    })
+
+    test('it should not add "apiVersion" to AxiosStatic defaults', () => {
+        expect(axios.defaults['apiVersion']).toBe(undefined);
+    })
+
+    test('it should not add "versioningStrategy" to AxiosStatic defaults', () => {
+        expect(axios.defaults['versioningStrategy']).toBe(undefined);
+    })
+
+    test('it should not add "ApiVersioningInterceptor" to AxiosStatic interceptors', () => {
+        // @ts-ignore
+        // we directly check the length of the handlers array for the request interceptors
+        expect(axios.interceptors.request["handlers"].length)
+            .toBe(0);
+    })
+})
+
+describe('Testing correct return value of withVersioning()', () => {
+    let instance: AxiosInstanceWithVersioning;
+
+    beforeAll(() => {
+        instance = withVersioning(axios, testVersioningConfig);
+    })
+
+    test('it should correctly add "ApiVersioningInterceptor" to instance interceptors', () => {
+        // @ts-ignore
+        // we directly check the length of the handlers array for the request interceptors
+        expect(instance.interceptors.request["handlers"].length)
+            .toBe(1);
+    })
+})
+
+describe('Testing correct return value of withVersioning() using axios.create()', () => {
+    let axiosInstance: AxiosInstance;
+    let instance: AxiosInstanceWithVersioning;
+
+    beforeAll(() => {
+        axiosInstance = axios.create();
+        instance = withVersioning(axiosInstance, testVersioningConfig);
+    })
+
+    test('it should correctly add "ApiVersioningInterceptor" to instance interceptors', () => {
+        // @ts-ignore
+        // we directly check the length of the handlers array for the request interceptors
+        expect(instance.interceptors.request["handlers"].length)
+            .toBe(1);
+    })
+
+    test('it should not add "apiVersion" to axios.create() instance', () => {
+        expect(axiosInstance.defaults['apiVersion']).toBe(undefined)
+    })
+
+    test('it should not add "versioningStrategy" to axios.create() instance', () => {
+        expect(axiosInstance.defaults['versioningStrategy']).toBe(undefined)
+    })
+
+    test('it should not add "ApiVersioningInterceptor" to axios.create() instance', () => {
+        // @ts-ignore
+        // we directly check the length of the handlers array for the request interceptors
+        expect(axiosInstance.interceptors.request["handlers"].length)
+            .toBe(0);
+    })
+})

src/__tests__/axios-api-versioning.spec.ts

@@ -5,6 +5,7 @@
     "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "es2015",
+      "dom"
     ], /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */