Skip to content

[iOS] Don't destroy an already destroyed window in WillTerminate - #40452

Merged
kubaflo merged 3 commits into
dotnet:candidate/11.0.1xx-sr2from
MykhailoDav:fix-40438-ios-terminate-destroyed-window
Nov 20, 2026
Merged

kubaflo merged 3 commits into
dotnet:candidate/11.0.1xx-sr2from
MykhailoDav:fix-40438-ios-terminate-destroyed-window

Conversation

@MykhailoDav

Copy link
Copy Markdown
Contributor

Description of Change

An iOS app that sets MainPage and has a scene manifest crashes with InvalidOperationException: Window was already destroyed every time the user swipes it away in the app switcher.

When the scene disconnects, SceneDidDisconnect calls Destroying() on the window. Application.RemoveWindow returns early for the MainPage window, so that window, already destroyed, stays in Application.Windows. UIKit then calls applicationWillTerminate, and the WillTerminate handler calls app.GetWindow()?.Destroying() on it a second time. Its comment assumes GetWindow() is null by then, which isn't true for MainPage apps.

WillTerminate now skips a window whose handler is already disconnected, which is what Destroying() leaves behind. If terminate arrives without a prior scene disconnect, the window is still destroyed. I chose this over the !HasSceneManifest() guard the neighbouring handlers use because it depends on the window's state, not on Info.plist.

#24191 was closed with "use CreateWindow", but the scene manifest is now in the .NET 11 templates and required by the iOS 27 SDK, so every app that still uses MainPage hits this crash on force-close.

Tests

WindowTests.WillTerminateDestroysMainPageWindowOnce (Controls device test, Window category, iOS and Mac Catalyst) sets MainPage, connects the window, optionally calls Destroying() as SceneDidDisconnect does, then runs the registered WillTerminate handlers. It checks that nothing throws and that Destroying runs exactly once in both cases.

On the iPhone 17 simulator (iOS 26.5), Window category: 53/57 without the fix (the 4 failures are the scene-disconnect cases, with the same stack as the issue), 57/57 with it. Application 1/1 and Lifecycle 9/9 with the fix.

