[RAM] Add the feature for slack api to have allowed list on channels #159534

XavierM · 2023-06-13T01:53:57Z

Summary

This will enable our user to create a slack api connector with the ability to only allow some channels as an allowed list. Our user will only be able to edit this input if the secrets is enter like the test button work.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

…ed_channels

x-pack/plugins/stack_connectors/public/connector_types/slack_api/translations.ts

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx

…pi/translations.ts Co-authored-by: Lisa Cawley <lcawley@elastic.co>

…pi/slack_connectors.tsx Co-authored-by: Lisa Cawley <lcawley@elastic.co>

…ed_channels

elasticmachine · 2023-06-15T21:42:30Z

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

x-pack/plugins/triggers_actions_ui/public/application/components/simple_connector_form.tsx

x-pack/plugins/stack_connectors/server/routes/get_slack_api_channels.ts

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx

x-pack/plugins/stack_connectors/server/connector_types/slack_api/service.ts

cnasikas · 2023-06-17T08:14:24Z

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx

+  const debounceSetToken = debounce(setAuthToken, INPUT_TIMEOUT);
+  useEffect(() => {
+    if (formData.secrets && formData.secrets.token !== authToken) {
+      debounceSetToken(formData.secrets.token);
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [formData.secrets]);


I don't think you need the useEffect here. You can do:

const authToken = formData.secrets && formData.secrets.token ? formData.secrets.token : '' const debounceSetToken = debounce(setAuthToken, INPUT_TIMEOUT);

I do believe that you need the useEffect, if the user decide to empty the token or not and also the way the form lib is getting initialized

Maybe I miss something but if the user decides to empty the token it will still run the code, right? I don't see any difference between having the useEffect and not having it in this code. Probably I miss something.

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx

cnasikas · 2023-06-17T08:23:57Z

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx


  return (
    <SimpleConnectorForm
      isEdit={isEdit}
      readOnly={readOnly}
      configFormSchema={[]}
      secretsFormSchema={getSecretsFormSchema(docLinks)}
+      configFormSchemaAfterSecrets={configFormSchemaAfterSecrets}


I get the reasoning behind it (given also time constraints) but I think the slack connector should have its own customized component and not use the SimpleConnectorForm. The reason is not the position of the configs after the secrets but mostly that the secrets are connected with these configs. We should disable the channels combo box until the user has filled out the secrets and provided a helpful message why they are disabled and what the user should do to be able to config the allowed channels. In Swimlane (more complex), we use steps where in step 1 you put the URL and the password and in step 2 you configure the rest of the options (I am not proposing this complex UI for the slack connector).

Ok, I just see what you did with configFormSchemaAfterSecrets. You connected them with getConfigFormSchemaAfterSecrets. Makes sense.

cnasikas · 2023-06-17T08:27:03Z

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx

+    id: 'allowedChannels',
+    isRequired: false,
+    label: i18n.ALLOWED_CHANNELS,
+    helpText: (


Maybe we can add a message explaining why the combo box is disabled if the user has not filled out the secrets.

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx

cnasikas · 2023-06-17T08:29:16Z

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx

+  }
+
+  const configFormSchemaAfterSecrets = useMemo(
+    () => getConfigFormSchemaAfterSecrets(channels, isLoading, channels.length === 0),


I think we should disable it formData.secrets.token is undefined.

that will be taking care when the channels is empty

cnasikas · 2023-06-17T08:33:39Z

x-pack/plugins/triggers_actions_ui/public/application/components/simple_connector_form.tsx

@@ -32,35 +39,45 @@ interface SimpleConnectorFormProps {
  readOnly: boolean;
  configFormSchema: ConfigFieldSchema[];
  secretsFormSchema: SecretsFieldSchema[];
+  configFormSchemaAfterSecrets?: ConfigFieldSchema[];


Another solution would be to extend ConfigFieldSchema with a afterSecrets?: boolean attribute and do the partition in the SimpleConnectorFormComponent. This way consumers will not have to create two configurations.

You might need both, I do not know!

x-pack/plugins/triggers_actions_ui/public/application/components/simple_connector_form.tsx

…ed_channels

…a into slack_api_allowed_channels

JiaweiWu

LGTM! Great to see react query being used.

Just have 1 small nitpick regarding naming

JiaweiWu · 2023-06-20T21:08:46Z

x-pack/plugins/stack_connectors/public/connector_types/slack_api/use_fetch_channels.tsx

+import { INTERNAL_BASE_STACK_CONNECTORS_API_PATH } from '../../../common';
+import * as i18n from './translations';
+
+interface UseLoadTagsQueryProps {


nitpick: this should be UseFetchChannelsProps

kibana-ci · 2023-06-21T13:57:05Z

💚 Build Succeeded

Buildkite Build
Commit: b02d002

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`stackConnectors`	203	204	+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`	261	262	+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`	440.0KB	440.7KB	+630.0B

Page load bundle

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

id	before	after	diff
`stackConnectors`	34.7KB	35.2KB	+535.0B
`triggersActionsUi`	86.0KB	86.5KB	+565.0B
total			+1.1KB

Unknown metric groups

API count

id	before	after	diff
`actions`	266	267	+1

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	13	15	+2
`securitySolution`	411	415	+4
`stackConnectors`	90	92	+2
total			+8

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	14	16	+2
`securitySolution`	492	496	+4
`stackConnectors`	94	96	+2
total			+8

History

💔 Build #136791 failed d7862fd
💔 Build #136764 failed 4bc468f
💔 Build #136751 failed 1bc1264
💚 Build #135910 succeeded c02282a
💚 Build #135820 succeeded 14a30ff
💔 Build #135387 failed b4f144e

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

XavierM added 2 commits June 12, 2023 21:50

basic approach

21d5e4d

retrieve

10ec4eb

XavierM added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Rule Management Security Solution Detection Rule Management v8.9.0 labels Jun 13, 2023

XavierM added 2 commits June 13, 2023 15:58

convert get api to post + fix some UX

53c432e

Merge branch 'main' of github.com:elastic/kibana into slack_api_allow…

a20d654

…ed_channels

lcawl reviewed Jun 13, 2023

View reviewed changes

x-pack/plugins/stack_connectors/public/connector_types/slack_api/translations.ts Outdated Show resolved Hide resolved

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx Outdated Show resolved Hide resolved

lcawl added the ui-copy Review of UI copy with docs team is recommended label Jun 13, 2023

XavierM and others added 5 commits June 14, 2023 16:34

Update x-pack/plugins/stack_connectors/public/connector_types/slack_a…

ed5373f

…pi/translations.ts Co-authored-by: Lisa Cawley <lcawley@elastic.co>

Update x-pack/plugins/stack_connectors/public/connector_types/slack_a…

b4f144e

…pi/slack_connectors.tsx Co-authored-by: Lisa Cawley <lcawley@elastic.co>

Merge branch 'main' of github.com:elastic/kibana into slack_api_allow…

178f95a

…ed_channels

add unit tests

50f6a91

Merge branch 'main' of github.com:elastic/kibana into slack_api_allow…

14a30ff

…ed_channels

XavierM marked this pull request as ready for review June 15, 2023 21:42

XavierM requested a review from a team as a code owner June 15, 2023 21:42

XavierM added the release_note:enhancement label Jun 16, 2023

Merge branch 'main' into slack_api_allowed_channels

c02282a

JiaweiWu reviewed Jun 16, 2023

View reviewed changes

x-pack/plugins/stack_connectors/server/connector_types/slack_api/service.ts Show resolved Hide resolved

cnasikas reviewed Jun 17, 2023

View reviewed changes

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx Outdated Show resolved Hide resolved

cnasikas reviewed Jun 17, 2023

View reviewed changes

x-pack/plugins/stack_connectors/public/connector_types/slack_api/slack_connectors.tsx Outdated Show resolved Hide resolved

cnasikas reviewed Jun 17, 2023

View reviewed changes

x-pack/plugins/triggers_actions_ui/public/application/components/simple_connector_form.tsx Outdated Show resolved Hide resolved

Merge branch 'main' of github.com:elastic/kibana into slack_api_allow…

ccfda32

…ed_channels

XavierM added 2 commits June 20, 2023 16:58

Review I

0f29173

Merge branch 'slack_api_allowed_channels' of github.com:XavierM/kiban…

1bc1264

…a into slack_api_allowed_channels

JiaweiWu approved these changes Jun 20, 2023

View reviewed changes

XavierM added 2 commits June 20, 2023 17:20

review + translations

4bc468f

fix tests

d7862fd

XavierM enabled auto-merge (squash) June 21, 2023 01:42

Merge branch 'main' into slack_api_allowed_channels

b02d002

XavierM merged commit 1149fe4 into elastic:main Jun 21, 2023
21 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Jun 21, 2023

XavierM added the v8.10.0 label Jun 21, 2023

This was referenced Jul 10, 2023

[DOCS] Allowed list of channels in Slack API connector #161602

Closed

[DOCS] Add slack connector 8.9 highlight #161668

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RAM] Add the feature for slack api to have allowed list on channels #159534

[RAM] Add the feature for slack api to have allowed list on channels #159534

XavierM commented Jun 13, 2023 •

edited

elasticmachine commented Jun 15, 2023

cnasikas Jun 17, 2023

XavierM Jun 20, 2023

cnasikas Jun 20, 2023

cnasikas Jun 17, 2023

cnasikas Jun 17, 2023 •

edited

cnasikas Jun 17, 2023

cnasikas Jun 17, 2023

XavierM Jun 20, 2023

cnasikas Jun 17, 2023 •

edited

XavierM Jun 20, 2023

JiaweiWu left a comment

JiaweiWu Jun 20, 2023

kibana-ci commented Jun 21, 2023

API count

ESLint disabled line counts

Total ESLint disabled count

[RAM] Add the feature for slack api to have allowed list on channels #159534

[RAM] Add the feature for slack api to have allowed list on channels #159534

Conversation

XavierM commented Jun 13, 2023 • edited

Summary

Checklist

elasticmachine commented Jun 15, 2023

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

cnasikas Jun 17, 2023 • edited

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

cnasikas Jun 17, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JiaweiWu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Jun 21, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

ESLint disabled line counts

Total ESLint disabled count

History

XavierM commented Jun 13, 2023 •

edited

cnasikas Jun 17, 2023 •

edited

cnasikas Jun 17, 2023 •

edited