-
Notifications
You must be signed in to change notification settings - Fork 6.8k
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
fix(focus-monitor): implement OnDestroy logic #9305
Conversation
Similarly to most of the other DOM-related services, these changes implement `ngOnDestroy` for the `FocusMonitor` which removes the monitoring from all of the currently-monitored elements.
/** Weak map of elements being monitored to their info. */ | ||
private _elementInfo = new WeakMap<Element, MonitoredElementInfo>(); | ||
/** Map of elements being monitored to their info. */ | ||
private _elementInfo = new Map<HTMLElement, MonitoredElementInfo>(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: I would prefer to keep this as a WeakMap
, but we need a Map
in order to be able to iterate over the elements. Alternatively, if we make an assumption that all the monitored elements will be removed on destroy, we could remove only the global listeners.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a tricky trade-off. We don't have any data to know for sure, but I expect most apps will end up with FocusMonitor
provided at the root, meaning that using Map
could end up making elements remain in memory after they'd otherwise be removed.
Do you think it would be common that monitored elements would remain while the module with the FocusMonitor
would be unloaded?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe the most common case would be that the elements are removed while the monitor remains, in which case the responsibility for stopping the monitoring is on the consumer.
Regarding using the Map
, I have a hunch (haven't verified it) that the current setup would retain references to the elements as well. While we use the element as a key, we also have a reference to it in the unlisten
function which is inside the value. I think that this would retain the reference until the item is removed from the map.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right, the unlisten
would preserve the element reference already, so switching to a Map
won't change anything
Does |
@mmalerba it gets called if the module is unloaded, which very large apps (like GCP) do. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Similarly to most of the other DOM-related services, these changes implement `ngOnDestroy` for the `FocusMonitor` which removes the monitoring from all of the currently-monitored elements.
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Similarly to most of the other DOM-related services, these changes implement
ngOnDestroy
for theFocusMonitor
which removes the monitoring from all of the currently-monitored elements.