refactor(services): discovery-8 minor config restructure (quipucords#82)

src/services/__tests__/__snapshots__/config.test.js.snap

@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`ServiceConfig should have specific properties and methods: specific props and methods 1`] = `
+Array [
+  "serviceCall",
+  "serviceConfig",
+  "authHeader",
+]
+`;

src/services/__tests__/config.test.js

@@ -1,17 +1,17 @@
 import cookies from 'js-cookie';
-import * as service from '../config';
+import { config } from '../config';
 
 describe('ServiceConfig', () => {
-  it('should export a specific number of methods and classes', () => {
-    expect(Object.keys(service)).toHaveLength(2);
+  it('should have specific properties and methods', () => {
+    expect(Object.keys(config)).toMatchSnapshot('specific props and methods');
   });
 
   it('should export a default services config', () => {
-    expect(service.serviceConfig).toBeDefined();
+    expect(config.serviceConfig).toBeDefined();
 
     cookies.set(process.env.REACT_APP_AUTH_TOKEN, 'spoof');
 
-    const configObject = service.serviceConfig(
+    const configObject = config.serviceConfig(
       {
         method: 'post',
         timeout: 3
@@ -24,7 +24,7 @@ describe('ServiceConfig', () => {
   });
 
   it('should export a default services config without authorization', () => {
-    const configObject = service.serviceConfig({}, false);
+    const configObject = config.serviceConfig({}, false);
 
     expect(configObject.headers[process.env.REACT_APP_AUTH_HEADER]).toBeUndefined();
   });

src/services/config.js

@@ -1,5 +1,16 @@
+import axios from 'axios';
 import cookies from 'js-cookie';
 
+/**
+ * Set Axios XHR default timeout.
+ */
+const globalXhrTimeout = Number.parseInt(process.env.REACT_APP_AJAX_TIMEOUT, 10) || 60000;
+
+/**
+ * Return a formatted auth header.
+ *
+ * @return {{}}
+ */
 const authHeader = () => {
   const authToken = cookies.get(process.env.REACT_APP_AUTH_TOKEN) || '';
 
@@ -12,10 +23,30 @@ const authHeader = () => {
   };
 };
 
-const serviceConfig = (passedConfig = {}, auth = true) => ({
+/**
+ * Apply custom service config.
+ *
+ * @param {object} passedConfig
+ * @param {object} options
+ * @param {boolean} options.auth
+ * @param {number} options.xhrTimeout
+ * @returns {{headers: *}}
+ */
+const serviceConfig = (passedConfig = {}, { auth = true, xhrTimeout = globalXhrTimeout } = {}) => ({
   headers: auth ? authHeader() : {},
-  timeout: process.env.REACT_APP_AJAX_TIMEOUT,
+  timeout: xhrTimeout,
   ...passedConfig
 });
 
-export { serviceConfig as default, serviceConfig };
+/**
+ * Use a global Axios configuration.
+ *
+ * @param {object} config
+ * @param {object} options
+ * @returns {Promise<*>}
+ */
+const serviceCall = async (config, options) => axios(serviceConfig(config, options));
+
+const config = { serviceCall, globalXhrTimeout, serviceConfig, authHeader };
+
+export { config as default, config, authHeader, globalXhrTimeout, serviceCall, serviceConfig };

src/services/credentialsService.js

@@ -1,47 +1,38 @@
-import axios from 'axios';
-import serviceConfig from './config';
+import { serviceCall } from './config';
 
 const addCredential = (data = {}) =>
-  axios(
-    serviceConfig({
-      method: 'post',
-      url: `${process.env.REACT_APP_CREDENTIALS_SERVICE}`,
-      data
-    })
-  );
+  serviceCall({
+    method: 'post',
+    url: `${process.env.REACT_APP_CREDENTIALS_SERVICE}`,
+    data
+  });
 
 const deleteCredential = id =>
-  axios(
-    serviceConfig({
-      method: 'delete',
-      url: `${process.env.REACT_APP_CREDENTIALS_SERVICE}${id}/`
-    })
-  );
+  serviceCall({
+    method: 'delete',
+    url: `${process.env.REACT_APP_CREDENTIALS_SERVICE}${id}/`
+  });
 
 const deleteCredentials = (data = []) =>
   Promise.all(data.map(id => deleteCredential(id))).then(success => new Promise(resolve => resolve({ data: success })));
 
 const getCredentials = (id = '', params = {}) =>
-  axios(
-    serviceConfig(
-      {
-        url: `${process.env.REACT_APP_CREDENTIALS_SERVICE}${id}`,
-        params
-      },
-      false
-    )
+  serviceCall(
+    {
+      url: `${process.env.REACT_APP_CREDENTIALS_SERVICE}${id}`,
+      params
+    },
+    { auth: false }
   );
 
 const getCredential = id => getCredentials(id);
 
 const updateCredential = (id, data = {}) =>
-  axios(
-    serviceConfig({
-      method: 'put',
-      url: `${process.env.REACT_APP_CREDENTIALS_SERVICE}${id}/`,
-      data
-    })
-  );
+  serviceCall({
+    method: 'put',
+    url: `${process.env.REACT_APP_CREDENTIALS_SERVICE}${id}/`,
+    data
+  });
 
 const credentialsService = {
   addCredential,

src/services/factsService.js

@@ -1,14 +1,11 @@
-import axios from 'axios';
-import serviceConfig from './config';
+import { serviceCall } from './config';
 
 const addFacts = (data = {}) =>
-  axios(
-    serviceConfig({
-      method: 'post',
-      url: `${process.env.REACT_APP_FACTS_SERVICE}`,
-      data
-    })
-  );
+  serviceCall({
+    method: 'post',
+    url: `${process.env.REACT_APP_FACTS_SERVICE}`,
+    data
+  });
 
 const factsService = {
   addFacts

src/services/index.js

@@ -0,0 +1,29 @@
+import { credentialsService } from './credentialsService';
+import { factsService } from './factsService';
+import { reportsService } from './reportsService';
+import { scansService } from './scansService';
+import { sourcesService } from './sourcesService';
+import { statusService } from './statusService';
+import { userService } from './userService';
+
+const services = {
+  credentials: credentialsService,
+  facts: factsService,
+  reports: reportsService,
+  scans: scansService,
+  sources: sourcesService,
+  status: statusService,
+  user: userService
+};
+
+export {
+  services as default,
+  services,
+  credentialsService,
+  factsService,
+  reportsService,
+  scansService,
+  sourcesService,
+  statusService,
+  userService
+};

src/services/reportsService.js

@@ -1,16 +1,13 @@
-import axios from 'axios';
-import serviceConfig from './config';
+import { serviceCall } from './config';
 import helpers from '../common/helpers';
 
 const getReportsDownload = id =>
-  axios(
-    serviceConfig(
-      {
-        url: `${process.env.REACT_APP_REPORTS_SERVICE}${id}/`,
-        responseType: 'blob'
-      },
-      false
-    )
+  serviceCall(
+    {
+      url: `${process.env.REACT_APP_REPORTS_SERVICE}${id}/`,
+      responseType: 'blob'
+    },
+    { auth: false }
   ).then(
     success =>
       (helpers.TEST_MODE && success.data) ||
@@ -22,13 +19,11 @@ const getReportsDownload = id =>
   );
 
 const mergeReports = (data = {}) =>
-  axios(
-    serviceConfig({
-      method: 'put',
-      url: process.env.REACT_APP_REPORTS_SERVICE_MERGE,
-      data
-    })
-  );
+  serviceCall({
+    method: 'put',
+    url: process.env.REACT_APP_REPORTS_SERVICE_MERGE,
+    data
+  });
 
 const reportsService = {
   getReportsDownload,