+
+
+
+
-
+ >
+
+
+
+
+
+
+
+
+
+
diff --git a/test/functional/apps/dashboard/dashboard_filter_bar.js b/test/functional/apps/dashboard/dashboard_filter_bar.js
index 273779a42d3f9..cbef274b78e93 100644
--- a/test/functional/apps/dashboard/dashboard_filter_bar.js
+++ b/test/functional/apps/dashboard/dashboard_filter_bar.js
@@ -67,7 +67,7 @@ export default function ({ getService, getPageObjects }) {
it('uses default index pattern on an empty dashboard', async () => {
await testSubjects.click('addFilter');
- await dashboardExpect.fieldSuggestions(['bytes']);
+ await dashboardExpect.fieldSuggestions(['agent']);
await filterBar.ensureFieldEditorModalIsClosed();
});
diff --git a/test/functional/apps/management/_import_objects.js b/test/functional/apps/management/_import_objects.js
index 03db3a2b108f2..5fbeb978f9a1c 100644
--- a/test/functional/apps/management/_import_objects.js
+++ b/test/functional/apps/management/_import_objects.js
@@ -49,12 +49,13 @@ export default function ({ getService, getPageObjects }) {
await PageObjects.savedObjects.checkImportSucceeded();
await PageObjects.savedObjects.clickImportDone();
- // get all the elements in the table, and index them by the 'title' visible text field
- const elements = keyBy(await PageObjects.savedObjects.getElementsInTable(), 'title');
log.debug("check that 'Log Agents' is in table as a visualization");
- expect(elements['Log Agents'].objectType).to.eql('visualization');
+ expect(await PageObjects.savedObjects.getObjectTypeByTitle('Log Agents')).to.eql(
+ 'visualization'
+ );
+
+ await PageObjects.savedObjects.clickRelationshipsByTitle('logstash-*');
- await elements['logstash-*'].relationshipsElement.click();
const flyout = keyBy(await PageObjects.savedObjects.getRelationshipFlyout(), 'title');
log.debug(
"check that 'Shared-Item Visualization AreaChart' shows 'logstash-*' as it's Parent"
@@ -150,8 +151,7 @@ export default function ({ getService, getPageObjects }) {
});
it('should not import saved objects linked to saved searches when saved search index pattern does not exist', async function () {
- const elements = keyBy(await PageObjects.savedObjects.getElementsInTable(), 'title');
- await elements['logstash-*'].checkbox.click();
+ await PageObjects.savedObjects.clickCheckboxByTitle('logstash-*');
await PageObjects.savedObjects.clickDelete();
await PageObjects.savedObjects.importFile(
@@ -182,8 +182,7 @@ export default function ({ getService, getPageObjects }) {
it('should import saved objects with index patterns when index patterns does not exists', async () => {
// First, we need to delete the index pattern
- const elements = keyBy(await PageObjects.savedObjects.getElementsInTable(), 'title');
- await elements['logstash-*'].checkbox.click();
+ await PageObjects.savedObjects.clickCheckboxByTitle('logstash-*');
await PageObjects.savedObjects.clickDelete();
// Then, import the objects
@@ -321,8 +320,7 @@ export default function ({ getService, getPageObjects }) {
await PageObjects.savedObjects.clickImportDone();
// Second, we need to delete the index pattern
- const elements = keyBy(await PageObjects.savedObjects.getElementsInTable(), 'title');
- await elements['logstash-*'].checkbox.click();
+ await PageObjects.savedObjects.clickCheckboxByTitle('logstash-*');
await PageObjects.savedObjects.clickDelete();
// Last, import a saved object connected to the saved search
@@ -353,8 +351,7 @@ export default function ({ getService, getPageObjects }) {
it('should import saved objects with index patterns when index patterns does not exists', async () => {
// First, we need to delete the index pattern
- const elements = keyBy(await PageObjects.savedObjects.getElementsInTable(), 'title');
- await elements['logstash-*'].checkbox.click();
+ await PageObjects.savedObjects.clickCheckboxByTitle('logstash-*');
await PageObjects.savedObjects.clickDelete();
// Then, import the objects
diff --git a/test/functional/apps/visualize/input_control_vis/chained_controls.js b/test/functional/apps/visualize/input_control_vis/chained_controls.js
index 89cca7dc7827e..e1a58e1da34f3 100644
--- a/test/functional/apps/visualize/input_control_vis/chained_controls.js
+++ b/test/functional/apps/visualize/input_control_vis/chained_controls.js
@@ -39,7 +39,7 @@ export default function ({ getService, getPageObjects }) {
it('should disable child control when parent control is not set', async () => {
const parentControlMenu = await comboBox.getOptionsList('listControlSelect0');
- expect(parentControlMenu.trim().split('\n').join()).to.equal('BD,BR,CN,ID,IN,JP,NG,PK,RU,US');
+ expect(parentControlMenu.trim().split('\n').join()).to.equal('BD,BR,CN,ID,IN,JP,NG,PK,RU');
const childControlInput = await find.byCssSelector('[data-test-subj="inputControl1"] input');
const isDisabled = await childControlInput.getAttribute('disabled');
diff --git a/test/functional/apps/visualize/input_control_vis/dynamic_options.js b/test/functional/apps/visualize/input_control_vis/dynamic_options.js
index b19f64511a23b..400be471be4b6 100644
--- a/test/functional/apps/visualize/input_control_vis/dynamic_options.js
+++ b/test/functional/apps/visualize/input_control_vis/dynamic_options.js
@@ -34,13 +34,13 @@ export default function ({ getService, getPageObjects }) {
it('should fetch new options when string field is filtered', async () => {
const initialOptions = await comboBox.getOptionsList('listControlSelect0');
- expect(initialOptions.trim().split('\n').join()).to.equal('BD,BR,CN,ID,IN,JP,NG,PK,RU,US');
+ expect(initialOptions.trim().split('\n').join()).to.equal('BD,BR,CN,ID,IN,JP,NG,PK,RU');
await comboBox.filterOptionsList('listControlSelect0', 'R');
await PageObjects.header.waitUntilLoadingHasFinished();
const updatedOptions = await comboBox.getOptionsList('listControlSelect0');
- expect(updatedOptions.trim().split('\n').join()).to.equal('AR,BR,FR,GR,IR,KR,RO,RU,RW,TR');
+ expect(updatedOptions.trim().split('\n').join()).to.equal('AR,BR,FR,GR,IR,KR,RO,RU,RW');
});
it('should not fetch new options when non-string is filtered', async () => {
@@ -74,13 +74,13 @@ export default function ({ getService, getPageObjects }) {
it('should fetch new options when string field is filtered', async () => {
const initialOptions = await comboBox.getOptionsList('listControlSelect1');
- expect(initialOptions.trim().split('\n').join()).to.equal('BD,BR,CN,ID,IN,JP,MX,NG,PK,US');
+ expect(initialOptions.trim().split('\n').join()).to.equal('BD,BR,CN,ID,IN,JP,MX,NG,PK');
await comboBox.filterOptionsList('listControlSelect1', 'R');
await PageObjects.header.waitUntilLoadingHasFinished();
const updatedOptions = await comboBox.getOptionsList('listControlSelect1');
- expect(updatedOptions.trim().split('\n').join()).to.equal('AR,BR,FR,GR,IR,KR,RO,RS,RU,TR');
+ expect(updatedOptions.trim().split('\n').join()).to.equal('AR,BR,FR,GR,IR,KR,RO,RS,RU');
});
});
});
diff --git a/test/functional/page_objects/discover_page.ts b/test/functional/page_objects/discover_page.ts
index c558d9e2d8a31..5a224d930ee42 100644
--- a/test/functional/page_objects/discover_page.ts
+++ b/test/functional/page_objects/discover_page.ts
@@ -332,6 +332,7 @@ export function DiscoverPageProvider({ getService, getPageObjects }: FtrProvider
public async selectIndexPattern(indexPattern: string) {
await testSubjects.click('indexPattern-switch-link');
+ await find.setValue('[data-test-subj="indexPattern-switcher"] input', indexPattern);
await find.clickByCssSelector(
`[data-test-subj="indexPattern-switcher"] [title="${indexPattern}"]`
);
diff --git a/test/functional/page_objects/management/saved_objects_page.ts b/test/functional/page_objects/management/saved_objects_page.ts
index 03d21aa4aa52f..ad82ea9b6fbc1 100644
--- a/test/functional/page_objects/management/saved_objects_page.ts
+++ b/test/functional/page_objects/management/saved_objects_page.ts
@@ -17,6 +17,7 @@
* under the License.
*/
+import { keyBy } from 'lodash';
import { map as mapAsync } from 'bluebird';
import { FtrProviderContext } from '../../ftr_provider_context';
@@ -34,6 +35,8 @@ export function SavedObjectsPageProvider({ getService, getPageObjects }: FtrProv
await searchBox.clearValue();
await searchBox.type(objectName);
await searchBox.pressKeys(browser.keys.ENTER);
+ await PageObjects.header.waitUntilLoadingHasFinished();
+ await this.waitTableIsLoaded();
}
async importFile(path: string, overwriteAll = true) {
@@ -99,6 +102,56 @@ export function SavedObjectsPageProvider({ getService, getPageObjects }: FtrProv
});
}
+ async clickRelationshipsByTitle(title: string) {
+ const table = keyBy(await this.getElementsInTable(), 'title');
+ // should we check if table size > 0 and log error if not?
+ if (table[title].menuElement) {
+ log.debug(`we found a context menu element for (${title}) so click it`);
+ await table[title].menuElement?.click();
+ // Wait for context menu to render
+ const menuPanel = await find.byCssSelector('.euiContextMenuPanel');
+ await (await menuPanel.findByTestSubject('savedObjectsTableAction-relationships')).click();
+ } else {
+ log.debug(
+ `we didn't find a menu element so should be a relastionships element for (${title}) to click`
+ );
+ // or the action elements are on the row without the menu
+ await table[title].relationshipsElement?.click();
+ }
+ }
+
+ async clickCopyToSpaceByTitle(title: string) {
+ const table = keyBy(await this.getElementsInTable(), 'title');
+ // should we check if table size > 0 and log error if not?
+ if (table[title].menuElement) {
+ log.debug(`we found a context menu element for (${title}) so click it`);
+ await table[title].menuElement?.click();
+ // Wait for context menu to render
+ const menuPanel = await find.byCssSelector('.euiContextMenuPanel');
+ await (
+ await menuPanel.findByTestSubject('savedObjectsTableAction-copy_saved_objects_to_space')
+ ).click();
+ } else {
+ log.debug(
+ `we didn't find a menu element so should be a "copy to space" element for (${title}) to click`
+ );
+ // or the action elements are on the row without the menu
+ await table[title].copySaveObjectsElement?.click();
+ }
+ }
+
+ async clickCheckboxByTitle(title: string) {
+ const table = keyBy(await this.getElementsInTable(), 'title');
+ // should we check if table size > 0 and log error if not?
+ await table[title].checkbox.click();
+ }
+
+ async getObjectTypeByTitle(title: string) {
+ const table = keyBy(await this.getElementsInTable(), 'title');
+ // should we check if table size > 0 and log error if not?
+ return table[title].objectType;
+ }
+
async getElementsInTable() {
const rows = await testSubjects.findAll('~savedObjectsTableRow');
return mapAsync(rows, async (row) => {
@@ -107,23 +160,45 @@ export function SavedObjectsPageProvider({ getService, getPageObjects }: FtrProv
const objectType = await row.findByTestSubject('objectType');
const titleElement = await row.findByTestSubject('savedObjectsTableRowTitle');
// not all rows have inspect button - Advanced Settings objects don't
- let inspectElement;
- const innerHtml = await row.getAttribute('innerHTML');
- if (innerHtml.includes('Inspect')) {
+ // Advanced Settings has 2 actions,
+ // data-test-subj="savedObjectsTableAction-relationships"
+ // data-test-subj="savedObjectsTableAction-copy_saved_objects_to_space"
+ // Some other objects have the ...
+ // data-test-subj="euiCollapsedItemActionsButton"
+ // Maybe some objects still have the inspect element visible?
+ // !!! Also note that since we don't have spaces on OSS, the actions for the same object can be different depending on OSS or not
+ let menuElement = null;
+ let inspectElement = null;
+ let relationshipsElement = null;
+ let copySaveObjectsElement = null;
+ const actions = await row.findByClassName('euiTableRowCell--hasActions');
+ // getting the innerHTML and checking if it 'includes' a string is faster than a timeout looking for each element
+ const actionsHTML = await actions.getAttribute('innerHTML');
+ if (actionsHTML.includes('euiCollapsedItemActionsButton')) {
+ menuElement = await row.findByTestSubject('euiCollapsedItemActionsButton');
+ }
+ if (actionsHTML.includes('savedObjectsTableAction-inspect')) {
inspectElement = await row.findByTestSubject('savedObjectsTableAction-inspect');
- } else {
- inspectElement = null;
}
- const relationshipsElement = await row.findByTestSubject(
- 'savedObjectsTableAction-relationships'
- );
+ if (actionsHTML.includes('savedObjectsTableAction-relationships')) {
+ relationshipsElement = await row.findByTestSubject(
+ 'savedObjectsTableAction-relationships'
+ );
+ }
+ if (actionsHTML.includes('savedObjectsTableAction-copy_saved_objects_to_space')) {
+ copySaveObjectsElement = await row.findByTestSubject(
+ 'savedObjectsTableAction-copy_saved_objects_to_space'
+ );
+ }
return {
checkbox,
objectType: await objectType.getAttribute('aria-label'),
titleElement,
title: await titleElement.getVisibleText(),
+ menuElement,
inspectElement,
relationshipsElement,
+ copySaveObjectsElement,
};
});
}
diff --git a/test/interpreter_functional/plugins/kbn_tp_run_pipeline/package.json b/test/interpreter_functional/plugins/kbn_tp_run_pipeline/package.json
index f3e5520a14fe2..b04fbc2bb2136 100644
--- a/test/interpreter_functional/plugins/kbn_tp_run_pipeline/package.json
+++ b/test/interpreter_functional/plugins/kbn_tp_run_pipeline/package.json
@@ -8,7 +8,7 @@
},
"license": "Apache-2.0",
"dependencies": {
- "@elastic/eui": "26.3.1",
+ "@elastic/eui": "27.4.0",
"react": "^16.12.0",
"react-dom": "^16.12.0"
},
diff --git a/test/plugin_functional/plugins/kbn_sample_panel_action/package.json b/test/plugin_functional/plugins/kbn_sample_panel_action/package.json
index b9c5b3bc5b836..e4a66fe47d8f2 100644
--- a/test/plugin_functional/plugins/kbn_sample_panel_action/package.json
+++ b/test/plugin_functional/plugins/kbn_sample_panel_action/package.json
@@ -8,7 +8,7 @@
},
"license": "Apache-2.0",
"dependencies": {
- "@elastic/eui": "26.3.1",
+ "@elastic/eui": "27.4.0",
"react": "^16.12.0"
},
"scripts": {
diff --git a/test/plugin_functional/plugins/kbn_tp_custom_visualizations/package.json b/test/plugin_functional/plugins/kbn_tp_custom_visualizations/package.json
index 95fafdf221c64..0e560dd7be7c3 100644
--- a/test/plugin_functional/plugins/kbn_tp_custom_visualizations/package.json
+++ b/test/plugin_functional/plugins/kbn_tp_custom_visualizations/package.json
@@ -8,7 +8,7 @@
},
"license": "Apache-2.0",
"dependencies": {
- "@elastic/eui": "26.3.1",
+ "@elastic/eui": "27.4.0",
"react": "^16.12.0"
},
"scripts": {
diff --git a/vars/kibanaPipeline.groovy b/vars/kibanaPipeline.groovy
index 173c5b7e11764..00668f2ccdaa7 100644
--- a/vars/kibanaPipeline.groovy
+++ b/vars/kibanaPipeline.groovy
@@ -170,7 +170,6 @@ def uploadCoverageArtifacts(prefix, pattern) {
def withGcsArtifactUpload(workerName, closure) {
def uploadPrefix = "kibana-ci-artifacts/jobs/${env.JOB_NAME}/${BUILD_NUMBER}/${workerName}"
def ARTIFACT_PATTERNS = [
- '**/target/public/.kbn-optimizer-cache',
'target/kibana-*',
'target/test-metrics/*',
'target/kibana-security-solution/**/*.png',
@@ -221,7 +220,7 @@ def publishJunit() {
}
}
-def sendMail() {
+def sendMail(Map params = [:]) {
// If the build doesn't have a result set by this point, there haven't been any errors and it can be marked as a success
// The e-mail plugin for the infra e-mail depends upon this being set
currentBuild.result = currentBuild.result ?: 'SUCCESS'
@@ -230,7 +229,7 @@ def sendMail() {
if (buildStatus != 'SUCCESS' && buildStatus != 'ABORTED') {
node('flyweight') {
sendInfraMail()
- sendKibanaMail()
+ sendKibanaMail(params)
}
}
}
@@ -246,12 +245,14 @@ def sendInfraMail() {
}
}
-def sendKibanaMail() {
+def sendKibanaMail(Map params = [:]) {
+ def config = [to: 'build-kibana@elastic.co'] + params
+
catchErrors {
def buildStatus = buildUtils.getBuildStatus()
if(params.NOTIFY_ON_FAILURE && buildStatus != 'SUCCESS' && buildStatus != 'ABORTED') {
emailext(
- to: 'build-kibana@elastic.co',
+ config.to,
subject: "${env.JOB_NAME} - Build # ${env.BUILD_NUMBER} - ${buildStatus}",
body: '${SCRIPT,template="groovy-html.template"}',
mimeType: 'text/html',
diff --git a/x-pack/dev-tools/jest/create_jest_config.js b/x-pack/dev-tools/jest/create_jest_config.js
index a0574dbdf36da..0e3f82792a2ba 100644
--- a/x-pack/dev-tools/jest/create_jest_config.js
+++ b/x-pack/dev-tools/jest/create_jest_config.js
@@ -58,6 +58,7 @@ export function createJestConfig({ kibanaDirectory, rootDir, xPackKibanaDirector
`${xPackKibanaDirectory}/dev-tools/jest/setup/setup_test.js`,
`${kibanaDirectory}/src/dev/jest/setup/mocks.js`,
`${kibanaDirectory}/src/dev/jest/setup/react_testing_library.js`,
+ `${kibanaDirectory}/src/dev/jest/setup/default_timeout.js`,
],
testEnvironment: 'jest-environment-jsdom-thirteen',
testMatch: ['**/*.test.{js,mjs,ts,tsx}'],
diff --git a/x-pack/examples/ui_actions_enhanced_examples/public/dashboard_to_url_drilldown/index.tsx b/x-pack/examples/ui_actions_enhanced_examples/public/dashboard_to_url_drilldown/index.tsx
index 037e017097e53..67599687dd881 100644
--- a/x-pack/examples/ui_actions_enhanced_examples/public/dashboard_to_url_drilldown/index.tsx
+++ b/x-pack/examples/ui_actions_enhanced_examples/public/dashboard_to_url_drilldown/index.tsx
@@ -10,6 +10,7 @@ import { reactToUiComponent } from '../../../../../src/plugins/kibana_react/publ
import { UiActionsEnhancedDrilldownDefinition as Drilldown } from '../../../../plugins/ui_actions_enhanced/public';
import { ChartActionContext } from '../../../../../src/plugins/embeddable/public';
import { CollectConfigProps as CollectConfigPropsBase } from '../../../../../src/plugins/kibana_utils/public';
+import { ActionExecutionContext } from '../../../../../src/plugins/ui_actions/public';
function isValidUrl(url: string) {
try {
@@ -101,7 +102,15 @@ export class DashboardToUrlDrilldown implements Drilldown
return config.url;
};
- public readonly execute = async (config: Config, context: ActionContext) => {
+ public readonly execute = async (
+ config: Config,
+ context: ActionExecutionContext
+ ) => {
+ // Just for showcasing:
+ // we can get trigger a which caused this drilldown execution
+ // eslint-disable-next-line no-console
+ console.log(context.trigger?.id);
+
const url = await this.getHref(config, context);
if (config.openInNewTab) {
diff --git a/x-pack/package.json b/x-pack/package.json
index 2b52646e0f748..57a0b88f8c2a5 100644
--- a/x-pack/package.json
+++ b/x-pack/package.json
@@ -44,9 +44,9 @@
"@storybook/addon-storyshots": "^5.3.19",
"@storybook/react": "^5.3.19",
"@storybook/theming": "^5.3.19",
+ "@testing-library/jest-dom": "^5.8.0",
"@testing-library/react": "^9.3.2",
"@testing-library/react-hooks": "^3.2.1",
- "@testing-library/jest-dom": "^5.8.0",
"@types/angular": "^1.6.56",
"@types/archiver": "^3.1.0",
"@types/base64-js": "^1.2.5",
@@ -72,8 +72,9 @@
"@types/gulp": "^4.0.6",
"@types/hapi__wreck": "^15.0.1",
"@types/he": "^1.1.1",
- "@types/hoist-non-react-statics": "^3.3.1",
"@types/history": "^4.7.3",
+ "@types/hoist-non-react-statics": "^3.3.1",
+ "@types/http-proxy": "^1.17.4",
"@types/jest": "^25.2.3",
"@types/jest-specific-snapshot": "^0.5.4",
"@types/joi": "^13.4.2",
@@ -94,6 +95,7 @@
"@types/object-hash": "^1.3.0",
"@types/papaparse": "^5.0.3",
"@types/pngjs": "^3.3.2",
+ "@types/pretty-ms": "^5.0.0",
"@types/prop-types": "^15.5.3",
"@types/proper-lockfile": "^3.0.1",
"@types/puppeteer": "^1.20.1",
@@ -109,6 +111,7 @@
"@types/redux-actions": "^2.6.1",
"@types/set-value": "^2.0.0",
"@types/sinon": "^7.0.13",
+ "@types/stats-lite": "^2.2.0",
"@types/styled-components": "^5.1.0",
"@types/supertest": "^2.0.5",
"@types/tar-fs": "^1.16.1",
@@ -116,11 +119,9 @@
"@types/tinycolor2": "^1.4.1",
"@types/use-resize-observer": "^6.0.0",
"@types/uuid": "^3.4.4",
+ "@types/webpack-env": "^1.15.2",
"@types/xml-crypto": "^1.4.0",
"@types/xml2js": "^0.4.5",
- "@types/stats-lite": "^2.2.0",
- "@types/pretty-ms": "^5.0.0",
- "@types/webpack-env": "^1.15.2",
"@welldone-software/why-did-you-render": "^4.0.0",
"abab": "^1.0.4",
"autoprefixer": "^9.7.4",
@@ -205,7 +206,7 @@
"@elastic/apm-rum-react": "^1.2.2",
"@elastic/datemath": "5.0.3",
"@elastic/ems-client": "7.9.3",
- "@elastic/eui": "26.3.1",
+ "@elastic/eui": "27.4.0",
"@elastic/filesaver": "1.1.2",
"@elastic/maki": "6.3.0",
"@elastic/node-crypto": "1.2.1",
@@ -227,6 +228,7 @@
"@turf/circle": "6.0.1",
"@turf/distance": "6.0.1",
"@turf/helpers": "6.0.1",
+ "@types/http-proxy-agent": "^2.0.2",
"angular": "^1.8.0",
"angular-resource": "1.8.0",
"angular-sanitize": "1.8.0",
diff --git a/x-pack/plugins/actions/server/builtin_action_types/case/types.ts b/x-pack/plugins/actions/server/builtin_action_types/case/types.ts
index de96864d0b295..1030e3d9c5d8e 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/case/types.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/case/types.ts
@@ -9,6 +9,7 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { TypeOf } from '@kbn/config-schema';
+import { Logger } from '../../../../../../src/core/server';
import {
ExternalIncidentServiceConfigurationSchema,
@@ -122,7 +123,12 @@ export interface ExternalServiceApi {
export interface CreateExternalServiceBasicArgs {
api: ExternalServiceApi;
- createExternalService: (credentials: ExternalServiceCredentials) => ExternalService;
+ createExternalService: (
+ credentials: ExternalServiceCredentials,
+ logger: Logger,
+ proxySettings?: any
+ ) => ExternalService;
+ logger: Logger;
}
export interface CreateExternalServiceArgs extends CreateExternalServiceBasicArgs {
diff --git a/x-pack/plugins/actions/server/builtin_action_types/case/utils.ts b/x-pack/plugins/actions/server/builtin_action_types/case/utils.ts
index 82dedb09c429e..d895bf386a367 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/case/utils.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/case/utils.ts
@@ -67,6 +67,7 @@ export const mapParams = (
export const createConnectorExecutor = ({
api,
createExternalService,
+ logger,
}: CreateExternalServiceBasicArgs) => async (
execOptions: ActionTypeExecutorOptions<
ExternalIncidentServiceConfiguration,
@@ -83,10 +84,14 @@ export const createConnectorExecutor = ({
actionId,
};
- const externalService = createExternalService({
- config,
- secrets,
- });
+ const externalService = createExternalService(
+ {
+ config,
+ secrets,
+ },
+ logger,
+ execOptions.proxySettings
+ );
if (!api[subAction]) {
throw new Error('[Action][ExternalService] Unsupported subAction type.');
@@ -122,10 +127,11 @@ export const createConnector = ({
validate,
createExternalService,
validationSchema,
+ logger,
}: CreateExternalServiceArgs) => {
return ({
configurationUtilities,
- executor = createConnectorExecutor({ api, createExternalService }),
+ executor = createConnectorExecutor({ api, createExternalService, logger }),
}: CreateActionTypeArgs): ActionType => ({
...config,
validate: {
diff --git a/x-pack/plugins/actions/server/builtin_action_types/email.test.ts b/x-pack/plugins/actions/server/builtin_action_types/email.test.ts
index 195f6db538ae5..62f369816d714 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/email.test.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/email.test.ts
@@ -269,6 +269,7 @@ describe('execute()', () => {
"message": "a message to you",
"subject": "the subject",
},
+ "proxySettings": undefined,
"routing": Object {
"bcc": Array [
"jimmy@example.com",
@@ -326,6 +327,7 @@ describe('execute()', () => {
"message": "a message to you",
"subject": "the subject",
},
+ "proxySettings": undefined,
"routing": Object {
"bcc": Array [
"jimmy@example.com",
diff --git a/x-pack/plugins/actions/server/builtin_action_types/email.ts b/x-pack/plugins/actions/server/builtin_action_types/email.ts
index a51a0432a01e0..e9dc4eea5dcfc 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/email.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/email.ts
@@ -184,6 +184,7 @@ async function executor(
subject: params.subject,
message: params.message,
},
+ proxySettings: execOptions.proxySettings,
};
let result;
diff --git a/x-pack/plugins/actions/server/builtin_action_types/index.ts b/x-pack/plugins/actions/server/builtin_action_types/index.ts
index 80a171cbe624d..3591e05fb3acf 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/index.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/index.ts
@@ -31,9 +31,9 @@ export function registerBuiltInActionTypes({
actionTypeRegistry.register(getIndexActionType({ logger }));
actionTypeRegistry.register(getPagerDutyActionType({ logger, configurationUtilities }));
actionTypeRegistry.register(getServerLogActionType({ logger }));
- actionTypeRegistry.register(getSlackActionType({ configurationUtilities }));
+ actionTypeRegistry.register(getSlackActionType({ logger, configurationUtilities }));
actionTypeRegistry.register(getWebhookActionType({ logger, configurationUtilities }));
actionTypeRegistry.register(getServiceNowActionType({ logger, configurationUtilities }));
- actionTypeRegistry.register(getJiraActionType({ configurationUtilities }));
- actionTypeRegistry.register(getResilientActionType({ configurationUtilities }));
+ actionTypeRegistry.register(getJiraActionType({ logger, configurationUtilities }));
+ actionTypeRegistry.register(getResilientActionType({ logger, configurationUtilities }));
}
diff --git a/x-pack/plugins/actions/server/builtin_action_types/jira/index.ts b/x-pack/plugins/actions/server/builtin_action_types/jira/index.ts
index a2d7bb5930a75..66be0bad02d7b 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/jira/index.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/jira/index.ts
@@ -4,21 +4,33 @@
* you may not use this file except in compliance with the Elastic License.
*/
+import { Logger } from '../../../../../../src/core/server';
import { createConnector } from '../case/utils';
+import { ActionType } from '../../types';
import { api } from './api';
import { config } from './config';
import { validate } from './validators';
import { createExternalService } from './service';
import { JiraSecretConfiguration, JiraPublicConfiguration } from './schema';
+import { ActionsConfigurationUtilities } from '../../actions_config';
-export const getActionType = createConnector({
- api,
- config,
- validate,
- createExternalService,
- validationSchema: {
- config: JiraPublicConfiguration,
- secrets: JiraSecretConfiguration,
- },
-});
+export function getActionType({
+ logger,
+ configurationUtilities,
+}: {
+ logger: Logger;
+ configurationUtilities: ActionsConfigurationUtilities;
+}): ActionType {
+ return createConnector({
+ api,
+ config,
+ validate,
+ createExternalService,
+ validationSchema: {
+ config: JiraPublicConfiguration,
+ secrets: JiraSecretConfiguration,
+ },
+ logger,
+ })({ configurationUtilities });
+}
diff --git a/x-pack/plugins/actions/server/builtin_action_types/jira/service.test.ts b/x-pack/plugins/actions/server/builtin_action_types/jira/service.test.ts
index 3de3926b7d821..547595b4c183f 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/jira/service.test.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/jira/service.test.ts
@@ -9,6 +9,9 @@ import axios from 'axios';
import { createExternalService } from './service';
import * as utils from '../lib/axios_utils';
import { ExternalService } from '../case/types';
+import { Logger } from '../../../../../../src/core/server';
+import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
+const logger = loggingSystemMock.create().get() as jest.Mocked;
jest.mock('axios');
jest.mock('../lib/axios_utils', () => {
@@ -26,10 +29,13 @@ describe('Jira service', () => {
let service: ExternalService;
beforeAll(() => {
- service = createExternalService({
- config: { apiUrl: 'https://siem-kibana.atlassian.net', projectKey: 'CK' },
- secrets: { apiToken: 'token', email: 'elastic@elastic.com' },
- });
+ service = createExternalService(
+ {
+ config: { apiUrl: 'https://siem-kibana.atlassian.net', projectKey: 'CK' },
+ secrets: { apiToken: 'token', email: 'elastic@elastic.com' },
+ },
+ logger
+ );
});
beforeEach(() => {
@@ -39,37 +45,49 @@ describe('Jira service', () => {
describe('createExternalService', () => {
test('throws without url', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: null, projectKey: 'CK' },
- secrets: { apiToken: 'token', email: 'elastic@elastic.com' },
- })
+ createExternalService(
+ {
+ config: { apiUrl: null, projectKey: 'CK' },
+ secrets: { apiToken: 'token', email: 'elastic@elastic.com' },
+ },
+ logger
+ )
).toThrow();
});
test('throws without projectKey', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: 'test.com', projectKey: null },
- secrets: { apiToken: 'token', email: 'elastic@elastic.com' },
- })
+ createExternalService(
+ {
+ config: { apiUrl: 'test.com', projectKey: null },
+ secrets: { apiToken: 'token', email: 'elastic@elastic.com' },
+ },
+ logger
+ )
).toThrow();
});
test('throws without username', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: 'test.com' },
- secrets: { apiToken: '', email: 'elastic@elastic.com' },
- })
+ createExternalService(
+ {
+ config: { apiUrl: 'test.com' },
+ secrets: { apiToken: '', email: 'elastic@elastic.com' },
+ },
+ logger
+ )
).toThrow();
});
test('throws without password', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: 'test.com' },
- secrets: { apiToken: '', email: undefined },
- })
+ createExternalService(
+ {
+ config: { apiUrl: 'test.com' },
+ secrets: { apiToken: '', email: undefined },
+ },
+ logger
+ )
).toThrow();
});
});
@@ -92,6 +110,7 @@ describe('Jira service', () => {
expect(requestMock).toHaveBeenCalledWith({
axios,
url: 'https://siem-kibana.atlassian.net/rest/api/2/issue/1',
+ logger,
});
});
@@ -146,6 +165,7 @@ describe('Jira service', () => {
expect(requestMock).toHaveBeenCalledWith({
axios,
url: 'https://siem-kibana.atlassian.net/rest/api/2/issue',
+ logger,
method: 'post',
data: {
fields: {
@@ -210,6 +230,7 @@ describe('Jira service', () => {
expect(requestMock).toHaveBeenCalledWith({
axios,
+ logger,
method: 'put',
url: 'https://siem-kibana.atlassian.net/rest/api/2/issue/1',
data: { fields: { summary: 'title', description: 'desc' } },
@@ -272,6 +293,7 @@ describe('Jira service', () => {
expect(requestMock).toHaveBeenCalledWith({
axios,
+ logger,
method: 'post',
url: 'https://siem-kibana.atlassian.net/rest/api/2/issue/1/comment',
data: { body: 'comment' },
diff --git a/x-pack/plugins/actions/server/builtin_action_types/jira/service.ts b/x-pack/plugins/actions/server/builtin_action_types/jira/service.ts
index 240b645c3a7dc..aec73cfb375ed 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/jira/service.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/jira/service.ts
@@ -7,6 +7,7 @@
import axios from 'axios';
import { ExternalServiceCredentials, ExternalService, ExternalServiceParams } from '../case/types';
+import { Logger } from '../../../../../../src/core/server';
import {
JiraPublicConfigurationType,
JiraSecretConfigurationType,
@@ -17,6 +18,7 @@ import {
import * as i18n from './translations';
import { request, getErrorMessage } from '../lib/axios_utils';
+import { ProxySettings } from '../../types';
const VERSION = '2';
const BASE_URL = `rest/api/${VERSION}`;
@@ -25,10 +27,11 @@ const COMMENT_URL = `comment`;
const VIEW_INCIDENT_URL = `browse`;
-export const createExternalService = ({
- config,
- secrets,
-}: ExternalServiceCredentials): ExternalService => {
+export const createExternalService = (
+ { config, secrets }: ExternalServiceCredentials,
+ logger: Logger,
+ proxySettings?: ProxySettings
+): ExternalService => {
const { apiUrl: url, projectKey } = config as JiraPublicConfigurationType;
const { apiToken, email } = secrets as JiraSecretConfigurationType;
@@ -55,6 +58,8 @@ export const createExternalService = ({
const res = await request({
axios: axiosInstance,
url: `${incidentUrl}/${id}`,
+ logger,
+ proxySettings,
});
const { fields, ...rest } = res.data;
@@ -75,10 +80,12 @@ export const createExternalService = ({
const res = await request({
axios: axiosInstance,
url: `${incidentUrl}`,
+ logger,
method: 'post',
data: {
fields: { ...incident, project: { key: projectKey }, issuetype: { name: 'Task' } },
},
+ proxySettings,
});
const updatedIncident = await getIncident(res.data.id);
@@ -102,7 +109,9 @@ export const createExternalService = ({
axios: axiosInstance,
method: 'put',
url: `${incidentUrl}/${incidentId}`,
+ logger,
data: { fields: { ...incident } },
+ proxySettings,
});
const updatedIncident = await getIncident(incidentId);
@@ -129,7 +138,9 @@ export const createExternalService = ({
axios: axiosInstance,
method: 'post',
url: getCommentsURL(incidentId),
+ logger,
data: { body: comment.comment },
+ proxySettings,
});
return {
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
index 4a52ae60bcdda..844aa6d2de7ed 100644
--- 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
@@ -5,7 +5,11 @@
*/
import axios from 'axios';
-import { addTimeZoneToDate, throwIfNotAlive, request, patch, getErrorMessage } from './axios_utils';
+import HttpProxyAgent from 'http-proxy-agent';
+import { Logger } from '../../../../../../src/core/server';
+import { addTimeZoneToDate, request, patch, getErrorMessage } from './axios_utils';
+import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
+const logger = loggingSystemMock.create().get() as jest.Mocked;
jest.mock('axios');
const axiosMock = (axios as unknown) as jest.Mock;
@@ -21,26 +25,6 @@ describe('addTimeZoneToDate', () => {
});
});
-describe('throwIfNotAlive ', () => {
- test('throws correctly when status is invalid', async () => {
- expect(() => {
- throwIfNotAlive(404, 'application/json');
- }).toThrow('Instance is not alive.');
- });
-
- test('throws correctly when content is invalid', () => {
- expect(() => {
- throwIfNotAlive(200, 'application/html');
- }).toThrow('Instance is not alive.');
- });
-
- test('do NOT throws with custom validStatusCodes', async () => {
- expect(() => {
- throwIfNotAlive(404, 'application/json', [404]);
- }).not.toThrow('Instance is not alive.');
- });
-});
-
describe('request', () => {
beforeEach(() => {
axiosMock.mockImplementation(() => ({
@@ -51,9 +35,22 @@ describe('request', () => {
});
test('it fetch correctly with defaults', async () => {
- const res = await request({ axios, url: '/test' });
+ const res = await request({
+ axios,
+ url: '/test',
+ logger,
+ });
- expect(axiosMock).toHaveBeenCalledWith('/test', { method: 'get', data: {} });
+ expect(axiosMock).toHaveBeenCalledWith('/test', {
+ method: 'get',
+ data: {},
+ headers: undefined,
+ httpAgent: undefined,
+ httpsAgent: undefined,
+ params: undefined,
+ proxy: false,
+ validateStatus: undefined,
+ });
expect(res).toEqual({
status: 200,
headers: { 'content-type': 'application/json' },
@@ -61,10 +58,27 @@ describe('request', () => {
});
});
- test('it fetch correctly', async () => {
- const res = await request({ axios, url: '/test', method: 'post', data: { id: '123' } });
+ test('it have been called with proper proxy agent', async () => {
+ const res = await request({
+ axios,
+ url: '/testProxy',
+ logger,
+ proxySettings: {
+ proxyUrl: 'http://localhost:1212',
+ rejectUnauthorizedCertificates: false,
+ },
+ });
- expect(axiosMock).toHaveBeenCalledWith('/test', { method: 'post', data: { id: '123' } });
+ expect(axiosMock).toHaveBeenCalledWith('/testProxy', {
+ method: 'get',
+ data: {},
+ headers: undefined,
+ httpAgent: new HttpProxyAgent('http://localhost:1212'),
+ httpsAgent: new HttpProxyAgent('http://localhost:1212'),
+ params: undefined,
+ proxy: false,
+ validateStatus: undefined,
+ });
expect(res).toEqual({
status: 200,
headers: { 'content-type': 'application/json' },
@@ -72,14 +86,24 @@ describe('request', () => {
});
});
- test('it throws correctly', async () => {
- axiosMock.mockImplementation(() => ({
- status: 404,
+ test('it fetch correctly', async () => {
+ const res = await request({ axios, url: '/test', method: 'post', logger, data: { id: '123' } });
+
+ expect(axiosMock).toHaveBeenCalledWith('/test', {
+ method: 'post',
+ data: { id: '123' },
+ headers: undefined,
+ httpAgent: undefined,
+ httpsAgent: undefined,
+ params: undefined,
+ proxy: false,
+ validateStatus: undefined,
+ });
+ expect(res).toEqual({
+ status: 200,
headers: { 'content-type': 'application/json' },
data: { incidentId: '123' },
- }));
-
- await expect(request({ axios, url: '/test' })).rejects.toThrow();
+ });
});
});
@@ -92,8 +116,17 @@ describe('patch', () => {
});
test('it fetch correctly', async () => {
- await patch({ axios, url: '/test', data: { id: '123' } });
- expect(axiosMock).toHaveBeenCalledWith('/test', { method: 'patch', data: { id: '123' } });
+ await patch({ axios, url: '/test', data: { id: '123' }, logger });
+ expect(axiosMock).toHaveBeenCalledWith('/test', {
+ method: 'patch',
+ data: { id: '123' },
+ headers: undefined,
+ httpAgent: undefined,
+ httpsAgent: undefined,
+ params: undefined,
+ proxy: false,
+ validateStatus: undefined,
+ });
});
});
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
index d527cf632bace..e26a3b686179c 100644
--- 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
@@ -4,50 +4,68 @@
* you may not use this file except in compliance with the Elastic License.
*/
-import { AxiosInstance, Method, AxiosResponse } from 'axios';
-
-export const throwIfNotAlive = (
- status: number,
- contentType: string,
- validStatusCodes: number[] = [200, 201, 204]
-) => {
- if (!validStatusCodes.includes(status) || !contentType.includes('application/json')) {
- throw new Error('Instance is not alive.');
- }
-};
+import { AxiosInstance, Method, AxiosResponse, AxiosBasicCredentials } from 'axios';
+import { Logger } from '../../../../../../src/core/server';
+import { ProxySettings } from '../../types';
+import { getProxyAgent } from './get_proxy_agent';
export const request = async ({
axios,
url,
+ logger,
method = 'get',
data,
params,
+ proxySettings,
+ headers,
+ validateStatus,
+ auth,
}: {
axios: AxiosInstance;
url: string;
+ logger: Logger;
method?: Method;
data?: T;
params?: unknown;
+ proxySettings?: ProxySettings;
+ headers?: Record | null;
+ validateStatus?: (status: number) => boolean;
+ auth?: AxiosBasicCredentials;
}): Promise => {
- const res = await axios(url, { method, data: data ?? {}, params });
- throwIfNotAlive(res.status, res.headers['content-type']);
- return res;
+ return await axios(url, {
+ method,
+ data: data ?? {},
+ params,
+ auth,
+ // use httpsAgent and embedded proxy: false, to be able to handle fail on invalid certs
+ httpsAgent: proxySettings ? getProxyAgent(proxySettings, logger) : undefined,
+ httpAgent: proxySettings ? getProxyAgent(proxySettings, logger) : undefined,
+ proxy: false, // the same way as it done for IncomingWebhook in
+ headers,
+ validateStatus,
+ });
};
export const patch = async ({
axios,
url,
data,
+ logger,
+ proxySettings,
}: {
axios: AxiosInstance;
url: string;
data: T;
+ logger: Logger;
+ proxySettings?: ProxySettings;
}): Promise => {
return request({
axios,
url,
+ logger,
method: 'patch',
data,
+ proxySettings,
});
};
diff --git a/x-pack/plugins/actions/server/builtin_action_types/lib/get_proxy_agent.test.ts b/x-pack/plugins/actions/server/builtin_action_types/lib/get_proxy_agent.test.ts
new file mode 100644
index 0000000000000..2468fab8c6ac5
--- /dev/null
+++ b/x-pack/plugins/actions/server/builtin_action_types/lib/get_proxy_agent.test.ts
@@ -0,0 +1,30 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import HttpProxyAgent from 'http-proxy-agent';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+import { Logger } from '../../../../../../src/core/server';
+import { getProxyAgent } from './get_proxy_agent';
+import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
+const logger = loggingSystemMock.create().get() as jest.Mocked;
+
+describe('getProxyAgent', () => {
+ test('return HttpsProxyAgent for https proxy url', () => {
+ const agent = getProxyAgent(
+ { proxyUrl: 'https://someproxyhost', rejectUnauthorizedCertificates: false },
+ logger
+ );
+ expect(agent instanceof HttpsProxyAgent).toBeTruthy();
+ });
+
+ test('return HttpProxyAgent for http proxy url', () => {
+ const agent = getProxyAgent(
+ { proxyUrl: 'http://someproxyhost', rejectUnauthorizedCertificates: false },
+ logger
+ );
+ expect(agent instanceof HttpProxyAgent).toBeTruthy();
+ });
+});
diff --git a/x-pack/plugins/actions/server/builtin_action_types/lib/get_proxy_agent.ts b/x-pack/plugins/actions/server/builtin_action_types/lib/get_proxy_agent.ts
new file mode 100644
index 0000000000000..bb4dadd3a4698
--- /dev/null
+++ b/x-pack/plugins/actions/server/builtin_action_types/lib/get_proxy_agent.ts
@@ -0,0 +1,31 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import HttpProxyAgent from 'http-proxy-agent';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+import { Logger } from '../../../../../../src/core/server';
+import { ProxySettings } from '../../types';
+
+export function getProxyAgent(
+ proxySettings: ProxySettings,
+ logger: Logger
+): HttpsProxyAgent | HttpProxyAgent {
+ logger.debug(`Create proxy agent for ${proxySettings.proxyUrl}.`);
+
+ if (/^https/i.test(proxySettings.proxyUrl)) {
+ const proxyUrl = new URL(proxySettings.proxyUrl);
+ return new HttpsProxyAgent({
+ host: proxyUrl.hostname,
+ port: Number(proxyUrl.port),
+ protocol: proxyUrl.protocol,
+ headers: proxySettings.proxyHeaders,
+ // do not fail on invalid certs if value is false
+ rejectUnauthorized: proxySettings.rejectUnauthorizedCertificates,
+ });
+ } else {
+ return new HttpProxyAgent(proxySettings.proxyUrl);
+ }
+}
diff --git a/x-pack/plugins/actions/server/builtin_action_types/lib/post_pagerduty.ts b/x-pack/plugins/actions/server/builtin_action_types/lib/post_pagerduty.ts
index 92f88ebe0be22..d78237beb98a1 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/lib/post_pagerduty.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/lib/post_pagerduty.ts
@@ -5,22 +5,34 @@
*/
import axios, { AxiosResponse } from 'axios';
-import { Services } from '../../types';
+import { Logger } from '../../../../../../src/core/server';
+import { Services, ProxySettings } from '../../types';
+import { request } from './axios_utils';
interface PostPagerdutyOptions {
apiUrl: string;
data: unknown;
headers: Record;
services: Services;
+ proxySettings?: ProxySettings;
}
// post an event to pagerduty
-export async function postPagerduty(options: PostPagerdutyOptions): Promise {
- const { apiUrl, data, headers } = options;
- const axiosOptions = {
+export async function postPagerduty(
+ options: PostPagerdutyOptions,
+ logger: Logger
+): Promise {
+ const { apiUrl, data, headers, proxySettings } = options;
+ const axiosInstance = axios.create();
+
+ return await request({
+ axios: axiosInstance,
+ url: apiUrl,
+ method: 'post',
+ logger,
+ data,
+ proxySettings,
headers,
validateStatus: () => true,
- };
-
- return axios.post(apiUrl, data, axiosOptions);
+ });
}
diff --git a/x-pack/plugins/actions/server/builtin_action_types/lib/send_email.test.ts b/x-pack/plugins/actions/server/builtin_action_types/lib/send_email.test.ts
index 3514bd4257b0f..8287ee944bca9 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/lib/send_email.test.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/lib/send_email.test.ts
@@ -12,6 +12,7 @@ import { Logger } from '../../../../../../src/core/server';
import { sendEmail } from './send_email';
import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
import nodemailer from 'nodemailer';
+import { ProxySettings } from '../../types';
const createTransportMock = nodemailer.createTransport as jest.Mock;
const sendMailMockResult = { result: 'does not matter' };
@@ -63,6 +64,59 @@ describe('send_email module', () => {
});
test('handles unauthenticated email using not secure host/port', async () => {
+ const sendEmailOptions = getSendEmailOptions(
+ {
+ transport: {
+ host: 'example.com',
+ port: 1025,
+ },
+ },
+ {
+ proxyUrl: 'https://example.com',
+ rejectUnauthorizedCertificates: false,
+ }
+ );
+ delete sendEmailOptions.transport.service;
+ delete sendEmailOptions.transport.user;
+ delete sendEmailOptions.transport.password;
+ const result = await sendEmail(mockLogger, sendEmailOptions);
+ expect(result).toBe(sendMailMockResult);
+ expect(createTransportMock.mock.calls[0]).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "headers": undefined,
+ "host": "example.com",
+ "port": 1025,
+ "proxy": "https://example.com",
+ "secure": false,
+ "tls": Object {
+ "rejectUnauthorized": false,
+ },
+ },
+ ]
+ `);
+ expect(sendMailMock.mock.calls[0]).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "bcc": Array [],
+ "cc": Array [
+ "bob@example.com",
+ "robert@example.com",
+ ],
+ "from": "fred@example.com",
+ "html": "a message
+ ",
+ "subject": "a subject",
+ "text": "a message",
+ "to": Array [
+ "jim@example.com",
+ ],
+ },
+ ]
+ `);
+ });
+
+ test('rejectUnauthorized default setting email using not secure host/port', async () => {
const sendEmailOptions = getSendEmailOptions({
transport: {
host: 'example.com',
@@ -80,9 +134,6 @@ describe('send_email module', () => {
"host": "example.com",
"port": 1025,
"secure": false,
- "tls": Object {
- "rejectUnauthorized": false,
- },
},
]
`);
@@ -161,7 +212,10 @@ describe('send_email module', () => {
});
});
-function getSendEmailOptions({ content = {}, routing = {}, transport = {} } = {}) {
+function getSendEmailOptions(
+ { content = {}, routing = {}, transport = {} } = {},
+ proxySettings?: ProxySettings
+) {
return {
content: {
...content,
@@ -181,5 +235,6 @@ function getSendEmailOptions({ content = {}, routing = {}, transport = {} } = {}
user: 'elastic',
password: 'changeme',
},
+ proxySettings,
};
}
diff --git a/x-pack/plugins/actions/server/builtin_action_types/lib/send_email.ts b/x-pack/plugins/actions/server/builtin_action_types/lib/send_email.ts
index 869db34f034ae..a4f32f1880cb5 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/lib/send_email.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/lib/send_email.ts
@@ -6,10 +6,10 @@
// info on nodemailer: https://nodemailer.com/about/
import nodemailer from 'nodemailer';
-
import { default as MarkdownIt } from 'markdown-it';
import { Logger } from '../../../../../../src/core/server';
+import { ProxySettings } from '../../types';
// an email "service" which doesn't actually send, just returns what it would send
export const JSON_TRANSPORT_SERVICE = '__json';
@@ -18,6 +18,7 @@ export interface SendEmailOptions {
transport: Transport;
routing: Routing;
content: Content;
+ proxySettings?: ProxySettings;
}
// config validation ensures either service is set or host/port are set
@@ -44,7 +45,7 @@ export interface Content {
// send an email
export async function sendEmail(logger: Logger, options: SendEmailOptions): Promise {
- const { transport, routing, content } = options;
+ const { transport, routing, content, proxySettings } = options;
const { service, host, port, secure, user, password } = transport;
const { from, to, cc, bcc } = routing;
const { subject, message } = content;
@@ -67,11 +68,16 @@ export async function sendEmail(logger: Logger, options: SendEmailOptions): Prom
transportConfig.host = host;
transportConfig.port = port;
transportConfig.secure = !!secure;
- if (!transportConfig.secure) {
+ if (proxySettings && !transportConfig.secure) {
transportConfig.tls = {
- rejectUnauthorized: false,
+ // do not fail on invalid certs if value is false
+ rejectUnauthorized: proxySettings?.rejectUnauthorizedCertificates,
};
}
+ if (proxySettings) {
+ transportConfig.proxy = proxySettings.proxyUrl;
+ transportConfig.headers = proxySettings.proxyHeaders;
+ }
}
const nodemailerTransport = nodemailer.createTransport(transportConfig);
diff --git a/x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts b/x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts
index b76e57419bc56..c0edfc530e738 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts
@@ -161,6 +161,7 @@ async function executor(
const secrets = execOptions.secrets;
const params = execOptions.params;
const services = execOptions.services;
+ const proxySettings = execOptions.proxySettings;
const apiUrl = getPagerDutyApiUrl(config);
const headers = {
@@ -171,7 +172,7 @@ async function executor(
let response;
try {
- response = await postPagerduty({ apiUrl, data, headers, services });
+ response = await postPagerduty({ apiUrl, data, headers, services, proxySettings }, logger);
} catch (err) {
const message = i18n.translate('xpack.actions.builtin.pagerduty.postingErrorMessage', {
defaultMessage: 'error posting pagerduty event',
diff --git a/x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts b/x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts
index e98bc71559d3f..1e9cb15589702 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts
@@ -4,6 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/
+import { Logger } from '../../../../../../src/core/server';
import { createConnector } from '../case/utils';
import { api } from './api';
@@ -11,14 +12,25 @@ import { config } from './config';
import { validate } from './validators';
import { createExternalService } from './service';
import { ResilientSecretConfiguration, ResilientPublicConfiguration } from './schema';
+import { ActionsConfigurationUtilities } from '../../actions_config';
+import { ActionType } from '../../types';
-export const getActionType = createConnector({
- api,
- config,
- validate,
- createExternalService,
- validationSchema: {
- config: ResilientPublicConfiguration,
- secrets: ResilientSecretConfiguration,
- },
-});
+export function getActionType({
+ logger,
+ configurationUtilities,
+}: {
+ logger: Logger;
+ configurationUtilities: ActionsConfigurationUtilities;
+}): ActionType {
+ return createConnector({
+ api,
+ config,
+ validate,
+ createExternalService,
+ validationSchema: {
+ config: ResilientPublicConfiguration,
+ secrets: ResilientSecretConfiguration,
+ },
+ logger,
+ })({ configurationUtilities });
+}
diff --git a/x-pack/plugins/actions/server/builtin_action_types/resilient/service.test.ts b/x-pack/plugins/actions/server/builtin_action_types/resilient/service.test.ts
index 573885698014e..a9271671f68b9 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/resilient/service.test.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/resilient/service.test.ts
@@ -9,6 +9,9 @@ import axios from 'axios';
import { createExternalService, getValueTextContent, formatUpdateRequest } from './service';
import * as utils from '../lib/axios_utils';
import { ExternalService } from '../case/types';
+import { Logger } from '../../../../../../src/core/server';
+import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
+const logger = loggingSystemMock.create().get() as jest.Mocked;
jest.mock('axios');
jest.mock('../lib/axios_utils', () => {
@@ -72,10 +75,13 @@ describe('IBM Resilient service', () => {
let service: ExternalService;
beforeAll(() => {
- service = createExternalService({
- config: { apiUrl: 'https://resilient.elastic.co', orgId: '201' },
- secrets: { apiKeyId: 'keyId', apiKeySecret: 'secret' },
- });
+ service = createExternalService(
+ {
+ config: { apiUrl: 'https://resilient.elastic.co', orgId: '201' },
+ secrets: { apiKeyId: 'keyId', apiKeySecret: 'secret' },
+ },
+ logger
+ );
});
afterAll(() => {
@@ -138,37 +144,49 @@ describe('IBM Resilient service', () => {
describe('createExternalService', () => {
test('throws without url', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: null, orgId: '201' },
- secrets: { apiKeyId: 'token', apiKeySecret: 'secret' },
- })
+ createExternalService(
+ {
+ config: { apiUrl: null, orgId: '201' },
+ secrets: { apiKeyId: 'token', apiKeySecret: 'secret' },
+ },
+ logger
+ )
).toThrow();
});
test('throws without orgId', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: 'test.com', orgId: null },
- secrets: { apiKeyId: 'token', apiKeySecret: 'secret' },
- })
+ createExternalService(
+ {
+ config: { apiUrl: 'test.com', orgId: null },
+ secrets: { apiKeyId: 'token', apiKeySecret: 'secret' },
+ },
+ logger
+ )
).toThrow();
});
test('throws without username', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: 'test.com', orgId: '201' },
- secrets: { apiKeyId: '', apiKeySecret: 'secret' },
- })
+ createExternalService(
+ {
+ config: { apiUrl: 'test.com', orgId: '201' },
+ secrets: { apiKeyId: '', apiKeySecret: 'secret' },
+ },
+ logger
+ )
).toThrow();
});
test('throws without password', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: 'test.com', orgId: '201' },
- secrets: { apiKeyId: '', apiKeySecret: undefined },
- })
+ createExternalService(
+ {
+ config: { apiUrl: 'test.com', orgId: '201' },
+ secrets: { apiKeyId: '', apiKeySecret: undefined },
+ },
+ logger
+ )
).toThrow();
});
});
@@ -197,6 +215,7 @@ describe('IBM Resilient service', () => {
await service.getIncident('1');
expect(requestMock).toHaveBeenCalledWith({
axios,
+ logger,
url: 'https://resilient.elastic.co/rest/orgs/201/incidents/1',
params: {
text_content_output_format: 'objects_convert',
@@ -256,6 +275,7 @@ describe('IBM Resilient service', () => {
expect(requestMock).toHaveBeenCalledWith({
axios,
url: 'https://resilient.elastic.co/rest/orgs/201/incidents',
+ logger,
method: 'post',
data: {
name: 'title',
@@ -311,6 +331,7 @@ describe('IBM Resilient service', () => {
// The second call to the API is the update call.
expect(requestMock.mock.calls[1][0]).toEqual({
axios,
+ logger,
method: 'patch',
url: 'https://resilient.elastic.co/rest/orgs/201/incidents/1',
data: {
@@ -392,7 +413,9 @@ describe('IBM Resilient service', () => {
expect(requestMock).toHaveBeenCalledWith({
axios,
+ logger,
method: 'post',
+ proxySettings: undefined,
url: 'https://resilient.elastic.co/rest/orgs/201/incidents/1/comments',
data: {
text: {
diff --git a/x-pack/plugins/actions/server/builtin_action_types/resilient/service.ts b/x-pack/plugins/actions/server/builtin_action_types/resilient/service.ts
index 8d0526ca3b571..b2150081f2c89 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/resilient/service.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/resilient/service.ts
@@ -6,6 +6,7 @@
import axios from 'axios';
+import { Logger } from '../../../../../../src/core/server';
import { ExternalServiceCredentials, ExternalService, ExternalServiceParams } from '../case/types';
import {
ResilientPublicConfigurationType,
@@ -19,6 +20,7 @@ import {
import * as i18n from './translations';
import { getErrorMessage, request } from '../lib/axios_utils';
+import { ProxySettings } from '../../types';
const BASE_URL = `rest`;
const INCIDENT_URL = `incidents`;
@@ -57,10 +59,11 @@ export const formatUpdateRequest = ({
};
};
-export const createExternalService = ({
- config,
- secrets,
-}: ExternalServiceCredentials): ExternalService => {
+export const createExternalService = (
+ { config, secrets }: ExternalServiceCredentials,
+ logger: Logger,
+ proxySettings?: ProxySettings
+): ExternalService => {
const { apiUrl: url, orgId } = config as ResilientPublicConfigurationType;
const { apiKeyId, apiKeySecret } = secrets as ResilientSecretConfigurationType;
@@ -88,9 +91,11 @@ export const createExternalService = ({
const res = await request({
axios: axiosInstance,
url: `${incidentUrl}/${id}`,
+ logger,
params: {
text_content_output_format: 'objects_convert',
},
+ proxySettings,
});
return { ...res.data, description: res.data.description?.content ?? '' };
@@ -107,6 +112,7 @@ export const createExternalService = ({
axios: axiosInstance,
url: `${incidentUrl}`,
method: 'post',
+ logger,
data: {
...incident,
description: {
@@ -115,6 +121,7 @@ export const createExternalService = ({
},
discovered_date: Date.now(),
},
+ proxySettings,
});
return {
@@ -139,7 +146,9 @@ export const createExternalService = ({
axios: axiosInstance,
method: 'patch',
url: `${incidentUrl}/${incidentId}`,
+ logger,
data,
+ proxySettings,
});
if (!res.data.success) {
@@ -170,7 +179,9 @@ export const createExternalService = ({
axios: axiosInstance,
method: 'post',
url: getCommentsURL(incidentId),
+ logger,
data: { text: { format: 'text', content: comment.comment } },
+ proxySettings,
});
return {
diff --git a/x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts b/x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts
index 109008b8fc9fb..3addbe7c54dac 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts
@@ -76,10 +76,14 @@ async function executor(
const { subAction, subActionParams } = params;
let data: PushToServiceResponse | null = null;
- const externalService = createExternalService({
- config,
- secrets,
- });
+ const externalService = createExternalService(
+ {
+ config,
+ secrets,
+ },
+ logger,
+ execOptions.proxySettings
+ );
if (!api[subAction]) {
const errorMessage = `[Action][ExternalService] Unsupported subAction type ${subAction}.`;
diff --git a/x-pack/plugins/actions/server/builtin_action_types/servicenow/service.test.ts b/x-pack/plugins/actions/server/builtin_action_types/servicenow/service.test.ts
index 07d60ec9f7a05..2adcdf561ce17 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/servicenow/service.test.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/servicenow/service.test.ts
@@ -9,6 +9,9 @@ import axios from 'axios';
import { createExternalService } from './service';
import * as utils from '../lib/axios_utils';
import { ExternalService } from './types';
+import { Logger } from '../../../../../../src/core/server';
+import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
+const logger = loggingSystemMock.create().get() as jest.Mocked;
jest.mock('axios');
jest.mock('../lib/axios_utils', () => {
@@ -28,10 +31,13 @@ describe('ServiceNow service', () => {
let service: ExternalService;
beforeAll(() => {
- service = createExternalService({
- config: { apiUrl: 'https://dev102283.service-now.com' },
- secrets: { username: 'admin', password: 'admin' },
- });
+ service = createExternalService(
+ {
+ config: { apiUrl: 'https://dev102283.service-now.com' },
+ secrets: { username: 'admin', password: 'admin' },
+ },
+ logger
+ );
});
beforeEach(() => {
@@ -41,28 +47,37 @@ describe('ServiceNow service', () => {
describe('createExternalService', () => {
test('throws without url', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: null },
- secrets: { username: 'admin', password: 'admin' },
- })
+ createExternalService(
+ {
+ config: { apiUrl: null },
+ secrets: { username: 'admin', password: 'admin' },
+ },
+ logger
+ )
).toThrow();
});
test('throws without username', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: 'test.com' },
- secrets: { username: '', password: 'admin' },
- })
+ createExternalService(
+ {
+ config: { apiUrl: 'test.com' },
+ secrets: { username: '', password: 'admin' },
+ },
+ logger
+ )
).toThrow();
});
test('throws without password', () => {
expect(() =>
- createExternalService({
- config: { apiUrl: 'test.com' },
- secrets: { username: '', password: undefined },
- })
+ createExternalService(
+ {
+ config: { apiUrl: 'test.com' },
+ secrets: { username: '', password: undefined },
+ },
+ logger
+ )
).toThrow();
});
});
@@ -84,6 +99,7 @@ describe('ServiceNow service', () => {
await service.getIncident('1');
expect(requestMock).toHaveBeenCalledWith({
axios,
+ logger,
url: 'https://dev102283.service-now.com/api/now/v2/table/incident/1',
});
});
@@ -127,6 +143,7 @@ describe('ServiceNow service', () => {
expect(requestMock).toHaveBeenCalledWith({
axios,
+ logger,
url: 'https://dev102283.service-now.com/api/now/v2/table/incident',
method: 'post',
data: { short_description: 'title', description: 'desc' },
@@ -179,6 +196,7 @@ describe('ServiceNow service', () => {
expect(patchMock).toHaveBeenCalledWith({
axios,
+ logger,
url: 'https://dev102283.service-now.com/api/now/v2/table/incident/1',
data: { short_description: 'title', description: 'desc' },
});
diff --git a/x-pack/plugins/actions/server/builtin_action_types/servicenow/service.ts b/x-pack/plugins/actions/server/builtin_action_types/servicenow/service.ts
index 2b5204af2eb7d..cf1c26e6462a2 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/servicenow/service.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/servicenow/service.ts
@@ -9,8 +9,10 @@ import axios from 'axios';
import { ExternalServiceCredentials, ExternalService, ExternalServiceParams } from './types';
import * as i18n from './translations';
+import { Logger } from '../../../../../../src/core/server';
import { ServiceNowPublicConfigurationType, ServiceNowSecretConfigurationType } from './types';
import { request, getErrorMessage, addTimeZoneToDate, patch } from '../lib/axios_utils';
+import { ProxySettings } from '../../types';
const API_VERSION = 'v2';
const INCIDENT_URL = `api/now/${API_VERSION}/table/incident`;
@@ -18,10 +20,11 @@ const INCIDENT_URL = `api/now/${API_VERSION}/table/incident`;
// Based on: https://docs.servicenow.com/bundle/orlando-platform-user-interface/page/use/navigation/reference/r_NavigatingByURLExamples.html
const VIEW_INCIDENT_URL = `nav_to.do?uri=incident.do?sys_id=`;
-export const createExternalService = ({
- config,
- secrets,
-}: ExternalServiceCredentials): ExternalService => {
+export const createExternalService = (
+ { config, secrets }: ExternalServiceCredentials,
+ logger: Logger,
+ proxySettings?: ProxySettings
+): ExternalService => {
const { apiUrl: url } = config as ServiceNowPublicConfigurationType;
const { username, password } = secrets as ServiceNowSecretConfigurationType;
@@ -43,6 +46,8 @@ export const createExternalService = ({
const res = await request({
axios: axiosInstance,
url: `${incidentUrl}/${id}`,
+ logger,
+ proxySettings,
});
return { ...res.data.result };
@@ -58,6 +63,8 @@ export const createExternalService = ({
const res = await request({
axios: axiosInstance,
url: incidentUrl,
+ logger,
+ proxySettings,
params,
});
@@ -71,9 +78,13 @@ export const createExternalService = ({
const createIncident = async ({ incident }: ExternalServiceParams) => {
try {
+ logger.warn(`incident error : ${JSON.stringify(proxySettings)}`);
+ logger.warn(`incident error : ${url}`);
const res = await request({
axios: axiosInstance,
url: `${incidentUrl}`,
+ logger,
+ proxySettings,
method: 'post',
data: { ...(incident as Record) },
});
@@ -96,7 +107,9 @@ export const createExternalService = ({
const res = await patch({
axios: axiosInstance,
url: `${incidentUrl}/${incidentId}`,
+ logger,
data: { ...(incident as Record) },
+ proxySettings,
});
return {
diff --git a/x-pack/plugins/actions/server/builtin_action_types/slack.test.ts b/x-pack/plugins/actions/server/builtin_action_types/slack.test.ts
index 6d4176067c3ba..812657138152c 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/slack.test.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/slack.test.ts
@@ -4,25 +4,40 @@
* you may not use this file except in compliance with the Elastic License.
*/
+import { Logger } from '../../../../../src/core/server';
import { Services, ActionTypeExecutorResult } from '../types';
import { validateParams, validateSecrets } from '../lib';
import { getActionType, SlackActionType, SlackActionTypeExecutorOptions } from './slack';
import { actionsConfigMock } from '../actions_config.mock';
import { actionsMock } from '../mocks';
+import { createActionTypeRegistry } from './index.test';
+
+jest.mock('@slack/webhook', () => {
+ return {
+ IncomingWebhook: jest.fn().mockImplementation(() => {
+ return { send: (message: string) => {} };
+ }),
+ };
+});
const ACTION_TYPE_ID = '.slack';
const services: Services = actionsMock.createServices();
let actionType: SlackActionType;
+let mockedLogger: jest.Mocked;
beforeAll(() => {
+ const { logger } = createActionTypeRegistry();
actionType = getActionType({
async executor(options) {
return { status: 'ok', actionId: options.actionId };
},
configurationUtilities: actionsConfigMock.create(),
+ logger,
});
+ mockedLogger = logger;
+ expect(actionType).toBeTruthy();
});
describe('action registeration', () => {
@@ -83,6 +98,7 @@ describe('validateActionTypeSecrets()', () => {
test('should validate and pass when the slack webhookUrl is whitelisted', () => {
actionType = getActionType({
+ logger: mockedLogger,
configurationUtilities: {
...actionsConfigMock.create(),
ensureWhitelistedUri: (url) => {
@@ -98,9 +114,10 @@ describe('validateActionTypeSecrets()', () => {
test('config validation returns an error if the specified URL isnt whitelisted', () => {
actionType = getActionType({
+ logger: mockedLogger,
configurationUtilities: {
...actionsConfigMock.create(),
- ensureWhitelistedHostname: (url) => {
+ ensureWhitelistedHostname: () => {
throw new Error(`target hostname is not whitelisted`);
},
},
@@ -136,6 +153,7 @@ describe('execute()', () => {
actionType = getActionType({
executor: mockSlackExecutor,
+ logger: mockedLogger,
configurationUtilities: actionsConfigMock.create(),
});
});
@@ -147,6 +165,10 @@ describe('execute()', () => {
config: {},
secrets: { webhookUrl: 'http://example.com' },
params: { message: 'this invocation should succeed' },
+ proxySettings: {
+ proxyUrl: 'https://someproxyhost',
+ rejectUnauthorizedCertificates: false,
+ },
});
expect(response).toMatchInlineSnapshot(`
Object {
@@ -170,4 +192,25 @@ describe('execute()', () => {
`"slack mockExecutor failure: this invocation should fail"`
);
});
+
+ test('calls the mock executor with success proxy', async () => {
+ const actionTypeProxy = getActionType({
+ logger: mockedLogger,
+ configurationUtilities: actionsConfigMock.create(),
+ });
+ await actionTypeProxy.executor({
+ actionId: 'some-id',
+ services,
+ config: {},
+ secrets: { webhookUrl: 'http://example.com' },
+ params: { message: 'this invocation should succeed' },
+ proxySettings: {
+ proxyUrl: 'https://someproxyhost',
+ rejectUnauthorizedCertificates: false,
+ },
+ });
+ expect(mockedLogger.info).toHaveBeenCalledWith(
+ 'IncomingWebhook was called with proxyUrl https://someproxyhost'
+ );
+ });
});
diff --git a/x-pack/plugins/actions/server/builtin_action_types/slack.ts b/x-pack/plugins/actions/server/builtin_action_types/slack.ts
index 209582585256b..293328c809435 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/slack.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/slack.ts
@@ -6,11 +6,14 @@
import { URL } from 'url';
import { curry } from 'lodash';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+import HttpProxyAgent from 'http-proxy-agent';
import { i18n } from '@kbn/i18n';
import { schema, TypeOf } from '@kbn/config-schema';
import { IncomingWebhook, IncomingWebhookResult } from '@slack/webhook';
import { pipe } from 'fp-ts/lib/pipeable';
import { map, getOrElse } from 'fp-ts/lib/Option';
+import { Logger } from '../../../../../src/core/server';
import { getRetryAfterIntervalFromHeaders } from './lib/http_rersponse_retry_header';
import {
@@ -20,6 +23,7 @@ import {
ExecutorType,
} from '../types';
import { ActionsConfigurationUtilities } from '../actions_config';
+import { getProxyAgent } from './lib/get_proxy_agent';
export type SlackActionType = ActionType<{}, ActionTypeSecretsType, ActionParamsType, unknown>;
export type SlackActionTypeExecutorOptions = ActionTypeExecutorOptions<
@@ -49,9 +53,11 @@ const ParamsSchema = schema.object({
// customizing executor is only used for tests
export function getActionType({
+ logger,
configurationUtilities,
- executor = slackExecutor,
+ executor = curry(slackExecutor)({ logger }),
}: {
+ logger: Logger;
configurationUtilities: ActionsConfigurationUtilities;
executor?: ExecutorType<{}, ActionTypeSecretsType, ActionParamsType, unknown>;
}): SlackActionType {
@@ -99,6 +105,7 @@ function valdiateActionTypeConfig(
// action executor
async function slackExecutor(
+ { logger }: { logger: Logger },
execOptions: SlackActionTypeExecutorOptions
): Promise> {
const actionId = execOptions.actionId;
@@ -109,10 +116,22 @@ async function slackExecutor(
const { webhookUrl } = secrets;
const { message } = params;
+ let proxyAgent: HttpsProxyAgent | HttpProxyAgent | undefined;
+ if (execOptions.proxySettings) {
+ proxyAgent = getProxyAgent(execOptions.proxySettings, logger);
+ logger.info(`IncomingWebhook was called with proxyUrl ${execOptions.proxySettings.proxyUrl}`);
+ }
+
try {
- const webhook = new IncomingWebhook(webhookUrl);
+ // https://slack.dev/node-slack-sdk/webhook
+ // node-slack-sdk use Axios inside :)
+ const webhook = new IncomingWebhook(webhookUrl, {
+ agent: proxyAgent,
+ });
result = await webhook.send(message);
} catch (err) {
+ logger.error(`error on ${actionId} slack event: ${err.message}`);
+
if (err.original == null || err.original.response == null) {
return serviceErrorResult(actionId, err.message);
}
@@ -143,6 +162,8 @@ async function slackExecutor(
},
}
);
+ logger.error(`error on ${actionId} slack action: ${errMessage}`);
+
return errorResult(actionId, errMessage);
}
diff --git a/x-pack/plugins/actions/server/builtin_action_types/webhook.test.ts b/x-pack/plugins/actions/server/builtin_action_types/webhook.test.ts
index 26dd8a1a1402a..ea9f30452918c 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/webhook.test.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/webhook.test.ts
@@ -4,10 +4,6 @@
* you may not use this file except in compliance with the Elastic License.
*/
-jest.mock('axios', () => ({
- request: jest.fn(),
-}));
-
import { Services } from '../types';
import { validateConfig, validateSecrets, validateParams } from '../lib';
import { actionsConfigMock } from '../actions_config.mock';
@@ -24,7 +20,22 @@ import {
WebhookMethods,
} from './webhook';
-const axiosRequestMock = axios.request as jest.Mock;
+import * as utils from './lib/axios_utils';
+
+jest.mock('axios');
+jest.mock('./lib/axios_utils', () => {
+ const originalUtils = jest.requireActual('./lib/axios_utils');
+ return {
+ ...originalUtils,
+ request: jest.fn(),
+ patch: jest.fn(),
+ };
+});
+
+axios.create = jest.fn(() => axios);
+const requestMock = utils.request as jest.Mock;
+
+axios.create = jest.fn(() => axios);
const ACTION_TYPE_ID = '.webhook';
@@ -227,7 +238,7 @@ describe('params validation', () => {
describe('execute()', () => {
beforeAll(() => {
- axiosRequestMock.mockReset();
+ requestMock.mockReset();
actionType = getActionType({
logger: mockedLogger,
configurationUtilities: actionsConfigMock.create(),
@@ -235,8 +246,8 @@ describe('execute()', () => {
});
beforeEach(() => {
- axiosRequestMock.mockReset();
- axiosRequestMock.mockResolvedValue({
+ requestMock.mockReset();
+ requestMock.mockResolvedValue({
status: 200,
statusText: '',
data: '',
@@ -261,17 +272,42 @@ describe('execute()', () => {
params: { body: 'some data' },
});
- expect(axiosRequestMock.mock.calls[0][0]).toMatchInlineSnapshot(`
+ expect(requestMock.mock.calls[0][0]).toMatchInlineSnapshot(`
Object {
"auth": Object {
"password": "123",
"username": "abc",
},
+ "axios": undefined,
"data": "some data",
"headers": Object {
"aheader": "a value",
},
+ "logger": Object {
+ "context": Array [],
+ "debug": [MockFunction] {
+ "calls": Array [
+ Array [
+ "response from webhook action \\"some-id\\": [HTTP 200] ",
+ ],
+ ],
+ "results": Array [
+ Object {
+ "type": "return",
+ "value": undefined,
+ },
+ ],
+ },
+ "error": [MockFunction],
+ "fatal": [MockFunction],
+ "get": [MockFunction],
+ "info": [MockFunction],
+ "log": [MockFunction],
+ "trace": [MockFunction],
+ "warn": [MockFunction],
+ },
"method": "post",
+ "proxySettings": undefined,
"url": "https://abc.def/my-webhook",
}
`);
@@ -294,13 +330,38 @@ describe('execute()', () => {
params: { body: 'some data' },
});
- expect(axiosRequestMock.mock.calls[0][0]).toMatchInlineSnapshot(`
+ expect(requestMock.mock.calls[0][0]).toMatchInlineSnapshot(`
Object {
+ "axios": undefined,
"data": "some data",
"headers": Object {
"aheader": "a value",
},
+ "logger": Object {
+ "context": Array [],
+ "debug": [MockFunction] {
+ "calls": Array [
+ Array [
+ "response from webhook action \\"some-id\\": [HTTP 200] ",
+ ],
+ ],
+ "results": Array [
+ Object {
+ "type": "return",
+ "value": undefined,
+ },
+ ],
+ },
+ "error": [MockFunction],
+ "fatal": [MockFunction],
+ "get": [MockFunction],
+ "info": [MockFunction],
+ "log": [MockFunction],
+ "trace": [MockFunction],
+ "warn": [MockFunction],
+ },
"method": "post",
+ "proxySettings": undefined,
"url": "https://abc.def/my-webhook",
}
`);
diff --git a/x-pack/plugins/actions/server/builtin_action_types/webhook.ts b/x-pack/plugins/actions/server/builtin_action_types/webhook.ts
index be75742fa882e..d9a005565498d 100644
--- a/x-pack/plugins/actions/server/builtin_action_types/webhook.ts
+++ b/x-pack/plugins/actions/server/builtin_action_types/webhook.ts
@@ -15,6 +15,7 @@ import { isOk, promiseResult, Result } from './lib/result_type';
import { ActionType, ActionTypeExecutorOptions, ActionTypeExecutorResult } from '../types';
import { ActionsConfigurationUtilities } from '../actions_config';
import { Logger } from '../../../../../src/core/server';
+import { request } from './lib/axios_utils';
// config definition
export enum WebhookMethods {
@@ -136,13 +137,18 @@ export async function executor(
? { auth: { username: secrets.user, password: secrets.password } }
: {};
+ const axiosInstance = axios.create();
+
const result: Result = await promiseResult(
- axios.request({
+ request({
+ axios: axiosInstance,
method,
url,
+ logger,
...basicAuth,
headers,
data,
+ proxySettings: execOptions.proxySettings,
})
);
@@ -159,7 +165,7 @@ export async function executor(
if (error.response) {
const { status, statusText, headers: responseHeaders } = error.response;
const message = `[${status}] ${statusText}`;
- logger.warn(`error on ${actionId} webhook event: ${message}`);
+ logger.error(`error on ${actionId} webhook event: ${message}`);
// The request was made and the server responded with a status code
// that falls out of the range of 2xx
// special handling for 5xx
@@ -178,7 +184,7 @@ export async function executor(
return errorResultInvalid(actionId, message);
}
- logger.warn(`error on ${actionId} webhook action: unexpected error`);
+ logger.error(`error on ${actionId} webhook action: unexpected error`);
return errorResultUnexpectedError(actionId);
}
}
diff --git a/x-pack/plugins/actions/server/config.test.ts b/x-pack/plugins/actions/server/config.test.ts
index e86f2d7832828..795fbbf84145b 100644
--- a/x-pack/plugins/actions/server/config.test.ts
+++ b/x-pack/plugins/actions/server/config.test.ts
@@ -15,6 +15,7 @@ describe('config validation', () => {
"*",
],
"preconfigured": Object {},
+ "rejectUnauthorizedCertificates": true,
"whitelistedHosts": Array [
"*",
],
@@ -33,6 +34,7 @@ describe('config validation', () => {
},
},
},
+ rejectUnauthorizedCertificates: false,
};
expect(configSchema.validate(config)).toMatchInlineSnapshot(`
Object {
@@ -50,6 +52,7 @@ describe('config validation', () => {
"secrets": Object {},
},
},
+ "rejectUnauthorizedCertificates": false,
"whitelistedHosts": Array [
"*",
],
diff --git a/x-pack/plugins/actions/server/config.ts b/x-pack/plugins/actions/server/config.ts
index b2f3fa2680a9c..ba80915ebe243 100644
--- a/x-pack/plugins/actions/server/config.ts
+++ b/x-pack/plugins/actions/server/config.ts
@@ -32,6 +32,9 @@ export const configSchema = schema.object({
defaultValue: {},
validate: validatePreconfigured,
}),
+ proxyUrl: schema.maybe(schema.string()),
+ proxyHeaders: schema.maybe(schema.recordOf(schema.string(), schema.string())),
+ rejectUnauthorizedCertificates: schema.boolean({ defaultValue: true }),
});
export type ActionsConfig = TypeOf;
diff --git a/x-pack/plugins/actions/server/lib/action_executor.ts b/x-pack/plugins/actions/server/lib/action_executor.ts
index bce06c829b1bc..97c08124f5546 100644
--- a/x-pack/plugins/actions/server/lib/action_executor.ts
+++ b/x-pack/plugins/actions/server/lib/action_executor.ts
@@ -12,6 +12,7 @@ import {
GetServicesFunction,
RawAction,
PreConfiguredAction,
+ ProxySettings,
} from '../types';
import { EncryptedSavedObjectsClient } from '../../../encrypted_saved_objects/server';
import { SpacesServiceSetup } from '../../../spaces/server';
@@ -28,6 +29,7 @@ export interface ActionExecutorContext {
actionTypeRegistry: ActionTypeRegistryContract;
eventLogger: IEventLogger;
preconfiguredActions: PreConfiguredAction[];
+ proxySettings?: ProxySettings;
}
export interface ExecuteOptions {
@@ -78,6 +80,7 @@ export class ActionExecutor {
eventLogger,
preconfiguredActions,
getActionsClientWithRequest,
+ proxySettings,
} = this.actionExecutorContext!;
const services = getServices(request);
@@ -133,6 +136,7 @@ export class ActionExecutor {
params: validatedParams,
config: validatedConfig,
secrets: validatedSecrets,
+ proxySettings,
});
} catch (err) {
rawResult = {
diff --git a/x-pack/plugins/actions/server/plugin.test.ts b/x-pack/plugins/actions/server/plugin.test.ts
index ca93e88d01203..341a17889923f 100644
--- a/x-pack/plugins/actions/server/plugin.test.ts
+++ b/x-pack/plugins/actions/server/plugin.test.ts
@@ -34,6 +34,7 @@ describe('Actions Plugin', () => {
enabledActionTypes: ['*'],
whitelistedHosts: ['*'],
preconfigured: {},
+ rejectUnauthorizedCertificates: true,
});
plugin = new ActionsPlugin(context);
coreSetup = coreMock.createSetup();
@@ -194,6 +195,7 @@ describe('Actions Plugin', () => {
secrets: {},
},
},
+ rejectUnauthorizedCertificates: true,
});
plugin = new ActionsPlugin(context);
coreSetup = coreMock.createSetup();
@@ -217,7 +219,7 @@ describe('Actions Plugin', () => {
// coreMock.createSetup doesn't support Plugin generics
// eslint-disable-next-line @typescript-eslint/no-explicit-any
await plugin.setup(coreSetup as any, pluginsSetup);
- const pluginStart = plugin.start(coreStart, pluginsStart);
+ const pluginStart = await plugin.start(coreStart, pluginsStart);
expect(pluginStart.isActionExecutable('preconfiguredServerLog', '.server-log')).toBe(true);
});
@@ -232,7 +234,7 @@ describe('Actions Plugin', () => {
usingEphemeralEncryptionKey: false,
},
});
- const pluginStart = plugin.start(coreStart, pluginsStart);
+ const pluginStart = await plugin.start(coreStart, pluginsStart);
await pluginStart.getActionsClientWithRequest(httpServerMock.createKibanaRequest());
});
@@ -241,7 +243,7 @@ describe('Actions Plugin', () => {
// coreMock.createSetup doesn't support Plugin generics
// eslint-disable-next-line @typescript-eslint/no-explicit-any
await plugin.setup(coreSetup as any, pluginsSetup);
- const pluginStart = plugin.start(coreStart, pluginsStart);
+ const pluginStart = await plugin.start(coreStart, pluginsStart);
expect(pluginsSetup.encryptedSavedObjects.usingEphemeralEncryptionKey).toEqual(true);
await expect(
diff --git a/x-pack/plugins/actions/server/plugin.ts b/x-pack/plugins/actions/server/plugin.ts
index ee50ee81d507c..413e6663105b8 100644
--- a/x-pack/plugins/actions/server/plugin.ts
+++ b/x-pack/plugins/actions/server/plugin.ts
@@ -116,6 +116,7 @@ export class ActionsPlugin implements Plugin, Plugi
private readonly config: Promise;
private readonly logger: Logger;
+ private actionsConfig?: ActionsConfig;
private serverBasePath?: string;
private taskRunnerFactory?: TaskRunnerFactory;
private actionTypeRegistry?: ActionTypeRegistry;
@@ -173,12 +174,12 @@ export class ActionsPlugin implements Plugin, Plugi
// get executions count
const taskRunnerFactory = new TaskRunnerFactory(actionExecutor);
- const actionsConfig = (await this.config) as ActionsConfig;
- const actionsConfigUtils = getActionsConfigurationUtilities(actionsConfig);
+ this.actionsConfig = (await this.config) as ActionsConfig;
+ const actionsConfigUtils = getActionsConfigurationUtilities(this.actionsConfig);
- for (const preconfiguredId of Object.keys(actionsConfig.preconfigured)) {
+ for (const preconfiguredId of Object.keys(this.actionsConfig.preconfigured)) {
this.preconfiguredActions.push({
- ...actionsConfig.preconfigured[preconfiguredId],
+ ...this.actionsConfig.preconfigured[preconfiguredId],
id: preconfiguredId,
isPreconfigured: true,
});
@@ -317,6 +318,14 @@ export class ActionsPlugin implements Plugin, Plugi
encryptedSavedObjectsClient,
actionTypeRegistry: actionTypeRegistry!,
preconfiguredActions,
+ proxySettings:
+ this.actionsConfig && this.actionsConfig.proxyUrl
+ ? {
+ proxyUrl: this.actionsConfig.proxyUrl,
+ proxyHeaders: this.actionsConfig.proxyHeaders,
+ rejectUnauthorizedCertificates: this.actionsConfig.rejectUnauthorizedCertificates,
+ }
+ : undefined,
});
taskRunnerFactory!.initialize({
diff --git a/x-pack/plugins/actions/server/types.ts b/x-pack/plugins/actions/server/types.ts
index ecec45ade0460..bf7bd709a4a88 100644
--- a/x-pack/plugins/actions/server/types.ts
+++ b/x-pack/plugins/actions/server/types.ts
@@ -58,6 +58,7 @@ export interface ActionTypeExecutorOptions {
config: Config;
secrets: Secrets;
params: Params;
+ proxySettings?: ProxySettings;
}
export interface ActionResult {
@@ -140,3 +141,9 @@ export interface ActionTaskExecutorParams {
spaceId: string;
actionTaskParamsId: string;
}
+
+export interface ProxySettings {
+ proxyUrl: string;
+ proxyHeaders?: Record;
+ rejectUnauthorizedCertificates: boolean;
+}
diff --git a/x-pack/plugins/alerting_builtins/server/alert_types/index_threshold/action_context.ts b/x-pack/plugins/alerting_builtins/server/alert_types/index_threshold/action_context.ts
index c3a132bc609d6..294a831c93459 100644
--- a/x-pack/plugins/alerting_builtins/server/alert_types/index_threshold/action_context.ts
+++ b/x-pack/plugins/alerting_builtins/server/alert_types/index_threshold/action_context.ts
@@ -6,7 +6,7 @@
import { i18n } from '@kbn/i18n';
import { Params } from './alert_type_params';
-import { AlertExecutorOptions } from '../../../../alerts/server';
+import { AlertExecutorOptions, AlertInstanceContext } from '../../../../alerts/server';
// alert type context provided to actions
@@ -19,7 +19,7 @@ export interface ActionContext extends BaseActionContext {
message: string;
}
-export interface BaseActionContext {
+export interface BaseActionContext extends AlertInstanceContext {
// the aggType used in the alert
// the value of the aggField, if used, otherwise 'all documents'
group: string;
diff --git a/x-pack/plugins/alerting_builtins/server/alert_types/index_threshold/alert_type.ts b/x-pack/plugins/alerting_builtins/server/alert_types/index_threshold/alert_type.ts
index c0522c08a7b96..01c2c2feb5b9a 100644
--- a/x-pack/plugins/alerting_builtins/server/alert_types/index_threshold/alert_type.ts
+++ b/x-pack/plugins/alerting_builtins/server/alert_types/index_threshold/alert_type.ts
@@ -7,7 +7,7 @@
import { i18n } from '@kbn/i18n';
import { AlertType, AlertExecutorOptions } from '../../types';
import { Params, ParamsSchema } from './alert_type_params';
-import { BaseActionContext, addMessages } from './action_context';
+import { ActionContext, BaseActionContext, addMessages } from './action_context';
import { TimeSeriesQuery } from './lib/time_series_query';
import { Service } from '../../types';
import { BUILT_IN_ALERTS_FEATURE_ID } from '../../../common';
@@ -19,7 +19,7 @@ const ActionGroupId = 'threshold met';
const ComparatorFns = getComparatorFns();
export const ComparatorFnNames = new Set(ComparatorFns.keys());
-export function getAlertType(service: Service): AlertType {
+export function getAlertType(service: Service): AlertType {
const { logger } = service;
const alertTypeName = i18n.translate('xpack.alertingBuiltins.indexThreshold.alertTypeTitle', {
@@ -118,9 +118,8 @@ export function getAlertType(service: Service): AlertType {
producer: BUILT_IN_ALERTS_FEATURE_ID,
};
- async function executor(options: AlertExecutorOptions) {
- const { alertId, name, services } = options;
- const params: Params = options.params as Params;
+ async function executor(options: AlertExecutorOptions) {
+ const { alertId, name, services, params } = options;
const compareFn = ComparatorFns.get(params.thresholdComparator);
if (compareFn == null) {
diff --git a/x-pack/plugins/alerts/README.md b/x-pack/plugins/alerts/README.md
index 10568abbe3c72..aab05cb0a7cfd 100644
--- a/x-pack/plugins/alerts/README.md
+++ b/x-pack/plugins/alerts/README.md
@@ -26,6 +26,7 @@ Table of Contents
- [`GET /api/alerts/_find`: Find alerts](#get-apialertfind-find-alerts)
- [`GET /api/alerts/alert/{id}`: Get alert](#get-apialertid-get-alert)
- [`GET /api/alerts/alert/{id}/state`: Get alert state](#get-apialertidstate-get-alert-state)
+ - [`GET /api/alerts/alert/{id}/status`: Get alert status](#get-apialertidstate-get-alert-status)
- [`GET /api/alerts/list_alert_types`: List alert types](#get-apialerttypes-list-alert-types)
- [`PUT /api/alerts/alert/{id}`: Update alert](#put-apialertid-update-alert)
- [`POST /api/alerts/alert/{id}/_enable`: Enable an alert](#post-apialertidenable-enable-an-alert)
@@ -504,6 +505,23 @@ Params:
|---|---|---|
|id|The id of the alert whose state you're trying to get.|string|
+### `GET /api/alerts/alert/{id}/status`: Get alert status
+
+Similar to the `GET state` call, but collects additional information from
+the event log.
+
+Params:
+
+|Property|Description|Type|
+|---|---|---|
+|id|The id of the alert whose status you're trying to get.|string|
+
+Query:
+
+|Property|Description|Type|
+|---|---|---|
+|dateStart|The date to start looking for alert events in the event log. Either an ISO date string, or a duration string indicating time since now.|string|
+
### `GET /api/alerts/list_alert_types`: List alert types
No parameters.
diff --git a/x-pack/plugins/alerts/common/alert.ts b/x-pack/plugins/alerts/common/alert.ts
index b410b6aa0187e..3ff7ed742e810 100644
--- a/x-pack/plugins/alerts/common/alert.ts
+++ b/x-pack/plugins/alerts/common/alert.ts
@@ -6,6 +6,11 @@
import { SavedObjectAttributes } from 'kibana/server';
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type AlertTypeState = Record;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type AlertTypeParams = Record;
+
export interface IntervalSchedule extends SavedObjectAttributes {
interval: string;
}
@@ -28,9 +33,7 @@ export interface Alert {
consumer: string;
schedule: IntervalSchedule;
actions: AlertAction[];
- // This will have to remain `any` until we can extend Alert Executors with generics
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- params: Record;
+ params: AlertTypeParams;
scheduledTaskId?: string;
createdBy: string | null;
updatedBy: string | null;
diff --git a/x-pack/plugins/alerts/common/alert_instance.ts b/x-pack/plugins/alerts/common/alert_instance.ts
index a6852f06efd34..0253a5c6919d6 100644
--- a/x-pack/plugins/alerts/common/alert_instance.ts
+++ b/x-pack/plugins/alerts/common/alert_instance.ts
@@ -17,6 +17,9 @@ export type AlertInstanceMeta = t.TypeOf;
const stateSchema = t.record(t.string, t.unknown);
export type AlertInstanceState = t.TypeOf;
+const contextSchema = t.record(t.string, t.unknown);
+export type AlertInstanceContext = t.TypeOf;
+
export const rawAlertInstance = t.partial({
state: stateSchema,
meta: metaSchema,
diff --git a/x-pack/plugins/alerts/common/alert_status.ts b/x-pack/plugins/alerts/common/alert_status.ts
new file mode 100644
index 0000000000000..517db6d6cb243
--- /dev/null
+++ b/x-pack/plugins/alerts/common/alert_status.ts
@@ -0,0 +1,31 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+type AlertStatusValues = 'OK' | 'Active' | 'Error';
+type AlertInstanceStatusValues = 'OK' | 'Active';
+
+export interface AlertStatus {
+ id: string;
+ name: string;
+ tags: string[];
+ alertTypeId: string;
+ consumer: string;
+ muteAll: boolean;
+ throttle: string | null;
+ enabled: boolean;
+ statusStartDate: string;
+ statusEndDate: string;
+ status: AlertStatusValues;
+ lastRun?: string;
+ errorMessages: Array<{ date: string; message: string }>;
+ instances: Record;
+}
+
+export interface AlertInstanceStatus {
+ status: AlertInstanceStatusValues;
+ muted: boolean;
+ activeStartDate?: string;
+}
diff --git a/x-pack/plugins/alerts/common/index.ts b/x-pack/plugins/alerts/common/index.ts
index b839c07a9db89..0922e164a3aa3 100644
--- a/x-pack/plugins/alerts/common/index.ts
+++ b/x-pack/plugins/alerts/common/index.ts
@@ -9,6 +9,7 @@ export * from './alert_type';
export * from './alert_instance';
export * from './alert_task_instance';
export * from './alert_navigation';
+export * from './alert_status';
export interface ActionGroup {
id: string;
diff --git a/x-pack/plugins/alerts/server/alert_instance/alert_instance.ts b/x-pack/plugins/alerts/server/alert_instance/alert_instance.ts
index 4d106178f86fb..661fb75f81c00 100644
--- a/x-pack/plugins/alerts/server/alert_instance/alert_instance.ts
+++ b/x-pack/plugins/alerts/server/alert_instance/alert_instance.ts
@@ -8,24 +8,26 @@ import {
AlertInstanceState,
RawAlertInstance,
rawAlertInstance,
+ AlertInstanceContext,
} from '../../common';
-import { State, Context } from '../types';
import { parseDuration } from '../lib';
-interface ScheduledExecutionOptions {
- actionGroup: string;
- context: Context;
- state: State;
-}
export type AlertInstances = Record;
-export class AlertInstance {
- private scheduledExecutionOptions?: ScheduledExecutionOptions;
+export class AlertInstance<
+ State extends AlertInstanceState = AlertInstanceState,
+ Context extends AlertInstanceContext = AlertInstanceContext
+> {
+ private scheduledExecutionOptions?: {
+ actionGroup: string;
+ context: Context;
+ state: State;
+ };
private meta: AlertInstanceMeta;
- private state: AlertInstanceState;
+ private state: State;
- constructor({ state = {}, meta = {} }: RawAlertInstance = {}) {
- this.state = state;
+ constructor({ state, meta = {} }: RawAlertInstance = {}) {
+ this.state = (state || {}) as State;
this.meta = meta;
}
@@ -62,11 +64,15 @@ export class AlertInstance {
return this.state;
}
- scheduleActions(actionGroup: string, context: Context = {}) {
+ scheduleActions(actionGroup: string, context?: Context) {
if (this.hasScheduledActions()) {
throw new Error('Alert instance execution has already been scheduled, cannot schedule twice');
}
- this.scheduledExecutionOptions = { actionGroup, context, state: this.state };
+ this.scheduledExecutionOptions = {
+ actionGroup,
+ context: (context || {}) as Context,
+ state: this.state,
+ };
return this;
}
diff --git a/x-pack/plugins/alerts/server/alert_type_registry.ts b/x-pack/plugins/alerts/server/alert_type_registry.ts
index 19d3bf13bd66d..7f34803b05a81 100644
--- a/x-pack/plugins/alerts/server/alert_type_registry.ts
+++ b/x-pack/plugins/alerts/server/alert_type_registry.ts
@@ -10,7 +10,13 @@ import { schema } from '@kbn/config-schema';
import typeDetect from 'type-detect';
import { RunContext, TaskManagerSetupContract } from '../../task_manager/server';
import { TaskRunnerFactory } from './task_runner';
-import { AlertType } from './types';
+import {
+ AlertType,
+ AlertTypeParams,
+ AlertTypeState,
+ AlertInstanceState,
+ AlertInstanceContext,
+} from './types';
interface ConstructorOptions {
taskManager: TaskManagerSetupContract;
@@ -59,7 +65,12 @@ export class AlertTypeRegistry {
return this.alertTypes.has(id);
}
- public register(alertType: AlertType) {
+ public register<
+ Params extends AlertTypeParams = AlertTypeParams,
+ State extends AlertTypeState = AlertTypeState,
+ InstanceState extends AlertInstanceState = AlertInstanceState,
+ InstanceContext extends AlertInstanceContext = AlertInstanceContext
+ >(alertType: AlertType) {
if (this.has(alertType.id)) {
throw new Error(
i18n.translate('xpack.alerts.alertTypeRegistry.register.duplicateAlertTypeError', {
@@ -71,18 +82,23 @@ export class AlertTypeRegistry {
);
}
alertType.actionVariables = normalizedActionVariables(alertType.actionVariables);
- this.alertTypes.set(alertIdSchema.validate(alertType.id), { ...alertType });
+ this.alertTypes.set(alertIdSchema.validate(alertType.id), { ...alertType } as AlertType);
this.taskManager.registerTaskDefinitions({
[`alerting:${alertType.id}`]: {
title: alertType.name,
type: `alerting:${alertType.id}`,
createTaskRunner: (context: RunContext) =>
- this.taskRunnerFactory.create(alertType, context),
+ this.taskRunnerFactory.create({ ...alertType } as AlertType, context),
},
});
}
- public get(id: string): AlertType {
+ public get<
+ Params extends AlertTypeParams = AlertTypeParams,
+ State extends AlertTypeState = AlertTypeState,
+ InstanceState extends AlertInstanceState = AlertInstanceState,
+ InstanceContext extends AlertInstanceContext = AlertInstanceContext
+ >(id: string): AlertType {
if (!this.has(id)) {
throw Boom.badRequest(
i18n.translate('xpack.alerts.alertTypeRegistry.get.missingAlertTypeError', {
@@ -93,7 +109,7 @@ export class AlertTypeRegistry {
})
);
}
- return this.alertTypes.get(id)!;
+ return this.alertTypes.get(id)! as AlertType;
}
public list(): Set {
diff --git a/x-pack/plugins/alerts/server/alerts_client.mock.ts b/x-pack/plugins/alerts/server/alerts_client.mock.ts
index be70e441b6fc5..b61139ae72c99 100644
--- a/x-pack/plugins/alerts/server/alerts_client.mock.ts
+++ b/x-pack/plugins/alerts/server/alerts_client.mock.ts
@@ -25,6 +25,7 @@ const createAlertsClientMock = () => {
muteInstance: jest.fn(),
unmuteInstance: jest.fn(),
listAlertTypes: jest.fn(),
+ getAlertStatus: jest.fn(),
};
return mocked;
};
diff --git a/x-pack/plugins/alerts/server/alerts_client.test.ts b/x-pack/plugins/alerts/server/alerts_client.test.ts
index c25e040ad09ce..d994269366ae6 100644
--- a/x-pack/plugins/alerts/server/alerts_client.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client.test.ts
@@ -11,16 +11,22 @@ import { taskManagerMock } from '../../task_manager/server/task_manager.mock';
import { alertTypeRegistryMock } from './alert_type_registry.mock';
import { alertsAuthorizationMock } from './authorization/alerts_authorization.mock';
import { TaskStatus } from '../../task_manager/server';
-import { IntervalSchedule } from './types';
+import { IntervalSchedule, RawAlert } from './types';
import { resolvable } from './test_utils';
import { encryptedSavedObjectsMock } from '../../encrypted_saved_objects/server/mocks';
import { actionsClientMock, actionsAuthorizationMock } from '../../actions/server/mocks';
import { AlertsAuthorization } from './authorization/alerts_authorization';
import { ActionsAuthorization } from '../../actions/server';
+import { eventLogClientMock } from '../../event_log/server/mocks';
+import { QueryEventsBySavedObjectResult } from '../../event_log/server';
+import { SavedObject } from 'kibana/server';
+import { EventsFactory } from './lib/alert_status_from_event_log.test';
const taskManager = taskManagerMock.start();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
+const eventLogClient = eventLogClientMock.create();
+
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
@@ -39,6 +45,7 @@ const alertsClientParams: jest.Mocked = {
logger: loggingSystemMock.create().get(),
encryptedSavedObjectsClient: encryptedSavedObjects,
getActionsClient: jest.fn(),
+ getEventLogClient: jest.fn(),
};
beforeEach(() => {
@@ -91,17 +98,33 @@ beforeEach(() => {
async executor() {},
producer: 'alerts',
}));
+ alertsClientParams.getEventLogClient.mockResolvedValue(eventLogClient);
});
-const mockedDate = new Date('2019-02-12T21:01:22.479Z');
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const mockedDateString = '2019-02-12T21:01:22.479Z';
+const mockedDate = new Date(mockedDateString);
+const DateOriginal = Date;
+
+// A version of date that responds to `new Date(null|undefined)` and `Date.now()`
+// by returning a fixed date, otherwise should be same as Date.
+/* eslint-disable-next-line @typescript-eslint/no-explicit-any */
(global as any).Date = class Date {
- constructor() {
- return mockedDate;
+ constructor(...args: unknown[]) {
+ // sometimes the ctor has no args, sometimes has a single `null` arg
+ if (args[0] == null) {
+ // @ts-ignore
+ return mockedDate;
+ } else {
+ // @ts-ignore
+ return new DateOriginal(...args);
+ }
}
static now() {
return mockedDate.getTime();
}
+ static parse(string: string) {
+ return DateOriginal.parse(string);
+ }
};
function getMockData(overwrites: Record = {}): CreateOptions['data'] {
@@ -2295,6 +2318,219 @@ describe('getAlertState()', () => {
});
});
+const AlertStatusFindEventsResult: QueryEventsBySavedObjectResult = {
+ page: 1,
+ per_page: 10000,
+ total: 0,
+ data: [],
+};
+
+const AlertStatusIntervalSeconds = 1;
+
+const BaseAlertStatusSavedObject: SavedObject = {
+ id: '1',
+ type: 'alert',
+ attributes: {
+ enabled: true,
+ name: 'alert-name',
+ tags: ['tag-1', 'tag-2'],
+ alertTypeId: '123',
+ consumer: 'alert-consumer',
+ schedule: { interval: `${AlertStatusIntervalSeconds}s` },
+ actions: [],
+ params: {},
+ createdBy: null,
+ updatedBy: null,
+ createdAt: mockedDateString,
+ apiKey: null,
+ apiKeyOwner: null,
+ throttle: null,
+ muteAll: false,
+ mutedInstanceIds: [],
+ },
+ references: [],
+};
+
+function getAlertStatusSavedObject(attributes: Partial = {}): SavedObject {
+ return {
+ ...BaseAlertStatusSavedObject,
+ attributes: { ...BaseAlertStatusSavedObject.attributes, ...attributes },
+ };
+}
+
+describe('getAlertStatus()', () => {
+ let alertsClient: AlertsClient;
+
+ beforeEach(() => {
+ alertsClient = new AlertsClient(alertsClientParams);
+ });
+
+ test('runs as expected with some event log data', async () => {
+ const alertSO = getAlertStatusSavedObject({ mutedInstanceIds: ['instance-muted-no-activity'] });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce(alertSO);
+
+ const eventsFactory = new EventsFactory(mockedDateString);
+ const events = eventsFactory
+ .addExecute()
+ .addNewInstance('instance-currently-active')
+ .addNewInstance('instance-previously-active')
+ .addActiveInstance('instance-currently-active')
+ .addActiveInstance('instance-previously-active')
+ .advanceTime(10000)
+ .addExecute()
+ .addResolvedInstance('instance-previously-active')
+ .addActiveInstance('instance-currently-active')
+ .getEvents();
+ const eventsResult = {
+ ...AlertStatusFindEventsResult,
+ total: events.length,
+ data: events,
+ };
+ eventLogClient.findEventsBySavedObject.mockResolvedValueOnce(eventsResult);
+
+ const dateStart = new Date(Date.now() - 60 * 1000).toISOString();
+
+ const result = await alertsClient.getAlertStatus({ id: '1', dateStart });
+ expect(result).toMatchInlineSnapshot(`
+ Object {
+ "alertTypeId": "123",
+ "consumer": "alert-consumer",
+ "enabled": true,
+ "errorMessages": Array [],
+ "id": "1",
+ "instances": Object {
+ "instance-currently-active": Object {
+ "activeStartDate": "2019-02-12T21:01:22.479Z",
+ "muted": false,
+ "status": "Active",
+ },
+ "instance-muted-no-activity": Object {
+ "activeStartDate": undefined,
+ "muted": true,
+ "status": "OK",
+ },
+ "instance-previously-active": Object {
+ "activeStartDate": undefined,
+ "muted": false,
+ "status": "OK",
+ },
+ },
+ "lastRun": "2019-02-12T21:01:32.479Z",
+ "muteAll": false,
+ "name": "alert-name",
+ "status": "Active",
+ "statusEndDate": "2019-02-12T21:01:22.479Z",
+ "statusStartDate": "2019-02-12T21:00:22.479Z",
+ "tags": Array [
+ "tag-1",
+ "tag-2",
+ ],
+ "throttle": null,
+ }
+ `);
+ });
+
+ // Further tests don't check the result of `getAlertStatus()`, as the result
+ // is just the result from the `alertStatusFromEventLog()`, which itself
+ // has a complete set of tests. These tests just make sure the data gets
+ // sent into `getAlertStatus()` as appropriate.
+
+ test('calls saved objects and event log client with default params', async () => {
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getAlertStatusSavedObject());
+ eventLogClient.findEventsBySavedObject.mockResolvedValueOnce(AlertStatusFindEventsResult);
+
+ await alertsClient.getAlertStatus({ id: '1' });
+
+ expect(unsecuredSavedObjectsClient.get).toHaveBeenCalledTimes(1);
+ expect(eventLogClient.findEventsBySavedObject).toHaveBeenCalledTimes(1);
+ expect(eventLogClient.findEventsBySavedObject.mock.calls[0]).toMatchInlineSnapshot(`
+ Array [
+ "alert",
+ "1",
+ Object {
+ "end": "2019-02-12T21:01:22.479Z",
+ "page": 1,
+ "per_page": 10000,
+ "sort_order": "desc",
+ "start": "2019-02-12T21:00:22.479Z",
+ },
+ ]
+ `);
+ // calculate the expected start/end date for one test
+ const { start, end } = eventLogClient.findEventsBySavedObject.mock.calls[0][2]!;
+ expect(end).toBe(mockedDateString);
+
+ const startMillis = Date.parse(start!);
+ const endMillis = Date.parse(end!);
+ const expectedDuration = 60 * AlertStatusIntervalSeconds * 1000;
+ expect(endMillis - startMillis).toBeGreaterThan(expectedDuration - 2);
+ expect(endMillis - startMillis).toBeLessThan(expectedDuration + 2);
+ });
+
+ test('calls event log client with start date', async () => {
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getAlertStatusSavedObject());
+ eventLogClient.findEventsBySavedObject.mockResolvedValueOnce(AlertStatusFindEventsResult);
+
+ const dateStart = new Date(Date.now() - 60 * AlertStatusIntervalSeconds * 1000).toISOString();
+ await alertsClient.getAlertStatus({ id: '1', dateStart });
+
+ expect(unsecuredSavedObjectsClient.get).toHaveBeenCalledTimes(1);
+ expect(eventLogClient.findEventsBySavedObject).toHaveBeenCalledTimes(1);
+ const { start, end } = eventLogClient.findEventsBySavedObject.mock.calls[0][2]!;
+
+ expect({ start, end }).toMatchInlineSnapshot(`
+ Object {
+ "end": "2019-02-12T21:01:22.479Z",
+ "start": "2019-02-12T21:00:22.479Z",
+ }
+ `);
+ });
+
+ test('calls event log client with relative start date', async () => {
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getAlertStatusSavedObject());
+ eventLogClient.findEventsBySavedObject.mockResolvedValueOnce(AlertStatusFindEventsResult);
+
+ const dateStart = '2m';
+ await alertsClient.getAlertStatus({ id: '1', dateStart });
+
+ expect(unsecuredSavedObjectsClient.get).toHaveBeenCalledTimes(1);
+ expect(eventLogClient.findEventsBySavedObject).toHaveBeenCalledTimes(1);
+ const { start, end } = eventLogClient.findEventsBySavedObject.mock.calls[0][2]!;
+
+ expect({ start, end }).toMatchInlineSnapshot(`
+ Object {
+ "end": "2019-02-12T21:01:22.479Z",
+ "start": "2019-02-12T20:59:22.479Z",
+ }
+ `);
+ });
+
+ test('invalid start date throws an error', async () => {
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getAlertStatusSavedObject());
+ eventLogClient.findEventsBySavedObject.mockResolvedValueOnce(AlertStatusFindEventsResult);
+
+ const dateStart = 'ain"t no way this will get parsed as a date';
+ expect(alertsClient.getAlertStatus({ id: '1', dateStart })).rejects.toMatchInlineSnapshot(
+ `[Error: Invalid date for parameter dateStart: "ain"t no way this will get parsed as a date"]`
+ );
+ });
+
+ test('saved object get throws an error', async () => {
+ unsecuredSavedObjectsClient.get.mockRejectedValueOnce(new Error('OMG!'));
+ eventLogClient.findEventsBySavedObject.mockResolvedValueOnce(AlertStatusFindEventsResult);
+
+ expect(alertsClient.getAlertStatus({ id: '1' })).rejects.toMatchInlineSnapshot(`[Error: OMG!]`);
+ });
+
+ test('findEvents throws an error', async () => {
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getAlertStatusSavedObject());
+ eventLogClient.findEventsBySavedObject.mockRejectedValueOnce(new Error('OMG 2!'));
+
+ // error eaten but logged
+ await alertsClient.getAlertStatus({ id: '1' });
+ });
+});
+
describe('find()', () => {
const listedTypes = new Set([
{
diff --git a/x-pack/plugins/alerts/server/alerts_client.ts b/x-pack/plugins/alerts/server/alerts_client.ts
index dd66ccc7a0256..80e021fc5cb6e 100644
--- a/x-pack/plugins/alerts/server/alerts_client.ts
+++ b/x-pack/plugins/alerts/server/alerts_client.ts
@@ -24,6 +24,7 @@ import {
IntervalSchedule,
SanitizedAlert,
AlertTaskState,
+ AlertStatus,
} from './types';
import { validateAlertTypeParams } from './lib';
import {
@@ -41,6 +42,11 @@ import {
WriteOperations,
ReadOperations,
} from './authorization/alerts_authorization';
+import { IEventLogClient } from '../../../plugins/event_log/server';
+import { parseIsoOrRelativeDate } from './lib/iso_or_relative_date';
+import { alertStatusFromEventLog } from './lib/alert_status_from_event_log';
+import { IEvent } from '../../event_log/server';
+import { parseDuration } from '../common/parse_duration';
export interface RegistryAlertTypeWithAuth extends RegistryAlertType {
authorizedConsumers: string[];
@@ -67,6 +73,7 @@ export interface ConstructorOptions {
createAPIKey: (name: string) => Promise;
invalidateAPIKey: (params: InvalidateAPIKeyParams) => Promise;
getActionsClient: () => Promise;
+ getEventLogClient: () => Promise;
}
export interface MuteOptions extends IndexType {
@@ -132,6 +139,11 @@ interface UpdateOptions {
};
}
+interface GetAlertStatusParams {
+ id: string;
+ dateStart?: string;
+}
+
export class AlertsClient {
private readonly logger: Logger;
private readonly getUserName: () => Promise;
@@ -147,6 +159,7 @@ export class AlertsClient {
) => Promise;
private readonly getActionsClient: () => Promise;
private readonly actionsAuthorization: ActionsAuthorization;
+ private readonly getEventLogClient: () => Promise;
encryptedSavedObjectsClient: EncryptedSavedObjectsClient;
constructor({
@@ -163,6 +176,7 @@ export class AlertsClient {
encryptedSavedObjectsClient,
getActionsClient,
actionsAuthorization,
+ getEventLogClient,
}: ConstructorOptions) {
this.logger = logger;
this.getUserName = getUserName;
@@ -177,6 +191,7 @@ export class AlertsClient {
this.encryptedSavedObjectsClient = encryptedSavedObjectsClient;
this.getActionsClient = getActionsClient;
this.actionsAuthorization = actionsAuthorization;
+ this.getEventLogClient = getEventLogClient;
}
public async create({ data, options }: CreateOptions): Promise {
@@ -269,6 +284,49 @@ export class AlertsClient {
}
}
+ public async getAlertStatus({ id, dateStart }: GetAlertStatusParams): Promise {
+ this.logger.debug(`getAlertStatus(): getting alert ${id}`);
+ const alert = await this.get({ id });
+ await this.authorization.ensureAuthorized(
+ alert.alertTypeId,
+ alert.consumer,
+ ReadOperations.GetAlertStatus
+ );
+
+ // default duration of status is 60 * alert interval
+ const dateNow = new Date();
+ const durationMillis = parseDuration(alert.schedule.interval) * 60;
+ const defaultDateStart = new Date(dateNow.valueOf() - durationMillis);
+ const parsedDateStart = parseDate(dateStart, 'dateStart', defaultDateStart);
+
+ const eventLogClient = await this.getEventLogClient();
+
+ this.logger.debug(`getAlertStatus(): search the event log for alert ${id}`);
+ let events: IEvent[];
+ try {
+ const queryResults = await eventLogClient.findEventsBySavedObject('alert', id, {
+ page: 1,
+ per_page: 10000,
+ start: parsedDateStart.toISOString(),
+ end: dateNow.toISOString(),
+ sort_order: 'desc',
+ });
+ events = queryResults.data;
+ } catch (err) {
+ this.logger.debug(
+ `alertsClient.getAlertStatus(): error searching event log for alert ${id}: ${err.message}`
+ );
+ events = [];
+ }
+
+ return alertStatusFromEventLog({
+ alert,
+ events,
+ dateStart: parsedDateStart.toISOString(),
+ dateEnd: dateNow.toISOString(),
+ });
+ }
+
public async find({
options: { fields, ...options } = {},
}: { options?: FindOptions } = {}): Promise {
@@ -283,7 +341,6 @@ export class AlertsClient {
? `${options.filter} and ${authorizationFilter}`
: authorizationFilter;
}
-
const {
page,
per_page: perPage,
@@ -886,3 +943,24 @@ export class AlertsClient {
return truncate(`Alerting: ${alertTypeId}/${alertName}`, { length: 256 });
}
}
+
+function parseDate(dateString: string | undefined, propertyName: string, defaultValue: Date): Date {
+ if (dateString === undefined) {
+ return defaultValue;
+ }
+
+ const parsedDate = parseIsoOrRelativeDate(dateString);
+ if (parsedDate === undefined) {
+ throw Boom.badRequest(
+ i18n.translate('xpack.alerts.alertsClient.getAlertStatus.invalidDate', {
+ defaultMessage: 'Invalid date for parameter {field}: "{dateValue}"',
+ values: {
+ field: propertyName,
+ dateValue: dateString,
+ },
+ })
+ );
+ }
+
+ return parsedDate;
+}
diff --git a/x-pack/plugins/alerts/server/alerts_client_factory.test.ts b/x-pack/plugins/alerts/server/alerts_client_factory.test.ts
index 16b5af499bb90..a5eb371633f1e 100644
--- a/x-pack/plugins/alerts/server/alerts_client_factory.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client_factory.test.ts
@@ -22,6 +22,7 @@ import { actionsMock, actionsAuthorizationMock } from '../../actions/server/mock
import { featuresPluginMock } from '../../features/server/mocks';
import { AuditLogger } from '../../security/server';
import { ALERTS_FEATURE_ID } from '../common';
+import { eventLogMock } from '../../event_log/server/mocks';
jest.mock('./alerts_client');
jest.mock('./authorization/alerts_authorization');
@@ -42,6 +43,7 @@ const alertsClientFactoryParams: jest.Mocked = {
encryptedSavedObjectsClient: encryptedSavedObjectsMock.createClient(),
actions: actionsMock.createStart(),
features,
+ eventLog: eventLogMock.createStart(),
};
const fakeRequest = ({
headers: {},
@@ -119,6 +121,7 @@ test('creates an alerts client with proper constructor arguments when security i
namespace: 'default',
getUserName: expect.any(Function),
getActionsClient: expect.any(Function),
+ getEventLogClient: expect.any(Function),
createAPIKey: expect.any(Function),
invalidateAPIKey: expect.any(Function),
encryptedSavedObjectsClient: alertsClientFactoryParams.encryptedSavedObjectsClient,
@@ -164,6 +167,7 @@ test('creates an alerts client with proper constructor arguments', async () => {
invalidateAPIKey: expect.any(Function),
encryptedSavedObjectsClient: alertsClientFactoryParams.encryptedSavedObjectsClient,
getActionsClient: expect.any(Function),
+ getEventLogClient: expect.any(Function),
});
});
diff --git a/x-pack/plugins/alerts/server/alerts_client_factory.ts b/x-pack/plugins/alerts/server/alerts_client_factory.ts
index 79b0ccaf1f0bc..83202424c9773 100644
--- a/x-pack/plugins/alerts/server/alerts_client_factory.ts
+++ b/x-pack/plugins/alerts/server/alerts_client_factory.ts
@@ -16,6 +16,7 @@ import { PluginStartContract as FeaturesPluginStart } from '../../features/serve
import { AlertsAuthorization } from './authorization/alerts_authorization';
import { AlertsAuthorizationAuditLogger } from './authorization/audit_logger';
import { Space } from '../../spaces/server';
+import { IEventLogClientService } from '../../../plugins/event_log/server';
export interface AlertsClientFactoryOpts {
logger: Logger;
@@ -28,6 +29,7 @@ export interface AlertsClientFactoryOpts {
encryptedSavedObjectsClient: EncryptedSavedObjectsClient;
actions: ActionsPluginStartContract;
features: FeaturesPluginStart;
+ eventLog: IEventLogClientService;
}
export class AlertsClientFactory {
@@ -42,6 +44,7 @@ export class AlertsClientFactory {
private encryptedSavedObjectsClient!: EncryptedSavedObjectsClient;
private actions!: ActionsPluginStartContract;
private features!: FeaturesPluginStart;
+ private eventLog!: IEventLogClientService;
public initialize(options: AlertsClientFactoryOpts) {
if (this.isInitialized) {
@@ -58,10 +61,11 @@ export class AlertsClientFactory {
this.encryptedSavedObjectsClient = options.encryptedSavedObjectsClient;
this.actions = options.actions;
this.features = options.features;
+ this.eventLog = options.eventLog;
}
public create(request: KibanaRequest, savedObjects: SavedObjectsServiceStart): AlertsClient {
- const { securityPluginSetup, actions, features } = this;
+ const { securityPluginSetup, actions, eventLog, features } = this;
const spaceId = this.getSpaceId(request);
const authorization = new AlertsAuthorization({
authorization: securityPluginSetup?.authz,
@@ -135,6 +139,9 @@ export class AlertsClientFactory {
async getActionsClient() {
return actions.getActionsClientWithRequest(request);
},
+ async getEventLogClient() {
+ return eventLog.getClient(request);
+ },
});
}
}
diff --git a/x-pack/plugins/alerts/server/authorization/alerts_authorization.ts b/x-pack/plugins/alerts/server/authorization/alerts_authorization.ts
index 33a9a0bf0396e..b2a214eae9316 100644
--- a/x-pack/plugins/alerts/server/authorization/alerts_authorization.ts
+++ b/x-pack/plugins/alerts/server/authorization/alerts_authorization.ts
@@ -18,6 +18,7 @@ import { Space } from '../../../spaces/server';
export enum ReadOperations {
Get = 'get',
GetAlertState = 'getAlertState',
+ GetAlertStatus = 'getAlertStatus',
Find = 'find',
}
diff --git a/x-pack/plugins/alerts/server/index.ts b/x-pack/plugins/alerts/server/index.ts
index 515de771e7d6b..4c192a896c0c3 100644
--- a/x-pack/plugins/alerts/server/index.ts
+++ b/x-pack/plugins/alerts/server/index.ts
@@ -17,8 +17,11 @@ export {
AlertExecutorOptions,
AlertActionParams,
AlertServices,
- State,
+ AlertTypeState,
+ AlertTypeParams,
PartialAlert,
+ AlertInstanceState,
+ AlertInstanceContext,
} from './types';
export { PluginSetupContract, PluginStartContract } from './plugin';
export { FindResult } from './alerts_client';
diff --git a/x-pack/plugins/alerts/server/lib/alert_status_from_event_log.test.ts b/x-pack/plugins/alerts/server/lib/alert_status_from_event_log.test.ts
new file mode 100644
index 0000000000000..15570d3032f24
--- /dev/null
+++ b/x-pack/plugins/alerts/server/lib/alert_status_from_event_log.test.ts
@@ -0,0 +1,464 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { SanitizedAlert, AlertStatus } from '../types';
+import { IValidatedEvent } from '../../../event_log/server';
+import { EVENT_LOG_ACTIONS, EVENT_LOG_PROVIDER } from '../plugin';
+import { alertStatusFromEventLog } from './alert_status_from_event_log';
+
+const ONE_HOUR_IN_MILLIS = 60 * 60 * 1000;
+const dateStart = '2020-06-18T00:00:00.000Z';
+const dateEnd = dateString(dateStart, ONE_HOUR_IN_MILLIS);
+
+describe('alertStatusFromEventLog', () => {
+ test('no events and muted ids', async () => {
+ const alert = createAlert({});
+ const events: IValidatedEvent[] = [];
+ const status: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ expect(status).toMatchInlineSnapshot(`
+ Object {
+ "alertTypeId": "123",
+ "consumer": "alert-consumer",
+ "enabled": false,
+ "errorMessages": Array [],
+ "id": "alert-123",
+ "instances": Object {},
+ "lastRun": undefined,
+ "muteAll": false,
+ "name": "alert-name",
+ "status": "OK",
+ "statusEndDate": "2020-06-18T01:00:00.000Z",
+ "statusStartDate": "2020-06-18T00:00:00.000Z",
+ "tags": Array [],
+ "throttle": null,
+ }
+ `);
+ });
+
+ test('different alert properties', async () => {
+ const alert = createAlert({
+ id: 'alert-456',
+ alertTypeId: '456',
+ schedule: { interval: '100s' },
+ enabled: true,
+ name: 'alert-name-2',
+ tags: ['tag-1', 'tag-2'],
+ consumer: 'alert-consumer-2',
+ throttle: '1h',
+ muteAll: true,
+ });
+ const events: IValidatedEvent[] = [];
+ const status: AlertStatus = alertStatusFromEventLog({
+ alert,
+ events,
+ dateStart: dateString(dateEnd, ONE_HOUR_IN_MILLIS),
+ dateEnd: dateString(dateEnd, ONE_HOUR_IN_MILLIS * 2),
+ });
+
+ expect(status).toMatchInlineSnapshot(`
+ Object {
+ "alertTypeId": "456",
+ "consumer": "alert-consumer-2",
+ "enabled": true,
+ "errorMessages": Array [],
+ "id": "alert-456",
+ "instances": Object {},
+ "lastRun": undefined,
+ "muteAll": true,
+ "name": "alert-name-2",
+ "status": "OK",
+ "statusEndDate": "2020-06-18T03:00:00.000Z",
+ "statusStartDate": "2020-06-18T02:00:00.000Z",
+ "tags": Array [
+ "tag-1",
+ "tag-2",
+ ],
+ "throttle": "1h",
+ }
+ `);
+ });
+
+ test('two muted instances', async () => {
+ const alert = createAlert({
+ mutedInstanceIds: ['instance-1', 'instance-2'],
+ });
+ const events: IValidatedEvent[] = [];
+ const alertStatus: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ const { lastRun, status, instances } = alertStatus;
+ expect({ lastRun, status, instances }).toMatchInlineSnapshot(`
+ Object {
+ "instances": Object {
+ "instance-1": Object {
+ "activeStartDate": undefined,
+ "muted": true,
+ "status": "OK",
+ },
+ "instance-2": Object {
+ "activeStartDate": undefined,
+ "muted": true,
+ "status": "OK",
+ },
+ },
+ "lastRun": undefined,
+ "status": "OK",
+ }
+ `);
+ });
+
+ test('active alert but no instances', async () => {
+ const alert = createAlert({});
+ const eventsFactory = new EventsFactory();
+ const events = eventsFactory.addExecute().advanceTime(10000).addExecute().getEvents();
+
+ const alertStatus: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ const { lastRun, status, instances } = alertStatus;
+ expect({ lastRun, status, instances }).toMatchInlineSnapshot(`
+ Object {
+ "instances": Object {},
+ "lastRun": "2020-06-18T00:00:10.000Z",
+ "status": "OK",
+ }
+ `);
+ });
+
+ test('active alert with no instances but has errors', async () => {
+ const alert = createAlert({});
+ const eventsFactory = new EventsFactory();
+ const events = eventsFactory
+ .addExecute('oof!')
+ .advanceTime(10000)
+ .addExecute('rut roh!')
+ .getEvents();
+
+ const alertStatus: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ const { lastRun, status, errorMessages, instances } = alertStatus;
+ expect({ lastRun, status, errorMessages, instances }).toMatchInlineSnapshot(`
+ Object {
+ "errorMessages": Array [
+ Object {
+ "date": "2020-06-18T00:00:00.000Z",
+ "message": "oof!",
+ },
+ Object {
+ "date": "2020-06-18T00:00:10.000Z",
+ "message": "rut roh!",
+ },
+ ],
+ "instances": Object {},
+ "lastRun": "2020-06-18T00:00:10.000Z",
+ "status": "Error",
+ }
+ `);
+ });
+
+ test('alert with currently inactive instance', async () => {
+ const alert = createAlert({});
+ const eventsFactory = new EventsFactory();
+ const events = eventsFactory
+ .addExecute()
+ .addNewInstance('instance-1')
+ .addActiveInstance('instance-1')
+ .advanceTime(10000)
+ .addExecute()
+ .addResolvedInstance('instance-1')
+ .getEvents();
+
+ const alertStatus: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ const { lastRun, status, instances } = alertStatus;
+ expect({ lastRun, status, instances }).toMatchInlineSnapshot(`
+ Object {
+ "instances": Object {
+ "instance-1": Object {
+ "activeStartDate": undefined,
+ "muted": false,
+ "status": "OK",
+ },
+ },
+ "lastRun": "2020-06-18T00:00:10.000Z",
+ "status": "OK",
+ }
+ `);
+ });
+
+ test('alert with currently inactive instance, no new-instance', async () => {
+ const alert = createAlert({});
+ const eventsFactory = new EventsFactory();
+ const events = eventsFactory
+ .addExecute()
+ .addActiveInstance('instance-1')
+ .advanceTime(10000)
+ .addExecute()
+ .addResolvedInstance('instance-1')
+ .getEvents();
+
+ const alertStatus: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ const { lastRun, status, instances } = alertStatus;
+ expect({ lastRun, status, instances }).toMatchInlineSnapshot(`
+ Object {
+ "instances": Object {
+ "instance-1": Object {
+ "activeStartDate": undefined,
+ "muted": false,
+ "status": "OK",
+ },
+ },
+ "lastRun": "2020-06-18T00:00:10.000Z",
+ "status": "OK",
+ }
+ `);
+ });
+
+ test('alert with currently active instance', async () => {
+ const alert = createAlert({});
+ const eventsFactory = new EventsFactory();
+ const events = eventsFactory
+ .addExecute()
+ .addNewInstance('instance-1')
+ .addActiveInstance('instance-1')
+ .advanceTime(10000)
+ .addExecute()
+ .addActiveInstance('instance-1')
+ .getEvents();
+
+ const alertStatus: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ const { lastRun, status, instances } = alertStatus;
+ expect({ lastRun, status, instances }).toMatchInlineSnapshot(`
+ Object {
+ "instances": Object {
+ "instance-1": Object {
+ "activeStartDate": "2020-06-18T00:00:00.000Z",
+ "muted": false,
+ "status": "Active",
+ },
+ },
+ "lastRun": "2020-06-18T00:00:10.000Z",
+ "status": "Active",
+ }
+ `);
+ });
+
+ test('alert with currently active instance, no new-instance', async () => {
+ const alert = createAlert({});
+ const eventsFactory = new EventsFactory();
+ const events = eventsFactory
+ .addExecute()
+ .addActiveInstance('instance-1')
+ .advanceTime(10000)
+ .addExecute()
+ .addActiveInstance('instance-1')
+ .getEvents();
+
+ const alertStatus: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ const { lastRun, status, instances } = alertStatus;
+ expect({ lastRun, status, instances }).toMatchInlineSnapshot(`
+ Object {
+ "instances": Object {
+ "instance-1": Object {
+ "activeStartDate": undefined,
+ "muted": false,
+ "status": "Active",
+ },
+ },
+ "lastRun": "2020-06-18T00:00:10.000Z",
+ "status": "Active",
+ }
+ `);
+ });
+
+ test('alert with active and inactive muted alerts', async () => {
+ const alert = createAlert({ mutedInstanceIds: ['instance-1', 'instance-2'] });
+ const eventsFactory = new EventsFactory();
+ const events = eventsFactory
+ .addExecute()
+ .addNewInstance('instance-1')
+ .addActiveInstance('instance-1')
+ .addNewInstance('instance-2')
+ .addActiveInstance('instance-2')
+ .advanceTime(10000)
+ .addExecute()
+ .addActiveInstance('instance-1')
+ .addResolvedInstance('instance-2')
+ .getEvents();
+
+ const alertStatus: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ const { lastRun, status, instances } = alertStatus;
+ expect({ lastRun, status, instances }).toMatchInlineSnapshot(`
+ Object {
+ "instances": Object {
+ "instance-1": Object {
+ "activeStartDate": "2020-06-18T00:00:00.000Z",
+ "muted": true,
+ "status": "Active",
+ },
+ "instance-2": Object {
+ "activeStartDate": undefined,
+ "muted": true,
+ "status": "OK",
+ },
+ },
+ "lastRun": "2020-06-18T00:00:10.000Z",
+ "status": "Active",
+ }
+ `);
+ });
+
+ test('alert with active and inactive alerts over many executes', async () => {
+ const alert = createAlert({});
+ const eventsFactory = new EventsFactory();
+ const events = eventsFactory
+ .addExecute()
+ .addNewInstance('instance-1')
+ .addActiveInstance('instance-1')
+ .addNewInstance('instance-2')
+ .addActiveInstance('instance-2')
+ .advanceTime(10000)
+ .addExecute()
+ .addActiveInstance('instance-1')
+ .addResolvedInstance('instance-2')
+ .advanceTime(10000)
+ .addExecute()
+ .addActiveInstance('instance-1')
+ .advanceTime(10000)
+ .addExecute()
+ .addActiveInstance('instance-1')
+ .getEvents();
+
+ const alertStatus: AlertStatus = alertStatusFromEventLog({ alert, events, dateStart, dateEnd });
+
+ const { lastRun, status, instances } = alertStatus;
+ expect({ lastRun, status, instances }).toMatchInlineSnapshot(`
+ Object {
+ "instances": Object {
+ "instance-1": Object {
+ "activeStartDate": "2020-06-18T00:00:00.000Z",
+ "muted": false,
+ "status": "Active",
+ },
+ "instance-2": Object {
+ "activeStartDate": undefined,
+ "muted": false,
+ "status": "OK",
+ },
+ },
+ "lastRun": "2020-06-18T00:00:30.000Z",
+ "status": "Active",
+ }
+ `);
+ });
+});
+
+function dateString(isoBaseDate: string, offsetMillis = 0): string {
+ return new Date(Date.parse(isoBaseDate) + offsetMillis).toISOString();
+}
+
+export class EventsFactory {
+ private events: IValidatedEvent[] = [];
+
+ constructor(private date: string = dateStart) {}
+
+ getEvents(): IValidatedEvent[] {
+ // ES normally returns events sorted newest to oldest, so we need to sort
+ // that way also
+ const events = this.events.slice();
+ events.sort((a, b) => -a!['@timestamp']!.localeCompare(b!['@timestamp']!));
+ return events;
+ }
+
+ getTime(): string {
+ return this.date;
+ }
+
+ advanceTime(millis: number): EventsFactory {
+ this.date = dateString(this.date, millis);
+ return this;
+ }
+
+ addExecute(errorMessage?: string): EventsFactory {
+ let event: IValidatedEvent = {
+ '@timestamp': this.date,
+ event: {
+ provider: EVENT_LOG_PROVIDER,
+ action: EVENT_LOG_ACTIONS.execute,
+ },
+ };
+
+ if (errorMessage) {
+ event = { ...event, error: { message: errorMessage } };
+ }
+
+ this.events.push(event);
+ return this;
+ }
+
+ addActiveInstance(instanceId: string): EventsFactory {
+ this.events.push({
+ '@timestamp': this.date,
+ event: {
+ provider: EVENT_LOG_PROVIDER,
+ action: EVENT_LOG_ACTIONS.activeInstance,
+ },
+ kibana: { alerting: { instance_id: instanceId } },
+ });
+ return this;
+ }
+
+ addNewInstance(instanceId: string): EventsFactory {
+ this.events.push({
+ '@timestamp': this.date,
+ event: {
+ provider: EVENT_LOG_PROVIDER,
+ action: EVENT_LOG_ACTIONS.newInstance,
+ },
+ kibana: { alerting: { instance_id: instanceId } },
+ });
+ return this;
+ }
+
+ addResolvedInstance(instanceId: string): EventsFactory {
+ this.events.push({
+ '@timestamp': this.date,
+ event: {
+ provider: EVENT_LOG_PROVIDER,
+ action: EVENT_LOG_ACTIONS.resolvedInstance,
+ },
+ kibana: { alerting: { instance_id: instanceId } },
+ });
+ return this;
+ }
+}
+
+function createAlert(overrides: Partial