Merge pull request #213 from reportportal/feature/update-work-with-axios

Keep axios instance between requests. Update work with headers

Author: AmsterGet

.eslintignore

@@ -1,3 +1,3 @@
 node_modules
 build
-spec/**/*.json
+__tests__/**/*.json

CHANGELOG.md

@@ -1,7 +1,8 @@
 ### Changed
 - **Breaking change** Drop support of Node.js 12. The version [5.1.4](https://github.com/reportportal/client-javascript/releases/tag/v5.1.4) is the latest that supports it.
+- The client now creates an instance of the `axios` HTTP client in the constructor.
+- The `HOST` HTTP header is added to all requests as it was skipped by the HTTP client.
 ### Fixed
-- Proxy support on HTTPS requests. Resolves [#30](https://github.com/reportportal/client-javascript/issues/30), related to [axios#4531](https://github.com/axios/axios/issues/4531).
 - Allow using `restClientConfig` in `checkConnect()` method. Thanks to [stevez](https://github.com/stevez).
 ### Security
 - Updated versions of vulnerable packages (braces).

spec/client-id.spec.js renamed to __tests__/client-id.spec.js

@@ -2,7 +2,6 @@ const os = require('os');
 const fs = require('fs');
 const glob = require('glob');
 const helpers = require('../lib/helpers');
-const RestClient = require('../lib/rest');
 const pjson = require('../package.json');
 
 describe('Helpers', () => {
@@ -27,34 +26,6 @@ describe('Helpers', () => {
     });
   });
 
-  describe('getServerResults', () => {
-    it('calls RestClient#request', () => {
-      jest.spyOn(RestClient, 'request').mockImplementation();
-
-      helpers.getServerResult(
-        'http://localhost:80/api/v1',
-        { userId: 1 },
-        {
-          headers: {
-            'X-Custom-Header': 'WOW',
-          },
-        },
-        'POST',
-      );
-
-      expect(RestClient.request).toHaveBeenCalledWith(
-        'POST',
-        'http://localhost:80/api/v1',
-        { userId: 1 },
-        {
-          headers: {
-            'X-Custom-Header': 'WOW',
-          },
-        },
-      );
-    });
-  });
-
   describe('readLaunchesFromFile', () => {
     it('should return the right ids', () => {
       jest.spyOn(glob, 'sync').mockReturnValue(['rplaunch-fileOne.tmp', 'rplaunch-fileTwo.tmp']);

spec/config.spec.js renamed to __tests__/config.spec.js

@@ -1,6 +1,5 @@
 const process = require('process');
 const RPClient = require('../lib/report-portal-client');
-const RestClient = require('../lib/rest');
 const helpers = require('../lib/helpers');
 const { OUTPUT_TYPES } = require('../lib/constants/outputs');
 
@@ -134,41 +133,12 @@ describe('ReportPortal javascript client', () => {
         project: 'test',
         endpoint: 'https://abc.com',
       });
-      jest.spyOn(RestClient, 'request').mockReturnValue(Promise.resolve('ok'));
+      jest.spyOn(client.restClient, 'request').mockReturnValue(Promise.resolve('ok'));
 
       const request = client.checkConnect();
 
       return expect(request).resolves.toBeDefined();
     });
-
-    it('client should include restClientConfig', () => {
-      const client = new RPClient({
-        apiKey: 'test',
-        project: 'test',
-        endpoint: 'https://abc.com/v1',
-        restClientConfig: {
-          proxy: false,
-          timeout: 0,
-        },
-      });
-      jest.spyOn(RestClient, 'request').mockImplementation();
-
-      client.checkConnect();
-
-      expect(RestClient.request).toHaveBeenCalledWith(
-        'GET',
-        'https://abc.com/v1/user',
-        {},
-        {
-          headers: {
-            'User-Agent': 'NodeJS',
-            Authorization: `bearer test`,
-          },
-          proxy: false,
-          timeout: 0,
-        },
-      );
-    });
   });
 
   describe('triggerAnalyticsEvent', () => {
@@ -278,15 +248,11 @@ describe('ReportPortal javascript client', () => {
         startTime: time,
       });
 
-      expect(client.restClient.create).toHaveBeenCalledWith(
-        'launch',
-        {
-          name: 'Test launch name',
-          startTime: time,
-          attributes: fakeSystemAttr,
-        },
-        { headers: client.headers },
-      );
+      expect(client.restClient.create).toHaveBeenCalledWith('launch', {
+        name: 'Test launch name',
+        startTime: time,
+        attributes: fakeSystemAttr,
+      });
     });
 
     it('should call restClient with suitable parameters, attributes is concatenated', () => {
@@ -312,22 +278,18 @@ describe('ReportPortal javascript client', () => {
         attributes: [{ value: 'value' }],
       });
 
-      expect(client.restClient.create).toHaveBeenCalledWith(
-        'launch',
-        {
-          name: 'Test launch name',
-          startTime: time,
-          attributes: [
-            { value: 'value' },
-            {
-              key: 'client',
-              value: 'client-name|1.0',
-              system: true,
-            },
-          ],
-        },
-        { headers: client.headers },
-      );
+      expect(client.restClient.create).toHaveBeenCalledWith('launch', {
+        name: 'Test launch name',
+        startTime: time,
+        attributes: [
+          { value: 'value' },
+          {
+            key: 'client',
+            value: 'client-name|1.0',
+            system: true,
+          },
+        ],
+      });
     });
 
     it('dont start new launch if launchDataRQ.id is not empty', () => {
@@ -599,9 +561,7 @@ describe('ReportPortal javascript client', () => {
 
       expect(promise.then).toBeDefined();
       await promise;
-      expect(client.restClient.create).toHaveBeenCalledWith('launch/merge', fakeMergeDataRQ, {
-        headers: client.headers,
-      });
+      expect(client.restClient.create).toHaveBeenCalledWith('launch/merge', fakeMergeDataRQ);
     });
 
     it('should not call rest client if something went wrong', async () => {

spec/helpers.spec.js renamed to __tests__/helpers.spec.js

@@ -2,13 +2,14 @@ const nock = require('nock');
 const isEqual = require('lodash/isEqual');
 const http = require('http');
 const RestClient = require('../lib/rest');
+const logger = require('../lib/logger');
 
 describe('RestClient', () => {
   const options = {
     baseURL: 'http://report-portal-host:8080/api/v1',
     headers: {
-      Authorization: 'bearer 00000000-0000-0000-0000-000000000000',
       'User-Agent': 'NodeJS',
+      Authorization: 'Bearer 00000000-0000-0000-0000-000000000000',
     },
     restClientConfig: {
       agent: {
@@ -34,6 +35,21 @@ describe('RestClient', () => {
       expect(restClient.baseURL).toBe(options.baseURL);
       expect(restClient.headers).toEqual(options.headers);
       expect(restClient.restClientConfig).toEqual(options.restClientConfig);
+      expect(restClient.axiosInstance).toBeDefined();
+    });
+
+    it('adds Logger to axios instance if enabled', () => {
+      const spyLogger = jest.spyOn(logger, 'addLogger').mockReturnValue();
+      const optionsWithLoggerEnabled = {
+        ...options,
+        restClientConfig: {
+          ...options.restClientConfig,
+          debug: true,
+        },
+      };
+      const client = new RestClient(optionsWithLoggerEnabled);
+
+      expect(spyLogger).toHaveBeenCalledWith(client.axiosInstance);
     });
   });
 

spec/publicReportingAPI.spec.js renamed to __tests__/publicReportingAPI.spec.js

@@ -1,8 +1,15 @@
 module.exports = {
   moduleFileExtensions: ['js'],
-  "testMatch": [
-    "<rootDir>/spec/**/*[sS]pec.js"
-  ],
-  coverageReporters: ["lcov", "text-summary"],
+  testRegex: '/__tests__/.*\\.(test|spec).js$',
+  testEnvironment: 'node',
+  collectCoverageFrom: ['lib/**/*.js', '!lib/logger.js'],
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 75,
+      lines: 80,
+      statements: 80,
+    },
+  },
   bail: false,
 };