Skip to content

Fix stale incremental generator cache when referenced types change in other source files#172

Merged
PhenX merged 2 commits intobugfix/inconsistent-analyzerfrom
copilot/sub-pr-171
Mar 7, 2026
Merged

Fix stale incremental generator cache when referenced types change in other source files#172
PhenX merged 2 commits intobugfix/inconsistent-analyzerfrom
copilot/sub-pr-171

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 7, 2026

MemberDeclarationSyntaxAndCompilationEqualityComparer only checked external assembly references, so changes to types in other source files (e.g., an enum gaining/losing members) were invisible to the cache — the generator reused stale output even though the semantic model had changed.

Changes

Bug fix — MemberDeclarationSyntaxAndCompilationEqualityComparer

  • Added source-tree reference equality check (step 5) before the external-references check.
    Roslyn reuses the same SyntaxTree object for unchanged files, so comparing by reference is cheap (O(n) pointer comparisons) and semantically correct.
  • Added a file-scoped ReferenceEqualityTreeComparer helper (netstandard2.0-compatible).
// Before — only external assemblies were checked:
return xCompilation.ExternalReferences.SequenceEqual(yCompilation.ExternalReferences);

// After — source trees checked first, then external references:
if (!xCompilation.SyntaxTrees.SequenceEqual(yCompilation.SyntaxTrees, ReferenceEqualityTreeComparer.Instance))
    return false;
return xCompilation.ExternalReferences.SequenceEqual(yCompilation.ExternalReferences);

New test helpers — ProjectionExpressionGeneratorTestsBase

  • GetDefaultReferences() — extracted so incremental tests can build multi-file compilations without duplicating the #if NET10_0/NET8_0 reference boilerplate.
  • CreateAndRunGenerator() — creates a fresh driver, returns (driver, result) to seed incremental state.
  • RunGeneratorWithDriver(driver, compilation) — reruns an existing driver on an updated compilation, preserving cache state.

New tests — IncrementalGeneratorTests

Tests that reuse a GeneratorDriver across two compilations to guard against cache regressions:

Test What it verifies
WhenReferencedEnumInAnotherFileGainsAMember_GeneratedOutputUpdates New enum member propagates into the ternary expansion
WhenReferencedEnumInAnotherFileLosesAMember_GeneratedOutputUpdates Removed enum member is no longer present in output
WhenProjectableFileChanges_GeneratedOutputUpdates Direct changes to the projectable still re-run (sanity)
WhenCompilationIsUnchanged_GeneratorProducesSameOutput Cache is still valid when nothing changed

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

… comparer

Co-authored-by: PhenX <42170+PhenX@users.noreply.github.com>
Copilot AI changed the title [WIP] Update source generator and analyzer responsiveness based on feedback Fix stale incremental generator cache when referenced types change in other source files Mar 7, 2026
Copilot finished work on behalf of PhenX March 7, 2026 16:39
@PhenX PhenX marked this pull request as ready for review March 7, 2026 19:13
@PhenX PhenX merged commit ff58a34 into bugfix/inconsistent-analyzer Mar 7, 2026
@PhenX PhenX deleted the copilot/sub-pr-171 branch March 8, 2026 08:48
@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.

2 participants