Skip to content

Fix TerminalLogger assert failure for metaproj files and cached project eval ID#13480

Merged
OvesN merged 12 commits intodotnet:mainfrom
OvesN:dev/veronikao/fix-TL-eval-before-proj-start-crash
Apr 15, 2026
Merged

Fix TerminalLogger assert failure for metaproj files and cached project eval ID#13480
OvesN merged 12 commits intodotnet:mainfrom
OvesN:dev/veronikao/fix-TL-eval-before-proj-start-crash

Conversation

@OvesN
Copy link
Copy Markdown
Contributor

@OvesN OvesN commented Apr 1, 2026

Fixes #13095

Context

These metaproj files are never evaluated — they have EvaluationId = -1. The TerminalLogger's Debug.Assert assumes every ProjectStarted has a prior ProjectEvaluationFinished, which fails for metaproj files and crashes the build.

Additionally, a pre-existing bug (#12953) causes real projects to lose their evaluation IDs when their ProjectInstance is cached (released from memory), and when BuildResult packets are sent from worker nodes to the central node without carrying the eval ID.

Changes Made

TerminalLogger metaproj fix:

  • TerminalLogger.cs: Assert "EvalProjectInfo should have been captured before ProjectStarted"); will not fail now for metaproj files

Evaluation ID fixes (adapted from PR #12946):

  • BuildRequestConfiguration.cs: Added _projectEvaluationId field that persists through caching + IPC serialization in both Translate() and TranslateForFutureUse()
  • NodeLoggingContext.cs: Use config.ProjectEvaluationId instead of config.Project.EvaluationId (which is inaccessible when cached)
  • BuildResult.cs: Added _evaluationId field with version 2 serialization
  • RequestBuilder.cs: Populate result.EvaluationId at success, exception, and abort paths
  • BuildManager.cs: Update config.ProjectEvaluationId from worker node results

Testing

Unit tests

  • BuildRequestConfiguration_Tests
  • BuildResult_Tests

Integration testing:

  • Verified by building Roslyn and Aspire with Debug bootstrap MSBuild with and without /mt.

Notes

@OvesN OvesN self-assigned this Apr 2, 2026
@OvesN OvesN marked this pull request as ready for review April 2, 2026 08:00
Copilot AI review requested due to automatic review settings April 2, 2026 08:00
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

Fixes TerminalLogger crashes and restores correct evaluation ID propagation across caching and cross-node result transfers, improving BuildEventContext consistency in multi-node (/m, /mt) builds.

Changes:

  • Make TerminalLogger’s ProjectStarted debug assertion tolerant of non-evaluated .metaproj projects.
  • Persist and propagate project evaluation IDs through configuration caching, node logging, worker→central result transfer, and BuildResult serialization.
  • Add/adjust unit tests for BuildResult/configuration serialization of evaluation IDs.

Reviewed changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/Framework/FileUtilities.cs Makes .metaproj detection helpers null-tolerant for broader call-site safety.
src/Build/Logging/TerminalLogger/TerminalLogger.cs Avoids Debug.Assert failure for .metaproj projects that never emit evaluation events.
src/Build/BuildCheck/Infrastructure/BuildCheckBuildEventHandler.cs Centralizes metaproject detection by using FileUtilities.IsMetaprojectFilename.
src/Build/BackEnd/Shared/BuildResult.cs Adds versioned _evaluationId field to allow eval ID propagation via result serialization.
src/Build/BackEnd/Shared/BuildRequestConfiguration.cs Persists evaluation ID independently of cached ProjectInstance accessibility and serializes it.
src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs Populates BuildResult.EvaluationId for success/abort/exception paths.
src/Build/BackEnd/Components/Logging/NodeLoggingContext.cs Uses persisted ProjectEvaluationId instead of reading from a potentially cached project.
src/Build/BackEnd/BuildManager/BuildManager.cs Updates configuration evaluation ID from worker node results when available.
src/Build.UnitTests/TerminalLogger_Tests.cs Whitespace-only adjustments.
src/Build.UnitTests/BackEnd/BuildResult_Tests.cs Adds test to validate translation preserves EvaluationId.
src/Build.UnitTests/BackEnd/BuildRequestConfiguration_Tests.cs Adds tests for ProjectEvaluationId preservation (translation/clone/future-use path).

Comment thread src/Build/BackEnd/Shared/BuildResult.cs
Comment thread src/Build.UnitTests/BackEnd/BuildRequestConfiguration_Tests.cs Outdated
Comment thread src/Build/BackEnd/Shared/BuildResult.cs
Comment thread src/Build/Logging/TerminalLogger/TerminalLogger.cs
@OvesN OvesN requested a review from SimaTian April 2, 2026 10:42
@OvesN OvesN enabled auto-merge (squash) April 2, 2026 15:57
Copy link
Copy Markdown
Member

@rainersigwald rainersigwald left a comment

Choose a reason for hiding this comment

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

#13489 should improve the test that flaked out on the current run. I'm not rerunning because I'm not convinced this is the right solution to the problem thouh.

Comment thread src/Build/Logging/TerminalLogger/TerminalLogger.cs Outdated
Comment thread src/Build/BackEnd/Shared/BuildResult.cs
@OvesN
Copy link
Copy Markdown
Contributor Author

OvesN commented Apr 15, 2026

@rainersigwald
Regarding your comment about deprecating older versions: the comment says "backwards compatible with at least 2
previous releases." We are now on version 2 and have two previous versions, 0 and 1. So I guess we do not need to
deprecate anything.

@rainersigwald
Copy link
Copy Markdown
Member

@rainersigwald Regarding your comment about deprecating older versions: the comment says "backwards compatible with at least 2 previous releases." We are now on version 2 and have two previous versions, 0 and 1. So I guess we do not need to deprecate anything.

I interpreted "releases" there as MSBuild releases, not this specific version that changes rarely. But this is not blocking.

@rainersigwald
Copy link
Copy Markdown
Member

Hit rerun after putting up #13546 to hopefully stabilize the test that flaked.

@OvesN OvesN merged commit d6f0b06 into dotnet:main Apr 15, 2026
10 checks passed
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.

Multithreaded build for roslyn crashes in TerminalLogger

5 participants