Skip to content

[Security Solution] Declutter the ThreeWayDiff UI #208177

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

Open
Tracked by #214746
banderror opened this issue Jan 24, 2025 · 3 comments
Open
Tracked by #214746

[Security Solution] Declutter the ThreeWayDiff UI #208177

banderror opened this issue Jan 24, 2025 · 3 comments
Assignees
Labels
enhancement New value added to drive a business result Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules area needs design needs product Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.

Comments

@banderror
Copy link
Contributor

banderror commented Jan 24, 2025

Epic: #179907

Summary

We should "declutter" the Updates tab of the Rule Upgrade flyout that shows fields updated by Elastic and customized by the user.

Currently, if the user has many rule fields customized, we will show all of them in the flyout, along with the fields that have updates from Elastic. This looks a bit messy and the user can loose focus on updates and resolving conflicts between the updates and their customizations.

Image

Here in green you can see fields that have updates from Elastic, and in orange fields that only have customizations made by the user.

We should ensure that users get a clear focus on updates from Elastic and conflicts between these updates and user customizations. Fields that have only user customizations but don't have updates from Elastic should be available for review and modification, but should be the lowest priority/focus.

User stories

  • User can review field updates in the Upgrade flyout in the following order, in order to focus on the most important information first:

    1. Fields with non-solvable conflicts.
    2. Fields with solvable conflicts.
    3. Fields only with updates from Elastic.
    4. Fields only with user customizations.
  • User can skip reviewing those fields that only contain user customizations; these fields should be hidden by default.

  • User can unhide the fields that only contain user customizations, to be able to review and edit them if needed.

Background

Currently, if the user has many rule fields customized, we will show all of them in the flyout, along with the fields that have updates from Elastic.

Something that might be not clear to people is why do we need to show the fields that only contain user customizations?

Let's look at this simple example:

  • Elastic updated the list of index patterns
  • User updated the list of index patterns AND also changed the rule query

We will always be able to auto-merge changes to index patterns, so in this case it's gonna always be a solvable conflict. However, the user's customization to the query field might not be compatible with the auto-merged value of index patterns. That's why we should allow the user to edit the query field as well, if it's needed in a particular upgrade case.

Related issues

@banderror banderror added enhancement New value added to drive a business result Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules area needs design needs product Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team labels Jan 24, 2025
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@banderror banderror changed the title [Security Solution] Declutter the ThreeWayDiff UI (DRAFT) [Security Solution] Declutter the ThreeWayDiff UI Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules area needs design needs product Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
Projects
None yet
Development

No branches or pull requests

4 participants