Before / after (sandbox app with MainPage set, Release build, swiped away in the app switcher with Appium; the app logs a line after MAUI's own handlers finish). There's no video because the app disappears either way.

Before:

[KeyWindow] Scene will invalidate: UIWindowScene ...
[40438] SceneDidDisconnect handlers finished
*** Terminating app due to uncaught exception 'System.InvalidOperationException', reason: 'Window was already destroyed (System.InvalidOperationException)
   at Microsoft.Maui.Controls.Window.Microsoft.Maui.IWindow.Destroying()
   at Microsoft.Maui.LifecycleEvents.AppHostBuilderExtensions.<>c.<OnConfigureLifeCycle>b__2_1(UIApplication app)
   at Microsoft.Maui.MauiUIApplicationDelegate.WillTerminate(UIApplication application)

After:

[KeyWindow] Scene will invalidate: UIWindowScene ...
[40438] SceneDidDisconnect handlers finished
[40438] WillTerminate handlers finished

xcrun simctl terminate kills the process without calling applicationWillTerminate, so it doesn't reproduce this. Not checked: Mac Catalyst (no local workload) and a physical device.

Issues Fixed

Fixes #40438

kubaflo and others added 3 commits November 19, 2026 19:25
…r/DragLeave (dotnet#40441)

<!-- Please let the below note in for people that find this PR -->
> [!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](https://github.com/dotnet/maui/wiki/Testing-PR-Builds) from
this PR and let us know in a comment if this change resolves your issue.
Thank you!

<!--
Open .NET 11 fix PRs against net11 for review; target main for
next-major features.
After approval, a maintainer manually retargets the fix PR to the active
inflight
branch and merges it directly there. Do not merge individual fixes into
net11.
Bots must not retarget or merge. Candidate integration into net11 and
release/*
changes are separate, explicitly coordinated release work.
-->

### Target Branch

| This PR is for | Initial base |
| --- | --- |
| New features, API changes, or .NET 12 work (including .NET 12 fixes) |
`main` |
| .NET 11 servicing fixes | `net11`, for review |
| Older servicing, release integration, infrastructure, or documentation
| The branch designated for that work |

- [x] I selected the applicable base branch using the [contribution
guide](https://github.com/dotnet/maui/blob/main/.github/CONTRIBUTING.md#choose-your-pr-base-before-starting).

For .NET 11 fixes, only a maintainer retargets the approved PR to the
active
inflight lane and merges it after CI validates that final base. Do not
merge
individual fixes directly into `net11`; agents must not retarget or
merge.

### Description of Change

On iOS, `DragEventArgs.GetPosition()` can throw a
`NullReferenceException` inside a `DragOver` or `DragLeave` handler. The
exception crashes the app.

**CI evidence.** The `DropEventCoordinates` UI test crashed the HostApp
on both attempts on the iOS CoreCLR lane of SR2 candidate dotnet#40116
(maui-pr-uitests
[1690394](https://dev.azure.com/dnceng-public/public/_build/results?buildId=1690394),
iOS latest Editor..Fr job). The job's `.ips` reports show SIGABRT from
`xamarin_process_managed_exception` under `-[UIDropInteraction
_dragDestinationGestureStateChanged:]`. The logarchive shows the managed
exception:

```
System.NullReferenceException
  at DragAndDropDelegate.CalculatePosition(IElement, WeakReference, WeakReference)
  at DragAndDropBetweenLayouts.OnDragOver(...)        // HostApp calls e.GetPosition(...)
  at DragAndDropDelegate.<HandleDragOver>...
  at DragAndDropDelegate.SendEventArgs(...)
  at DragAndDropDelegate.HandleDragOver(...)
  at DragAndDropDelegate.SessionDidUpdate(...)
```

**Root cause.**
- `SessionDidUpdate` and `SessionDidExit` pass
`session.LocalDragSession`, a transient managed wrapper of the native
local drag session, into `HandleDragOver` and `HandleDragLeave`.
- Those methods put only a `WeakReference` to it in the `GetPosition`
callback, and nothing else on the path keeps it alive:
`PlatformDragEventArgs` holds the outer `IUIDropSession`, not the local
drag session.
- A GC while the user's handler is running can therefore collect the
wrapper. `CalculatePosition` then calls `LocationInView` on a null
session.
- Separately, `HandleDragOver` built a weak reference even when
`LocalDragSession` is null (a drag from another app), so `GetPosition`
always threw in that case. `HandleDragLeave` and `HandleDrop` already
return null there.

The weak references date from 2023, and the code is identical on
`net11`, the candidate and `main`. This is a latent bug that the CoreCLR
lane's GC timing exposed, not a candidate regression.

**Fix** (`DragAndDropDelegate.cs`, iOS/Mac Catalyst):
- `HandleDragOver` and `HandleDragLeave` call `GC.KeepAlive(session)`
after dispatching to the recognizers. The session stays alive while
handlers can synchronously call `GetPosition`, and the event args still
don't hold it strongly.
- `HandleDragOver` uses a null `sessionRef` when there is no local drag
session, matching `HandleDragLeave` and `HandleDrop`.
- `CalculatePosition` returns `null` when the session reference is
missing or its target has already been collected, instead of
dereferencing null. This covers a `GetPosition` call made after the
handler returns.

**Tests** (`DragAndDropTests.iOS.cs`, `Gesture` category):
- `DragPositionIsAvailableAfterGarbageCollectionDuringHandler(dragLeave:
false/true)`: a fake drop session returns a fresh local drag session
wrapper each time, the handler forces a full GC and then calls
`GetPosition`, and the test asserts the fake session's location.
- `DragOverPositionIsNullWithoutLocalDragSession`: with no local drag
session, `GetPosition` in `DragOver` returns `null`.

**Validation** (iOS 18.5 simulator, Release, CoreCLR, the same runtime
as the failing CI lane):

| Command | Result |
| --- | --- |
| `pwsh .github/skills/run-device-tests/scripts/Run-DeviceTests.ps1
-Project Controls -Platform ios -TestFilter "Category=Gesture"
-DeviceUdid <iOS 18.5 sim> -SkipXcodeVersionCheck` with only the new
tests (no fix) | **Failed**: 45 passed, 3 failed. All three new cases
throw `NullReferenceException` at
`DragAndDropDelegate.CalculatePosition`, the same frame as the CI crash.
|
| Same command with the fix | **Passed**: 48 passed, 0 failed |
| `dotnet format whitespace --folder --include <changed files>
--verify-no-changes` | Passed |

The UI test itself was not rerun locally, because its crash depends on
when a GC happens.

### Issues Fixed

No existing issue; found while investigating SR2 candidate dotnet#40116 CI.
Searched for related issues and PRs and found no duplicate.
dotnet#28416/dotnet#28417 is an unrelated Mac Catalyst `DragAndDropDelegate` NRE.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.sh | bash -s -- 40452

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.ps1) } 40452"

@dotnet-policy-service dotnet-policy-service Bot added the community ✨ Community Contribution label Nov 19, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Hey there @MykhailoDav! Thank you so much for your PR! Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@azure-pipelines

This comment has been minimized.

@kubaflo

This comment has been minimized.

@github-actions github-actions Bot added the s/agent-review-in-progress AI review is currently running for this PR label Nov 19, 2026
@MauiBot

MauiBot commented Nov 19, 2026

Copy link
Copy Markdown
Collaborator

PR Test Gate

@MykhailoDav — existing-test verification; Setup did not capture a tested commit.

Result INCONCLUSIVE Platform iOS


🧪 Gate analysis — click to expand

⚠ Inconclusive. Setup, build, or execution did not produce a conclusive result. This does not prove the fix is incorrect.

No interpretable test-group summary was produced. No additional test execution is inferred.

Setup did not capture a verified PR head; no commit is claimed as tested.

No immutable without-fix baseline was prepared.

@MauiBot MauiBot removed the s/agent-review-in-progress AI review is currently running for this PR label Nov 19, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Expert Review — 0 findings

Reviewed commit 6074706.

@kubaflo
kubaflo changed the base branch from net11 to candidate/11.0.1xx-sr2 November 20, 2026 19:12
@kubaflo
kubaflo merged commit d5925a3 into dotnet:candidate/11.0.1xx-sr2 Nov 20, 2026
44 checks passed

This branch was previously deployed

1 inactive deployment
copilot-pat-pool — 60747069 Deployed Nov 19, 2026 by MykhailoDav via conclusion #3150
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-controls-window Window community ✨ Community Contribution platform/ios platform/macos macOS / Mac Catalyst

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants