-
Notifications
You must be signed in to change notification settings - Fork 53
Dts Grpc client retry support #403
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
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
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 |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using Grpc.Core; | ||
| using Grpc.Net.Client.Configuration; | ||
|
|
||
| namespace Microsoft.DurableTask; | ||
|
|
||
| /// <summary> | ||
| /// Provides default retry policy configurations for gRPC client connections. | ||
| /// </summary> | ||
| sealed class GrpcRetryPolicyDefaults | ||
| { | ||
| /// <summary> | ||
| /// Default maximum number of retry attempts. | ||
YunchuWang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /// </summary> | ||
| public const int DefaultMaxAttempts = 10; | ||
|
|
||
| /// <summary> | ||
| /// Default initial backoff in milliseconds. | ||
| /// </summary> | ||
| public const int DefaultInitialBackoffMs = 50; | ||
|
|
||
| /// <summary> | ||
| /// Default maximum backoff in milliseconds. | ||
| /// </summary> | ||
| public const int DefaultMaxBackoffMs = 250; | ||
|
|
||
| /// <summary> | ||
| /// Default backoff multiplier for exponential backoff. | ||
| /// </summary> | ||
| public const double DefaultBackoffMultiplier = 2; | ||
|
|
||
| /// <summary> | ||
| /// The default service configuration that includes the method configuration. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// This can be applied to a gRPC channel to enable automatic retries for all methods. | ||
| /// </remarks> | ||
| public static readonly ServiceConfig DefaultServiceConfig; | ||
|
|
||
|
|
||
| /// <summary> | ||
| /// The default retry policy for gRPC operations. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// - Retries only for Unavailable status codes (typically connection issues). | ||
| /// </remarks> | ||
| static readonly Grpc.Net.Client.Configuration.RetryPolicy Default; | ||
|
|
||
| /// <summary> | ||
| /// The default method configuration that applies the retry policy to all methods. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Uses MethodName.Default to apply the retry policy to all gRPC methods. | ||
| /// </remarks> | ||
| static readonly MethodConfig DefaultMethodConfig; | ||
|
|
||
| static GrpcRetryPolicyDefaults() | ||
| { | ||
| Default = new Grpc.Net.Client.Configuration.RetryPolicy | ||
| { | ||
| MaxAttempts = DefaultMaxAttempts, | ||
| InitialBackoff = TimeSpan.FromMilliseconds(DefaultInitialBackoffMs), | ||
| MaxBackoff = TimeSpan.FromMilliseconds(DefaultMaxBackoffMs), | ||
| BackoffMultiplier = DefaultBackoffMultiplier, | ||
| RetryableStatusCodes = { StatusCode.Unavailable }, | ||
| }; | ||
|
|
||
| DefaultMethodConfig = new MethodConfig | ||
| { | ||
| Names = { MethodName.Default }, | ||
| RetryPolicy = Default, | ||
| }; | ||
|
|
||
| DefaultServiceConfig = new ServiceConfig | ||
| { | ||
| MethodConfigs = { DefaultMethodConfig }, | ||
| }; | ||
| } | ||
| } | ||
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
34 changes: 34 additions & 0 deletions
34
test/Shared/AzureManaged.Tests/GrpcRetryPolicyDefaultsTests.cs
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 |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using FluentAssertions; | ||
| using Grpc.Core; | ||
| using Grpc.Net.Client.Configuration; | ||
| using Xunit; | ||
|
|
||
| namespace Microsoft.DurableTask.Tests; | ||
|
|
||
| public class GrpcRetryPolicyDefaultsTests | ||
| { | ||
| [Fact] | ||
| public void DefaultServiceConfig_ShouldHaveExpectedConfiguration() | ||
YunchuWang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| ServiceConfig serviceConfig = GrpcRetryPolicyDefaults.DefaultServiceConfig; | ||
|
|
||
| serviceConfig.Should().NotBeNull(); | ||
| serviceConfig.MethodConfigs.Should().HaveCount(1); | ||
|
|
||
| MethodConfig methodConfig = serviceConfig.MethodConfigs[0]; | ||
| methodConfig.Names.Should().Contain(MethodName.Default); | ||
| methodConfig.RetryPolicy.Should().NotBeNull(); | ||
|
|
||
| RetryPolicy? retryPolicy = methodConfig.RetryPolicy; | ||
| retryPolicy.Should().NotBeNull(); | ||
| _ = retryPolicy!.MaxAttempts.Should().Be(GrpcRetryPolicyDefaults.DefaultMaxAttempts); | ||
| retryPolicy.InitialBackoff.Should().Be(TimeSpan.FromMilliseconds(GrpcRetryPolicyDefaults.DefaultInitialBackoffMs)); | ||
| retryPolicy.MaxBackoff.Should().Be(TimeSpan.FromMilliseconds(GrpcRetryPolicyDefaults.DefaultMaxBackoffMs)); | ||
| retryPolicy.BackoffMultiplier.Should().Be(GrpcRetryPolicyDefaults.DefaultBackoffMultiplier); | ||
| retryPolicy.RetryableStatusCodes.Should().ContainSingle() | ||
| .Which.Should().Be(StatusCode.Unavailable); | ||
| } | ||
| } | ||
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.
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.
Uh oh!
There was an error while loading. Please reload this page.