-
Notifications
You must be signed in to change notification settings - Fork 371
Add optional parameter to configuration providers for non-blocking startup #1745
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
GeorgeTsiokos
wants to merge
5
commits into
dapr:master
Choose a base branch
from
GeorgeTsiokos:feature/optional-config-resilience
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f17d73f
Add optional parameter to configuration providers for non-blocking st…
GeorgeTsiokos d33da80
Add integration tests for optional configuration provider resilience
GeorgeTsiokos f99ca95
Merge branch 'master' into feature/optional-config-resilience
WhitWaldo 6557847
Merge branch 'master' into feature/optional-config-resilience
GeorgeTsiokos 96c20b8
Merge branch 'master' into feature/optional-config-resilience
WhitWaldo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,13 +26,14 @@ namespace Dapr.Extensions.Configuration; | |
| /// </summary> | ||
| internal class DaprConfigurationStoreProvider : ConfigurationProvider, IDisposable | ||
| { | ||
| private string store; | ||
| private IReadOnlyList<string> keys; | ||
| private DaprClient daprClient; | ||
| private TimeSpan sidecarWaitTimeout; | ||
| private bool isStreaming; | ||
| private IReadOnlyDictionary<string, string>? metadata; | ||
| private CancellationTokenSource cts; | ||
| private readonly string store; | ||
| private readonly IReadOnlyList<string> keys; | ||
| private readonly DaprClient daprClient; | ||
| private readonly TimeSpan sidecarWaitTimeout; | ||
| private readonly bool isStreaming; | ||
| private readonly bool isOptional; | ||
| private readonly IReadOnlyDictionary<string, string>? metadata; | ||
| private readonly CancellationTokenSource cts; | ||
| private Task subscribeTask = Task.CompletedTask; | ||
|
|
||
| /// <summary> | ||
|
|
@@ -44,30 +45,83 @@ internal class DaprConfigurationStoreProvider : ConfigurationProvider, IDisposab | |
| /// <param name="sidecarWaitTimeout">The <see cref="TimeSpan"/> used to configure the timeout waiting for Dapr.</param> | ||
| /// <param name="isStreaming">Determines if the source is streaming or not.</param> | ||
| /// <param name="metadata">Optional metadata sent to the configuration store.</param> | ||
| /// <param name="isOptional">When true, does not block startup waiting for the sidecar.</param> | ||
| public DaprConfigurationStoreProvider( | ||
| string store, | ||
| IReadOnlyList<string> keys, | ||
| DaprClient daprClient, | ||
| TimeSpan sidecarWaitTimeout, | ||
| bool isStreaming = false, | ||
| IReadOnlyDictionary<string, string>? metadata = default) | ||
| IReadOnlyDictionary<string, string>? metadata = default, | ||
| bool isOptional = false) | ||
| { | ||
| this.store = store; | ||
| this.keys = keys; | ||
| this.daprClient = daprClient; | ||
| this.sidecarWaitTimeout = sidecarWaitTimeout; | ||
| this.isStreaming = isStreaming; | ||
| this.isOptional = isOptional; | ||
| this.metadata = metadata ?? new Dictionary<string, string>(); | ||
| this.cts = new CancellationTokenSource(); | ||
| } | ||
|
|
||
| public void Dispose() | ||
| { | ||
| cts.Cancel(); | ||
| cts.Dispose(); | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public override void Load() => LoadAsync().ConfigureAwait(false).GetAwaiter().GetResult(); | ||
| public override void Load() | ||
| { | ||
| if (isOptional) | ||
| { | ||
| Data = new Dictionary<string, string?>(StringComparer.OrdinalIgnoreCase); | ||
| _ = Task.Run(() => LoadInBackgroundAsync()); | ||
| } | ||
|
Comment on lines
+75
to
+81
|
||
| else | ||
| { | ||
| LoadAsync().ConfigureAwait(false).GetAwaiter().GetResult(); | ||
| } | ||
| } | ||
|
|
||
| private async Task LoadInBackgroundAsync() | ||
| { | ||
| while (!cts.Token.IsCancellationRequested) | ||
| { | ||
| try | ||
| { | ||
| using var tokenSource = new CancellationTokenSource(sidecarWaitTimeout); | ||
| using var linked = CancellationTokenSource.CreateLinkedTokenSource(tokenSource.Token, cts.Token); | ||
| await daprClient.WaitForSidecarAsync(linked.Token); | ||
|
|
||
| await FetchDataAsync(); | ||
| OnReload(); | ||
| return; | ||
| } | ||
| catch (OperationCanceledException) when (cts.Token.IsCancellationRequested) | ||
| { | ||
| return; | ||
| } | ||
| catch (OperationCanceledException) | ||
| { | ||
| // Sidecar wait timed out — retry after delay. | ||
| } | ||
| catch (DaprException) | ||
| { | ||
| // Transient Dapr error — retry after delay. | ||
| } | ||
|
|
||
| try | ||
| { | ||
| await Task.Delay(sidecarWaitTimeout, cts.Token); | ||
| } | ||
| catch (OperationCanceledException) | ||
| { | ||
| return; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private async Task LoadAsync() | ||
| { | ||
|
|
@@ -77,6 +131,11 @@ private async Task LoadAsync() | |
| await daprClient.WaitForSidecarAsync(tokenSource.Token); | ||
| } | ||
|
|
||
| await FetchDataAsync(); | ||
| } | ||
|
|
||
| private async Task FetchDataAsync() | ||
| { | ||
| if (isStreaming) | ||
| { | ||
| subscribeTask = Task.Run(async () => | ||
|
Comment on lines
+137
to
141
|
||
|
|
||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dispose()cancels and disposes the sharedCancellationTokenSource, but background tasks started viaTask.Run(and the streaming subscription task) may still be executing and attempting to register withcts.Token. Disposing the CTS while work is still running can causeObjectDisposedExceptionraces inside token registration APIs. Consider storing the background task(s) and waiting for completion after cancellation (or avoid disposing the CTS if you can’t guarantee completion).