feat(codegen): register static grain-reference factories - #11386
Draft
ReubenBond wants to merge 6 commits into
Draft
ReubenBond wants to merge 6 commits into
ReubenBond wants to merge 6 commits into
Conversation
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Nested generic interfaces can produce invalid generated code, and duplicate manifest registrations can unexpectedly discard static factories.
Review effort: Balanced
Findings: 1
Open (2)
What changed in this PR
Adds statically generated grain-reference factories to avoid reflective construction, particularly under NativeAOT.
Changes:
- Generates direct typed factory registrations, including closed generic interfaces.
- Resolves factories by declared interface while retaining legacy proxy compatibility.
- Adds runtime, code-generation, NativeAOT, API, and documentation coverage.
| File | Description |
|---|---|
test/Orleans.NativeAotSmoke/GrainReferences.cs |
Tests closed generic factories under NativeAOT. |
test/Orleans.Core.Tests/GrainReferences/ReferenceConstructionFixture.cs |
Extends the reference-construction fixture. |
test/Orleans.Core.Tests/GrainReferences/GrainReferenceActivatorTests.cs |
Covers factory resolution and compatibility. |
test/Orleans.CodeGenerator.Tests/snapshots/OrleansSourceGeneratorTests.TestGrainWithMultipleInterfaces.verified.cs |
Updates generated factory snapshot. |
test/Orleans.CodeGenerator.Tests/snapshots/OrleansSourceGeneratorTests.TestGrainWithDifferentKeyTypes.verified.cs |
Updates key-type factory snapshots. |
test/Orleans.CodeGenerator.Tests/snapshots/OrleansSourceGeneratorTests.TestGrainMethodAnnotatedWithResponseTimeout.verified.cs |
Updates generated factory snapshot. |
test/Orleans.CodeGenerator.Tests/snapshots/OrleansSourceGeneratorTests.TestGrainMethodAnnotatedWithInvokableBaseType.verified.cs |
Updates generated factory snapshot. |
test/Orleans.CodeGenerator.Tests/snapshots/OrleansSourceGeneratorTests.TestGrainComplexGrain.verified.cs |
Updates generated factory snapshot. |
test/Orleans.CodeGenerator.Tests/snapshots/OrleansSourceGeneratorTests.TestClassWithGenerateMethodSerializersAnnotation.verified.cs |
Updates generated factory snapshot. |
test/Orleans.CodeGenerator.Tests/snapshots/OrleansSourceGeneratorTests.TestBasicGrain.verified.cs |
Updates generated factory snapshot. |
test/Orleans.CodeGenerator.Tests/GrainReferenceFactoryCodegenTests.cs |
Tests factory code generation and diagnostics. |
src/Orleans.Serialization/Configuration/TypeManifestOptions.cs |
Adds typed manifest extension storage. |
src/Orleans.Core/GrainReferences/GrainReferenceActivator.cs |
Resolves and invokes registered factories. |
src/Orleans.Core.Abstractions/Configuration/GrainReferenceFactoryOptions.cs |
Defines factory registration options. |
src/Orleans.Core.Abstractions/CodeGeneration/GenerateGrainReferenceAttribute.cs |
Adds closed-interface generation attribute. |
src/Orleans.CodeGenerator/Model/ReferenceAssemblyModelExtractor.cs |
Extracts requested closed factories. |
src/Orleans.CodeGenerator/Model/ReferenceAssemblyModel.cs |
Models grain-reference factories. |
src/Orleans.CodeGenerator/Model/ProxyInterfaceModelExtractor.cs |
Detects compatible proxy bases. |
src/Orleans.CodeGenerator/Model/ProxyInterfaceModel.cs |
Records factory support metadata. |
src/Orleans.CodeGenerator/Model/MetadataAggregateModelBuilder.cs |
Preserves factory metadata during normalization. |
src/Orleans.CodeGenerator/MetadataGenerator.cs |
Emits direct factory registrations. |
src/Orleans.CodeGenerator/Diagnostics/InvalidGrainReferenceFactoryDiagnostic.cs |
Defines invalid-registration diagnostics. |
src/Orleans.CodeGenerator/Diagnostics/DiagnosticRuleId.cs |
Adds diagnostic identifier ORLEANS0117. |
src/Orleans.CodeGenerator/AnalyzerReleases.Unshipped.md |
Records the new analyzer rule. |
src/api/Orleans.Serialization/Orleans.Serialization.cs |
Updates generated serialization API surface. |
src/api/Orleans.Core.Abstractions/Orleans.Core.Abstractions.cs |
Updates generated core API surface. |
docs/site/src/content/docs/implementation/serialization.md |
Documents factory construction and compatibility. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
Code coverage
Report-only conclusion: current-main baseline stale. The newest successful coverage run tested cdb7961, not current main d4e4620. Coverage combines every CI test matrix job, including providers, CodeGen, .NET 8/10, Linux, Windows, and macOS, using canonical physical source and branch identities. The comparison remains report-only while normal line and branch variance is calibrated. Coverage details |
ReubenBond
marked this pull request as draft
October 2, 2026 21:54
This branch has not been deployed
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.
Warning
Incomplete approach: automatic reflection-free construction covers only non-generic grain references. Generic proxies have generated
Createmethods, but this PR does not automatically generate or register factories for closed generic grain interfaces. Without explicit closed registrations, generic reference construction still usesMakeGenericType, constructor lookup, andConstructorInvoker.The NativeAOT generic scenarios work because the tests manually register their closed proxy factories. They do not demonstrate automatic generic support. This falls short of replacing reflective construction for all grain references. This PR is draft, is not ready to merge, and will likely not be merged.
Follow-up to #11371.
Generated grain references use statically registered, typed factory delegates.
RpcProviderresolves them by the explicitly declared grain interface, avoiding interface guessing, constructor reflection, emitted IL, and grain-key boxing on the registered construction path. The existing activator continues to share runtime state, interface versions, invocation options, and serialization services while each reference retains its own key.Proxy bases declare their construction contract with
[GenerateProxyFactory(typeof(TDelegate))]. The generator reads the delegate's argument types, passing modes, and result type, emits a staticCreatemethod with a direct constructor call, and registers the method group inInterfaceProxyFactoryOptions<TDelegate>.GrainReferencedeclares the namedGrainReferenceFactorydelegate, which accepts shared runtime state and a grain key and returns a grain reference. The base annotation, registrations, cached activators, and legacy compatibility delegates all use that same named type. Factory generation and metadata registration remain independent of grain-specific types.Factory declarations are inherited, and a nearer proxy base can override the declaration. Closed delegates and supported argument passing modes are validated at build time; factory results use identity or implicit reference conversions to preserve the constructed proxy instance. C# checks constructor calls for both non-generic and open generic proxies. Unannotated RPC bases retain their existing type-only registration behavior. A public read-only registration view lets other proxy consumers invoke their own typed factories. Coverage includes non-grain factories with multiple arguments, generic proxy families, inheritance/overrides, custom delegates with
ref,in, andoutarguments, and rejection of user-defined result conversions.Factories for non-generic interfaces are registered automatically. Closed-generic NativeAOT construction uses explicitly supplied concrete factory registrations; open mappings support runtime-selected arguments on JIT through reflective generic closure. Older generated binaries and custom proxies registered by type retain the constructor-invoker compatibility path. Legacy custom overrides and replacement typed factories preserve their precedence. The earlier grain-specific root attribute, discovery models, and capability checks are removed.
The existing production grain-reference NativeAOT scenario exercises generated non-generic references, manually registered value/reference-type generic proxies, and a non-grain proxy whose factory comes solely from its base declaration. Generated proxy names remain implementation details. Public API surfaces are regenerated and architecture guidance describes factory contracts, registration, and compatibility boundaries.
Microsoft Reviewers: Open in CodeFlow