-
Notifications
You must be signed in to change notification settings - Fork 55
feat: Add built-in HTTP activity for standalone SDK #697
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
YunchuWang
wants to merge
2
commits into
microsoft:main
Choose a base branch
from
YunchuWang:feature/builtin-http-activity
base: main
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
2 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
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,196 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System.Net; | ||
| using System.Net.Http; | ||
| using System.Text; | ||
| using Microsoft.Extensions.Logging; | ||
|
|
||
| namespace Microsoft.DurableTask.Http; | ||
|
|
||
| /// <summary> | ||
| /// Built-in activity that executes HTTP requests for the standalone Durable Task SDK. | ||
| /// This enables <c>CallHttpAsync</c> to work without the Azure Functions host. | ||
| /// </summary> | ||
| internal sealed class BuiltInHttpActivity : TaskActivity<DurableHttpRequest, DurableHttpResponse> | ||
| { | ||
| readonly HttpClient httpClient; | ||
| readonly ILogger logger; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="BuiltInHttpActivity"/> class. | ||
| /// </summary> | ||
| /// <param name="httpClient">The HTTP client to use for requests.</param> | ||
| /// <param name="logger">The logger.</param> | ||
| public BuiltInHttpActivity(HttpClient httpClient, ILogger logger) | ||
| { | ||
| this.httpClient = httpClient ?? throw new ArgumentNullException(nameof(httpClient)); | ||
| this.logger = logger ?? throw new ArgumentNullException(nameof(logger)); | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public override async Task<DurableHttpResponse> RunAsync( | ||
| TaskActivityContext context, DurableHttpRequest request) | ||
| { | ||
| if (request == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(request)); | ||
| } | ||
|
|
||
| if (request.TokenSource != null) | ||
| { | ||
| throw new NotSupportedException( | ||
| "TokenSource-based authentication is not supported in standalone mode. " + | ||
| "Pass authentication tokens directly via the request Headers dictionary instead."); | ||
| } | ||
|
|
||
| this.logger.LogInformation( | ||
| "Executing built-in HTTP activity: {Method} {Uri}", | ||
| request.Method, | ||
| request.Uri); | ||
|
|
||
| HttpResponseMessage response = await this.ExecuteWithRetryAsync(request); | ||
|
|
||
| string? body = response.Content != null | ||
| ? await response.Content.ReadAsStringAsync() | ||
| : null; | ||
|
|
||
| IDictionary<string, string>? responseHeaders = MapResponseHeaders(response); | ||
|
|
||
| this.logger.LogInformation( | ||
| "Built-in HTTP activity completed: {Method} {Uri} → {StatusCode}", | ||
| request.Method, | ||
| request.Uri, | ||
| (int)response.StatusCode); | ||
|
|
||
| return new DurableHttpResponse(response.StatusCode) | ||
| { | ||
| Headers = responseHeaders, | ||
| Content = body, | ||
| }; | ||
| } | ||
|
|
||
| async Task<HttpResponseMessage> ExecuteWithRetryAsync(DurableHttpRequest request) | ||
| { | ||
| HttpRetryOptions? retryOptions = request.HttpRetryOptions; | ||
| int maxAttempts = retryOptions?.MaxNumberOfAttempts ?? 1; | ||
| if (maxAttempts < 1) | ||
| { | ||
| maxAttempts = 1; | ||
| } | ||
|
|
||
| TimeSpan delay = retryOptions?.FirstRetryInterval ?? TimeSpan.Zero; | ||
| DateTime deadline = retryOptions != null && retryOptions.RetryTimeout < TimeSpan.MaxValue | ||
| ? DateTime.UtcNow + retryOptions.RetryTimeout | ||
| : DateTime.MaxValue; | ||
|
|
||
| HttpResponseMessage? lastResponse = null; | ||
|
|
||
| for (int attempt = 1; attempt <= maxAttempts; attempt++) | ||
| { | ||
| using HttpRequestMessage httpRequest = BuildHttpRequest(request); | ||
|
|
||
| using var cts = new CancellationTokenSource(); | ||
| if (request.Timeout.HasValue) | ||
| { | ||
| cts.CancelAfter(request.Timeout.Value); | ||
| } | ||
|
|
||
| lastResponse?.Dispose(); | ||
| lastResponse = await this.httpClient.SendAsync(httpRequest, cts.Token); | ||
|
|
||
| // Check if we should retry | ||
| bool isLastAttempt = attempt >= maxAttempts || DateTime.UtcNow >= deadline; | ||
| if (isLastAttempt || !IsRetryableStatus(lastResponse.StatusCode, retryOptions)) | ||
| { | ||
| return lastResponse; | ||
| } | ||
|
|
||
| this.logger.LogWarning( | ||
| "HTTP request to {Uri} returned {StatusCode}, retrying (attempt {Attempt}/{MaxAttempts})", | ||
| request.Uri, | ||
| (int)lastResponse.StatusCode, | ||
| attempt, | ||
| maxAttempts); | ||
|
|
||
| lastResponse.Dispose(); | ||
| lastResponse = null; | ||
|
|
||
| await Task.Delay(delay); | ||
|
|
||
| // Calculate next delay with exponential backoff | ||
| double coefficient = retryOptions?.BackoffCoefficient ?? 1; | ||
| delay = TimeSpan.FromTicks((long)(delay.Ticks * coefficient)); | ||
|
|
||
| TimeSpan maxInterval = retryOptions?.MaxRetryInterval ?? TimeSpan.FromDays(6); | ||
| if (delay > maxInterval) | ||
| { | ||
| delay = maxInterval; | ||
| } | ||
| } | ||
|
|
||
| // Should not reach here, but return last response as a safety net | ||
| return lastResponse!; | ||
| } | ||
|
|
||
| static HttpRequestMessage BuildHttpRequest(DurableHttpRequest request) | ||
| { | ||
| var httpRequest = new HttpRequestMessage(request.Method, request.Uri); | ||
|
|
||
| if (request.Content != null) | ||
| { | ||
| httpRequest.Content = new StringContent(request.Content, Encoding.UTF8, "application/json"); | ||
| } | ||
|
|
||
| if (request.Headers != null) | ||
| { | ||
| foreach (KeyValuePair<string, string> header in request.Headers) | ||
| { | ||
| // Try request headers first, then content headers | ||
| if (!httpRequest.Headers.TryAddWithoutValidation(header.Key, header.Value)) | ||
| { | ||
| httpRequest.Content?.Headers.TryAddWithoutValidation(header.Key, header.Value); | ||
| } | ||
| } | ||
|
Comment on lines
+140
to
+154
|
||
| } | ||
|
|
||
| return httpRequest; | ||
| } | ||
|
|
||
| static bool IsRetryableStatus(HttpStatusCode statusCode, HttpRetryOptions? retryOptions) | ||
| { | ||
| if (retryOptions == null) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| if (retryOptions.StatusCodesToRetry.Count > 0) | ||
| { | ||
| return retryOptions.StatusCodesToRetry.Contains(statusCode); | ||
| } | ||
|
|
||
| // Default: retry all 4xx and 5xx | ||
| int code = (int)statusCode; | ||
| return code >= 400; | ||
| } | ||
|
|
||
| static IDictionary<string, string>? MapResponseHeaders(HttpResponseMessage response) | ||
| { | ||
| var headers = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase); | ||
|
|
||
| foreach (KeyValuePair<string, IEnumerable<string>> header in response.Headers) | ||
| { | ||
| headers[header.Key] = string.Join(", ", header.Value); | ||
| } | ||
|
|
||
| if (response.Content?.Headers != null) | ||
| { | ||
| foreach (KeyValuePair<string, IEnumerable<string>> header in response.Content.Headers) | ||
| { | ||
| headers[header.Key] = string.Join(", ", header.Value); | ||
| } | ||
| } | ||
|
|
||
| return headers.Count > 0 ? headers : null; | ||
| } | ||
| } | ||
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,67 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System.Text.Json; | ||
| using System.Text.Json.Serialization; | ||
|
|
||
| namespace Microsoft.DurableTask.Http.Converters; | ||
|
|
||
| /// <summary> | ||
| /// JSON converter for HTTP header dictionaries. Handles both single-value strings and | ||
| /// string arrays (takes the last value for simplicity since <see cref="DurableHttpResponse.Headers"/> | ||
| /// is <c>IDictionary<string, string></c>). | ||
| /// </summary> | ||
| internal sealed class HttpHeadersConverter : JsonConverter<IDictionary<string, string>> | ||
| { | ||
| /// <inheritdoc/> | ||
| public override IDictionary<string, string> Read( | ||
| ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) | ||
| { | ||
| var headers = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase); | ||
|
|
||
| if (reader.TokenType != JsonTokenType.StartObject) | ||
| { | ||
| return headers; | ||
| } | ||
|
|
||
|
Comment on lines
+17
to
+26
|
||
| while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) | ||
| { | ||
| string propertyName = reader.GetString()!; | ||
| reader.Read(); | ||
|
|
||
| if (reader.TokenType == JsonTokenType.String) | ||
| { | ||
| headers[propertyName] = reader.GetString()!; | ||
| } | ||
| else if (reader.TokenType == JsonTokenType.StartArray) | ||
| { | ||
| string? lastValue = null; | ||
| while (reader.Read() && reader.TokenType != JsonTokenType.EndArray) | ||
| { | ||
| lastValue = reader.GetString(); | ||
| } | ||
|
|
||
| if (lastValue != null) | ||
| { | ||
| headers[propertyName] = lastValue; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return headers; | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public override void Write( | ||
| Utf8JsonWriter writer, IDictionary<string, string> value, JsonSerializerOptions options) | ||
| { | ||
| writer.WriteStartObject(); | ||
|
|
||
| foreach (KeyValuePair<string, string> pair in value) | ||
| { | ||
| writer.WriteString(pair.Key, pair.Value); | ||
| } | ||
|
|
||
| writer.WriteEndObject(); | ||
| } | ||
| } | ||
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,27 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System.Net.Http; | ||
| using System.Text.Json; | ||
| using System.Text.Json.Serialization; | ||
|
|
||
| namespace Microsoft.DurableTask.Http.Converters; | ||
|
|
||
| /// <summary> | ||
| /// JSON converter for <see cref="HttpMethod"/>. | ||
| /// </summary> | ||
| internal sealed class HttpMethodConverter : JsonConverter<HttpMethod> | ||
| { | ||
| /// <inheritdoc/> | ||
| public override HttpMethod Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) | ||
| { | ||
| string value = reader.GetString() ?? string.Empty; | ||
| return new HttpMethod(value); | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public override void Write(Utf8JsonWriter writer, HttpMethod value, JsonSerializerOptions options) | ||
| { | ||
| writer.WriteStringValue(value.ToString()); | ||
| } | ||
| } |
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.
When
HttpRetryOptionsis provided butFirstRetryIntervalis left at its default (TimeSpan.Zero), retries will occur back-to-back with no delay (and exponential backoff will never increase it from zero). Consider validatingFirstRetryIntervalwhenMaxNumberOfAttempts > 1, or applying a small, non-zero default delay to avoid tight retry loops.