Support sync interface members & enum names by ChrisPulman · Pull Request #2068 · reactiveui/refit

ChrisPulman · 2026-03-25T09:26:19Z

What kind of change does this PR introduce?

fixes #2065 and #2067

What is the current behavior?

#2065
#2067

What is the new behavior?

Allow synchronous return types only for generated/non-public interface members by building a generated sync function path in RequestBuilderImplementation (BuildGeneratedSyncFuncForMethod, DeserializeSyncResponse).
Update RestMethodInfo to enforce the new rule. Enhance SystemTextJsonContentSerializer enum converter to map serialized names (including JsonStringEnumMemberName on .NET 9+) both ways and prefer annotated/serialized names when reading/writing.

Add tests (guarded by NET9_0_OR_GREATER) to validate JsonStringEnumMemberName behavior and a SyncCapableMockHttpMessageHandler for sync test scenarios.
Add a Blazor WebAssembly example (BlazorWasmIssue2065) demonstrating Refit usage and include it in the solution.

Enhance the System.Text.Json enum converter to attempt case-insensitive name lookups by adding a second names-to-values map using StringComparer.OrdinalIgnoreCase and making GetNamesToValues accept a comparer.
This makes deserialization resilient to case differences in incoming JSON.

Also update the BlazorWasm example project file: mark with IsPackable=false, bump Microsoft.AspNetCore.Components.WebAssembly packages from 10.0.0 to 10.0.5, and adjust file encoding.

What might this PR break?

Please check if the PR fulfills these requirements

Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Other information:

Allow synchronous return types only for generated/non-public interface members by building a generated sync function path in RequestBuilderImplementation (BuildGeneratedSyncFuncForMethod, DeserializeSyncResponse). Update RestMethodInfo to enforce the new rule. Enhance SystemTextJsonContentSerializer enum converter to map serialized names (including JsonStringEnumMemberName on .NET 9+) both ways and prefer annotated/serialized names when reading/writing. Add tests (guarded by NET9_0_OR_GREATER) to validate JsonStringEnumMemberName behavior and a SyncCapableMockHttpMessageHandler for sync test scenarios. Add a Blazor WebAssembly example (BlazorWasmIssue2065) demonstrating Refit usage and include it in the solution.

Enhance the System.Text.Json enum converter to attempt case-insensitive name lookups by adding a second names-to-values map using StringComparer.OrdinalIgnoreCase and making GetNamesToValues accept a comparer. This makes deserialization resilient to case differences in incoming JSON. Also update the BlazorWasm example project file: replace NoPack with IsPackable=false, bump Microsoft.AspNetCore.Components.WebAssembly packages from 10.0.0 to 10.0.5, and adjust file encoding.

codecov · 2026-03-25T16:09:32Z

Codecov Report

❌ Patch coverage is 74.89362% with 59 lines in your changes missing coverage. Please review.
✅ Project coverage is 81.16%. Comparing base (7251290) to head (6588d75).

Files with missing lines	Patch %	Lines
Refit/RequestBuilderImplementation.cs	68.10%	52 Missing and 7 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2068      +/-   ##
==========================================
- Coverage   82.48%   81.16%   -1.32%     
==========================================
  Files          38       38              
  Lines        2780     2878      +98     
  Branches      449      476      +27     
==========================================
+ Hits         2293     2336      +43     
- Misses        379      428      +49     
- Partials      108      114       +6

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR addresses two reported regressions/feature gaps: (1) enabling synchronous return shapes only for generated/non-public Refit interface members (avoiding problematic sync waits for normal/public APIs), and (2) improving System.Text.Json enum (de)serialization to support serialized/annotated enum member names (including JsonStringEnumMemberName on .NET 9+) with added case-insensitive matching. It also adds tests and a Blazor WASM example project demonstrating the scenarios from #2065 and #2067.

Changes:

