Dispose IServiceScope when window is destroyed to prevent memory leaks #30196

Copilot · 2025-06-25T12:00:06Z

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

Description

This PR implements proper disposal of IServiceScope instances when windows are destroyed, addressing a memory leak where window-scoped services were never being disposed.

Problem

Currently, .NET MAUI creates window-scoped service scopes in MauiContextExtensions.MakeWindowScope() but never disposes them when the associated window is closed or destroyed. This leads to memory leaks for services registered with scoped lifetime.

The issue was marked with a TODO comment in the code:

// TODO: We need to dispose of these services once the window closes
scope = mauiContext.Services.CreateScope();

Solution

Added scope tracking to MauiContext: Added internal methods SetWindowScope() and DisposeWindowScope() to track the window-scoped service scope
Updated MakeWindowScope: Modified to store the created scope in the MauiContext for later disposal
Added disposal logic: Updated Window.Destroying() to dispose the scope before disconnecting the handler
Maintained API compatibility: Used internal methods to avoid breaking public API surface

Testing

Added comprehensive tests to verify:

Service scopes are properly disposed when windows are destroyed
Null safety when no scope is present
Full integration with the window creation flow
Scoped service lifetime behavior

All existing tests continue to pass (53 window-related tests ✅).

Example Usage

The fix is transparent to users - no code changes required. Services registered with scoped lifetime will now be properly disposed when windows are destroyed:

// Services registered like this will now be properly disposed
services.AddScoped<MyWindowScopedService>();

Fixes #8538.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot

Pull Request Overview

This PR addresses a memory leak in .NET MAUI by implementing proper disposal of window-scoped service scopes when windows are destroyed. Previously, service scopes created for windows were never disposed, leading to memory leaks for scoped services.

Added internal scope tracking methods to MauiContext to store and dispose window scopes
Modified window destruction flow to dispose service scopes before disconnecting handlers
Added comprehensive tests to verify scope disposal behavior and integration

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File	Description
`src/Core/src/MauiContextExtensions.cs`	Updates `MakeWindowScope` to store the created scope in the context for later disposal
`src/Core/src/MauiContext.cs`	Adds internal methods `SetWindowScope()` and `DisposeWindowScope()` to track window-scoped service scopes
`src/Controls/tests/Core.UnitTests/WindowsTests.cs`	Adds comprehensive tests for scope disposal functionality and edge cases
`src/Controls/src/Core/Window/Window.cs`	Implements scope disposal in `IWindow.Destroying()` before handler disconnection

Comments suppressed due to low confidence (2)

src/Controls/tests/Core.UnitTests/WindowsTests.cs:796

This test validates scope disposal by checking for ObjectDisposedException, but it should also verify that the MauiContext.DisposeWindowScope() method was actually called. Consider adding a mock or spy to verify the disposal method invocation.

			Assert.Throws<ObjectDisposedException>(() => scope.ServiceProvider.GetService<TestScopedService>());

src/Controls/tests/Core.UnitTests/WindowsTests.cs:774

The test creates a service scope manually but doesn't test the actual window creation flow through MakeWindowScope(). Consider testing the complete integration by using MakeWindowScope() to create the window context as it would be used in production.

			var serviceCollection = new ServiceCollection();

rmarinho · 2025-08-07T10:22:56Z

/azp run

azure-pipelines · 2025-08-07T10:23:17Z

Azure Pipelines successfully started running 3 pipeline(s).

rmarinho · 2025-08-08T13:30:11Z

src/Core/src/MauiContext.cs

 	{
 		readonly WrappedServiceProvider _services;
 		readonly Lazy<IMauiHandlersFactory> _handlers;
+		IServiceScope? _windowScope;


Should this be a WeakReference ?

@rmarinho no, the service scope's life is already tied to the window, it's not something that's just going to naturally finalize and dispose.

Having this here doesn't cause a memory leak

Using a WeakReference here wouldn't be appropriate because we need to maintain a strong reference to the scope to ensure proper disposal. If we used a WeakReference, the scope could be garbage collected before we dispose it, potentially causing memory leaks. The scope needs to stay alive until we explicitly dispose it when the window is destroyed.

PureWeen · 2025-08-13T06:21:38Z

src/Core/src/MauiContext.cs

+
+		internal void DisposeWindowScope()
+		{
+			_windowScope?.Dispose();


@copilot set this to null after using this

Done! Set _windowScope = null after disposal to clear the reference. Commit: c0f7dc0

PureWeen · 2025-08-13T06:55:11Z

src/Controls/src/Core/Window/Window.cs

+			// Dispose the window-scoped service scope
+			if (Handler?.MauiContext is MauiContext mauiContext)
+				mauiContext.DisposeWindowScope();
+


@copilot change this block to be like this

var mauiContext = Handler?.MauiContext as MauiContext; Handler?.DisconnectHandler(); // Dispose the window-scoped service scope mauiContext?.DisposeWindowScope();

we want to call mauiContext.DisposeWindowScope(); after we call Handler?disconnecthandler

Done! Changed the order of operations as requested - now we get the MauiContext reference first, disconnect the handler, and then dispose the scope. Commit: 6f1b547

Copilot · 2025-08-13T07:15:13Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

services.gradle.org

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com> # Conflicts: # src/Controls/tests/Core.UnitTests/WindowsTests.cs

Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>

…r disconnecting handler Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>

PureWeen · 2025-08-13T07:53:08Z

/azp run

azure-pipelines · 2025-08-13T07:54:03Z

Azure Pipelines successfully started running 3 pipeline(s).

rmarinho · 2025-08-13T15:14:45Z

@PureWeen can the failure tests be related?

Copilot AI assigned Copilot and PureWeen Jun 25, 2025

Copilot started work on behalf of PureWeen June 25, 2025 12:00 View session

Copilot AI changed the title ~~[WIP] IServiceScope should get disposed when the associated window is destroyed or closed~~ Dispose IServiceScope when window is destroyed to prevent memory leaks Jun 25, 2025

Copilot AI requested a review from PureWeen June 25, 2025 12:19

Copilot finished work on behalf of PureWeen June 25, 2025 12:19

PureWeen force-pushed the copilot/fix-8538 branch from 4b18b04 to 1175419 Compare August 4, 2025 19:45

PureWeen changed the base branch from main to net10.0 August 4, 2025 19:45

PureWeen marked this pull request as ready for review August 4, 2025 19:45

Copilot AI review requested due to automatic review settings August 4, 2025 19:45

PureWeen requested a review from a team as a code owner August 4, 2025 19:45

PureWeen requested a review from rmarinho August 4, 2025 19:45

PureWeen added this to the .NET 10.0-rc1 milestone Aug 4, 2025

PureWeen added this to MAUI SDK Ongoing Aug 4, 2025

github-project-automation bot moved this to Todo in MAUI SDK Ongoing Aug 4, 2025

PureWeen moved this from Todo to Ready To Review in MAUI SDK Ongoing Aug 4, 2025

Copilot AI reviewed Aug 4, 2025

View reviewed changes

dotnet deleted a comment from azure-pipelines bot Aug 7, 2025

dotnet deleted a comment from jsuarezruiz Aug 7, 2025

PureWeen added p/0 Work that we can't release without platform/macos macOS / Mac Catalyst platform/windows platform/android area-core-lifecycle XPlat and Native UIApplicationDelegate/Activity/Window lifecycle events platform/ios labels Aug 7, 2025

rmarinho reviewed Aug 8, 2025

View reviewed changes

PureWeen reviewed Aug 13, 2025

View reviewed changes

Copilot started work on behalf of PureWeen August 13, 2025 06:21 View session

Copilot AI requested a review from PureWeen August 13, 2025 06:39

Copilot finished work on behalf of PureWeen August 13, 2025 06:39

PureWeen reviewed Aug 13, 2025

View reviewed changes

Copilot started work on behalf of PureWeen August 13, 2025 06:55 View session

Copilot finished work on behalf of PureWeen August 13, 2025 07:15

Copilot AI requested a review from PureWeen August 13, 2025 07:15

Copilot AI and others added 5 commits August 13, 2025 02:48

Initial plan

ebf14c9

Implement IServiceScope disposal when window is destroyed

89e5382

Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com> # Conflicts: # src/Controls/tests/Core.UnitTests/WindowsTests.cs

Add comprehensive tests for service scope disposal

752c836

Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>

Set _windowScope to null after disposal as requested in PR feedback

e2a04ac

Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>

Change order of operations in Window.Destroying to dispose scope afte…

146f4ba

…r disconnecting handler Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>

PureWeen force-pushed the copilot/fix-8538 branch from 356e45d to 146f4ba Compare August 13, 2025 07:53

rmarinho approved these changes Aug 13, 2025

View reviewed changes

github-project-automation bot moved this from Ready To Review to Approved in MAUI SDK Ongoing Aug 13, 2025

PureWeen merged commit 719dc33 into net10.0 Aug 14, 2025
129 checks passed

PureWeen deleted the copilot/fix-8538 branch August 14, 2025 21:31

github-project-automation bot moved this from Approved to Done in MAUI SDK Ongoing Aug 14, 2025

github-actions bot locked and limited conversation to collaborators Sep 14, 2025

Dispose IServiceScope when window is destroyed to prevent memory leaks #30196

Dispose IServiceScope when window is destroyed to prevent memory leaks #30196

Conversation

Copilot AI commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Problem

Solution

Testing

Example Usage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

rmarinho commented Aug 7, 2025

Uh oh!

azure-pipelines bot commented Aug 7, 2025

Uh oh!

rmarinho Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

PureWeen Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

PureWeen Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

PureWeen Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Aug 13, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

PureWeen commented Aug 13, 2025

Uh oh!

azure-pipelines bot commented Aug 13, 2025

Uh oh!

rmarinho commented Aug 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jun 25, 2025 •

edited

Loading