Add telemetry logger support for API-based MSBuild usage with BannedApiAnalyzer protection

.github/copilot-instructions.md

@@ -36,3 +36,9 @@ External Dependencies:
 - Changes that require modifications to the dotnet/templating repository (Microsoft.TemplateEngine packages) should be made directly in that repository, not worked around in this repo.
 - The dotnet/templating repository owns the TemplateEngine.Edge, TemplateEngine.Abstractions, and related packages.
 - If a change requires updates to template engine behavior or formatting (e.g., DisplayName properties), file an issue in dotnet/templating and make the changes there rather than adding workarounds in this SDK repository.
+
+Package Versioning:
+- Package versions should be managed through version property files, not hard-coded in Directory.Packages.props.
+- For packages from .NET repos (dotnet/runtime, dotnet/roslyn, etc.): Add version to eng/Version.Details.xml and eng/Version.Details.props. These are auto-updated by Maestro dependency flow.
+- For packages from other sources: Add version to eng/Versions.props for manual version management.
+- In Directory.Packages.props, always reference the version property (e.g., $(MicrosoftCodeAnalysisBannedApiAnalyzersPackageVersion)) instead of hard-coding version numbers.

BannedSymbols.txt

@@ -0,0 +1,23 @@
+# Ban direct usage of MSBuild API Build methods to ensure telemetry logger is always attached
+# Use BuildWithTelemetry extension methods from ProjectInstanceExtensions instead
+
+# Ban ProjectInstance.Build() methods
+M:Microsoft.Build.Execution.ProjectInstance.Build();Use BuildWithTelemetry() from ProjectInstanceExtensions instead
+M:Microsoft.Build.Execution.ProjectInstance.Build(System.String[],System.Collections.Generic.IEnumerable`1<Microsoft.Build.Framework.ILogger>);Use BuildWithTelemetry() from ProjectInstanceExtensions instead
+M:Microsoft.Build.Execution.ProjectInstance.Build(System.String[],System.Collections.Generic.IEnumerable`1<Microsoft.Build.Framework.ILogger>,System.Collections.Generic.IEnumerable`1<Microsoft.Build.Logging.ForwardingLoggerRecord>);Use BuildWithTelemetry() from ProjectInstanceExtensions instead
+M:Microsoft.Build.Execution.ProjectInstance.Build(System.String[],System.Collections.Generic.IEnumerable`1<Microsoft.Build.Framework.ILogger>,System.Collections.Generic.IEnumerable`1<Microsoft.Build.Logging.ForwardingLoggerRecord>,Microsoft.Build.Evaluation.Context.EvaluationContext);Use BuildWithTelemetry() from ProjectInstanceExtensions instead
+
+# Ban Project.Build() methods
+M:Microsoft.Build.Evaluation.Project.Build();Use BuildWithTelemetry() on the Project's ProjectInstance instead
+M:Microsoft.Build.Evaluation.Project.Build(Microsoft.Build.Framework.ILogger);Use BuildWithTelemetry() on the Project's ProjectInstance instead
+M:Microsoft.Build.Evaluation.Project.Build(System.String);Use BuildWithTelemetry() on the Project's ProjectInstance instead
+M:Microsoft.Build.Evaluation.Project.Build(System.String[]);Use BuildWithTelemetry() on the Project's ProjectInstance instead
+M:Microsoft.Build.Evaluation.Project.Build(System.String,System.Collections.Generic.IEnumerable`1<Microsoft.Build.Framework.ILogger>);Use BuildWithTelemetry() on the Project's ProjectInstance instead
+M:Microsoft.Build.Evaluation.Project.Build(System.String[],System.Collections.Generic.IEnumerable`1<Microsoft.Build.Framework.ILogger>);Use BuildWithTelemetry() on the Project's ProjectInstance instead
+M:Microsoft.Build.Evaluation.Project.Build(System.String[],System.Collections.Generic.IEnumerable`1<Microsoft.Build.Framework.ILogger>,System.Collections.Generic.IEnumerable`1<Microsoft.Build.Logging.ForwardingLoggerRecord>);Use BuildWithTelemetry() on the Project's ProjectInstance instead
+
+# Ban ProjectCollection constructor without telemetry - use CreateLoggersWithTelemetry() helper
+M:Microsoft.Build.Evaluation.ProjectCollection.#ctor();Use constructor with loggers from CreateLoggersWithTelemetry()
+M:Microsoft.Build.Evaluation.ProjectCollection.#ctor(System.Collections.Generic.IDictionary`2<System.String,System.String>);Use constructor with loggers from CreateLoggersWithTelemetry()
+M:Microsoft.Build.Evaluation.ProjectCollection.#ctor(Microsoft.Build.Evaluation.ToolsetDefinitionLocations);Use constructor with loggers from CreateLoggersWithTelemetry()
+M:Microsoft.Build.Evaluation.ProjectCollection.#ctor(System.Collections.Generic.IDictionary`2<System.String,System.String>,System.Collections.Generic.IEnumerable`1<Microsoft.Build.Framework.ILogger>,Microsoft.Build.Evaluation.ToolsetDefinitionLocations);Ensure telemetry logger is included via CreateLoggersWithTelemetry()

