Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[connectors] Allow connector UX to display warnings about connectors #114507

Open
pmuellr opened this issue Oct 11, 2021 · 2 comments
Open

[connectors] Allow connector UX to display warnings about connectors #114507

pmuellr opened this issue Oct 11, 2021 · 2 comments
Labels
Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) technical debt Improvement of the software architecture and operational architecture

Comments

@pmuellr
Copy link
Member

pmuellr commented Oct 11, 2021

in PR #105440, a new capability in the connectors UX is added - the ability to display a warning icon beside a connector. This is used in the PR to note connectors which are "deprecated" and need to be updated.

The way this is done in the PR is to check a specific field for a specific set of connector types:

const itemConfig = (
item as UserConfiguredActionConnector<Record<string, unknown>, Record<string, unknown>>
).config;
const showLegacyTooltip =
itemConfig?.isLegacy &&
// TODO: Remove when applications are certified
((ENABLE_NEW_SN_ITSM_CONNECTOR && item.actionTypeId === '.servicenow') ||
(ENABLE_NEW_SN_SIR_CONNECTOR && item.actionTypeId === '.servicenow-sir'));

That code will get complicated if we need to add more of these.

Rather than continue in that style, it seems like a connector should be able to return some kind of "warning" indicator, that would have at least the content needed for the tooltip - title and content. Perhaps we'd also want to allow a customized icon, and a URL (in case the warning message is actionable, and the URL would help the user perform that action).

If we have a generic way of allowing a connector to return this kind of information, then we can move that logic into the connectors, and out of the generic UX code.

@pmuellr pmuellr added Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX labels Oct 11, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@pmuellr pmuellr added technical debt Improvement of the software architecture and operational architecture and removed technical-debt discuss labels Oct 11, 2021
@gmmorris
Copy link
Contributor

We should probably do this as part of the oAuth support work as we'll need a way of warning users when their tokens expire.

Moving to backlog until we have clearer timelines for oAuth.

@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) technical debt Improvement of the software architecture and operational architecture
Projects
No open projects
Development

No branches or pull requests

4 participants