Upgrade EUI to v88.1.0 by 1Copenut · Pull Request #165047 · elastic/kibana

1Copenut · 2023-08-28T21:00:53Z

PR change summary

v87.2.0⏩v88.1.0

⚠️ The biggest thing to QA in this PR is several breaking changes to EuiDescriptionList.

Description list `columnWidths` prop

This PR introduces a new columnWidths prop and removes several Kibana instances of custom CSS overrides to title/description column widths.

The primary motivation behind this is not just to reduce custom CSS, but also because v88.0.0 introduced an underlying CSS change of column description lists to using display: grid CSS. The new prop allows us to support existing description list custom widths while not requiring Kibana developers to understand or write grid CSS (except for 1 or two scenarios around max-width).

⚠️ No user-facing UI around column widths should have regressed as a result of these changes. If they have, please let us know in this PR.

Description list gutter size changes

The prop gutterSize has been renamed to rowGutterSize and the default size is now s instead of m.

The change to s from m means there is an expected smaller gap between list items (see below screenshots):

Current EuiDescriptionList with default rowGutterSize="s"

Prior EuiDescriptionList with default gutterSize="m"

If Kibana teams prefer to keep the previous m gutter for their instances of EuiDescriptionList, you have a couple of options:

Let EUI team know in the PR and we can set usage back to what it was before
Set rowGutterSize="m" yourselves manually

`88.1.0`

