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.

Sign up for GitHub

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

Jump to bottom

[EuiTextTruncate] Fix timeout clean-up when component unmounts #7495

Merged
merged 4 commits into from
Jan 31, 2024
Merged

[EuiTextTruncate] Fix timeout clean-up when component unmounts #7495

merged 4 commits into from
Jan 31, 2024

Conversation

tonyghiani
Copy link
Contributor

@tonyghiani tonyghiani commented Jan 30, 2024 •
edited by cee-chen
Loading

Summary

The component could unmount before the timeout to mark the component as ready is resolved and update the state.

React has a specific error for this scenario, which is occurring in one of the consuming apps:

unmount-error

A defensive timer clean-up on the side effect removes the error and cleans the memory the timer uses.

General checklist

  • Browser QA
    • Checked in both light and dark modes
    • Checked in mobile
    • Checked in Chrome, Safari, Edge, and Firefox
      - [ ] Checked for accessibility including keyboard-only and screenreader modes
  • Docs site QA - N/A, bugfix
  • Code quality checklist
  • Release checklist
    • A changelog entry exists and is marked appropriately.
    • [ ] If applicable, added the breaking change issue label (and filled out the breaking change checklist)
  • Designer checklist - N/A

@tonyghiani tonyghiani marked this pull request as ready for review January 30, 2024 13:00
@tonyghiani tonyghiani requested a review from a team as a code owner January 30, 2024 13:00
cee-chen
cee-chen approved these changes Jan 30, 2024
View reviewed changes
Copy link
Member

@cee-chen cee-chen left a comment

Choose a reason for hiding this comment

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

Thanks so much again for catching this Marco, you're awesome! If you'd not a fan of the minor cleanup I pushed, let me know and I'm happy to revisit!

@cee-chen cee-chen added the bug label Jan 30, 2024
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jan 30, 2024 •
edited
Loading

💚 Build Succeeded

History

@kibanamachine
Copy link

Preview staging links for this PR:

@cee-chen cee-chen merged commit 3b46c35 into elastic:main Jan 31, 2024
9 checks passed
@tonyghiani tonyghiani deleted the euiTextTruncate/fix-update-on-unmount branch February 1, 2024 08:06
@cee-chen cee-chen mentioned this pull request Feb 5, 2024
Merged
jbudz added a commit to elastic/kibana that referenced this pull request Feb 8, 2024
@cee-chen @jbudz
Upgrade EUI to v93.0.0 (#176246)
cb5cf0e 
`v92.2.1` ⏩ `v93.0.0`

---

## [`v93.0.0`](https://github.com/elastic/eui/releases/v93.0.0)

**Bug fixes**

- Fixed `EuiTextTruncate` component to clean up timer from side effect
on unmount ([#7495](elastic/eui#7495))

**Breaking changes**

- Removed deprecated `anchorClassName` prop from `EuiPopover`. Use
`className` instead ([#7488](elastic/eui#7488))
- Removed deprecated `buttonRef` prop from `EuiPopover`. Use
`popoverRef` instead ([#7488](elastic/eui#7488))
- Removed deprecated `toolTipTitle` and `toolTipPosition` props from
`EuiContextMenuItem`. Use `toolTipProps.title` and
`toolTipProps.position` instead
([#7489](elastic/eui#7489))
- Removed deprecated internal `setSelection` ref method from
`EuiInMemoryTable` and `EuiBasicTable`. Use the new controlled
`selection.selected` prop API instead.
([#7491](elastic/eui#7491))
- `EuiTourStep`'s `className` and `style` props now apply to the
anchoring element instead of to the popover panel, to match `EuiPopover`
behavior. ([#7497](elastic/eui#7497))
- Convert your existing usages to `panelClassName` and `panelStyle`
respectively instead.

**Performance**

- Improved the amount of recomputed styles being generated by `EuiCode`
and `EuiCodeBlock` ([#7486](elastic/eui#7486))

**CSS-in-JS conversions**

- Converted `EuiSearchBar` to Emotion
([#7490](elastic/eui#7490))
- Converted `EuiEmptyPrompt` to Emotion
([#7494](elastic/eui#7494))
- Added `euiBorderColor` and `useEuiBorderColorCSS` style utilities
([#7494](elastic/eui#7494))

---------

Co-authored-by: Jon <[email protected]>
CoenWarmer pushed a commit to CoenWarmer/kibana that referenced this pull request Feb 15, 2024
@cee-chen @jbudz @CoenWarmer
Upgrade EUI to v93.0.0 (elastic#176246)
51777ff 
`v92.2.1` ⏩ `v93.0.0`

---

## [`v93.0.0`](https://github.com/elastic/eui/releases/v93.0.0)

**Bug fixes**

- Fixed `EuiTextTruncate` component to clean up timer from side effect
on unmount ([elastic#7495](elastic/eui#7495))

**Breaking changes**

- Removed deprecated `anchorClassName` prop from `EuiPopover`. Use
`className` instead ([elastic#7488](elastic/eui#7488))
- Removed deprecated `buttonRef` prop from `EuiPopover`. Use
`popoverRef` instead ([elastic#7488](elastic/eui#7488))
- Removed deprecated `toolTipTitle` and `toolTipPosition` props from
`EuiContextMenuItem`. Use `toolTipProps.title` and
`toolTipProps.position` instead
([elastic#7489](elastic/eui#7489))
- Removed deprecated internal `setSelection` ref method from
`EuiInMemoryTable` and `EuiBasicTable`. Use the new controlled
`selection.selected` prop API instead.
([elastic#7491](elastic/eui#7491))
- `EuiTourStep`'s `className` and `style` props now apply to the
anchoring element instead of to the popover panel, to match `EuiPopover`
behavior. ([elastic#7497](elastic/eui#7497))
- Convert your existing usages to `panelClassName` and `panelStyle`
respectively instead.

**Performance**

- Improved the amount of recomputed styles being generated by `EuiCode`
and `EuiCodeBlock` ([elastic#7486](elastic/eui#7486))

**CSS-in-JS conversions**

- Converted `EuiSearchBar` to Emotion
([elastic#7490](elastic/eui#7490))
- Converted `EuiEmptyPrompt` to Emotion
([elastic#7494](elastic/eui#7494))
- Added `euiBorderColor` and `useEuiBorderColorCSS` style utilities
([elastic#7494](elastic/eui#7494))

---------

Co-authored-by: Jon <[email protected]>
CoenWarmer pushed a commit to CoenWarmer/kibana that referenced this pull request Feb 15, 2024
@cee-chen @jbudz @CoenWarmer
Upgrade EUI to v93.0.0 (elastic#176246)
804138c 
`v92.2.1` ⏩ `v93.0.0`

---

## [`v93.0.0`](https://github.com/elastic/eui/releases/v93.0.0)

**Bug fixes**

- Fixed `EuiTextTruncate` component to clean up timer from side effect
on unmount ([elastic#7495](elastic/eui#7495))

**Breaking changes**

- Removed deprecated `anchorClassName` prop from `EuiPopover`. Use
`className` instead ([elastic#7488](elastic/eui#7488))
- Removed deprecated `buttonRef` prop from `EuiPopover`. Use
`popoverRef` instead ([elastic#7488](elastic/eui#7488))
- Removed deprecated `toolTipTitle` and `toolTipPosition` props from
`EuiContextMenuItem`. Use `toolTipProps.title` and
`toolTipProps.position` instead
([elastic#7489](elastic/eui#7489))
- Removed deprecated internal `setSelection` ref method from
`EuiInMemoryTable` and `EuiBasicTable`. Use the new controlled
`selection.selected` prop API instead.
([elastic#7491](elastic/eui#7491))
- `EuiTourStep`'s `className` and `style` props now apply to the
anchoring element instead of to the popover panel, to match `EuiPopover`
behavior. ([elastic#7497](elastic/eui#7497))
- Convert your existing usages to `panelClassName` and `panelStyle`
respectively instead.

**Performance**

- Improved the amount of recomputed styles being generated by `EuiCode`
and `EuiCodeBlock` ([elastic#7486](elastic/eui#7486))

**CSS-in-JS conversions**

- Converted `EuiSearchBar` to Emotion
([elastic#7490](elastic/eui#7490))
- Converted `EuiEmptyPrompt` to Emotion
([elastic#7494](elastic/eui#7494))
- Added `euiBorderColor` and `useEuiBorderColorCSS` style utilities
([elastic#7494](elastic/eui#7494))

---------

Co-authored-by: Jon <[email protected]>
fkanout pushed a commit to fkanout/kibana that referenced this pull request Mar 4, 2024
@cee-chen @jbudz @fkanout
Upgrade EUI to v93.0.0 (elastic#176246)
8a666bf 
`v92.2.1` ⏩ `v93.0.0`

---

## [`v93.0.0`](https://github.com/elastic/eui/releases/v93.0.0)

**Bug fixes**

- Fixed `EuiTextTruncate` component to clean up timer from side effect
on unmount ([elastic#7495](elastic/eui#7495))

**Breaking changes**

- Removed deprecated `anchorClassName` prop from `EuiPopover`. Use
`className` instead ([elastic#7488](elastic/eui#7488))
- Removed deprecated `buttonRef` prop from `EuiPopover`. Use
`popoverRef` instead ([elastic#7488](elastic/eui#7488))
- Removed deprecated `toolTipTitle` and `toolTipPosition` props from
`EuiContextMenuItem`. Use `toolTipProps.title` and
`toolTipProps.position` instead
([elastic#7489](elastic/eui#7489))
- Removed deprecated internal `setSelection` ref method from
`EuiInMemoryTable` and `EuiBasicTable`. Use the new controlled
`selection.selected` prop API instead.
([elastic#7491](elastic/eui#7491))
- `EuiTourStep`'s `className` and `style` props now apply to the
anchoring element instead of to the popover panel, to match `EuiPopover`
behavior. ([elastic#7497](elastic/eui#7497))
- Convert your existing usages to `panelClassName` and `panelStyle`
respectively instead.

**Performance**

- Improved the amount of recomputed styles being generated by `EuiCode`
and `EuiCodeBlock` ([elastic#7486](elastic/eui#7486))

**CSS-in-JS conversions**

- Converted `EuiSearchBar` to Emotion
([elastic#7490](elastic/eui#7490))
- Converted `EuiEmptyPrompt` to Emotion
([elastic#7494](elastic/eui#7494))
- Added `euiBorderColor` and `useEuiBorderColorCSS` style utilities
([elastic#7494](elastic/eui#7494))

---------

Co-authored-by: Jon <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cee-chen cee-chen cee-chen approved these changes

Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tonyghiani @elasticmachine @kibanamachine @cee-chen