fix(cdk/overlay): backdrop timeouts not being cleared in some cases by crisbeto · Pull Request #23972 · angular/components

crisbeto · 2021-11-17T12:49:43Z

When we start the detach sequence of a backdrop, we bind a transitionend event as well as a 500ms timeout in case the event doesn't fire. If the event fires before 500ms, we clear the timeout so users don't have to flush it in tests, however we had the following problems:

Transparent backdrops don't have a transition so they were always being cleaned up after the 500ms timeout.
We weren't clearing the timeout if the overlay was disposed while the backdrop transition is running. This meant that the timeout would still be in memory, even though the element was removed from the DOM.
We had a memory leak where the click and transitionend events weren't being removed from the backdrop if the overlay is disposed while detaching.

Basically all Material components had one of these issues. These changes resolve the problems by:

Clearing the timeout when the overlay is disposed.
Setting a 1ms transition on the transparent overlay so its transitionend can fire (almost) instantly.
Removing the click and transitionend events when the backdrop is disposed.

jelbourn

lgtm

github-actions · 2021-12-22T17:09:04Z

Deployed dev-app to: https://ng-comp-dev--pr-23972-a880f87e34fa15d448cdfd1c99520f4a-4aj27tou.web.app

mmalerba · 2022-01-21T05:44:48Z

- // `rgba(0, 0, 0, 0)`, we work around the inconsistency by not setting the background at
- // all and using `opacity` to make the element transparent.
- &, &.cdk-overlay-backdrop-showing {
- opacity: 0;


why was the opacity: 0 removed? this seems to be breaking screenshots in some apps

It's been a while since I opened the PR, but I think it was because the opacity would actually cause the transition to run, even though it's animating from transparent to transparent.

I think there may be something not quite right about it. When I presubmitted this I wound up with some apps that had opaque backdrops covering everything

When we start the detach sequence of a backdrop, we bind a `transitionend` event as well as a 500ms timeout in case the event doesn't fire. If the event fires before 500ms, we clear the timeout so users don't have to flush it in tests, however we had the following problems: 1. Transparent backdrops don't have a transition so they were always being cleaned up after the 500ms timeout. 2. We weren't clearing the timeout if the overlay was disposed while the backdrop transition is running. This meant that the timeout would still be in memory, even though the element was removed from the DOM. 3. We had a memory leak where the `click` and `transitionend` events weren't being removed from the backdrop if the overlay is disposed while detaching. Basically all Material components had one of these two issues. These changes resolve the problems by: 1. Clearing the timeout when the overlay is disposed. 2. Setting a 1ms transition on the transparent overlay so its `transitionend` can fire (almost) instantly. 3. Removing the `click` and `transitionend` events when the backdrop is disposed.

crisbeto · 2022-03-04T10:34:57Z

I've pushed another change to try and make it easier to land.

…23972) When we start the detach sequence of a backdrop, we bind a `transitionend` event as well as a 500ms timeout in case the event doesn't fire. If the event fires before 500ms, we clear the timeout so users don't have to flush it in tests, however we had the following problems: 1. Transparent backdrops don't have a transition so they were always being cleaned up after the 500ms timeout. 2. We weren't clearing the timeout if the overlay was disposed while the backdrop transition is running. This meant that the timeout would still be in memory, even though the element was removed from the DOM. 3. We had a memory leak where the `click` and `transitionend` events weren't being removed from the backdrop if the overlay is disposed while detaching. Basically all Material components had one of these two issues. These changes resolve the problems by: 1. Clearing the timeout when the overlay is disposed. 2. Setting a 1ms transition on the transparent overlay so its `transitionend` can fire (almost) instantly. 3. Removing the `click` and `transitionend` events when the backdrop is disposed. (cherry picked from commit bbe6355)

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@angular/cdk](https://github.com/angular/components) | dependencies | patch | [`13.2.5` -> `13.2.6`](https://renovatebot.com/diffs/npm/@angular%2fcdk/13.2.5/13.2.6) | | [@angular/material](https://github.com/angular/components) | dependencies | patch | [`13.2.5` -> `13.2.6`](https://renovatebot.com/diffs/npm/@angular%2fmaterial/13.2.5/13.2.6) | --- ### Release Notes <details> <summary>angular/components</summary> ### [`v13.2.6`](https://github.com/angular/components/blob/HEAD/CHANGELOG.md#1326-suede-spaghetti-2022-03-09) [Compare Source](angular/components@13.2.5...13.2.6) ##### cdk | Commit | Type | Description | | -- | -- | -- | | [39929a815d](angular/components@39929a8) | fix | **overlay:** backdrop timeouts not being cleared in some cases ([#23972](angular/components#23972)) | | [2f2b0c7cf4](angular/components@2f2b0c7) | fix | **testing:** dispatch mouseover and mouseout events in UnitTestElement ([#24490](angular/components#24490)) | | [edca54f2d0](angular/components@edca54f) | fix | **testing:** require at least one argument for locator functions ([#23619](angular/components#23619)) | ##### material | Commit | Type | Description | | -- | -- | -- | | [c4993ac171](angular/components@c4993ac) | fix | **button:** avoid setting a tabindex on all link buttons ([#22901](angular/components#22901)) | | [c47d30e0e5](angular/components@c47d30e) | fix | **dialog:** don't wait for animation before moving focus ([#24121](angular/components#24121)) | | [70b8248568](angular/components@70b8248) | fix | **expansion:** able to tab into descendants with visibility while closed ([#24045](angular/components#24045)) | | [d22d73ab8d](angular/components@d22d73a) | fix | **select:** disabled state out of sync when swapping form group with a disabled one ([#17872](angular/components#17872)) | | [911d6b71d4](angular/components@911d6b7) | fix | **slide-toggle:** clear name from host node ([#15505](angular/components#15505)) | | [4b5363d160](angular/components@4b5363d) | fix | **tooltip:** decouple removal logic from change detection ([#19432](angular/components#19432)) | ##### material-experimental | Commit | Type | Description | | -- | -- | -- | | [8414646d79](angular/components@8414646) | fix | **mdc-card:** remove extra margin if header doesn't have an avatar ([#19072](angular/components#19072)) | | [f66486dc5b](angular/components@f66486d) | fix | **mdc-slider:** fix a few null pointer exceptions ([#23659](angular/components#23659)) | ##### multiple | Commit | Type | Description | | -- | -- | -- | | [6ee0089ce6](angular/components@6ee0089) | fix | don't block child component animations on open ([#24529](angular/components#24529)) | #### Special Thanks Andrew Seguin, Jeri Peier, Kristiyan Kostadinov and Paul Gschwendtner  </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1214 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

…ngular#23972) When we start the detach sequence of a backdrop, we bind a `transitionend` event as well as a 500ms timeout in case the event doesn't fire. If the event fires before 500ms, we clear the timeout so users don't have to flush it in tests, however we had the following problems: 1. Transparent backdrops don't have a transition so they were always being cleaned up after the 500ms timeout. 2. We weren't clearing the timeout if the overlay was disposed while the backdrop transition is running. This meant that the timeout would still be in memory, even though the element was removed from the DOM. 3. We had a memory leak where the `click` and `transitionend` events weren't being removed from the backdrop if the overlay is disposed while detaching. Basically all Material components had one of these two issues. These changes resolve the problems by: 1. Clearing the timeout when the overlay is disposed. 2. Setting a 1ms transition on the transparent overlay so its `transitionend` can fire (almost) instantly. 3. Removing the `click` and `transitionend` events when the backdrop is disposed.

angular-automatic-lock-bot · 2022-04-09T00:03:29Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

google-claBot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Nov 17, 2021

crisbeto marked this pull request as ready for review November 17, 2021 12:59

crisbeto requested a review from jelbourn as a code owner November 17, 2021 12:59

crisbeto added G This is is related to a Google internal issue P2 The issue is important to a large percentage of users, with a workaround target: patch This PR is targeted for the next patch release labels Nov 17, 2021

jelbourn approved these changes Nov 17, 2021
View reviewed changes

jelbourn added the action: merge The PR is ready for merge by the caretaker label Nov 17, 2021

josephperrott added the dev-app preview When applied, previews of the dev-app are deployed to Firebase label Dec 22, 2021

andrewseguin removed the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 28, 2021

mmalerba reviewed Jan 21, 2022
View reviewed changes

mmalerba removed the action: merge The PR is ready for merge by the caretaker label Jan 21, 2022

crisbeto removed the dev-app preview When applied, previews of the dev-app are deployed to Firebase label Mar 4, 2022

crisbeto force-pushed the overlay-backdrop-timeouts branch from a880f87 to 2923a85Compare March 4, 2022 10:33

crisbeto added the action: merge The PR is ready for merge by the caretaker label Mar 4, 2022

amysorto merged commit bbe6355 into angular:masterMar 9, 2022

sync-by-unitoBot mentioned this pull request Mar 14, 2022
build(deps): bump @angular/cdk from 12.2.4 to 13.2.6 numbersprotocol/capture-cam#1370
Closed

sync-by-unitoBot mentioned this pull request Mar 22, 2022
build(deps): bump @angular/cdk from 12.2.4 to 13.3.0 numbersprotocol/capture-cam#1403
Closed

angular-automatic-lock-botBot locked and limited conversation to collaborators Apr 9, 2022

Navigation Menu

Uh oh!

fix(cdk/overlay): backdrop timeouts not being cleared in some cases - #23972

fix(cdk/overlay): backdrop timeouts not being cleared in some cases#23972
amysorto merged 1 commit into
angular:masterfrom
crisbeto:overlay-backdrop-timeouts

crisbeto commented Nov 17, 2021

Uh oh!

jelbourn left a comment

Uh oh!

github-actionsBot commented Dec 22, 2021

Uh oh!

mmalerbaJan 21, 2022

Uh oh!

crisbetoJan 21, 2022•
edited
Loading

Uh oh!

mmalerbaFeb 4, 2022

Uh oh!

crisbeto commented Mar 4, 2022

Uh oh!

angular-automatic-lock-botBot commented Apr 9, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

crisbeto commented Nov 17, 2021

Uh oh!

jelbourn left a comment

Choose a reason for hiding this comment

Uh oh!

github-actionsBot commented Dec 22, 2021

Uh oh!

mmalerbaJan 21, 2022

Choose a reason for hiding this comment

Uh oh!

crisbetoJan 21, 2022• 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!

mmalerbaFeb 4, 2022

Choose a reason for hiding this comment

Uh oh!

crisbeto commented Mar 4, 2022

Uh oh!

angular-automatic-lock-botBot commented Apr 9, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

crisbetoJan 21, 2022•
edited
Loading