Added font.defaultUnits theme token. EUI component font sizes default to rem units - this token allows consumers to configure this to px or em (#7133)
Updated EuiDescriptionList with new columnWidths prop (#7146)

Bug fixes

Fixed EuiDataGrid's keyboard shortcuts popover display (#7146)

CSS-in-JS conversions

Renamed useEuiFontSize()'s measurement option to unit for clarity (#7133)

`88.0.0`

Updated EuiDescriptionList with a new columnGutterSize prop (#7062)

Deprecations

Deprecated EuiSuggest. We recommend using EuiSelectable or EuiComboBox instead (#7122)
Deprecated EuiControlBar. We recommend using EuiBottomBar instead (#7122)
Deprecated EuiColorStops. We recommend copying the component to your application if necessary (#7122)
Deprecated EuiNotificationEvent. We recommend copying the component to your application if necessary (#7122)

Breaking changes

Renamed EuiDescriptionList's gutterSize prop to rowGutterSize (#7062)
EuiDescriptionList's rowGutterSize prop now defaults to a size of s (was previously m) (#7062)

Accessibility

Fixed the dark mode colors of inline EuiDescriptionListTitles to meet WCAG color contrast requirements (#7062)

CSS-in-JS conversions

Converted EuiKeyPadMenuItem to Emotion; Removed $euiKeyPadMenuSize and $euiKeyPadMenuMarginSize (#7118)

- note: for some reason, `getDOMNode()` is returning an array instead of a single element - appears to be a bug with Enzyme

cee-chen · 2023-08-28T21:23:00Z

src/plugins/data/public/shard_failure_modal/shard_failure_description.tsx

        <EuiDescriptionList
          type="responsiveColumn"
-          gutterSize="s"
+          rowGutterSize="s"


We can technically remove these props completely now that rowGutterSize defaults to "s".

Suggested change

rowGutterSize="s"

@kyrspl what was the intention of the breaking EuiDescriptionList gutter size change? Do you want all downstream instances in Kibana to adopt the new default gutter size, or should we update previous usages to set <EuiDescriptionList rowGutterSize="m"> to preserve the old gutter size?

Visual preference - if we think it's going to break a lot of instances let's switch it to m and we can review later.

For clarity, why did you write size="m"?

@kyrspl and I discussed this at the beginning of my workday Tuesday (Aug 29). We decided it would be better to update the EuiDescriptionList props rowGutterSize and columnGutterSize to have default m. I'll update the component in EUI, issue a new pull request, then make a minor point release and fold it into this Kibana upgrade.

~~That way we're keeping the default the same as was prior for row margins, and honoring the local Kibana overrides by passing in s.~~

/cc @cee-chen

UPDATE:
The whole EUI team discussed this item and the ramifications of reverting a conscious change. We are moving ahead with the breaking change as is, with the default gutter as s. I'll update the Kibana code to handle this breaking change and include screen shots as I can for product teams to review.

….0.0

elasticmachine · 2023-08-29T21:49:49Z

Pinging @elastic/eui-team (EUI)

src/plugins/data/public/shard_failure_modal/shard_failure_description.tsx

elasticmachine · 2023-08-29T23:03:34Z

Pinging @elastic/uptime (Team:uptime)

opauloh

Cloud Security lgtm

weltenwort · 2023-08-30T10:02:28Z

x-pack/plugins/monitoring/public/components/no_data/__snapshots__/checker_errors.test.js.snap

      >
        <dt
-          class="euiDescriptionList__title emotion-euiDescriptionList__title-row-m-normal"
+          class="euiDescriptionList__title emotion-euiDescriptionList__title-row-normal-s"


This seems to be a direct consequence of the changed default size, right? Do we want to specify size m explicitly in the corresponding React element call so it doesn't change?

@weltenwort Correct, the snapshots updated because the default size was changed to s. This was a conscious decision by EUI to reduce the margin between rows on EuiDescriptionList. If there are layouts you want to retain the larger margin, they can be overrode by passing rowGutterSize="m" into the component.

- goal is to reduce churn whenever eui theme updates, and also prefer RTL over enzyme

…-ref HEAD~1..HEAD --fix'

peteharverson

Tested ML changes and LGTM

cee-chen · 2023-09-01T16:51:42Z

Hey all - just want to give a heads up, I'm not sure what's going on with the failing serverless tests and I'm pretty sure they're not related to EUI. We'll continue merging main in hopes that they get fixed in main, and talk to KibanaOps if it's not looking to improve, but until then, please ignore any serverless CI failures and focus on EuiDescriptionList as the main item to QA in this PR.

nikitaindik

Reviewed the Security Solution Rules Management screens. Found a couple display issues. Discussed these with @cee-chen. Fixes for these were merged in with this commit.

Now Security Solution Rules Management part LGTM.

tomsonpl

LGTM, Management views look ok to me :) But let's wait for a second pair of eyes too 👍

angorayc

Tested locally, LGTM, thank you!

weltenwort

monitoring plugin changes LGTM

cee-chen · 2023-09-05T16:03:18Z

@elastic/security-threat-hunting-investigations @elastic/kibana-visualizations @elastic/kibana-presentation @elastic/security-defend-workflows - last call for reviews/QA checks, we'll be asking KibanaOps to admin merge by EOD.

As always, however, you're welcome to ping us later for help if you run into issues!

kibana-ci · 2023-09-05T18:07:12Z

💔 Build Failed

Failed CI Steps

Test Failures

[job] [logs] Serverless Security Explore Cypress Tests #2 / Entity Analytics Dashboard in Serverless "before each" hook for "should display a splash screen when visited with Security essentials PLI " "before each" hook for "should display a splash screen when visited with Security essentials PLI "
[job] [logs] Explore - Security Solution Cypress Tests #4 / Entity Analytics Dashboard With host risk data filters by risk classification filters by risk classification
[job] [logs] Defend Workflows Endpoint Cypress Tests #6 / Response console document signing "after all" hook for "should fail if data tampered" "after all" hook for "should fail if data tampered"
[job] [logs] Defend Workflows Endpoint Cypress Tests #6 / Response console document signing "before all" hook for "should fail if data tampered" "before all" hook for "should fail if data tampered"
[job] [logs] Serverless Security Examples Tests / serverless examples UI search examples Search example with bfetch should have an other bucket

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`cases`	668	670	+2
`core`	481	483	+2
`fleet`	939	941	+2
`kibanaReact`	325	327	+2
`kibanaUtils`	181	183	+2
`security`	500	502	+2
`securitySolution`	4499	4502	+3
total			+15

Async chunks

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

id	before	after	diff
`canvas`	1.0MB	1.0MB	-33.0B
`cases`	423.1KB	426.8KB	+3.6KB
`core`	146.7KB	150.3KB	+3.6KB
`data`	54.8KB	54.1KB	-732.0B
`dataVisualizer`	606.1KB	605.5KB	-646.0B
`fleet`	1.2MB	1.2MB	+3.6KB
`infra`	2.0MB	2.0MB	+1.0B
`kibanaReact`	209.4KB	213.0KB	+3.6KB
`kibanaUtils`	60.8KB	64.4KB	+3.6KB
`ml`	3.5MB	3.5MB	-1.5KB
`security`	568.0KB	571.6KB	+3.6KB
`securitySolution`	12.6MB	12.6MB	+14.4KB
`sessionView`	392.0KB	391.9KB	-28.0B
`synthetics`	913.1KB	913.0KB	-43.0B
`triggersActionsUi`	1.4MB	1.4MB	-269.0B
`visTypeVega`	1.8MB	1.8MB	+1.0B
total			+32.8KB

Page load bundle

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

id	before	after	diff
`kbnUiSharedDeps-css`	284.1KB	279.4KB	-4.7KB
`kbnUiSharedDeps-npmDll`	6.2MB	6.2MB	+3.5KB
`kbnUiSharedDeps-srcJs`	2.2MB	2.2MB	+1.0B
total			-1.2KB

History

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

cc @1Copenut

…ails flyout (#165937) ## Summary This PR fixes a UX bug that was a result of EUI upgrade where the description list contents were misaligned. The `EuiDescriptionList` component should take a set of column widths and column and row gutter sizes to allow for adequate spacing between text elements. **before** ![Screenshot 2023-09-07 at 10 16 11 AM](https://github.com/elastic/kibana/assets/1849116/80984552-b611-40ea-98c5-945aa3b179d7) **with this fix** ![Screenshot 2023-09-07 at 10 15 26 AM](https://github.com/elastic/kibana/assets/1849116/fe1fd47f-8905-4808-bd14-f891fc345a2b) see /pull/165047 ### Checklist - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [x] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

1Copenut added 2 commits August 28, 2023 14:41

Bumping EUI to v88.0.0.

beddeaf

Updating rowGutterSize prop in EuiDescriptionList.

a9b5c07

1Copenut added release_note:skip Skip the PR/issue when compiling release notes EUI backport:skip This PR does not require backporting v8.11.0 labels Aug 28, 2023

1Copenut self-assigned this Aug 28, 2023

Update deprecated EuiKeyPadMenuItem className selector

d84cc09

- note: for some reason, `getDOMNode()` is returning an array instead of a single element - appears to be a bug with Enzyme

cee-chen reviewed Aug 28, 2023

View reviewed changes

cee-chen and others added 4 commits August 28, 2023 14:49

Fix deprecated color stop type

65712bf

Updated Jest snapshots.

dc5cd7d

Merge branch 'eui/v88.0.0' of github.com:1Copenut/kibana into eui/v88…

7e2897a

….0.0

Merge branch 'main' into eui/v88.0.0

5c223e0

1Copenut marked this pull request as ready for review August 29, 2023 21:49

1Copenut requested review from a team as code owners August 29, 2023 21:49

davismcphee reviewed Aug 29, 2023

View reviewed changes

src/plugins/data/public/shard_failure_modal/shard_failure_description.tsx Show resolved Hide resolved

botelastic bot added the Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability label Aug 29, 2023

opauloh approved these changes Aug 29, 2023

View reviewed changes

weltenwort reviewed Aug 30, 2023

View reviewed changes

cee-chen requested review from nikitaindik and tomsonpl August 31, 2023 19:29

cee-chen changed the title ~~Upgrade EUI to v88.0.0~~ Upgrade EUI to v88.1.0 Aug 31, 2023

cee-chen and others added 6 commits August 31, 2023 13:19

[EuiDescriptionList] Update snapshots

79546e4

[Spaces] Remove enzyme snapshot in favor of RTL snapshot

b0ab48a

- goal is to reduce churn whenever eui theme updates, and also prefer RTL over enzyme

Merge branch 'main' into eui/v88.0.0

c2ca2bc

Merge branch 'main' into eui/v88.0.0

bab48a6

Merge branch 'main' into eui/v88.0.0

ca0e352

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

2098bc5

…-ref HEAD~1..HEAD --fix'

kibanamachine requested a review from a team as a code owner September 1, 2023 00:34

peteharverson approved these changes Sep 1, 2023

View reviewed changes

jcger approved these changes Sep 1, 2023

View reviewed changes

cee-chen and others added 2 commits September 1, 2023 09:00

Merge remote-tracking branch 'upstream/main' into eui/v88.0.0

93c1f71

Fix EuiDescriptionList usage styles

62cdbad

nikitaindik approved these changes Sep 1, 2023

View reviewed changes

ryankeairns approved these changes Sep 1, 2023

View reviewed changes

tomsonpl approved these changes Sep 4, 2023

View reviewed changes

jcger approved these changes Sep 4, 2023

View reviewed changes

angorayc approved these changes Sep 4, 2023

View reviewed changes

Merge branch 'main' into eui/v88.0.0

eef93d4

weltenwort approved these changes Sep 5, 2023

View reviewed changes

Merge branch 'main' into eui/v88.0.0

1c37660

Merge branch 'main' into eui/v88.0.0

ac172e7

jbudz merged commit 3cb13fb into elastic:main Sep 5, 2023

ashokaditya mentioned this pull request Sep 7, 2023

[Security Solution][Endpoint] Update description list on endpoint details flyout #165937

Merged

5 tasks

Conversation

1Copenut commented Aug 28, 2023 • edited by cee-chen Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR change summary

Description list columnWidths prop

Description list gutter size changes

88.1.0

88.0.0

Uh oh!

cee-chen Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kyrspl Aug 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

1Copenut Aug 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Aug 29, 2023

Uh oh!

Uh oh!

elasticmachine commented Aug 29, 2023

Uh oh!

opauloh left a comment

Choose a reason for hiding this comment

Uh oh!

weltenwort Aug 30, 2023

Choose a reason for hiding this comment

Uh oh!

1Copenut Aug 30, 2023

Choose a reason for hiding this comment

Uh oh!

peteharverson left a comment

Choose a reason for hiding this comment

Uh oh!

cee-chen commented Sep 1, 2023

Uh oh!

nikitaindik left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tomsonpl left a comment

Choose a reason for hiding this comment

Uh oh!

angorayc left a comment

Choose a reason for hiding this comment

Uh oh!

weltenwort left a comment

Choose a reason for hiding this comment

Uh oh!

cee-chen commented Sep 5, 2023

Uh oh!

kibana-ci commented Sep 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💔 Build Failed

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

19 participants

1Copenut commented Aug 28, 2023 •

edited by cee-chen

Loading

Description list `columnWidths` prop

`88.1.0`

`88.0.0`

cee-chen Aug 28, 2023 •

edited

Loading

kyrspl Aug 29, 2023 •

edited

Loading

1Copenut Aug 29, 2023 •

edited

Loading

nikitaindik left a comment •

edited

Loading

kibana-ci commented Sep 5, 2023 •

edited

Loading