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

[Security Solution][Detections] EQL UX Improvements #80230

Merged
merged 4 commits into from
Oct 13, 2020

Conversation

rylnd
Copy link
Contributor

@rylnd rylnd commented Oct 12, 2020

Summary

Two minor UX improvements to the new EQL features:

  • EQL Validation Loading Spinner:
    • gives the user some indication that the validation is being performed in the background, and that their query's validity is undefined as they type it.
    • On a related note, recent changes to the form lib cause a field that's currently validating to be invalid, so this prevents the race condition mentioned in this comment.
  • Preserve whitespace when displaying EQL Rule queries

Loading Spinner:
Oct-12-2020 17-47-02

EQL Rule Before:
aa5f9e20-e397-4dc0-bbd7-99b42b2fac30_-_Kibana

EqL Rule After:
aa5f9e20-e397-4dc0-bbd7-99b42b2fac30_-_Kibana

Checklist

  • Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
  • Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)

For maintainers

This gives the user some indication that the validation is being
performed in the background, and that their query's validity is
currently undefined.
@rylnd rylnd added Team:SIEM v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v7.11.0 Team:Detections and Resp Security Detection Response Team labels Oct 12, 2020
@rylnd rylnd self-assigned this Oct 12, 2020
@rylnd rylnd marked this pull request as ready for review October 13, 2020 00:35
@rylnd rylnd requested review from a team as code owners October 13, 2020 00:35
@elasticmachine
Copy link
Contributor

Pinging @elastic/siem (Team:SIEM)

This is useful for all rules, but particularly for EQL rules, where
sequences will be multiline.
@rylnd rylnd changed the title [Security Solution][Detections] Adds loading state to EQL Query Bar [Security Solution][Detections] EQL UX Improvements Oct 13, 2020
rylnd added 2 commits October 13, 2020 00:12
This content is now wrapped in a whitespace-preserving element, so these
need to be updated ever so slightly.
* Remove extra space from assertion
  * This extra space was removed in the presentation component. I didn't
    find an explicit reason why it was there in the first place.
* Use have.value when asserting on form inputs
Copy link
Contributor

@yctercero yctercero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Pulled down and tested validation, loading spinner, and white space fix. 👍

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

async chunks size

id before after diff
securitySolution 10.6MB 10.6MB +648.0B

History

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

@rylnd rylnd merged commit 79cecd1 into elastic:master Oct 13, 2020
@rylnd rylnd deleted the eql_validation_ux branch October 13, 2020 16:22
rylnd added a commit to rylnd/kibana that referenced this pull request Oct 13, 2020
* Add loading spinner to EQL Query Bar

This gives the user some indication that the validation is being
performed in the background, and that their query's validity is
currently undefined.

* Preserve whitespace on display of rule queries

This is useful for all rules, but particularly for EQL rules, where
sequences will be multiline.

* Fix tests around query description

This content is now wrapped in a whitespace-preserving element, so these
need to be updated ever so slightly.

* Update cypress assertions around rule queries

* Remove extra space from assertion
  * This extra space was removed in the presentation component. I didn't
    find an explicit reason why it was there in the first place.
* Use have.value when asserting on form inputs
rylnd added a commit that referenced this pull request Oct 13, 2020
* Add loading spinner to EQL Query Bar

This gives the user some indication that the validation is being
performed in the background, and that their query's validity is
currently undefined.

* Preserve whitespace on display of rule queries

This is useful for all rules, but particularly for EQL rules, where
sequences will be multiline.

* Fix tests around query description

This content is now wrapped in a whitespace-preserving element, so these
need to be updated ever so slightly.

* Update cypress assertions around rule queries

* Remove extra space from assertion
  * This extra space was removed in the presentation component. I didn't
    find an explicit reason why it was there in the first place.
* Use have.value when asserting on form inputs
rylnd added a commit that referenced this pull request Oct 13, 2020
* Add loading spinner to EQL Query Bar

This gives the user some indication that the validation is being
performed in the background, and that their query's validity is
currently undefined.

* Preserve whitespace on display of rule queries

This is useful for all rules, but particularly for EQL rules, where
sequences will be multiline.

* Fix tests around query description

This content is now wrapped in a whitespace-preserving element, so these
need to be updated ever so slightly.

* Update cypress assertions around rule queries

* Remove extra space from assertion
  * This extra space was removed in the presentation component. I didn't
    find an explicit reason why it was there in the first place.
* Use have.value when asserting on form inputs
@MindyRS MindyRS added the Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. label Sep 22, 2021
@elasticmachine
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:SIEM v7.10.0 v7.11.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants