[ResponseOps][Slack] Simplify channel configuration #245423
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { TypeRegistry } from '@kbn/triggers-actions-ui-plugin/public/application/type_registry'; | ||
| import type { ActionTypeModel as ConnectorTypeModel } from '@kbn/triggers-actions-ui-plugin/public/types'; | ||
| import { registerConnectorTypes } from '..'; | ||
| import { experimentalFeaturesMock, registrationServicesMock } from '../../mocks'; | ||
| import { CONNECTOR_ID } from '@kbn/connector-schemas/slack_api/constants'; | ||
| import { ExperimentalFeaturesService } from '../../common/experimental_features_service'; | ||
|
|
||
| let connectorTypeModel: ConnectorTypeModel; | ||
|
|
||
| beforeAll(async () => { | ||
| const connectorTypeRegistry = new TypeRegistry<ConnectorTypeModel>(); | ||
| ExperimentalFeaturesService.init({ experimentalFeatures: experimentalFeaturesMock }); | ||
| registerConnectorTypes({ connectorTypeRegistry, services: registrationServicesMock }); | ||
|
|
||
| const getResult = connectorTypeRegistry.get(CONNECTOR_ID); | ||
|
|
||
| if (getResult !== null) { | ||
| connectorTypeModel = getResult; | ||
| } | ||
| }); | ||
|
|
||
| describe('deserializer', () => { | ||
| it('should deserialize the config as expected', () => { | ||
| const data = { | ||
| id: '1', | ||
| name: 'slack api', | ||
| isPreconfigured: false, | ||
| isDeprecated: false, | ||
| isSystemAction: false, | ||
| actionTypeId: CONNECTOR_ID, | ||
| config: { allowedChannels: [{ name: 'general' }, { name: '#random' }] }, | ||
| secrets: {}, | ||
| }; | ||
|
|
||
| const deserializer = connectorTypeModel.connectorForm?.deserializer!; | ||
| const result = deserializer(data); | ||
|
|
||
| expect(result).toEqual({ | ||
| ...data, | ||
| config: { | ||
| ...data.config, | ||
| allowedChannels: ['#general', '#random'], | ||
| }, | ||
| }); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import type { ConnectorFormSchema, InternalConnectorForm } from '@kbn/alerts-ui-shared'; | ||
| import type { SlackApiConfig } from '@kbn/connector-schemas/slack_api'; | ||
|
|
||
| export const deserializer = (data: ConnectorFormSchema): InternalConnectorForm => { | ||
| const allowedChannels = (data.config?.allowedChannels as SlackApiConfig['allowedChannels']) ?? []; | ||
|
|
||
| const formattedChannels = | ||
| allowedChannels.map((channel) => { | ||
| if (channel.name.startsWith('#')) { | ||
| return channel.name; | ||
| } | ||
|
|
||
| return `#${channel.name}`; | ||
|
Contributor
There was a problem hiding this comment. how can this happen? Did we miss a schema validation to check that channel.name starts with # ?
Member
Author
There was a problem hiding this comment. The old code always put names without |
||
| }) ?? []; | ||
|
|
||
| return { | ||
| ...data, | ||
| config: { ...data.config, allowedChannels: formattedChannels }, | ||
| }; | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { TypeRegistry } from '@kbn/triggers-actions-ui-plugin/public/application/type_registry'; | ||
| import type { ActionTypeModel as ConnectorTypeModel } from '@kbn/triggers-actions-ui-plugin/public/types'; | ||
| import { registerConnectorTypes } from '..'; | ||
| import { experimentalFeaturesMock, registrationServicesMock } from '../../mocks'; | ||
| import { CONNECTOR_ID } from '@kbn/connector-schemas/slack_api/constants'; | ||
| import { ExperimentalFeaturesService } from '../../common/experimental_features_service'; | ||
|
|
||
| let connectorTypeModel: ConnectorTypeModel; | ||
|
|
||
| beforeAll(async () => { | ||
| const connectorTypeRegistry = new TypeRegistry<ConnectorTypeModel>(); | ||
| ExperimentalFeaturesService.init({ experimentalFeatures: experimentalFeaturesMock }); | ||
| registerConnectorTypes({ connectorTypeRegistry, services: registrationServicesMock }); | ||
|
|
||
| const getResult = connectorTypeRegistry.get(CONNECTOR_ID); | ||
|
|
||
| if (getResult !== null) { | ||
| connectorTypeModel = getResult; | ||
| } | ||
| }); | ||
|
|
||
| describe('serializer', () => { | ||
| it('should serialize the config as expected', () => { | ||
| const data = { | ||
| id: '1', | ||
| name: 'slack api', | ||
| isPreconfigured: false, | ||
| isDeprecated: false, | ||
| isSystemAction: false, | ||
| actionTypeId: CONNECTOR_ID, | ||
| config: { allowedChannels: ['#general', '#random'] }, | ||
| secrets: {}, | ||
| }; | ||
|
|
||
| const serializer = connectorTypeModel.connectorForm?.serializer!; | ||
|
|
||
| const result = serializer(data); | ||
|
|
||
| expect(result).toEqual({ | ||
| ...data, | ||
| config: { | ||
| ...data.config, | ||
| allowedChannels: [{ name: '#general' }, { name: '#random' }], | ||
| }, | ||
| }); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import type { ConnectorFormSchema, InternalConnectorForm } from '@kbn/alerts-ui-shared'; | ||
|
|
||
| export const serializer = (data: InternalConnectorForm): ConnectorFormSchema => { | ||
| const formAllowedChannels = (data.config?.allowedChannels as string[]) ?? []; | ||
| const allowedChannels = formAllowedChannels.map((option) => ({ name: option })) ?? []; | ||
|
|
||
| return { | ||
| ...data, | ||
| config: { ...data.config, allowedChannels }, | ||
| }; | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The casting is needed because the TS types do not support templates, as they assume the
datais the same for all connectors. I opened this issue: #246390.