Skip to content

Improve source generator and analyzer responsiveness#171

Merged
PhenX merged 8 commits intomasterfrom
bugfix/inconsistent-analyzer
Mar 7, 2026
Merged

Improve source generator and analyzer responsiveness#171
PhenX merged 8 commits intomasterfrom
bugfix/inconsistent-analyzer

Conversation

@PhenX
Copy link
Copy Markdown
Member

@PhenX PhenX commented Mar 7, 2026

While limiting useless executions on unrelated code as much as possible

Here are the results of the source generator benchmark.

GeneratorBenchmarks — Overview

The benchmark measures the performance of ProjectionExpressionGenerator (the Roslyn incremental source generator) under a synthetic but realistic workload. In Setup, it builds a CSharpCompilation containing a configurable number of [Projectable] members (ProjectableCount = 1 / 100 / 1 000), spread across multiple files of 1–9 members each, covering all 9 transformer paths in the generator (simple properties, null-conditionals, switch expressions, block-bodied methods, etc.). An equal number of noise files — plain classes with no [Projectable] members — are added to simulate a realistic project where only a fraction of files are relevant to the generator. Two additional compilations are pre-built in Setup, each identical to the baseline but with a single trailing comment appended to either a noise file or a projectable file.


Methods

Cold benchmarks (new driver every iteration)

Method What it measures
RunGenerator (baseline) Full cold run on the unmodified compilation. Establishes the cost of running the generator from scratch with no prior state.
RunGenerator_NoiseChange Full cold run on the compilation where a noise file was edited. Shows whether the cold path is sensitive to which files changed.
RunGenerator_ProjectableChange Full cold run on the compilation where a projectable file was edited (comment only, no member body change).

Incremental benchmarks (pre-warmed driver)

Method What it measures
RunGenerator_Incremental_NoiseChange Warm incremental run after a trivial edit in a noise file. The generator finds no [Projectable] nodes in the changed tree and should return all cached outputs immediately — this is the minimum incremental overhead.
RunGenerator_Incremental_ProjectableChange Warm incremental run after a trivial edit in a projectable file (comment only). The generator must re-examine every [Projectable] node it previously found in that tree, compare them to cached values, and only then confirm the cache is still valid — isolating the incremental re-examination overhead vs. the noise case.

BEFORE:

image

AFTER:

image

We can see that the incremental generator is significatively slower on files containing projectables. It remains acceptable though (under 10ms). It is faster though on files not containing projectables.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refactors the incremental generator pipeline to reduce unnecessary work by snapshotting [Projectable] attribute arguments into stable plain data and introducing custom equality comparers intended to improve caching behavior across edits.

Changes:

  • Snapshot [Projectable] attribute named arguments into a new ProjectableAttributeData record struct and pass it through the pipeline.
  • Rework generator initialization to avoid flowing “live” Roslyn objects from the syntax transform, and build semantic information only in the final source output step.
  • Replace the previous member/compilation comparers with new comparer logic based on syntax tree identity, member text, attribute snapshot, and external references.

Reviewed changes

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

Show a summary per file
File Description
src/EntityFrameworkCore.Projectables.Generator/ProjectionExpressionGenerator.cs Updates incremental pipeline to carry stable attribute snapshots and compute semantic info in the output step.
src/EntityFrameworkCore.Projectables.Generator/ProjectableInterpreter.cs Updates descriptor creation to consume precomputed symbol + attribute snapshot, optionally requiring Compilation for constructors.
src/EntityFrameworkCore.Projectables.Generator/ProjectableAttributeData.cs Adds a plain-data snapshot type for [Projectable] named arguments.
src/EntityFrameworkCore.Projectables.Generator/MemberDeclarationSyntaxEqualityComparer.cs Replaces name-based equality with syntax-tree identity + full text equality/hash.
src/EntityFrameworkCore.Projectables.Generator/MemberDeclarationSyntaxAndCompilationEqualityComparer.cs Introduces a custom comparer for (member+attribute, compilation) intended to skip work on unrelated edits.

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

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 7, 2026

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

