Fix ObjectDisposedException when disposing session after client.StopAsync()#371
Open
parthtrivedi2492 wants to merge 1 commit intogithub:mainfrom
Open
Conversation
…sync() Make CopilotSession.DisposeAsync() idempotent and tolerant to already-disposed connections. This fixes the crash when 'await using var session' cleanup runs after client.StopAsync() has already disposed the connection. Changes: - Add _isDisposed flag with Interlocked.Exchange for thread-safe idempotency - Catch ObjectDisposedException and IOException during dispose (connection gone) - Add regression test to ClientTests Fixes github#306
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a double disposal bug where disposing a CopilotSession after calling client.StopAsync() would throw an ObjectDisposedException. The issue occurred because StopAsync() disposes all sessions, and then the await using cleanup would attempt to dispose the session again on an already-closed connection.
Changes:
- Added thread-safe idempotency to
CopilotSession.DisposeAsync()using an_isDisposedflag withInterlocked.Exchange - Added exception handling to gracefully handle disposal when the connection is already disposed
- Added a regression test to prevent this issue from recurring
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| dotnet/src/Session.cs | Implements idempotent disposal with thread-safe flag and exception handling for ObjectDisposedException and IOException |
| dotnet/test/ClientTests.cs | Adds regression test that reproduces the issue scenario: creating a session, calling StopAsync(), then allowing implicit disposal |
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
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.
Summary
Fixes #306
When
await client.StopAsync()is called before theawait using var sessiongoes out of scope,session.DisposeAsync()is called twice:StopAsync()(while connection is alive) ✓await usingcleanup (connection is now disposed) ✗ →ObjectDisposedExceptionRepro (from issue)
Solution
Make
CopilotSession.DisposeAsync()idempotent and tolerant to already-disposed connections:_isDisposedflag - Thread-safe usingInterlocked.ExchangeDisposeAsyncidempotent - Returns immediately if already disposed (required byIAsyncDisposablecontract)ObjectDisposedExceptionandIOExceptionsince dispose methods should never throwThis follows the same pattern already used in
CopilotClient.DisposeAsync().Changes
dotnet/src/Session.cs: Add idempotency and exception handling toDisposeAsync()dotnet/test/ClientTests.cs: Add regression testTesting