[Response Ops][Connectors] New `xpack.actions.email.services.enabled` Kibana setting by jcger · Pull Request #223363 · elastic/kibana

jcger · 2025-06-11T08:12:26Z

Summary

Closes #220288

Release note

New kibana setting xpack.actions.email.services.enabled to enable/disable email services for email connector.

elasticmachine · 2025-06-16T10:52:53Z

Pinging @elastic/response-ops (Team:ResponseOps)

...atform/plugins/shared/stack_connectors/public/connector_types/email/email_connector.test.tsx

adcoelho · 2025-06-16T12:34:46Z

...ck/platform/plugins/shared/stack_connectors/public/connector_types/email/email_connector.tsx

  const disableServiceConfig = shouldDisableEmailConfiguration(service);
  const { isLoading, getEmailServiceConfig } = useEmailConfig({ http, toasts });

+  useMount(() => {


This is after rendering, right? Shouldn't we fetch before rendering to prevent the UI from flashing?

I'm not sure what you mean by "before rendering". I can only think of blocking the whole form or doing it server side. Server side isn't an option as we don't render server side, and blocking the whole form because of this seems like too much.

For more context: before my changes, we had a list of possible options, by default, it's set to empty. Once the user chooses an option, we fetch the linked data (host, port, and whether it's secure or not). But now, there is a chance that only one option is enabled and it would render as select with just one option. My changes are to set that only available service and it's linked data. useMount is just a useEffect with no dependencies in the dependency array. This way, it will only fetch once when the component is mounted in the DOM and yes, there will be a slight delay while loading the data linked to the enabled service.

adcoelho · 2025-06-16T12:37:02Z

x-pack/platform/plugins/shared/stack_connectors/server/connector_types/email/index.test.ts

    }).not.toThrowError();
  });
+
+  test('error when using a service that is not enabled', async () => {


This part is key, so I would extend these tests to also include does not throw when config is [*] and does not throw when fetching service enabled in config

done in adae589#diff-e9c89639c6fbd5b8b156ff2ff9ed729cd4f778514081654e39c86e7c4a1cdacdR535

adcoelho · 2025-06-16T12:41:21Z

x-pack/platform/plugins/shared/actions/server/config.ts

        domain_allowlist: schema.maybe(schema.arrayOf(schema.string())),
        services: schema.maybe(
          schema.object({
+            enabled: schema.maybe(


Here we set enabled: schema.maybe( but then schema.arrayOf has a default value. I think like this, the default value will never come into effect. We should probably pick one of the two.

I did change/simplify this schema. The comment shouldn't apply anymore

x-pack/platform/plugins/shared/actions/server/actions_config.ts

adcoelho · 2025-06-16T12:49:36Z

...ck/platform/plugins/shared/stack_connectors/public/connector_types/email/email_connector.tsx

-                {
-                  validator: emptyField(i18n.SERVICE_REQUIRED),
+          {availableEmailServices.length === 1 ? (
+            <UseField


All tests changed in x-pack/platform/plugins/shared/stack_connectors/public/connector_types/email/email_connector.test.tsx expect the [*] scenario. We should also test when availableEmailServices.length === 1.

Maybe just checking that emailServiceInput exists.

done in adae589#diff-1fb1e3ab4a29af4481ca4bbab7bb6e39f118635a56062fc4a8d946d811382c83R723

…l-services-kbn-cfg

nastasha-solomon

Docs look good - thanks!

cnasikas

Code LTGMT! I tested and I think there is a bug. In the UI I can see all services available even though I have configured the new setting. The backend throws as expected.

cnasikas · 2025-06-17T15:58:32Z

x-pack/platform/plugins/shared/stack_connectors/common/email/constants.ts

+ * 2.0.
+ */
+
+export const serviceParamValueToKbnSettingMap = {


Thanks for that!

...ck/platform/plugins/shared/stack_connectors/public/connector_types/email/email_connector.tsx

cnasikas · 2025-06-17T16:19:41Z

x-pack/platform/plugins/shared/stack_connectors/public/connector_types/email/email.test.tsx

Let's add a basic test for the new functionality (unless it has already been tested elsewhere; I haven't finished the review).

done in 9a957c3

cnasikas

The initial bug I reported seems to not be easily reproducible and probably it is related with how the config is cached. I found another bug. If I have an already configured connector with a service, I change the config to make this service unavailable and I try to save the connector I get an error even though it shows another valid service.

Screen.Recording.2025-06-19.at.12.31.31.PM.mov

cnasikas · 2025-06-19T09:24:33Z

...ck/platform/plugins/shared/stack_connectors/public/connector_types/email/email_connector.tsx

-              validations: [
-                {
-                  validator: emptyField(i18n.SERVICE_REQUIRED),
+          {availableEmailServices.length === 1 ? (


I think it is better if we do not introduce a separate field just for when the available services are. You could disable the selection (disabled: readOnly || isLoading || availableEmailServices.length <= 1,). I tested, and the result is visually the same. Nevertheless, I would say not to disable at all because users may want to change an already configured connector to the new valid service. Otherwise, they would have to delete that one and create a new one, meaning they would have to update all rules to use the new connector.

Thanks, I didn't check that the disabled select doesn't show the "expand" icon on the right. I will show a service that is not enabled, but the current service value of the connector. This means that if the user tries to update, they'll not be able to do so because the service is not enabled, and they'll have to update it.

I should still be disabled if only one service is enabled, even if it only applies to new connectors.

cnasikas · 2025-06-19T09:37:53Z

...ck/platform/plugins/shared/stack_connectors/public/connector_types/email/email_connector.tsx

  const disableServiceConfig = shouldDisableEmailConfiguration(service);
  const { isLoading, getEmailServiceConfig } = useEmailConfig({ http, toasts });

+  useMount(() => {


I am a bit confused why we want this extra API call. Should the useEffect achieve the same? The service is either what the user selected or what the connector is already configured. If the service is not part of the available services, and the connector is configured with such a service, we should probably not set any value or deselect the value. I think it is related to a bug I posted in my second review.

The useEffect is triggered every time the user clicks on the select service component. I added useMount to automatically load the data linked to a service when there is only one service available. For example, if we just have amazon-ses, it will select that service and load the host, port and issecure fields automatically when rendering the form. Related to the bug you found, it shouldn't trigger if it's an already existing connector that has a service selected. Still useful for new connectors when only one service is enabled, though

It wasn't possible, at least not in a simple manner. Instead, the dropdown will have as options the enabled services. On update, it will render the enabled services and the currently stored service. If the user just updates the name, the BE will throw until the service is updated to an enabled option. The downside is that if only one service is enabled, we'll show a dropdown with just one option and the user will have to manually select that only option.

elasticmachine · 2025-06-19T16:03:28Z

💚 Build Succeeded

Buildkite Build
Commit: 355382e

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`stackConnectors`	321	322	+1

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`actions`	335	336	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`stackConnectors`	627.9KB	628.0KB	+94.0B
`triggersActionsUi`	1.5MB	1.5MB	+92.0B
total			+186.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`actions`	16.9KB	17.2KB	+240.0B
`stackConnectors`	60.8KB	61.1KB	+310.0B
`triggersActionsUi`	111.8KB	111.9KB	+52.0B
total			+602.0B

Unknown metric groups

API count

id	before	after	diff
`actions`	341	342	+1

History

💛 Build #310175 was flaky 9a957c3
💛 Build #309342 was flaky 38213f8
💔 Build #309273 failed 9b6ac9f
💔 Build #309032 failed d19105d
💔 Build #308959 failed 420b14b
💔 Build #308778 failed d1a575e

cnasikas

LGTM! I tested and is working as expected. The bugs I mentioned are not reproducible anymore.

kibanamachine · 2025-06-20T14:11:03Z

Starting backport for target branches: 8.19

https://github.com/elastic/kibana/actions/runs/15780864354

kibanamachine · 2025-06-20T14:17:50Z

💔 All backports failed

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts You might need to backport the following PRs to 8.19: - [Discover] Update "isSpan" logic in span waterfall flyout (#224654) - [Discover][Trace waterfall] Update link to relate errors to use QSTR (#224637) - [Streams 🌊] Listing and overview page improvements (#223603) - [Console] Add custom context menu (#217865) - XSOAR Connector (#212049) - [Security Solution][Auto migrations] Implement migration stop/resume UI (#224102) - [ES\|QL] Update grammars (#224562) - Enable FF for gaps by default (#224659) - [ResponseOps][Alerting] Do not return alerts from internally managed rule types (#223453) - [Security Solution] update codeowners @security-threat-hunting-explore to @security-threat-hunting-investigations (#224408)

Manual backport

To create the backport manually run:

node scripts/backport --pr 223363

Questions ?

Please refer to the Backport tool documentation

jcger · 2025-06-20T14:37:33Z

💚 All backports created successfully

Status	Branch	Result
✅	8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

… Kibana setting (elastic#223363) ## Summary Closes elastic#220288 ## Release note New kibana setting `xpack.actions.email.services.enabled` to enable/disable email services for email connector. (cherry picked from commit 411ab21) # Conflicts: # docs/reference/configuration-reference/alerting-settings.md # docs/settings-gen/source/kibana-alert-action-settings.yml

…nabled` Kibana setting (#223363) (#224710) # Backport This will backport the following commits from `main` to `8.19`: - [[Response Ops][Connectors] New `xpack.actions.email.services.enabled` Kibana setting (#223363)](#223363)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

… Kibana setting (elastic#223363) ## Summary Closes elastic#220288 ## Release note New kibana setting `xpack.actions.email.services.enabled` to enable/disable email services for email connector.

Available since 9.1 - 8.19 - #223363 - #221389 - #221389 - #222507

…c#228215) Available since 9.1 - 8.19 - elastic#223363 - elastic#221389 - elastic#221389 - elastic#222507 (cherry picked from commit 39dda35)

…c#228215) Available since 9.1 - 8.19 - elastic#223363 - elastic#221389 - elastic#221389 - elastic#222507

jcger added 4 commits June 13, 2025 11:57

first commit

094493f

remove commented code

be131bf

validate in connector create route

2b49a96

add test

734e470

jcger force-pushed the issue-220288-email-services-kbn-cfg branch from 1ac53e0 to 734e470 Compare June 13, 2025 09:58

fix unique service form value

029dbd3

jcger added Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// release_note:feature Makes this part of the condensed release notes backport:version Backport to applied version labels v9.1.0 v8.19.0 labels Jun 13, 2025

jcger added 2 commits June 13, 2025 18:48

fix types

d712c71

Merge branch 'main' into issue-220288-email-services-kbn-cfg

a607d76

jcger marked this pull request as ready for review June 16, 2025 10:52

jcger requested review from a team as code owners June 16, 2025 10:52

jcger added 2 commits June 16, 2025 12:53

Merge branch 'main' into issue-220288-email-services-kbn-cfg

05b9a2e

fix types

d1a575e

jcger marked this pull request as draft June 16, 2025 12:44

adcoelho reviewed Jun 16, 2025

View reviewed changes

jcger added 6 commits June 16, 2025 17:01

fix config schema

a1ef13c

add functional test & fix actions config

420b14b

Merge branch 'main' of github.com:jcger/kibana into issue-220288-emai…

faaeb57

…l-services-kbn-cfg

missing test + linter issues

d19105d

add tests

adae589

Merge branch 'main' of github.com:jcger/kibana into issue-220288-emai…

9b6ac9f

…l-services-kbn-cfg

jcger marked this pull request as ready for review June 17, 2025 10:45

fix test

38213f8

jbudz approved these changes Jun 17, 2025

View reviewed changes

nastasha-solomon approved these changes Jun 17, 2025

View reviewed changes

cnasikas reviewed Jun 18, 2025

View reviewed changes

elena-shostak approved these changes Jun 18, 2025

View reviewed changes

add tests

9a957c3

cnasikas reviewed Jun 19, 2025

View reviewed changes

jcger added 2 commits June 19, 2025 16:27

simplify

2bf0e69

Merge branch 'main' into issue-220288-email-services-kbn-cfg

355382e

lcawl approved these changes Jun 19, 2025

View reviewed changes

cnasikas approved these changes Jun 20, 2025

View reviewed changes

jcger merged commit 411ab21 into elastic:main Jun 20, 2025
10 checks passed

jcger mentioned this pull request Jun 20, 2025

[8.19] [Response Ops][Connectors] New xpack.actions.email.services.enabled Kibana setting (#223363) #224710

Merged

kibanamachine mentioned this pull request Jun 20, 2025

[Response Ops][Reporting] Scheduled report API license check #224737

Merged

jcger mentioned this pull request Jul 16, 2025

[Response Ops][Docs] Add missing actions settings in ECH docs #228215

Merged

jcger added a commit that referenced this pull request Jul 18, 2025

[Response Ops][Docs] Add missing actions settings in ECH docs (#228215)

39dda35

Available since 9.1 - 8.19 - #223363 - #221389 - #221389 - #222507

Bluefinger pushed a commit to Bluefinger/kibana that referenced this pull request Jul 22, 2025

[Response Ops][Docs] Add missing actions settings in ECH docs (elasti…

8323742

…c#228215) Available since 9.1 - 8.19 - elastic#223363 - elastic#221389 - elastic#221389 - elastic#222507

kertal pushed a commit to kertal/kibana that referenced this pull request Jul 25, 2025

[Response Ops][Docs] Add missing actions settings in ECH docs (elasti…

49e0e69

…c#228215) Available since 9.1 - 8.19 - elastic#223363 - elastic#221389 - elastic#221389 - elastic#222507

florent-leborgne added a commit to florent-leborgne/kibana that referenced this pull request Jul 25, 2025

Missed applies_to in elastic#223363

69e372b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Response Ops][Connectors] New `xpack.actions.email.services.enabled` Kibana setting#223363

[Response Ops][Connectors] New `xpack.actions.email.services.enabled` Kibana setting#223363
jcger merged 19 commits intoelastic:mainfrom
jcger:issue-220288-email-services-kbn-cfg

jcger commented Jun 11, 2025 •

edited by kibanamachine

Loading

elasticmachine commented Jun 16, 2025

Uh oh!

adcoelho Jun 16, 2025

jcger Jun 17, 2025

adcoelho Jun 16, 2025

jcger Jun 17, 2025

adcoelho Jun 16, 2025

jcger Jun 17, 2025

Uh oh!

adcoelho Jun 16, 2025

jcger Jun 17, 2025

nastasha-solomon left a comment

cnasikas left a comment

cnasikas Jun 17, 2025

Uh oh!

cnasikas Jun 17, 2025

jcger Jun 18, 2025

cnasikas left a comment

cnasikas Jun 19, 2025

jcger Jun 19, 2025

cnasikas Jun 19, 2025

jcger Jun 19, 2025

jcger Jun 19, 2025

elasticmachine commented Jun 19, 2025

API count

cnasikas left a comment

Uh oh!

kibanamachine commented Jun 20, 2025

kibanamachine commented Jun 20, 2025

jcger commented Jun 20, 2025

Labels

9 participants

Conversation

jcger commented Jun 11, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Release note

elasticmachine commented Jun 16, 2025

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nastasha-solomon left a comment

Choose a reason for hiding this comment

cnasikas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cnasikas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jun 19, 2025

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

cnasikas left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Jun 20, 2025

kibanamachine commented Jun 20, 2025

💔 All backports failed

Manual backport

Questions ?

jcger commented Jun 20, 2025

💚 All backports created successfully

Questions ?

Labels

9 participants

jcger commented Jun 11, 2025 •

edited by kibanamachine

Loading