Update Refit’s return-type enforcement to allow sync return types only for explicit interface members or non-public methods, and add a new sync execution path in RequestBuilderImplementation.
Enhance SystemTextJsonContentSerializer enum converter to round-trip annotated/serialized enum names and add case-insensitive name matching.
Add tests for JsonStringEnumMemberName behavior (NET9+) and add a Blazor WASM example project to the solution.

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
examples/BlazorWasmIssue2065/**	New Blazor WASM example demonstrating the reported issues and expected behavior.
Refit/SystemTextJsonContentSerializer.cs	Enum converter updated to support serialized/annotated names and case-insensitive lookup.
Refit/RestMethodInfo.cs	Enforces sync return types only for explicit interface members or non-public methods.
Refit/RequestBuilderImplementation.cs	Adds a new “generated sync” execution path for allowed sync members.
Refit.Tests/SerializedContentTests.cs	Adds NET9+ tests validating `JsonStringEnumMemberName` round-tripping and default converter usage.
Refit.Tests/ExplicitInterfaceRefitTests.cs	Adjusts tests to support sync execution scenarios.
Refit.sln	Includes the new Blazor WASM example in the solution.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Refit/RequestBuilderImplementation.cs

Copilot · 2026-03-25T16:13:49Z

Refit/SystemTextJsonContentSerializer.cs

+            readonly Dictionary<string, object> namesToValues = GetNamesToValues(
+                enumType,
+                StringComparer.Ordinal
+            );
+            readonly Dictionary<string, object> namesToValuesIgnoreCase = GetNamesToValues(
+                enumType,
+                StringComparer.OrdinalIgnoreCase
+            );


CamelCaseStringEnumConverter now adds a case-insensitive lookup map (namesToValuesIgnoreCase), but there are no tests covering the new behavior. Adding a test that deserializes an enum value with different casing (and asserting the correct member is chosen) would help prevent regressions, especially for enums where members differ only by case.

@copilot open a new pull request to apply changes based on this feedback

Copilot · 2026-03-25T16:17:26Z

@ChrisPulman I've opened a new pull request, #2069, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2026-03-25T16:18:23Z

@ChrisPulman I've opened a new pull request, #2070, to work on those changes. Once the pull request is ready, I'll request review from you.

…zation (#2069) * Initial plan * Add case-insensitive enum deserialization tests for CamelCaseStringEnumConverter Co-authored-by: ChrisPulman <4910015+ChrisPulman@users.noreply.github.com> Agent-Logs-Url: https://github.com/reactiveui/refit/sessions/457806a0-8430-40b3-8e4e-26f6590217ff --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ChrisPulman <4910015+ChrisPulman@users.noreply.github.com>

…ApiResponse, disposal) (#2070) * Initial plan * Fix sync pipeline to replicate full BuildCancellableTaskFuncForMethod behavior - Rewrite BuildGeneratedSyncFuncForMethod as a dispatcher that handles void return separately and delegates non-void to a new generic method. - Add BuildGeneratedSyncFuncForMethodGeneric<T,TBody> that mirrors the full async pipeline: runs ExceptionFactory (skipped for HttpResponseMessage), honours IsApiResponse, uses ShouldDisposeResponse for cleanup, and surfaces DeserializationExceptionFactory on deserialization errors. - Add DeserializeContentSync<T> handling all content types: HttpResponseMessage, HttpContent, Stream, string, and deserialised T. - Fix RestMethodInfo sync branch to properly decompose IApiResponse<T> / ApiResponse<T> return types, setting DeserializedResultType to the inner type just like the async Task<IApiResponse<T>> path does. - Add SyncVoid to ReturnTypeInfo enum and handle it in Parser.cs and Emitter.cs so void-returning sync stub methods emit a plain call instead of the invalid 'return (void)...' pattern. - Add comprehensive tests covering error responses, HttpResponseMessage, HttpContent, Stream, IApiResponse<T>, and void sync methods. Co-authored-by: ChrisPulman <4910015+ChrisPulman@users.noreply.github.com> Agent-Logs-Url: https://github.com/reactiveui/refit/sessions/7e184030-9d18-44ec-aff4-305b2c7e973d * Fix spelling: 'occured' -> 'occurred' in new sync error messages Co-authored-by: ChrisPulman <4910015+ChrisPulman@users.noreply.github.com> Agent-Logs-Url: https://github.com/reactiveui/refit/sessions/7e184030-9d18-44ec-aff4-305b2c7e973d --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ChrisPulman <4910015+ChrisPulman@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 22 out of 22 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-25T17:33:46Z

Refit/RequestBuilderImplementation.cs

+            var isExplicitInterfaceMember = restMethod.MethodInfo.Name.IndexOf('.') >= 0;
+            var isNonPublic = !restMethod.MethodInfo.IsPublic;
+            if (isExplicitInterfaceMember || isNonPublic)
+            {
+                return BuildGeneratedSyncFuncForMethod(restMethod);


BuildRestResultFuncForMethod only has branches for Task, Task, and IObservable. Interfaces returning ValueTask (which RestMethodInfo explicitly allows and the exception message advertises) will currently fall through into the sync/explicit-member branch and either throw or be treated as a sync method. Add an explicit ValueTask branch (likely by reusing the Task pipeline and wrapping/unwrapping as needed) so ValueTask return types behave as supported.

Copilot · 2026-03-25T17:33:47Z

Refit/RequestBuilderImplementation.cs

+                var factory = BuildRequestFactoryForMethod(
+                    restMethod,
+                    client.BaseAddress.AbsolutePath,
+                    paramsContainsCancellationToken: false
+                );


The generated sync path always calls BuildRequestFactoryForMethod(..., paramsContainsCancellationToken: false) and later calls SendAsync without a CancellationToken. If a (non-public / explicit) sync method includes a CancellationToken parameter, the token won’t be stripped from paramList (so it may get bound into query/body) and cancellation won’t be honored for SendAsync or AuthorizationHeaderValueGetter. Mirror the async path by using restMethod.CancellationToken != null, extracting the token from paramList, and passing it through to SendAsync and the auth-header getter.

Copilot · 2026-03-25T17:33:47Z

Refit/RequestBuilderImplementation.cs

+                    var factory = BuildRequestFactoryForMethod(
+                        restMethod,
+                        client.BaseAddress.AbsolutePath,
+                        paramsContainsCancellationToken: false
+                    );
+                    using var rq = factory(paramList);
+                    using var resp = client
+                        .SendAsync(rq, HttpCompletionOption.ResponseHeadersRead)
+                        .GetAwaiter()
+                        .GetResult();


The sync-void branch hard-codes paramsContainsCancellationToken: false and calls SendAsync without a CancellationToken. If a generated/non-public void method includes a CancellationToken parameter, it won’t cancel and the token may be treated as a normal argument when building the request. Consider matching BuildVoidTaskFuncForMethod by stripping/passing the CancellationToken when restMethod.CancellationToken != null.

@copilot apply changes based on this feedback

Refit.Tests/ExplicitInterfaceRefitTests.cs

ChrisPulman · 2026-03-26T09:24:18Z

@copilot open a new pull request to apply changes based on the comments in this thread

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Refactors request building/execution to centralize async logic and surface correct request metadata. Introduces RunSynchronous helpers and async implementations (ExecuteRequestAsync, ExecuteVoidRequestAsync, BuildRequestMessageForMethodAsync) so synchronous funcs invoke the same async pipeline. AuthorizationHeaderValueGetter is now awaited when building requests. ApiResponse creation now preserves the original HttpRequestMessage/RequestUri and fixes disposal/error/deserialization handling (including improved Exception/DeserializationExceptionFactory usage). Adds tests: awaiting auth header getter and ensuring generated sync ApiResponse preserves RequestMessage; updates expectations in explicit-interface tests to use HasResponseError and assert request properties.

ChrisPulman added 2 commits March 25, 2026 09:24

ChrisPulman marked this pull request as ready for review March 25, 2026 16:06

ChrisPulman requested a review from Copilot March 25, 2026 16:07

Copilot started reviewing on behalf of ChrisPulman March 25, 2026 16:07 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

Copilot AI mentioned this pull request Mar 25, 2026

Add tests for CamelCaseStringEnumConverter case-insensitive deserialization #2069

Merged

Copilot AI mentioned this pull request Mar 25, 2026

Fix sync method pipeline to match async behavior (ExceptionFactory, IApiResponse, disposal) #2070

Merged

Copilot AI and others added 2 commits March 25, 2026 16:59

ChrisPulman requested a review from Copilot March 25, 2026 17:25

Copilot started reviewing on behalf of ChrisPulman March 25, 2026 17:26 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

ChrisPulman and others added 4 commits March 26, 2026 09:26

Merge branch 'main' into FixFor2065_2067

11fcc0a

Merge branch 'main' into FixFor2065_2067

3581ec8

Update Refit.Tests/ExplicitInterfaceRefitTests.cs

7f5db39

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Uh oh!

Conversation

ChrisPulman commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

ChrisPulman Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

ChrisPulman Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Mar 25, 2026

Uh oh!

Copilot AI commented Mar 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

ChrisPulman Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ChrisPulman commented Mar 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ChrisPulman commented Mar 25, 2026 •

edited

Loading

codecov bot commented Mar 25, 2026 •

edited

Loading