Repository navigation
Add async Always Encrypted key cache (1/5) - #5077
cheenamalhotra wants to merge 3 commits into
Conversation
Extract the cache foundation from #4585 with per-key async loading, cancellation, and shared sync/async publication. Relocate cache regressions into focused cache tests. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🔵 Needs a closer look
Human verification is needed because the current PR identity, feedback and CI evidence, and a trusted revision of supplemental review policies were not established.
No open issues 🎉
What changed in this PR
Adds the asynchronous Always Encrypted symmetric-key cache foundation for #3672, as the first of five layers split from #4585. Command execution integration is deferred; this layer changes no public APIs or dependencies.
Changes:
- Adds per-key load gates, cancellable waits, and concurrent uncached loads when the cache lifetime is zero.
- Shares sync/async cache publication while serializing provider invocation without holding the gate during outstanding async I/O.
- Adds 16 unit tests covering cache reuse, cancellation, retries, provider serialization, and publication races.
| File | Description |
|---|---|
src/Microsoft.Data.SqlClient/tests/UnitTests/Utilities/SymmetricKeyCacheTestProviders.cs |
Adds observable synchronous and asynchronous test providers. |
src/Microsoft.Data.SqlClient/tests/UnitTests/Utilities/PendingDecryptionKeyStoreProvider.cs |
Adds a controllable provider for overlapping decryption tests. |
src/Microsoft.Data.SqlClient/tests/UnitTests/TestIsolationCollections.cs |
Isolates tests that change the process-wide cache lifetime. |
src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/AlwaysEncrypted/SymmetricKeyCacheTests.cs |
Adds async cache behavior and concurrency regression coverage. |
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/AlwaysEncrypted/SymmetricKeyCache.cs |
Implements async loading, per-key coordination, and shared cache publication. |
Review effort: Balanced
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Avoid repeating decryption when a synchronous caller publishes the key while an async caller waits for the provider gate. Cover the race with a deterministic regression test. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #5077 +/- ##
==========================================
+ Coverage 68.99% 70.07% +1.08%
==========================================
Files 314 314
Lines 45857 69893 +24036
==========================================
+ Hits 31638 48981 +17343
- Misses 14219 20912 +6693
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Description
Layer 1/5 of the split of #4585: async symmetric-key cache foundation only. Adds per-key load gates, cancellable waits, cache-disabled concurrency, and shared sync/async publication. Provider invocation remains serialized without holding the gate across outstanding async I/O.
Extracted from source head
5f1b860410426f8c1af3eb55bfac0e7354bd2ac7onto main foundation2bda3c9edb53ce59589cdd401f10ae4415f331a5, preserving newer main changes. Source deviations: explanatory synchronization comments and a self-review fix to recheck the cache after acquiring the provider gate. That avoids redundant decryption and possible provider failure when a sync caller publishes while an async caller waits.Execution-path integration follows in later layers; no public API or dependency changes.
Issues
Relates to #3672. Split from #4585; neither issue nor original PR is closed by this layer.
Testing
Moved all source
GetKeyAsync_*coverage intoSymmetricKeyCacheTests, including sync/async identity, cancellation, provider serialization, failed-owner retry, and zero-TTL concurrency. Split behavior-switch theories and combined scenarios into separate facts; provider fixtures live under UnitTests/Utilities. Added a regression for synchronous publication while async waits for the provider gate.Commands run on macOS after the self-review fix:
The new race regression failed before the fix with the redundant provider-call exception, then passed in both suites above:
No SQL Server integration tests or Windows/.NET Framework runtime tests were run. This layer has no execution-path callers yet; server coverage belongs with integration layers.
Guidelines
Please review the contribution guidelines before submitting a pull request: