Add support for SqlConnectionOverrides for OpenAsync() API

[cheenamalhotra]

As the name suggests, introduces new API:

public Task SqlConnection.OpenAsync(SqlConnectionOverrides overrides, CancellationToken cancellationToken);

Previously, we skipped addiing overrides to OpenAsync in PR #463 due to no transient fault handling, but with recent PR #1983 we now enable transient fault handling by default for OpenAsync() too.

To support fail fast behavior in OpenAsync(), we need to allow passing SqlConnectionOverrides in OpenAsync() too.

Additional context:
dotnet/efcore#33399
#29

[mdaigle]

Based on my current understanding, the existing default is to not apply transient fault handling for OpenAsync. This changes the default to applying transient fault handling.

It seems like there are two options if we want to make a change now:

1. modify this change to retain the current default behavior
2. do this change, but only apply it on a new (major?) version

However, given what we've learned about the slow, serial nature of OpenAsync, part of me feels like we should wait to do this change until general async performance is improved.

I would advocate for waiting.

[DavoudEshtehari]

@cheenamalhotra Could you wrap this up for the preview 1 with the outstanding comments? Generally, this looks good to me and I'd rather not pushing it to the next preview.

[cheenamalhotra]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[cheenamalhotra]

This had to be moved here as in async flow, connection attempt happens on another thread and the value gets reset very quickly to be captured again when retry is attempted. So fail fast wasn't really working. This change makes sure the value gets reset after the login flow is complete.

cc @David-Engel for second set of eyes

[codecov]

Codecov Report

Attention: Patch coverage is 90.00000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 72.44%. Comparing base (7ec6310) to head (906fa0f).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...c/Microsoft/Data/SqlClient/SqlConnectionFactory.cs	0.00%	1 Missing ⚠️
...c/Microsoft/Data/SqlClient/SqlConnectionFactory.cs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2433      +/-   ##
==========================================
- Coverage   72.48%   72.44%   -0.04%     
==========================================
  Files         288      288              
  Lines       59493    59497       +4     
==========================================
- Hits        43122    43104      -18     
- Misses      16371    16393      +22     

Flag	Coverage Δ
addons	92.58% <ø> (ø)
netcore	75.37% <90.00%> (-0.04%)	⬇️
netfx	70.92% <90.00%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.