fix: always mount listeners in useStorage #4730
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is _yet another_ possible fix for the various `useStorage` scope issues. Basically, `onMounted` will _always_ run in the scope of the _component_. This means the event listener will not be torn down unless the element itself is. When the various effect scopes we use are torn down, the listener will remain and cause various memory leaks. We can solve this by moving the event listeners _outside_ the `onMounted` callback, as they will then teardown when the scope they're in disposes. However, this then means the event listener could run before the component has mounted, when `initOnMount` is true. To solve this, we check in the event handler and do nothing if it isn't mounted yet. We only care about the _first_ mount, since all others will have already gone through at least one `update` call.
ferferga
reviewed
Apr 26, 2025
Comment on lines
+208
to
211
| tryOnMounted(() => { | ||
| firstMounted = true | ||
| update() | ||
| }) |
There was a problem hiding this comment.
This is needed for SSR maybe? Why the hooks need to be added on mount in the first place?
There was a problem hiding this comment.
i'm just maintaining whatever was there before
there's an initOnMounted option, that's why this is a thing. don't know why that is an option though
5 tasks
OrbisK
previously approved these changes
Apr 30, 2025
ilyaliao
reviewed
Apr 30, 2025
OrbisK
approved these changes
Apr 30, 2025
ilyaliao
approved these changes
Apr 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is yet another possible fix for the various
useStoragescope issues.Basically,
onMountedwill always run in the scope of the component. This means the event listener will not be torn down unless the element itself is. When the various effect scopes we use are torn down, the listener will remain and cause various memory leaks.We can solve this by moving the event listeners outside the
onMountedcallback, as they will then teardown when the scope they're in disposes.However, this then means the event listener could run before the component has mounted, when
initOnMountis true. To solve this, we check in the event handler and do nothing if it isn't mounted yet.We only care about the first mount, since all others will have already gone through at least one
updatecall.Before submitting the PR, please make sure you do the following
fixes #123).