Add centralized request service (#4758)

Tostti · Tostti · commit 427cd1a624ec · 2022-11-08T09:34:11.000-03:00
* create service * Improve service functionality * add timeout handling * Improve code quality * Fix issue that caused infinite loop * separate interceptor initialization * add interceptor to plugin start * fix double reload and add abort * Add function to disable requests externally * Add auth validation on server to disable requests * Update changelog * Add missing parameters verification * Add missing parameter validation * Add reload to interceptor * Change structure of code * Implement new service * Fix bug * Fix errors * Create unit tests * Fix bad reference to previous PR in changelog * Add missing previous change in changelog (cherry picked from commit 34c3fae)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 All notable changes to the Wazuh app project will be documented in this file.
 
+## Wazuh v4.3.10 - Kibana 7.10.2, 7.16.x, 7.17.x - Revision 4311
+
+### Added
+- Added a centralized service to handle the requests [#4758](https://github.com/wazuh/wazuh-kibana-app/pull/4758)
+
 ## Wazuh v4.3.9 - Kibana 7.10.2, 7.16.x, 7.17.x - Revision 4310
 
 ### Added
diff --git a/public/plugin.ts b/public/plugin.ts
@@ -29,6 +29,8 @@ import { setErrorOrchestrator } from './react-services/common-services';
 import { ErrorOrchestratorService } from './react-services/error-orchestrator/error-orchestrator.service';
 import { getThemeAssetURL, getAssetURL } from './utils/assets';
 import { WzRequest } from './react-services/wz-request';
+import { initializeInterceptor } from './services/request-handler';
+
 const innerAngularName = 'app/wazuh';
 export class WazuhPlugin implements Plugin<WazuhSetup, WazuhStart, WazuhSetupPlugins, WazuhStartPlugins> {
   constructor(private readonly initializerContext: PluginInitializerContext) {}
@@ -141,6 +143,7 @@ export class WazuhPlugin implements Plugin<WazuhSetup, WazuhStart, WazuhSetupPlu
     setSavedObjects(core.savedObjects);
     setOverlays(core.overlays);
     setErrorOrchestrator(ErrorOrchestratorService);
+    initializeInterceptor();
     return {};
   }
 }
diff --git a/public/react-services/generic-request.js b/public/react-services/generic-request.js
@@ -10,14 +10,14 @@
  * Find more information about this on the LICENSE file.
  */
 
-import axios from 'axios';
 import { AppState } from './app-state';
 import { WazuhConfig } from './wazuh-config';
 import { ApiCheck } from './wz-api-check';
 import { WzMisc } from '../factories/misc';
 import { OdfeUtils } from '../utils';
 import { getHttp, getDataPlugin } from '../kibana-services';
 import { PLUGIN_PLATFORM_REQUEST_HEADERS } from '../../common/constants';
+import { request } from '../services/request-handler';
 
 export class GenericRequest {
   static async request(method, path, payload = null, returnError = false) {
@@ -33,9 +33,9 @@ export class GenericRequest {
       };
       const tmpUrl = getHttp().basePath.prepend(path);
 
-      try{
+      try {
         requestHeaders.pattern = (await getDataPlugin().indexPatterns.get(AppState.getCurrentPattern())).title;
-      }catch(error){};
+      } catch (error) { };
 
       try {
         requestHeaders.id = JSON.parse(AppState.getCurrentAPI()).id;
@@ -48,40 +48,36 @@ export class GenericRequest {
       if (method === 'GET') {
         options = {
           method: method,
-          headers: requestHeaders,
-          url: tmpUrl,
+          path: path,
           timeout: timeout || 20000
         };
       }
       if (method === 'PUT') {
         options = {
           method: method,
-          headers: requestHeaders,
           data: payload,
-          url: tmpUrl,
+          path: path,
           timeout: timeout || 20000
         };
       }
       if (method === 'POST') {
         options = {
           method: method,
-          headers: requestHeaders,
           data: payload,
-          url: tmpUrl,
+          path: path,
           timeout: timeout || 20000
         };
       }
       if (method === 'DELETE') {
         options = {
           method: method,
-          headers: requestHeaders,
           data: payload,
-          url: tmpUrl,
+          path: path,
           timeout: timeout || 20000
         };
       }
 
-      Object.assign(data, await axios(options));
+      Object.assign(data, await request(options));
       if (!data) {
         throw new Error(
           `Error doing a request to ${tmpUrl}, method: ${method}.`
@@ -100,9 +96,9 @@ export class GenericRequest {
           const wzMisc = new WzMisc();
           wzMisc.setApiIsDown(true);
 
-          if (!window.location.hash.includes('#/settings') && 
-          !window.location.hash.includes('#/health-check') &&
-          !window.location.hash.includes('#/blank-screen')) {
+          if (!window.location.hash.includes('#/settings') &&
+            !window.location.hash.includes('#/health-check') &&
+            !window.location.hash.includes('#/blank-screen')) {
             window.location.href = getHttp().basePath.prepend('/app/wazuh#/health-check');
           }
         }
diff --git a/public/react-services/wz-api-check.js b/public/react-services/wz-api-check.js
@@ -10,11 +10,10 @@
  * Find more information about this on the LICENSE file.
  */
 import { WazuhConfig } from './wazuh-config';
-import axios from 'axios';
 import { AppState } from './app-state';
 import { WzMisc } from '../factories/misc';
 import { getHttp } from '../kibana-services';
-import { PLUGIN_PLATFORM_REQUEST_HEADERS } from '../../common/constants';
+import { request } from '../services/request-handler';
 
 export class ApiCheck {
   static async checkStored(data, idChanged = false) {
@@ -30,8 +29,7 @@ export class ApiCheck {
       const url = getHttp().basePath.prepend('/api/check-stored-api');
       const options = {
         method: 'POST',
-        headers: { ...PLUGIN_PLATFORM_REQUEST_HEADERS, 'content-type': 'application/json' },
-        url: url,
+        path: '/api/check-stored-api',
         data: payload,
         timeout: timeout || 20000
       };
@@ -40,7 +38,7 @@ export class ApiCheck {
         AppState.setPatternSelector(configuration['ip.selector']);
       }
 
-      const response = await axios(options);
+      const response = await request(options);
 
       if (response.error) {
         return Promise.reject(response);
@@ -65,21 +63,20 @@ export class ApiCheck {
    * Check the status of an API entry
    * @param {String} apiObject
    */
-  static async checkApi(apiEntry, forceRefresh=false) {
+  static async checkApi(apiEntry, forceRefresh = false) {
     try {
       const wazuhConfig = new WazuhConfig();
       const { timeout } = wazuhConfig.getConfig();
       const url = getHttp().basePath.prepend('/api/check-api');
 
       const options = {
         method: 'POST',
-        headers: { ...PLUGIN_PLATFORM_REQUEST_HEADERS, 'content-type': 'application/json' },
-        url: url,
-        data: {...apiEntry, forceRefresh},
+        path: '/api/check-api',
+        data: { ...apiEntry, forceRefresh },
         timeout: timeout || 20000
       };
 
-      const response = await axios(options);
+      const response = await request(options);
 
       if (response.error) {
         return Promise.reject(response);
diff --git a/public/react-services/wz-request.ts b/public/react-services/wz-request.ts
@@ -9,7 +9,6 @@
  *
  * Find more information about this on the LICENSE file.
  */
-import axios from 'axios';
 import { AppState } from './app-state';
 import { ApiCheck } from './wz-api-check';
 import { WzAuthentication } from './wz-authentication';
@@ -18,7 +17,7 @@ import { WazuhConfig } from './wazuh-config';
 import { OdfeUtils } from '../utils';
 import IApiResponse from './interfaces/api-response.interface';
 import { getHttp } from '../kibana-services';
-import { PLUGIN_PLATFORM_REQUEST_HEADERS } from '../../common/constants';
+import { request } from '../services/request-handler';
 export class WzRequest {
   static wazuhConfig: any;
 
@@ -50,13 +49,12 @@ export class WzRequest {
       const url = getHttp().basePath.prepend(path);
       const options = {
         method: method,
-        headers: { ...PLUGIN_PLATFORM_REQUEST_HEADERS, 'content-type': 'application/json' },
-        url: url,
+        path: path,
         data: payload,
         timeout: timeout,
       };
 
-      const data = await axios(options);
+      const data = await request(options);
 
       if (data['error']) {
         throw new Error(data['error']);
@@ -66,7 +64,7 @@ export class WzRequest {
     } catch (error) {
       OdfeUtils.checkOdfeSessionExpired(error);
       //if the requests fails, we need to check if the API is down
-      if(checkCurrentApiIsUp){
+      if (checkCurrentApiIsUp) {
         const currentApi = JSON.parse(AppState.getCurrentAPI() || '{}');
         if (currentApi && currentApi.id) {
           try {
@@ -100,7 +98,7 @@ export class WzRequest {
       }
       return errorMessage
         ? Promise.reject(this.returnErrorInstance(error, errorMessage))
-        : Promise.reject(this.returnErrorInstance(error,'Server did not respond'));
+        : Promise.reject(this.returnErrorInstance(error, 'Server did not respond'));
     }
   }
 
@@ -111,9 +109,9 @@ export class WzRequest {
    * @param {Object} body Request body
    */
   static async apiReq(
-    method, 
-    path, 
-    body, 
+    method,
+    path,
+    body,
     options: { checkCurrentApiIsUp?: boolean } = { checkCurrentApiIsUp: true }
   ): Promise<IApiResponse<any>> {
     try {
@@ -170,8 +168,8 @@ export class WzRequest {
    * @param message 
    * @returns error
    */
-  static returnErrorInstance(error, message){
-    if(!error || typeof error === 'string'){
+  static returnErrorInstance(error, message) {
+    if (!error || typeof error === 'string') {
       return new Error(message || error);
     }
     error.message = message
diff --git a/public/services/request-handler.js b/public/services/request-handler.js
@@ -0,0 +1,89 @@
+import { getCore } from '../kibana-services';
+
+let allow = true;
+let aborts = [];
+let currentid = 0;
+
+const removeController = (id) => {
+    const index = aborts.findIndex(object => {
+        return object.id === id;
+    });
+    if (!id) {
+        return;
+    }
+    aborts.splice(index);
+    return;
+}
+
+export const disableRequests = () => {
+    allow = false;
+    aborts.forEach(item => {
+        item.controller.abort();
+    })
+    return;
+}
+
+export const initializeInterceptor = () => {
+    const core = getCore();
+    core.http.intercept({
+        responseError: (httpErrorResponse, controller) => {
+            if (
+                httpErrorResponse.response?.status === 401
+            ) {
+                disableRequests();
+                setTimeout(() => window.location.reload(), 1000);
+            }
+        },
+    });
+}
+
+export const request = async (info = '') => {
+    if (!allow) {
+        return Promise.reject('Requests are disabled');
+    }
+
+
+    if (!info.method | !info.path) {
+        return Promise.reject("Missing parameters")
+    }
+
+    let { method, path, headers, data, timeout } = info;
+    const core = getCore();
+    const url = path.split('?')[0]
+
+    const query = Object.fromEntries([... new URLSearchParams(path.split('?')[1])])
+    const abort = new AbortController();
+    let options = {
+        method: method,
+        headers: headers,
+        query: query,
+        signal: abort.signal,
+        id: currentid
+    }
+    currentid++;
+
+    if (method !== 'GET') {
+        options = { ...options, body: JSON.stringify(data) }
+    }
+
+    if (allow) {
+        try {
+            aborts.push({ id: options.id, controller: abort })
+            if (timeout && timeout !== 0) {
+                const id = setTimeout(() => abort.abort(), timeout);
+                const requestData = await core.http.fetch(url, options);
+                clearTimeout(id);
+                removeController(options.id);
+                return Promise.resolve({ data: requestData, timeout: timeout });
+            }
+            else {
+                const requestData = await core.http.fetch(url, options);
+                removeController(options.id);
+                return Promise.resolve({ data: requestData });
+            }
+        }
+        catch (e) {
+            return Promise.reject(e);
+        }
+    }
+}
diff --git a/public/services/request-handler.test.js b/public/services/request-handler.test.js
diff --git a/server/plugin.ts b/server/plugin.ts
