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] Updates Timeline tooltips to use action words / fewer words #132756

Merged

Conversation

andrew-goldstein
Copy link
Contributor

[Security Solution] Updates Timeline tooltips to use action words / fewer words

Alert tooltips

This section contains before / after screenshots for alerts.

Before: Unpinned alert

01-BEFORE-unpinned-alert

After: Unpinned alert

01-AFTER-unpinned-alert

Before: Pinned alert

02-BEFORE-pinned-alert

After: Pinned alert

02-AFTER-pinned-alert

Before: Add a note to an alert

03-BEFORE-alert-add-note

After: Add a note to an alert

03-AFTER-alert-add-note

Before: A pinned alert with notes

04-BEFORE-pinned-alert-with-notes

After: A pinned alert with notes

04-AFTER-pinned-alert-with-notes

Before: A timeline template with alerts

05-BEFORE-alert-template

After: A timeline template with alerts

05-AFTER-alert-template

Event tooltips

This section contains before / after screenshots for events.

Before: Unpinned event

06-BEFORE-unpinned-event

After: Unpinned event

06-AFTER-unpinned-event

Before: Pinned event

07-BEFORE-pinned-event

After: Pinned event

07-AFTER-pinned-event

Before: Add a note to event

08-BEFORE-event-add-note

After: Add a note to an event

08-AFTER-event-add-note

Before: A pinned event with notes

09-BEFORE-pinned-event-with-notes

After: A pinned event with notes

09-AFTER-pinned-event-with-notes

Before: A timeline template with events

10-BEFORE-event-template

After: A timeline template with events

10-AFTER-event-template

CC: @dimadavid

@andrew-goldstein andrew-goldstein added bug Fixes for quality problems that affect the customer experience release_note:fix auto-backport Deprecated: Automatically backport this PR after it's merged Team:Threat Hunting:Investigations Security Solution Investigations Team v8.3.0 labels May 23, 2022
@andrew-goldstein andrew-goldstein requested a review from a team as a code owner May 23, 2022 22:13
@andrew-goldstein andrew-goldstein self-assigned this May 23, 2022
Comment on lines +42 to +50
if (timelineType === TimelineType.template) {
return i18n.DISABLE_PIN(isAlert);
} else if (isPinned && eventHasNotes) {
return i18n.PINNED_WITH_NOTES(isAlert);
} else if (isPinned) {
return i18n.PINNED(isAlert);
} else {
return i18n.UNPINNED(isAlert);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for cleaning this up, it's much more readable now 👍

@@ -221,6 +224,7 @@ const ActionsComponent: React.FC<ActionProps> = ({
/>
<PinEventAction
ariaLabel={i18n.PIN_EVENT_FOR_ROW({ ariaRowindex, columnValues, isEventPinned })}
isAlert={isAlert(ecsData)}
Copy link
Contributor

Choose a reason for hiding this comment

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

Since eventType is already extracted above (line 108), I wonder if it might be better to change isAlert(ecs: Ecs) to isAlert(eventType: string). That way you'd save one getEventType call per render.

Copy link
Contributor

@janmonschke janmonschke left a comment

Choose a reason for hiding this comment

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

🎉

…/ fewer words

- This PR updates the row-level action button tooltips in Timeline, per issue <elastic#126973>, to use action words / fewer words. This brings the tooltips up to date with the latest [EUI Guidelines](https://elastic.github.io/eui/#/navigation/button/guidelines).
- The tooltips now differentiate between events and alerts. (The original tooltips were written before the Security Solution shipped with a detection engine, so there was no prior distinction.)

### Alert tooltips

This section contains before / after screenshots for alerts.

#### Before: Unpinned alert

![01-BEFORE-unpinned-alert](https://user-images.githubusercontent.com/4459398/169910015-ec5789c2-a691-4e48-b375-c95d15db8378.png)

#### After: Unpinned alert

![01-AFTER-unpinned-alert](https://user-images.githubusercontent.com/4459398/169910149-0cdd8c65-a9b0-43b6-8550-cd0d9c512b17.png)

#### Before: Pinned alert

![02-BEFORE-pinned-alert](https://user-images.githubusercontent.com/4459398/169910207-27aa3307-d33d-4fb5-9ff7-042a6adf030e.png)

#### After: Pinned alert

![02-AFTER-pinned-alert](https://user-images.githubusercontent.com/4459398/169910265-087a3779-2330-437d-b83f-d887eb4adaf9.png)

#### Before: Add a note to an alert

![03-BEFORE-alert-add-note](https://user-images.githubusercontent.com/4459398/169910347-39ca30db-a010-4739-b67f-464851730218.png)

#### After: Add a note to an alert

![03-AFTER-alert-add-note](https://user-images.githubusercontent.com/4459398/169910407-510ff4f3-e0ee-4649-8a44-5b7411a5b629.png)

#### Before: A pinned alert with notes

![04-BEFORE-pinned-alert-with-notes](https://user-images.githubusercontent.com/4459398/169910491-59869c08-2b2b-4c42-a39b-4d4efc05e668.png)

#### After: A pinned alert with notes

![04-AFTER-pinned-alert-with-notes](https://user-images.githubusercontent.com/4459398/169910573-7ae31f88-1199-4744-ae5e-54b40d3c34cb.png)

#### Before: A timeline template with alerts

![05-BEFORE-alert-template](https://user-images.githubusercontent.com/4459398/169910699-03ead1dd-d543-4687-a6f3-14b1b95023aa.png)

#### After: A timeline template with alerts

![05-AFTER-alert-template](https://user-images.githubusercontent.com/4459398/169910740-120eb087-111f-42e9-bb24-af3c344e68c7.png)

### Event tooltips

This section contains before / after screenshots for events.

#### Before: Unpinned event

![06-BEFORE-unpinned-event](https://user-images.githubusercontent.com/4459398/169911532-047d07e2-b4b2-4719-a1a9-fe67c9e04162.png)

#### After: Unpinned event

![06-AFTER-unpinned-event](https://user-images.githubusercontent.com/4459398/169911561-3c452e5b-23de-4144-b0c9-3e805fbd4021.png)

#### Before: Pinned event

![07-BEFORE-pinned-event](https://user-images.githubusercontent.com/4459398/169911699-ffde9799-6120-49e0-8012-37dd687bba31.png)

#### After: Pinned event

![07-AFTER-pinned-event](https://user-images.githubusercontent.com/4459398/169911741-48eeba36-a2c3-4a53-b5f6-57c376b82aa0.png)

#### Before: Add a note to event

![08-BEFORE-event-add-note](https://user-images.githubusercontent.com/4459398/169911867-4139d719-dd5d-4e1b-a415-08863cbf9897.png)

#### After: Add a note to an event

![08-AFTER-event-add-note](https://user-images.githubusercontent.com/4459398/169911895-ea537e8e-9457-4f30-adcc-7ca03c35ea68.png)

#### Before: A pinned event with notes

![09-BEFORE-pinned-event-with-notes](https://user-images.githubusercontent.com/4459398/169911931-9bb662b7-21ea-414b-99c2-46706763ac01.png)

#### After: A pinned event with notes

![09-AFTER-pinned-event-with-notes](https://user-images.githubusercontent.com/4459398/169911975-fc7901ff-61d2-4b6d-b47f-62bf38d4ca16.png)

#### Before: A timeline template with events

![10-BEFORE-event-template](https://user-images.githubusercontent.com/4459398/169911994-4df648ad-bfc7-44ec-bcd5-602a6edb6ca1.png)

#### After: A timeline template with events

![10-AFTER-event-template](https://user-images.githubusercontent.com/4459398/169912017-ac54d03d-11ab-4116-ab33-6d20d5cbba37.png)
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] Security Solution Tests #4 / Open timeline Open timeline modal should display timeline info - pinned event count

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
securitySolution 5.0MB 5.0MB +399.0B

Page load bundle

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

id before after diff
timelines 273.9KB 273.5KB -346.0B

History

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

cc @andrew-goldstein

@andrew-goldstein andrew-goldstein merged commit 899e5cb into elastic:main May 24, 2022
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label May 24, 2022
@andrew-goldstein andrew-goldstein deleted the update-timeline-tooltips branch May 24, 2022 17:49
@kibanamachine
Copy link
Contributor

⚪ Backport skipped

The pull request was not backported as there were no branches to backport to. If this is a mistake, please apply the desired version labels or run the backport tool manually.

Manual backport

To create the backport manually run:

node scripts/backport --pr 132756

Questions ?

Please refer to the Backport tool documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated: Automatically backport this PR after it's merged backport:skip This commit does not require backporting bug Fixes for quality problems that affect the customer experience release_note:fix Team:Threat Hunting:Investigations Security Solution Investigations Team v8.3.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants