feat: improve generated clients for AOT by glennawatson · Pull Request #2151 · reactiveui/refit

glennawatson · 2026-06-20T15:19:38Z

What changed

Added RestService.ForGenerated(...) for applications that want to require a source-generated Refit client.
Added settings-based generated factories so fully generated clients can use HttpClient and RefitSettings without creating the reflection request builder.
Added generated request construction for URL-encoded bodies, including declared-type form property discovery for trimming and Native AOT.
Kept the generated request-builder path for interfaces with request shapes that still need runtime request-builder support.
Moved reusable Refit interface validation into analyzer and code-fix assemblies.
Added analyzer diagnostics for:
- non-Refit members on Refit interfaces
- route templates that use backslashes
- multiple CancellationToken parameters
- invalid [HeaderCollection] parameter types
Added code fixes for:
- replacing route backslashes with forward slashes
- changing invalid [HeaderCollection] parameter types to IDictionary<string, string>
Updated the source generator to use Roslyn incremental generator patterns for built-in Refit HTTP attributes.
Improved generated source so it follows the repository analyzer rules for documentation, visibility, nullable context, field ordering, and field naming.
Added generated-code compliance tests that compile real generated output with generated-code markers disabled.
Added C# 7.3 generated-source coverage, while enabling nullable annotations for generated code on C# 8 and newer.
Tightened trimming and Native AOT annotations so remaining warnings describe concrete runtime metadata or dynamic-code requirements.
Shared enum, reflected property, and string helpers across runtime request paths.
Updated the README with generated-only client creation, generated request building, Native AOT guidance, analyzer diagnostics, code fixes, and generated-code language support.

Compatibility

This targets the next major version.
RestService.For<T>(...) and AddRefitClient<T>() remain the normal entry points.
RestService.ForGenerated<T>(...) is the stricter entry point for applications that require generated clients.
Interfaces that cannot use settings-only generated factories still use the existing generated request-builder path.
Generated source is kept compatible with C# 7.3 syntax, with nullable annotations emitted when the consuming project supports them.

Issues

Closes #1345.
Closes #1142.
Closes #1475.

Validation

dotnet build "Refit/Refit.csproj" -f net8.0 -v:minimal --no-restore /p:NuGetAudit=false /m:1
dotnet build "Refit/Refit.csproj" -f net462 -v:minimal --no-restore /p:NuGetAudit=false /m:1
dotnet build "Refit/Refit.csproj" -f net10.0 -v:minimal --no-restore /p:NuGetAudit=false /m:1
dotnet build "Refit/Refit.csproj" -f net11.0 -v:minimal --no-restore /p:NuGetAudit=false /m:1
dotnet test "tests/Refit.Tests/Refit.Tests.csproj" -f net8.0 -v:minimal --no-restore /p:NuGetAudit=false
dotnet build "tests/Refit.GeneratorTests/Refit.GeneratorTests.csproj" -f net8.0 -v:minimal --no-restore /p:NuGetAudit=false /m:1
dotnet run --project "tests/Refit.GeneratorTests/Refit.GeneratorTests.csproj" -f net8.0 --no-restore --no-build
dotnet publish "Refit.NativeAotSmoke/Refit.NativeAotSmoke.csproj" -c Release -r linux-x64 --self-contained true /p:NuGetAudit=false /p:ContinuousIntegrationBuild=true
./Refit.NativeAotSmoke/bin/Release/net8.0/linux-x64/publish/Refit.NativeAotSmoke
git diff --check

Checklist

I have read the Contribute guide
Tests have been added or updated
Docs have been added or updated
Changes target the main branch
PR title follows Conventional Commits

…d handling

codecov · 2026-06-20T16:26:28Z

Codecov Report

❌ Patch coverage is 98.27728% with 21 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.56%. Comparing base (e28a384) to head (c98c2ea).

Files with missing lines	Patch %	Lines
...c/Refit.Analyzers.Shared/RefitInterfaceAnalyzer.cs	95.62%	0 Missing and 6 partials ⚠️
src/InterfaceStubGenerator.Shared/Emitter.cs	99.62%	0 Missing and 2 partials ⚠️
...ceStubGenerator.Shared/InterfaceStubGeneratorV2.cs	97.80%	0 Missing and 2 partials ⚠️
src/Refit/EnumHelpers.cs	96.61%	0 Missing and 2 partials ⚠️
src/Refit/StringHelpers.cs	87.50%	2 Missing ⚠️
src/Refit/ValidationApiException.cs	96.72%	0 Missing and 2 partials ⚠️
src/InterfaceStubGenerator.Shared/Parser.cs	97.43%	0 Missing and 1 partial ⚠️
....CodeFixes.Shared/RefitInterfaceCodeFixProvider.cs	98.21%	0 Missing and 1 partial ⚠️
src/Refit/ReflectionPropertyHelpers.cs	92.85%	0 Missing and 1 partial ⚠️
...it/RequestBuilderImplementation.QueryAndHeaders.cs	75.00%	0 Missing and 1 partial ⚠️
... and 1 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2151      +/-   ##
==========================================
+ Coverage   97.49%   97.56%   +0.06%     
==========================================
  Files         105      112       +7     
  Lines        4711     5334     +623     
  Branches      845      961     +116     
==========================================
+ Hits         4593     5204     +611     
  Misses         31       31              
- Partials       87       99      +12

☔ View full report in Codecov by Harness.
📢 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.

This reverts commit df22e3c.

- Add generated URL-encoded body handling that preserves declared form types for AOT. - Compile generated source against repository analyzer rules and older C# syntax expectations. - Share enum, property, and string helpers across runtime request paths. - Extend native AOT and runtime tests for generated request construction.

- Keep the substring fallback for targets without the span URI escaping overload. - Limit the suppression to the helper method that selects the target-specific path.

- Make generated infrastructure field names unique against interface members. - Cover collisions with generated request-builder, settings, and type-parameter fields.

- Add problem-details coverage for validation errors and extension values. - Cover enum backing-type helpers and generated-only RestService overloads.

- Add focused coverage for generator helpers, analyzer exits, and code-fix paths. - Cover the new generic enum and request-builder fallbacks without reflection-only tests.

- Use JsonElement parsing APIs where modern targets support them. - Reject duplicate JSON properties in default System.Text.Json options on .NET 10+. - Include the generator test accessors required by the coverage tests.

- Track the attribute state directly when parsing authorization and body parameters. - This keeps the same validation behavior while satisfying constant-condition analysis.

sonarqubecloud · 2026-06-21T01:13:06Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
97.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

glennawatson added 4 commits June 21, 2026 01:18

feat: add AOT-aware generated API paths

147985a

refactor: split Refit diagnostics into analyzers

900e23e

test: add CloseGenericMethodKeyTests and enhance generator HTTP metho…

a52f95a

…d handling

fix: resolve generated client and problem details test failures

06c41b4

glennawatson added 3 commits June 21, 2026 02:39

Add generated Minimal API endpoint mapping

df22e3c

Revert "Add generated Minimal API endpoint mapping"

6aa970f

This reverts commit df22e3c.

Remove Minimal API package

5a8c51e

glennawatson changed the title ~~feat: add AOT-aware generated API paths~~ feat: add AOT-aware generated client paths Jun 20, 2026

glennawatson added 3 commits June 21, 2026 07:57

Improve generated source formatting checks

43fb653

Use settings factories for generated clients

4fad975

Document generated-only client creation

7ce9a05

glennawatson changed the title ~~feat: add AOT-aware generated client paths~~ feat: improve AOT source-generated clients Jun 20, 2026

Fix Sonar coverage test path

5821261

glennawatson changed the title ~~feat: improve AOT source-generated clients~~ feat: add AOT generated clients Jun 20, 2026

glennawatson changed the title ~~feat: add AOT generated clients~~ feat: improve generated clients for AOT Jun 20, 2026

glennawatson marked this pull request as ready for review June 20, 2026 23:13

fix: suppress net9 span analyzer fallback

eabbb17

- Keep the substring fallback for targets without the span URI escaping overload. - Limit the suppression to the helper method that selects the target-specific path.

ChrisPulman approved these changes Jun 20, 2026

View reviewed changes

glennawatson added 5 commits June 21, 2026 09:57

fix(generator): avoid generated field collisions

fa55660

- Make generated infrastructure field names unique against interface members. - Cover collisions with generated request-builder, settings, and type-parameter fields.

test: cover generated client runtime paths

af0876f

- Add problem-details coverage for validation errors and extension values. - Cover enum backing-type helpers and generated-only RestService overloads.

test: cover AOT source-generation paths

e8b7e5a

- Add focused coverage for generator helpers, analyzer exits, and code-fix paths. - Cover the new generic enum and request-builder fallbacks without reflection-only tests.

perf(json): use modern JSON APIs

c96b045

- Use JsonElement parsing APIs where modern targets support them. - Reject duplicate JSON properties in default System.Text.Json options on .NET 10+. - Include the generator test accessors required by the coverage tests.

fix(refit): remove redundant metadata checks

c98c2ea

- Track the attribute state directly when parsing authorization and body parameters. - This keeps the same validation behavior while satisfying constant-condition analysis.

glennawatson merged commit bf488d6 into main Jun 21, 2026
13 checks passed

glennawatson deleted the source-gen-remaining-issues branch June 21, 2026 02:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: improve generated clients for AOT#2151

feat: improve generated clients for AOT#2151
glennawatson merged 18 commits into
mainfrom
source-gen-remaining-issues

glennawatson commented Jun 20, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Jun 20, 2026 •

edited

Loading

Uh oh!

sonarqubecloud Bot commented Jun 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

glennawatson commented Jun 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changed

Compatibility

Issues

Validation

Checklist

Uh oh!

codecov Bot commented Jun 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sonarqubecloud Bot commented Jun 21, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

glennawatson commented Jun 20, 2026 •

edited

Loading

codecov Bot commented Jun 20, 2026 •

edited

Loading