CSHARP-5798: Implement test to track if any UnobservedTaskExceptions were raised while test run #1831
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
sanych-sun
added
the
chore
Contributor
There was a problem hiding this comment.
Pull request overview
This PR implements tracking for unobserved task exceptions during test execution to help identify tasks that complete with exceptions without proper handling. The implementation uses xUnit's extensibility to register a global handler that captures unobserved exceptions and verifies none occurred after all tests complete.
Key Changes
- Added custom xUnit test case and discoverer infrastructure to track
UnobservedTaskExceptionevents globally - Implemented a test that runs after all other tests to verify no unobserved exceptions were raised
- Fixed a race condition in
CSharp3302Testswhere an unhandled task was causing unobserved exceptions
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| UnobservedExceptionTrackingTestCase.cs | New test case class that registers/unregisters the UnobservedTaskException handler and stores exceptions in a static list |
| UnobservedExceptionTestDiscoverer.cs | New xUnit test discoverer and fact attribute to enable unobserved exception tracking |
| TimeoutEnforcingXunitTestAssemblyRunner.cs | Modified to run the unobserved exception tracking test after all other tests complete |
| UnobservedTaskExceptionTracking.cs | New test class that verifies no unobserved exceptions were captured during test execution |
| CSharp3302Tests.cs | Fixed to properly handle task cancellation to prevent unobserved exceptions |
| Cluster.cs | Added disposal check to prevent ObjectDisposedException from timer callback |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.../MongoDB.TestHelpers/XunitExtensions/TimeoutEnforcing/UnobservedExceptionTrackingTestCase.cs
Outdated
Show resolved
Hide resolved
.../MongoDB.TestHelpers/XunitExtensions/TimeoutEnforcing/UnobservedExceptionTrackingTestCase.cs
Outdated
Show resolved
Hide resolved
.../MongoDB.TestHelpers/XunitExtensions/TimeoutEnforcing/UnobservedExceptionTrackingTestCase.cs
Outdated
Show resolved
Hide resolved
Comment on lines
+47
to
+54
| { | ||
| return new TimeoutEnforcingXunitTestCollectionRunner(testCollection, testCases, DiagnosticMessageSink, messageBus, TestCaseOrderer, new ExceptionAggregator(Aggregator), cancellationTokenSource).RunAsync(); | ||
| } |
There was a problem hiding this comment.
[nitpick] The formatting change converts this to a multi-line method but the actual logic is still a single return statement. Consider keeping the expression-bodied member syntax => for consistency with the codebase style, or add meaningful logic to justify the block body.
Suggested change
| { | |
| return new TimeoutEnforcingXunitTestCollectionRunner(testCollection, testCases, DiagnosticMessageSink, messageBus, TestCaseOrderer, new ExceptionAggregator(Aggregator), cancellationTokenSource).RunAsync(); | |
| } | |
| => new TimeoutEnforcingXunitTestCollectionRunner(testCollection, testCases, DiagnosticMessageSink, messageBus, TestCaseOrderer, new ExceptionAggregator(Aggregator), cancellationTokenSource).RunAsync(); |
sanych-sun
requested review from
BorisDog
and removed request for
adelinowona
BorisDog
requested changes
Nov 28, 2025
.../MongoDB.TestHelpers/XunitExtensions/TimeoutEnforcing/UnobservedExceptionTrackingTestCase.cs
Outdated
Show resolved
Hide resolved
…were raised while test run
sanych-sun
force-pushed
the
csharp5798
branch
from
f0ea7f0 to
0620e0c
Compare
BorisDog
requested changes
Dec 3, 2025
tests/MongoDB.TestHelpers/XunitExtensions/TimeoutEnforcing/TimeoutEnforcingTestInvoker.cs
Outdated
Show resolved
Hide resolved
| public class UnobservedTaskExceptionTracking | ||
| { | ||
| [UnobservedExceptionTrackingFact] | ||
| public void EnsureNoUnobservedTaskException() |
Contributor
There was a problem hiding this comment.
So why don't we add this to BSON a well?
BorisDog
requested changes
Dec 5, 2025
| public class UnobservedTaskExceptionTracking | ||
| { | ||
| [UnobservedExceptionTrackingFact] | ||
| public void EnsureNoUnobservedTaskException() |
| return result; | ||
| } | ||
|
|
||
| private class UnobservedExceptionDebugger : IDisposable |
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.
No description provided.