[keyvault/azsecrets] make azsecrets.Client thread-safe #24032
Conversation
This file contains 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
strager
requested review from
chlowell,
jhendrixMSFT and
gracewilcox
as code owners
github-actions
bot
added
Community Contribution
|
Thank you for your contribution @strager! We will review the pull request and get back to you soon. |
strager
commented
Jan 31, 2025
| serverAuthenticateRequests := atomic.Int32{} | ||
| serverAuthenticatedRequests := atomic.Int32{} | ||
| var srv *httptest.Server | ||
| srv = httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { |
There was a problem hiding this comment.
Other tests use mock.Server, but here I used httptest.Server for two reasons:
mock.Serveris documented to not be safe when used from multiple goroutines.- Even if
mock.Serverwas safe at a surface level (e.g. by adding locks), its interface doesn't allow me to handle out-of-order requests.
httptest.Server has its own issues, but it seemed like the least amount of code to get the test working.
| require.GreaterOrEqual(t, int(serverAuthenticateRequests.Load()), 1, "client should have sent at least one preflight request") | ||
| require.LessOrEqual(t, int(serverAuthenticateRequests.Load()), concurrentRequestCount, "client should have sent no more preflight requests than client requests") | ||
| require.EqualValues(t, concurrentRequestCount, serverAuthenticatedRequests.Load(), "client preflight request count should equal server preflight request count") | ||
| } |
There was a problem hiding this comment.
The real assertion is the -race flag of go test. The three assertions in the test just make sure the test issued the requests, so they're not doing too much. Should I make the assertions more sophisticated? Is there a way to document that this test is designed to work with -race?
| @@ -7,6 +7,7 @@ | |||
| ### Breaking Changes | |||
|
|
|||
| ### Bugs Fixed | |||
| * Fixed data race when using Client from multiple goroutines concurrently. | |||
There was a problem hiding this comment.
Should we reference issue numbers here?
gracewilcox
reviewed
Jan 31, 2025
azsecrets.Client uses NewKeyVaultChallengePolicy. This policy is not
goroutine-safe, violating the documented requirement that policies are
goroutine-safe [1]. This leads to data races which are reported by Go's race
detector.
Fix NewKeyVaultChallengePolicy to be goroutine-safe using a mutex. This can lead
to redundant preflight requests, but at least Go's race detector no longer
complains.
Test plan:
$ cd sdk/security/keyvault/internal/
$ go test -race
[1] https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-core-concepts
strager
force-pushed
the
keyvault-thread-safety
branch
from
3d3cf5c to
7adba6e
Compare
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.
azsecrets.Client uses NewKeyVaultChallengePolicy. This policy is not goroutine-safe, violating the documented requirement that policies are goroutine-safe [1]. This leads to data races which are reported by Go's race detector.
Fix NewKeyVaultChallengePolicy to be goroutine-safe using a mutex. This can lead to redundant preflight requests, but at least Go's race detector no longer complains.
Test plan:
Fixes #24031.
[1] https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-core-concepts