Skip to content

Cleanup | AsyncHelpers Generic State #3705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open

Cleanup | AsyncHelpers Generic State #3705

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
8383e19
Extract AsyncHelper from SqlUtil.cs into the utilities namespace
benrr101 Oct 10, 2025
8119c0c
Add generic ContinueTaskWithState - and it's static the whole way thr…
benrr101 Oct 10, 2025
3df7400
Use generic version where not difficult
benrr101 Oct 11, 2025
6500240
Add stateful version of CreateContinuationTask
benrr101 Oct 11, 2025
f4eea9f
Introduce stateless version that chains into the stateful version
benrr101 Oct 11, 2025
8450aaa
Introduce two-generic ContinueTaskWithState
benrr101 Oct 14, 2025
547af51
Introduce two-generic CreateContinuationTaskWithState
benrr101 Oct 14, 2025
847fd25
Replacing usages that didn't show up before?
benrr101 Oct 15, 2025
cb6d1f9
Make non-generic ContinueTaskWithState private, remove exteernal usag…
benrr101 Oct 16, 2025
dd48b59
Rewrite CreateContinuationTask
benrr101 Oct 16, 2025
5b29b7f
Remove seemingly duplicated CreateContinuationTask overload
benrr101 Oct 16, 2025
153b764
Remove the non-generic CreateContinuationTaskWithState overload
benrr101 Oct 16, 2025
3584c99
Rewrite SetTimeoutException
benrr101 Oct 16, 2025
14fed23
SetTimeoutExceptionWithState
benrr101 Oct 16, 2025
7684fe7
Cleanup WaitForCompletion
benrr101 Oct 16, 2025
da6ef3c
Add reference to Moq in unit test project
benrr101 Oct 20, 2025
f8ccc85
Adding tests
benrr101 Oct 20, 2025
45ef372
Removing exception converter from state-less continue task helper
benrr101 Oct 20, 2025
0e3250f
Adding null task cases for CreateContinuationTask
benrr101 Oct 20, 2025
aabd04f
Migrating SqlHelperTest in functional tests to AsyncHelper in unit tests
benrr101 Oct 22, 2025
ba65f50
Address copilot comments, address unobserved exception issue that bre…
benrr101 Oct 22, 2025
453197e
Merge branch 'main' into dev/russellben/asynchelper-generic-state
benrr101 Oct 27, 2025
db584d7
Addressing a couple bits of PR comments
benrr101 Oct 27, 2025
2340c83
Address PR comments
benrr101 Oct 30, 2025
e20f118
Merge branch 'main' into dev/russellben/asynchelper-generic-state
benrr101 Oct 30, 2025
76770ef
Increase timeout and ensure no stack dives on task completion
benrr101 Oct 31, 2025
c7d06b9
*Try*Set everything, add comment as per PR comment
benrr101 Oct 31, 2025
2035cf5
Tweak comments, add logging to unovserved exception observation, incr…
benrr101 Nov 3, 2025
bbc9193
Fix syntax error
benrr101 Nov 4, 2025
3560027
Only trace the event if tracing is enabled (should've read the comments)
benrr101 Nov 4, 2025
8ae7470
Merge branch 'main' into dev/russellben/asynchelper-generic-state
benrr101 Nov 6, 2025
3f5cfa9
Make sure mockOnCancellation is checked on one test, reorder a couple…
benrr101 Nov 6, 2025
10f39c9
Fix tests that don't correspond to their method name
benrr101 Nov 11, 2025
e2a1027
Merge branch 'main' into dev/russellben/asynchelper-generic-state
benrr101 Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
<PackageVersion Include="Microsoft.SqlServer.Types" Version="160.1000.6" />
<PackageVersion Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.19.5" />
<PackageVersion Include="Microsoft.Win32.Registry" Version="5.0.0" />
<PackageVersion Include="Moq" Version="4.20.72" />
<PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
<PackageVersion Include="System.Data.Odbc" Version="9.0.9" />
<PackageVersion Include="System.Security.Principal.Windows" Version="5.0.0" />
Expand Down
3 changes: 3 additions & 0 deletions src/Microsoft.Data.SqlClient/netcore/src/Microsoft.Data.SqlClient.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -762,6 +762,9 @@
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\SSPI\SspiAuthenticationParameters.cs">
<Link>Microsoft\Data\SqlClient\SSPI\SspiAuthenticationParameters.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\Utilities\AsyncHelper.cs">
<Link>Microsoft\Data\SqlClient\Utilities\AsyncHelper.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\Utilities\ObjectPool.cs">
<Link>Microsoft\Data\SqlClient\Utilities\ObjectPool.cs</Link>
</Compile>
Expand Down
38 changes: 19 additions & 19 deletions src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlCommand.netcore.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
using System.Data.Common;
using System.Data.SqlTypes;
using System.Diagnostics;
using System.IO;
using System.Runtime.CompilerServices;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Data.Common;
using Microsoft.Data.SqlClient.Diagnostics;
using Microsoft.Data.SqlClient.Utilities;

// NOTE: The current Microsoft.VSDesigner editor attributes are implemented for System.Data.SqlClient, and are not publicly available.
// New attributes that are designed to work with Microsoft.Data.SqlClient and are publicly documented should be included in future.
Expand Down Expand Up @@ -1334,41 +1334,45 @@ private SqlDataReader GetParameterEncryptionDataReader(out Task returnTask, Task
SqlDataReader describeParameterEncryptionDataReader,
ReadOnlyDictionary<_SqlRPC, _SqlRPC> describeParameterEncryptionRpcOriginalRpcMap, bool describeParameterEncryptionNeeded, bool isRetry)
{
returnTask = AsyncHelper.CreateContinuationTaskWithState(fetchInputParameterEncryptionInfoTask, this,
(object state) =>
// @TODO: Why use the with state version if we can't make the lambda static?
returnTask = AsyncHelper.CreateContinuationTaskWithState(
taskToContinue: fetchInputParameterEncryptionInfoTask,
state: this,
onSuccess: this2 =>
{
SqlCommand command = (SqlCommand)state;
bool processFinallyBlockAsync = true;
bool decrementAsyncCountInFinallyBlockAsync = true;

try
{
// Check for any exceptions on network write, before reading.
command.CheckThrowSNIException();
this2.CheckThrowSNIException();

// If it is async, then TryFetchInputParameterEncryptionInfo-> RunExecuteReaderTds would have incremented the async count.
// Decrement it when we are about to complete async execute reader.
SqlInternalConnectionTds internalConnectionTds = command._activeConnection.GetOpenTdsConnection();
SqlInternalConnectionTds internalConnectionTds = this2._activeConnection.GetOpenTdsConnection();
if (internalConnectionTds != null)
{
internalConnectionTds.DecrementAsyncCount();
decrementAsyncCountInFinallyBlockAsync = false;
}

// Complete executereader.
describeParameterEncryptionDataReader = command.CompleteAsyncExecuteReader(isInternal: false, forDescribeParameterEncryption: true);
Debug.Assert(command._stateObj == null, "non-null state object in PrepareForTransparentEncryption.");
describeParameterEncryptionDataReader = this2.CompleteAsyncExecuteReader(
isInternal: false,
forDescribeParameterEncryption: true);
Debug.Assert(this2._stateObj == null, "non-null state object in PrepareForTransparentEncryption.");

// Read the results of describe parameter encryption.
command.ReadDescribeEncryptionParameterResults(describeParameterEncryptionDataReader, describeParameterEncryptionRpcOriginalRpcMap, isRetry);
this2.ReadDescribeEncryptionParameterResults(describeParameterEncryptionDataReader, describeParameterEncryptionRpcOriginalRpcMap, isRetry);

#if DEBUG
#if DEBUG
// Failpoint to force the thread to halt to simulate cancellation of SqlCommand.
if (_sleepAfterReadDescribeEncryptionParameterResults)
{
Thread.Sleep(10000);
}
#endif
#endif
}
catch (Exception e)
{
Expand All @@ -1377,22 +1381,18 @@ private SqlDataReader GetParameterEncryptionDataReader(out Task returnTask, Task
}
finally
{
command.PrepareTransparentEncryptionFinallyBlock(closeDataReader: processFinallyBlockAsync,
this2.PrepareTransparentEncryptionFinallyBlock(
closeDataReader: processFinallyBlockAsync,
decrementAsyncCount: decrementAsyncCountInFinallyBlockAsync,
clearDataStructures: processFinallyBlockAsync,
wasDescribeParameterEncryptionNeeded: describeParameterEncryptionNeeded,
describeParameterEncryptionRpcOriginalRpcMap: describeParameterEncryptionRpcOriginalRpcMap,
describeParameterEncryptionDataReader: describeParameterEncryptionDataReader);
}
},
onFailure: static (Exception exception, object state) =>
onFailure: static (this2, exception) =>
{
SqlCommand command = (SqlCommand)state;
if (command.CachedAsyncState != null)
{
command.CachedAsyncState.ResetAsyncState();
}

this2.CachedAsyncState?.ResetAsyncState();
if (exception != null)
{
throw exception;
Expand Down
1 change: 1 addition & 0 deletions ...Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlInternalConnectionTds.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
using Microsoft.Data.Common.ConnectionString;
using Microsoft.Data.ProviderBase;
using Microsoft.Data.SqlClient.ConnectionPool;
using Microsoft.Data.SqlClient.Utilities;
using Microsoft.Identity.Client;

namespace Microsoft.Data.SqlClient
Expand Down
3 changes: 3 additions & 0 deletions src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,6 +957,9 @@
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\TdsValueSetter.cs">
<Link>Microsoft\Data\SqlClient\TdsValueSetter.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\Utilities\AsyncHelper.cs">
<Link>Microsoft\Data\SqlClient\Utilities\AsyncHelper.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\Utilities\BufferWriterExtensions.netfx.cs">
<Link>Microsoft\Data\SqlClient\Utilities\BufferWriterExtensions.netfx.cs</Link>
</Compile>
Expand Down
114 changes: 57 additions & 57 deletions src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/SqlCommand.netfx.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,20 @@
// See the LICENSE file in the project root for more information.

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Data;
using System.Data.Common;
using System.Data.SqlTypes;
using System.Diagnostics;
using System.IO;
using System.Runtime.CompilerServices;
using System.Runtime.ConstrainedExecution;
using System.Security.Permissions;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Data.Common;
using System.Collections.Concurrent;
using Microsoft.Data.SqlClient.Utilities;

// NOTE: The current Microsoft.VSDesigner editor attributes are implemented for System.Data.SqlClient, and are not publicly available.
// New attributes that are designed to work with Microsoft.Data.SqlClient and are publicly documented should be included in future.
Expand Down Expand Up @@ -1249,69 +1248,70 @@ private void PrepareForTransparentEncryption(
// Mark that we should not process the finally block since we have async execution pending.
// Note that this should be done outside the task's continuation delegate.
processFinallyBlock = false;
returnTask = AsyncHelper.CreateContinuationTask(fetchInputParameterEncryptionInfoTask, () =>
{
bool processFinallyBlockAsync = true;
bool decrementAsyncCountInFinallyBlockAsync = true;

try
returnTask = AsyncHelper.CreateContinuationTask(
taskToContinue: fetchInputParameterEncryptionInfoTask,
onSuccess: () =>
{
// Check for any exceptions on network write, before reading.
CheckThrowSNIException();
bool processFinallyBlockAsync = true;
bool decrementAsyncCountInFinallyBlockAsync = true;

// If it is async, then TryFetchInputParameterEncryptionInfo-> RunExecuteReaderTds would have incremented the async count.
// Decrement it when we are about to complete async execute reader.
SqlInternalConnectionTds internalConnectionTds = _activeConnection.GetOpenTdsConnection();
if (internalConnectionTds != null)
try
{
internalConnectionTds.DecrementAsyncCount();
decrementAsyncCountInFinallyBlockAsync = false;
}
// Check for any exceptions on network write, before reading.
CheckThrowSNIException();

// If it is async, then TryFetchInputParameterEncryptionInfo-> RunExecuteReaderTds would have incremented the async count.
// Decrement it when we are about to complete async execute reader.
SqlInternalConnectionTds internalConnectionTds = _activeConnection.GetOpenTdsConnection();
if (internalConnectionTds != null)
{
internalConnectionTds.DecrementAsyncCount();
decrementAsyncCountInFinallyBlockAsync = false;
}

// Complete executereader.
describeParameterEncryptionDataReader = CompleteAsyncExecuteReader(isInternal: false, forDescribeParameterEncryption: true);
Debug.Assert(_stateObj == null, "non-null state object in PrepareForTransparentEncryption.");
// Complete executereader.
describeParameterEncryptionDataReader = CompleteAsyncExecuteReader(isInternal: false, forDescribeParameterEncryption: true);
Debug.Assert(_stateObj == null, "non-null state object in PrepareForTransparentEncryption.");

// Read the results of describe parameter encryption.
ReadDescribeEncryptionParameterResults(
describeParameterEncryptionDataReader,
describeParameterEncryptionRpcOriginalRpcMap,
isRetry);
// Read the results of describe parameter encryption.
ReadDescribeEncryptionParameterResults(
describeParameterEncryptionDataReader,
describeParameterEncryptionRpcOriginalRpcMap,
isRetry);

#if DEBUG
// Failpoint to force the thread to halt to simulate cancellation of SqlCommand.
if (_sleepAfterReadDescribeEncryptionParameterResults)
#if DEBUG
// Failpoint to force the thread to halt to simulate cancellation of SqlCommand.
if (_sleepAfterReadDescribeEncryptionParameterResults)
{
Thread.Sleep(10000);
}
#endif //DEBUG
}
catch (Exception e)
{
Thread.Sleep(10000);
processFinallyBlockAsync = ADP.IsCatchableExceptionType(e);
throw;
}
#endif //DEBUG
}
catch (Exception e)
{
processFinallyBlockAsync = ADP.IsCatchableExceptionType(e);
throw;
}
finally
{
PrepareTransparentEncryptionFinallyBlock(closeDataReader: processFinallyBlockAsync,
decrementAsyncCount: decrementAsyncCountInFinallyBlockAsync,
clearDataStructures: processFinallyBlockAsync,
wasDescribeParameterEncryptionNeeded: describeParameterEncryptionNeeded,
describeParameterEncryptionRpcOriginalRpcMap: describeParameterEncryptionRpcOriginalRpcMap,
describeParameterEncryptionDataReader: describeParameterEncryptionDataReader);
}
},
onFailure: ((exception) =>
{
if (CachedAsyncState != null)
{
CachedAsyncState.ResetAsyncState();
}
if (exception != null)
finally
{
PrepareTransparentEncryptionFinallyBlock(
closeDataReader: processFinallyBlockAsync,
decrementAsyncCount: decrementAsyncCountInFinallyBlockAsync,
clearDataStructures: processFinallyBlockAsync,
wasDescribeParameterEncryptionNeeded: describeParameterEncryptionNeeded,
describeParameterEncryptionRpcOriginalRpcMap:
describeParameterEncryptionRpcOriginalRpcMap,
describeParameterEncryptionDataReader: describeParameterEncryptionDataReader);
}
},
onFailure: exception =>
{
throw exception;
}
}));
CachedAsyncState?.ResetAsyncState();
if (exception != null)
{
throw exception;
}
});

decrementAsyncCountInFinallyBlock = false;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/SqlInternalConnectionTds.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Net.Http.Headers;
using System.Runtime.CompilerServices;
using System.Security;
using System.Text;
using System.Threading;
Expand All @@ -19,6 +18,7 @@
using Microsoft.Data.Common.ConnectionString;
using Microsoft.Data.ProviderBase;
using Microsoft.Data.SqlClient.ConnectionPool;
using Microsoft.Data.SqlClient.Utilities;
using Microsoft.Identity.Client;

namespace Microsoft.Data.SqlClient
Expand Down
Loading
Loading