fix(subscriber): panic when reloading Filtered #3328
+250
−10
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
samugi
force-pushed
the
fix/reload-filtered-layers
branch
2 times, most recently
from
cad5db4 to
6316fba
Compare
This commit adds support for reloading filtered layers without breaking the existing API. The `Reload` handle now provides a `reload_filtered` function, which invokes a newly introduced `on_reload_layer` function on the `Layer`. This function is responsible for registering the filter with the subscriber via `register_filter_immut`. Unlike `register_filter`, `register_filter_immut` takes a shared reference to the subscriber, allowing the filter registration to occur after the subscriber has been fully initialized.
samugi
force-pushed
the
fix/reload-filtered-layers
branch
from
6316fba to
5f93bac
Compare
hds
added
kind/feature
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
Resolve #1629 without introducing a breaking change.
A workaround for this issue was introduced via
filter_mut, which allows reloading theFilterof aFilteredlayer — but it still doesn't support replacing the entireFilteredlayer.A breaking change was also proposed, but it comes with some downsides:
Alternativessection here, it could introduce unintended side effects.Solution
This change adds support for reloading filtered layers without breaking the existing API by introducing a dedicated
Handle::reload_filteredmethod for reloadingFilteredlayers, and aLayer::on_reload_layermethod for performing late initialization when aLayeris reloaded.Handle::reload_filteredinvokes the newLayer::on_reload_layermethod on the layer. This method is responsible for registering the filter with the subscriber viaregister_filter_immut.Unlike
register_filter, theregister_filter_immutfunction takes a shared reference to the subscriber, allowing filter registration after the subscriber has been fully initialized.Usage examples for are included in the inline documentation.
Fixes: #1629