Implement a Roslyn source generator for AssemblyScanAttribute by ds5678 · Pull Request #3593 · stride3d/stride

ds5678 · 2026-10-15T10:09:19Z

PR Details

This pull request replaces the AssemblyScanProcessor in the AssemblyProcessor with a new Roslyn source generator in Stride.Core.CompilerServices.

Related Issue

Part of #1835

Types of changes

Docs change / refactoring / dependency upgrade

Checklist

All new and existing tests passed.
I have built and run the editor to try this change out.

Note

This pull request will conflict with Replace ParameterKeyProcessor with Roslyn source generation #3584, so ~~that~~ this needs merged first.
~~I haven't deleted AssemblyScanProcessor nor recompiled the AssemblyProcessor. I will do that after Replace ParameterKeyProcessor with Roslyn source generation #3584 is merged.~~
~~I haven't done any validation beyond checking that Stride compiles. I will do that before I mark this pull request ready for review.~~

github-actions · 2026-10-15T10:09:28Z

🤖 Draft PR — automatic CI is skipped to save runner minutes.

Mark the PR ready for review to run the full automatic CI — or add a ci-run-on-draft label to run it now without leaving draft.
Or arm a specific opt-in suite: ci-enduser, ci-editor, ci-ios, ci-android.

xen2

Thanks! A few points:

Rebase on latest master which merged #3678. Then you can rebuild AssemblyProcessor which is now deterministic (anybody can verify the build).
Some comments still say the scan index comes from the assembly processor (AssemblyRegistry.cs, Game.cs, StrideDefaultAssetsPlugin.cs, EditorGameController.cs, ...), and the StrideAssemblyProcessor comments in Stride.Audio.Editor.Wpf.csproj / Stride.UI.Editor.Wpf.csproj. Could you update them? Are those two still needed?
Could you add a few generator tests in Stride.Core.CompilerServices.Tests (Inherited = false, generic interface, nested type, keyword name)?

Filter duplicate attribute type definitions from generator scan results.

…dn't have attributes or base types listed

Filter inaccessible symbols from assembly-scan generation to prevent generated code from referencing types that are not visible within the assembly. Centralize the accessibility check in a shared compilation helper.

Rename `AssemblyScanGenerator` to `UnifiedGenerator`.

Move generator data and definition records into partial-class files, make the generator sealed, and centralize attribute inheritance detection in a symbol extension.

Prefix reserved and contextual C# keywords with `@` in generated namespace, type, and generic parameter names to keep generated code valid.

Lower the assembly scan results module initializer order from -1000 to -10000 so they run earlier.

Enumerate referenced modules and scan types only in Stride.Core or modules that reference it. Update type enumeration to work from module symbols.

Remove the `StrideAssemblyProcessor` setting from the Audio and UI WPF editor projects.

Thread `CancellationToken` through reference scanning, type data generation, and scan result computation. Check cancellation while processing modules, types, interfaces, targets, and attributes so generator execution stops promptly when cancelled.

xen2

Thanks for the fixes! The AssemblyProcessor binaries match a rebuild of the PR's source, so that part is good (thanks for being the first beta-tester).

You're right about RegisterImplementationSourceOutput, the IDE doesn't run it.
The filter is still nice for builds.

Still open: a few generator tests in Stride.Core.CompilerServices.Tests (Inherited = false, generic interface, nested type, keyword name). They would have caught the issue below.
Let me know if you want me to generate them?

…nerator.cs Co-authored-by: xen2 <virgile.bello@gmail.com>

Rename `GeneratorTestBase` to `UnifiedGeneratorTestBase` and update `DerivedClassTests` inheritance while preserving the existing test context and configuration.

ds5678 · 2026-10-22T22:56:05Z

@xen2 I added some tests. Let me know if you think anything else should be covered.

xen2

Thanks for the tests!
Just small things left below.

Move source generator testing to test-only dependencies and remove the unused Net100 reference assemblies package.

Rename `GenericInterfaceTests` to `InterfaceTests` and move the generic interface scanning test. Add coverage verifying assembly scanning discovers `IAppSettingsProvider` implementations from referenced assemblies.

xen2 · 2026-10-23T12:09:25Z

Editor CI is failing on all 3 graphics APIs, GameStudio crashes on startup with Could not load file or assembly 'Stride.Graphics'.

