Fix EmbedInBinlog items with relative paths from child projects by huulinhnguyen-dev · Pull Request #13990 · dotnet/msbuild

huulinhnguyen-dev · 2026-06-08T11:00:06Z

Context

EmbedInBinlog items with a relative Include path were silently dropped unless created on the entrypoint node where the logger runs — files added by child projects never got embedded (also the root cause of flaky test #13762).

Two layers:

CheckForFilesToEmbed embedded the raw ItemSpec, so relative paths resolved against the logger's working dir, not the declaring project's.
On worker nodes, ProjectFile isn't serialized (perf), so even after (1) there was no project dir to resolve against.

Changes Made

BuildEventArgsWriter.cs — thread ProjectFile into CheckForFilesToEmbed and resolve relative item specs against the project directory.
LoggingService.cs — restore ProjectFile for forwarded EmbedInBinlog events in InjectNonSerializedData (scoped to EmbedInBinlog to avoid overhead on common events).
MSBuildConstants.cs / Binary-Log.md — document that EmbedInBinlog expects absolute paths; relative paths resolve against the declaring project.

Testing

Added a test reproducing the issue (parent builds two child projects in parallel, each with a relative EmbedInBinlog path; asserts both files embedded).

Notes

…h-resolution

Copilot

Pull request overview

This PR fixes a long-standing gap in binary logging where @(EmbedInBinlog) items with relative includes coming from child projects / worker nodes were not reliably embedded, because the entrypoint logger lacked the originating project directory context.

Changes:

Pass ProjectFile into the embed-file detection path and resolve relative EmbedInBinlog item specs against the declaring project’s directory.
Rehydrate TaskParameterEventArgs.ProjectFile for forwarded EmbedInBinlog events on the receiving (entrypoint) node to avoid adding serialization overhead broadly.
Add a unit test that builds multiple child projects in parallel and asserts both relative-path outputs are embedded; clarify expectations in MSBuildConstants.

Reviewed changes

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

File	Description
src/Framework/MSBuildConstants.cs	Documents the intended resolution behavior for relative `EmbedInBinlog` item specs.
src/Build/Logging/BinaryLogger/BuildEventArgsWriter.cs	Threads `ProjectFile` through item writing and resolves relative embed paths against the project directory.
src/Build/BackEnd/Components/Logging/LoggingService.cs	Restores `ProjectFile` for forwarded `EmbedInBinlog` task-parameter events using the project context map.
src/Build.UnitTests/BinaryLogger_Tests.cs	Adds a regression test for relative-path embedding from parallel child projects.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

…n' of https://github.com/huulinhnguyen-dev/msbuild into dev/huulinhnguyen/embedinbinlog-relative-path-resolution

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

Updated [Microsoft.Build.Utilities.Core](https://github.com/dotnet/msbuild) from 18.9.6 to 18.10.1. <details> <summary>Release notes</summary> _Sourced from [Microsoft.Build.Utilities.Core's releases](https://github.com/dotnet/msbuild/releases)._ ## 18.10.1 ## What's Changed * [vs16.11] Update dependencies from dotnet/arcade by @dotnet-maestro[bot] in dotnet/msbuild#13103 * [vs17.12] Update dependencies from dotnet/arcade by @dotnet-maestro[bot] in dotnet/msbuild#13796 * [vs17.8] Update dependencies from dotnet/arcade by @dotnet-maestro[bot] in dotnet/msbuild#13902 * [vs17.11] Update dependencies from dotnet/arcade by @dotnet-maestro[bot] in dotnet/msbuild#13903 * [vs17.12] Update dependencies from dotnet/arcade by @dotnet-maestro[bot] in dotnet/msbuild#13909 * [vs17.12] Update dependencies from dotnet/arcade by @dotnet-maestro[bot] in dotnet/msbuild#13986 * Add vs18.9 to merge-flow config; retire vs18.3 by @JanProvaznik in dotnet/msbuild#14214 * Bump labeler-cache-retention to use issue-labeler v2.1.0 by @jeffhandley in dotnet/msbuild#14171 * Bump main to 18.10.0 after vs18.9 snap by @JanProvaznik in dotnet/msbuild#14216 * Improve release skill: Phase 2 DARC rules, VMR backflow, deterministic baseline by @JanProvaznik in dotnet/msbuild#14220 * Determinize release: hardcode OptProf baseline + Phase 3.2 baseline resolver by @JanProvaznik in dotnet/msbuild#14222 * Serialize BuildRequestConfiguration.RequestedTargets to fix solution metaproject MSB4057 in parallel builds by @ViktorHofer in dotnet/msbuild#14223 * [main] Update dependencies from nuget/nuget.client by @dotnet-maestro[bot] in dotnet/msbuild#14203 * Core support for AbsolutePath/FileInfo/DirectoryInfo and ITaskItem<T> as task parameters by @baronfel in dotnet/msbuild#13971 * [main] Update dependencies from dotnet/roslyn by @dotnet-maestro[bot] in dotnet/msbuild#14206 * Fix existence cache kind poisoning by @AlesProkop in dotnet/msbuild#14249 * [main] Source code updates from dotnet/dotnet by @dotnet-maestro[bot] in dotnet/msbuild#14226 * Don't disable the MSBuild server for /mt builds when node reuse is off by @AR-May in dotnet/msbuild#14248 * Enhance expert reviewer guidelines with additional checks. by @AR-May in dotnet/msbuild#14255 * [main] Source code updates from dotnet/dotnet by @dotnet-maestro[bot] in dotnet/msbuild#14253 * [main] Update dependencies from dotnet/roslyn by @dotnet-maestro[bot] in dotnet/msbuild#14268 * [main] Update dependencies from nuget/nuget.client by @dotnet-maestro[bot] in dotnet/msbuild#14267 * Bump github/gh-aw-actions/setup from 0.81.6 to 0.82.2 by @dependabot[bot] in dotnet/msbuild#14266 * Avoid boxing the struct enumerator in PropertyDictionary<T>.GetEnumerator() by @nareshjo in dotnet/msbuild#14272 * Refresh copy marker when implementation output changes by @AlesProkop in dotnet/msbuild#14231 * Send task-host build process environment as delta by @OvesN in dotnet/msbuild#14126 * Add regression coverage for metadata newline preservation by @VolPlita in dotnet/msbuild#14261 * Fix EmbedInBinlog items with relative paths from child projects by @huulinhnguyen-dev in dotnet/msbuild#13990 * Stop requiring VersionPrefix updates in servicing - insert prerelease versions to VS by @ViktorHofer in dotnet/msbuild#14277 * Fix WriteLinesToFile rewriting unchanged file when custom encoding is used by @huulinhnguyen-dev in dotnet/msbuild#14146 * Enable trim/AOT analyzers for Microsoft.Build and clean up annotations by @JeremyKuhne in dotnet/msbuild#14064 * [automated] Merge branch 'vs18.9' => 'main' by @github-actions[bot] in dotnet/msbuild#14291 * Fix MicroBuild plugin feed URL to use allowed pkgs.dev.azure.com format by @AlesProkop in dotnet/msbuild#14295 * Pass ExcludeRestorePackageImports during restore to avoid redundant evaluations by @ViktorHofer with @Copilot in dotnet/msbuild#14274 * [vs18.7] Update dependencies from dotnet/arcade by @dotnet-maestro[bot] in dotnet/msbuild#13988 * Adopt Clever Test Selection (CTS) as parallel, non-blocking PR pipeline by @jankratochvilcz in dotnet/msbuild#14212 * Harden exceptions when connecting to server by @JanProvaznik in dotnet/msbuild#14292 * Update MicrosoftBuildVersion in analyzer template by @github-actions[bot] in dotnet/msbuild#13886 * Fix MSBuild Server client dropping build result under WaitAny race (#14172) by @JanProvaznik in dotnet/msbuild#14251 * Partially revert #13660: remove NuGet RestoreTask transient TaskHost workaround by @JanProvaznik in dotnet/msbuild#14297 * Disable daily AI credits guardrail for Expert Code Review workflow by @JanProvaznik with @Copilot in dotnet/msbuild#14314 * Localized file check-in by OneLocBuild Task: Build definition ID 9434: Build ID 14614733 by @dotnet-bot in dotnet/msbuild#14246 * Add opt-in partial (stop-after-pass) project evaluation by @ViktorHofer in dotnet/msbuild#14290 * Use partial evaluation for -getProperty/-getItem without a target by @ViktorHofer in dotnet/msbuild#14296 * [main] Source code updates from dotnet/dotnet by @dotnet-maestro[bot] in dotnet/msbuild#14324 * [main] Update dependencies from dotnet/roslyn by @dotnet-maestro[bot] in dotnet/msbuild#14333 * [main] Update dependencies from nuget/nuget.client by @dotnet-maestro[bot] in dotnet/msbuild#14330 * Bump github/gh-aw-actions/setup from 0.82.2 to 0.82.8 by @dependabot[bot] in dotnet/msbuild#14328 * Restrict partial evaluation to ProjectInstance by @ViktorHofer in dotnet/msbuild#14340 ... (truncated) Commits viewable in [compare view](dotnet/msbuild@v18.9.6...v18.10.1). </details> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Microsoft.Build.Utilities.Core&package-manager=nuget&previous-version=18.9.6&new-version=18.10.1)](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>

huulinhnguyen-dev and others added 2 commits June 8, 2026 17:50

Fix EmbedInBinlog items with relative paths from child projects

3eb4eb5

Merge branch 'main' into dev/huulinhnguyen/embedinbinlog-relative-pat…

a658ba5

…h-resolution

huulinhnguyen-dev marked this pull request as ready for review June 9, 2026 03:00

Copilot AI review requested due to automatic review settings June 9, 2026 03:00

Copilot started reviewing on behalf of huulinhnguyen-dev June 9, 2026 03:00 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

Comment thread src/Build.UnitTests/BinaryLogger_Tests.cs

Update the unit test

9c5423f

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

huulinhnguyen-dev requested a review from Copilot June 9, 2026 07:45

Copilot started reviewing on behalf of huulinhnguyen-dev June 9, 2026 07:45 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

Comment thread src/Framework/MSBuildConstants.cs

Comment thread src/Build.UnitTests/BinaryLogger_Tests.cs

huulinhnguyen-dev added 2 commits June 9, 2026 16:26

doc EmbedInBinlog paths, harden repro test

0bed385

Merge branch 'dev/huulinhnguyen/embedinbinlog-relative-path-resolutio…

379af2c

…n' of https://github.com/huulinhnguyen-dev/msbuild into dev/huulinhnguyen/embedinbinlog-relative-path-resolution

huulinhnguyen-dev requested a review from Copilot June 9, 2026 09:28

Copilot started reviewing on behalf of huulinhnguyen-dev June 9, 2026 09:28 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

Comment thread src/Build/Logging/BinaryLogger/BuildEventArgsWriter.cs

Normalize EmbedInBinlog paths for cross-platform consistency

43935b0

huulinhnguyen-dev requested a review from Copilot June 9, 2026 10:17

Copilot started reviewing on behalf of huulinhnguyen-dev June 9, 2026 10:18 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

Comment thread src/Build/Logging/BinaryLogger/BuildEventArgsWriter.cs

Guard EmbedInBinlog path resolution against malformed specs

6d22855

huulinhnguyen-dev requested a review from Copilot June 9, 2026 10:32

Copilot started reviewing on behalf of huulinhnguyen-dev June 9, 2026 10:33 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

Comment thread src/Build.UnitTests/BinaryLogger_Tests.cs Outdated

Comment thread src/Build.UnitTests/BinaryLogger_Tests.cs

Fix comment

c7aabfd

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

huulinhnguyen-dev requested a review from Copilot June 9, 2026 10:38

Copilot started reviewing on behalf of huulinhnguyen-dev June 9, 2026 10:38 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

huulinhnguyen-dev self-assigned this Jun 11, 2026

AlesProkop requested review from AlesProkop and JanProvaznik June 23, 2026 12:42

Navigation Menu

Fix EmbedInBinlog items with relative paths from child projects - #13990

Fix EmbedInBinlog items with relative paths from child projects#13990
AlesProkop merged 9 commits into
dotnet:mainfrom
huulinhnguyen-dev:dev/huulinhnguyen/embedinbinlog-relative-path-resolution

huulinhnguyen-dev commented Jun 8, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

huulinhnguyen-dev commented Jun 8, 2026

Context

Changes Made

Testing

Notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants