fix(core): improve event listener cleanup #4258
Merged
Conversation
This file contains 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
Closes #4186. Before this fix, we weren't removing event listeners registered by the plugin event brokers (mostly for the `_exit` and `_restart` control events). This is now done in a simple way via the new `onKey` and `clearKey` methods on the event bus, which facilitates removing all listeners matching a given key. We use `garden.sessionId` as the key now, which is not quite ideal when running concurrent commands in `garden dev`, but we'll be assigning a command-unique `sessionId` in an upcoming PR (which gives us precisely the semantics we want here).
edvald
approved these changes
May 13, 2023
This was referenced May 13, 2023
vvagaytsev
reviewed
May 14, 2023
Comment on lines
+315
to
+316
| // "_exit", | ||
| // "_restart", |
There was a problem hiding this comment.
@thsig should these commented lines be removed?
There was a problem hiding this comment.
Yes, they should—my bad.
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.
What this PR does / why we need it:
Closes #4186.
Before this fix, we weren't removing event listeners registered by the plugin event brokers (mostly for the
_exitand_restartcontrol events).This is now done in a simple way via the new
onKeyandclearKeymethods on the event bus, which facilitates removing all listeners matching a given key.We use
garden.sessionIdas the key now, which is not quite ideal when running concurrent commands ingarden dev, but we'll be assigning a command-uniquesessionIdin an upcoming PR (which gives us precisely the semantics we want here).Which issue(s) this PR fixes:
Fixes #4186 and #2422.