Copilot AI and others added 2 commits March 7, 2026 16:36
… comparer

Co-authored-by: PhenX <42170+PhenX@users.noreply.github.com>
Fix stale incremental generator cache when referenced types change in other source files
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.


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

@PhenX PhenX merged commit 39d7f6b into master Mar 7, 2026
4 checks passed
@PhenX PhenX deleted the bugfix/inconsistent-analyzer branch March 8, 2026 08:42
@PhenX PhenX added this to the v6.0.0 milestone Mar 8, 2026
github-merge-queue bot pushed a commit to DFE-Digital/teaching-record-system that referenced this pull request Mar 27, 2026
Updated
[EntityFrameworkCore.Projectables](https://github.com/EFNext/EntityFrameworkCore.Projectables)
from 5.0.2 to 6.0.0.

<details>
<summary>Release notes</summary>

_Sourced from [EntityFrameworkCore.Projectables's
releases](https://github.com/EFNext/EntityFrameworkCore.Projectables/releases)._

## 6.0.0

## What's Changed

### Major changes

* Add support for projectable method overloads by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#143
* Add C#​14 extension members by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#148
* Support explicitly implemented interface members and default interface
properties by @​rhodon-jargon in
EFNext/EntityFrameworkCore.Projectables#135
* Support block-bodied members with [Projectable] attribute by @​Copilot
in EFNext/EntityFrameworkCore.Projectables#152
* Add ExpandEnumMethods to expand enum extension calls into ternary
expressions by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#150
* Add support for pattern matching in various cases by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#158
* Add support for projectable constructors by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#161
* AOT-compatible static projection registry + SyntaxFactory-based
emission by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#166
* Improve UseMemberBody and add new diagnostics by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#174
* Add code fixes for EFP0001, EFP0002 and EFP0008, with tests by @​PhenX
in EFNext/EntityFrameworkCore.Projectables#181
* Add a code fixer and a code refactorer to transform factory methods
into constructors by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#183
* Improve source generator and analyzer responsiveness by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#171
* Docs website by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#194
* Implement global MSBuild defaults for [Projectable] options by
@​koenbeuk in
EFNext/EntityFrameworkCore.Projectables#191

### Other changes

* Check source generator output compilation by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#156
* Fix GetImplementingProperty issue when using interfaces by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#144
* Full qualification not needed anymore by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#157
* Split generator tests in different classes by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#162
* Refactor ExpressionSyntaxRewriter into focused partial class files by
@​Copilot in
EFNext/EntityFrameworkCore.Projectables#163
* Update readme and add new test for constructors by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#165
* Remove obsolete code by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#167
* Add source generator self-benchmark covering all expression
transformers by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#168
* Fix null conditional rewrite generating invalid member access on
nullable value types by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#169
* Improve generator benchmark with more realistic scenario by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#170
* Fix stale incremental generator cache when referenced types change in
other source files by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#172
* Add tests for properties with a getter and setter by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#173
* UseMemberBody more strict with expressions by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#175
* Add custom Copilot instructions by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#177
* Reorganize generator project by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#178
* Add closure resolution benchmark by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#179
* Feature/optimize closures by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#180
* Feature/optimize resolver by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#182
* Update github project urls by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#184
* Update deps by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#185
* Remove obsolete verified files and name net8 files correctly by
@​PhenX in
EFNext/EntityFrameworkCore.Projectables#186
* Remove all allocations when resolving and make it even faster by
@​PhenX in
EFNext/EntityFrameworkCore.Projectables#189
* Add devcontainer configuration for C# (.NET) development by @​koenbeuk
in EFNext/EntityFrameworkCore.Projectables#190

**Full Changelog**:
EFNext/EntityFrameworkCore.Projectables@v5.0.2...v6.0.0

Commits viewable in [compare
view](EFNext/EntityFrameworkCore.Projectables@v5.0.2...v6.0.0).
</details>

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=EntityFrameworkCore.Projectables&package-manager=nuget&previous-version=5.0.2&new-version=6.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: James Gunn <james@gunn.io>
gunndabad added a commit to DFE-Digital/teaching-record-system that referenced this pull request Mar 27, 2026
Updated
[EntityFrameworkCore.Projectables](https://github.com/EFNext/EntityFrameworkCore.Projectables)
from 5.0.2 to 6.0.0.

<details>
<summary>Release notes</summary>

_Sourced from [EntityFrameworkCore.Projectables's
releases](https://github.com/EFNext/EntityFrameworkCore.Projectables/releases)._

## 6.0.0

## What's Changed

### Major changes

* Add support for projectable method overloads by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#143
* Add C#​14 extension members by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#148
* Support explicitly implemented interface members and default interface
properties by @​rhodon-jargon in
EFNext/EntityFrameworkCore.Projectables#135
* Support block-bodied members with [Projectable] attribute by @​Copilot
in EFNext/EntityFrameworkCore.Projectables#152
* Add ExpandEnumMethods to expand enum extension calls into ternary
expressions by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#150
* Add support for pattern matching in various cases by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#158
* Add support for projectable constructors by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#161
* AOT-compatible static projection registry + SyntaxFactory-based
emission by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#166
* Improve UseMemberBody and add new diagnostics by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#174
* Add code fixes for EFP0001, EFP0002 and EFP0008, with tests by @​PhenX
in EFNext/EntityFrameworkCore.Projectables#181
* Add a code fixer and a code refactorer to transform factory methods
into constructors by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#183
* Improve source generator and analyzer responsiveness by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#171
* Docs website by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#194
* Implement global MSBuild defaults for [Projectable] options by
@​koenbeuk in
EFNext/EntityFrameworkCore.Projectables#191

### Other changes

* Check source generator output compilation by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#156
* Fix GetImplementingProperty issue when using interfaces by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#144
* Full qualification not needed anymore by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#157
* Split generator tests in different classes by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#162
* Refactor ExpressionSyntaxRewriter into focused partial class files by
@​Copilot in
EFNext/EntityFrameworkCore.Projectables#163
* Update readme and add new test for constructors by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#165
* Remove obsolete code by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#167
* Add source generator self-benchmark covering all expression
transformers by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#168
* Fix null conditional rewrite generating invalid member access on
nullable value types by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#169
* Improve generator benchmark with more realistic scenario by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#170
* Fix stale incremental generator cache when referenced types change in
other source files by @​Copilot in
EFNext/EntityFrameworkCore.Projectables#172
* Add tests for properties with a getter and setter by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#173
* UseMemberBody more strict with expressions by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#175
* Add custom Copilot instructions by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#177
* Reorganize generator project by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#178
* Add closure resolution benchmark by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#179
* Feature/optimize closures by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#180
* Feature/optimize resolver by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#182
* Update github project urls by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#184
* Update deps by @​PhenX in
EFNext/EntityFrameworkCore.Projectables#185
* Remove obsolete verified files and name net8 files correctly by
@​PhenX in
EFNext/EntityFrameworkCore.Projectables#186
* Remove all allocations when resolving and make it even faster by
@​PhenX in
EFNext/EntityFrameworkCore.Projectables#189
* Add devcontainer configuration for C# (.NET) development by @​koenbeuk
in EFNext/EntityFrameworkCore.Projectables#190

**Full Changelog**:
EFNext/EntityFrameworkCore.Projectables@v5.0.2...v6.0.0

Commits viewable in [compare
view](EFNext/EntityFrameworkCore.Projectables@v5.0.2...v6.0.0).
</details>

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=EntityFrameworkCore.Projectables&package-manager=nuget&previous-version=5.0.2&new-version=6.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: James Gunn <james@gunn.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants