Conversation
…luelt API surface
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
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.
Improve HttpRequestBuilder fluent API, retries, and per-request logging
Summary
This PR expands
HttpRequestBuilderinto a more complete fluent request builder while keeping the existingAdd*methods available for compatibility.The main additions are:
WithRetry(...)WithUri(...)Patch,Head, andOptionsHttpContentfactoriesILoggersupport withWithLogger(...)and optionalWithLogScope(...)Notable Changes
Fluent API
HttpRequestBuilder(string uri)WithUri(string uri)Get,Post,Put,Patch, andDeletePatch,Head, andOptionsverb methodsWithBody,WithContent,WithHeader,WithBearerToken,WithAuthorization,WithCancellationToken, andWithJsonSerializerSettingsRetry Support
WithRetry(ResiliencePipeline<Response>)MakeRequestAsync()andMakeRequestAsync<T>()WithContent(Func<HttpContent>)/AddContent(Func<HttpContent>)so retries can create fresh request content per attemptLogging
WithLogger(ILogger logger)WithLogScope(Enums.LogScope logScope)WithLogger(...)defaults to logging all request activityWithLogScope(Enums.LogScope.OnlyFailedRequests)limits that request to failed response loggingHttpConfig.Loggerfor that requestRequest Handling
HttpResponseMessageis now disposed after response materializationAuthorizationis routed through typedAuthenticationHeaderValuehandlingAddQueryParamsnow acceptsIEnumerable<KeyValuePair<string, string>>Documentation
WithUriPatchHead/OptionsCompatibility Notes
Existing builder methods such as
AddBody,AddHeader,AddContent, andAddCancellationTokenremain available. They now delegate to the newerWith*methods where appropriate.The behavior of duplicate query/form parameters changed: duplicate keys are now preserved. This better matches common HTTP query string behavior, but it is worth calling out for consumers who relied on duplicate suppression.
Tests
Ran:
dotnet testResult: