avoid stack trace cost via exception when#4099
Open
SimonCropp wants to merge 6 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Refactors broad catch (Exception) blocks across core SqlClient components to use exception filters (catch (...) when (...)) so non-catchable exceptions bypass the handler, reducing overhead and avoiding unnecessary catch/rethrow paths.
Changes:
- Replaces
catch (Exception) { if (!IsCatchable) throw; ... }patterns withcatch (...) when (ADP.IsCatchableExceptionType(...))(orIsCatchableOrSecurityExceptionType) across the driver. - Simplifies selected exception-handling branches (e.g., transient retry, transaction cleanup) while keeping behavior consistent for catchable vs. non-catchable exceptions.
- Splits
SqlQueryMetadataCachehandling into filtered “expected exception” vs. “unexpected exception” catch blocks.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsParserStateObject.cs | Uses exception filters for Deactivate/timeout attention failure paths. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsParser.cs | Applies exception filters to attention/login/transaction-manager error handling. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlQueryMetadataCache.cs | Uses filtered catch for expected key-decrypt failures; separates unexpected exceptions. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlParameter.cs | Filters catchable exceptions before wrapping conversion failures. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlMetaDataFactory.cs | Filters catchable exceptions before wrapping query execution failure. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlInternalTransaction.cs | Filters catchable exceptions around zombie/commit/rollback/save error paths. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlDependencyUtils.cs | Filters catchable exceptions while invalidating dependencies (user callbacks). |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlDependencyListener.cs | Filters catchable exceptions in listener setup/restart/teardown resiliency paths. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlDependency.cs | Filters catchable exceptions in Start/Stop flows (including duplicate-start cleanup). |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlDataReader.cs | Filters catchable exceptions for sync buffer ops and async Task.FromException paths. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlConnection.cs | Filters catchable/security exceptions in InfoMessage event invocation. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.cs | Filters catchable/security exceptions in StatementCompleted event invocation. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Xml.cs | Filters catchable exceptions for XML reader completion and async state cleanup. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Reader.cs | Filters catchable exceptions during reader finish/metadata initialization cleanup. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.NonQuery.cs | Filters catchable/security exceptions for async state object cleanup in BeginExecuteNonQuery. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlBulkCopy.cs | Filters catchable exceptions during dispose cleanup and value conversion. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Server/ValueUtilsSmi.cs | Filters catchable exceptions around reader string/chars transfer fallback. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/ManagedSni/SniTcpHandle.netcore.cs | Refactors connection retry exception handling to use filters for retry eligibility. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/ConnectionPool/WaitHandleDbConnectionPool.cs | Filters catchable exceptions in pooled connection creation and background create requests. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Connection/SqlConnectionInternal.cs | Uses exception filters for transient retry and connection deactivate/login failure handling. |
…gedSni/SniTcpHandle.netcore.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
paulmedynski
requested changes
Apr 22, 2026
github-project-automation
Bot
moved this from In review
to In progress
in SqlClient Board
Contributor
|
@SimonCropp - Some conflicts to resolve here. |
…ost-via-exception-when
Member
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
cheenamalhotra
added
Author attention needed
paulmedynski
removed
the
Author attention needed
paulmedynski
added
the
Code Health 💊
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #4099 +/- ##
==========================================
- Coverage 66.04% 65.87% -0.18%
==========================================
Files 275 279 +4
Lines 42976 66029 +23053
==========================================
+ Hits 28383 43495 +15112
- Misses 14593 22534 +7941
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
cheenamalhotra
previously approved these changes
May 12, 2026
paulmedynski
added
the
Author attention needed
Contributor
|
Hi @SimonCropp - Are you able to make the changes I suggested? |
…stack-trace-cost-via-exception-when
Contributor
|
/azp run |
paulmedynski
removed
the
Author attention needed
|
Azure Pipelines successfully started running 2 pipeline(s). |
paulmedynski
previously approved these changes
May 20, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 20 out of 20 changed files in this pull request and generated 4 comments.
Comments suppressed due to low confidence (1)
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsParser.cs:9528
- Same readability issue here: the comment sits between the
catch (Exception e)header and thewhen (...)filter. Please move the comment inside the catch body (or above the catch) and keepcatch (Exception e) when (...)together to improve clarity/consistency.
catch (Exception e)
// UNDONE - should not be catching all exceptions!!!
when (ADP.IsCatchableExceptionType(e))
…g, clean up formatting
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
paulmedynski
approved these changes
May 21, 2026
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.
No description provided.