Looks like GameStudio now gets its own scan index (the old processor only did it for --serialization assemblies). Its module initializer builds the dictionary right away, so all the typeof load their assemblies and run their module initializers, all the way to Stride.Engine needing Stride.Graphics, before the AutoTesting host had a chance to set up the graphics API resolver in Main.

How about making the registration lazy? Module init would just register a factory, something like RegisterScanTypes(assembly, () => new ScanTypes(...)) stored in a Lazy, and the dictionary gets built on the first GetScanTypes(assembly). That way module init stays cheap and doesn't load anything, so we avoid this kind of load-order issue in general (and startup is a bit faster too).

ds5678 · 2026-10-23T12:31:39Z

How about making the registration lazy? Module init would just register a factory, something like RegisterScanTypes(assembly, () => new ScanTypes(...)) stored in a Lazy, and the dictionary gets built on the first GetScanTypes(assembly).

I'll take a look at this tomorrow.

That way module init stays cheap and doesn't load anything, so we avoid this kind of load-order issue in general (and startup is a bit faster too).

Do you want me to unmerge the generators, or is it still good to have a defined point in module initialization for that?

…tScanTypes (building it in the module initializer loaded the scanned types' assemblies too early)

# Conflicts: # sources/engine/Stride.Engine/Engine/Game.cs

…it again (AssetQuantumRegistry asks for it from a module initializer the index build triggers)

xen2 · 2026-10-23T20:31:14Z

How about making the registration lazy? Module init would just register a factory, something like RegisterScanTypes(assembly, () => new ScanTypes(...)) stored in a Lazy, and the dictionary gets built on the first GetScanTypes(assembly).

I'll take a look at this tomorrow.

That way module init stays cheap and doesn't load anything, so we avoid this kind of load-order issue in general (and startup is a bit faster too).

Do you want me to unmerge the generators, or is it still good to have a defined point in module initialization for that?

I took the liberty to do the lazy registration, so that I could merge this right away and you could focus on next steps of assembly processor removal.
Feel free to rebase next PR(s) on latest master to fix AssemblyProcessor.exe conflicts.
Thanks again!

ds5678 · 2026-10-23T20:34:14Z

I appreciate you getting this across the finish line. I'll rebase the other pull requests promptly!

xen2 · 2026-10-23T22:54:06Z

I appreciate you getting this across the finish line. I'll rebase the other pull requests promptly!

No problem, it's me thanking you for all your work on removing the assembly processor. It's a huge task!

ds5678 force-pushed the assembly-scan-source-generator branch from cf8f1d0 to 2a8142a Compare October 22, 2026 07:29

ds5678 marked this pull request as ready for review October 22, 2026 07:38

xen2 reviewed Oct 22, 2026

View reviewed changes

ds5678 added 18 commits October 22, 2026 11:14

Implement a Roslyn source generator for AssemblyScanAttribute

37cea5c

Switch from AssemblyProcessor to Roslyn source generator

a49c495

Deduplicate scanned attribute types

156047c

Filter duplicate attribute type definitions from generator scan results.

Fix partial classes being excluded if their first syntax reference di…

9c49ef0

…dn't have attributes or base types listed

Support records, enums, and delegates

320161b

Skip inaccessible types in assembly scanning

144852f

Filter inaccessible symbols from assembly-scan generation to prevent generated code from referencing types that are not visible within the assembly. Centralize the accessibility check in a shared compilation helper.

Merge generators

803d2b2

Fix assembly scan results being registered too late

009d2a0

Rename assembly scan generator

08c34f3

Rename `AssemblyScanGenerator` to `UnifiedGenerator`.

Refactor unified generator support types

f608c20

Move generator data and definition records into partial-class files, make the generator sealed, and centralize attribute inheritance detection in a symbol extension.

Escape keywords in generated identifiers

4c6b5d2

Prefix reserved and contextual C# keywords with `@` in generated namespace, type, and generic parameter names to keep generated code valid.

Update compiled dll files

46a63b5

Remove unused API

c1293c5

Remove duplicate ModuleInitializer

f9ff033

Fix derived interfaces being registered

5d6f8bc

Remove field caches in records

5869958

Prioritize assembly scan initializers

049d5af

Lower the assembly scan results module initializer order from -1000 to -10000 so they run earlier.

Limit assembly-scan discovery to relevant modules

9610783

Enumerate referenced modules and scan types only in Stride.Core or modules that reference it. Update type enumeration to work from module symbols.

ds5678 force-pushed the assembly-scan-source-generator branch from 2a8142a to 9610783 Compare October 22, 2026 19:11

ds5678 added 3 commits October 22, 2026 12:45

Update comments referencing the AssemblyProcessor

0127e4f

Disable assembly processing for WPF editors

c634adf

Remove the `StrideAssemblyProcessor` setting from the Audio and UI WPF editor projects.

xen2 reviewed Oct 22, 2026

View reviewed changes

Comment thread sources/core/Stride.Core.CompilerServices/Generators/UnifiedGenerator.cs Outdated

Comment thread sources/core/Stride.Core.CompilerServices/Generators/UnifiedGenerator.cs Outdated

ds5678 and others added 2 commits October 22, 2026 14:39

Update sources/core/Stride.Core.CompilerServices/Generators/UnifiedGe…

45dc8df

…nerator.cs Co-authored-by: xen2 <virgile.bello@gmail.com>

Interfaces should never be registered

f40a0f5

xen2 added the ci-enduser Run the end-user sample screenshot + packaging suite on this PR label Oct 22, 2026

xen2 added ci-editor Run the GameStudio editor screenshot suite on this PR ci-ios Run the iOS game test suite on this PR ci-android Run the Android game test suite on this PR labels Oct 22, 2026

ds5678 added 3 commits October 22, 2026 15:34

First test

df22ddf

Rename generator test base class

4b8fb04

Rename `GeneratorTestBase` to `UnifiedGeneratorTestBase` and update `DerivedClassTests` inheritance while preserving the existing test context and configuration.

More tests

dc5d2fd

ds5678 requested a review from xen2 October 22, 2026 22:55

Remove line from README

455ad12

ds5678 mentioned this pull request Oct 23, 2026

Delete unused assembly processors #3679

Merged

3 tasks done

xen2 reviewed Oct 23, 2026

View reviewed changes

Comment thread sources/core/Stride.Core.CompilerServices.Tests/GeneratorTests/UnifiedGeneratorTestBase.cs

Comment thread sources/core/Stride.Core.CompilerServices.Tests/GeneratorTests/UnifiedGeneratorTestBase.cs

Comment thread sources/Directory.Packages.props Outdated

ds5678 added 2 commits October 23, 2026 02:47

Scope source generator test dependencies

485240c

Move source generator testing to test-only dependencies and remove the unused Net100 reference assemblies package.

Rename interface tests and add reference scanning coverage

5d89993

Rename `GenericInterfaceTests` to `InterfaceTests` and move the generic interface scanning test. Add coverage verifying assembly scanning discovers `IAppSettingsProvider` implementations from referenced assemblies.

ds5678 requested a review from xen2 October 23, 2026 09:50

xen2 added 3 commits October 23, 2026 21:07

Assembly scan: register the index as a factory, built on the first Ge…

99cc0c8

…tScanTypes (building it in the module initializer loaded the scanned types' assemblies too early)

Merge remote-tracking branch 'origin/master' into pr3593-lazy-scan

330d57b

# Conflicts: # sources/engine/Stride.Engine/Engine/Game.cs

Assembly scan: a nested GetScanTypes while the index is built builds …

26fc43d

…it again (AssetQuantumRegistry asks for it from a module initializer the index build triggers)

xen2 merged commit a7f4379 into stride3d:master Oct 23, 2026
38 of 39 checks passed

ds5678 deleted the assembly-scan-source-generator branch October 23, 2026 20:28

Conversation

ds5678 commented Oct 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Details

Related Issue

Types of changes

Checklist

Note

Uh oh!

github-actions Bot commented Oct 15, 2026

Uh oh!

xen2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xen2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ds5678 commented Oct 22, 2026

Uh oh!

xen2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xen2 commented Oct 23, 2026

Uh oh!

ds5678 commented Oct 23, 2026

Uh oh!

Uh oh!

xen2 commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ds5678 commented Oct 23, 2026

Uh oh!

xen2 commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ds5678 commented Oct 15, 2026 •

edited

Loading

xen2 commented Oct 23, 2026 •

edited

Loading

xen2 commented Oct 23, 2026 •

edited

Loading