Directory.Packages.props

@@ -29,6 +29,7 @@
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Features" Version="$(MicrosoftCodeAnalysisCSharpPackageVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="$(MicrosoftCodeAnalysisCSharpWorkspacesPackageVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Features" Version="$(MicrosoftCodeAnalysisPackageVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="$(MicrosoftCodeAnalysisBannedApiAnalyzersPackageVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="$(MicrosoftCodeAnalysisPublicApiAnalyzersVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Razor.Tooling.Internal" Version="$(MicrosoftCodeAnalysisRazorToolingInternalVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic" Version="$(MicrosoftCodeAnalysisPackageVersion)" />

eng/Analyzers.props

@@ -1,5 +1,10 @@
 <Project>
   <ItemGroup Condition="'$(DotNetBuildSourceOnly)' != 'true'">
     <PackageReference Include="StyleCop.Analyzers" PrivateAssets="all" Condition="'$(EnableStyleCopAnalyzer)' == 'true'" />
+    <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" PrivateAssets="all" Condition="$(MSBuildProjectDirectory.Contains('src\Cli')) OR $(MSBuildProjectDirectory.Contains('src/Cli'))" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(DotNetBuildSourceOnly)' != 'true' AND ($(MSBuildProjectDirectory.Contains('src\Cli')) OR $(MSBuildProjectDirectory.Contains('src/Cli')))">
+    <AdditionalFiles Include="$(MSBuildThisFileDirectory)../BannedSymbols.txt" />
   </ItemGroup>
 </Project>

eng/Version.Details.props

@@ -41,6 +41,7 @@ This file should be imported by eng/Versions.props
     <MicrosoftCodeAnalysisCSharpCodeStylePackageVersion>5.0.0-2.25502.107</MicrosoftCodeAnalysisCSharpCodeStylePackageVersion>
     <MicrosoftCodeAnalysisCSharpFeaturesPackageVersion>5.0.0-2.25502.107</MicrosoftCodeAnalysisCSharpFeaturesPackageVersion>
     <MicrosoftCodeAnalysisCSharpWorkspacesPackageVersion>5.0.0-2.25502.107</MicrosoftCodeAnalysisCSharpWorkspacesPackageVersion>
+    <MicrosoftCodeAnalysisBannedApiAnalyzersPackageVersion>5.0.0-2.25502.107</MicrosoftCodeAnalysisBannedApiAnalyzersPackageVersion>
     <MicrosoftCodeAnalysisPublicApiAnalyzersPackageVersion>5.0.0-2.25502.107</MicrosoftCodeAnalysisPublicApiAnalyzersPackageVersion>
     <MicrosoftCodeAnalysisRazorToolingInternalPackageVersion>10.0.0-preview.25502.107</MicrosoftCodeAnalysisRazorToolingInternalPackageVersion>
     <MicrosoftCodeAnalysisWorkspacesCommonPackageVersion>5.0.0-2.25502.107</MicrosoftCodeAnalysisWorkspacesCommonPackageVersion>
@@ -183,6 +184,7 @@ This file should be imported by eng/Versions.props
     <MicrosoftCodeAnalysisCSharpCodeStyleVersion>$(MicrosoftCodeAnalysisCSharpCodeStylePackageVersion)</MicrosoftCodeAnalysisCSharpCodeStyleVersion>
     <MicrosoftCodeAnalysisCSharpFeaturesVersion>$(MicrosoftCodeAnalysisCSharpFeaturesPackageVersion)</MicrosoftCodeAnalysisCSharpFeaturesVersion>
     <MicrosoftCodeAnalysisCSharpWorkspacesVersion>$(MicrosoftCodeAnalysisCSharpWorkspacesPackageVersion)</MicrosoftCodeAnalysisCSharpWorkspacesVersion>
+    <MicrosoftCodeAnalysisBannedApiAnalyzersVersion>$(MicrosoftCodeAnalysisBannedApiAnalyzersPackageVersion)</MicrosoftCodeAnalysisBannedApiAnalyzersVersion>
     <MicrosoftCodeAnalysisPublicApiAnalyzersVersion>$(MicrosoftCodeAnalysisPublicApiAnalyzersPackageVersion)</MicrosoftCodeAnalysisPublicApiAnalyzersVersion>
     <MicrosoftCodeAnalysisRazorToolingInternalVersion>$(MicrosoftCodeAnalysisRazorToolingInternalPackageVersion)</MicrosoftCodeAnalysisRazorToolingInternalVersion>
     <MicrosoftCodeAnalysisWorkspacesCommonVersion>$(MicrosoftCodeAnalysisWorkspacesCommonPackageVersion)</MicrosoftCodeAnalysisWorkspacesCommonVersion>

eng/Version.Details.xml

@@ -124,6 +124,10 @@
       <Uri>https://dev.azure.com/dnceng/internal/_git/dotnet-dotnet</Uri>
       <Sha>89c8f6a112d37d2ea8b77821e56d170a1bccdc5a</Sha>
     </Dependency>
+    <Dependency Name="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="5.0.0-2.25502.107">
+      <Uri>https://dev.azure.com/dnceng/internal/_git/dotnet-dotnet</Uri>
+      <Sha>89c8f6a112d37d2ea8b77821e56d170a1bccdc5a</Sha>
+    </Dependency>
     <Dependency Name="Microsoft.Build.NuGetSdkResolver" Version="7.0.0-rc.307">
       <Uri>https://dev.azure.com/dnceng/internal/_git/dotnet-dotnet</Uri>
       <Sha>89c8f6a112d37d2ea8b77821e56d170a1bccdc5a</Sha>

src/BuiltInTools/dotnet-watch/Build/EvaluationResult.cs

@@ -3,6 +3,7 @@
 
 using System.Collections.Immutable;
 using Microsoft.Build.Graph;
+using Microsoft.DotNet.Cli.Extensions;
 using Microsoft.Extensions.Logging;
 
 namespace Microsoft.DotNet.Watch;
@@ -75,7 +76,7 @@ public void WatchFiles(FileWatcher fileWatcher)
         {
             using (var loggers = buildReporter.GetLoggers(rootNode.ProjectInstance.FullPath, "Restore"))
             {
-                if (!rootNode.ProjectInstance.Build([TargetNames.Restore], loggers))
+                if (!rootNode.ProjectInstance.BuildWithTelemetry([TargetNames.Restore], loggers))
                 {
                     logger.LogError("Failed to restore project '{Path}'.", rootProjectPath);
                     loggers.ReportOutput();
@@ -103,7 +104,7 @@ public void WatchFiles(FileWatcher fileWatcher)
 
             using (var loggers = buildReporter.GetLoggers(projectInstance.FullPath, "DesignTimeBuild"))
             {
-                if (!projectInstance.Build([TargetNames.Compile, .. customCollectWatchItems], loggers))
+                if (!projectInstance.BuildWithTelemetry([TargetNames.Compile, .. customCollectWatchItems], loggers))
                 {
                     logger.LogError("Failed to build project '{Path}'.", projectInstance.FullPath);
                     loggers.ReportOutput();

src/BuiltInTools/dotnet-watch/HotReload/HotReloadDotNetWatcher.cs

@@ -5,6 +5,7 @@
 using System.Diagnostics;
 using Microsoft.Build.Graph;
 using Microsoft.CodeAnalysis;
+using Microsoft.DotNet.Cli.Extensions;
 using Microsoft.DotNet.HotReload;
 using Microsoft.Extensions.Logging;
 
@@ -582,7 +583,7 @@ private void DeployProjectDependencies(ProjectGraph graph, ImmutableArray<string
                 }
 
                 using var loggers = buildReporter.GetLoggers(projectPath, targetName);
-                if (!node.ProjectInstance.Build([targetName], loggers, out var targetOutputs))
+                if (!node.ProjectInstance.BuildWithTelemetry([targetName], loggers, null, out var targetOutputs))
                 {
                     _context.Logger.LogDebug("{TargetName} target failed", targetName);
                     loggers.ReportOutput();
@@ -791,7 +792,7 @@ void Report(ChangeKind kind)
             }
 
             string GetMessage(IReadOnlyList<ChangedFile> items, ChangeKind kind)
-                => items is [{Item: var item }]
+                => items is [{ Item: var item }]
                     ? GetSingularMessage(kind) + ": " + GetRelativeFilePath(item.FilePath)
                     : GetPluralMessage(kind) + ": " + string.Join(", ", items.Select(f => GetRelativeFilePath(f.Item.FilePath)));
 

src/BuiltInTools/dotnet-watch/HotReload/ScopedCssFileHandler.cs

@@ -3,6 +3,7 @@
 
 
 using Microsoft.Build.Graph;
+using Microsoft.DotNet.Cli.Extensions;
 using Microsoft.Extensions.Logging;
 
 namespace Microsoft.DotNet.Watch
@@ -61,7 +62,7 @@ public async ValueTask HandleFileChangesAsync(IReadOnlyList<ChangedFile> files,
                 using var loggers = buildReporter.GetLoggers(projectNode.ProjectInstance.FullPath, BuildTargetName);
 
                 // Deep copy so that we don't pollute the project graph:
-                if (!projectNode.ProjectInstance.DeepCopy().Build(BuildTargetName, loggers))
+                if (!projectNode.ProjectInstance.DeepCopy().BuildWithTelemetry([BuildTargetName], loggers))
                 {
                     loggers.ReportOutput();
                     return null;

src/Cli/dotnet/CliCompletion.cs

@@ -5,6 +5,7 @@
 
 using System.CommandLine.Completions;
 using Microsoft.Build.Evaluation;
+using Microsoft.DotNet.Cli.Extensions;
 using Microsoft.DotNet.Cli.Utils;
 using static System.Array;
 
@@ -69,8 +70,9 @@ private static MsbuildProject GetMSBuildProject()
     {
         try
         {
+            var (loggers, _) = ProjectInstanceExtensions.CreateLoggersWithTelemetry();
             return MsbuildProject.FromFileOrDirectory(
-                new ProjectCollection(),
+                new ProjectCollection(globalProperties: null, loggers: loggers, toolsetDefinitionLocations: ToolsetDefinitionLocations.Default),
                 Directory.GetCurrentDirectory(), interactive: false);
         }
         catch (Exception e)

src/Cli/dotnet/CommandFactory/CommandResolution/ProjectToolsCommandResolver.cs

@@ -385,7 +385,7 @@ internal void GenerateDepsJsonFile(
         string? stdOut;
         string? stdErr;
 
-        var msbuildArgs = MSBuildArgs.AnalyzeMSBuildArguments([..args], CommonOptions.PropertiesOption, CommonOptions.RestorePropertiesOption, BuildCommandParser.TargetOption, BuildCommandParser.VerbosityOption);
+        var msbuildArgs = MSBuildArgs.AnalyzeMSBuildArguments([.. args], CommonOptions.PropertiesOption, CommonOptions.RestorePropertiesOption, BuildCommandParser.TargetOption, BuildCommandParser.VerbosityOption);
         var forwardingAppWithoutLogging = new MSBuildForwardingAppWithoutLogging(msbuildArgs, msBuildExePath);
         if (forwardingAppWithoutLogging.ExecuteMSBuildOutOfProc)
         {

src/Cli/dotnet/Commands/Build/BuildCommand.cs

@@ -12,7 +12,7 @@ public static class BuildCommand
 {
     public static CommandBase FromArgs(string[] args, string? msbuildPath = null)
     {
-        var parseResult = Parser.Parse(["dotnet", "build", ..args]);
+        var parseResult = Parser.Parse(["dotnet", "build", .. args]);
         return FromParseResult(parseResult, msbuildPath);
     }
 

src/Cli/dotnet/Commands/Clean/CleanCommand.cs

@@ -13,7 +13,7 @@ public class CleanCommand(MSBuildArgs msbuildArgs, string? msbuildPath = null) :
 {
     public static CommandBase FromArgs(string[] args, string? msbuildPath = null)
     {
-        var result = Parser.Parse(["dotnet", "clean", ..args]);
+        var result = Parser.Parse(["dotnet", "clean", .. args]);
         return FromParseResult(result, msbuildPath);
     }
 
@@ -33,7 +33,7 @@ public static CommandBase FromParseResult(ParseResult result, string? msbuildPat
                 NoWriteBuildMarkers = true,
             },
             static (msbuildArgs, msbuildPath) => new CleanCommand(msbuildArgs, msbuildPath),
-            [ CommonOptions.PropertiesOption, CommonOptions.RestorePropertiesOption, CleanCommandParser.TargetOption, CleanCommandParser.VerbosityOption ],
+            [CommonOptions.PropertiesOption, CommonOptions.RestorePropertiesOption, CleanCommandParser.TargetOption, CleanCommandParser.VerbosityOption],
             result,
             msbuildPath
         );

src/Cli/dotnet/Commands/Format/FormatCommand.cs

@@ -13,7 +13,7 @@ public class FormatCommand(IEnumerable<string> argsToForward) : FormatForwarding
 {
     public static FormatCommand FromArgs(string[] args)
     {
-        var result = Parser.Parse(["dotnet", "format", ..args]);
+        var result = Parser.Parse(["dotnet", "format", .. args]);
         return FromParseResult(result);
     }
 

src/Cli/dotnet/Commands/Hidden/Complete/CompleteCommand.cs

@@ -19,7 +19,7 @@ public static int Run(ParseResult parseResult)
 
     public static int RunWithReporter(string[] args, IReporter reporter)
     {
-        var result = Parser.Parse(["dotnet", "complete", ..args]);
+        var result = Parser.Parse(["dotnet", "complete", .. args]);
         return RunWithReporter(result, reporter);
     }
 

src/Cli/dotnet/Commands/Hidden/InternalReportInstallSuccess/InternalReportInstallSuccessCommand.cs

@@ -25,7 +25,7 @@ public static int Run(ParseResult parseResult)
 
     public static void ProcessInputAndSendTelemetry(string[] args, ITelemetry telemetry)
     {
-        var result = Parser.Parse(["dotnet", "internal-reportinstallsuccess", ..args]);
+        var result = Parser.Parse(["dotnet", "internal-reportinstallsuccess", .. args]);
         ProcessInputAndSendTelemetry(result, telemetry);
     }
 

src/Cli/dotnet/Commands/MSBuild/MSBuildCommand.cs

@@ -10,11 +10,11 @@ namespace Microsoft.DotNet.Cli.Commands.MSBuild;
 public class MSBuildCommand(
     IEnumerable<string> msbuildArgs,
     string? msbuildPath = null
-) : MSBuildForwardingApp(MSBuildArgs.AnalyzeMSBuildArguments([..msbuildArgs], CommonOptions.PropertiesOption, CommonOptions.RestorePropertiesOption, MSBuildCommandParser.TargetOption, CommonOptions.VerbosityOption()), msbuildPath, includeLogo: true)
+) : MSBuildForwardingApp(MSBuildArgs.AnalyzeMSBuildArguments([.. msbuildArgs], CommonOptions.PropertiesOption, CommonOptions.RestorePropertiesOption, MSBuildCommandParser.TargetOption, CommonOptions.VerbosityOption()), msbuildPath, includeLogo: true)
 {
     public static MSBuildCommand FromArgs(string[] args, string? msbuildPath = null)
     {
-        var result = Parser.Parse(["dotnet", "msbuild", ..args]);
+        var result = Parser.Parse(["dotnet", "msbuild", .. args]);
         return FromParseResult(result, msbuildPath);
     }
 

src/Cli/dotnet/Commands/MSBuild/MSBuildLogger.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Globalization;

src/Cli/dotnet/Commands/New/MSBuildEvaluation/MSBuildEvaluator.cs

@@ -3,6 +3,7 @@
 
 using System.Diagnostics;
 using Microsoft.Build.Evaluation;
+using Microsoft.DotNet.Cli.Extensions;
 using Microsoft.DotNet.Cli.Utils;
 using Microsoft.Extensions.Logging;
 using Microsoft.TemplateEngine.Abstractions;
@@ -13,7 +14,7 @@ namespace Microsoft.DotNet.Cli.Commands.New.MSBuildEvaluation;
 
 internal class MSBuildEvaluator : IIdentifiedComponent
 {
-    private readonly ProjectCollection _projectCollection = new();
+    private readonly ProjectCollection _projectCollection;
     private readonly object _lockObj = new();
 
     private IEngineEnvironmentSettings? _settings;
@@ -24,12 +25,16 @@ internal class MSBuildEvaluator : IIdentifiedComponent
     internal MSBuildEvaluator()
     {
         _outputDirectory = Directory.GetCurrentDirectory();
+        var (loggers, _) = ProjectInstanceExtensions.CreateLoggersWithTelemetry();
+        _projectCollection = new ProjectCollection(globalProperties: null, loggers: loggers, toolsetDefinitionLocations: ToolsetDefinitionLocations.Default);
     }
 
     internal MSBuildEvaluator(string? outputDirectory = null, string? projectPath = null)
     {
         _outputDirectory = outputDirectory ?? Directory.GetCurrentDirectory();
         _projectFullPath = projectPath != null ? Path.GetFullPath(projectPath) : null;
+        var (loggers, _) = ProjectInstanceExtensions.CreateLoggersWithTelemetry();
+        _projectCollection = new ProjectCollection(globalProperties: null, loggers: loggers, toolsetDefinitionLocations: ToolsetDefinitionLocations.Default);
     }
 
     public Guid Id => Guid.Parse("{6C2CB5CA-06C3-460A-8ADB-5F21E113AB24}");

src/Cli/dotnet/Commands/Pack/PackCommand.cs

@@ -24,7 +24,7 @@ public class PackCommand(
 {
     public static CommandBase FromArgs(string[] args, string? msbuildPath = null)
     {
-        var parseResult = Parser.Parse(["dotnet", "pack", ..args]);
+        var parseResult = Parser.Parse(["dotnet", "pack", .. args]);
         return FromParseResult(parseResult, msbuildPath);
     }
 
@@ -92,14 +92,14 @@ public static int RunPackCommand(ParseResult parseResult)
 
         if (args.Count != 1)
         {
-            Console.Error.WriteLine(CliStrings.PackCmd_OneNuspecAllowed); 
+            Console.Error.WriteLine(CliStrings.PackCmd_OneNuspecAllowed);
             return 1;
         }
 
         var nuspecPath = args[0];
 
         var packArgs = new PackArgs()
-        { 
+        {
             Logger = new NuGetConsoleLogger(),
             Exclude = new List<string>(),
             OutputDirectory = parseResult.GetValue(PackCommandParser.OutputOption),