Rename getProxyAgents to getCustomAgents (#89813)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
elastic · Feb 2, 2021 · 33bf590 · 33bf590
1 parent 3f97a04
commit 33bf590
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 21 deletions.
diff --git a/x-pack/plugins/actions/server/builtin_action_types/lib/axios_utils.test.ts b/x-pack/plugins/actions/server/builtin_action_types/lib/axios_utils.test.ts
@@ -10,7 +10,7 @@ import { Logger } from '../../../../../../src/core/server';
 import { addTimeZoneToDate, request, patch, getErrorMessage } from './axios_utils';
 import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
 import { actionsConfigMock } from '../../actions_config.mock';
-import { getProxyAgents } from './get_proxy_agents';
+import { getCustomAgents } from './get_custom_agents';
 
 const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
 const configurationUtilities = actionsConfigMock.create();
@@ -66,7 +66,7 @@ describe('request', () => {
       proxyRejectUnauthorizedCertificates: true,
       proxyUrl: 'https://localhost:1212',
     });
-    const { httpAgent, httpsAgent } = getProxyAgents(configurationUtilities, logger);
+    const { httpAgent, httpsAgent } = getCustomAgents(configurationUtilities, logger);
 
     const res = await request({
       axios,

diff --git a/x-pack/plugins/actions/server/builtin_action_types/lib/axios_utils.ts b/x-pack/plugins/actions/server/builtin_action_types/lib/axios_utils.ts
@@ -6,7 +6,7 @@
 
 import { AxiosInstance, Method, AxiosResponse, AxiosBasicCredentials } from 'axios';
 import { Logger } from '../../../../../../src/core/server';
-import { getProxyAgents } from './get_proxy_agents';
+import { getCustomAgents } from './get_custom_agents';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 
 export const request = async <T = unknown>({
@@ -29,7 +29,7 @@ export const request = async <T = unknown>({
   validateStatus?: (status: number) => boolean;
   auth?: AxiosBasicCredentials;
 }): Promise<AxiosResponse> => {
-  const { httpAgent, httpsAgent } = getProxyAgents(configurationUtilities, logger);
+  const { httpAgent, httpsAgent } = getCustomAgents(configurationUtilities, logger);
 
   return await axios(url, {
     ...rest,

diff --git a/...action_types/lib/get_proxy_agents.test.ts → ...ction_types/lib/get_custom_agents.test.ts b/...action_types/lib/get_proxy_agents.test.ts → ...ction_types/lib/get_custom_agents.test.ts
@@ -8,20 +8,20 @@ import { Agent as HttpsAgent } from 'https';
 import HttpProxyAgent from 'http-proxy-agent';
 import { HttpsProxyAgent } from 'https-proxy-agent';
 import { Logger } from '../../../../../../src/core/server';
-import { getProxyAgents } from './get_proxy_agents';
+import { getCustomAgents } from './get_custom_agents';
 import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
 import { actionsConfigMock } from '../../actions_config.mock';
 const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
 
-describe('getProxyAgents', () => {
+describe('getCustomAgents', () => {
   const configurationUtilities = actionsConfigMock.create();
 
   test('get agents for valid proxy URL', () => {
     configurationUtilities.getProxySettings.mockReturnValue({
       proxyUrl: 'https://someproxyhost',
       proxyRejectUnauthorizedCertificates: false,
     });
-    const { httpAgent, httpsAgent } = getProxyAgents(configurationUtilities, logger);
+    const { httpAgent, httpsAgent } = getCustomAgents(configurationUtilities, logger);
     expect(httpAgent instanceof HttpProxyAgent).toBeTruthy();
     expect(httpsAgent instanceof HttpsProxyAgent).toBeTruthy();
   });
@@ -31,13 +31,13 @@ describe('getProxyAgents', () => {
       proxyUrl: ':nope: not a valid URL',
       proxyRejectUnauthorizedCertificates: false,
     });
-    const { httpAgent, httpsAgent } = getProxyAgents(configurationUtilities, logger);
+    const { httpAgent, httpsAgent } = getCustomAgents(configurationUtilities, logger);
     expect(httpAgent).toBe(undefined);
     expect(httpsAgent instanceof HttpsAgent).toBeTruthy();
   });
 
   test('return default agents for undefined proxy options', () => {
-    const { httpAgent, httpsAgent } = getProxyAgents(configurationUtilities, logger);
+    const { httpAgent, httpsAgent } = getCustomAgents(configurationUtilities, logger);
     expect(httpAgent).toBe(undefined);
     expect(httpsAgent instanceof HttpsAgent).toBeTruthy();
   });

diff --git a/...ltin_action_types/lib/get_proxy_agents.ts → ...tin_action_types/lib/get_custom_agents.ts b/...ltin_action_types/lib/get_proxy_agents.ts → ...tin_action_types/lib/get_custom_agents.ts
@@ -11,25 +11,25 @@ import { HttpsProxyAgent } from 'https-proxy-agent';
 import { Logger } from '../../../../../../src/core/server';
 import { ActionsConfigurationUtilities } from '../../actions_config';
 
-interface GetProxyAgentsResponse {
+interface GetCustomAgentsResponse {
   httpAgent: HttpAgent | undefined;
   httpsAgent: HttpsAgent | undefined;
 }
 
-export function getProxyAgents(
+export function getCustomAgents(
   configurationUtilities: ActionsConfigurationUtilities,
   logger: Logger
-): GetProxyAgentsResponse {
+): GetCustomAgentsResponse {
   const proxySettings = configurationUtilities.getProxySettings();
-  const defaultResponse = {
+  const defaultAgents = {
     httpAgent: undefined,
     httpsAgent: new HttpsAgent({
       rejectUnauthorized: configurationUtilities.isRejectUnauthorizedCertificatesEnabled(),
     }),
   };
 
   if (!proxySettings) {
-    return defaultResponse;
+    return defaultAgents;
   }
 
   logger.debug(`Creating proxy agents for proxy: ${proxySettings.proxyUrl}`);
@@ -38,7 +38,7 @@ export function getProxyAgents(
     proxyUrl = new URL(proxySettings.proxyUrl);
   } catch (err) {
     logger.warn(`invalid proxy URL "${proxySettings.proxyUrl}" ignored`);
-    return defaultResponse;
+    return defaultAgents;
   }
 
   const httpAgent = new HttpProxyAgent(proxySettings.proxyUrl);

diff --git a/x-pack/plugins/actions/server/builtin_action_types/slack.ts b/x-pack/plugins/actions/server/builtin_action_types/slack.ts
@@ -22,7 +22,7 @@ import {
   ExecutorType,
 } from '../types';
 import { ActionsConfigurationUtilities } from '../actions_config';
-import { getProxyAgents } from './lib/get_proxy_agents';
+import { getCustomAgents } from './lib/get_custom_agents';
 
 export type SlackActionType = ActionType<{}, ActionTypeSecretsType, ActionParamsType, unknown>;
 export type SlackActionTypeExecutorOptions = ActionTypeExecutorOptions<
@@ -130,10 +130,10 @@ async function slackExecutor(
   const { message } = params;
   const proxySettings = configurationUtilities.getProxySettings();
 
-  const proxyAgents = getProxyAgents(configurationUtilities, logger);
-  const httpProxyAgent = webhookUrl.toLowerCase().startsWith('https')
-    ? proxyAgents.httpsAgent
-    : proxyAgents.httpAgent;
+  const customAgents = getCustomAgents(configurationUtilities, logger);
+  const agent = webhookUrl.toLowerCase().startsWith('https')
+    ? customAgents.httpsAgent
+    : customAgents.httpAgent;
 
   if (proxySettings) {
     logger.debug(`IncomingWebhook was called with proxyUrl ${proxySettings.proxyUrl}`);
@@ -143,7 +143,7 @@ async function slackExecutor(
     // https://slack.dev/node-slack-sdk/webhook
     // node-slack-sdk use Axios inside :)
     const webhook = new IncomingWebhook(webhookUrl, {
-      agent: httpProxyAgent,
+      agent,
     });
     result = await webhook.send(message);
   } catch (err) {