feat: Prevent indefinite hang in ensure_initialized
#20
Conversation
This file contains hidden or 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
Problem: Requests could hang indefinitely within the `RemoteJwksDecoder::decode` method, specifically while awaiting `self.initialized.notified().await` inside `ensure_initialized`. This occurred even after the background refresh task had successfully fetched keys, populated the cache, and called `notify_waiters()`. Solution: Modify `ensure_initialized` to first check if the `keys_cache` is non-empty. If keys are already present, indicating a successful prior initialization or refresh, the function returns immediately without awaiting the `Notify` signal. The `notified().await` is now only used as a fallback mechanism if the cache is empty when the check occurs, preserving the original intent for the very first request synchronization. This ensures that once keys are successfully loaded, subsequent requests do not block unnecessarily on the potentially unreliable notification mechanism in this context.
bertybuttface
force-pushed
the
ensure-initialized-fix
branch
from
8bac981 to
8d01ee8
Compare
bertybuttface
changed the title
ensure_initializedensure_initialized
|
Thanks for the PR to fix this @bertybuttface! Much appreciated! |
cmackenzie1
approved these changes
Apr 3, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #20 +/- ##
==========================================
+ Coverage 62.62% 64.01% +1.39%
==========================================
Files 3 3
Lines 206 214 +8
==========================================
+ Hits 129 137 +8
Misses 77 77 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Released in v0.5.1 https://crates.io/crates/axum-jwt-auth/0.5.1 |
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.
Problem:
Requests could hang indefinitely within the
RemoteJwksDecoder::decodemethod, specifically while awaitingself.initialized.notified().awaitinsideensure_initialized. This occurred even after the background refresh task had successfully fetched keys, populated the cache, and callednotify_waiters().Solution:
Modify
ensure_initializedto first check if thekeys_cacheis non-empty. If keys are already present, indicating a successful prior initialization or refresh, the function returns immediately without awaiting theNotifysignal. Thenotified().awaitis now only used as a fallback mechanism if the cache is empty when the check occurs, preserving the original intent for the very first request synchronization.This ensures that once keys are successfully loaded, subsequent requests do not block unnecessarily on the potentially unreliable notification mechanism in this context.