[ResponseOps][Connectors] Common request axios utility function acros…

…s frameworks (#139549)

* Adding common axios util

* Fixing tests

* Removing patch

* Moving config to be first param

x-pack/plugins/actions/server/builtin_action_types/cases_webhook/service.test.ts

@@ -8,15 +8,15 @@
 import axios, { AxiosError, AxiosResponse } from 'axios';
 
 import { createExternalService } from './service';
-import { request, createAxiosResponse } from '../lib/axios_utils';
+import { request, createAxiosResponse } from '../../lib/axios_utils';
 import { CasesWebhookMethods, CasesWebhookPublicConfigurationType, ExternalService } from './types';
 import { Logger } from '@kbn/core/server';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
 import { actionsConfigMock } from '../../actions_config.mock';
 const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
 
-jest.mock('../lib/axios_utils', () => {
-  const originalUtils = jest.requireActual('../lib/axios_utils');
+jest.mock('../../lib/axios_utils', () => {
+  const originalUtils = jest.requireActual('../../lib/axios_utils');
   return {
     ...originalUtils,
     request: jest.fn(),

x-pack/plugins/actions/server/builtin_action_types/cases_webhook/service.ts

@@ -31,7 +31,7 @@ import {
 } from './types';
 
 import * as i18n from './translations';
-import { request } from '../lib/axios_utils';
+import { request } from '../../lib/axios_utils';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 
 export const createExternalService = (

x-pack/plugins/actions/server/builtin_action_types/cases_webhook/utils.ts

@@ -7,7 +7,7 @@
 
 import { AxiosResponse, AxiosError } from 'axios';
 import { isEmpty, isObjectLike, get } from 'lodash';
-import { getErrorMessage } from '../lib/axios_utils';
+import { getErrorMessage } from '../../lib/axios_utils';
 import * as i18n from './translations';
 
 export const createServiceError = (error: AxiosError, message: string) => {

x-pack/plugins/actions/server/builtin_action_types/jira/service.test.ts

@@ -8,7 +8,7 @@
 import axios from 'axios';
 
 import { createExternalService } from './service';
-import { request, createAxiosResponse } from '../lib/axios_utils';
+import { request, createAxiosResponse } from '../../lib/axios_utils';
 import { ExternalService } from './types';
 import { Logger } from '@kbn/core/server';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
@@ -20,8 +20,8 @@ interface ResponseError extends Error {
 }
 
 jest.mock('axios');
-jest.mock('../lib/axios_utils', () => {
-  const originalUtils = jest.requireActual('../lib/axios_utils');
+jest.mock('../../lib/axios_utils', () => {
+  const originalUtils = jest.requireActual('../../lib/axios_utils');
   return {
     ...originalUtils,
     request: jest.fn(),

x-pack/plugins/actions/server/builtin_action_types/jira/service.ts

@@ -27,7 +27,7 @@ import {
 } from './types';
 
 import * as i18n from './translations';
-import { request, getErrorMessage, throwIfResponseIsNotValid } from '../lib/axios_utils';
+import { request, getErrorMessage, throwIfResponseIsNotValid } from '../../lib/axios_utils';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 
 const VERSION = '2';

x-pack/plugins/actions/server/builtin_action_types/lib/post_pagerduty.ts

@@ -8,7 +8,7 @@
 import axios, { AxiosResponse } from 'axios';
 import { Logger } from '@kbn/core/server';
 import { Services } from '../../types';
-import { request } from './axios_utils';
+import { request } from '../../lib/axios_utils';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 
 interface PostPagerdutyOptions {

x-pack/plugins/actions/server/builtin_action_types/lib/post_xmatters.ts

@@ -7,7 +7,7 @@
 
 import axios, { AxiosResponse } from 'axios';
 import { Logger } from '@kbn/core/server';
-import { request } from './axios_utils';
+import { request } from '../../lib/axios_utils';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 
 interface PostXmattersOptions {

x-pack/plugins/actions/server/builtin_action_types/lib/request_oauth_token.ts

@@ -9,7 +9,7 @@ import qs from 'query-string';
 import axios from 'axios';
 import stringify from 'json-stable-stringify';
 import { Logger } from '@kbn/core/server';
-import { request } from './axios_utils';
+import { request } from '../../lib/axios_utils';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 import { AsApiContract } from '../../../common';
 

x-pack/plugins/actions/server/builtin_action_types/lib/send_email_graph_api.ts

@@ -9,7 +9,7 @@
 import stringify from 'json-stringify-safe';
 import axios, { AxiosInstance, AxiosResponse } from 'axios';
 import { Logger } from '@kbn/core/server';
-import { request } from './axios_utils';
+import { request } from '../../lib/axios_utils';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 import { SendEmailOptions } from './send_email';
 

x-pack/plugins/actions/server/builtin_action_types/resilient/service.test.ts

@@ -8,7 +8,7 @@
 import axios from 'axios';
 
 import { createExternalService, getValueTextContent, formatUpdateRequest } from './service';
-import { request, createAxiosResponse } from '../lib/axios_utils';
+import { request, createAxiosResponse } from '../../lib/axios_utils';
 import { ExternalService } from './types';
 import { Logger } from '@kbn/core/server';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
@@ -18,8 +18,8 @@ import { actionsConfigMock } from '../../actions_config.mock';
 const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
 
 jest.mock('axios');
-jest.mock('../lib/axios_utils', () => {
-  const originalUtils = jest.requireActual('../lib/axios_utils');
+jest.mock('../../lib/axios_utils', () => {
+  const originalUtils = jest.requireActual('../../lib/axios_utils');
   return {
     ...originalUtils,
     request: jest.fn(),

x-pack/plugins/actions/server/builtin_action_types/resilient/service.ts

@@ -24,7 +24,7 @@ import {
 } from './types';
 
 import * as i18n from './translations';
-import { getErrorMessage, request, throwIfResponseIsNotValid } from '../lib/axios_utils';
+import { getErrorMessage, request, throwIfResponseIsNotValid } from '../../lib/axios_utils';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 
 const VIEW_INCIDENT_URL = `#incidents`;

x-pack/plugins/actions/server/builtin_action_types/servicenow/service.test.ts

@@ -8,7 +8,7 @@
 import axios, { AxiosResponse } from 'axios';
 
 import { createExternalService } from './service';
-import * as utils from '../lib/axios_utils';
+import * as utils from '../../lib/axios_utils';
 import { ExternalService, ServiceNowITSMIncident } from './types';
 import { Logger } from '@kbn/core/server';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
@@ -18,8 +18,8 @@ import { snExternalServiceConfig } from './config';
 const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
 
 jest.mock('axios');
-jest.mock('../lib/axios_utils', () => {
-  const originalUtils = jest.requireActual('../lib/axios_utils');
+jest.mock('../../lib/axios_utils', () => {
+  const originalUtils = jest.requireActual('../../lib/axios_utils');
   return {
     ...originalUtils,
     request: jest.fn(),

x-pack/plugins/actions/server/builtin_action_types/servicenow/service.ts

@@ -20,7 +20,7 @@ import {
 
 import * as i18n from './translations';
 import { ServiceNowPublicConfigurationType, ServiceNowSecretConfigurationType } from './types';
-import { request } from '../lib/axios_utils';
+import { request } from '../../lib/axios_utils';
 import { createServiceError, getPushedDate, prepareIncident } from './utils';
 
 export const SYS_DICTIONARY_ENDPOINT = `api/now/table/sys_dictionary`;

x-pack/plugins/actions/server/builtin_action_types/servicenow/service_itom.test.ts

@@ -8,7 +8,7 @@
 import axios from 'axios';
 
 import { createExternalServiceITOM } from './service_itom';
-import * as utils from '../lib/axios_utils';
+import * as utils from '../../lib/axios_utils';
 import { ExternalServiceITOM } from './types';
 import { Logger } from '@kbn/core/server';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
@@ -19,8 +19,8 @@ import { itomEventParams, serviceNowChoices } from './mocks';
 const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
 
 jest.mock('axios');
-jest.mock('../lib/axios_utils', () => {
-  const originalUtils = jest.requireActual('../lib/axios_utils');
+jest.mock('../../lib/axios_utils', () => {
+  const originalUtils = jest.requireActual('../../lib/axios_utils');
   return {
     ...originalUtils,
     request: jest.fn(),

x-pack/plugins/actions/server/builtin_action_types/servicenow/service_itom.ts

@@ -7,7 +7,7 @@
 
 import { ServiceFactory, ExternalServiceITOM, ExecutorSubActionAddEventParams } from './types';
 
-import { request } from '../lib/axios_utils';
+import { request } from '../../lib/axios_utils';
 import { createExternalService } from './service';
 import { createServiceError } from './utils';
 

x-pack/plugins/actions/server/builtin_action_types/servicenow/service_sir.test.ts

@@ -8,7 +8,7 @@
 import axios from 'axios';
 
 import { createExternalServiceSIR } from './service_sir';
-import * as utils from '../lib/axios_utils';
+import * as utils from '../../lib/axios_utils';
 import { ExternalServiceSIR } from './types';
 import { Logger } from '@kbn/core/server';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
@@ -19,8 +19,8 @@ import { snExternalServiceConfig } from './config';
 const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
 
 jest.mock('axios');
-jest.mock('../lib/axios_utils', () => {
-  const originalUtils = jest.requireActual('../lib/axios_utils');
+jest.mock('../../lib/axios_utils', () => {
+  const originalUtils = jest.requireActual('../../lib/axios_utils');
   return {
     ...originalUtils,
     request: jest.fn(),

x-pack/plugins/actions/server/builtin_action_types/servicenow/service_sir.ts

@@ -7,7 +7,7 @@
 
 import { Observable, ExternalServiceSIR, ObservableResponse, ServiceFactory } from './types';
 
-import { request } from '../lib/axios_utils';
+import { request } from '../../lib/axios_utils';
 import { createExternalService } from './service';
 import { createServiceError } from './utils';
 

x-pack/plugins/actions/server/builtin_action_types/servicenow/utils.ts

@@ -17,7 +17,7 @@ import {
   ServiceNowSecretConfigurationType,
 } from './types';
 import { FIELD_PREFIX } from './config';
-import { addTimeZoneToDate, getErrorMessage } from '../lib/axios_utils';
+import { addTimeZoneToDate, getErrorMessage } from '../../lib/axios_utils';
 import * as i18n from './translations';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 import { ConnectorTokenClientContract } from '../../types';

x-pack/plugins/actions/server/builtin_action_types/swimlane/service.test.ts

@@ -10,16 +10,16 @@ import axios from 'axios';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
 import { Logger } from '@kbn/core/server';
 import { actionsConfigMock } from '../../actions_config.mock';
-import { request, createAxiosResponse } from '../lib/axios_utils';
+import { request, createAxiosResponse } from '../../lib/axios_utils';
 import { createExternalService } from './service';
 import { mappings } from './mocks';
 import { ExternalService } from './types';
 
 const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
 
 jest.mock('axios');
-jest.mock('../lib/axios_utils', () => {
-  const originalUtils = jest.requireActual('../lib/axios_utils');
+jest.mock('../../lib/axios_utils', () => {
+  const originalUtils = jest.requireActual('../../lib/axios_utils');
   return {
     ...originalUtils,
     request: jest.fn(),

x-pack/plugins/actions/server/builtin_action_types/swimlane/service.ts

@@ -9,7 +9,7 @@ import { Logger } from '@kbn/logging';
 import axios from 'axios';
 
 import { ActionsConfigurationUtilities } from '../../actions_config';
-import { getErrorMessage, request, throwIfResponseIsNotValid } from '../lib/axios_utils';
+import { getErrorMessage, request, throwIfResponseIsNotValid } from '../../lib/axios_utils';
 import { getBodyForEventAction } from './helpers';
 import {
   CreateCommentParams,

x-pack/plugins/actions/server/builtin_action_types/teams.test.ts

@@ -13,12 +13,12 @@ import { ActionParamsType, ActionTypeSecretsType, getActionType, TeamsActionType
 import { actionsConfigMock } from '../actions_config.mock';
 import { actionsMock } from '../mocks';
 import { createActionTypeRegistry } from './index.test';
-import * as utils from './lib/axios_utils';
+import * as utils from '../lib/axios_utils';
 import { ActionsConfigurationUtilities } from '../actions_config';
 
 jest.mock('axios');
-jest.mock('./lib/axios_utils', () => {
-  const originalUtils = jest.requireActual('./lib/axios_utils');
+jest.mock('../lib/axios_utils', () => {
+  const originalUtils = jest.requireActual('../lib/axios_utils');
   return {
     ...originalUtils,
     request: jest.fn(),

x-pack/plugins/actions/server/builtin_action_types/teams.ts

@@ -15,7 +15,7 @@ import { map, getOrElse } from 'fp-ts/lib/Option';
 import { Logger } from '@kbn/core/server';
 import { getRetryAfterIntervalFromHeaders } from './lib/http_rersponse_retry_header';
 import { isOk, promiseResult, Result } from './lib/result_type';
-import { request } from './lib/axios_utils';
+import { request } from '../lib/axios_utils';
 import {
   ActionType,
   ActionTypeExecutorOptions,

x-pack/plugins/actions/server/builtin_action_types/webhook.test.ts

@@ -21,12 +21,12 @@ import {
   WebhookMethods,
 } from './webhook';
 
-import * as utils from './lib/axios_utils';
+import * as utils from '../lib/axios_utils';
 import { ActionsConfigurationUtilities } from '../actions_config';
 
 jest.mock('axios');
-jest.mock('./lib/axios_utils', () => {
-  const originalUtils = jest.requireActual('./lib/axios_utils');
+jest.mock('../lib/axios_utils', () => {
+  const originalUtils = jest.requireActual('../lib/axios_utils');
   return {
     ...originalUtils,
     request: jest.fn(),

x-pack/plugins/actions/server/builtin_action_types/webhook.ts

@@ -22,7 +22,7 @@ import {
   ValidatorServices,
 } from '../types';
 import { ActionsConfigurationUtilities } from '../actions_config';
-import { request } from './lib/axios_utils';
+import { request } from '../lib/axios_utils';
 import { renderMustacheString } from '../lib/mustache_renderer';
 import {
   AlertingConnectorFeatureId,
@@ -190,7 +190,7 @@ export async function executor(
       url,
       logger,
       ...basicAuth,
-      headers,
+      headers: headers ? headers : {},
       data,
       configurationUtilities,
     })

x-pack/plugins/actions/server/integration_tests/axios_utils_connection.test.ts

@@ -17,7 +17,7 @@ import { duration as momentDuration } from 'moment';
 import { schema } from '@kbn/config-schema';
 import getPort from 'get-port';
 
-import { request } from '../builtin_action_types/lib/axios_utils';
+import { request } from '../lib/axios_utils';
 import { ByteSizeValue } from '@kbn/config-schema';
 import { Logger } from '@kbn/core/server';
 import { loggingSystemMock } from '@kbn/core/server/mocks';

x-pack/plugins/actions/server/integration_tests/axios_utils_proxy.test.ts

@@ -17,7 +17,7 @@ import { duration as momentDuration } from 'moment';
 import { schema } from '@kbn/config-schema';
 import getPort from 'get-port';
 
-import { request } from '../builtin_action_types/lib/axios_utils';
+import { request } from '../lib/axios_utils';
 import { ByteSizeValue } from '@kbn/config-schema';
 import { Logger } from '@kbn/core/server';
 import { loggingSystemMock } from '@kbn/core/server/mocks';

x-pack/plugins/actions/server/builtin_action_types/lib/axios_utils.test.ts → x-pack/plugins/actions/server/lib/axios_utils.test.ts

@@ -19,8 +19,8 @@ import {
   createAxiosResponse,
 } from './axios_utils';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
-import { actionsConfigMock } from '../../actions_config.mock';
-import { getCustomAgents } from './get_custom_agents';
+import { actionsConfigMock } from '../actions_config.mock';
+import { getCustomAgents } from '../builtin_action_types/lib/get_custom_agents';
 
 const TestUrl = 'https://elastic.co/foo/bar/baz';
 

x-pack/plugins/actions/server/builtin_action_types/lib/axios_utils.ts → x-pack/plugins/actions/server/lib/axios_utils.ts

@@ -6,10 +6,10 @@
  */
 
 import { isObjectLike, isEmpty } from 'lodash';
-import { AxiosInstance, Method, AxiosResponse, AxiosBasicCredentials } from 'axios';
+import { AxiosInstance, Method, AxiosResponse, AxiosRequestConfig } from 'axios';
 import { Logger } from '@kbn/core/server';
-import { getCustomAgents } from './get_custom_agents';
-import { ActionsConfigurationUtilities } from '../../actions_config';
+import { getCustomAgents } from '../builtin_action_types/lib/get_custom_agents';
+import { ActionsConfigurationUtilities } from '../actions_config';
 
 export const request = async <T = unknown>({
   axios,
@@ -19,24 +19,21 @@ export const request = async <T = unknown>({
   data,
   configurationUtilities,
   headers,
-  ...rest
+  ...config
 }: {
   axios: AxiosInstance;
   url: string;
   logger: Logger;
   method?: Method;
   data?: T;
-  params?: unknown;
   configurationUtilities: ActionsConfigurationUtilities;
   headers?: Record<string, string> | null;
-  validateStatus?: (status: number) => boolean;
-  auth?: AxiosBasicCredentials;
-}): Promise<AxiosResponse> => {
+} & AxiosRequestConfig): Promise<AxiosResponse> => {
   const { httpAgent, httpsAgent } = getCustomAgents(configurationUtilities, logger, url);
   const { maxContentLength, timeout } = configurationUtilities.getResponseSettings();
 
   return await axios(url, {
-    ...rest,
+    ...config,
     method,
     // Axios doesn't support `null` value for `headers` property.
     headers: headers ?? undefined,