Repository navigation
[Async AE 1] Add async key cache - #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 stays serialized without holding the gate across outstanding async I/O.
Extracted from source head
5f1b860410426f8c1af3eb55bfac0e7354bd2ac7onto main2bda3c9edb53ce59589cdd401f10ae4415f331a5, preserving newer main changes. Execution-path integration follows in later layers; no public API or dependency changes.Changes added while addressing review feedback:
_publicationLockand_pendingKeyLoadsare needed.LoadKeyAsyncrechecks the cache after acquiring the provider gate, so a key published by a sync caller during the wait is reused instead of decrypted again (which could fail).Issues
Relates to #3672. Split from #4585; neither is closed by this layer.
Testing
All source
GetKeyAsync_*coverage moved toSymmetricKeyCacheTests(sync/async identity, cancellation, provider serialization, failed-owner retry, zero-TTL concurrency), plus a regression for sync publication while async waits. Provider fixtures live under UnitTests/Utilities.Local (macOS, head
16919af):The race regression (
GetKeyAsync_SynchronousOwnerPublishesWhileWaiting_ReusesPublishedKey) failed before the fix and passes after.CI:
This PR: sqlclient-pr build 192526 on
16919af; all 39 checks pass.Full stack: [Async AE 5] Load enclave keys asynchronously and route package retries #5085 build 192590 on
aa9fadbf(includes this layer). UnitTests: Linux net10 2668 passed / 0 failed; Windows net10 2692 / 0; net462 2588 / 0; simulated-server tests ran and no stack tests were skipped. AE manual tests: 246 passed / 0 failed; only enclave tests skipped (no enclave server in CI).Tests added or updated
Public API changes documented (none)
Verified against customer repro (not applicable to this foundation layer)
Ensure no breaking changes introduced
Guidelines
Please review the contribution guidelines before submitting a pull request: