Skip to content

MSBuildBinaryLog: Retrieve inner assets files for multi-target project #1891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Julien Lebosquain (MrJul) wants to merge 4 commits into
base: main
Choose a base branch
from
Open

MSBuildBinaryLog: Retrieve inner assets files for multi-target project #1891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cf5f21d
Add failing tests for multi-target projects
MrJul Oct 9, 2026
24bd1d6
Retrieve inner assets files for multi-target project
MrJul Oct 9, 2026
ac03948
Properly merge inner builds
MrJul Oct 9, 2026
c88f105
Bump detector version
MrJul Oct 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 2 additions & 22 deletions src/Microsoft.ComponentDetection.Detectors/nuget/BinLogProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,30 +221,10 @@ private void AddOrMergeProjectInfo(
existing.InnerBuilds.Add(projectInfo);
}
}
else if (existing.IsOuterBuild && projectInfo.IsOuterBuild)
{
// Both are outer builds (e.g. build + publish of a multi-targeted project)
// Merge inner builds: for matching TFMs, merge; for new TFMs, add
foreach (var newInner in projectInfo.InnerBuilds)
{
var matchingInner = existing.InnerBuilds.FirstOrDefault(
ib => string.Equals(ib.TargetFramework, newInner.TargetFramework, StringComparison.OrdinalIgnoreCase));
if (matchingInner != null)
{
matchingInner.MergeWith(newInner);
}
else
{
existing.InnerBuilds.Add(newInner);
}
}

// Merge the outer build properties/items too
existing.MergeWith(projectInfo);
}
else
{
// Fallback: merge properties/items as superset
// Both are outer builds (e.g. build + publish of a multi-targeted project), or fallback:
// merge properties/items and inner builds (by TFM) as superset
existing.MergeWith(projectInfo);
}
}
Expand Down
50 changes: 39 additions & 11 deletions src/Microsoft.ComponentDetection.Detectors/nuget/MSBuildBinaryLogComponentDetector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ internal MSBuildBinaryLogComponentDetector(
public override IEnumerable<ComponentType> SupportedComponentTypes { get; } = [ComponentType.NuGet, ComponentType.DotNet];

/// <inheritdoc />
public override int Version { get; } = 1;
public override int Version { get; } = 2;

/// <inheritdoc />
public override Task<IndividualDetectorScanResult> ExecuteDetectorAsync(ScanRequest request, CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -246,6 +246,26 @@ private static MSBuildProjectInfo GetInnerBuildOrDefault(MSBuildProjectInfo proj
return projectInfo;
}

/// <summary>
/// Gets the assets files a project info should be indexed by.
/// </summary>
/// <remarks>
/// The outer build of a multi-targeted project never has ProjectAssetsFile, only the inner builds do.
/// </remarks>
private static IEnumerable<string> GetProjectAssetsFiles(MSBuildProjectInfo projectInfo)
{
if (!string.IsNullOrEmpty(projectInfo.ProjectAssetsFile))
{
return [projectInfo.ProjectAssetsFile];
}

return projectInfo.InnerBuilds
.Select(ib => ib.ProjectAssetsFile)
.Where(f => !string.IsNullOrEmpty(f))
.Select(f => f!)
.Distinct(StringComparer.OrdinalIgnoreCase);
}

/// <summary>
/// Maps the MSBuild OutputType property to "application" or "library".
/// Returns <c>null</c> for empty/unknown values rather than guessing.
Expand Down Expand Up @@ -336,30 +356,38 @@ private void IndexProjectInfo(MSBuildProjectInfo projectInfo, List<string> asset
// Use AddOrUpdate+MergeWith so that multiple binlogs for the same project
// (e.g., build and publish passes) form a superset rather than keeping only the first.
// Normalize to forward slashes so lookup from OS-native ComponentStream.Location matches.
if (!string.IsNullOrEmpty(projectInfo.ProjectAssetsFile))
foreach (var assetsFile in GetProjectAssetsFiles(projectInfo))

@MrJul Julien Lebosquain (MrJul) Oct 9, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

ac03948 now merges the inner builds.

{
var normalizedAssetsPath = PathRebasingUtility.NormalizePath(projectInfo.ProjectAssetsFile);
var normalizedAssetsPath = PathRebasingUtility.NormalizePath(assetsFile);
this.projectInfoByAssetsFile.AddOrUpdate(
normalizedAssetsPath,
_ => projectInfo,
(_, existing) => existing.MergeWith(projectInfo));
assetsFilesFound.Add(projectInfo.ProjectAssetsFile);
assetsFilesFound.Add(assetsFile);
}
}

private void LogMissingAssetsWarnings(MSBuildProjectInfo projectInfo)
{
if (string.IsNullOrEmpty(projectInfo.ProjectAssetsFile))
var hasAssetFile = false;

foreach (var assetsFile in GetProjectAssetsFiles(projectInfo))
{
this.Logger.LogWarning(
"No ProjectAssetsFile property found in binlog for project: {ProjectPath}. NuGet dependencies may not be detected.",
projectInfo.ProjectPath);
hasAssetFile = true;

if (!this.fileUtilityService.Exists(assetsFile))
{
this.Logger.LogWarning(
"Project.assets.json referenced in binlog does not exist: {AssetsFile} (from project {ProjectPath})",
assetsFile,
projectInfo.ProjectPath);
}
}
else if (!this.fileUtilityService.Exists(projectInfo.ProjectAssetsFile))

if (!hasAssetFile)
{
this.Logger.LogWarning(
"Project.assets.json referenced in binlog does not exist: {AssetsFile} (from project {ProjectPath})",
projectInfo.ProjectAssetsFile,
"No ProjectAssetsFile property found in binlog for project: {ProjectPath}. NuGet dependencies may not be detected.",
projectInfo.ProjectPath);
}
}
Expand Down
23 changes: 23 additions & 0 deletions src/Microsoft.ComponentDetection.Detectors/nuget/MSBuildProjectInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ namespace Microsoft.ComponentDetection.Detectors.NuGet;

using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Build.Framework;

/// <summary>
Expand Down Expand Up @@ -238,11 +239,17 @@ public bool TryRemoveItem(string itemType, string itemSpec)
/// and target framework — the merge fills in any values that were not set rather than overriding.
/// Boolean properties use logical OR (any true value is sufficient to classify the project).
/// Items from <paramref name="other"/> are added if not already present.
/// Inner builds are merged by target framework: matching ones are merged recursively, new ones are added.
/// </summary>
/// <param name="other">The other project info to merge from.</param>
/// <returns>This instance for fluent chaining.</returns>
public MSBuildProjectInfo MergeWith(MSBuildProjectInfo other)
{
if (ReferenceEquals(this, other))
{
return this;
}

// Merge boolean properties: true wins. For all classification booleans (IsTestProject,
// IsDevelopment, IsShipping, etc.), if any pass reports true it is sufficient to classify
// the project accordingly. These values are not expected to differ across passes, if they
Expand All @@ -266,6 +273,22 @@ public MSBuildProjectInfo MergeWith(MSBuildProjectInfo other)
MergeItems(this.PackageReference, other.PackageReference);
MergeItems(this.PackageDownload, other.PackageDownload);

// Merge inner builds by target framework, so that per-TFM properties and items
// from later passes (e.g. publish) of a multi-targeted project are not lost.
foreach (var otherInner in other.InnerBuilds)
{
var matchingInner = this.InnerBuilds.FirstOrDefault(
ib => string.Equals(ib.TargetFramework, otherInner.TargetFramework, StringComparison.OrdinalIgnoreCase));
if (matchingInner != null)
{
matchingInner.MergeWith(otherInner);
}
else
{
this.InnerBuilds.Add(otherInner);
}
}

return this;
}

Expand Down
104 changes: 104 additions & 0 deletions ...rosoft.ComponentDetection.Detectors.Tests/nuget/MSBuildBinaryLogComponentDetectorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,51 @@ public async Task WithBinlog_MultiTarget_PerTfmDevDependency()
recorder.GetEffectiveDevDependencyValue(component.Component.Id).Should().BeFalse();
}

[TestMethod]
public async Task WithBinlog_MultiTarget_OuterBuildWithoutAssetsFile_IsShippingFalse_AllDependenciesMarkedAsDev()
{
var outer = CreateProjectInfo(targetFramework: null);
outer.ProjectAssetsFile = null;
outer.IsShipping = false;
outer.TrySetProperty("TargetFrameworks", "net8.0;net6.0");

var innerNet8 = new MSBuildProjectInfo { ProjectPath = ProjectPath, ProjectAssetsFile = AssetsFilePath, TargetFramework = "net8.0", IsShipping = false };
var innerNet6 = new MSBuildProjectInfo { ProjectPath = ProjectPath, ProjectAssetsFile = AssetsFilePath, TargetFramework = "net6.0", IsShipping = false };

outer.InnerBuilds.Add(innerNet8);
outer.InnerBuilds.Add(innerNet6);

var (result, recorder) = await ExecuteWithBinlogAsync([outer], MultiTargetAssetsJson());

result.ResultCode.Should().Be(ProcessingResultCode.Success);
var component = recorder.GetDetectedComponents()
.Single(c => c.Component is NuGetComponent { Name: "Newtonsoft.Json" });
recorder.GetEffectiveDevDependencyValue(component.Component.Id).Should().BeTrue();
Comment thread
Copilot marked this conversation as resolved.
}

[TestMethod]
public async Task WithBinlog_MultiTarget_OuterBuildWithoutAssetsFile_UsesInnerBuildPerTfm()
{
var outer = CreateProjectInfo(targetFramework: null);
outer.ProjectAssetsFile = null;
outer.TrySetProperty("TargetFrameworks", "net8.0;net6.0");

var innerNet8 = new MSBuildProjectInfo { ProjectPath = ProjectPath, ProjectAssetsFile = AssetsFilePath, TargetFramework = "net8.0" };
AddPackageReference(innerNet8, "Newtonsoft.Json", isDevelopmentDependency: true);
var innerNet6 = new MSBuildProjectInfo { ProjectPath = ProjectPath, ProjectAssetsFile = AssetsFilePath, TargetFramework = "net6.0" };
AddPackageReference(innerNet6, "Newtonsoft.Json", isDevelopmentDependency: true);

outer.InnerBuilds.Add(innerNet8);
outer.InnerBuilds.Add(innerNet6);

var (result, recorder) = await ExecuteWithBinlogAsync([outer], MultiTargetAssetsJson());

result.ResultCode.Should().Be(ProcessingResultCode.Success);
var component = recorder.GetDetectedComponents()
.Single(c => c.Component is NuGetComponent { Name: "Newtonsoft.Json" });
recorder.GetEffectiveDevDependencyValue(component.Component.Id).Should().BeTrue();
}

[TestMethod]
public async Task WithBinlog_NoBinlogMatch_FallsBackToStandardProcessing()
{
Expand Down Expand Up @@ -654,6 +699,65 @@ public async Task MultipleBinlogs_MergesTestProjectFlag_AllDepsAreDev()
recorder.GetEffectiveDevDependencyValue(component.Component.Id).Should().BeTrue();
}

[TestMethod]
public async Task MultipleBinlogs_MultiTarget_MergesInnerBuildProperties_AllDepsAreDev()
{
// Outer builds of a multi-targeted project don't have ProjectAssetsFile:
// properties set only on the inner builds of the second binlog must still be merged.
static MSBuildProjectInfo CreateMultiTargetProjectInfo(bool? isTestProject)
{
var outer = CreateProjectInfo(targetFramework: null);
outer.ProjectAssetsFile = null;
outer.TrySetProperty("TargetFrameworks", "net8.0;net6.0");
outer.InnerBuilds.Add(new MSBuildProjectInfo { ProjectPath = ProjectPath, ProjectAssetsFile = AssetsFilePath, TargetFramework = "net8.0", IsTestProject = isTestProject });
outer.InnerBuilds.Add(new MSBuildProjectInfo { ProjectPath = ProjectPath, ProjectAssetsFile = AssetsFilePath, TargetFramework = "net6.0", IsTestProject = isTestProject });
return outer;
}

var binlogs = new Dictionary<string, IReadOnlyList<MSBuildProjectInfo>>
{
[BinlogFilePath] = [CreateMultiTargetProjectInfo(isTestProject: null)],
[TestBinlogFilePath] = [CreateMultiTargetProjectInfo(isTestProject: true)],
};

var (result, recorder) = await ExecuteWithMultipleBinlogsAsync(binlogs, MultiTargetAssetsJson());

result.ResultCode.Should().Be(ProcessingResultCode.Success);
var component = recorder.GetDetectedComponents()
.Single(c => c.Component is NuGetComponent { Name: "Newtonsoft.Json" });
recorder.GetEffectiveDevDependencyValue(component.Component.Id).Should().BeTrue();
}

[TestMethod]
public async Task MultipleBinlogs_MultiTarget_AddsInnerBuildsFromLaterBinlog()
{
// First binlog only built net8.0, second only built net6.0: both inner builds
// (and their package metadata) must be available when processing the shared assets file.
static MSBuildProjectInfo CreateMultiTargetProjectInfo(string targetFramework)
{
var outer = CreateProjectInfo(targetFramework: null);
outer.ProjectAssetsFile = null;
outer.TrySetProperty("TargetFrameworks", "net8.0;net6.0");
var inner = new MSBuildProjectInfo { ProjectPath = ProjectPath, ProjectAssetsFile = AssetsFilePath, TargetFramework = targetFramework };
AddPackageReference(inner, "Newtonsoft.Json", isDevelopmentDependency: true);
outer.InnerBuilds.Add(inner);
return outer;
}

var binlogs = new Dictionary<string, IReadOnlyList<MSBuildProjectInfo>>
{
[BinlogFilePath] = [CreateMultiTargetProjectInfo("net8.0")],
[PublishBinlogFilePath] = [CreateMultiTargetProjectInfo("net6.0")],
};

var (result, recorder) = await ExecuteWithMultipleBinlogsAsync(binlogs, MultiTargetAssetsJson());

result.ResultCode.Should().Be(ProcessingResultCode.Success);
var component = recorder.GetDetectedComponents()
.Single(c => c.Component is NuGetComponent { Name: "Newtonsoft.Json" });
recorder.GetEffectiveDevDependencyValue(component.Component.Id).Should().BeTrue();
}

// ================================================================
// Cancellation
// ================================================================
Expand Down