-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Weak subscription to CanExecuteChange events #29837
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
Merged
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
pictos
reviewed
Jun 6, 2025
mandel-macaque
requested changes
Jun 9, 2025
/rebase |
5dfb469
to
85db6e1
Compare
PureWeen
commented
Jun 12, 2025
pictos
approved these changes
Jun 12, 2025
I've been testing this PR and it solved a lot of leaks. It's a hit! Thank you guys |
mattleibow
approved these changes
Jun 16, 2025
PureWeen
added a commit
that referenced
this pull request
Jun 21, 2025
* Weak subscription to CanExecuteChange events * - add tests * - fix lifecycle of CanExecute subscription * - cleanup code based on Pictos recommendations * - add a netstandard_20 version of DependentHandle * - add more * - fix missing null check on textcell
PureWeen
added a commit
that referenced
this pull request
Jun 25, 2025
* Weak subscription to CanExecuteChange events * - add tests * - fix lifecycle of CanExecute subscription * - cleanup code based on Pictos recommendations * - add a netstandard_20 version of DependentHandle * - add more * - fix missing null check on textcell
PureWeen
added a commit
that referenced
this pull request
Jun 25, 2025
* Weak subscription to CanExecuteChange events * - add tests * - fix lifecycle of CanExecute subscription * - cleanup code based on Pictos recommendations * - add a netstandard_20 version of DependentHandle * - add more * - fix missing null check on textcell
github-actions bot
pushed a commit
that referenced
this pull request
Jun 26, 2025
* Weak subscription to CanExecuteChange events * - add tests * - fix lifecycle of CanExecute subscription * - cleanup code based on Pictos recommendations * - add a netstandard_20 version of DependentHandle * - add more * - fix missing null check on textcell
github-actions bot
pushed a commit
that referenced
this pull request
Jun 26, 2025
* Weak subscription to CanExecuteChange events * - add tests * - fix lifecycle of CanExecute subscription * - cleanup code based on Pictos recommendations * - add a netstandard_20 version of DependentHandle * - add more * - fix missing null check on textcell
PureWeen
added a commit
that referenced
this pull request
Jun 27, 2025
* Weak subscription to CanExecuteChange events * - add tests * - fix lifecycle of CanExecute subscription * - cleanup code based on Pictos recommendations * - add a netstandard_20 version of DependentHandle * - add more * - fix missing null check on textcell
github-actions bot
pushed a commit
that referenced
this pull request
Jun 27, 2025
* Weak subscription to CanExecuteChange events * - add tests * - fix lifecycle of CanExecute subscription * - cleanup code based on Pictos recommendations * - add a netstandard_20 version of DependentHandle * - add more * - fix missing null check on textcell
PureWeen
added a commit
that referenced
this pull request
Jun 27, 2025
* Weak subscription to CanExecuteChange events * - add tests * - fix lifecycle of CanExecute subscription * - cleanup code based on Pictos recommendations * - add a netstandard_20 version of DependentHandle * - add more * - fix missing null check on textcell
PureWeen
added a commit
that referenced
this pull request
Jun 28, 2025
For more information about inflight process check https://github.com/dotnet/maui/wiki/Inflight-Branch-Process # .NET MAUI Release Notes - Inflight/Candidate Branch ## What's Changed ### MAUI Product Fixes * [iOS] CarouselView with CarouselViewHandler2 make app crash when Loop="False" and user scroll to the last position - fixes #26863 by @kubaflo in #26868 * Fixes Setting BackgroundColor to null does not actually changes BackgroundColor - fixes #22914 and #19576 by @jgonzalez-gft in #22917 * Fixed the picker title's color - fixes #16737 by @kubaflo in #23075 * [android] Fallback to default icons in SearchHandler by @aheubusch in #25067 * ScrollView's Background on iOS - fixes #24016 by @kubaflo in #25541 * [iOS] Enabled MultiTouch Support for Handling Multi-Touch Points in GraphicsView - fixes #29461 by @prakashKannanSf3972 in #29895 * Optimize converters for GridLength, ColumnDefinition, and RowDefinition - performance improvement by @emiller in #20048 * Add defensive IsAlive check to Android ViewExtensions.OnUnloaded - fixes #28051 by @jfversluis in #29934 * [Windows] Fixed runtime update issue for SearchBar PlaceholderColor and BackgroundColor - fixes #29962 by @Tamilarasan-Paranthaman in #29965 * Weak subscription to CanExecuteChange events - fixes #16124 by @sneumaier in #29837 * [iOS, Mac] Fix for downsized image retaining original dimensions in GraphicsView - fixes #30006 by @SyedAbdulAzeemSF4852 in #30007 * [Android] Prevent Picker from Gaining Focus on Touch - fixes #19739, #8546, #13503, #24862, #28121, #21704, #15394 by @bhavanesh2001 in #29068 * Fix CV1 GridItemsLayout centering single item AND Fix Empty view not resizing when bounds change - fixes #29595, #29634 by @albyrock87 in #29639 ### Testing * [Testing] Feature Matrix UITest Cases for Button by @TamilarasanSF4853 in #29803 * [Testing] Feature matrix UITest Cases for BoxView Control by @HarishKumarSF4517 in #29808 * [Testing] Enable HandlerDoesNotLeak for Button and ProgressBar by @bhavanesh2001 in #29896 * [Testing] Add Validation Test For Issue28051 On Android by @prakashKannanSf3972 in #30026 * [Testing] Fixed Test case failure in PR 30115 - [2025/06/23] Candidate by @HarishKumarSF4517 in #30136 ### Dependency Updates * Bump to 1.7.250606001 of WindowsAppSDK by @sneumaier in #29915 ### Housekeeping * [housekeeping] Update namespaces in HostApp and Shared tests projects by @bhavanesh2001 in #29904 * Update SetterSpecificity.cs Remove Extra Line From Bad Merge by @sneumaier in #29987 * Revert - Fixed the Label not sized correctly on Android by @Ahamed-Ali in #30023 * Revert "Fixes Setting BackgroundColor to null does not actually changes BackgroundColor #22914 (#22917)" by @mattleibow in #30031 * [create-pull-request] automated change by @github-actions[bot] in #30019 * [create-pull-request] automated change by @github-actions[bot] in #30043 * [create-pull-request] automated change by @github-actions[bot] in #30078 * Update Controls.TestCases.HostApp.csproj by @HarishKumarSF4517 in #30124 ## New Contributors * @albyrock87 made their first contribution in #29639 * @SyedAbdulAzeemSF4852 made their first contribution in #30007 * @emiller made their first contribution in #20048 * @jgonzalez-gft made their first contribution in #22917 * @aheubusch made their first contribution in #25067 **Full Changelog**: https://github.com/dotnet/maui/compare/main..inflight/candidate
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.
Description of Change
This pull request introduces a mechanism for managing and cleaning up command event subscriptions when the lifetime of the
ICommand
instance exceeds that of the XAML element it's assigned to.Example from the Unit Tests
This largerly comes up with scenarios using static viewmodels or if people are using reference bindings. The key changes include the addition of a
WeakCommandSubscription
class, updates to theICommandElement
interface, and new unit tests to verify the functionality.Memory Management Enhancements:
Added
WeakCommandSubscription
class: Introduced a new class to manage weak references to command subscriptions, ensuring that event handlers do not prevent garbage collection of associated objects. This includes theCommandCanExecuteSubscription
inner class for handlingCanExecuteChanged
events. (src/Controls/src/Core/WeakCommandSubscription.cs
)Updated
ICommandElement
interface: Added aCleanupTracker
property to manage the lifecycle of command subscriptions. (src/Controls/src/Core/ICommandElement.cs
)Integrated
WeakCommandSubscription
in controls: Implemented theCleanupTracker
property in multiple controls (Button
,ImageButton
,MenuItem
,RefreshView
,SearchBar
) to utilize the new subscription management system. [1] [2] [3] [4] [5]Command Handling Improvements:
CommandElement
static class: UpdatedOnCommandChanging
andOnCommandChanged
methods to use theCleanupTracker
for disposing of old subscriptions and creating new ones. (src/Controls/src/Core/CommandElement.cs
)Unit Testing Enhancements:
New tests for garbage collection: Added tests to ensure that controls with commands can be garbage collected properly and that weak event handlers are not collected prematurely. (
src/Controls/tests/Core.UnitTests/ButtonUnitTest.cs
)Improved garbage collection helper: Enhanced the
TestHelpers.Collect
method to force multiple garbage collection cycles and ensure deterministic behavior during testing. (src/Controls/tests/Core.UnitTests/TestHelpers.cs
)These changes collectively improve the robustness of command handling in the library while addressing potential memory management issues.
Concerns
CommandCanExecuteSubscription
. The commandelement itself will cleanup without the finalizer. One approach we could take here would be to track these and then just clean them up every so often.Other Notes
Issues Fixed
Fixes #16124