From cf264e2ef40835219169ff6dd27d5f798d90082c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 5 Dec 2025 14:18:09 +0000 Subject: [PATCH 01/39] Initial plan From 3c0d56af041a8e3f828ea892c91fe7a473864668 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 5 Dec 2025 14:57:30 +0000 Subject: [PATCH 02/39] WIP: Investigation of chained item function comparison issue The issue is that when chaining item functions like: @(TestItem->WithMetadataValue('Identity', 'Test1')->WithMetadataValue('Foo', 'Baz')) The result incorrectly evaluates as non-empty when compared in a condition, even though the actual result is empty. Initial hypothesis was that the BreakOnNotEmpty optimization in Transform() was breaking early after the first transform. However, testing revealed that the Transform() method is NOT being called at all for chained transforms with BreakOnNotEmpty option. This suggests the bug is elsewhere - possibly in how ExpressionShredder parses chained transforms or in how they're evaluated separately. Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com> --- src/Build/Evaluation/Expander.cs | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/src/Build/Evaluation/Expander.cs b/src/Build/Evaluation/Expander.cs index 9c6afc433e2..5cbb297a6af 100644 --- a/src/Build/Evaluation/Expander.cs +++ b/src/Build/Evaluation/Expander.cs @@ -2021,21 +2021,25 @@ internal static List> Transform( break; } + // If we have another transform, swap the source and transform lists. + if (i < captures.Count - 1) + { + (transformedItems, sourceItems) = (sourceItems, transformedItems); + transformedItems.Clear(); + } + } + + // Check for break on non-empty only after ALL transforms are complete + if ((options & ExpanderOptions.BreakOnNotEmpty) != 0) + { foreach (KeyValuePair itemTuple in transformedItems) { - if (!string.IsNullOrEmpty(itemTuple.Key) && (options & ExpanderOptions.BreakOnNotEmpty) != 0) + if (!string.IsNullOrEmpty(itemTuple.Key)) { brokeEarly = true; return transformedItems; // break out early } } - - // If we have another transform, swap the source and transform lists. - if (i < captures.Count - 1) - { - (transformedItems, sourceItems) = (sourceItems, transformedItems); - transformedItems.Clear(); - } } brokeEarly = false; From e991105e9cfbc8d08f1f81c83bb3a17f56fe7963 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 5 Dec 2025 15:09:23 +0000 Subject: [PATCH 03/39] Fix chained item function empty string comparison in conditions When chaining item functions like @(Item->Func1()->Func2()), and the final result is empty, the condition comparison with empty string was incorrectly evaluating to false. The bug was in the Transform method in Expander.cs. The original code checked for BreakOnNotEmpty after EACH intermediate transform, causing it to break early when an intermediate result was non-empty, even if subsequent transforms would filter to an empty result. The fix moves the BreakOnNotEmpty check to after ALL transforms in the chain complete, ensuring we only check the final result, not intermediate ones. Added a unit test to verify the fix works correctly. Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com> --- .../Evaluation/Expander_Tests.cs | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/src/Build.UnitTests/Evaluation/Expander_Tests.cs b/src/Build.UnitTests/Evaluation/Expander_Tests.cs index e6e9e1597d0..08ecacd2a7a 100644 --- a/src/Build.UnitTests/Evaluation/Expander_Tests.cs +++ b/src/Build.UnitTests/Evaluation/Expander_Tests.cs @@ -5268,5 +5268,35 @@ public void PropertyFunctionRegisterBuildCheck() logger.AllBuildEvents.Count.ShouldBe(1); } } + + /// + /// Test for issue where chained item functions with empty results incorrectly evaluate as non-empty in conditions + /// + [Fact] + public void ChainedItemFunctionEmptyResultInCondition() + { + string content = @" + + + + + + + + + WithMetadataValue('Identity', 'Test1')->WithMetadataValue('Foo', 'Baz'))' == ''""> + TRUE + + + + + + "; + + MockLogger log = Helpers.BuildProjectWithNewOMExpectSuccess(content); + + // The chained WithMetadataValue should return empty, so the condition should be true and EmptyResult should be set + log.AssertLogContains("EmptyResult=TRUE"); + } } } From 49a6fd48e744ed899e94e9354008c30b7f3889f2 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 5 Jan 2026 14:12:08 +0000 Subject: [PATCH 04/39] Fix unhandled exception in /getItem and /getTargetResult for items with illegal path characters (#12841) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Context `/getItem` and `/getTargetResult` throw an unhandled `InvalidOperationException` when serializing items whose item specs contain illegal path characters (e.g., compiler command line flags from ClangTidy's `GetCompileCommands` target). The JSON output formatter iterates over all metadata names including built-in metadata like `FullPath`, `Directory`, etc. When `GetMetadata()` is called on these, it attempts path computation which fails for non-path item specs. ### Changes Made - Wrapped metadata retrieval in `JsonOutputFormatter.cs` with try-catch for `InvalidOperationException` - Added `TryGetMetadata` and `TryGetMetadataValue` helper methods that return empty string on failure - Applied fix to all three affected methods: `AddTargetResultsInJsonFormat`, `AddItemInstancesInJsonFormat`, `AddItemsInJsonFormat` - Exception handling catches all `InvalidOperationException` instances to ensure compatibility across all locales (error messages are localized) ### Testing Added `GetTargetResultWithIllegalPathCharacters` test that verifies both `/getTargetResult` and `/getItem` succeed with items containing compiler flags as item specs. ### Notes On Linux, the test shows the path-like metadata is still computed (since `/` is valid in paths). On Windows, these would return empty strings. The key fix is preventing the unhandled exception crash. The exception handling is intentionally broad (catching all `InvalidOperationException` without message filtering) to ensure the fix works correctly in all locales, as error messages from MSBuild are localized and checking for specific English text would fail in non-English environments.
Original prompt ---- *This section details on the original issue you should resolve* [Unhandled Exception]: /getItem and /getTargetResult fail for target GetCompileCommands ### Issue Description There is an uncaught exception when trying to access certain information from the GetCompileCommands target (from ClangTidy), in particular `/getTargetResult:GetCompileCommands` and `/getTargetResult:GetCompileCommands` ### Steps to Reproduce [tidytest.zip](https://github.com/user-attachments/files/22645381/tidytest.zip) Run either of the following commands (You could also run with target `/t:ClangTidy` for the same result) ``` msbuild tidytest.vcxproj /t:GetCompileCommands /getTargetResult:GetCompileCommands msbuild tidytest.vcxproj /t:GetCompileCommands /getItem:CompileCommands ``` I expect to get a json formatted target result or item. ### Actual Behavior I get the following error when building ``` C:\Users\rp0656\source\repos\tidytest>msbuild tidytest.vcxproj /t:GetCompileCommands /getTargetResult:GetCompileCommands MSBUILD : error MSB1025: An internal failure occurred while running MSBuild. System.InvalidOperationException: The item metadata "%(FullPath)" cannot be applied to the path "/c /nologo /W3 /WX- /diagnostics:column /Od /D _DEBUG /D _CONSOLE /D _UNICODE /D UNICODE /EHsc /RTC1 /MDd /GS /fp:precise /permissive- /Fa"tidytest\x64\Debug\\" /Fo"tidytest\x64\Debug\\" /Gd --target=amd64-pc-windows-msvc /TP". Illegal characters in path. at Microsoft.Build.Shared.ErrorUtilities.ThrowInvalidOperation(String resourceName, Object[] args) at Microsoft.Build.Shared.FileUtilities.ItemSpecModifiers.GetItemSpecModifier(String currentDirectory, String itemSpec, String definingProjectEscaped, String modifier, String& fullPath) at Microsoft.Build.Evaluation.BuiltInMetadata.GetMetadataValueEscaped(String currentDirectory, String evaluatedIncludeBeforeWildcardExpansionEscaped, String evaluatedIncludeEscaped, String definingProjectEscaped, String name, String& fullPath) at Microsoft.Build.Execution.ProjectItemInstance.TaskItem.GetBuiltInMetadataEscaped(String name) at Microsoft.Build.Execution.ProjectItemInstance.TaskItem.GetMetadataEscaped(String metadataName) at Microsoft.Build.Execution.ProjectItemInstance.TaskItem.GetMetadata(String metadataName) at Microsoft.Build.CommandLine.JsonOutputFormatter.AddTargetResultsInJsonFormat(String[] targetNames, BuildResult result) at Microsoft.Build.CommandLine.MSBuildApp.OutputBuildInformationInJson(BuildResult result, String[] getProperty, String[] getItem, String[] getTargetResult, ILogger[] loggers, ExitType exitType, TextWriter outputStream) at Microsoft.Build.CommandLine.MSBuildApp.Execute(String commandLine) Unhandled Exception: System.InvalidOperationException: The item metadata "%(FullPath)" cannot be applied to the path "/c /nologo /W3 /WX- /diagnostics:column /Od /D _DEBUG /D _CONSOLE /D _UNICODE /D UNICODE /EHsc /RTC1 /MDd /GS /fp:precise /permissive- /Fa"tidytest\x64\Debug\\" /Fo"tidytest\x64\Debug\\" /Gd --target=amd64-pc-windows-msvc /TP". Illegal characters in path. at Microsoft.Build.Shared.ErrorUtilities.ThrowInvalidOperation(String resourceName, Object[] args) at Microsoft.Build.Shared.FileUtilities.ItemSpecModifiers.GetItemSpecModifier(String currentDirectory, String itemSpec, String definingProjectEscaped, String modifier, String& fullPath) at Microsoft.Build.Evaluation.BuiltInMetadata.GetMetadataValueEscaped(String currentDirectory, String evaluatedIncludeBeforeWildcardExpansionEscaped, String evaluatedIncludeEscaped, String definingProjectEscaped, String name, String& fullPath) at Microsoft.Build.Execution.ProjectItemInstance.TaskItem.GetBuiltInMetadataEscaped(String name) at Microsoft.Build.Execution.ProjectItemInstance.TaskItem.GetMetadataEscaped(String metadataName) at Microsoft.Build.Execution.ProjectItemInstance.TaskItem.GetMetadata(String metadataName) at Microsoft.Build.CommandLine.JsonOutputFormatter.AddTargetResultsInJsonFormat(String[] targetNames, BuildResult result) at Microsoft.Build.CommandLine.MSBuildApp.OutputBuildInformationInJson(BuildResult result, String[] getProperty, String[] getItem, String[] getTargetResult, ILogger[] loggers, ExitType exitType, TextWriter outputStream) at Microsoft.Build.CommandLine.MSBuildApp.Execute(String commandLine) at Microsoft.Build.CommandLine.MSBuildApp.Main() ``` ### Analysis The error suggests that it is trying to interpret the flags of the compile commands as a path, which causes an error when it can't be resolved. The function `%(FullPath)` is used, though it is not clear to me exactly where, but my best guess is it used on a variable that is supposed to just be the path to `cl`, but has been extended with flags. See the clang tidy targets file at something similar to `C:\Program Files\Microsoft Visual Studio\2022\Enterprise\MSBuild\Microsoft\VC\v170\Microsoft.Cpp.ClangTidy.targets` ### Versions & Co...
- Fixes dotnet/msbuild#12589 --- ✨ Let Copilot coding agent [set things up for you](https://github.com/dotnet/msbuild/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com> Co-authored-by: Jan Provazník Co-authored-by: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> --- src/MSBuild.UnitTests/XMake_Tests.cs | 32 ++++++++++++++ src/MSBuild/JsonOutputFormatter.cs | 63 ++++++++++++++++++++++++++-- 2 files changed, 92 insertions(+), 3 deletions(-) diff --git a/src/MSBuild.UnitTests/XMake_Tests.cs b/src/MSBuild.UnitTests/XMake_Tests.cs index f4eafd483a6..3ebfcae6615 100644 --- a/src/MSBuild.UnitTests/XMake_Tests.cs +++ b/src/MSBuild.UnitTests/XMake_Tests.cs @@ -888,6 +888,38 @@ public void GetStarOutputsToFileIfRequested(string extraSwitch, string result) result.ShouldContain("MSB1068"); } + /// + /// Regression test for issue where getTargetResult/getItem would throw an unhandled exception + /// when the item spec contained illegal path characters (e.g. compiler command line flags). + /// + [Theory] + [InlineData("-getTargetResult:GetCompileCommands", "\"Result\": \"Success\"")] + [InlineData("-getItem:CompileCommands", "\"Identity\":")] + public void GetTargetResultWithIllegalPathCharacters(string extraSwitch, string expectedContent) + { + using TestEnvironment env = TestEnvironment.Create(); + // Create a project that mimics the ClangTidy target - it outputs items with illegal path characters + // (compiler command line flags) as the item spec. + TransientTestFile project = env.CreateFile("testProject.csproj", @" + + + + + + + + + + + +"); + string results = RunnerUtilities.ExecMSBuild($" {project.Path} /t:GetCompileCommands {extraSwitch}", out bool success); + // The build should succeed instead of throwing an unhandled exception + success.ShouldBeTrue(results); + // The output should contain the expected content + results.ShouldContain(expectedContent); + } + [Theory] [InlineData(true)] [InlineData(false)] diff --git a/src/MSBuild/JsonOutputFormatter.cs b/src/MSBuild/JsonOutputFormatter.cs index cdc166849ca..a3c2f0afc9d 100644 --- a/src/MSBuild/JsonOutputFormatter.cs +++ b/src/MSBuild/JsonOutputFormatter.cs @@ -67,7 +67,7 @@ internal void AddItemInstancesInJsonFormat(string[] itemNames, ProjectInstance p continue; } - jsonItem[metadatumName] = item.GetMetadataValue(metadatumName); + jsonItem[metadatumName] = TryGetMetadataValue(item, metadatumName); } itemArray.Add(jsonItem); @@ -108,7 +108,7 @@ internal void AddItemsInJsonFormat(string[] itemNames, Project project) continue; } - jsonItem[metadatumName] = item.GetMetadataValue(metadatumName); + jsonItem[metadatumName] = TryGetMetadataValue(item, metadatumName); } itemArray.Add(jsonItem); @@ -147,7 +147,7 @@ internal void AddTargetResultsInJsonFormat(string[] targetNames, BuildResult res continue; } - jsonItem[metadatumName] = item.GetMetadata(metadatumName); + jsonItem[metadatumName] = TryGetMetadata(item, metadatumName); } outputArray.Add(jsonItem); @@ -159,5 +159,62 @@ internal void AddTargetResultsInJsonFormat(string[] targetNames, BuildResult res _topLevelNode["TargetResults"] = targetResultsNode; } + + /// + /// Attempts to get metadata from an ITaskItem. If the metadata is a built-in metadata + /// (like FullPath, Directory, etc.) and the item spec contains illegal path characters, + /// this will catch the InvalidOperationException and return an empty string. + /// + private static string TryGetMetadata(ITaskItem item, string metadataName) + { + try + { + return item.GetMetadata(metadataName); + } + catch (InvalidOperationException) + { + // Built-in metadata like FullPath, Directory, etc. require path computation. + // If the item spec contains illegal path characters, return empty string. + return string.Empty; + } + } + + /// + /// Attempts to get metadata value from a ProjectItemInstance. If the metadata is a built-in metadata + /// (like FullPath, Directory, etc.) and the item spec contains illegal path characters, + /// this will catch the InvalidOperationException and return an empty string. + /// + private static string TryGetMetadataValue(ProjectItemInstance item, string metadataName) + { + try + { + return item.GetMetadataValue(metadataName); + } + catch (InvalidOperationException) + { + // Built-in metadata like FullPath, Directory, etc. require path computation. + // If the item spec contains illegal path characters, return empty string. + return string.Empty; + } + } + + /// + /// Attempts to get metadata value from a ProjectItem. If the metadata is a built-in metadata + /// (like FullPath, Directory, etc.) and the item spec contains illegal path characters, + /// this will catch the InvalidOperationException and return an empty string. + /// + private static string TryGetMetadataValue(ProjectItem item, string metadataName) + { + try + { + return item.GetMetadataValue(metadataName); + } + catch (InvalidOperationException) + { + // Built-in metadata like FullPath, Directory, etc. require path computation. + // If the item spec contains illegal path characters, return empty string. + return string.Empty; + } + } } } From 9ba8f3e3be8a3655dc84326ef81a5aa4fb02ca33 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 5 Jan 2026 09:27:40 -0600 Subject: [PATCH 05/39] Log SDK environment variable messages only when values differ (#12918) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Context Structured log viewer was cluttered with repeated non-actionable messages about SDK environment variables (e.g., `DOTNET_HOST_PATH`). These appeared for every project evaluation, reporting normal SDK behavior without providing value to users. ### Changes Made Modified `ProjectInstance.AddSdkResolvedEnvironmentVariable()` to only log messages when an SDK attempts to set an environment variable to a **different value** than what's already set: - **When values match** (common case): No message is logged, eliminating the clutter shown in the original issue - **When values differ** (conflict): A low-importance message is logged showing both the attempted value and the existing value for diagnostic purposes - **Code refactoring**: Extracted duplicate value comparison and logging logic into a helper method `LogIfValueDiffers` to improve code maintainability Updated string resources in `Strings.resx` and all 13 localized `.xlf` files: - `SdkEnvironmentVariableAlreadySet`: Now includes both attempted and existing values in the message - `SdkEnvironmentVariableAlreadySetBySdk`: Now includes both attempted and existing values in the message - Removed `SdkEnvironmentVariableSet` (no longer logging successful sets) The underlying functionality is unchanged—environment variables are still tracked and set correctly, and properties remain visible in the structured log viewer. ### Testing - Built MSBuild successfully - Verified messages no longer appear when values are the same (common case) - Messages would appear when values differ (preserves diagnostic value for conflicts) - Confirmed existing unit tests pass - Verified sample projects build successfully - Confirmed properties are still visible in structured log viewer (DOTNET_HOST_PATH, etc.) ### Notes This implementation balances two concerns: 1. **Eliminates noise**: Repeated messages about the same value being set multiple times no longer clutter logs 2. **Preserves diagnostics**: Actual conflicts (different values) are still logged with full context (both values shown) The messages log at `MessageImportance.Low` to provide diagnostic information without being intrusive in normal builds. Code quality was improved by extracting duplicate logic into a reusable helper method.
Original prompt > > ---- > > *This section details on the original issue you should resolve* > > Duplicated messages from SDK/environment resolution > Image > > There are a ton of these `An SDK attempted to set the environment variable "DOTNET_HOST_PATH"` messages that aren't particularly helpful, and they're not attributed to a project so they clutter up the top level of the viewer tool. > > ## Comments on the Issue (you are @copilot in this section) > > > >
- Fixes dotnet/msbuild#12915 --- 💡 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](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> --- src/Build/Instance/ProjectInstance.cs | 16 +++++++++++++--- src/Build/Resources/Strings.resx | 8 +++----- src/Build/Resources/xlf/Strings.cs.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.de.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.es.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.fr.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.it.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.ja.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.ko.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.pl.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.pt-BR.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.ru.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.tr.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.zh-Hans.xlf | 14 +++++--------- src/Build/Resources/xlf/Strings.zh-Hant.xlf | 14 +++++--------- 15 files changed, 81 insertions(+), 125 deletions(-) diff --git a/src/Build/Instance/ProjectInstance.cs b/src/Build/Instance/ProjectInstance.cs index fe0cdee00e6..da0ac9603d0 100644 --- a/src/Build/Instance/ProjectInstance.cs +++ b/src/Build/Instance/ProjectInstance.cs @@ -1390,13 +1390,13 @@ public void AddSdkResolvedEnvironmentVariable(string name, string value) // If the property has already been set as an environment variable, we do not overwrite it. if (_environmentVariableProperties.Contains(name)) { - _loggingContext.LogComment(MessageImportance.Low, "SdkEnvironmentVariableAlreadySet", name, value); + LogIfValueDiffers(_environmentVariableProperties, name, value, "SdkEnvironmentVariableAlreadySet"); return; } // If another SDK already set it, we do not overwrite it. else if (_sdkResolvedEnvironmentVariableProperties?.Contains(name) == true) { - _loggingContext.LogComment(MessageImportance.Low, "SdkEnvironmentVariableAlreadySetBySdk", name, value); + LogIfValueDiffers(_sdkResolvedEnvironmentVariableProperties, name, value, "SdkEnvironmentVariableAlreadySetBySdk"); return; } @@ -1412,8 +1412,18 @@ public void AddSdkResolvedEnvironmentVariable(string name, string value) ((IEvaluatorData)this) .SetProperty(name, value, isGlobalProperty: false, mayBeReserved: false, loggingContext: _loggingContext, isEnvironmentVariable: true, isCommandLineProperty: false); } + } - _loggingContext.LogComment(MessageImportance.Low, "SdkEnvironmentVariableSet", name, value); + /// + /// Helper method to log a message if the attempted value differs from the existing value. + /// + private void LogIfValueDiffers(PropertyDictionary propertyDictionary, string name, string attemptedValue, string messageResourceName) + { + ProjectPropertyInstance existingProperty = propertyDictionary.GetProperty(name); + if (existingProperty != null && !string.Equals(existingProperty.EvaluatedValue, attemptedValue, StringComparison.Ordinal)) + { + _loggingContext.LogComment(MessageImportance.Low, messageResourceName, name, attemptedValue, existingProperty.EvaluatedValue); + } } /// diff --git a/src/Build/Resources/Strings.resx b/src/Build/Resources/Strings.resx index 68b59de6ee8..95da5690fa1 100644 --- a/src/Build/Resources/Strings.resx +++ b/src/Build/Resources/Strings.resx @@ -1384,14 +1384,12 @@ Errors: {3} {StrBegin="MSB4238: "} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - - - An SDK attempted set the environment variable "{0}" to "{1}". + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + MSB4189: <{1}> is not a valid child of the <{0}> element. {StrBegin="MSB4189: "} diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index 86d6fc9c60c..026ed4209ae 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -907,20 +907,16 @@ Chyby: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - Sada SDK se pokusila nastavit proměnnou prostředí {0} na {1}, která ale již byla nastavena jako proměnná prostředí. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - Sada SDK se pokusila nastavit proměnnou prostředí {0} na {1}, která ale už byla nastavena jinou sadou SDK. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - Sada SDK se pokusila nastavit proměnnou prostředí {0} na {1}. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Sadu SDK {0} se nepodařilo vyřešit pomocí překladače sady SDK {1}. {2} diff --git a/src/Build/Resources/xlf/Strings.de.xlf b/src/Build/Resources/xlf/Strings.de.xlf index 4adaf0b3973..be3c31d7318 100644 --- a/src/Build/Resources/xlf/Strings.de.xlf +++ b/src/Build/Resources/xlf/Strings.de.xlf @@ -907,20 +907,16 @@ Fehler: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - Ein SDK hat versucht, die Umgebungsvariable „{0}“ auf „{1}“ festzulegen, sie wurde aber bereits als Umgebungsvariable festgelegt. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - Ein SDK hat versucht, die Umgebungsvariable „{0}“ auf „{1}“ festzulegen, sie wurde aber bereits von einem anderen SDK festgelegt. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - Ein SDK hat versucht, die Umgebungsvariable „{0}“ auf „{1}“ festzulegen. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK „{0}“ konnte vom SDK-Resolver „{1}“ nicht aufgelöst werden. {2} diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index ed841430d86..d36690c8d8b 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -907,20 +907,16 @@ Errores: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - Un SDK intentó establecer la variable de entorno "{0}" en "{1}", pero ya se estableció como variable de entorno. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - Un SDK intentó establecer la variable de entorno "{0}" en "{1}", pero ya la estableció otro SDK. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - Un SDK intentó establecer la variable de entorno "{0}" en "{1}". + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} El SDK '{0}' no se pudo resolver mediante la resolución de SDK '{1}'. {2} diff --git a/src/Build/Resources/xlf/Strings.fr.xlf b/src/Build/Resources/xlf/Strings.fr.xlf index 2a866b00d4e..cb5f6f9f57b 100644 --- a/src/Build/Resources/xlf/Strings.fr.xlf +++ b/src/Build/Resources/xlf/Strings.fr.xlf @@ -907,20 +907,16 @@ Erreurs : {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - Un Kit de développement logiciel (SDK) a tenté de définir la variable d’environnement « {0} » à « {1} », alors qu'elle était déjà définie en tant que variable d'environnement. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - Un Kit de développement logiciel (SDK) a tenté de définir la variable d’environnement « {0} » à « {1} », mais elle était déjà définie par un autre SDK. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - Un Kit de développement logiciel (SDK) a tenté de définir la variable d’environnement « {0} » à « {1} ». + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Le Kit de développement logiciel (SDK) « {0} » n’a pas pu être résolu par le résolveur de SDK « {1} ». {2} diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index 99d4affd579..908c3afe6e0 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -907,20 +907,16 @@ Errori: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - Un SDK ha tentato di impostare la variabile di ambiente "{0}" su "{1}" ma era già stata impostata come variabile di ambiente. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - Un SDK ha tentato di impostare la variabile di ambiente "{0}" su "{1}" ma era già stata impostata da un altro SDK. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - Un SDK ha tentato di impostare la variabile di ambiente "{0}" su "{1}". + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Il resolver SDK '{0}' non è riuscito a risolvere l'SDK '{1}'. {2} diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index 38b60d181d3..be5077cab90 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -907,20 +907,16 @@ Errors: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - SDK は環境変数 "{0}" を "{1}" に設定しようとしましたが、それは既に環境変数として設定されていました。 + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - SDK は環境変数 "{0}" を "{1}" に設定しようとしましたが、それは既に別の SDK によって設定されていました。 - - - - An SDK attempted set the environment variable "{0}" to "{1}". - SDK が環境変数 "{0}" を "{1}" に設定しようとしました。 + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK '{0}' を SDK リゾルバー '{1}' で解決できませんでした。{2} diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index e5aa1a02533..8d3b59f5ec8 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -907,20 +907,16 @@ Errors: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - SDK가 환경 변수 "{0}"을(를) "{1}"(으)로 설정하려고 했지만 이미 환경 변수로 설정되었습니다. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - SDK가 환경 변수 "{0}"을(를) "{1}"(으)로 설정하려고 했지만 이미 다른 SDK에 의해 설정되었습니다. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - SDK가 환경 변수 "{0}"을(를) "{1}"(으)로 설정하려고 했습니다. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK 확인자 '{1}'에서 SDK '{0}'을(를) 확인할 수 없습니다. {2} diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index 866d90bcd9d..663194899f7 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -907,20 +907,16 @@ Błędy: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - Zestaw SDK próbował ustawić zmienną środowiskową „{0}” na „{1}”, ale została już ustawiona jako zmienna środowiskowa. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - Zestaw SDK próbował ustawić zmienną środowiskową „{0}” na „{1}”, ale została już ustawiona przez inny zestaw SDK. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - Zestaw SDK próbował ustawić zmienną środowiskową „{0}” na „{1}”. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Nie można rozpoznać zestawu SDK „{0}” przez program rozpoznawania nazw zestawu SDK „{1}”. {2} diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index d27c50e5464..f38690c4d33 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -907,20 +907,16 @@ Erros: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - Um SDK tentou definir a variável de ambiente "{0}" como "{1}", mas ela já foi definida como variável de ambiente. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - Um SDK tentou definir a variável de ambiente "{0}" como "{1}", mas ela já foi definida por outro SDK. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - Um SDK tentou definir a variável de ambiente "{0}" como "{1}". + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} O SDK '{0}' não pôde ser resolvido pelo resolvedor de SDK '{1}'. {2} diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index 55d613e49cd..612f94ddbed 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -907,20 +907,16 @@ Errors: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - Пакет SDK попытался настроить для переменной среды "{0}" значение "{1}", но она уже была настроена в качестве переменной среды. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - Пакет SDK попытался настроить для переменной среды "{0}" значение "{1}", но она уже была настроена другим пакетом SDK. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - Пакет SDK попытался настроить для переменной среды "{0}" значение "{1}". + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Не удалось разрешить SDK "{0}" с помощью сопоставителя SDK "{1}". {2} diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index 7a5e481602b..aa8290cc5ea 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -907,20 +907,16 @@ Hatalar: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - Bir SDK "{0}" ortam değişkenini "{1}" olarak ayarlamaya çalıştı ancak bu değişken zaten bir ortam değişkeni olarak ayarlanmıştı. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - Bir SDK "{0}" ortam değişkenini "{1}" olarak ayarlamaya çalıştı ancak bu değişken zaten başka bir SDK tarafından ayarlanmıştı. - - - - An SDK attempted set the environment variable "{0}" to "{1}". - Bir SDK, "{0}" ortam değişkenini "{1}" olarak ayarlamaya çalıştı. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK '{0}', SDK çözümleyici '{1}' tarafından çözümlenemedi. {2} diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index d8da78803bc..e3e48f00b27 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -907,20 +907,16 @@ Errors: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - SDK 尝试将环境变量 "{0}" 设置为 "{1}"，但它已设置为环境变量。 + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - SDK 尝试将环境变量 "{0}" 设置为 "{1}"，但已由另一个 SDK 设置。 - - - - An SDK attempted set the environment variable "{0}" to "{1}". - SDK 尝试将环境变量 "{0}" 设置为 "{1}"。 + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK 解析程序“{1}”无法解析 SDK“{0}”。{2} diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index d851b21ba23..d7de7350890 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -907,20 +907,16 @@ Errors: {3} - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set as an environment variable. - 一個 SDK 嘗試將環境變數 "{0}" 設定為 "{1}"，但該變數已設定為環境變數。 + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set by another SDK. - 一個 SDK 嘗試將環境變數 "{0}" 設定為 "{1}"，但該變數已由另一個 SDK 設定。 - - - - An SDK attempted set the environment variable "{0}" to "{1}". - 一個 SDK 嘗試將環境變數 "{0}" 設定為 "{1}"。 + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK 解析程式 '{1}' 無法解析 SDK '{0}'。{2} From 5fccf5a2de99d11b13d494d0a37c90fa2cc448a7 Mon Sep 17 00:00:00 2001 From: dotnet bot Date: Mon, 5 Jan 2026 07:41:01 -0800 Subject: [PATCH 06/39] Localized file check-in by OneLocBuild Task: Build definition ID 9434: Build ID 13036709 --- src/Build/Resources/xlf/Strings.cs.xlf | 1 - src/Build/Resources/xlf/Strings.de.xlf | 1 - src/Build/Resources/xlf/Strings.es.xlf | 1 - src/Build/Resources/xlf/Strings.fr.xlf | 1 - src/Build/Resources/xlf/Strings.it.xlf | 1 - src/Build/Resources/xlf/Strings.ja.xlf | 1 - src/Build/Resources/xlf/Strings.ko.xlf | 1 - src/Build/Resources/xlf/Strings.pl.xlf | 1 - src/Build/Resources/xlf/Strings.pt-BR.xlf | 1 - src/Build/Resources/xlf/Strings.ru.xlf | 1 - src/Build/Resources/xlf/Strings.tr.xlf | 1 - src/Build/Resources/xlf/Strings.zh-Hans.xlf | 1 - src/Build/Resources/xlf/Strings.zh-Hant.xlf | 1 - 13 files changed, 13 deletions(-) diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index 026ed4209ae..a5773bf2038 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -916,7 +916,6 @@ Chyby: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Sadu SDK {0} se nepodařilo vyřešit pomocí překladače sady SDK {1}. {2} diff --git a/src/Build/Resources/xlf/Strings.de.xlf b/src/Build/Resources/xlf/Strings.de.xlf index be3c31d7318..29625306e1d 100644 --- a/src/Build/Resources/xlf/Strings.de.xlf +++ b/src/Build/Resources/xlf/Strings.de.xlf @@ -916,7 +916,6 @@ Fehler: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK „{0}“ konnte vom SDK-Resolver „{1}“ nicht aufgelöst werden. {2} diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index d36690c8d8b..fbad7f6fbd9 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -916,7 +916,6 @@ Errores: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} El SDK '{0}' no se pudo resolver mediante la resolución de SDK '{1}'. {2} diff --git a/src/Build/Resources/xlf/Strings.fr.xlf b/src/Build/Resources/xlf/Strings.fr.xlf index cb5f6f9f57b..e36c0d13f30 100644 --- a/src/Build/Resources/xlf/Strings.fr.xlf +++ b/src/Build/Resources/xlf/Strings.fr.xlf @@ -916,7 +916,6 @@ Erreurs : {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Le Kit de développement logiciel (SDK) « {0} » n’a pas pu être résolu par le résolveur de SDK « {1} ». {2} diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index 908c3afe6e0..35520f4ead6 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -916,7 +916,6 @@ Errori: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Il resolver SDK '{0}' non è riuscito a risolvere l'SDK '{1}'. {2} diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index be5077cab90..ff6592d2d65 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -916,7 +916,6 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK '{0}' を SDK リゾルバー '{1}' で解決できませんでした。{2} diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index 8d3b59f5ec8..1f8febc1325 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -916,7 +916,6 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK 확인자 '{1}'에서 SDK '{0}'을(를) 확인할 수 없습니다. {2} diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index 663194899f7..48fcf71d76d 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -916,7 +916,6 @@ Błędy: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Nie można rozpoznać zestawu SDK „{0}” przez program rozpoznawania nazw zestawu SDK „{1}”. {2} diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index f38690c4d33..78e5e61e1f4 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -916,7 +916,6 @@ Erros: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} O SDK '{0}' não pôde ser resolvido pelo resolvedor de SDK '{1}'. {2} diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index 612f94ddbed..50ad0335993 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -916,7 +916,6 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} Не удалось разрешить SDK "{0}" с помощью сопоставителя SDK "{1}". {2} diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index aa8290cc5ea..2299d8178e6 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -916,7 +916,6 @@ Hatalar: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK '{0}', SDK çözümleyici '{1}' tarafından çözümlenemedi. {2} diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index e3e48f00b27..9f1610a48a2 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -916,7 +916,6 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK 解析程序“{1}”无法解析 SDK“{0}”。{2} diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index d7de7350890..0c718642f76 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -916,7 +916,6 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - SDK '{0}' could not be resolved by the SDK resolver '{1}'. {2} SDK 解析程式 '{1}' 無法解析 SDK '{0}'。{2} From 2392c792aa6953ebfe6683c44d295ac3da3e0a54 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Tue, 6 Jan 2026 17:16:24 +0100 Subject: [PATCH 07/39] Fix terminal logger quiet mode to show project context for warnings/errors (#12930) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Context In quiet mode (`-v:q`), warnings and errors were rendered immediately without project context. Users saw diagnostic messages but couldn't identify which project they came from. ``` CSC : warning MSTEST0001: Explicitly enable or disable tests parallelization ``` ### Changes Made **Modified diagnostic accumulation logic** - `WarningRaised` and `ErrorRaised` now accumulate diagnostics in the project's `BuildMessages` collection regardless of verbosity - Removed verbosity check that caused immediate rendering in quiet mode - Preserved immediate rendering for auth provider warnings and immediate warnings (MSB3026) **Modified project summary rendering** - `ProjectFinished` now displays project summaries in quiet mode when `HasErrorsOrWarnings` is true - Projects without diagnostics remain hidden in quiet mode as expected - Simplified quiet mode detection logic: `Verbosity < LoggerVerbosity.Quiet || (Verbosity == LoggerVerbosity.Quiet && !project.HasErrorsOrWarnings)` - Skip `DisplayNodes()` call in quiet mode to avoid writing unnecessary cursor hide/show ANSI codes since there's no dynamic refresh **Result in quiet mode:** ``` project failed with 1 error(s) and 2 warning(s) (0.2s) directory/file(1,2,3,4): warning AA0000: Warning message directory/file(1,2,3,4): error AA0000: Error message ``` ### Testing - Updated snapshot files for `PrintBuildSummaryQuietVerbosity_FailedWithErrors` across Linux/OSX/Windows - All 69 TerminalLogger tests pass - Verified successful projects still produce no output in quiet mode - Verified no cursor control codes are written in quiet mode output ### Notes Uses the same project-grouping primitives as higher verbosity levels, toggled by runtime state per maintainer guidance.
Original prompt > > ---- > > *This section details on the original issue you should resolve* > > Terminal logger quiet mode hides projects > This was reported by @gao-artur in https://github.com/microsoft/testfx/issues/7051 > > > Here is a new project created from the MSTest template without `MSTestSettings.cs` file + the binlog. Built with > > > > `dotnet build -bl -v q` > > [TestProject11.zip](https://github.com/user-attachments/files/23968849/TestProject11.zip) > > In that thread we determined that `-tl` status affects the usefulness of the output for messages that do not have a specific file associated with them: > > ```sh-session > ❯ dotnet build > Restore complete (4.0s) > TestProject11 net9.0 succeeded with 1 warning(s) (2.3s) → bin\Debug\net9.0\TestProject11.dll > CSC : warning MSTEST0001: Explicitly enable or disable tests parallelization (https://learn.microsoft.com/dotnet/core/testing/mstest-analyzers/mstest0001) > > Build succeeded with 1 warning(s) in 7.2s > > ❯ rm -r .\obj\ > > ❯ dotnet build -v:q > CSC : warning MSTEST0001: Explicitly enable or disable tests parallelization (https://learn.microsoft.com/dotnet/core/testing/mstest-analyzers/mstest0001) > ``` > > The associated project `TestProject11` is not mentioned anywhere in the latter. I think that's unreasonable even when the user has requested "quiet". > > Try to update the diagnostic/warning/error message rendering in quiet mode so that it doesn't use the 'immediate' mode formatting, the final output should only show the diagnostics for projects that failed or had warnings. > > ## Comments on the Issue (you are @copilot in this section) > > > @baronfel > A few approaches to consider: > > * in quiet mode appending/prepending the project if it exists to the 'message formatting' part of the line > * in quiet mode using the same project-based grouping as we do in non-quiet mode, instead of assuming that quiet mode should trigger some kind of flat-list-only output > @rainersigwald > Yeah I waffled between the two myself, I think I lean to the latter right now though. > @baronfel > I do too - it feels more like a 'modular' approach - use the same 'primitives' that can be toggled on/off based on run-time state, etc. > >
- Fixes dotnet/msbuild#12929 --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: baronfel <573979+baronfel@users.noreply.github.com> Co-authored-by: Chet Husk Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- ...bosity_FailedWithErrors.Linux.verified.txt | 15 ++++---- ...erbosity_FailedWithErrors.OSX.verified.txt | 15 ++++---- ...sity_FailedWithErrors.Windows.verified.txt | 15 ++++---- .../Logging/TerminalLogger/TerminalLogger.cs | 38 ++++++++++--------- 4 files changed, 45 insertions(+), 38 deletions(-) diff --git a/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Linux.verified.txt b/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Linux.verified.txt index 34432ae0de0..ca72cc765ec 100644 --- a/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Linux.verified.txt +++ b/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Linux.verified.txt @@ -1,8 +1,9 @@ The plugin credential provider could not acquire credentials.Authentication may require manual action. Consider re-running the command with --interactive for `dotnet`, /p:NuGetInteractive="true" for MSBuild or removing the -NonInteractive switch for `NuGet` -directory/file(1,2,3,4): warning AA0000: Warning! -directory/file(1,2,3,4): warning AA0000: - A - Multi - Line - Warning! -directory/file(1,2,3,4): error AA0000: Error! + project failed with 1 error(s) and 2 warning(s) (0.2s) + directory/file(1,2,3,4): warning AA0000: Warning! + directory/file(1,2,3,4): warning AA0000: + A + Multi + Line + Warning! + directory/file(1,2,3,4): error AA0000: Error! diff --git a/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.OSX.verified.txt b/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.OSX.verified.txt index 5037f4b16db..450eaea951f 100644 --- a/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.OSX.verified.txt +++ b/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.OSX.verified.txt @@ -1,8 +1,9 @@ The plugin credential provider could not acquire credentials.Authentication may require manual action. Consider re-running the command with --interactive for `dotnet`, /p:NuGetInteractive="true" for MSBuild or removing the -NonInteractive switch for `NuGet` -directory/file(1,2,3,4): warning AA0000: Warning! -directory/file(1,2,3,4): warning AA0000: - A - Multi - Line - Warning! -directory/file(1,2,3,4): error AA0000: Error! + project failed with 1 error(s) and 2 warning(s) (0.2s) + directory/file(1,2,3,4): warning AA0000: Warning! + directory/file(1,2,3,4): warning AA0000: + A + Multi + Line + Warning! + directory/file(1,2,3,4): error AA0000: Error! diff --git a/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Windows.verified.txt b/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Windows.verified.txt index 34432ae0de0..ca72cc765ec 100644 --- a/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Windows.verified.txt +++ b/src/Build.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Windows.verified.txt @@ -1,8 +1,9 @@ The plugin credential provider could not acquire credentials.Authentication may require manual action. Consider re-running the command with --interactive for `dotnet`, /p:NuGetInteractive="true" for MSBuild or removing the -NonInteractive switch for `NuGet` -directory/file(1,2,3,4): warning AA0000: Warning! -directory/file(1,2,3,4): warning AA0000: - A - Multi - Line - Warning! -directory/file(1,2,3,4): error AA0000: Error! + project failed with 1 error(s) and 2 warning(s) (0.2s) + directory/file(1,2,3,4): warning AA0000: Warning! + directory/file(1,2,3,4): warning AA0000: + A + Multi + Line + Warning! + directory/file(1,2,3,4): error AA0000: Error! diff --git a/src/Build/Logging/TerminalLogger/TerminalLogger.cs b/src/Build/Logging/TerminalLogger/TerminalLogger.cs index dffb6064a90..8965696dfa8 100644 --- a/src/Build/Logging/TerminalLogger/TerminalLogger.cs +++ b/src/Build/Logging/TerminalLogger/TerminalLogger.cs @@ -754,18 +754,23 @@ private void ProjectFinished(object sender, ProjectFinishedEventArgs e) UpdateNodeStatus(buildEventContext, null); } - // Continue execution and add project summary to the static part of the Console only if verbosity is higher than Quiet. - if (Verbosity <= LoggerVerbosity.Quiet) - { - return; - } - ProjectContext c = new(buildEventContext); if (_projects.TryGetValue(c, out TerminalProjectInfo? project)) { project.Succeeded = e.Succeeded; project.Stopwatch.Stop(); + + // In quiet mode, only show projects with errors or warnings. + // In higher verbosity modes, show projects based on other criteria. + if (Verbosity == LoggerVerbosity.Quiet && !project.HasErrorsOrWarnings) + { + // Still need to update counts even if not displaying + _buildErrorsCount += project.ErrorCount; + _buildWarningsCount += project.WarningCount; + return; + } + lock (_lock) { Terminal.BeginUpdate(); @@ -809,6 +814,7 @@ private void ProjectFinished(object sender, ProjectFinishedEventArgs e) // If this was a notable project build, we print it as completed only if it's produced an output or warnings/error. // If this is a test project, print it always, so user can see either a success or failure, otherwise success is hidden // and it is hard to see if project finished, or did not run at all. + // In quiet mode, we show the project header if there are errors/warnings (already checked above). else if (project.OutputPath is not null || project.BuildMessages is not null || project.IsTestProject) { // Show project build complete and its output @@ -839,7 +845,7 @@ private void ProjectFinished(object sender, ProjectFinishedEventArgs e) _buildErrorsCount += project.ErrorCount; _buildWarningsCount += project.WarningCount; - if (_showNodesDisplay) + if (_showNodesDisplay && Verbosity > LoggerVerbosity.Quiet) { DisplayNodes(); } @@ -1300,27 +1306,24 @@ private void WarningRaised(object sender, BuildWarningEventArgs e) } if (buildEventContext is not null - && _projects.TryGetValue(new ProjectContext(buildEventContext), out TerminalProjectInfo? project) - && Verbosity > LoggerVerbosity.Quiet) + && _projects.TryGetValue(new ProjectContext(buildEventContext), out TerminalProjectInfo? project)) { // If the warning is not a 'global' auth provider message, but is immediate, we render it immediately // but we don't early return so that the project also tracks it. - if (IsImmediateWarning(e.Code)) + if (IsImmediateWarning(e.Code) && Verbosity > LoggerVerbosity.Quiet) { RenderImmediateMessage(FormatWarningMessage(e, Indentation)); } // This is the general case - _most_ warnings are not immediate, so we add them to the project summary // and display them in the per-project and final summary. + // In quiet mode, we still accumulate so they can be shown in project-grouped form later. project.AddBuildMessage(TerminalMessageSeverity.Warning, FormatWarningMessage(e, TripleIndentation)); } else { // It is necessary to display warning messages reported by MSBuild, - // even if it's not tracked in _projects collection or the verbosity is Quiet. - // The idea here (similar to the implementation in ErrorRaised) is that - // even in Quiet scenarios we need to show warnings/errors, even if not in - // full project-tree view + // even if it's not tracked in _projects collection. RenderImmediateMessage(FormatWarningMessage(e, Indentation)); _buildWarningsCount++; } @@ -1385,14 +1388,15 @@ private void ErrorRaised(object sender, BuildErrorEventArgs e) BuildEventContext? buildEventContext = e.BuildEventContext; if (buildEventContext is not null - && _projects.TryGetValue(new ProjectContext(buildEventContext), out TerminalProjectInfo? project) - && Verbosity > LoggerVerbosity.Quiet) + && _projects.TryGetValue(new ProjectContext(buildEventContext), out TerminalProjectInfo? project)) { + // Always accumulate errors in the project, even in quiet mode, so they can be shown + // in project-grouped form later. project.AddBuildMessage(TerminalMessageSeverity.Error, FormatErrorMessage(e, TripleIndentation)); } else { - // It is necessary to display error messages reported by MSBuild, even if it's not tracked in _projects collection or the verbosity is Quiet. + // It is necessary to display error messages reported by MSBuild, even if it's not tracked in _projects collection. // For nicer formatting, any messages from the engine we strip the file portion from. bool hasMSBuildPlaceholderLocation = e.File.Equals("MSBUILD", StringComparison.Ordinal); RenderImmediateMessage(FormatErrorMessage(e, Indentation, requireFileAndLinePortion: !hasMSBuildPlaceholderLocation)); From 3d8dd2eeb147d15f59b650f432b16974fb49cba9 Mon Sep 17 00:00:00 2001 From: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> Date: Wed, 7 Jan 2026 09:39:48 +0100 Subject: [PATCH 08/39] Replace OpenTelemetry with Microsoft.VisualStudio.Telemetry for VS (#12843) --- Directory.Packages.props | 6 +- NuGet.config | 4 - THIRDPARTYNOTICES.txt | 30 -- documentation/specs/VS-OpenTelemetry.md | 198 ---------- .../specs/proposed/telemetry-onepager.md | 77 ---- eng/Signing.props | 3 - eng/Versions.props | 4 +- .../BackEnd/BuildManager_Tests.cs | 1 - .../Microsoft.Build.Engine.UnitTests.csproj | 5 +- .../OpenTelemetryActivities_Tests.cs | 195 ---------- .../Telemetry/OpenTelemetryManager_Tests.cs | 142 -------- .../Telemetry/Telemetry_Tests.cs | 263 +++++++------- .../BackEnd/BuildManager/BuildManager.cs | 72 ++-- .../Components/Logging/LoggingService.cs | 5 + .../RequestBuilder/RequestBuilder.cs | 9 +- src/Build/Microsoft.Build.csproj | 1 - src/Build/Resources/Strings.resx | 3 - src/Build/Resources/xlf/Strings.cs.xlf | 5 - src/Build/Resources/xlf/Strings.de.xlf | 5 - src/Build/Resources/xlf/Strings.es.xlf | 5 - src/Build/Resources/xlf/Strings.fr.xlf | 5 - src/Build/Resources/xlf/Strings.it.xlf | 5 - src/Build/Resources/xlf/Strings.ja.xlf | 5 - src/Build/Resources/xlf/Strings.ko.xlf | 5 - src/Build/Resources/xlf/Strings.pl.xlf | 5 - src/Build/Resources/xlf/Strings.pt-BR.xlf | 5 - src/Build/Resources/xlf/Strings.ru.xlf | 5 - src/Build/Resources/xlf/Strings.tr.xlf | 5 - src/Build/Resources/xlf/Strings.zh-Hans.xlf | 5 - src/Build/Resources/xlf/Strings.zh-Hant.xlf | 5 - .../TelemetryInfra/ITelemetryForwarder.cs | 7 +- .../InternalTelemetryConsumingLogger.cs | 4 + .../TelemetryInfra/TelemetryDataUtils.cs | 339 ------------------ .../Microsoft.Build.Framework.csproj | 8 +- src/Framework/Telemetry/ActivityExtensions.cs | 111 ------ .../Telemetry/BuildCheckTelemetry.cs | 3 - src/Framework/Telemetry/BuildInsights.cs | 39 ++ src/Framework/Telemetry/BuildTelemetry.cs | 157 +++----- src/Framework/Telemetry/DiagnosticActivity.cs | 62 ++++ src/Framework/Telemetry/IActivity.cs | 28 ++ .../Telemetry/IActivityTelemetryDataHolder.cs | 5 +- .../Telemetry/IWorkerNodeTelemetryData.cs | 1 + .../Telemetry/MSBuildActivitySource.cs | 50 ++- .../Telemetry/OpenTelemetryManager.cs | 282 --------------- src/Framework/Telemetry/TelemetryConstants.cs | 33 +- src/Framework/Telemetry/TelemetryDataUtils.cs | 313 ++++++++++++++++ src/Framework/Telemetry/TelemetryItem.cs | 6 - src/Framework/Telemetry/TelemetryManager.cs | 195 ++++++++++ .../Telemetry/VSTelemetryActivity.cs | 66 ++++ src/Framework/Traits.cs | 15 - src/MSBuild/XMake.cs | 10 +- src/MSBuild/app.amd64.config | 94 +---- src/MSBuild/app.config | 8 - src/Package/MSBuild.VSSetup/files.swr | 18 - src/Package/Microsoft.Build.UnGAC/Program.cs | 2 - 55 files changed, 1002 insertions(+), 1937 deletions(-) delete mode 100644 documentation/specs/VS-OpenTelemetry.md delete mode 100644 documentation/specs/proposed/telemetry-onepager.md delete mode 100644 src/Build.UnitTests/Telemetry/OpenTelemetryActivities_Tests.cs delete mode 100644 src/Build.UnitTests/Telemetry/OpenTelemetryManager_Tests.cs delete mode 100644 src/Build/TelemetryInfra/TelemetryDataUtils.cs delete mode 100644 src/Framework/Telemetry/ActivityExtensions.cs create mode 100644 src/Framework/Telemetry/BuildInsights.cs create mode 100644 src/Framework/Telemetry/DiagnosticActivity.cs create mode 100644 src/Framework/Telemetry/IActivity.cs delete mode 100644 src/Framework/Telemetry/OpenTelemetryManager.cs create mode 100644 src/Framework/Telemetry/TelemetryDataUtils.cs delete mode 100644 src/Framework/Telemetry/TelemetryItem.cs create mode 100644 src/Framework/Telemetry/TelemetryManager.cs create mode 100644 src/Framework/Telemetry/VSTelemetryActivity.cs diff --git a/Directory.Packages.props b/Directory.Packages.props index 2961c3bd5ff..117d0ddf276 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -46,10 +46,8 @@ - - - - + + diff --git a/NuGet.config b/NuGet.config index c181d033061..764f9c8ddaa 100644 --- a/NuGet.config +++ b/NuGet.config @@ -18,11 +18,7 @@ - - - - diff --git a/THIRDPARTYNOTICES.txt b/THIRDPARTYNOTICES.txt index 49e551d4279..982c50663a3 100644 --- a/THIRDPARTYNOTICES.txt +++ b/THIRDPARTYNOTICES.txt @@ -43,33 +43,3 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - -------------------------------- - -Notice for OpenTelemetry .NET -------------------------------- -MSBuild.exe is distributed with OpenTelemetry .NET binaries. - -Copyright (c) OpenTelemetry Authors -Source: https://github.com/open-telemetry/opentelemetry-dotnet - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software distributed -under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR -CONDITIONS OF ANY KIND, either express or implied. See the License for the specific -language governing permissions and limitations under the License. - -------------------------------- - -Notice for Microsoft.VisualStudio.OpenTelemetry.* -------------------------------- -MSBuild.exe is distributed with Microsoft.VisualStudio.OpenTelemetry.* binaries. - -Project: Microsoft.VisualStudio.OpenTelemetry -Copyright: (c) Microsoft Corporation -License: https://visualstudio.microsoft.com/license-terms/mt736442/ \ No newline at end of file diff --git a/documentation/specs/VS-OpenTelemetry.md b/documentation/specs/VS-OpenTelemetry.md deleted file mode 100644 index 59d1f6e5d17..00000000000 --- a/documentation/specs/VS-OpenTelemetry.md +++ /dev/null @@ -1,198 +0,0 @@ -# Telemetry via OpenTelemetry design - -VS OTel provide packages compatible with ingesting data to their backend if we instrument it via OpenTelemetry traces (System.Diagnostics.Activity). -VS OTel packages are not open source so we need to conditionally include them in our build only for VS and MSBuild.exe - -> this formatting is a comment describing how the implementation turned out in 17.14 when our original goals were different - -[Onepager](https://github.com/dotnet/msbuild/blob/main/documentation/specs/proposed/telemetry-onepager.md) - -## Concepts - -It's a bit confusing how things are named in OpenTelemetry and .NET and VS Telemetry and what they do. - -| OTel concept | .NET/VS | Description | -| --- | --- | --- | -| Span/Trace | System.Diagnostics.Activity | Trace is a tree of Spans. Activities can be nested.| -| Tracer | System.Diagnostics.ActivitySource | Creates activites. | -| Processor/Exporter | VS OTel provided default config | filters and saves telemetry as files in a desired format | -| TracerProvider | OTel SDK TracerProvider | Singleton that is aware of processors, exporters and Tracers and listens (in .NET a bit looser relationship because it does not create Tracers just hooks to them) | -| Collector | VS OTel Collector | Sends to VS backend | - -## Requirements - -### Performance - -- If not sampled, no infra initialization overhead. -- Avoid allocations when not sampled. -- Has to have no impact on Core without opting into tracing, small impact on Framework -- No regression in VS perf ddrit scenarios. - -> there is an allocation regression when sampled, one of the reasons why it's not enabled by default - -### Privacy - -- Hashing data points that could identify customers (e.g. names of targets) -- Opt out capability - -### Security - -- Providing or/and documenting a method for creating a hook in Framework MSBuild -- If custom hooking solution will be used - document the security implications of hooking custom telemetry Exporters/Collectors in Framework -- other security requirements (transportation, rate limiting, sanitization, data access) are implemented by VS Telemetry library or the backend - -> hooking in Framework not implemented - -### Data handling - -- Implement head [Sampling](https://opentelemetry.io/docs/concepts/sampling/) with the granularity of a MSBuild.exe invocation/VS instance. -- VS Data handle tail sampling in their infrastructure not to overwhelm storage with a lot of build events. - -#### Data points - -The data sent via VS OpenTelemetry is neither a subset neither a superset of what is sent to SDK telemetry and it is not a purpose of this design to unify them. - -##### Basic info - -- Build duration -- Host -- Build success/failure -- Version -- Target (hashed) - -##### Evnironment - -- SAC (Smart app control) enabled - -##### Features - -- BuildCheck enabled -- Tasks runtimes and memory usage -- Tasks summary - whether they come from Nuget or are custom -- Targets summary - how many loaded and executed, how many come from nuget, how many come from metaproject - -The design should allow for easy instrumentation of additional data points. -> current implementation has only one datapoint and that is the whole build `vs/msbuild/build`, the instrumentaiton of additional datapoints is gated by first checking that telemetry is running and using `Activity` classes only in helper methods gated by `[MethodImpl(MethodImplOptions.NoInlining)]` to avoid System.Diagnostics.DiagnosticSource dll load. - -## Core `dotnet build` scenario - -- Telemetry should not be collected via VS OpenTelemetry mechanism because it's already collected in sdk. -- opt in to initialize the ActivitySource to avoid degrading performance. -- [baronfel/otel-startup-hook: A .NET CLR Startup Hook that exports OpenTelemetry metrics via the OTLP Exporter to an OpenTelemetry Collector](https://github.com/baronfel/otel-startup-hook/) and similar enable collecting telemetry data locally by listening to the ActivitySource prefix defined in MSBuild. - -> this hook can be used when the customer specifies that they want to listen to the prefix `Microsoft.VisualStudio.OpenTelemetry.MSBuild`, opt in by setting environment variables `MSBUILD_TELEMETRY_OPTIN=1`,`MSBUILD_TELEMETRY_SAMPLE_RATE=1.0` - -## Standalone MSBuild.exe scenario - -- Initialize and finalize in Xmake.cs - ActivitySource, TracerProvider, VS Collector -- overhead of starting VS collector is nonzero -- head sampling should avoid initializing if not sampled - -## VS in proc (devenv) scenario - -- VS can call `BuildManager` in a thread unsafe way the telemetry implementation has to be mindful of [BuildManager instances acquire its own BuildTelemetry instance by rokonec · Pull Request #8444 · dotnet/msbuild](https://github.com/dotnet/msbuild/pull/8444) - - ensure no race conditions in initialization - - only 1 TracerProvider with VS defined processing should exist -- Visual Studio should be responsible for having a running collector, we don't want this overhead in MSBuild and eventually many will use it - -> this was not achieved in 17.14 so we start collector every time - -## Implementation and MSBuild developer experience - -### ActivitySource names - -- Microsoft.VisualStudio.OpenTelemetry.MSBuild.Default - -### Sampling - -Our estimation from VS and SDK data is that there are 10M-100M build events per day. -For proportion estimation (of fairly common occurence in the builds), with not very strict confidnece (95%) and margin for error (5%) sampling 1:25000 would be enough. - -- this would apply for the DefaultActivitySource -- other ActivitySources could be sampled more frequently to get enough data -- Collecting has a cost, especially in standalone scenario where we have to start the collector. We might decide to undersample in standalone to avoid performance frequent impact. -- We want to avoid that cost when not sampled, therefore we prefer head sampling. -- Enables opt-in and opt-out for guaranteed sample or not sampled. -- nullable ActivitySource, using `?` when working with them, we can be initialized but not sampled -> it will not reinitialize but not collect telemetry. - -- for 17.14 we can't use the new OTel assemblies and their dependencies, so everything has to be opt in. -- eventually OpenTelemetry will be available and usable by default -- We can use experiments in VS to pass the environment variable to initialize - -> Targeted notification can be set that samples 100% of customers to which it is sent - -### Initialization at entrypoints - -- There are 2 entrypoints: - - for VS in BuildManager.BeginBuild - - for standalone in Xmake.cs Main - -### Exiting - -Force flush TracerProvider's exporter in BuildManager.EndBuild. -Dispose collector in Xmake.cs at the end of Main. - -### Configuration - -- Class that's responsible for configuring and initializing telemetry and handles optouts, holding tracer and collector. -- Wrapping source so that it has correct prefixes for VS backend to ingest. - -### Instrumenting - -2 ways of instrumenting: - -#### Instrument areas in code running in the main process - -```csharp -using (Activity? myActivity = OpenTelemetryManager.DefaultActivitySource?.StartActivity(TelemetryConstants.NameFromAConstantToAvoidAllocation)) -{ -// something happens here - -// add data to the trace -myActivity?.WithTag("SpecialEvent","fail") -} -``` - -Interface for classes holding telemetry data - -```csharp -IActivityTelemetryDataHolder data = new SomeData(); -... -myActivity?.WithTags(data); -``` - -> currently this should be gated in a separate method to avoid System.DiagnosticDiagnosticsource dll load. - -#### Default Build activity in EndBuild - -- this activity would always be created at the same point when sdk telemetry is sent in Core -- we can add data to it that we want in general builds -- the desired count of data from this should control the sample rate of DefaultActivitySource - -#### Multiple Activity Sources - -We want to create ActivitySources with different sample rates, this requires either implementation server side or a custom Processor. - -We potentially want apart from the Default ActivitySource: - -1. Other activity sources with different sample rates (in order to get significant data for rarer events such as custom tasks). -2. a way to override sampling decision - ad hoc starting telemetry infrastructure to catch rare events - -- Create a way of using a "HighPrioActivitySource" which would override sampling and initialize Collector in MSBuild.exe scenario/tracerprovider in VS. -- this would enable us to catch rare events - -> not implemented - -### Implementation details - -- `OpenTelemetryManager` - singleton that manages lifetime of OpenTelemetry objects listening to `Activity`ies, start by initializing in `Xmake` or `BuildManager`. -- Task and Target data is forwarded from worker nodes via `TelemetryForwarder` and `InternalTelemetryForwardingLogger` and then aggregated to stats and serialized in `TelemetryDataUtils` and attached to the default `vs/msbuild/build` event. - -## Future work when/if we decide to invest in telemetry again - -- avoid initializing/finalizing collector in VS when there is one running -- multiple levels of sampling for different types of events -- running by default with head sampling (simplifies instrumentation with `Activity`ies) -- implement anonymization consistently in an OTel processor and not ad hoc in each usage -- add datapoints helping perf optimization decisions/ reliability investigations diff --git a/documentation/specs/proposed/telemetry-onepager.md b/documentation/specs/proposed/telemetry-onepager.md deleted file mode 100644 index 5bc8f22f9ce..00000000000 --- a/documentation/specs/proposed/telemetry-onepager.md +++ /dev/null @@ -1,77 +0,0 @@ -# Telemetry - -We want to implement telemetry collection for VS/MSBuild.exe scenarios where we are currently not collecting data. VS OpenTelemetry initiative provides a good opportunity to use their infrastructure and library. -There is some data we collect via SDK which we want to make accessible. - -## Goals and Motivation - -We have limited data about usage of MSBuild by our customers in VS and no data about usage of standalone msbuild.exe. -This limits us in prioritization of features and scenarios to optimize performance for. -Over time we want to have comprehensive insight into how MSBuild is used in all scenarios. Collecting such a data without any constraints nor limitations would however be prohibitively expensive (from the data storage PoV and possibly as well from the client side performance impact PoV). Ability to sample / configure the collection is an important factor in deciding the instrumentation and collection tech stack. Implementing telemetry via VS OpenTelemetry initiative would give us this ability in the future. - -Goal: To have relevant data in that is actionable for decisions about development. Measuring real world performance impact of features (e.g. BuildCheck). Easily extensible telemetry infrastructure if we want to measure a new datapoint. - -## Impact -- Better planning of deployment of forces in MSBuild by product/team management. -- Customers can subscribe to telemetry locally to have data in standardized OpenTelemetry format - -## Stakeholders -- @Jan(Krivanek|Provaznik) design and implementation of telemetry via VS OTel. @ - using data we already have from SDK. -- @maridematte - documenting + dashboarding currently existing datapoints. -- MSBuild Team+Management – want insights from builds in VS -- VS OpenTelemetry team – provide support for VS OpenTelemetry collector library, want successful adoption -- SourceBuild – consulting and approving usage of OpenTelemetry -- MSBuild PM @baronfel – representing customers who want to monitor their builds locally - -### V1 Successful handover -- Shipped to Visual Studio -- Data queryable in Kusto -- Dashboards (even for pre-existing data - not introduced by this work) -- Customers are able to monitor with OpenTelemetry collector of choice (can be cut) - -## Risks -- Performance regression risks - it's another thing MSBuild would do and if the perf hit would be too bad it would need mitigation effort. -- It introduces a closed source dependency for VS and MSBuild.exe distribution methods which requires workarounds to remain compatible with SourceBuild policy (conditional compilation/build). -- Using a new VS API - might have gaps -- storage costs -- Potential additional costs and delays due to compliance with SourceBuild/VS data. - -## V1 Cost -5 months of .5 developer's effort ~ 50 dev days (dd) - -20-30dd JanPro OTel design + implementation, 10-15dd JanK design + implementation, 5-10dd Mariana/someone getting available data in order/"data science"/dashboards + external documentation - -Uncertainties: -It’s an exploratory project for VS OpenTelemetry, we'll be their first OSS component, so there might come up issues. SourceBuild compliance could introduce delays. - -## Plan -### V1 scope -- Collected data point definition -- Instrumented data points (as an example how the instrumentation and collection works) -- Telemetry sent to VS Telemetry in acceptable quantity -- Dashboards for collected data -- Hooking of customer's telemetry collection -- Documenting and leveraging pre-existing telemetry - -#### Out of scope -- Unifying telemetry for SDK MSBuild and MSBuild.exe/VS MSBuild. -- Thorough instrumentation of MSBuild -- Using MSBuild server -- Distributed tracing - -### Detailed cost -- Prototyping the libraries/mechanism for collecting telemetry data (month 1) 10dd - -- Defining usful data points (month 1) 5dd - -- Design and approval of hooking VSTelemetry collectors and OTel collectors (month 2) 10dd - -- Formalizing, agreeing to sourcebuild and other external requirements (month 2) 5dd - -- Instrumenting MSBuild with defined datapoints (month 3) 7dd - -- Creating dashboards/insights (month 4) 5dd - -- Documenting for customers how to hook their own telemetry collection (month 4) 3dd - -- Buffer for discovered issues (VSData Platform, SourceBuild, OpenTelemetry) and more investments (month 5) 5dd diff --git a/eng/Signing.props b/eng/Signing.props index b2e4bff8ffe..00e8367eb86 100644 --- a/eng/Signing.props +++ b/eng/Signing.props @@ -13,9 +13,6 @@ - - - diff --git a/eng/Versions.props b/eng/Versions.props index 5ab5660455d..74765ef67d5 100644 --- a/eng/Versions.props +++ b/eng/Versions.props @@ -59,8 +59,8 @@ - 0.2.104-beta - + 17.14.18 + diff --git a/src/Build.UnitTests/BackEnd/BuildManager_Tests.cs b/src/Build.UnitTests/BackEnd/BuildManager_Tests.cs index 06cf011f5a2..ab4af5b59d6 100644 --- a/src/Build.UnitTests/BackEnd/BuildManager_Tests.cs +++ b/src/Build.UnitTests/BackEnd/BuildManager_Tests.cs @@ -1801,7 +1801,6 @@ public void OverlappingBuildsOfTheSameProjectDifferentTargetsAreAllowed() "); - Project project = CreateProject(contents, MSBuildDefaultToolsVersion, _projectCollection, true); ProjectInstance instance = _buildManager.GetProjectInstanceForBuild(project); _buildManager.BeginBuild(_parameters); diff --git a/src/Build.UnitTests/Microsoft.Build.Engine.UnitTests.csproj b/src/Build.UnitTests/Microsoft.Build.Engine.UnitTests.csproj index 4ee55fb60ea..25ce6ea2727 100644 --- a/src/Build.UnitTests/Microsoft.Build.Engine.UnitTests.csproj +++ b/src/Build.UnitTests/Microsoft.Build.Engine.UnitTests.csproj @@ -30,10 +30,7 @@ all - - - - + diff --git a/src/Build.UnitTests/Telemetry/OpenTelemetryActivities_Tests.cs b/src/Build.UnitTests/Telemetry/OpenTelemetryActivities_Tests.cs deleted file mode 100644 index 7a567e79495..00000000000 --- a/src/Build.UnitTests/Telemetry/OpenTelemetryActivities_Tests.cs +++ /dev/null @@ -1,195 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System; -using System.Collections.Generic; -using System.Diagnostics; -using Microsoft.Build.Framework.Telemetry; -using Shouldly; -using Xunit; - -namespace Microsoft.Build.Engine.UnitTests.Telemetry -{ - public class ActivityExtensionsTests - { - [Fact] - public void WithTag_ShouldSetUnhashedValue() - { - var activity = new Activity("TestActivity"); - activity.Start(); - - var telemetryItem = new TelemetryItem( - Name: "TestItem", - Value: "TestValue", - NeedsHashing: false); - - activity.WithTag(telemetryItem); - - var tagValue = activity.GetTagItem("VS.MSBuild.TestItem"); - tagValue.ShouldNotBeNull(); - tagValue.ShouldBe("TestValue"); - - activity.Dispose(); - } - - [Fact] - public void WithTag_ShouldSetHashedValue() - { - var activity = new Activity("TestActivity"); - var telemetryItem = new TelemetryItem( - Name: "TestItem", - Value: "SensitiveValue", - NeedsHashing: true); - - activity.WithTag(telemetryItem); - - var tagValue = activity.GetTagItem("VS.MSBuild.TestItem"); - tagValue.ShouldNotBeNull(); - tagValue.ShouldNotBe("SensitiveValue"); // Ensure it’s not the plain text - activity.Dispose(); - } - - [Fact] - public void WithTags_ShouldSetMultipleTags() - { - var activity = new Activity("TestActivity"); - var tags = new List - { - new("Item1", "Value1", false), - new("Item2", "Value2", true) // hashed - }; - - activity.WithTags(tags); - - var tagValue1 = activity.GetTagItem("VS.MSBuild.Item1"); - var tagValue2 = activity.GetTagItem("VS.MSBuild.Item2"); - - tagValue1.ShouldNotBeNull(); - tagValue1.ShouldBe("Value1"); - - tagValue2.ShouldNotBeNull(); - tagValue2.ShouldNotBe("Value2"); // hashed - - activity.Dispose(); - } - - [Fact] - public void WithTags_DataHolderShouldSetMultipleTags() - { - var activity = new Activity("TestActivity"); - var dataHolder = new MockTelemetryDataHolder(); // see below - - activity.WithTags(dataHolder); - - var tagValueA = activity.GetTagItem("VS.MSBuild.TagA"); - var tagValueB = activity.GetTagItem("VS.MSBuild.TagB"); - - tagValueA.ShouldNotBeNull(); - tagValueA.ShouldBe("ValueA"); - - tagValueB.ShouldNotBeNull(); - tagValueB.ShouldNotBe("ValueB"); // should be hashed - activity.Dispose(); - } - - [Fact] - public void WithStartTime_ShouldSetActivityStartTime() - { - var activity = new Activity("TestActivity"); - var now = DateTime.UtcNow; - - activity.WithStartTime(now); - - activity.StartTimeUtc.ShouldBe(now); - activity.Dispose(); - } - - [Fact] - public void WithStartTime_NullDateTime_ShouldNotSetStartTime() - { - var activity = new Activity("TestActivity"); - var originalStartTime = activity.StartTimeUtc; // should be default (min) if not started - - activity.WithStartTime(null); - - activity.StartTimeUtc.ShouldBe(originalStartTime); - - activity.Dispose(); - } - } - - /// - /// A simple mock for testing IActivityTelemetryDataHolder. - /// Returns two items: one hashed, one not hashed. - /// - internal sealed class MockTelemetryDataHolder : IActivityTelemetryDataHolder - { - public IList GetActivityProperties() - { - return new List - { - new("TagA", "ValueA", false), - new("TagB", "ValueB", true), - }; - } - } - - - public class MSBuildActivitySourceTests - { - [Fact] - public void StartActivity_ShouldPrefixNameCorrectly_WhenNoRemoteParent() - { - var source = new MSBuildActivitySource(TelemetryConstants.DefaultActivitySourceNamespace, 1.0); - using var listener = new ActivityListener - { - ShouldListenTo = activitySource => activitySource.Name == TelemetryConstants.DefaultActivitySourceNamespace, - Sample = (ref ActivityCreationOptions options) => ActivitySamplingResult.AllData, - }; - ActivitySource.AddActivityListener(listener); - - - var activity = source.StartActivity("Build"); - - activity.ShouldNotBeNull(); - activity?.DisplayName.ShouldBe("VS/MSBuild/Build"); - - activity?.Dispose(); - } - - [Fact] - public void StartActivity_ShouldUseParentId_WhenRemoteParentExists() - { - // Arrange - var parentActivity = new Activity("ParentActivity"); - parentActivity.SetParentId("|12345.abcde."); // Simulate some parent trace ID - parentActivity.AddTag("sampleTag", "sampleVal"); - parentActivity.Start(); - - var source = new MSBuildActivitySource(TelemetryConstants.DefaultActivitySourceNamespace, 1.0); - using var listener = new ActivityListener - { - ShouldListenTo = activitySource => activitySource.Name == TelemetryConstants.DefaultActivitySourceNamespace, - Sample = (ref ActivityCreationOptions options) => ActivitySamplingResult.AllData, - }; - ActivitySource.AddActivityListener(listener); - - // Act - var childActivity = source.StartActivity("ChildBuild"); - - // Assert - childActivity.ShouldNotBeNull(); - // If HasRemoteParent is true, the code uses `parentId: Activity.Current.ParentId`. - // However, by default .NET Activity doesn't automatically set HasRemoteParent = true - // unless you explicitly set it. If you have logic that sets it, you can test it here. - // For demonstration, we assume the ParentId is carried over if HasRemoteParent == true. - if (Activity.Current?.HasRemoteParent == true) - { - childActivity?.ParentId.ShouldBe("|12345.abcde."); - } - - parentActivity.Dispose(); - childActivity?.Dispose(); - } - } -} diff --git a/src/Build.UnitTests/Telemetry/OpenTelemetryManager_Tests.cs b/src/Build.UnitTests/Telemetry/OpenTelemetryManager_Tests.cs deleted file mode 100644 index 3faa3ab54a9..00000000000 --- a/src/Build.UnitTests/Telemetry/OpenTelemetryManager_Tests.cs +++ /dev/null @@ -1,142 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System; -using System.Collections.Generic; -using System.Linq; -using System.Reflection; -using Microsoft.Build.Execution; -using Microsoft.Build.Framework.Telemetry; -using Microsoft.Build.UnitTests; -using Shouldly; -using Xunit; - -namespace Microsoft.Build.Engine.UnitTests.Telemetry -{ - // Putting the tests to a collection ensures tests run serially by default, that's needed to isolate the manager singleton state and env vars in some telemetry tests. - [Collection("OpenTelemetryManagerTests")] - public class OpenTelemetryManagerTests : IDisposable - { - - private const string TelemetryFxOptoutEnvVarName = "MSBUILD_TELEMETRY_OPTOUT"; - private const string DotnetOptOut = "DOTNET_CLI_TELEMETRY_OPTOUT"; - private const string TelemetrySampleRateOverrideEnvVarName = "MSBUILD_TELEMETRY_SAMPLE_RATE"; - private const string VS1714TelemetryOptInEnvVarName = "MSBUILD_TELEMETRY_OPTIN"; - - public OpenTelemetryManagerTests() - { - } - - public void Dispose() - { - ResetManagerState(); - } - - [Theory] - [InlineData(DotnetOptOut, "true")] - [InlineData(TelemetryFxOptoutEnvVarName, "true")] - [InlineData(DotnetOptOut, "1")] - [InlineData(TelemetryFxOptoutEnvVarName, "1")] - public void Initialize_ShouldSetStateToOptOut_WhenOptOutEnvVarIsTrue(string optoutVar, string value) - { - // Arrange - using TestEnvironment environment = TestEnvironment.Create(); - environment.SetEnvironmentVariable(optoutVar, value); - - // Act - OpenTelemetryManager.Instance.Initialize(isStandalone: false); - - // Assert - OpenTelemetryManager.Instance.IsActive().ShouldBeFalse(); - } - -#if NETCOREAPP - [Fact] - public void Initialize_ShouldSetStateToUnsampled_WhenNoOverrideOnNetCore() - { - using TestEnvironment environment = TestEnvironment.Create(); - environment.SetEnvironmentVariable(TelemetrySampleRateOverrideEnvVarName, null); - environment.SetEnvironmentVariable(DotnetOptOut, null); - - OpenTelemetryManager.Instance.Initialize(isStandalone: false); - - // If no override on .NET, we expect no Active ActivitySource - OpenTelemetryManager.Instance.DefaultActivitySource.ShouldBeNull(); - } -#endif - - [Theory] - [InlineData(true)] - [InlineData(false)] - public void Initialize_ShouldSetSampleRateOverride_AndCreateActivitySource_WhenRandomBelowOverride(bool standalone) - { - // Arrange - using TestEnvironment environment = TestEnvironment.Create(); - environment.SetEnvironmentVariable(VS1714TelemetryOptInEnvVarName, "1"); - environment.SetEnvironmentVariable(TelemetrySampleRateOverrideEnvVarName, "1.0"); - environment.SetEnvironmentVariable(DotnetOptOut, null); - - // Act - OpenTelemetryManager.Instance.Initialize(isStandalone: standalone); - - // Assert - OpenTelemetryManager.Instance.IsActive().ShouldBeTrue(); - OpenTelemetryManager.Instance.DefaultActivitySource.ShouldNotBeNull(); - } - - [Fact] - public void Initialize_ShouldNoOp_WhenCalledMultipleTimes() - { - using TestEnvironment environment = TestEnvironment.Create(); - environment.SetEnvironmentVariable(DotnetOptOut, "true"); - OpenTelemetryManager.Instance.Initialize(isStandalone: true); - var state1 = OpenTelemetryManager.Instance.IsActive(); - - environment.SetEnvironmentVariable(DotnetOptOut, null); - OpenTelemetryManager.Instance.Initialize(isStandalone: true); - var state2 = OpenTelemetryManager.Instance.IsActive(); - - // Because the manager is already initialized, second call is a no-op - state1.ShouldBe(false); - state2.ShouldBe(false); - } - - [Fact] - public void TelemetryLoadFailureIsLoggedOnce() - { - OpenTelemetryManager.Instance.LoadFailureExceptionMessage = new System.IO.FileNotFoundException().ToString(); - using BuildManager bm = new BuildManager(); - var deferredMessages = new List(); - bm.BeginBuild(new BuildParameters(), deferredMessages); - deferredMessages.ShouldContain(x => x.Text.Contains("FileNotFound")); - bm.EndBuild(); - bm.BeginBuild(new BuildParameters()); - bm.EndBuild(); - - // should not add message twice - int count = deferredMessages.Count(x => x.Text.Contains("FileNotFound")); - count.ShouldBe(1); - } - - /* Helper methods */ - - /// - /// Resets the singleton manager to a known uninitialized state so each test is isolated. - /// - private void ResetManagerState() - { - var instance = OpenTelemetryManager.Instance; - - // 1. Reset the private _telemetryState field - var telemetryStateField = typeof(OpenTelemetryManager) - .GetField("_telemetryState", BindingFlags.NonPublic | BindingFlags.Instance); - telemetryStateField?.SetValue(instance, OpenTelemetryManager.TelemetryState.Uninitialized); - - // 2. Null out the DefaultActivitySource property - var defaultSourceProp = typeof(OpenTelemetryManager) - .GetProperty(nameof(OpenTelemetryManager.DefaultActivitySource), - BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance); - defaultSourceProp?.SetValue(instance, null); - } - } -} diff --git a/src/Build.UnitTests/Telemetry/Telemetry_Tests.cs b/src/Build.UnitTests/Telemetry/Telemetry_Tests.cs index f03ee221094..fb2459d683b 100644 --- a/src/Build.UnitTests/Telemetry/Telemetry_Tests.cs +++ b/src/Build.UnitTests/Telemetry/Telemetry_Tests.cs @@ -5,7 +5,7 @@ using System.Collections.Generic; using System.Diagnostics; using System.Linq; -using System.Text.Json; +using System.Threading; using Microsoft.Build.Execution; using Microsoft.Build.Framework; using Microsoft.Build.Framework.Telemetry; @@ -14,10 +14,12 @@ using Shouldly; using Xunit; using Xunit.Abstractions; +using static Microsoft.Build.Framework.Telemetry.BuildInsights; +using static Microsoft.Build.Framework.Telemetry.TelemetryDataUtils; namespace Microsoft.Build.Engine.UnitTests { - [Collection("OpenTelemetryManagerTests")] + [Collection("TelemetryManagerTests")] public class Telemetry_Tests { private readonly ITestOutputHelper _output; @@ -27,29 +29,6 @@ public Telemetry_Tests(ITestOutputHelper output) _output = output; } - private sealed class ProjectFinishedCapturingLogger : ILogger - { - private readonly List _projectFinishedEventArgs = []; - public LoggerVerbosity Verbosity { get; set; } - public string? Parameters { get; set; } - - public IReadOnlyList ProjectFinishedEventArgsReceived => - _projectFinishedEventArgs; - - public void Initialize(IEventSource eventSource) - { - eventSource.ProjectFinished += EventSource_ProjectFinished; - } - - private void EventSource_ProjectFinished(object sender, ProjectFinishedEventArgs e) - { - _projectFinishedEventArgs.Add(e); - } - - public void Shutdown() - { } - } - [Fact] public void WorkerNodeTelemetryCollection_BasicTarget() { @@ -57,16 +36,16 @@ public void WorkerNodeTelemetryCollection_BasicTarget() InternalTelemetryConsumingLogger.TestOnly_InternalTelemetryAggregted += dt => workerNodeTelemetryData = dt; var testProject = """ - - - - - - - - - - """; + + + + + + + + + + """; MockLogger logger = new MockLogger(_output); Helpers.BuildProjectContentUsingBuildManager(testProject, logger, @@ -79,9 +58,9 @@ public void WorkerNodeTelemetryCollection_BasicTarget() workerNodeTelemetryData.TargetsExecutionData.Keys.Count.ShouldBe(1); workerNodeTelemetryData.TasksExecutionData.Keys.Count.ShouldBeGreaterThan(2); - ((int)workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.Message"].ExecutionsCount).ShouldBe(2); + workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.Message"].ExecutionsCount.ShouldBe(2); workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.Message"].CumulativeExecutionTime.ShouldBeGreaterThan(TimeSpan.Zero); - ((int)workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.CreateItem"].ExecutionsCount).ShouldBe(1); + workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.CreateItem"].ExecutionsCount.ShouldBe(1); workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.CreateItem"].CumulativeExecutionTime.ShouldBeGreaterThan(TimeSpan.Zero); workerNodeTelemetryData.TasksExecutionData.Keys.ShouldAllBe(k => !k.IsCustom && !k.IsNuget); @@ -92,8 +71,8 @@ public void WorkerNodeTelemetryCollection_BasicTarget() [Fact] public void WorkerNodeTelemetryCollection_CustomTargetsAndTasks() { - WorkerNodeTelemetryData? workerNodeTelemetryData = null; - InternalTelemetryConsumingLogger.TestOnly_InternalTelemetryAggregted += dt => workerNodeTelemetryData = dt; + WorkerNodeTelemetryData? workerNodeData = null; + InternalTelemetryConsumingLogger.TestOnly_InternalTelemetryAggregted += dt => workerNodeData = dt; var testProject = """ @@ -108,7 +87,6 @@ public void WorkerNodeTelemetryCollection_CustomTargetsAndTasks() - - @@ -129,73 +106,77 @@ public void WorkerNodeTelemetryCollection_CustomTargetsAndTasks() - - """; + MockLogger logger = new MockLogger(_output); - Helpers.BuildProjectContentUsingBuildManager(testProject, logger, + Helpers.BuildProjectContentUsingBuildManager( + testProject, + logger, new BuildParameters() { IsTelemetryEnabled = true }).OverallResult.ShouldBe(BuildResultCode.Success); - workerNodeTelemetryData!.ShouldNotBeNull(); - workerNodeTelemetryData.TargetsExecutionData.ShouldContainKey(new TaskOrTargetTelemetryKey("Build", true, false)); - workerNodeTelemetryData.TargetsExecutionData[new TaskOrTargetTelemetryKey("Build", true, false)].ShouldBeTrue(); - workerNodeTelemetryData.TargetsExecutionData.ShouldContainKey(new TaskOrTargetTelemetryKey("BeforeBuild", true, false)); - workerNodeTelemetryData.TargetsExecutionData[new TaskOrTargetTelemetryKey("BeforeBuild", true, false)].ShouldBeTrue(); - workerNodeTelemetryData.TargetsExecutionData.ShouldContainKey(new TaskOrTargetTelemetryKey("NotExecuted", true, false)); - workerNodeTelemetryData.TargetsExecutionData[new TaskOrTargetTelemetryKey("NotExecuted", true, false)].ShouldBeFalse(); - workerNodeTelemetryData.TargetsExecutionData.Keys.Count.ShouldBe(3); + workerNodeData!.ShouldNotBeNull(); + workerNodeData.TargetsExecutionData.ShouldContainKey(new TaskOrTargetTelemetryKey("Build", true, false)); + workerNodeData.TargetsExecutionData[new TaskOrTargetTelemetryKey("Build", true, false)].ShouldBeTrue(); + workerNodeData.TargetsExecutionData.ShouldContainKey(new TaskOrTargetTelemetryKey("BeforeBuild", true, false)); + workerNodeData.TargetsExecutionData[new TaskOrTargetTelemetryKey("BeforeBuild", true, false)].ShouldBeTrue(); + workerNodeData.TargetsExecutionData.ShouldContainKey(new TaskOrTargetTelemetryKey("NotExecuted", true, false)); + workerNodeData.TargetsExecutionData[new TaskOrTargetTelemetryKey("NotExecuted", true, false)].ShouldBeFalse(); + workerNodeData.TargetsExecutionData.Keys.Count.ShouldBe(3); - workerNodeTelemetryData.TasksExecutionData.Keys.Count.ShouldBeGreaterThan(2); - ((int)workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.Message"].ExecutionsCount).ShouldBe(3); - workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.Message"].CumulativeExecutionTime.ShouldBeGreaterThan(TimeSpan.Zero); - ((int)workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.CreateItem"].ExecutionsCount).ShouldBe(1); - workerNodeTelemetryData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.CreateItem"].CumulativeExecutionTime.ShouldBeGreaterThan(TimeSpan.Zero); + workerNodeData.TasksExecutionData.Keys.Count.ShouldBeGreaterThan(2); + workerNodeData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.Message"].ExecutionsCount.ShouldBe(3); + workerNodeData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.Message"].CumulativeExecutionTime.ShouldBeGreaterThan(TimeSpan.Zero); + workerNodeData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.CreateItem"].ExecutionsCount.ShouldBe(1); + workerNodeData.TasksExecutionData[(TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.CreateItem"].CumulativeExecutionTime.ShouldBeGreaterThan(TimeSpan.Zero); - ((int)workerNodeTelemetryData.TasksExecutionData[new TaskOrTargetTelemetryKey("Task01", true, false)].ExecutionsCount).ShouldBe(2); - workerNodeTelemetryData.TasksExecutionData[new TaskOrTargetTelemetryKey("Task01", true, false)].CumulativeExecutionTime.ShouldBeGreaterThan(TimeSpan.Zero); + workerNodeData.TasksExecutionData[new TaskOrTargetTelemetryKey("Task01", true, false)].ExecutionsCount.ShouldBe(2); + workerNodeData.TasksExecutionData[new TaskOrTargetTelemetryKey("Task01", true, false)].CumulativeExecutionTime.ShouldBeGreaterThan(TimeSpan.Zero); - ((int)workerNodeTelemetryData.TasksExecutionData[new TaskOrTargetTelemetryKey("Task02", true, false)].ExecutionsCount).ShouldBe(0); - workerNodeTelemetryData.TasksExecutionData[new TaskOrTargetTelemetryKey("Task02", true, false)].CumulativeExecutionTime.ShouldBe(TimeSpan.Zero); + workerNodeData.TasksExecutionData[new TaskOrTargetTelemetryKey("Task02", true, false)].ExecutionsCount.ShouldBe(0); + workerNodeData.TasksExecutionData[new TaskOrTargetTelemetryKey("Task02", true, false)].CumulativeExecutionTime.ShouldBe(TimeSpan.Zero); - workerNodeTelemetryData.TasksExecutionData.Values - .Count(v => v.CumulativeExecutionTime > TimeSpan.Zero || v.ExecutionsCount > 0).ShouldBe(3); + workerNodeData.TasksExecutionData.Values.Count(v => v.CumulativeExecutionTime > TimeSpan.Zero || v.ExecutionsCount > 0).ShouldBe(3); - workerNodeTelemetryData.TasksExecutionData.Keys.ShouldAllBe(k => !k.IsNuget); + workerNodeData.TasksExecutionData.Keys.ShouldAllBe(k => !k.IsNuget); } #if NET - // test in .net core with opentelemetry opted in to avoid sending it but enable listening to it + // test in .net core with telemetry opted in to avoid sending it but enable listening to it [Fact] public void NodeTelemetryE2E() { using TestEnvironment env = TestEnvironment.Create(); - env.SetEnvironmentVariable("MSBUILD_TELEMETRY_OPTIN", "1"); - env.SetEnvironmentVariable("MSBUILD_TELEMETRY_SAMPLE_RATE", "1.0"); env.SetEnvironmentVariable("MSBUILD_TELEMETRY_OPTOUT", null); env.SetEnvironmentVariable("DOTNET_CLI_TELEMETRY_OPTOUT", null); - // Reset the OpenTelemetryManager state to ensure clean test - ResetManagerState(); - - // track activities through an ActivityListener var capturedActivities = new List(); + using var activityStoppedEvent = new ManualResetEventSlim(false); using var listener = new ActivityListener { ShouldListenTo = source => source.Name.StartsWith(TelemetryConstants.DefaultActivitySourceNamespace), - Sample = (ref ActivityCreationOptions _) => ActivitySamplingResult.AllData, - ActivityStarted = capturedActivities.Add, - ActivityStopped = _ => { } + Sample = (ref ActivityCreationOptions _) => ActivitySamplingResult.AllDataAndRecorded, + ActivityStarted = a => { lock (capturedActivities) { capturedActivities.Add(a); } }, + ActivityStopped = a => + { + if (a.DisplayName == "VS/MSBuild/Build") + { + activityStoppedEvent.Set(); + } + }, }; ActivitySource.AddActivityListener(listener); + // Reset TelemetryManager to force re-initialization with our listener active + TelemetryManager.ResetForTest(); + var testProject = @" @@ -248,78 +229,76 @@ public void NodeTelemetryE2E() // Phase 3: End Build - This puts telemetry to an system.diagnostics activity buildManager.EndBuild(); - - // Verify build activity were captured by the listener and contain task and target info - capturedActivities.ShouldNotBeEmpty(); - var activity = capturedActivities.FindLast(a => a.DisplayName == "VS/MSBuild/Build").ShouldNotBeNull(); - var tags = activity.Tags.ToDictionary(t => t.Key, t => t.Value); - tags.ShouldNotBeNull(); - - tags.ShouldContainKey("VS.MSBuild.BuildTarget"); - tags["VS.MSBuild.BuildTarget"].ShouldNotBeNullOrEmpty(); - - // Verify task data - tags.ShouldContainKey("VS.MSBuild.Tasks"); - var tasksJson = tags["VS.MSBuild.Tasks"]; - tasksJson.ShouldNotBeNullOrEmpty(); - tasksJson.ShouldContain("Microsoft.Build.Tasks.Message"); - tasksJson.ShouldContain("Microsoft.Build.Tasks.CreateItem"); - - // Parse tasks data for detailed assertions - var tasksData = JsonSerializer.Deserialize(tasksJson); - - // Verify Message task execution metrics - updated for object structure - tasksData.TryGetProperty("Microsoft.Build.Tasks.Message", out var messageTask).ShouldBe(true); - messageTask.GetProperty("ExecutionsCount").GetInt32().ShouldBe(3); - messageTask.GetProperty("TotalMilliseconds").GetDouble().ShouldBeGreaterThan(0); - messageTask.GetProperty("TotalMemoryBytes").GetInt64().ShouldBeGreaterThanOrEqualTo(0); - messageTask.GetProperty(nameof(TaskOrTargetTelemetryKey.IsCustom)).GetBoolean().ShouldBe(false); - messageTask.GetProperty(nameof(TaskOrTargetTelemetryKey.IsCustom)).GetBoolean().ShouldBe(false); - - // Verify CreateItem task execution metrics - updated for object structure - tasksData.TryGetProperty("Microsoft.Build.Tasks.CreateItem", out var createItemTask).ShouldBe(true); - createItemTask.GetProperty("ExecutionsCount").GetInt32().ShouldBe(1); - createItemTask.GetProperty("TotalMilliseconds").GetDouble().ShouldBeGreaterThan(0); - createItemTask.GetProperty("TotalMemoryBytes").GetInt64().ShouldBeGreaterThanOrEqualTo(0); - - // Verify Targets summary information - tags.ShouldContainKey("VS.MSBuild.TargetsSummary"); - var targetsSummaryJson = tags["VS.MSBuild.TargetsSummary"]; - targetsSummaryJson.ShouldNotBeNullOrEmpty(); - var targetsSummary = JsonSerializer.Deserialize(targetsSummaryJson); - - // Verify loaded and executed targets counts - match structure in TargetsSummaryConverter.Write - targetsSummary.GetProperty("Loaded").GetProperty("Total").GetInt32().ShouldBe(2); - targetsSummary.GetProperty("Executed").GetProperty("Total").GetInt32().ShouldBe(2); - - // Verify Tasks summary information - tags.ShouldContainKey("VS.MSBuild.TasksSummary"); - var tasksSummaryJson = tags["VS.MSBuild.TasksSummary"]; - tasksSummaryJson.ShouldNotBeNullOrEmpty(); - var tasksSummary = JsonSerializer.Deserialize(tasksSummaryJson); - - // Verify task execution summary metrics based on TasksSummaryConverter.Write structure - tasksSummary.GetProperty("Microsoft").GetProperty("Total").GetProperty("ExecutionsCount").GetInt32().ShouldBe(4); - tasksSummary.GetProperty("Microsoft").GetProperty("Total").GetProperty("TotalMilliseconds").GetDouble().ShouldBeGreaterThan(0); - // Allowing 0 for TotalMemoryBytes as it is possible for tasks to allocate no memory in certain scenarios. - tasksSummary.GetProperty("Microsoft").GetProperty("Total").GetProperty("TotalMemoryBytes").GetInt64().ShouldBeGreaterThanOrEqualTo(0); } - // Reset the OpenTelemetryManager state to ensure it doesn't affect other tests - ResetManagerState(); + + // Wait for the activity to be fully processed + activityStoppedEvent.Wait(TimeSpan.FromSeconds(10)).ShouldBeTrue("Timed out waiting for build activity to stop"); + + // Verify build activity were captured by the listener and contain task and target info + capturedActivities.ShouldNotBeEmpty(); + var activity = capturedActivities.FindLast(a => a.DisplayName == "VS/MSBuild/Build").ShouldNotBeNull(); + var tags = activity.Tags.ToDictionary(t => t.Key, t => t.Value); + tags.ShouldNotBeNull(); + + tags.ShouldContainKey("VS.MSBuild.BuildTarget"); + tags["VS.MSBuild.BuildTarget"].ShouldNotBeNullOrEmpty(); + + // Verify task data + var tasks = activity.TagObjects.FirstOrDefault(to => to.Key == "VS.MSBuild.Tasks"); + + var tasksData = tasks.Value as List; + var messageTaskData = tasksData!.FirstOrDefault(t => t.Name == "Microsoft.Build.Tasks.Message"); + messageTaskData.ShouldNotBeNull(); + + // Verify Message task execution metrics + messageTaskData.ExecutionsCount.ShouldBe(3); + messageTaskData.TotalMilliseconds.ShouldBeGreaterThan(0); + messageTaskData.TotalMemoryBytes.ShouldBeGreaterThanOrEqualTo(0); + messageTaskData.IsCustom.ShouldBe(false); + + // Verify CreateItem task execution metrics + var createItemTaskData = tasksData!.FirstOrDefault(t => t.Name == "Microsoft.Build.Tasks.CreateItem"); + createItemTaskData.ShouldNotBeNull(); + createItemTaskData.ExecutionsCount.ShouldBe(1); + createItemTaskData.TotalMilliseconds.ShouldBeGreaterThan(0); + createItemTaskData.TotalMemoryBytes.ShouldBeGreaterThanOrEqualTo(0); + + // Verify Targets summary information + var targetsSummaryTagObject = activity.TagObjects.FirstOrDefault(to => to.Key.Contains("VS.MSBuild.TargetsSummary")); + var targetsSummary = targetsSummaryTagObject.Value as TargetsSummaryInfo; + targetsSummary.ShouldNotBeNull(); + targetsSummary.Loaded.Total.ShouldBe(2); + targetsSummary.Executed.Total.ShouldBe(2); + + // Verify Tasks summary information + var tasksSummaryTagObject = activity.TagObjects.FirstOrDefault(to => to.Key.Contains("VS.MSBuild.TasksSummary")); + var tasksSummary = tasksSummaryTagObject.Value as TasksSummaryInfo; + tasksSummary.ShouldNotBeNull(); + + tasksSummary.Microsoft.ShouldNotBeNull(); + tasksSummary.Microsoft!.Total!.ExecutionsCount.ShouldBe(4); + tasksSummary.Microsoft!.Total!.TotalMilliseconds.ShouldBeGreaterThan(0); + + // Allowing 0 for TotalMemoryBytes as it is possible for tasks to allocate no memory in certain scenarios. + tasksSummary.Microsoft.Total.TotalMemoryBytes.ShouldBeGreaterThanOrEqualTo(0); } +#endif - private void ResetManagerState() + private sealed class ProjectFinishedCapturingLogger : ILogger { - var instance = OpenTelemetryManager.Instance; - typeof(OpenTelemetryManager) - .GetField("_telemetryState", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance) - ?.SetValue(instance, OpenTelemetryManager.TelemetryState.Uninitialized); - - typeof(OpenTelemetryManager) - .GetProperty("DefaultActivitySource", - System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance) - ?.SetValue(instance, null); + private readonly List _projectFinishedEventArgs = []; + + public LoggerVerbosity Verbosity { get; set; } + + public string? Parameters { get; set; } + + public IReadOnlyList ProjectFinishedEventArgsReceived => _projectFinishedEventArgs; + + public void Initialize(IEventSource eventSource) => eventSource.ProjectFinished += EventSource_ProjectFinished; + + private void EventSource_ProjectFinished(object sender, ProjectFinishedEventArgs e) => _projectFinishedEventArgs.Add(e); + + public void Shutdown() { } } -#endif } } diff --git a/src/Build/BackEnd/BuildManager/BuildManager.cs b/src/Build/BackEnd/BuildManager/BuildManager.cs index 7a70791f17b..887ce2d15ca 100644 --- a/src/Build/BackEnd/BuildManager/BuildManager.cs +++ b/src/Build/BackEnd/BuildManager/BuildManager.cs @@ -26,13 +26,13 @@ using Microsoft.Build.Exceptions; using Microsoft.Build.Experimental.BuildCheck; using Microsoft.Build.Experimental.BuildCheck.Infrastructure; -using Microsoft.Build.ProjectCache; using Microsoft.Build.FileAccesses; using Microsoft.Build.Framework; using Microsoft.Build.Framework.Telemetry; using Microsoft.Build.Graph; using Microsoft.Build.Internal; using Microsoft.Build.Logging; +using Microsoft.Build.ProjectCache; using Microsoft.Build.Shared; using Microsoft.Build.Shared.Debugging; using Microsoft.Build.Shared.FileSystem; @@ -280,7 +280,7 @@ public class BuildManager : INodePacketHandler, IBuildComponentHost, IDisposable /// /// Creates a new unnamed build manager. /// Normally there is only one build manager in a process, and it is the default build manager. - /// Access it with + /// Access it with . /// public BuildManager() : this("Unnamed") @@ -290,11 +290,12 @@ public BuildManager() /// /// Creates a new build manager with an arbitrary distinct name. /// Normally there is only one build manager in a process, and it is the default build manager. - /// Access it with + /// Access it with . /// public BuildManager(string hostName) { ErrorUtilities.VerifyThrowArgumentNull(hostName); + _hostName = hostName; _buildManagerState = BuildManagerState.Idle; _buildSubmissions = new Dictionary(); @@ -336,12 +337,12 @@ private enum BuildManagerState /// /// This is the state the BuildManager is in after has been called but before has been called. - /// , , , , and may be called in this state. + /// , , , , and may be called in this state. /// Building, /// - /// This is the state the BuildManager is in after has been called but before all existing submissions have completed. + /// This is the state the BuildManager is in after has been called but before all existing submissions have completed. /// WaitingForBuildToComplete } @@ -459,8 +460,11 @@ private void UpdatePriority(Process p, ProcessPriorityClass priority) /// Thrown if a build is already in progress. public void BeginBuild(BuildParameters parameters) { - InitializeTelemetry(); - +#if NETFRAMEWORK + // Collect telemetry unless explicitly opted out via environment variable. + // The decision to send telemetry is made at EndBuild to avoid eager loading of telemetry assemblies. + parameters.IsTelemetryEnabled |= !TelemetryManager.IsOptOut(); +#endif if (_previousLowPriority != null) { if (parameters.LowPriority != _previousLowPriority) @@ -529,6 +533,7 @@ public void BeginBuild(BuildParameters parameters) } _buildTelemetry.InnerStartAt = now; + _buildTelemetry.IsStandaloneExecution ??= false; if (BuildParameters.DumpOpportunisticInternStats) { @@ -585,7 +590,6 @@ public void BeginBuild(BuildParameters parameters) // Initialize components. _nodeManager = ((IBuildComponentHost)this).GetComponent(BuildComponentType.NodeManager) as INodeManager; - _buildParameters.IsTelemetryEnabled |= OpenTelemetryManager.Instance.IsActive(); var loggingService = InitializeLoggingService(); // Log deferred messages and response files @@ -739,25 +743,6 @@ void InitializeCaches() } } - private void InitializeTelemetry() - { - OpenTelemetryManager.Instance.Initialize(isStandalone: false); - string? failureMessage = OpenTelemetryManager.Instance.LoadFailureExceptionMessage; - if (_deferredBuildMessages != null && - failureMessage != null && - _deferredBuildMessages is ICollection deferredBuildMessagesCollection) - { - deferredBuildMessagesCollection.Add( - new DeferredBuildMessage( - ResourceUtilities.FormatResourceStringIgnoreCodeAndKeyword( - "OpenTelemetryLoadFailed", - failureMessage), - MessageImportance.Low)); - - // clean up the message from OpenTelemetryManager to avoid double logging it - OpenTelemetryManager.Instance.LoadFailureExceptionMessage = null; - } - } #if FEATURE_REPORTFILEACCESSES /// @@ -1120,6 +1105,7 @@ public void EndBuild() { host = "VSCode"; } + _buildTelemetry.BuildEngineHost = host; _buildTelemetry.BuildCheckEnabled = _buildParameters!.IsBuildCheckEnabled; @@ -1129,10 +1115,8 @@ public void EndBuild() _buildTelemetry.SACEnabled = sacState == NativeMethodsShared.SAC_State.Evaluation || sacState == NativeMethodsShared.SAC_State.Enforcement; loggingService.LogTelemetry(buildEventContext: null, _buildTelemetry.EventName, _buildTelemetry.GetProperties()); - if (OpenTelemetryManager.Instance.IsActive()) - { - EndBuildTelemetry(); - } + + EndBuildTelemetry(); // Clean telemetry to make it ready for next build submission. _buildTelemetry = null; @@ -1176,18 +1160,18 @@ void SerializeCaches() } } - [MethodImpl(MethodImplOptions.NoInlining)] // avoid assembly loads of System.Diagnostics.DiagnosticSource, TODO: when this is agreed to perf-wise enable instrumenting using activities anywhere... + [MethodImpl(MethodImplOptions.NoInlining)] private void EndBuildTelemetry() { - OpenTelemetryManager.Instance.DefaultActivitySource? - .StartActivity("Build")? - .WithTags(_buildTelemetry) - .WithTags(_telemetryConsumingLogger?.WorkerNodeTelemetryData.AsActivityDataHolder( - includeTasksDetails: !Traits.Instance.ExcludeTasksDetailsFromTelemetry, - includeTargetDetails: false)) - .WithStartTime(_buildTelemetry!.InnerStartAt) - .Dispose(); - OpenTelemetryManager.Instance.ForceFlush(); + TelemetryManager.Instance.Initialize(isStandalone: false); + + using IActivity? activity = TelemetryManager.Instance + ?.DefaultActivitySource + ?.StartActivity(TelemetryConstants.Build) + ?.SetTags(_buildTelemetry) + ?.SetTags(_telemetryConsumingLogger?.WorkerNodeTelemetryData.AsActivityDataHolder( + includeTasksDetails: !Traits.Instance.ExcludeTasksDetailsFromTelemetry, + includeTargetDetails: false)); } /// @@ -3040,8 +3024,7 @@ private ILoggingService CreateLoggingService( loggerSwitchParameters: null, verbosity: LoggerVerbosity.Quiet); - _telemetryConsumingLogger = - new InternalTelemetryConsumingLogger(); + _telemetryConsumingLogger = new InternalTelemetryConsumingLogger(); ForwardingLoggerRecord[] forwardingLogger = { new ForwardingLoggerRecord(_telemetryConsumingLogger, forwardingLoggerDescription) }; @@ -3053,7 +3036,6 @@ private ILoggingService CreateLoggingService( loggingService.EnableTargetOutputLogging = true; } - try { if (loggers != null) @@ -3265,6 +3247,8 @@ private void Dispose(bool disposing) s_singletonInstance = null; } + TelemetryManager.Instance?.Dispose(); + _disposed = true; } } diff --git a/src/Build/BackEnd/Components/Logging/LoggingService.cs b/src/Build/BackEnd/Components/Logging/LoggingService.cs index 487c10b69b0..d2067256d9c 100644 --- a/src/Build/BackEnd/Components/Logging/LoggingService.cs +++ b/src/Build/BackEnd/Components/Logging/LoggingService.cs @@ -1848,6 +1848,11 @@ private void UpdateMinimumMessageImportance(ILogger logger) // The null logger has no effect on minimum verbosity. Execution.BuildManager.NullLogger => null, + // Telemetry loggers only consume WorkerNodeTelemetryLogged events, not message events. + // They have no effect on minimum message verbosity. + TelemetryInfra.InternalTelemetryConsumingLogger => null, + Framework.Telemetry.InternalTelemetryForwardingLogger => null, + TerminalLogger terminalLogger => terminalLogger.GetMinimumMessageImportance(), _ => innerLogger.GetType().FullName == "Microsoft.Build.Logging.TerminalLogger" diff --git a/src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs b/src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs index d99df97edb7..f4eeca2c1ef 100644 --- a/src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs +++ b/src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs @@ -1267,9 +1267,9 @@ private void UpdateStatisticsPostBuild() { ITelemetryForwarder telemetryForwarder = ((TelemetryForwarderProvider)_componentHost.GetComponent(BuildComponentType.TelemetryForwarder)) - .Instance; + ?.Instance; - if (!telemetryForwarder.IsTelemetryCollected) + if (telemetryForwarder == null || !telemetryForwarder.IsTelemetryCollected) { return; } @@ -1279,6 +1279,11 @@ private void UpdateStatisticsPostBuild() // Hence we need to fetch the original result from the cache - to get the data for all executed targets. BuildResult unfilteredResult = resultsCache.GetResultsForConfiguration(_requestEntry.Request.ConfigurationId); + if (unfilteredResult?.ResultsByTarget == null || _requestEntry.RequestConfiguration.Project?.Targets == null) + { + return; + } + foreach (var projectTargetInstance in _requestEntry.RequestConfiguration.Project.Targets) { bool wasExecuted = diff --git a/src/Build/Microsoft.Build.csproj b/src/Build/Microsoft.Build.csproj index d53ecf9d743..a0834749ca8 100644 --- a/src/Build/Microsoft.Build.csproj +++ b/src/Build/Microsoft.Build.csproj @@ -182,7 +182,6 @@ - diff --git a/src/Build/Resources/Strings.resx b/src/Build/Resources/Strings.resx index 95da5690fa1..401757434dc 100644 --- a/src/Build/Resources/Strings.resx +++ b/src/Build/Resources/Strings.resx @@ -2428,9 +2428,6 @@ Utilization: {0} Average Utilization: {1:###.0} succeeded: {0} {0} whole number - - Loading telemetry libraries failed with exception: {0}. - Custom TaskFactory '{0}' for Task '{1}' does not support out of process TaskHost execution. Turn off the multithreaded build mode or remove the custom TaskFactory from your <UsingTask> definitions in project files. diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index a5773bf2038..63c5e33025a 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -652,11 +652,6 @@ Metoda {0} se nedá zavolat s kolekcí, která obsahuje prázdné cílové názvy nebo názvy null. - - Loading telemetry libraries failed with exception: {0}. - Načítání knihoven telemetrie se nezdařilo s výjimkou: {0}. - - Output Property: Výstupní vlastnost: diff --git a/src/Build/Resources/xlf/Strings.de.xlf b/src/Build/Resources/xlf/Strings.de.xlf index 29625306e1d..f731975839f 100644 --- a/src/Build/Resources/xlf/Strings.de.xlf +++ b/src/Build/Resources/xlf/Strings.de.xlf @@ -652,11 +652,6 @@ Die Methode "{0}" kann nicht mit einer Sammlung aufgerufen werden, die NULL oder leere Zielnamen enthält. - - Loading telemetry libraries failed with exception: {0}. - Fehler beim Laden von Telemetriebibliotheken. Ausnahme:{0}. - - Output Property: Ausgabeeigenschaft: diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index fbad7f6fbd9..3e9c155cea7 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -652,11 +652,6 @@ No se puede llamar al método {0} con una colección que contiene nombres de destino nulos o vacíos. - - Loading telemetry libraries failed with exception: {0}. - Error al cargar las bibliotecas de telemetría con la excepción: {0}. - - Output Property: Propiedad de salida: diff --git a/src/Build/Resources/xlf/Strings.fr.xlf b/src/Build/Resources/xlf/Strings.fr.xlf index e36c0d13f30..9e0c8281ae3 100644 --- a/src/Build/Resources/xlf/Strings.fr.xlf +++ b/src/Build/Resources/xlf/Strings.fr.xlf @@ -652,11 +652,6 @@ Impossible d'appeler la méthode {0} avec une collection contenant des noms de cibles qui ont une valeur null ou qui sont vides. - - Loading telemetry libraries failed with exception: {0}. - Nous n’avons pas pu charger les bibliothèques de télémétrie avec l’exception : {0}. - - Output Property: Propriété de sortie : diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index 35520f4ead6..5a589fa568b 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -652,11 +652,6 @@ Non è possibile chiamare il metodo {0} con una raccolta contenente nomi di destinazione Null o vuoti. - - Loading telemetry libraries failed with exception: {0}. - Caricamento delle librerie di telemetria non riuscito con eccezione: {0}. - - Output Property: Proprietà di output: diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index ff6592d2d65..3ba522678a6 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -652,11 +652,6 @@ Null または空のターゲット名を含むコレクションを指定してメソッド {0} を呼び出すことはできません。 - - Loading telemetry libraries failed with exception: {0}. - テレメトリ ライブラリの読み込みが次の例外で失敗しました: {0}。 - - Output Property: プロパティの出力: diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index 1f8febc1325..e7d00c351da 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -652,11 +652,6 @@ null 또는 빈 대상 이름을 포함하는 컬렉션을 사용하여 {0} 메서드를 호출할 수 없습니다. - - Loading telemetry libraries failed with exception: {0}. - 예외 {0}(으)로 인해 원격 분석 라이브러리를 로드하지 못했습니다. - - Output Property: 출력 속성: diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index 48fcf71d76d..e0df1be2942 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -652,11 +652,6 @@ Metody {0} nie można wywołać przy użyciu kolekcji zawierającej nazwy docelowe o wartości null lub puste. - - Loading telemetry libraries failed with exception: {0}. - Ładowanie bibliotek telemetrii nie powiodło się. Wyjątek: {0}. - - Output Property: Właściwość danych wyjściowych: diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index 78e5e61e1f4..081e761e83c 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -652,11 +652,6 @@ O método {0} não pode ser chamado com uma coleção que contém nomes de destino nulos ou vazios. - - Loading telemetry libraries failed with exception: {0}. - Falha ao carregar as bibliotecas de telemetria com a exceção: {0}. - - Output Property: Propriedade de Saída: diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index 50ad0335993..b859753c3c8 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -652,11 +652,6 @@ Метод {0} не может быть вызван с коллекцией, содержащей целевые имена, которые пусты или равны NULL. - - Loading telemetry libraries failed with exception: {0}. - Не удалось загрузить библиотеки телеметрии с исключением: {0}. - - Output Property: Выходное свойство: diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index 2299d8178e6..4e5bc849ce9 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -652,11 +652,6 @@ {0} metosu null veya boş hedef adları içeren bir koleksiyonla çağrılamaz. - - Loading telemetry libraries failed with exception: {0}. - Telemetri kitaplıklarının yüklenmesi şu hayatla başarısız oldu: {0}. - - Output Property: Çıkış Özelliği: diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index 9f1610a48a2..0412e4b9a83 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -652,11 +652,6 @@ 无法使用包含 null 或空目标名称的集合调用方法 {0}。 - - Loading telemetry libraries failed with exception: {0}. - 加载遥测库失败，出现异常: {0}。 - - Output Property: 输出属性: diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index 0c718642f76..5d951c0a935 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -652,11 +652,6 @@ 無法使用內含 null 或空白目標名稱的集合呼叫方法 {0}。 - - Loading telemetry libraries failed with exception: {0}. - 載入遙測程式庫時發生例外狀況: {0}。 - - Output Property: 輸出屬性: diff --git a/src/Build/TelemetryInfra/ITelemetryForwarder.cs b/src/Build/TelemetryInfra/ITelemetryForwarder.cs index 15d021bfb81..97735076593 100644 --- a/src/Build/TelemetryInfra/ITelemetryForwarder.cs +++ b/src/Build/TelemetryInfra/ITelemetryForwarder.cs @@ -14,7 +14,12 @@ internal interface ITelemetryForwarder { bool IsTelemetryCollected { get; } - void AddTask(string name, TimeSpan cumulativeExecutionTime, short executionsCount, long totalMemoryConsumed, bool isCustom, + void AddTask( + string name, + TimeSpan cumulativeExecutionTime, + short executionsCount, + long totalMemoryConsumed, + bool isCustom, bool isFromNugetCache); /// diff --git a/src/Build/TelemetryInfra/InternalTelemetryConsumingLogger.cs b/src/Build/TelemetryInfra/InternalTelemetryConsumingLogger.cs index b028dd4b7fa..d4a388d79ce 100644 --- a/src/Build/TelemetryInfra/InternalTelemetryConsumingLogger.cs +++ b/src/Build/TelemetryInfra/InternalTelemetryConsumingLogger.cs @@ -11,7 +11,9 @@ namespace Microsoft.Build.TelemetryInfra; internal sealed class InternalTelemetryConsumingLogger : ILogger { public LoggerVerbosity Verbosity { get; set; } + public string? Parameters { get; set; } + internal static event Action? TestOnly_InternalTelemetryAggregted; public void Initialize(IEventSource eventSource) @@ -70,12 +72,14 @@ private void FlushDataIntoConsoleIfRequested() { Console.WriteLine($"{task.Key} - {task.Value.TotalMemoryBytes / 1024.0:0.00}kB"); } + Console.WriteLine("=========================================="); Console.WriteLine("Tasks by Executions count:"); foreach (var task in _workerNodeTelemetryData.TasksExecutionData.OrderByDescending(t => t.Value.ExecutionsCount)) { Console.WriteLine($"{task.Key} - {task.Value.ExecutionsCount}"); } + Console.WriteLine("=========================================="); } diff --git a/src/Build/TelemetryInfra/TelemetryDataUtils.cs b/src/Build/TelemetryInfra/TelemetryDataUtils.cs deleted file mode 100644 index e2759bec030..00000000000 --- a/src/Build/TelemetryInfra/TelemetryDataUtils.cs +++ /dev/null @@ -1,339 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System; -using System.Collections.Generic; -using System.Text.Json; -using System.Text.Json.Serialization; - -namespace Microsoft.Build.Framework.Telemetry -{ - internal static class TelemetryDataUtils - { - /// - /// Transforms collected telemetry data to format recognized by the telemetry infrastructure. - /// - /// Data about tasks and target forwarded from nodes. - /// Controls whether Task details should attached to the telemetry. - /// Controls whether Target details should be attached to the telemetry. - /// Node Telemetry data wrapped in a list of properties that can be attached as tags to a . - public static IActivityTelemetryDataHolder? AsActivityDataHolder(this IWorkerNodeTelemetryData? telemetryData, bool includeTasksDetails, bool includeTargetDetails) - { - if (telemetryData == null) - { - return null; - } - - List telemetryItems = new(4); - - if (includeTasksDetails) - { - telemetryItems.Add(new TelemetryItem(NodeTelemetryTags.Tasks, - JsonSerializer.Serialize(telemetryData.TasksExecutionData, _serializerOptions), false)); - } - - if (includeTargetDetails) - { - telemetryItems.Add(new TelemetryItem(NodeTelemetryTags.Targets, - JsonSerializer.Serialize(telemetryData.TargetsExecutionData, _serializerOptions), false)); - } - - TargetsSummaryConverter targetsSummary = new(); - targetsSummary.Process(telemetryData.TargetsExecutionData); - telemetryItems.Add(new TelemetryItem(NodeTelemetryTags.TargetsSummary, - JsonSerializer.Serialize(targetsSummary, _serializerOptions), false)); - - TasksSummaryConverter tasksSummary = new(); - tasksSummary.Process(telemetryData.TasksExecutionData); - telemetryItems.Add(new TelemetryItem(NodeTelemetryTags.TasksSummary, - JsonSerializer.Serialize(tasksSummary, _serializerOptions), false)); - - return new NodeTelemetry(telemetryItems); - } - - private static JsonSerializerOptions _serializerOptions = CreateSerializerOptions(); - - private static JsonSerializerOptions CreateSerializerOptions() - { - var opt = new JsonSerializerOptions - { - Converters = - { - new TargetsDetailsConverter(), - new TasksDetailsConverter(), - new TargetsSummaryConverter(), - new TasksSummaryConverter(), - }, - }; - - return opt; - } - - private class TargetsDetailsConverter : JsonConverter?> - { - public override Dictionary? Read( - ref Utf8JsonReader reader, - Type typeToConvert, - JsonSerializerOptions options) - => - throw new NotImplementedException("Reading is not supported"); - - public override void Write( - Utf8JsonWriter writer, - Dictionary? value, - JsonSerializerOptions options) - { - if (value == null) - { - throw new NotSupportedException("TaskOrTargetTelemetryKey cannot be null in telemetry data"); - } - - // Following needed - as System.Text.Json doesn't support indexing dictionary by composite types - writer.WriteStartObject(); - - foreach (KeyValuePair valuePair in value) - { - string keyName = ShouldHashKey(valuePair.Key) ? - ActivityExtensions.GetHashed(valuePair.Key.Name) : - valuePair.Key.Name; - - writer.WriteStartObject(keyName); - writer.WriteBoolean("WasExecuted", valuePair.Value); - writer.WriteBoolean(nameof(valuePair.Key.IsCustom), valuePair.Key.IsCustom); - writer.WriteBoolean(nameof(valuePair.Key.IsNuget), valuePair.Key.IsNuget); - writer.WriteBoolean(nameof(valuePair.Key.IsMetaProj), valuePair.Key.IsMetaProj); - writer.WriteEndObject(); - } - - writer.WriteEndObject(); - } - - private bool ShouldHashKey(TaskOrTargetTelemetryKey key) => key.IsCustom || key.IsMetaProj; - } - - private class TasksDetailsConverter : JsonConverter?> - { - public override Dictionary? Read( - ref Utf8JsonReader reader, - Type typeToConvert, - JsonSerializerOptions options) - => - throw new NotImplementedException("Reading is not supported"); - - public override void Write( - Utf8JsonWriter writer, - Dictionary? value, - JsonSerializerOptions options) - { - if (value == null) - { - throw new NotSupportedException("TaskOrTargetTelemetryKey cannot be null in telemetry data"); - } - - // Following needed - as System.Text.Json doesn't support indexing dictionary by composite types - writer.WriteStartObject(); - - foreach (KeyValuePair valuePair in value) - { - string keyName = valuePair.Key.IsCustom ? - ActivityExtensions.GetHashed(valuePair.Key.Name) : - valuePair.Key.Name; - writer.WriteStartObject(keyName); - writer.WriteNumber(nameof(valuePair.Value.CumulativeExecutionTime.TotalMilliseconds), valuePair.Value.CumulativeExecutionTime.TotalMilliseconds); - writer.WriteNumber(nameof(valuePair.Value.ExecutionsCount), valuePair.Value.ExecutionsCount); - writer.WriteNumber(nameof(valuePair.Value.TotalMemoryBytes), valuePair.Value.TotalMemoryBytes); - writer.WriteBoolean(nameof(valuePair.Key.IsCustom), valuePair.Key.IsCustom); - writer.WriteBoolean(nameof(valuePair.Key.IsNuget), valuePair.Key.IsNuget); - writer.WriteEndObject(); - } - - writer.WriteEndObject(); - } - } - - private class TargetsSummaryConverter : JsonConverter - { - /// - /// Processes target execution data to compile summary statistics for both built-in and custom targets. - /// - /// Dictionary containing target execution data keyed by task identifiers. - public void Process(Dictionary targetsExecutionData) - { - foreach (KeyValuePair targetPair in targetsExecutionData) - { - TaskOrTargetTelemetryKey key = targetPair.Key; - bool wasExecuted = targetPair.Value; - - // Update loaded targets statistics (all targets are loaded) - UpdateTargetStatistics(key, isExecuted: false); - - // Update executed targets statistics (only targets that were actually executed) - if (wasExecuted) - { - UpdateTargetStatistics(key, isExecuted: true); - } - } - } - - private void UpdateTargetStatistics(TaskOrTargetTelemetryKey key, bool isExecuted) - { - // Select the appropriate target info collections based on execution state - TargetInfo builtinTargetInfo = isExecuted ? ExecutedBuiltinTargetInfo : LoadedBuiltinTargetInfo; - TargetInfo customTargetInfo = isExecuted ? ExecutedCustomTargetInfo : LoadedCustomTargetInfo; - - // Update either custom or builtin target info based on target type - TargetInfo targetInfo = key.IsCustom ? customTargetInfo : builtinTargetInfo; - - targetInfo.Total++; - if (key.IsNuget) - { - targetInfo.FromNuget++; - } - if (key.IsMetaProj) - { - targetInfo.FromMetaproj++; - } - } - - private TargetInfo LoadedBuiltinTargetInfo { get; } = new(); - private TargetInfo LoadedCustomTargetInfo { get; } = new(); - private TargetInfo ExecutedBuiltinTargetInfo { get; } = new(); - private TargetInfo ExecutedCustomTargetInfo { get; } = new(); - - private class TargetInfo - { - public int Total { get; internal set; } - public int FromNuget { get; internal set; } - public int FromMetaproj { get; internal set; } - } - - public override TargetsSummaryConverter? Read( - ref Utf8JsonReader reader, - Type typeToConvert, - JsonSerializerOptions options) => - throw new NotImplementedException("Reading is not supported"); - - public override void Write( - Utf8JsonWriter writer, - TargetsSummaryConverter value, - JsonSerializerOptions options) - { - writer.WriteStartObject(); - writer.WriteStartObject("Loaded"); - WriteStat(writer, value.LoadedBuiltinTargetInfo, value.LoadedCustomTargetInfo); - writer.WriteEndObject(); - writer.WriteStartObject("Executed"); - WriteStat(writer, value.ExecutedBuiltinTargetInfo, value.ExecutedCustomTargetInfo); - writer.WriteEndObject(); - writer.WriteEndObject(); - - void WriteStat(Utf8JsonWriter writer, TargetInfo builtinTargetsInfo, TargetInfo customTargetsInfo) - { - writer.WriteNumber(nameof(builtinTargetsInfo.Total), builtinTargetsInfo.Total + customTargetsInfo.Total); - WriteSingleStat(writer, builtinTargetsInfo, "Microsoft"); - WriteSingleStat(writer, customTargetsInfo, "Custom"); - } - - void WriteSingleStat(Utf8JsonWriter writer, TargetInfo targetInfo, string name) - { - if (targetInfo.Total > 0) - { - writer.WriteStartObject(name); - writer.WriteNumber(nameof(targetInfo.Total), targetInfo.Total); - writer.WriteNumber(nameof(targetInfo.FromNuget), targetInfo.FromNuget); - writer.WriteNumber(nameof(targetInfo.FromMetaproj), targetInfo.FromMetaproj); - writer.WriteEndObject(); - } - } - } - } - - private class TasksSummaryConverter : JsonConverter - { - /// - /// Processes task execution data to compile summary statistics for both built-in and custom tasks. - /// - /// Dictionary containing task execution data keyed by task identifiers. - public void Process(Dictionary tasksExecutionData) - { - foreach (KeyValuePair taskInfo in tasksExecutionData) - { - UpdateTaskStatistics(BuiltinTasksInfo, CustomTasksInfo, taskInfo.Key, taskInfo.Value); - } - } - - private void UpdateTaskStatistics( - TasksInfo builtinTaskInfo, - TasksInfo customTaskInfo, - TaskOrTargetTelemetryKey key, - TaskExecutionStats taskExecutionStats) - { - TasksInfo taskInfo = key.IsCustom ? customTaskInfo : builtinTaskInfo; - taskInfo.Total.Accumulate(taskExecutionStats); - - if (key.IsNuget) - { - taskInfo.FromNuget.Accumulate(taskExecutionStats); - } - } - - private TasksInfo BuiltinTasksInfo { get; } = new TasksInfo(); - - private TasksInfo CustomTasksInfo { get; } = new TasksInfo(); - - private class TasksInfo - { - public TaskExecutionStats Total { get; } = TaskExecutionStats.CreateEmpty(); - - public TaskExecutionStats FromNuget { get; } = TaskExecutionStats.CreateEmpty(); - } - - public override TasksSummaryConverter? Read( - ref Utf8JsonReader reader, - Type typeToConvert, - JsonSerializerOptions options) => - throw new NotImplementedException("Reading is not supported"); - - public override void Write( - Utf8JsonWriter writer, - TasksSummaryConverter value, - JsonSerializerOptions options) - { - writer.WriteStartObject(); - WriteStat(writer, value.BuiltinTasksInfo, "Microsoft"); - WriteStat(writer, value.CustomTasksInfo, "Custom"); - writer.WriteEndObject(); - - void WriteStat(Utf8JsonWriter writer, TasksInfo tasksInfo, string name) - { - writer.WriteStartObject(name); - WriteSingleStat(writer, tasksInfo.Total, nameof(tasksInfo.Total)); - WriteSingleStat(writer, tasksInfo.FromNuget, nameof(tasksInfo.FromNuget)); - writer.WriteEndObject(); - } - - void WriteSingleStat(Utf8JsonWriter writer, TaskExecutionStats stats, string name) - { - if (stats.ExecutionsCount > 0) - { - writer.WriteStartObject(name); - writer.WriteNumber(nameof(stats.ExecutionsCount), stats.ExecutionsCount); - writer.WriteNumber(nameof(stats.CumulativeExecutionTime.TotalMilliseconds), stats.CumulativeExecutionTime.TotalMilliseconds); - writer.WriteNumber(nameof(stats.TotalMemoryBytes), stats.TotalMemoryBytes); - writer.WriteEndObject(); - } - } - } - } - - private class NodeTelemetry : IActivityTelemetryDataHolder - { - private readonly IList _items; - - public NodeTelemetry(IList items) => _items = items; - - public IList GetActivityProperties() - => _items; - } - } -} diff --git a/src/Framework/Microsoft.Build.Framework.csproj b/src/Framework/Microsoft.Build.Framework.csproj index 2f972d7903e..2820f9af784 100644 --- a/src/Framework/Microsoft.Build.Framework.csproj +++ b/src/Framework/Microsoft.Build.Framework.csproj @@ -24,21 +24,19 @@ - - - + + - + - diff --git a/src/Framework/Telemetry/ActivityExtensions.cs b/src/Framework/Telemetry/ActivityExtensions.cs deleted file mode 100644 index 9b4e05f7c02..00000000000 --- a/src/Framework/Telemetry/ActivityExtensions.cs +++ /dev/null @@ -1,111 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System; -using System.Collections.Generic; -using System.Diagnostics; -using System.Security.Cryptography; -using System.Text; - -namespace Microsoft.Build.Framework.Telemetry -{ - /// - /// Extension methods for . usage in VS OpenTelemetry. - /// - internal static class ActivityExtensions - { - /// - /// Add tags to the activity from a . - /// - public static Activity WithTags(this Activity activity, IActivityTelemetryDataHolder? dataHolder) - { - if (dataHolder != null) - { - activity.WithTags(dataHolder.GetActivityProperties()); - } - return activity; - } - - /// - /// Add tags to the activity from a list of TelemetryItems. - /// - public static Activity WithTags(this Activity activity, IList tags) - { - foreach (var tag in tags) - { - activity.WithTag(tag); - } - return activity; - } - /// - /// Add a tag to the activity from a . - /// - public static Activity WithTag(this Activity activity, TelemetryItem item) - { - object value = item.NeedsHashing ? GetHashed(item.Value) : item.Value; - activity.SetTag($"{TelemetryConstants.PropertyPrefix}{item.Name}", value); - return activity; - } - - /// - /// Set the start time of the activity. - /// - public static Activity WithStartTime(this Activity activity, DateTime? startTime) - { - if (startTime.HasValue) - { - activity.SetStartTime(startTime.Value); - } - return activity; - } - - /// - /// Depending on the platform, hash the value using an available mechanism. - /// - internal static string GetHashed(object value) - { - return Sha256Hasher.Hash(value.ToString() ?? ""); - } - - // https://github.com/dotnet/sdk/blob/8bd19a2390a6bba4aa80d1ac3b6c5385527cc311/src/Cli/Microsoft.DotNet.Cli.Utils/Sha256Hasher.cs + workaround for netstandard2.0 - private static class Sha256Hasher - { - /// - /// The hashed mac address needs to be the same hashed value as produced by the other distinct sources given the same input. (e.g. VsCode) - /// - public static string Hash(string text) - { - byte[] bytes = Encoding.UTF8.GetBytes(text); -#if NET - byte[] hash = SHA256.HashData(bytes); -#if NET9_0_OR_GREATER - return Convert.ToHexStringLower(hash); -#else - return Convert.ToHexString(hash).ToLowerInvariant(); -#endif - -#else - // Create the SHA256 object and compute the hash - using (var sha256 = SHA256.Create()) - { - byte[] hash = sha256.ComputeHash(bytes); - - // Convert the hash bytes to a lowercase hex string (manual loop approach) - var sb = new StringBuilder(hash.Length * 2); - foreach (byte b in hash) - { - sb.AppendFormat("{0:x2}", b); - } - - return sb.ToString(); - } -#endif - } - - public static string HashWithNormalizedCasing(string text) - { - return Hash(text.ToUpperInvariant()); - } - } - } -} diff --git a/src/Framework/Telemetry/BuildCheckTelemetry.cs b/src/Framework/Telemetry/BuildCheckTelemetry.cs index 3b8507203c1..8555a1b33e8 100644 --- a/src/Framework/Telemetry/BuildCheckTelemetry.cs +++ b/src/Framework/Telemetry/BuildCheckTelemetry.cs @@ -87,10 +87,7 @@ internal class BuildCheckTelemetry yield return (RuleStatsEventName, properties); } - // set for the new submission in case of build server _submissionId = Guid.NewGuid(); } } - - diff --git a/src/Framework/Telemetry/BuildInsights.cs b/src/Framework/Telemetry/BuildInsights.cs new file mode 100644 index 00000000000..50858c09323 --- /dev/null +++ b/src/Framework/Telemetry/BuildInsights.cs @@ -0,0 +1,39 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Collections.Generic; +using static Microsoft.Build.Framework.Telemetry.TelemetryDataUtils; + +namespace Microsoft.Build.Framework.Telemetry; + +/// +/// Container for all build telemetry insights including tasks and targets details and summaries. +/// +internal sealed class BuildInsights +{ + public List Tasks { get; } + + public List Targets { get; } + + public TargetsSummaryInfo TargetsSummary { get; } + + public TasksSummaryInfo TasksSummary { get; } + + public BuildInsights( + List tasks, + List targets, + TargetsSummaryInfo targetsSummary, + TasksSummaryInfo tasksSummary) + { + Tasks = tasks; + Targets = targets; + TargetsSummary = targetsSummary; + TasksSummary = tasksSummary; + } + + internal record TasksSummaryInfo(TaskCategoryStats? Microsoft, TaskCategoryStats? Custom); + + internal record TaskCategoryStats(TaskStatsInfo? Total, TaskStatsInfo? FromNuget); + + internal record TaskStatsInfo(int ExecutionsCount, double TotalMilliseconds, long TotalMemoryBytes); +} diff --git a/src/Framework/Telemetry/BuildTelemetry.cs b/src/Framework/Telemetry/BuildTelemetry.cs index c20c5817558..acaf6033f97 100644 --- a/src/Framework/Telemetry/BuildTelemetry.cs +++ b/src/Framework/Telemetry/BuildTelemetry.cs @@ -4,6 +4,7 @@ using System; using System.Collections.Generic; using System.Globalization; +using System.Runtime.CompilerServices; namespace Microsoft.Build.Framework.Telemetry { @@ -32,6 +33,11 @@ internal class BuildTelemetry : TelemetryBase, IActivityTelemetryDataHolder /// public DateTime? InnerStartAt { get; set; } + /// + /// True if MSBuild runs from command line. + /// + public bool? IsStandaloneExecution { get; set; } + /// /// Time at which build have finished. /// @@ -100,138 +106,83 @@ internal class BuildTelemetry : TelemetryBase, IActivityTelemetryDataHolder /// public string? BuildEngineFrameworkName { get; set; } - public override IDictionary GetProperties() + /// + /// Create a list of properties sent to VS telemetry. + /// + public Dictionary GetActivityProperties() { - var properties = new Dictionary(); - - // populate property values - if (BuildEngineDisplayVersion != null) - { - properties[nameof(BuildEngineDisplayVersion)] = BuildEngineDisplayVersion; - } + Dictionary telemetryItems = new(8); if (StartAt.HasValue && FinishedAt.HasValue) { - properties[TelemetryConstants.BuildDurationPropertyName] = (FinishedAt.Value - StartAt.Value).TotalMilliseconds.ToString(CultureInfo.InvariantCulture); + telemetryItems.Add(TelemetryConstants.BuildDurationPropertyName, (FinishedAt.Value - StartAt.Value).TotalMilliseconds); } if (InnerStartAt.HasValue && FinishedAt.HasValue) { - properties[TelemetryConstants.InnerBuildDurationPropertyName] = (FinishedAt.Value - InnerStartAt.Value).TotalMilliseconds.ToString(CultureInfo.InvariantCulture); - } - - if (BuildEngineFrameworkName != null) - { - properties[nameof(BuildEngineFrameworkName)] = BuildEngineFrameworkName; + telemetryItems.Add(TelemetryConstants.InnerBuildDurationPropertyName, (FinishedAt.Value - InnerStartAt.Value).TotalMilliseconds); } - if (BuildEngineHost != null) - { - properties[nameof(BuildEngineHost)] = BuildEngineHost; - } - - if (InitialMSBuildServerState != null) - { - properties[nameof(InitialMSBuildServerState)] = InitialMSBuildServerState; - } - - if (ProjectPath != null) - { - properties[nameof(ProjectPath)] = ProjectPath; - } - - if (ServerFallbackReason != null) - { - properties[nameof(ServerFallbackReason)] = ServerFallbackReason; - } - - if (BuildSuccess.HasValue) - { - properties[nameof(BuildSuccess)] = BuildSuccess.Value.ToString(CultureInfo.InvariantCulture); - } - - if (BuildTarget != null) - { - properties[nameof(BuildTarget)] = BuildTarget; - } - - if (BuildEngineVersion != null) - { - properties[nameof(BuildEngineVersion)] = BuildEngineVersion.ToString(); - } + AddIfNotNull(BuildEngineHost); + AddIfNotNull(BuildSuccess); + AddIfNotNull(BuildTarget); + AddIfNotNull(BuildEngineVersion); + AddIfNotNull(BuildCheckEnabled); + AddIfNotNull(MultiThreadedModeEnabled); + AddIfNotNull(SACEnabled); + AddIfNotNull(IsStandaloneExecution); - if (BuildCheckEnabled != null) - { - properties[nameof(BuildCheckEnabled)] = BuildCheckEnabled.Value.ToString(CultureInfo.InvariantCulture); - } - - if (MultiThreadedModeEnabled != null) - { - properties[nameof(MultiThreadedModeEnabled)] = MultiThreadedModeEnabled.Value.ToString(CultureInfo.InvariantCulture); - } + return telemetryItems; - if (SACEnabled != null) + void AddIfNotNull(object? value, [CallerArgumentExpression(nameof(value))] string key = "") { - properties[nameof(SACEnabled)] = SACEnabled.Value.ToString(CultureInfo.InvariantCulture); + if (value != null) + { + telemetryItems.Add(key, value); + } } - - return properties; } - /// - /// Create a list of properties sent to VS telemetry with the information whether they should be hashed. - /// - /// - public IList GetActivityProperties() + public override IDictionary GetProperties() { - List telemetryItems = new(8); + var properties = new Dictionary(); + AddIfNotNull(BuildEngineDisplayVersion); + AddIfNotNull(BuildEngineFrameworkName); + AddIfNotNull(BuildEngineHost); + AddIfNotNull(InitialMSBuildServerState); + AddIfNotNull(ProjectPath); + AddIfNotNull(ServerFallbackReason); + AddIfNotNull(BuildTarget); + AddIfNotNull(BuildEngineVersion?.ToString(), nameof(BuildEngineVersion)); + AddIfNotNull(BuildSuccess?.ToString(), nameof(BuildSuccess)); + AddIfNotNull(BuildCheckEnabled?.ToString(), nameof(BuildCheckEnabled)); + AddIfNotNull(MultiThreadedModeEnabled?.ToString(), nameof(MultiThreadedModeEnabled)); + AddIfNotNull(SACEnabled?.ToString(), nameof(SACEnabled)); + AddIfNotNull(IsStandaloneExecution?.ToString(), nameof(IsStandaloneExecution)); + + // Calculate durations if (StartAt.HasValue && FinishedAt.HasValue) { - telemetryItems.Add(new TelemetryItem(TelemetryConstants.BuildDurationPropertyName, (FinishedAt.Value - StartAt.Value).TotalMilliseconds, false)); + properties[TelemetryConstants.BuildDurationPropertyName] = + (FinishedAt.Value - StartAt.Value).TotalMilliseconds.ToString(CultureInfo.InvariantCulture); } if (InnerStartAt.HasValue && FinishedAt.HasValue) { - telemetryItems.Add(new TelemetryItem(TelemetryConstants.InnerBuildDurationPropertyName, (FinishedAt.Value - InnerStartAt.Value).TotalMilliseconds, false)); - } - - if (BuildEngineHost != null) - { - telemetryItems.Add(new TelemetryItem(nameof(BuildEngineHost), BuildEngineHost, false)); - } - - if (BuildSuccess.HasValue) - { - telemetryItems.Add(new TelemetryItem(nameof(BuildSuccess), BuildSuccess, false)); - } - - if (BuildTarget != null) - { - telemetryItems.Add(new TelemetryItem(nameof(BuildTarget), BuildTarget, true)); - } - - if (BuildEngineVersion != null) - { - telemetryItems.Add(new TelemetryItem(nameof(BuildEngineVersion), BuildEngineVersion.ToString(), false)); + properties[TelemetryConstants.InnerBuildDurationPropertyName] = + (FinishedAt.Value - InnerStartAt.Value).TotalMilliseconds.ToString(CultureInfo.InvariantCulture); } - if (BuildCheckEnabled != null) - { - telemetryItems.Add(new TelemetryItem(nameof(BuildCheckEnabled), BuildCheckEnabled, false)); - } - - if (MultiThreadedModeEnabled != null) - { - telemetryItems.Add(new TelemetryItem(nameof(MultiThreadedModeEnabled), MultiThreadedModeEnabled, false)); - } + return properties; - if (SACEnabled != null) + void AddIfNotNull(string? value, [CallerArgumentExpression(nameof(value))] string key = "") { - telemetryItems.Add(new TelemetryItem(nameof(SACEnabled), SACEnabled, false)); + if (value != null) + { + properties[key] = value; + } } - - return telemetryItems; } } } diff --git a/src/Framework/Telemetry/DiagnosticActivity.cs b/src/Framework/Telemetry/DiagnosticActivity.cs new file mode 100644 index 00000000000..3bb2ed30f8e --- /dev/null +++ b/src/Framework/Telemetry/DiagnosticActivity.cs @@ -0,0 +1,62 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#if !NETFRAMEWORK + +using System.Collections.Generic; +using System.Diagnostics; + +namespace Microsoft.Build.Framework.Telemetry +{ + /// + /// Wraps a and implements . + /// + internal class DiagnosticActivity : IActivity + { + private readonly Activity _activity; + private bool _disposed; + + public DiagnosticActivity(Activity activity) + { + _activity = activity; + } + + public IActivity? SetTags(IActivityTelemetryDataHolder? dataHolder) + { + Dictionary? tags = dataHolder?.GetActivityProperties(); + if (tags != null) + { + foreach (KeyValuePair tag in tags) + { + SetTag(tag.Key, tag.Value); + } + } + + return this; + } + + public IActivity? SetTag(string key, object? value) + { + if (value != null) + { + _activity.SetTag($"{TelemetryConstants.PropertyPrefix}{key}", value); + } + + return this; + } + + public void Dispose() + { + if (_disposed) + { + return; + } + + _activity.Dispose(); + + _disposed = true; + } + } +} + +#endif diff --git a/src/Framework/Telemetry/IActivity.cs b/src/Framework/Telemetry/IActivity.cs new file mode 100644 index 00000000000..6118e50f7e8 --- /dev/null +++ b/src/Framework/Telemetry/IActivity.cs @@ -0,0 +1,28 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System; + +namespace Microsoft.Build.Framework.Telemetry +{ + /// + /// Represents an activity for telemetry tracking. + /// + internal interface IActivity : IDisposable + { + /// + /// Sets a tag on the activity. + /// + /// Telemetry data holder. + /// The activity instance for method chaining. + IActivity? SetTags(IActivityTelemetryDataHolder? dataHolder); + + /// + /// Sets a tag on the activity. + /// + /// The tag key. + /// The tag value. + /// The activity instance for method chaining. + IActivity? SetTag(string key, object? value); + } +} diff --git a/src/Framework/Telemetry/IActivityTelemetryDataHolder.cs b/src/Framework/Telemetry/IActivityTelemetryDataHolder.cs index 9eeb0a7509f..e660f191695 100644 --- a/src/Framework/Telemetry/IActivityTelemetryDataHolder.cs +++ b/src/Framework/Telemetry/IActivityTelemetryDataHolder.cs @@ -2,14 +2,13 @@ // The .NET Foundation licenses this file to you under the MIT license. using System.Collections.Generic; -using System.Diagnostics; namespace Microsoft.Build.Framework.Telemetry; /// -/// Interface for classes that hold telemetry data that should be added as tags to an . +/// Interface for classes that hold telemetry data that should be added as tags to an . /// internal interface IActivityTelemetryDataHolder { - IList GetActivityProperties(); + Dictionary GetActivityProperties(); } diff --git a/src/Framework/Telemetry/IWorkerNodeTelemetryData.cs b/src/Framework/Telemetry/IWorkerNodeTelemetryData.cs index a0303e4a4e2..b4ca028d57d 100644 --- a/src/Framework/Telemetry/IWorkerNodeTelemetryData.cs +++ b/src/Framework/Telemetry/IWorkerNodeTelemetryData.cs @@ -8,5 +8,6 @@ namespace Microsoft.Build.Framework.Telemetry; internal interface IWorkerNodeTelemetryData { Dictionary TasksExecutionData { get; } + Dictionary TargetsExecutionData { get; } } diff --git a/src/Framework/Telemetry/MSBuildActivitySource.cs b/src/Framework/Telemetry/MSBuildActivitySource.cs index 7d73f87062f..891e85c781f 100644 --- a/src/Framework/Telemetry/MSBuildActivitySource.cs +++ b/src/Framework/Telemetry/MSBuildActivitySource.cs @@ -1,36 +1,62 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +#if NETFRAMEWORK +using Microsoft.VisualStudio.Telemetry; +#else using System.Diagnostics; +#endif namespace Microsoft.Build.Framework.Telemetry { /// - /// Wrapper class for ActivitySource with a method that wraps Activity name with VS OTel prefix. + /// Wrapper class for ActivitySource with a method that wraps Activity name with MSBuild prefix. + /// On .NET Framework, activities are also forwarded to VS Telemetry. /// internal class MSBuildActivitySource { +#if NETFRAMEWORK + private readonly TelemetrySession? _telemetrySession; + + public MSBuildActivitySource(TelemetrySession? telemetrySession) + { + _telemetrySession = telemetrySession; + } +#else private readonly ActivitySource _source; - private readonly double _sampleRate; - public MSBuildActivitySource(string name, double sampleRate) + public MSBuildActivitySource(string name) { _source = new ActivitySource(name); - _sampleRate = sampleRate; } +#endif + /// - /// Prefixes activity with VS OpenTelemetry. + /// Starts a new activity with the appropriate telemetry prefix. /// /// Name of the telemetry event without prefix. - /// - public Activity? StartActivity(string name) + /// An wrapping the underlying Activity, or null if not sampled. + public IActivity? StartActivity(string name) { - var activity = Activity.Current?.HasRemoteParent == true - ? _source.StartActivity($"{TelemetryConstants.EventPrefix}{name}", ActivityKind.Internal, parentId: Activity.Current.ParentId) - : _source.StartActivity($"{TelemetryConstants.EventPrefix}{name}"); - activity?.WithTag(new("SampleRate", _sampleRate, false)); + string eventName = $"{TelemetryConstants.EventPrefix}{name}"; + +#if NETFRAMEWORK + TelemetryScope? operation = _telemetrySession?.StartOperation(eventName); + return operation != null ? new VsTelemetryActivity(operation) : null; +#else + Activity? activity = Activity.Current?.HasRemoteParent == true + ? _source.StartActivity(eventName, ActivityKind.Internal, parentId: Activity.Current.ParentId) + : _source.StartActivity(eventName); + + if (activity == null) + { + return null; + } + + activity.SetTag("SampleRate", TelemetryConstants.DefaultSampleRate); - return activity; + return new DiagnosticActivity(activity); +#endif } } } diff --git a/src/Framework/Telemetry/OpenTelemetryManager.cs b/src/Framework/Telemetry/OpenTelemetryManager.cs deleted file mode 100644 index 7ee7813bddf..00000000000 --- a/src/Framework/Telemetry/OpenTelemetryManager.cs +++ /dev/null @@ -1,282 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. -#if NETFRAMEWORK -using Microsoft.VisualStudio.OpenTelemetry.ClientExtensions; -using Microsoft.VisualStudio.OpenTelemetry.ClientExtensions.Exporters; -using Microsoft.VisualStudio.OpenTelemetry.Collector.Interfaces; -using Microsoft.VisualStudio.OpenTelemetry.Collector.Settings; -using OpenTelemetry; -using OpenTelemetry.Trace; -#endif -using System; -using System.Runtime.CompilerServices; -using System.Threading; - -namespace Microsoft.Build.Framework.Telemetry -{ - - /// - /// Singleton class for configuring and managing the telemetry infrastructure with System.Diagnostics.Activity, - /// OpenTelemetry SDK, and VS OpenTelemetry Collector. - /// - internal class OpenTelemetryManager - { - // Lazy provides thread-safe lazy initialization. - private static readonly Lazy s_instance = - new Lazy(() => new OpenTelemetryManager(), LazyThreadSafetyMode.ExecutionAndPublication); - - /// - /// Globally accessible instance of . - /// - public static OpenTelemetryManager Instance => s_instance.Value; - - private TelemetryState _telemetryState = TelemetryState.Uninitialized; - private readonly LockType _initializeLock = new LockType(); - private double _sampleRate = TelemetryConstants.DefaultSampleRate; - -#if NETFRAMEWORK - private TracerProvider? _tracerProvider; - private IOpenTelemetryCollector? _collector; -#endif - - public string? LoadFailureExceptionMessage { get; set; } - - /// - /// Optional activity source for MSBuild or other telemetry usage. - /// - public MSBuildActivitySource? DefaultActivitySource { get; private set; } - - private OpenTelemetryManager() - { - } - - /// - /// Initializes the telemetry infrastructure. Multiple invocations are no-op, thread-safe. - /// - /// Differentiates between executing as MSBuild.exe or from VS/API. - public void Initialize(bool isStandalone) - { - // for lock free early exit - if (_telemetryState != TelemetryState.Uninitialized) - { - return; - } - - lock (_initializeLock) - { - // for correctness - if (_telemetryState != TelemetryState.Uninitialized) - { - return; - } - - if (IsOptOut()) - { - _telemetryState = TelemetryState.OptOut; - return; - } - - // TODO: temporary until we have green light to enable telemetry perf-wise - if (!IsOptIn()) - { - _telemetryState = TelemetryState.Unsampled; - return; - } - - if (!IsSampled()) - { - _telemetryState = TelemetryState.Unsampled; - return; - } - - InitializeActivitySources(); - } -#if NETFRAMEWORK - try - { - InitializeTracerProvider(); - - // TODO: Enable commented logic when Collector is present in VS - // if (isStandalone) - InitializeCollector(); - - // } - } - catch (Exception ex) when (ex is System.IO.FileNotFoundException or System.IO.FileLoadException) - { - // catch exceptions from loading the OTel SDK or Collector to maintain usability of Microsoft.Build.Framework package in our and downstream tests in VS. - _telemetryState = TelemetryState.Unsampled; - LoadFailureExceptionMessage = ex.ToString(); - return; - } -#endif - } - - [MethodImpl(MethodImplOptions.NoInlining)] // avoid assembly loads - private void InitializeActivitySources() - { - _telemetryState = TelemetryState.TracerInitialized; - DefaultActivitySource = new MSBuildActivitySource(TelemetryConstants.DefaultActivitySourceNamespace, _sampleRate); - } - -#if NETFRAMEWORK - /// - /// Initializes the OpenTelemetry SDK TracerProvider with VS default exporter settings. - /// - [MethodImpl(MethodImplOptions.NoInlining)] // avoid assembly loads - private void InitializeTracerProvider() - { - var exporterSettings = OpenTelemetryExporterSettingsBuilder - .CreateVSDefault(TelemetryConstants.VSMajorVersion) - .Build(); - - TracerProviderBuilder tracerProviderBuilder = Sdk - .CreateTracerProviderBuilder() - // this adds listeners to ActivitySources with the prefix "Microsoft.VisualStudio.OpenTelemetry." - .AddVisualStudioDefaultTraceExporter(exporterSettings); - - _tracerProvider = tracerProviderBuilder.Build(); - _telemetryState = TelemetryState.ExporterInitialized; - } - - /// - /// Initializes the VS OpenTelemetry Collector with VS default settings. - /// - [MethodImpl(MethodImplOptions.NoInlining)] // avoid assembly loads - private void InitializeCollector() - { - IOpenTelemetryCollectorSettings collectorSettings = OpenTelemetryCollectorSettingsBuilder - .CreateVSDefault(TelemetryConstants.VSMajorVersion) - .Build(); - - _collector = OpenTelemetryCollectorProvider.CreateCollector(collectorSettings); - _collector.StartAsync().GetAwaiter().GetResult(); - - _telemetryState = TelemetryState.CollectorInitialized; - } -#endif - [MethodImpl(MethodImplOptions.NoInlining)] // avoid assembly loads - private void ForceFlushInner() - { -#if NETFRAMEWORK - _tracerProvider?.ForceFlush(); -#endif - } - - /// - /// Flush the telemetry in TracerProvider/Exporter. - /// - public void ForceFlush() - { - if (ShouldBeCleanedUp()) - { - ForceFlushInner(); - } - } - - // to avoid assembly loading OpenTelemetry in tests - [MethodImpl(MethodImplOptions.NoInlining)] // avoid assembly loads - private void ShutdownInner() - { -#if NETFRAMEWORK - _tracerProvider?.Shutdown(); - // Dispose stops the collector, with a default drain timeout of 10s - _collector?.Dispose(); -#endif - } - - /// - /// Shuts down the telemetry infrastructure. - /// - public void Shutdown() - { - lock (_initializeLock) - { - if (ShouldBeCleanedUp()) - { - ShutdownInner(); - } - - _telemetryState = TelemetryState.Disposed; - } - } - - /// - /// Determines if the user has explicitly opted out of telemetry. - /// - private bool IsOptOut() => Traits.Instance.FrameworkTelemetryOptOut || Traits.Instance.SdkTelemetryOptOut || !ChangeWaves.AreFeaturesEnabled(ChangeWaves.Wave17_14); - - /// - /// TODO: Temporary until perf of loading OTel is agreed to in VS. - /// - private bool IsOptIn() => !IsOptOut() && (Traits.Instance.TelemetryOptIn || Traits.Instance.TelemetrySampleRateOverride.HasValue); - - /// - /// Determines if telemetry should be initialized based on sampling and environment variable overrides. - /// - private bool IsSampled() - { - double? overrideRate = Traits.Instance.TelemetrySampleRateOverride; - if (overrideRate.HasValue) - { - _sampleRate = overrideRate.Value; - } - else - { -#if !NETFRAMEWORK - // In core, OTel infrastructure is not initialized by default. - return false; -#endif - } - - // Simple random sampling, this method is called once, no need to save the Random instance. - Random random = new(); - return random.NextDouble() < _sampleRate; - } - - private bool ShouldBeCleanedUp() => _telemetryState == TelemetryState.CollectorInitialized || _telemetryState == TelemetryState.ExporterInitialized; - - internal bool IsActive() => _telemetryState == TelemetryState.TracerInitialized || _telemetryState == TelemetryState.CollectorInitialized || _telemetryState == TelemetryState.ExporterInitialized; - - /// - /// State of the telemetry infrastructure. - /// - internal enum TelemetryState - { - /// - /// Initial state. - /// - Uninitialized, - - /// - /// Opt out of telemetry. - /// - OptOut, - - /// - /// Run not sampled for telemetry. - /// - Unsampled, - - /// - /// For core hook, ActivitySource is created. - /// - TracerInitialized, - - /// - /// For VS scenario with a collector. ActivitySource, OTel TracerProvider are created. - /// - ExporterInitialized, - - /// - /// For standalone, ActivitySource, OTel TracerProvider, VS OpenTelemetry Collector are created. - /// - CollectorInitialized, - - /// - /// End state. - /// - Disposed - } - } -} diff --git a/src/Framework/Telemetry/TelemetryConstants.cs b/src/Framework/Telemetry/TelemetryConstants.cs index dc51085f60c..94e194b9e48 100644 --- a/src/Framework/Telemetry/TelemetryConstants.cs +++ b/src/Framework/Telemetry/TelemetryConstants.cs @@ -3,20 +3,10 @@ namespace Microsoft.Build.Framework.Telemetry; /// -/// Constants for VS OpenTelemetry for basic configuration and appropriate naming for VS exporting/collection. +/// Constants for VS Telemetry for basic configuration and appropriate naming for VS exporting/collection. /// internal static class TelemetryConstants { - /// - /// "Microsoft.VisualStudio.OpenTelemetry.*" namespace is required by VS exporting/collection. - /// - public const string ActivitySourceNamespacePrefix = "Microsoft.VisualStudio.OpenTelemetry.MSBuild."; - - /// - /// Namespace of the default ActivitySource handling e.g. End of build telemetry. - /// - public const string DefaultActivitySourceNamespace = $"{ActivitySourceNamespacePrefix}Default"; - /// /// Prefix required by VS exporting/collection. /// @@ -28,9 +18,14 @@ internal static class TelemetryConstants public const string PropertyPrefix = "VS.MSBuild."; /// - /// For VS OpenTelemetry Collector to apply the correct privacy policy. + /// "Microsoft.Build.Telemetry.*" namespace is required by VS exporting/collection. /// - public const string VSMajorVersion = "18.0"; + public const string ActivitySourceNamespacePrefix = "Microsoft.Build.Telemetry"; + + /// + /// Namespace of the default ActivitySource handling e.g. End of build telemetry. + /// + public const string DefaultActivitySourceNamespace = $"{ActivitySourceNamespacePrefix}Default"; /// /// Sample rate for the default namespace. @@ -47,13 +42,9 @@ internal static class TelemetryConstants /// Name of the property for inner build duration. /// public const string InnerBuildDurationPropertyName = "InnerBuildDurationInMilliseconds"; -} -internal static class NodeTelemetryTags -{ - // These properties can't use nameof since they're not tied to a specific class property - public const string Tasks = "Tasks"; - public const string Targets = "Targets"; - public const string TargetsSummary = "TargetsSummary"; - public const string TasksSummary = "TasksSummary"; + /// + /// Name of the property for build activity. + /// + public const string Build = "Build"; } diff --git a/src/Framework/Telemetry/TelemetryDataUtils.cs b/src/Framework/Telemetry/TelemetryDataUtils.cs new file mode 100644 index 00000000000..b7202bd897b --- /dev/null +++ b/src/Framework/Telemetry/TelemetryDataUtils.cs @@ -0,0 +1,313 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Collections.Generic; +using System.Security.Cryptography; +using System.Text; +using static Microsoft.Build.Framework.Telemetry.BuildInsights; + +namespace Microsoft.Build.Framework.Telemetry +{ + internal static class TelemetryDataUtils + { + /// + /// Transforms collected telemetry data to format recognized by the telemetry infrastructure. + /// + /// Data about tasks and target forwarded from nodes. + /// Controls whether Task details should attached to the telemetry. + /// Controls whether Target details should be attached to the telemetry. + /// Node Telemetry data wrapped in a list of properties that can be attached as tags to a . + public static IActivityTelemetryDataHolder? AsActivityDataHolder(this IWorkerNodeTelemetryData? telemetryData, bool includeTasksDetails, bool includeTargetDetails) + { + if (telemetryData == null) + { + return null; + } + + var targetsSummary = new TargetsSummaryConverter(); + targetsSummary.Process(telemetryData.TargetsExecutionData); + + var tasksSummary = new TasksSummaryConverter(); + tasksSummary.Process(telemetryData.TasksExecutionData); + + var buildInsights = new BuildInsights( + includeTasksDetails ? GetTasksDetails(telemetryData.TasksExecutionData) : [], + includeTargetDetails ? GetTargetsDetails(telemetryData.TargetsExecutionData) : [], + GetTargetsSummary(targetsSummary), + GetTasksSummary(tasksSummary)); + + return new NodeTelemetry(buildInsights); + } + + /// + /// Converts targets details to a list of custom objects for telemetry. + /// + private static List GetTargetsDetails(Dictionary targetsDetails) + { + var result = new List(); + + foreach (KeyValuePair valuePair in targetsDetails) + { + string targetName = ShouldHashKey(valuePair.Key) ? GetHashed(valuePair.Key.Name) : valuePair.Key.Name; + + result.Add(new TargetDetailInfo( + targetName, + valuePair.Value, + valuePair.Key.IsCustom, + valuePair.Key.IsNuget, + valuePair.Key.IsMetaProj)); + } + + return result; + + static bool ShouldHashKey(TaskOrTargetTelemetryKey key) => key.IsCustom || key.IsMetaProj; + } + + internal record TargetDetailInfo(string Name, bool WasExecuted, bool IsCustom, bool IsNuget, bool IsMetaProj); + + /// + /// Converts tasks details to a list of custom objects for telemetry. + /// + private static List GetTasksDetails( + Dictionary tasksDetails) + { + var result = new List(); + + foreach (KeyValuePair valuePair in tasksDetails) + { + string taskName = valuePair.Key.IsCustom ? GetHashed(valuePair.Key.Name) : valuePair.Key.Name; + + result.Add(new TaskDetailInfo( + taskName, + valuePair.Value.CumulativeExecutionTime.TotalMilliseconds, + valuePair.Value.ExecutionsCount, + valuePair.Value.TotalMemoryBytes, + valuePair.Key.IsCustom, + valuePair.Key.IsNuget)); + } + + return result; + } + + /// + /// Depending on the platform, hash the value using an available mechanism. + /// + internal static string GetHashed(object value) => Sha256Hasher.Hash(value?.ToString() ?? ""); + + // https://github.com/dotnet/sdk/blob/8bd19a2390a6bba4aa80d1ac3b6c5385527cc311/src/Cli/Microsoft.DotNet.Cli.Utils/Sha256Hasher.cs + workaround for netstandard2.0 + private static class Sha256Hasher + { + /// + /// The hashed mac address needs to be the same hashed value as produced by the other distinct sources given the same input. (e.g. VsCode) + /// + public static string Hash(string text) + { + byte[] bytes = Encoding.UTF8.GetBytes(text); +#if NET + byte[] hash = SHA256.HashData(bytes); +#if NET9_0_OR_GREATER + return System.Convert.ToHexStringLower(hash); +#else + return Convert.ToHexString(hash).ToLowerInvariant(); +#endif + +#else + // Create the SHA256 object and compute the hash + using (var sha256 = SHA256.Create()) + { + byte[] hash = sha256.ComputeHash(bytes); + + // Convert the hash bytes to a lowercase hex string (manual loop approach) + var sb = new StringBuilder(hash.Length * 2); + foreach (byte b in hash) + { + sb.AppendFormat("{0:x2}", b); + } + + return sb.ToString(); + } +#endif + } + } + + internal record TaskDetailInfo(string Name, double TotalMilliseconds, int ExecutionsCount, long TotalMemoryBytes, bool IsCustom, bool IsNuget); + + /// + /// Converts targets summary to a custom object for telemetry. + /// + private static TargetsSummaryInfo GetTargetsSummary(TargetsSummaryConverter summary) + { + return new TargetsSummaryInfo( + CreateTargetStats(summary.LoadedBuiltinTargetInfo, summary.LoadedCustomTargetInfo), + CreateTargetStats(summary.ExecutedBuiltinTargetInfo, summary.ExecutedCustomTargetInfo)); + + static TargetStatsInfo CreateTargetStats( + TargetsSummaryConverter.TargetInfo builtinInfo, + TargetsSummaryConverter.TargetInfo customInfo) + { + var microsoft = builtinInfo.Total > 0 + ? new TargetCategoryInfo(builtinInfo.Total, builtinInfo.FromNuget, builtinInfo.FromMetaproj) + : null; + + var custom = customInfo.Total > 0 + ? new TargetCategoryInfo(customInfo.Total, customInfo.FromNuget, customInfo.FromMetaproj) + : null; + + return new TargetStatsInfo(builtinInfo.Total + customInfo.Total, microsoft, custom); + } + } + + internal record TargetsSummaryInfo(TargetStatsInfo Loaded, TargetStatsInfo Executed); + + internal record TargetStatsInfo(int Total, TargetCategoryInfo? Microsoft, TargetCategoryInfo? Custom); + + internal record TargetCategoryInfo(int Total, int FromNuget, int FromMetaproj); + + /// + /// Converts tasks summary to a custom object for telemetry. + /// + private static TasksSummaryInfo GetTasksSummary(TasksSummaryConverter summary) + { + var microsoft = CreateTaskStats(summary.BuiltinTasksInfo.Total, summary.BuiltinTasksInfo.FromNuget); + var custom = CreateTaskStats(summary.CustomTasksInfo.Total, summary.CustomTasksInfo.FromNuget); + + return new TasksSummaryInfo(microsoft, custom); + + static TaskCategoryStats? CreateTaskStats(TaskExecutionStats total, TaskExecutionStats fromNuget) + { + var totalStats = total.ExecutionsCount > 0 + ? new TaskStatsInfo( + total.ExecutionsCount, + total.CumulativeExecutionTime.TotalMilliseconds, + total.TotalMemoryBytes) + : null; + + var nugetStats = fromNuget.ExecutionsCount > 0 + ? new TaskStatsInfo( + fromNuget.ExecutionsCount, + fromNuget.CumulativeExecutionTime.TotalMilliseconds, + fromNuget.TotalMemoryBytes) + : null; + + return (totalStats != null || nugetStats != null) + ? new TaskCategoryStats(totalStats, nugetStats) + : null; + } + } + + private class TargetsSummaryConverter + { + internal TargetInfo LoadedBuiltinTargetInfo { get; } = new(); + + internal TargetInfo LoadedCustomTargetInfo { get; } = new(); + + internal TargetInfo ExecutedBuiltinTargetInfo { get; } = new(); + + internal TargetInfo ExecutedCustomTargetInfo { get; } = new(); + + /// + /// Processes target execution data to compile summary statistics for both built-in and custom targets. + /// + public void Process(Dictionary targetsExecutionData) + { + foreach (var kv in targetsExecutionData) + { + GetTargetInfo(kv.Key, isExecuted: false).Increment(kv.Key); + + // Update executed targets statistics (only if executed) + if (kv.Value) + { + GetTargetInfo(kv.Key, isExecuted: true).Increment(kv.Key); + } + } + } + + private TargetInfo GetTargetInfo(TaskOrTargetTelemetryKey key, bool isExecuted) => + (key.IsCustom, isExecuted) switch + { + (true, true) => ExecutedCustomTargetInfo, + (true, false) => LoadedCustomTargetInfo, + (false, true) => ExecutedBuiltinTargetInfo, + (false, false) => LoadedBuiltinTargetInfo, + }; + + internal class TargetInfo + { + public int Total { get; private set; } + + public int FromNuget { get; private set; } + + public int FromMetaproj { get; private set; } + + internal void Increment(TaskOrTargetTelemetryKey key) + { + Total++; + if (key.IsNuget) + { + FromNuget++; + } + + if (key.IsMetaProj) + { + FromMetaproj++; + } + } + } + } + + private class TasksSummaryConverter + { + internal TasksInfo BuiltinTasksInfo { get; } = new(); + + internal TasksInfo CustomTasksInfo { get; } = new(); + + /// + /// Processes task execution data to compile summary statistics for both built-in and custom tasks. + /// + public void Process(Dictionary tasksExecutionData) + { + foreach (KeyValuePair kv in tasksExecutionData) + { + var taskInfo = kv.Key.IsCustom ? CustomTasksInfo : BuiltinTasksInfo; + taskInfo.Total.Accumulate(kv.Value); + + if (kv.Key.IsNuget) + { + taskInfo.FromNuget.Accumulate(kv.Value); + } + } + } + + internal class TasksInfo + { + public TaskExecutionStats Total { get; } = TaskExecutionStats.CreateEmpty(); + + public TaskExecutionStats FromNuget { get; } = TaskExecutionStats.CreateEmpty(); + } + } + + private sealed class NodeTelemetry(BuildInsights insights) : IActivityTelemetryDataHolder + { + Dictionary IActivityTelemetryDataHolder.GetActivityProperties() + { + Dictionary properties = new() + { + [nameof(BuildInsights.TargetsSummary)] = insights.TargetsSummary, + [nameof(BuildInsights.TasksSummary)] = insights.TasksSummary, + }; + + if (insights.Targets.Count > 0) + { + properties[nameof(BuildInsights.Targets)] = insights.Targets; + } + + if (insights.Tasks.Count > 0) + { + properties[nameof(BuildInsights.Tasks)] = insights.Tasks; + } + + return properties; + } + } + } +} diff --git a/src/Framework/Telemetry/TelemetryItem.cs b/src/Framework/Telemetry/TelemetryItem.cs deleted file mode 100644 index f037d7ddbea..00000000000 --- a/src/Framework/Telemetry/TelemetryItem.cs +++ /dev/null @@ -1,6 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -namespace Microsoft.Build.Framework.Telemetry; - -internal record TelemetryItem(string Name, object Value, bool NeedsHashing); diff --git a/src/Framework/Telemetry/TelemetryManager.cs b/src/Framework/Telemetry/TelemetryManager.cs new file mode 100644 index 00000000000..4b55507436b --- /dev/null +++ b/src/Framework/Telemetry/TelemetryManager.cs @@ -0,0 +1,195 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#if NETFRAMEWORK +using Microsoft.VisualStudio.Telemetry; +#endif + +using System; +using System.IO; +using System.Runtime.CompilerServices; + +namespace Microsoft.Build.Framework.Telemetry +{ + /// + /// Manages telemetry collection and reporting for MSBuild. + /// This class provides a centralized way to initialize, configure, and manage telemetry sessions. + /// + /// + /// The TelemetryManager is a singleton that handles both standalone and integrated telemetry scenarios. + /// On .NET Framework, it integrates with Visual Studio telemetry services. + /// On .NET Core it provides a lightweight telemetry implementation through exposing an activity source. + /// + internal class TelemetryManager + { + /// + /// Lock object for thread-safe initialization and disposal. + /// + private static readonly LockType s_lock = new(); + + private static bool s_initialized; + private static bool s_disposed; + + private TelemetryManager() + { + } + + /// + /// Optional activity source for MSBuild or other telemetry usage. + /// + public MSBuildActivitySource? DefaultActivitySource { get; private set; } + + public static TelemetryManager Instance { get; } = new TelemetryManager(); + + /// + /// Initializes the telemetry manager with the specified configuration. + /// + /// + /// Indicates whether MSBuild is running in standalone mode (e.g., MSBuild.exe directly invoked) + /// versus integrated mode (e.g., running within Visual Studio or dotnet CLI). + /// When true, creates and manages its own telemetry session on .NET Framework. + /// + [MethodImpl(MethodImplOptions.NoInlining)] + public void Initialize(bool isStandalone) + { + lock (s_lock) + { + if (s_initialized) + { + return; + } + + s_initialized = true; + + if (IsOptOut()) + { + return; + } + + TryInitializeTelemetry(isStandalone); + } + } + + /// + /// Resets the TelemetryManager state for TESTING purposes. + /// + internal static void ResetForTest() + { + lock (s_lock) + { + s_initialized = false; + s_disposed = false; + Instance.DefaultActivitySource = null; + } + } + + /// + /// Initializes MSBuild telemetry. + /// This method is deliberately not inlined to ensure + /// the Telemetry related assemblies are only loaded when this method is called, + /// allowing the calling code to catch assembly loading exceptions. + /// + [MethodImpl(MethodImplOptions.NoInlining)] + private void TryInitializeTelemetry(bool isStandalone) + { + try + { +#if NETFRAMEWORK + DefaultActivitySource = VsTelemetryInitializer.Initialize(isStandalone); +#else + DefaultActivitySource = new MSBuildActivitySource(TelemetryConstants.DefaultActivitySourceNamespace); +#endif + } + catch (Exception ex) when (ex is FileNotFoundException or FileLoadException or TypeLoadException) + { + // Microsoft.VisualStudio.Telemetry or System.Diagnostics.DiagnosticSource might not be available outside of VS or dotnet. + // This is expected in standalone application scenarios (when MSBuild.exe is invoked directly). + DefaultActivitySource = null; + } + } + + public void Dispose() + { + lock (s_lock) + { + if (s_disposed) + { + return; + } + +#if NETFRAMEWORK + try + { + DisposeVsTelemetry(); + } + catch (Exception ex) when ( + ex is FileNotFoundException or + FileLoadException or + TypeLoadException) + { + // Assembly was never loaded, nothing to dispose. + } +#endif + s_disposed = true; + } + } + + /// + /// Determines if the user has explicitly opted out of telemetry. + /// + internal static bool IsOptOut() => +#if NETFRAMEWORK + Traits.Instance.FrameworkTelemetryOptOut; +#else + Traits.Instance.SdkTelemetryOptOut; +#endif + +#if NETFRAMEWORK + [MethodImpl(MethodImplOptions.NoInlining)] + private static void DisposeVsTelemetry() => VsTelemetryInitializer.Dispose(); +#endif + } + +#if NETFRAMEWORK + internal static class VsTelemetryInitializer + { + // Telemetry API key for Visual Studio telemetry service. + private const string CollectorApiKey = "f3e86b4023cc43f0be495508d51f588a-f70d0e59-0fb0-4473-9f19-b4024cc340be-7296"; + + // Store as object to avoid type reference at class load time + private static object? s_telemetrySession; + private static bool s_ownsSession = false; + + [MethodImpl(MethodImplOptions.NoInlining)] + public static MSBuildActivitySource Initialize(bool isStandalone) + { + TelemetrySession session; + if (isStandalone) + { + session = TelemetryService.CreateAndGetDefaultSession(CollectorApiKey); + TelemetryService.DefaultSession.UseVsIsOptedIn(); + TelemetryService.DefaultSession.Start(); + s_ownsSession = true; + } + else + { + session = TelemetryService.DefaultSession; + } + + s_telemetrySession = session; + return new MSBuildActivitySource(session); + } + + [MethodImpl(MethodImplOptions.NoInlining)] + public static void Dispose() + { + if (s_ownsSession && s_telemetrySession is TelemetrySession session) + { + session.Dispose(); + } + + s_telemetrySession = null; + } + } +#endif +} diff --git a/src/Framework/Telemetry/VSTelemetryActivity.cs b/src/Framework/Telemetry/VSTelemetryActivity.cs new file mode 100644 index 00000000000..f9f21374d1b --- /dev/null +++ b/src/Framework/Telemetry/VSTelemetryActivity.cs @@ -0,0 +1,66 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#if NETFRAMEWORK + +using System.Collections.Generic; +using Microsoft.VisualStudio.Telemetry; + +namespace Microsoft.Build.Framework.Telemetry +{ + /// + /// Represents a Visual Studio telemetry activity that wraps a . + /// This class provides an implementation of for the VS Telemetry system, + /// allowing telemetry data to be collected and sent when running on .NET Framework. + /// + internal class VsTelemetryActivity : IActivity + { + private readonly TelemetryScope _scope; + private TelemetryResult _result = TelemetryResult.Success; + + private bool _disposed; + + public VsTelemetryActivity(TelemetryScope scope) + { + _scope = scope; + } + + public IActivity? SetTags(IActivityTelemetryDataHolder? dataHolder) + { + Dictionary? tags = dataHolder?.GetActivityProperties(); + + if (tags != null) + { + foreach (KeyValuePair tag in tags) + { + _ = SetTag(tag.Key, tag.Value); + } + } + + return this; + } + + public IActivity? SetTag(string key, object? value) + { + if (value != null) + { + _scope.EndEvent.Properties[$"{TelemetryConstants.PropertyPrefix}{key}"] = new TelemetryComplexProperty(value); + } + + return this; + } + + public void Dispose() + { + if (_disposed) + { + return; + } + + _scope.End(_result); + _disposed = true; + } + } +} + +#endif diff --git a/src/Framework/Traits.cs b/src/Framework/Traits.cs index 8cbf21feef1..d02e95ce944 100644 --- a/src/Framework/Traits.cs +++ b/src/Framework/Traits.cs @@ -154,14 +154,12 @@ public Traits() /// public bool SdkTelemetryOptOut = IsEnvVarOneOrTrue("DOTNET_CLI_TELEMETRY_OPTOUT"); public bool FrameworkTelemetryOptOut = IsEnvVarOneOrTrue("MSBUILD_TELEMETRY_OPTOUT"); - public double? TelemetrySampleRateOverride = ParseDoubleFromEnvironmentVariable("MSBUILD_TELEMETRY_SAMPLE_RATE"); public bool ExcludeTasksDetailsFromTelemetry = IsEnvVarOneOrTrue("MSBUILDTELEMETRYEXCLUDETASKSDETAILS"); public bool FlushNodesTelemetryIntoConsole = IsEnvVarOneOrTrue("MSBUILDFLUSHNODESTELEMETRYINTOCONSOLE"); public bool EnableTargetOutputLogging = IsEnvVarOneOrTrue("MSBUILDTARGETOUTPUTLOGGING"); // for VS17.14 - public readonly bool TelemetryOptIn = IsEnvVarOneOrTrue("MSBUILD_TELEMETRY_OPTIN"); public readonly bool SlnParsingWithSolutionPersistenceOptIn = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("MSBUILD_PARSE_SLN_WITH_SOLUTIONPERSISTENCE")); public static void UpdateFromEnvironment() @@ -180,19 +178,6 @@ private static int ParseIntFromEnvironmentVariableOrDefault(string environmentVa : defaultValue; } - /// - /// Parse a double from an environment variable with invariant culture. - /// - private static double? ParseDoubleFromEnvironmentVariable(string environmentVariable) - { - return double.TryParse(Environment.GetEnvironmentVariable(environmentVariable), - NumberStyles.Float, - CultureInfo.InvariantCulture, - out double result) - ? result - : null; - } - internal static bool IsEnvVarOneOrTrue(string name) { string? value = Environment.GetEnvironmentVariable(name); diff --git a/src/MSBuild/XMake.cs b/src/MSBuild/XMake.cs index 0bc9bd7aafd..b5ad7405d7e 100644 --- a/src/MSBuild/XMake.cs +++ b/src/MSBuild/XMake.cs @@ -248,9 +248,9 @@ string[] args DebuggerLaunchCheck(); // Initialize new build telemetry and record start of this build. - KnownTelemetry.PartialBuildTelemetry = new BuildTelemetry { StartAt = DateTime.UtcNow }; - // Initialize OpenTelemetry infrastructure - OpenTelemetryManager.Instance.Initialize(isStandalone: true); + KnownTelemetry.PartialBuildTelemetry = new BuildTelemetry { StartAt = DateTime.UtcNow, IsStandaloneExecution = true }; + + TelemetryManager.Instance?.Initialize(isStandalone: true); using PerformanceLogEventListener eventListener = PerformanceLogEventListener.Create(); @@ -298,12 +298,12 @@ string[] args { DumpCounters(false /* log to console */); } - OpenTelemetryManager.Instance.Shutdown(); + + TelemetryManager.Instance?.Dispose(); return exitCode; } - /// /// Returns true if arguments allows or make sense to leverage msbuild server. /// diff --git a/src/MSBuild/app.amd64.config b/src/MSBuild/app.amd64.config index 9bf8b014e38..00194107526 100644 --- a/src/MSBuild/app.amd64.config +++ b/src/MSBuild/app.amd64.config @@ -57,16 +57,18 @@ - - + + - - + + + - - + + + @@ -104,90 +106,10 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/MSBuild/app.config b/src/MSBuild/app.config index 9c41d0b862c..6f2cba28e6c 100644 --- a/src/MSBuild/app.config +++ b/src/MSBuild/app.config @@ -39,10 +39,6 @@ - - - - @@ -72,10 +68,6 @@ - - - - diff --git a/src/Package/MSBuild.VSSetup/files.swr b/src/Package/MSBuild.VSSetup/files.swr index 3b75caa7fb1..4e091c37e8e 100644 --- a/src/Package/MSBuild.VSSetup/files.swr +++ b/src/Package/MSBuild.VSSetup/files.swr @@ -41,7 +41,6 @@ folder InstallDir:\MSBuild\Current\Bin file source=$(X86BinPath)Microsoft.VisualStudio.SolutionPersistence.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 file source=$(X86BinPath)RuntimeContracts.dll file source=$(X86BinPath)System.Buffers.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=2 - file source=$(X86BinPath)System.Diagnostics.DiagnosticSource.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 file source=$(X86BinPath)System.Formats.Nrbf.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=2 file source=$(X86BinPath)System.IO.Pipelines.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=2 file source=$(X86BinPath)System.Memory.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=2 @@ -89,24 +88,7 @@ folder InstallDir:\MSBuild\Current\Bin file source=$(X86BinPath)Microsoft.ServiceModel.targets file source=$(X86BinPath)Microsoft.WinFx.targets file source=$(X86BinPath)Microsoft.WorkflowBuildExtensions.targets - file source=$(X86BinPath)Microsoft.VisualStudio.OpenTelemetry.ClientExtensions.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.VisualStudio.OpenTelemetry.Collector.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 file source=$(X86BinPath)Microsoft.VisualStudio.Utilities.Internal.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)OpenTelemetry.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)OpenTelemetry.Api.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)OpenTelemetry.Api.ProviderBuilderExtensions.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Configuration.Abstractions.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Configuration.Binder.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Configuration.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.DependencyInjection.Abstractions.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.DependencyInjection.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Logging.Abstractions.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Logging.Configuration.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Logging.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Options.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Options.ConfigurationExtensions.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Primitives.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 - file source=$(X86BinPath)Microsoft.Extensions.Diagnostics.Abstractions.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=3 file source=$(X86BinPath)Newtonsoft.Json.dll vs.file.ngenApplications="[installDir]\MSBuild\Current\Bin\amd64\MSBuild.exe" vs.file.ngenArchitecture=all vs.file.ngenPriority=2 folder InstallDir:\MSBuild\Current\Bin\MSBuild diff --git a/src/Package/Microsoft.Build.UnGAC/Program.cs b/src/Package/Microsoft.Build.UnGAC/Program.cs index a13f518146d..d686da3dc75 100644 --- a/src/Package/Microsoft.Build.UnGAC/Program.cs +++ b/src/Package/Microsoft.Build.UnGAC/Program.cs @@ -32,8 +32,6 @@ private static void Main(string[] args) "BuildXL.Utilities.Core, Version=1.0.0.0", "BuildXL.Native, Version=1.0.0.0", "Microsoft.VisualStudio.SolutionPersistence, Version=1.0.0.0", - "Microsoft.VisualStudio.OpenTelemetry.ClientExtensions, Version=0.1.0.0", - "Microsoft.VisualStudio.OpenTelemetry.Collector, Version=0.1.0.0", }; uint hresult = NativeMethods.CreateAssemblyCache(out IAssemblyCache assemblyCache, 0); From b8e744f5f3d380b6666d5729bb1ac3b65c984c76 Mon Sep 17 00:00:00 2001 From: dotnet bot Date: Wed, 7 Jan 2026 02:34:48 -0800 Subject: [PATCH 09/39] Localized file check-in by OneLocBuild Task: Build definition ID 9434: Build ID 13050856 (#12982) This is the pull request automatically created by the OneLocBuild task in the build process to check-in localized files generated based upon translation source files (.lcl files) handed-back from the downstream localization pipeline. If there are issues in translations, visit https://aka.ms/icxLocBug and log bugs for fixes. The OneLocBuild wiki is https://aka.ms/onelocbuild and the localization process in general is documented at https://aka.ms/AllAboutLoc. --- src/Build/Resources/xlf/Strings.cs.xlf | 4 ++-- src/Build/Resources/xlf/Strings.es.xlf | 4 ++-- src/Build/Resources/xlf/Strings.it.xlf | 4 ++-- src/Build/Resources/xlf/Strings.ja.xlf | 4 ++-- src/Build/Resources/xlf/Strings.ko.xlf | 4 ++-- src/Build/Resources/xlf/Strings.pl.xlf | 4 ++-- src/Build/Resources/xlf/Strings.pt-BR.xlf | 4 ++-- src/Build/Resources/xlf/Strings.ru.xlf | 4 ++-- src/Build/Resources/xlf/Strings.tr.xlf | 4 ++-- src/Build/Resources/xlf/Strings.zh-Hans.xlf | 4 ++-- src/Build/Resources/xlf/Strings.zh-Hant.xlf | 4 ++-- 11 files changed, 22 insertions(+), 22 deletions(-) diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index 63c5e33025a..ff718145e90 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -903,12 +903,12 @@ Chyby: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + Sada SDK se pokusila nastavit proměnnou prostředí {0} na {1}, která ale již byla nastavena na „{2}“ jako proměnná prostředí. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + Sada SDK se pokusila nastavit proměnnou prostředí „{0}“ na „{1}“, která ale už byla nastavena jinou sadou SDK na „{2}“. diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index 3e9c155cea7..83da74d37bd 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -903,12 +903,12 @@ Errores: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + Un SDK intentó establecer la variable de entorno "{0}" en "{1}", pero ya estaba establecida en "{2}" como variable de entorno. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + Un SDK intentó establecer la variable de entorno "{0}" en "{1}", pero otro SDK ya la estableció en "{2}". diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index 5a589fa568b..6b3e3262a52 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -903,12 +903,12 @@ Errori: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + Un SDK ha tentato di impostare la variabile di ambiente "{0}" su "{1}" ma era già stata impostata su "{2}" come variabile di ambiente. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + Un SDK ha tentato di impostare la variabile di ambiente "{0}" su "{1}" ma era già stata impostata su "{2}" da un altro SDK. diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index 3ba522678a6..94bcb18f1bc 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -903,12 +903,12 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + SDK は環境変数 "{0}" を "{1}" に設定しようとしましたが、それは既に環境変数として {2} に設定されていました。 An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK は環境変数 "{0}" を "{1}" に設定しようとしましたが、それは既に別の SDK によって {2} に設定されていました。 diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index e7d00c351da..f4d22bba8bf 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -903,12 +903,12 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + SDK가 환경 변수 "{0}"을(를) "{1}"(으)로 설정하려고 했지만 이미 환경 변수로 "{2}"(으)로 설정되어 있었습니다. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK가 환경 변수 "{0}"을(를) "{1}"(으)로 설정하려고 했지만 이미 다른 SDK에 의해 "{2}"(으)로 설정되어 있었습니다. diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index e0df1be2942..7c3e380b213 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -903,12 +903,12 @@ Błędy: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + Zestaw SDK próbował ustawić zmienną środowiskową „{0}” na „{1}”, ale została już ustawiona na wartość „{2}” jako zmienna środowiskowa. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + Zestaw SDK próbował ustawić zmienną środowiskową „{0}” na „{1}”, ale została już ustawiona na wartość „{2}” przez inny zestaw SDK. diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index 081e761e83c..4f78d016570 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -903,12 +903,12 @@ Erros: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + Um SDK tentou definir a variável de ambiente "{0}" como "{1}", mas ela já havia sido definida como "{2}" como uma variável de ambiente. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + Um SDK tentou definir a variável de ambiente "{0}" como "{1}", mas ela já havia sido definida como "{2}" por outro SDK. diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index b859753c3c8..991a56d8c3c 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -903,12 +903,12 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + Пакет SDK попытался настроить для переменной среды "{0}" значение "{1}", но для нее уже было настроено значение "{2}" в качестве переменной среды. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + Пакет SDK попытался настроить для переменной среды "{0}" значение "{1}", но для нее уже было настроено значение "{2}" другим пакетом SDK. diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index 4e5bc849ce9..536de415c1a 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -903,12 +903,12 @@ Hatalar: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + Bir SDK "{0}" ortam değişkenini "{1}" olarak ayarlamaya çalıştı ancak bu değişken zaten bir ortam değişkeni olarak "{2}" değerine ayarlanmıştı. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + Bir SDK "{0}" ortam değişkenini "{1}" olarak ayarlamaya çalıştı ancak bu değişken zaten başka bir SDK tarafından "{2}" olarak ayarlanmıştı. diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index 0412e4b9a83..27d8a4d45dd 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -903,12 +903,12 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + SDK 尝试将环境变量 "{0}" 设置为 "{1}"，但它已作为环境变量设置为 "{2}"。 An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK 尝试将环境变量 "{0}" 设置为 "{1}"，但它已由另一个 SDK 设置为 "{2}"。 diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index 5d951c0a935..ce1875a9b4a 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -903,12 +903,12 @@ Errors: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + SDK 嘗試將環境變數 "{0}" 設定為 "{1}"，但該變數已設定為 "{2}" 做為環境變數。 An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + SDK 嘗試將環境變數 "{0}" 設定為 "{1}"，但該變數已由另一個 SDK 設定為 "{2}"。 From bddfab6585ab9a44d03dd7a90b4bad296435b635 Mon Sep 17 00:00:00 2001 From: "dotnet-maestro[bot]" <42748379+dotnet-maestro[bot]@users.noreply.github.com> Date: Wed, 7 Jan 2026 11:35:19 +0100 Subject: [PATCH 10/39] [main] Source code updates from dotnet/dotnet (#12979) > [!NOTE] > This is a codeflow update. It may contain both source code changes from > [the VMR](https://github.com/dotnet/dotnet) > as well as dependency updates. Learn more [here](https://github.com/dotnet/dotnet/tree/main/docs/Codeflow-PRs.md). This pull request brings the following source code changes [marker]: <> (Begin:91fa59f1-1864-46b1-b482-87955691317c) ## From https://github.com/dotnet/dotnet - **Subscription**: [91fa59f1-1864-46b1-b482-87955691317c](https://maestro.dot.net/subscriptions?search=91fa59f1-1864-46b1-b482-87955691317c) - **Build**: [20260105.2](https://dev.azure.com/dnceng/internal/_build/results?buildId=2872392) ([296040](https://maestro.dot.net/channel/8298/github:dotnet:dotnet/build/296040)) - **Date Produced**: January 6, 2026 12:20:56 AM UTC - **Commit**: [fb2e783fa530d337a56ef5c528a2807b7d63e46d](https://github.com/dotnet/dotnet/commit/fb2e783fa530d337a56ef5c528a2807b7d63e46d) - **Commit Diff**: [5a69737...fb2e783](https://github.com/dotnet/dotnet/compare/5a69737e6f6447fe397d552503a3909ea49f6f34...fb2e783fa530d337a56ef5c528a2807b7d63e46d) - **Branch**: [main](https://github.com/dotnet/dotnet/tree/main) [marker]: <> (End:91fa59f1-1864-46b1-b482-87955691317c) [marker]: <> (Start:Footer:CodeFlow PR) ## Associated changes in source repos - https://github.com/dotnet/arcade/compare/1c09acb26525da819530dd2678a0b7f62c35cbfd...47a8a69721dfea57b82121ac1458d2f5bba6abd2 - https://github.com/dotnet/aspnetcore/compare/70d851104f739fb906aabcd6a07c0935ce2549c9...1b7269e1ec8b0b1103a3d2dffaa400aea347bf39 - https://github.com/dotnet/deployment-tools/compare/56c3d96916e1b2bb065732ffedd6b9e0285a6ed4...6ebef72019b85958ae78d0da73ea49a161c7a28a - https://github.com/dotnet/efcore/compare/9a868352299586a7e23b736d945f2931b1e822bf...5a68c09c2c67b7f410f0972b193b42d5502367a7 - https://github.com/dotnet/emsdk/compare/f8b85873c9157f00b4951a78977fa87e3ab7c628...36e24b2207d929b79bb48c9429e8b797bd78e467 - https://github.com/dotnet/fsharp/compare/36868180d30ec3a74659d71fb183897807d60f81...6396a18a707b29f552373b8ff5650c98beb9bcfc - https://github.com/dotnet/msbuild/compare/228caa11ad0046ccb599530abd9aba4e1979b5e9...9263fe6534ccb8eec416ae83815d5566ffeaea3b - https://github.com/nuget/nuget.client/compare/56f4657d7585ec12b61c623756ca4b2b810c4863...cc8f616db8da1c2feb052c2d7eb5cd73071da290 - https://github.com/dotnet/roslyn/compare/a01d6a0838430706cea74ad38e054c2877ffbfa1...bf35fe58e593ac0ac74c05bfa6e4719b85772da0 - https://github.com/dotnet/runtime/compare/8eb90a6dba628a6fbdc470277e64e4b9aa72994f...bce6119e41ecfbcf630c369836770669604c22c6 - https://github.com/dotnet/sdk/compare/65384c6536d6c6f6afa9c13dc023b1848f0ef69e...ec5f7d915a8597baba3dbf1ef3ece19accb4541b - https://github.com/dotnet/source-build-reference-packages/compare/d6738f130736917696d71ad88a7cadeb0a4f9086...a6113e0d389522d2f601b894340b30336441c82a - https://github.com/dotnet/sourcelink/compare/c84e22bedd248cae51c24bdef5cf4022409fc671...d656e7bc73c28d039e6baf6d591c905ea8b76ee1 - https://github.com/dotnet/templating/compare/41ef93aacf72633b58372a9841d8940f6d87ae26...413680c51cc58fd29655bacf2a080bd0efe0db21 - https://github.com/microsoft/vstest/compare/154e8babf0b97312a403b6ccf84cf1498a32ecea...bbee830b0ef18eb5b4aa5daee65ae35a34f8c132 - https://github.com/dotnet/winforms/compare/1a8c138be340d80c7e288e044e8a80b7f4adeb1b...01eefd447bf1de58c82bcd765bf85d1d7fb4e7ac - https://github.com/dotnet/wpf/compare/6e486f4f1e48f2729f707f2b93d915214a7d6f6e...37b9597bebaf48196a05f6d6212ec1e9bc24352f
Diff the source with this PR branch ```bash darc vmr diff --name-only https://github.com/dotnet/dotnet:fb2e783fa530d337a56ef5c528a2807b7d63e46d..https://github.com/dotnet/msbuild:darc-main-2911e53d-2584-4f82-bc52-e50ddaf06f9c ```
[marker]: <> (End:Footer:CodeFlow PR) --------- Co-authored-by: dotnet-maestro[bot] --- .editorconfig | 6 ++++++ NuGet.config | 8 ++++++++ eng/Version.Details.xml | 2 +- 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index 99c82a0c47f..24cb45298a2 100644 --- a/.editorconfig +++ b/.editorconfig @@ -415,6 +415,12 @@ dotnet_diagnostic.IDE0301.severity = suggestion dotnet_diagnostic.IDE0305.severity = suggestion dotnet_diagnostic.IDE0306.severity = suggestion +# Remove unnecessary nullable warning suppression +dotnet_diagnostic.IDE0370.severity = suggestion + +# Remove unnecessary 'unsafe' modifier +dotnet_diagnostic.IDE0380.severity = suggestion + # Temporarily disable SA1010 "Opening square brackets should not be preceded by a space" until https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3687 is fixed dotnet_diagnostic.SA1010.severity = none diff --git a/NuGet.config b/NuGet.config index 764f9c8ddaa..45c16d21697 100644 --- a/NuGet.config +++ b/NuGet.config @@ -16,6 +16,8 @@ + + @@ -49,6 +51,12 @@ + + + + + + diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml index 1508f78d1ec..421bb049256 100644 --- a/eng/Version.Details.xml +++ b/eng/Version.Details.xml @@ -1,6 +1,6 @@ - + From a8434cbcec3466929024b5845d138bd803158b2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Provazn=C3=ADk?= Date: Wed, 7 Jan 2026 16:46:01 +0100 Subject: [PATCH 11/39] eliminate test data serialization warnings (#12983) this pollutes context for agents running tests on cli --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com> --- .../Construction/ConstructionEditing_Tests.cs | 4 ++-- .../Definition/DefinitionEditing_Tests.cs | 22 +++++++++---------- .../Definition/ProjectItem_Tests.cs | 2 +- .../Definition/Project_Tests.cs | 4 ++-- .../Graph/GraphLoadedFromSolution_tests.cs | 2 +- .../Graph/IsolateProjects_Tests.cs | 2 +- .../Graph/ProjectGraph_Tests.cs | 10 ++++----- .../Graph/ResultCacheBasedBuilds_Tests.cs | 2 +- src/Shared/UnitTests/FileMatcher_Tests.cs | 2 +- .../InterningTestData.cs | 22 +++++++++++++++++-- 10 files changed, 45 insertions(+), 27 deletions(-) diff --git a/src/Build.OM.UnitTests/Construction/ConstructionEditing_Tests.cs b/src/Build.OM.UnitTests/Construction/ConstructionEditing_Tests.cs index aaa2c454210..81874f5afd2 100644 --- a/src/Build.OM.UnitTests/Construction/ConstructionEditing_Tests.cs +++ b/src/Build.OM.UnitTests/Construction/ConstructionEditing_Tests.cs @@ -869,7 +869,7 @@ public static IEnumerable InsertMetadataElementAfterSiblingsTestData } [Theory] - [MemberData(nameof(InsertMetadataElementAfterSiblingsTestData))] + [MemberData(nameof(InsertMetadataElementAfterSiblingsTestData), DisableDiscoveryEnumeration = true)] public void InsertMetadataElementAfterSiblings(AddMetadata addMetadata, int position, string expectedItem) { Action act = (i, c, r) => { i.InsertAfterChild(c, r); }; @@ -911,7 +911,7 @@ public static IEnumerable InsertMetadataElementBeforeSiblingsTestData } [Theory] - [MemberData(nameof(InsertMetadataElementBeforeSiblingsTestData))] + [MemberData(nameof(InsertMetadataElementBeforeSiblingsTestData), DisableDiscoveryEnumeration = true)] public void InsertMetadataElementBeforeSiblings(AddMetadata addMetadata, int position, string expectedItem) { Action act = (i, c, r) => { i.InsertBeforeChild(c, r); }; diff --git a/src/Build.OM.UnitTests/Definition/DefinitionEditing_Tests.cs b/src/Build.OM.UnitTests/Definition/DefinitionEditing_Tests.cs index 6708096bd7e..2c046dd3f87 100644 --- a/src/Build.OM.UnitTests/Definition/DefinitionEditing_Tests.cs +++ b/src/Build.OM.UnitTests/Definition/DefinitionEditing_Tests.cs @@ -1151,8 +1151,8 @@ public void RenameItem_StillMatchesWildcard() } [Theory] - [MemberData(nameof(ItemElementsThatRequireSplitting))] - [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting))] + [MemberData(nameof(ItemElementsThatRequireSplitting), DisableDiscoveryEnumeration = true)] + [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting), DisableDiscoveryEnumeration = true)] public void RenameThrowsWhenItemElementSplittingIsDisabled(string projectContents, int itemIndex, SetupProject setupProject) { AssertDisabledItemSplitting(projectContents, itemIndex, setupProject, (p, i) => { i.Rename("foo"); }); @@ -1284,8 +1284,8 @@ public void ChangeItemTypeOnItemNeedingSplitting() } [Theory] - [MemberData(nameof(ItemElementsThatRequireSplitting))] - [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting))] + [MemberData(nameof(ItemElementsThatRequireSplitting), DisableDiscoveryEnumeration = true)] + [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting), DisableDiscoveryEnumeration = true)] public void ChangeItemTypeThrowsWhenItemElementSplittingIsDisabled(string projectContents, int itemIndex, SetupProject setupProject) { AssertDisabledItemSplitting(projectContents, itemIndex, setupProject, (p, i) => { i.ItemType = "foo"; }); @@ -1446,16 +1446,16 @@ public void RemoveItem_IncludingFromIgnoringConditionList() } [Theory] - [MemberData(nameof(ItemElementsThatRequireSplitting))] - [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting))] + [MemberData(nameof(ItemElementsThatRequireSplitting), DisableDiscoveryEnumeration = true)] + [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting), DisableDiscoveryEnumeration = true)] public void RemoveItemThrowsWhenItemElementSplittingIsDisabled(string projectContents, int itemIndex, SetupProject setupProject) { AssertDisabledItemSplitting(projectContents, itemIndex, setupProject, (p, i) => { p.RemoveItem(i); }); } [Theory] - [MemberData(nameof(ItemElementsThatRequireSplitting))] - [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting))] + [MemberData(nameof(ItemElementsThatRequireSplitting), DisableDiscoveryEnumeration = true)] + [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting), DisableDiscoveryEnumeration = true)] public void RemoveItemsThrowsWhenItemElementSplittingIsDisabled(string projectContents, int itemIndex, SetupProject setupProject) { AssertDisabledItemSplitting(projectContents, itemIndex, setupProject, (p, i) => { p.RemoveItems(new[] { i }); }); @@ -1654,7 +1654,7 @@ public void RemoveMetadataAfterItemRemoved() } [Theory] - [MemberData(nameof(ItemElementsThatRequireSplitting))] + [MemberData(nameof(ItemElementsThatRequireSplitting), DisableDiscoveryEnumeration = true)] public void RemoveMetadataThrowsWhenItemElementSplittingIsDisabled(string projectContents, int itemIndex, SetupProject setupProject) { AssertDisabledItemSplitting(projectContents, itemIndex, setupProject, (p, i) => { i.RemoveMetadata("bar"); }, "bar"); @@ -1743,8 +1743,8 @@ public void SetMetadatumAfterRemoved3() } [Theory] - [MemberData(nameof(ItemElementsThatRequireSplitting))] - [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting))] + [MemberData(nameof(ItemElementsThatRequireSplitting), DisableDiscoveryEnumeration = true)] + [MemberData(nameof(ItemElementsWithGlobsThatRequireSplitting), DisableDiscoveryEnumeration = true)] public void SetMetadataThrowsWhenItemElementSplittingIsDisabled(string projectContents, int itemIndex, SetupProject setupProject) { AssertDisabledItemSplitting(projectContents, itemIndex, setupProject, (p, i) => { i.SetMetadataValue("foo", "bar"); }); diff --git a/src/Build.OM.UnitTests/Definition/ProjectItem_Tests.cs b/src/Build.OM.UnitTests/Definition/ProjectItem_Tests.cs index 75b2e82319d..600f24ad21e 100644 --- a/src/Build.OM.UnitTests/Definition/ProjectItem_Tests.cs +++ b/src/Build.OM.UnitTests/Definition/ProjectItem_Tests.cs @@ -3625,7 +3625,7 @@ public static IEnumerable UpdateAndRemoveShouldWorkWithEscapedCharacte } [Theory] - [MemberData(nameof(UpdateAndRemoveShouldWorkWithEscapedCharactersTestData))] + [MemberData(nameof(UpdateAndRemoveShouldWorkWithEscapedCharactersTestData), DisableDiscoveryEnumeration = true)] public void UpdateAndRemoveShouldWorkWithEscapedCharacters(string projectContents, string include, string update, string remove, string[] expectedInclude, Dictionary[] expectedMetadata) { var formattedProjectContents = string.Format(projectContents, include, update, remove); diff --git a/src/Build.OM.UnitTests/Definition/Project_Tests.cs b/src/Build.OM.UnitTests/Definition/Project_Tests.cs index ca0fc1cde72..d1e43441816 100644 --- a/src/Build.OM.UnitTests/Definition/Project_Tests.cs +++ b/src/Build.OM.UnitTests/Definition/Project_Tests.cs @@ -3065,7 +3065,7 @@ public static IEnumerable GetItemProvenanceByProjectItemTestData } [Theory] - [MemberData(nameof(GetItemProvenanceByProjectItemTestData))] + [MemberData(nameof(GetItemProvenanceByProjectItemTestData), DisableDiscoveryEnumeration = true)] public void GetItemProvenanceByProjectItem(string items, string itemValue, int itemPosition, ProvenanceResultTupleList expected) { var formattedProject = string.Format(ProjectWithItemGroup, items); @@ -3486,7 +3486,7 @@ public static IEnumerable GetItemProvenanceShouldWorkWithEscapedCharac } } [Theory] - [MemberData(nameof(GetItemProvenanceShouldWorkWithEscapedCharactersTestData))] + [MemberData(nameof(GetItemProvenanceShouldWorkWithEscapedCharactersTestData), DisableDiscoveryEnumeration = true)] public void GetItemProvenanceShouldWorkWithEscapedCharacters(string project, string provenanceArgument, ProvenanceResultTupleList expectedProvenance) { AssertProvenanceResult(expectedProvenance, project, provenanceArgument); diff --git a/src/Build.UnitTests/Graph/GraphLoadedFromSolution_tests.cs b/src/Build.UnitTests/Graph/GraphLoadedFromSolution_tests.cs index bcf72ce632a..77e4ffded51 100644 --- a/src/Build.UnitTests/Graph/GraphLoadedFromSolution_tests.cs +++ b/src/Build.UnitTests/Graph/GraphLoadedFromSolution_tests.cs @@ -476,7 +476,7 @@ public static IEnumerable SolutionOnlyDependenciesData } [Theory] - [MemberData(nameof(SolutionOnlyDependenciesData))] + [MemberData(nameof(SolutionOnlyDependenciesData), DisableDiscoveryEnumeration = true)] public void SolutionsCanInjectEdgesIntoTheProjectGraph(Dictionary edges, (int, int)[] solutionDependencies, bool hasCycle, bool solutionEdgesOverlapGraphEdges) { // Use the same global properties as the solution would use so all ConfigurationMetadata objects would match on global properties. diff --git a/src/Build.UnitTests/Graph/IsolateProjects_Tests.cs b/src/Build.UnitTests/Graph/IsolateProjects_Tests.cs index 13bb4275c65..1da40fe77d3 100644 --- a/src/Build.UnitTests/Graph/IsolateProjects_Tests.cs +++ b/src/Build.UnitTests/Graph/IsolateProjects_Tests.cs @@ -484,7 +484,7 @@ public static IEnumerable UndeclaredReferenceEnforcementShouldNormaliz } [Theory] - [MemberData(nameof(UndeclaredReferenceEnforcementShouldNormalizeFilePathsTestData))] + [MemberData(nameof(UndeclaredReferenceEnforcementShouldNormalizeFilePathsTestData), DisableDiscoveryEnumeration = true)] public void UndeclaredReferenceEnforcementShouldNormalizeFilePaths(Func projectReferenceModifier, Func msbuildProjectModifier, string targetName) { AssertBuild(new[] { targetName }, diff --git a/src/Build.UnitTests/Graph/ProjectGraph_Tests.cs b/src/Build.UnitTests/Graph/ProjectGraph_Tests.cs index baf7e0a1ae3..e275395f5f3 100644 --- a/src/Build.UnitTests/Graph/ProjectGraph_Tests.cs +++ b/src/Build.UnitTests/Graph/ProjectGraph_Tests.cs @@ -1804,7 +1804,7 @@ public static IEnumerable Graphs } [Theory] - [MemberData(nameof(Graphs))] + [MemberData(nameof(Graphs), DisableDiscoveryEnumeration = true)] public void TopologicalSortShouldTopologicallySort(Dictionary edges) { using (var env = TestEnvironment.Create()) @@ -1827,7 +1827,7 @@ public void TopologicalSortShouldTopologicallySort(Dictionary edges) } [Theory] - [MemberData(nameof(Graphs))] + [MemberData(nameof(Graphs), DisableDiscoveryEnumeration = true)] public void DotNotationShouldRepresentGraph(Dictionary edges) { var graph = Helpers.CreateProjectGraph( @@ -2320,7 +2320,7 @@ public static IEnumerable AllNodesShouldHaveGraphBuildGlobalPropertyDa } [Theory] - [MemberData(nameof(AllNodesShouldHaveGraphBuildGlobalPropertyData))] + [MemberData(nameof(AllNodesShouldHaveGraphBuildGlobalPropertyData), DisableDiscoveryEnumeration = true)] public void AllNodesShouldHaveGraphBuildGlobalProperty(Dictionary edges, int[] entryPoints, Dictionary globalProperties) { using (var env = TestEnvironment.Create()) @@ -2354,7 +2354,7 @@ public void UserValuesForIsGraphBuildGlobalPropertyShouldBePreserved() } [Theory] - [MemberData(nameof(Graphs))] + [MemberData(nameof(Graphs), DisableDiscoveryEnumeration = true)] public void GraphShouldSupportTransitiveReferences(Dictionary edges) { var graph = Helpers.CreateProjectGraph( @@ -2479,7 +2479,7 @@ public static IEnumerable TransitiveReferencesAreDefinedPerProjectTest } [Theory] - [MemberData(nameof(TransitiveReferencesAreDefinedPerProjectTestData))] + [MemberData(nameof(TransitiveReferencesAreDefinedPerProjectTestData), DisableDiscoveryEnumeration = true)] public void TransitiveReferencesAreDefinedPerProject( Dictionary edges, Dictionary extraContentPerProjectNumber, diff --git a/src/Build.UnitTests/Graph/ResultCacheBasedBuilds_Tests.cs b/src/Build.UnitTests/Graph/ResultCacheBasedBuilds_Tests.cs index f9dd9bf05d4..11033d78af8 100644 --- a/src/Build.UnitTests/Graph/ResultCacheBasedBuilds_Tests.cs +++ b/src/Build.UnitTests/Graph/ResultCacheBasedBuilds_Tests.cs @@ -282,7 +282,7 @@ public static IEnumerable BuildGraphData } [Theory] - [MemberData(nameof(BuildGraphData))] + [MemberData(nameof(BuildGraphData), DisableDiscoveryEnumeration = true)] public void BuildProjectGraphUsingCaches(Dictionary edges) { var topoSortedNodes = diff --git a/src/Shared/UnitTests/FileMatcher_Tests.cs b/src/Shared/UnitTests/FileMatcher_Tests.cs index bf7f53b6bf3..c0bea972965 100644 --- a/src/Shared/UnitTests/FileMatcher_Tests.cs +++ b/src/Shared/UnitTests/FileMatcher_Tests.cs @@ -95,7 +95,7 @@ public void DoNotFollowRecursiveSymlinks() #endif [Theory] - [MemberData(nameof(GetFilesComplexGlobbingMatchingInfo.GetTestData), MemberType = typeof(GetFilesComplexGlobbingMatchingInfo))] + [MemberData(nameof(GetFilesComplexGlobbingMatchingInfo.GetTestData), MemberType = typeof(GetFilesComplexGlobbingMatchingInfo), DisableDiscoveryEnumeration = true)] public void GetFilesComplexGlobbingMatching(GetFilesComplexGlobbingMatchingInfo info) { TransientTestFolder testFolder = _env.CreateFolder(); diff --git a/src/StringTools.UnitTests/InterningTestData.cs b/src/StringTools.UnitTests/InterningTestData.cs index 0e34b3ca39a..28fc95ac0e2 100644 --- a/src/StringTools.UnitTests/InterningTestData.cs +++ b/src/StringTools.UnitTests/InterningTestData.cs @@ -3,6 +3,8 @@ using System.Collections.Generic; +using Xunit.Abstractions; + #nullable disable namespace Microsoft.NET.StringTools.Tests @@ -12,13 +14,18 @@ public static class InterningTestData /// /// Represents an array of string fragments to initialize an InternableString with. /// - public class TestDatum + public class TestDatum : IXunitSerializable { private string _string; - public string[] Fragments { get; } + public string[] Fragments { get; private set; } public int Length => _string.Length; + // Required for deserialization + public TestDatum() + { + } + public TestDatum(params string[] fragments) { Fragments = fragments; @@ -31,6 +38,17 @@ public override string ToString() { return _string; } + + public void Deserialize(IXunitSerializationInfo info) + { + Fragments = info.GetValue(nameof(Fragments)); + _string = string.Join(string.Empty, Fragments); + } + + public void Serialize(IXunitSerializationInfo info) + { + info.AddValue(nameof(Fragments), Fragments); + } } public static IEnumerable TestData From 0a5497348104fda248fb9613fffe9394708a7435 Mon Sep 17 00:00:00 2001 From: Gang Wang Date: Thu, 8 Jan 2026 00:50:02 +0800 Subject: [PATCH 12/39] Add the feature flag that allows users to opt out automatic UTF8 console encoding (#12637) Fixes #11850 ### Context In non-English system especially like Japanese/Chinese, when redirecting the console output which is in UTF8 encoding to the pipe, the output is garbled. There is no way to detect the encoding of the destination. So add the feature flag that allows users to opt out automatic UTF8 console encoding. ### Changes Made Opt out automatic UTF8 console encoding by setting the environment variable `CONSOLE_USE_DEFAULT_ENCODING` to `1`. ### Testing Manually tested. For msbuild.exe image For `dotnet build`, it requires the change in SDK https://github.com/dotnet/sdk/pull/51261. ### Notes --------- Co-authored-by: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> --- .../wiki/MSBuild-Environment-Variables.md | 2 ++ src/Framework/Traits.cs | 5 ++++ src/MSBuild/XMake.cs | 29 ++++++++++--------- 3 files changed, 23 insertions(+), 13 deletions(-) diff --git a/documentation/wiki/MSBuild-Environment-Variables.md b/documentation/wiki/MSBuild-Environment-Variables.md index 76b73f435f4..859cc8e7f69 100644 --- a/documentation/wiki/MSBuild-Environment-Variables.md +++ b/documentation/wiki/MSBuild-Environment-Variables.md @@ -34,3 +34,5 @@ Some of the env variables listed here are unsupported, meaning there is no guara - Set this to force all tasks to run out of process (except inline tasks). - `MSBUILDFORCEINLINETASKFACTORIESOUTOFPROC` - Set this to force all inline tasks to run out of process. It is not compatible with custom TaskFactories. +- `MSBUILD_CONSOLE_USE_DEFAULT_ENCODING` + - It opts out automatic console encoding UTF-8. Make Console use default encoding in the system. \ No newline at end of file diff --git a/src/Framework/Traits.cs b/src/Framework/Traits.cs index d02e95ce944..31378398be6 100644 --- a/src/Framework/Traits.cs +++ b/src/Framework/Traits.cs @@ -147,6 +147,11 @@ public Traits() /// public readonly bool ForceTaskFactoryOutOfProc = Environment.GetEnvironmentVariable("MSBUILDFORCEINLINETASKFACTORIESOUTOFPROC") == "1"; + /// + /// Make Console use default encoding in the system. It opts out automatic console encoding UTF-8. + /// + public readonly bool ConsoleUseDefaultEncoding = Environment.GetEnvironmentVariable("MSBUILD_CONSOLE_USE_DEFAULT_ENCODING") == "1" || Environment.GetEnvironmentVariable("DOTNET_CLI_CONSOLE_USE_DEFAULT_ENCODING") == "1"; + /// /// Variables controlling opt out at the level of not initializing telemetry infrastructure. Set to "1" or "true" to opt out. /// mirroring diff --git a/src/MSBuild/XMake.cs b/src/MSBuild/XMake.cs index b5ad7405d7e..60d30f90088 100644 --- a/src/MSBuild/XMake.cs +++ b/src/MSBuild/XMake.cs @@ -1931,23 +1931,26 @@ internal static void SetConsoleUI() CultureInfo.CurrentUICulture = desiredCulture; CultureInfo.DefaultThreadCurrentUICulture = desiredCulture; + if (!Traits.Instance.ConsoleUseDefaultEncoding) + { #if RUNTIME_TYPE_NETCORE - if (EncodingUtilities.CurrentPlatformIsWindowsAndOfficiallySupportsUTF8Encoding()) + if (EncodingUtilities.CurrentPlatformIsWindowsAndOfficiallySupportsUTF8Encoding()) #else - if (EncodingUtilities.CurrentPlatformIsWindowsAndOfficiallySupportsUTF8Encoding() - && !CultureInfo.CurrentUICulture.TwoLetterISOLanguageName.Equals("en", StringComparison.InvariantCultureIgnoreCase)) + if (EncodingUtilities.CurrentPlatformIsWindowsAndOfficiallySupportsUTF8Encoding() + && !CultureInfo.CurrentUICulture.TwoLetterISOLanguageName.Equals("en", StringComparison.InvariantCultureIgnoreCase)) #endif - { - try - { - // Setting both encodings causes a change in the CHCP, making it so we don't need to P-Invoke CHCP ourselves. - Console.OutputEncoding = Encoding.UTF8; - // If the InputEncoding is not set, the encoding will work in CMD but not in PowerShell, as the raw CHCP page won't be changed. - Console.InputEncoding = Encoding.UTF8; - } - catch (Exception ex) when (ex is IOException || ex is SecurityException) { - // The encoding is unavailable. Do nothing. + try + { + // Setting both encodings causes a change in the CHCP, making it so we don't need to P-Invoke CHCP ourselves. + Console.OutputEncoding = Encoding.UTF8; + // If the InputEncoding is not set, the encoding will work in CMD but not in PowerShell, as the raw CHCP page won't be changed. + Console.InputEncoding = Encoding.UTF8; + } + catch (Exception ex) when (ex is IOException || ex is SecurityException) + { + // The encoding is unavailable. Do nothing. + } } } From dc7f357173d3d795316b86851d95328651592f6d Mon Sep 17 00:00:00 2001 From: Dustin Campbell Date: Wed, 7 Jan 2026 09:02:21 -0800 Subject: [PATCH 13/39] Polyfill clean up and source package organization (#12977) This pull request represents a bit of clean up and should have no product impact. - a342950eceb0eb45504d7d6e58adec6546c7d02b: I noticed that the `StringSyntaxAttribute` polyfill is declared in the wrong namespace. This attribute is only for IDE tooling support and probably doesn't actually work in non-.NET, since it was declared in the `System` namespace rather than `System.Diagnostics.CodeAnalysis`. I've fixed the polyfill and updated all of the files that had used conditional compilation gymnastics to deal with the incorrect namespace. - df61bee674703facce93bdaed106baa805f12725: Small changes to the `CallerArgumentExpressionAttribute` polyfill to match best practices. - 68b8bf25f3f0cc35bb200562429c524ad03b6d84: Update links to the Compile and Content items in the `Microsoft.CodeAnalysis.*` source packages to display the items in separate folders rather than dumping them into the project root. This separates them in the Solution Explorer. image --- src/Build/Microsoft.Build.csproj | 26 +++++++++++++++++-- src/Framework/BuildErrorEventArgs.cs | 2 -- src/Framework/BuildMessageEventArgs.cs | 2 -- src/Framework/BuildWarningEventArgs.cs | 2 -- .../CriticalBuildMessageEventArgs.cs | 2 -- src/Framework/CustomBuildEventArgs.cs | 2 -- src/Framework/ExtendedBuildErrorEventArgs.cs | 2 -- .../ExtendedBuildWarningEventArgs.cs | 2 -- src/Framework/LazyFormattedBuildEventArgs.cs | 2 -- .../Microsoft.Build.Framework.csproj | 8 ++++++ .../CallerArgumentExpressionAttribute.cs | 11 +++++++- .../Polyfills/StringSyntaxAttribute.cs | 12 +++++++-- src/Framework/ProjectImportedEventArgs.cs | 2 -- src/Framework/TargetSkippedEventArgs.cs | 2 -- src/Shared/TaskLoggingHelper.cs | 2 -- src/Tasks/Error.cs | 2 -- src/Tasks/Exec.cs | 2 -- src/Tasks/Warning.cs | 2 -- 18 files changed, 52 insertions(+), 33 deletions(-) diff --git a/src/Build/Microsoft.Build.csproj b/src/Build/Microsoft.Build.csproj index a0834749ca8..fda2c82cc32 100644 --- a/src/Build/Microsoft.Build.csproj +++ b/src/Build/Microsoft.Build.csproj @@ -38,14 +38,36 @@ - - + + + + + + SourcePackages\Collections\%(Link) + + + SourcePackages\Collections\%(Link) + + + + + + + + + SourcePackages\PooledObjects\%(Link) + + + SourcePackages\PooledObjects\%(Link) + + + diff --git a/src/Framework/BuildErrorEventArgs.cs b/src/Framework/BuildErrorEventArgs.cs index 052d602f63d..97cb5b1f1df 100644 --- a/src/Framework/BuildErrorEventArgs.cs +++ b/src/Framework/BuildErrorEventArgs.cs @@ -2,9 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.IO; using Microsoft.Build.Shared; diff --git a/src/Framework/BuildMessageEventArgs.cs b/src/Framework/BuildMessageEventArgs.cs index cab1d21892b..20a1898bea2 100644 --- a/src/Framework/BuildMessageEventArgs.cs +++ b/src/Framework/BuildMessageEventArgs.cs @@ -2,9 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.IO; using System.Runtime.Serialization; using Microsoft.Build.Shared; diff --git a/src/Framework/BuildWarningEventArgs.cs b/src/Framework/BuildWarningEventArgs.cs index 5e4d11acd39..543281e8c26 100644 --- a/src/Framework/BuildWarningEventArgs.cs +++ b/src/Framework/BuildWarningEventArgs.cs @@ -2,9 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.IO; using Microsoft.Build.Shared; diff --git a/src/Framework/CriticalBuildMessageEventArgs.cs b/src/Framework/CriticalBuildMessageEventArgs.cs index 07488b90833..613240347c4 100644 --- a/src/Framework/CriticalBuildMessageEventArgs.cs +++ b/src/Framework/CriticalBuildMessageEventArgs.cs @@ -2,9 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; -#if NET using System.Diagnostics.CodeAnalysis; -#endif #nullable disable diff --git a/src/Framework/CustomBuildEventArgs.cs b/src/Framework/CustomBuildEventArgs.cs index 19f3f844776..85d59389d3f 100644 --- a/src/Framework/CustomBuildEventArgs.cs +++ b/src/Framework/CustomBuildEventArgs.cs @@ -2,9 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; -#if NET using System.Diagnostics.CodeAnalysis; -#endif #nullable disable diff --git a/src/Framework/ExtendedBuildErrorEventArgs.cs b/src/Framework/ExtendedBuildErrorEventArgs.cs index 2ce76e0bf53..54f558432b1 100644 --- a/src/Framework/ExtendedBuildErrorEventArgs.cs +++ b/src/Framework/ExtendedBuildErrorEventArgs.cs @@ -3,9 +3,7 @@ using System; using System.Collections.Generic; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.IO; using Microsoft.Build.Shared; diff --git a/src/Framework/ExtendedBuildWarningEventArgs.cs b/src/Framework/ExtendedBuildWarningEventArgs.cs index 598526c40a8..2d9a163eb15 100644 --- a/src/Framework/ExtendedBuildWarningEventArgs.cs +++ b/src/Framework/ExtendedBuildWarningEventArgs.cs @@ -3,9 +3,7 @@ using System; using System.Collections.Generic; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.IO; using Microsoft.Build.Shared; diff --git a/src/Framework/LazyFormattedBuildEventArgs.cs b/src/Framework/LazyFormattedBuildEventArgs.cs index 28598b2f1b6..5cb00f9a8b2 100644 --- a/src/Framework/LazyFormattedBuildEventArgs.cs +++ b/src/Framework/LazyFormattedBuildEventArgs.cs @@ -2,9 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.Globalization; using System.IO; diff --git a/src/Framework/Microsoft.Build.Framework.csproj b/src/Framework/Microsoft.Build.Framework.csproj index 2820f9af784..b87b9db871e 100644 --- a/src/Framework/Microsoft.Build.Framework.csproj +++ b/src/Framework/Microsoft.Build.Framework.csproj @@ -16,6 +16,14 @@ + + + + SourcePackages\Contracts\%(Link) + + + SourcePackages\Contracts\%(Link) + diff --git a/src/Framework/Polyfills/CallerArgumentExpressionAttribute.cs b/src/Framework/Polyfills/CallerArgumentExpressionAttribute.cs index 66e0e808c2c..91623fbd9f9 100644 --- a/src/Framework/Polyfills/CallerArgumentExpressionAttribute.cs +++ b/src/Framework/Polyfills/CallerArgumentExpressionAttribute.cs @@ -1,9 +1,17 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +#if NETCOREAPP3_0_OR_GREATER + +using System.Runtime.CompilerServices; + +// This is a supporting forwarder for an internal polyfill API +[assembly: TypeForwardedTo(typeof(CallerArgumentExpressionAttribute))] + +#else + namespace System.Runtime.CompilerServices; -#if !NET [AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false, Inherited = false)] internal sealed class CallerArgumentExpressionAttribute : Attribute { @@ -14,4 +22,5 @@ public CallerArgumentExpressionAttribute(string parameterName) public string ParameterName { get; } } + #endif diff --git a/src/Framework/Polyfills/StringSyntaxAttribute.cs b/src/Framework/Polyfills/StringSyntaxAttribute.cs index 4bfd1bb40cd..2be24ae6499 100644 --- a/src/Framework/Polyfills/StringSyntaxAttribute.cs +++ b/src/Framework/Polyfills/StringSyntaxAttribute.cs @@ -1,9 +1,16 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. -#if !NET +#if NET7_0_OR_GREATER -using System; +using System.Runtime.CompilerServices; + +// This is a supporting forwarder for an internal polyfill API +[assembly: TypeForwardedTo(typeof(System.Diagnostics.CodeAnalysis.StringSyntaxAttribute))] + +#else + +namespace System.Diagnostics.CodeAnalysis; [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false, Inherited = false)] internal sealed class StringSyntaxAttribute : Attribute @@ -67,4 +74,5 @@ public StringSyntaxAttribute(string syntax, params object?[] arguments) /// The syntax identifier for strings containing XML. public const string Xml = nameof(Xml); } + #endif diff --git a/src/Framework/ProjectImportedEventArgs.cs b/src/Framework/ProjectImportedEventArgs.cs index 2df59de35f3..4884d1bcf23 100644 --- a/src/Framework/ProjectImportedEventArgs.cs +++ b/src/Framework/ProjectImportedEventArgs.cs @@ -2,9 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.IO; using Microsoft.Build.Shared; diff --git a/src/Framework/TargetSkippedEventArgs.cs b/src/Framework/TargetSkippedEventArgs.cs index 6e636b4f61b..8536d2bec8a 100644 --- a/src/Framework/TargetSkippedEventArgs.cs +++ b/src/Framework/TargetSkippedEventArgs.cs @@ -2,9 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.IO; using Microsoft.Build.Shared; diff --git a/src/Shared/TaskLoggingHelper.cs b/src/Shared/TaskLoggingHelper.cs index 1f288534e81..fcfa634e4c4 100644 --- a/src/Shared/TaskLoggingHelper.cs +++ b/src/Shared/TaskLoggingHelper.cs @@ -4,9 +4,7 @@ using System; using System.Collections.Generic; using System.Diagnostics; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.Globalization; using System.IO; using System.Resources; diff --git a/src/Tasks/Error.cs b/src/Tasks/Error.cs index fc7d5cf2288..40f9c7edf1c 100644 --- a/src/Tasks/Error.cs +++ b/src/Tasks/Error.cs @@ -3,9 +3,7 @@ #nullable disable -#if NET using System.Diagnostics.CodeAnalysis; -#endif using Microsoft.Build.Framework; namespace Microsoft.Build.Tasks diff --git a/src/Tasks/Exec.cs b/src/Tasks/Exec.cs index 4daa47cf647..cf87ebedec1 100644 --- a/src/Tasks/Exec.cs +++ b/src/Tasks/Exec.cs @@ -3,9 +3,7 @@ using System; using System.Collections.Generic; -#if NET using System.Diagnostics.CodeAnalysis; -#endif using System.IO; using System.Text; using System.Text.RegularExpressions; diff --git a/src/Tasks/Warning.cs b/src/Tasks/Warning.cs index 49ba1e927ff..bb5a364d185 100644 --- a/src/Tasks/Warning.cs +++ b/src/Tasks/Warning.cs @@ -3,9 +3,7 @@ #nullable disable -#if NET using System.Diagnostics.CodeAnalysis; -#endif using Microsoft.Build.Framework; namespace Microsoft.Build.Tasks From 9da1bd7b6e2e4508eed4af26e2e1de93eac977bd Mon Sep 17 00:00:00 2001 From: dotnet bot Date: Thu, 8 Jan 2026 14:26:30 +0100 Subject: [PATCH 14/39] Localized file check-in by OneLocBuild Task: Build definition ID 9434: Build ID 13052367 (#12984) This is the pull request automatically created by the OneLocBuild task in the build process to check-in localized files generated based upon translation source files (.lcl files) handed-back from the downstream localization pipeline. If there are issues in translations, visit https://aka.ms/icxLocBug and log bugs for fixes. The OneLocBuild wiki is https://aka.ms/onelocbuild and the localization process in general is documented at https://aka.ms/AllAboutLoc. Co-authored-by: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> --- src/Build/Resources/xlf/Strings.de.xlf | 4 ++-- src/Build/Resources/xlf/Strings.fr.xlf | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Build/Resources/xlf/Strings.de.xlf b/src/Build/Resources/xlf/Strings.de.xlf index f731975839f..4dc35395ed0 100644 --- a/src/Build/Resources/xlf/Strings.de.xlf +++ b/src/Build/Resources/xlf/Strings.de.xlf @@ -903,12 +903,12 @@ Fehler: {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + Ein SDK hat versucht, die Umgebungsvariable „{0}“ auf „{1}“ festzulegen, sie wurde aber bereits als Umgebungsvariable auf „{2}“ festgelegt. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + Ein SDK hat versucht, die Umgebungsvariable „{0}“ auf „{1}“ festzulegen, sie wurde aber bereits von einem anderen SDK auf „{2}“ festgelegt. diff --git a/src/Build/Resources/xlf/Strings.fr.xlf b/src/Build/Resources/xlf/Strings.fr.xlf index 9e0c8281ae3..099af04b766 100644 --- a/src/Build/Resources/xlf/Strings.fr.xlf +++ b/src/Build/Resources/xlf/Strings.fr.xlf @@ -903,12 +903,12 @@ Erreurs : {3} An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" as an environment variable. + Un Kit de développement logiciel (SDK) a tenté de définir la variable d’environnement « {0} » à « {1} », alors qu'elle était déjà définie sur « {2} » en tant que variable d'environnement. An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. - An SDK attempted to set the environment variable "{0}" to "{1}" but it was already set to "{2}" by another SDK. + Un Kit de développement logiciel (SDK) a tenté de définir la variable d’environnement « {0} » à « {1} », mais elle était déjà définie sur « {2} » par un autre SDK. From 09c76669b0e7039ef9246a289d76c334a44b79fb Mon Sep 17 00:00:00 2001 From: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> Date: Fri, 9 Jan 2026 09:45:38 +0100 Subject: [PATCH 15/39] Add documentation for enabling binlog collection via env var (#12805) Document the process for enabling binary logging in CI/CD pipelines using environment variables, including supported arguments, argument processing order, and implementation flow. Fixes https://github.com/dotnet/msbuild/issues/12804 --- .../enable-binlog-collection-by-env-var.md | 158 ++++++++++++++++++ 1 file changed, 158 insertions(+) create mode 100644 documentation/specs/enable-binlog-collection-by-env-var.md diff --git a/documentation/specs/enable-binlog-collection-by-env-var.md b/documentation/specs/enable-binlog-collection-by-env-var.md new file mode 100644 index 00000000000..9db31a50f7b --- /dev/null +++ b/documentation/specs/enable-binlog-collection-by-env-var.md @@ -0,0 +1,158 @@ +# Enable Binary Log Collection via Environment Variable + +## Purpose + +Enable binary logging in CI/CD pipelines without modifying artifacts on disk. + +**Proposed solution:** An environment variable that enables diagnostic logging without touching any files on disk-no response file creation, no project file modifications, no build script changes. + +**Important for company-wide deployment:** When enabling this feature organization-wide (e.g., via CI/CD pipeline configuration), the team setting the environment variable may not be the team that owns individual codebases. Ensure stakeholders understand that builds with `/warnaserror` may be affected and be ready to mitigate this. + +### Demoting Warnings to Messages + +For scenarios where warnings would break builds (e.g., `/warnaserror` is enabled), set: + +```bash +set MSBUILD_LOGGING_ARGS_LEVEL=message +``` + +| Value | Behavior | +|-------|----------| +| `warning` (default) | Issues logged as warnings; may fail `/warnaserror` builds | +| `message` | Issues logged as low-importance messages; never fails builds | + +**Problem scenarios addressed:** + +- `-noAutoResponse` blocks response files entirely +- Creating `Directory.Build.rsp` requires writing new files to the source tree +- Modifying existing RSP files risks merge conflicts or unintended side effects +- Some build environments restrict write access to source directories + +### Why Not MSBUILDDEBUGENGINE? + +The existing `MSBUILDDEBUGENGINE=1` + `MSBUILDDEBUGPATH` mechanism works but has limitations for the desired CI/CD scenarios: + +- **Excessive logging:** Captures *all* MSBuild invocations including design-time builds, generating many files +- **No filename control:** Auto-generates filenames; cannot specify output path with `{}` placeholder for unique names +- **Debug overhead:** Enables additional debugging infrastructure beyond just binary logging + +## Supported Arguments + +- `-bl` / `/bl` / `-binarylogger` / `/binarylogger` (with optional parameters) +- `-check` / `/check` (with optional parameters) + +> **Note:** The `deferred` mode for `-check` is not currently supported. Enabling this feature requires changes to the MSBuild codebase. See section "Build Check (-check) Handling" below. + +> **Recommendation:** For CI/CD use, specify an **absolute path** with the `{}` placeholder (e.g., `-bl:C:\BuildLogs\build{}.binlog` or `-bl:/var/log/builds/build{}.binlog`) to generate unique filenames in a known location, avoiding CWD-relative paths that vary by build. + +**All other switches are blocked** to maintain diagnosability. + +### Rationale + +Environment variables that unexpectedly affect build behavior are notoriously difficult to diagnose (e.g., `Platform` is a known source of build issues). By restricting this environment variable to logging/diagnostic switches only, we ensure it cannot accidentally change build outcomes-only what gets recorded about the build. + +## Argument Processing Order + +1. **MSBuild.rsp** (next to MSBuild.exe) - skipped if `-noAutoResponse` present +2. **Directory.Build.rsp** (next to project) - skipped if `-noAutoResponse` present +3. **MSBUILD_LOGGING_ARGS** - always processed, regardless of `-noAutoResponse` +4. **Command-line arguments** + +### Why Precedence Doesn't Matter Here + +Since `MSBUILD_LOGGING_ARGS` only allows logging switches (`-bl` and `-check`), traditional precedence concerns don't apply: + +- **`-bl` is additive:** Each `-bl` argument creates a separate binlog file (requires [#12706](https://github.com/dotnet/msbuild/pull/12706)). Multiple sources specifying `-bl` simply result in multiple binlog files-there's no conflict to resolve. + +## Implementation Flow + +1. `MSBuildApp.Execute()` called +2. Check for `-noAutoResponse` in command line +3. Process response files (if no `-noAutoResponse`) +4. Read `MSBUILD_LOGGING_ARGS` environment variable +5. Validate and filter arguments +6. Prepend valid arguments to command line +7. Parse combined command line (merging happens here) +8. Execute build + +## Scope and Limitations + +### Supported Entry Points + +This environment variable only affects builds that go through MSBuild's `Main()` entry point: + +| Entry Point | Supported | Notes | +|-------------|-----------|-------| +| `MSBuild.exe` | ✅ Yes | | +| `dotnet build` | ✅ Yes | | +| `dotnet msbuild` | ✅ Yes | | +| Visual Studio (IDE builds) | ❌ No | Uses MSBuild API directly | +| `devenv.exe /build` | ❌ No | Uses MSBuild API directly | +| MSBuildWorkspace (Roslyn) | ❌ No | Uses MSBuild API directly | +| Custom build drivers via API | ❌ No | Any direct `Microsoft.Build` API usage | + +### API-Driven Builds + +For builds that use the MSBuild API directly (including Visual Studio and `devenv.exe /build`), this environment variable has no effect. + +**Alternative:** Use `MSBUILDDEBUGENGINE` to inject binlog collection into API-driven builds. This existing mechanism is already used for debugging Visual Studio builds and works across all MSBuild entry points. +```bash +# For API-driven builds (VS, devenv.exe /build, etc.) +set MSBUILDDEBUGENGINE=1 + +# For command-line builds (MSBuild.exe, dotnet build) +set MSBUILD_LOGGING_ARGS=-bl:build{}.binlog +``` + +## Warning Messages + +Issues are logged as **warnings** by default. Note that users with `/warnaserror` enabled will see these as errors-by opting into this environment variable, users also opt into these diagnostics. + +### Messages + +- **Informational:** "Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0}" - build continues with arguments applied +- **Unsupported argument:** "MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed." - the specific invalid argument is skipped, other valid arguments in the same env var are still processed (e.g., `-bl:a.binlog -maxcpucount:4` → `-bl:a.binlog` is applied, `-maxcpucount:4` is ignored with warning) +- **Malformed input:** "Error processing MSBUILD_LOGGING_ARGS environment variable: {0}" - the entire environment variable is skipped to avoid partial/unpredictable behavior, build proceeds as if the env var was not set + +## Build Check (-check) Handling + +### Deferred Analysis Mode + +`-check:deferred` enables binlog replay analysis with reduced build-time overhead: + +- **During build:** Flag recorded in binlog along with additional data needed for checks; BuildCheck NOT activated +- **During replay:** Binlog reader activates BuildCheck for analysis + +**Rationale:** BuildCheck analysis can be expensive and checks can fail the build. The environment variable is for diagnostics that can be analyzed later, allowing teams to record data with minimal impact to the build itself. + +### Example Workflow +```bash +# 1. Configure environment +set MSBUILD_LOGGING_ARGS=-bl:build{}.binlog -check:deferred + +# 2. Run build (reduced overhead, no BuildCheck analysis during build) +msbuild solution.sln + +# 3. Later: Replay binlog (BuildCheck analyzes recorded events) +msbuild build{}.binlog +``` + +## CI/CD Integration + + +### Environment Variable + +- Set `MSBUILD_LOGGING_ARGS=-bl:build{}.binlog` +- No file creation needed +- The `{}` placeholder generates unique filenames for each build invocation + +### Combining Both Approaches +```bash +# Environment provides base logging +set MSBUILD_LOGGING_ARGS=-bl:base{}.binlog -check:deferred + +# Command line adds specific logging +msbuild solution.sln -bl:detailed.binlog + +# Result: Two binlog files created (base{...}.binlog + detailed.binlog) +``` \ No newline at end of file From 3f8a08bbcf61c804139128c45bfce46b9b6db634 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Fri, 9 Jan 2026 07:32:02 -0600 Subject: [PATCH 16/39] Support multiple binary logs from command line arguments (#12706) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Context Today it's possible to provide the `-bl` flag multiple times, but the behavior of the engine is that the last-provided flag wins. This is confusing, and in extreme cases can mean that tools that need binlogs and provide them via things like response files can be overridden by a user's invocation. Tools like CodeQL have a harder time adopting binlog usage for C# code analysis because they can't control where the binlog is generated. ### Changes Made Implemented support for writing multiple binlogs when supplied via command line arguments. The implementation intelligently handles two scenarios: 1. **Same Configuration (Optimized)**: When all `-bl` flags have the same configuration (only file paths differ), a single BinaryLogger writes to one location and copies to additional destinations at build completion for consistency and performance. 2. **Different Configurations**: When `-bl` flags have different configurations (e.g., `ProjectImports=None` vs `ProjectImports=Embed`), separate BinaryLogger instances are created to respect each configuration. **Key changes:** - Added `AdditionalFilePaths` property to BinaryLogger with `init` accessor (documented as internal-use only) - Added `BinaryLogger.ProcessParameters()` static method to process multiple parameter sets and return distinct paths with configuration info - Added `ProcessedBinaryLoggerParameters` readonly struct to encapsulate the processing results - Updated `Shutdown()` method to copy binlog to additional paths after stream close - Uses `LogMessage` to log copy destinations before stream close - Uses `Console.Error` to log copy errors (won't fail build on copy failures) - Updated `XMake.ProcessBinaryLogger()` to use the new BinaryLogger.ProcessParameters() method with object initializer syntax for `init` properties - Added error message resource for copy failures - Replaced hardcoded string literals with constants (BinlogFileExtension, LogFileParameterPrefix) - All new methods have XML documentation - Added `DuplicateFilePaths` property to track and report duplicate paths - Added message to inform users when duplicate binary log paths are filtered out - Refactored `TryInterpretPathParameter` methods to eliminate code duplication via shared core method - Optimized `ProcessParameters` to avoid redundant path extraction calls ### Testing - Added unit tests for multiple binlog files with same configuration - Added unit tests for multiple binlog files with different configurations - Added unit test for duplicate path deduplication - Added dedicated unit tests for `ExtractFilePathFromParameters`, `ExtractNonPathParameters`, and `ProcessParameters` - Manual verification confirms all specified binlog files are created with identical content - All tests passing with `init` accessor implementation ### Notes - The `AdditionalFilePaths` property uses `init` accessor to enforce immutability after object initialization, signaling it should only be set during construction - External code should create multiple logger instances instead of using AdditionalFilePaths - When MSBUILDDEBUGENGINE is set, the engine creates a separate BinaryLogger instance which operates independently (functionally correct behavior) - Duplicate paths specified via multiple `-bl` flags are automatically deduplicated - only the first occurrence is kept - Users are now informed when duplicate paths are detected and filtered out - Copy errors are logged to stderr but don't fail the build, ensuring builds succeed even if binlog copies fail
Original prompt > > ---- > > *This section details on the original issue you should resolve* > > MSBuild.exe should support writing multiple binlogs if supplied as part of command line arguments > ### Summary > > Today it's possible to provide the `-bl` flag multiple times, but the behavior of the engine is that the last-provided flag wins: > > ``` > > dotnet build -bl:1.binlog -bl:2.binlog > Restore complete (0.1s) > info NETSDK1057: You are using a preview version of .NET. See: https://aka.ms/dotnet-support-policy > lib2 net10.0 succeeded (0.1s) → D:\Code\scratch\bleh\lib2\bin\Debug\net10.0\lib2.dll > bleh net10.0 succeeded (0.1s) → bin\Debug\net10.0\bleh.dll > > Build succeeded in 0.5s > > ls *.binlog > > Directory: D:\Code\scratch\bleh\lib > > Mode LastWriteTime Length Name > ---- ------------- ------ ---- > -a--- 10/29/2025 11:14 AM 454756 2.binlog > ``` > This is confusing, and in extreme cases can mean that tools that need binlogs and provide them via things like response files can be overridden by a users invocation. > > ### Background and Motivation > > The inability to write more than one binlog file means that tools like codeql have a harder time adopting binlog usage for C# code analysis, because they can't control where the binlog is generated. > > ### Proposed Feature > > The command-line handling should accept _multiple_ bl flags, resolve them into their distinct binlog filenames, ensure that set is distinct, and then the binary logger should be able to write binary logs to all of those specified files. > > This file writing could be done in two ways (at least) > * multiple independent writers, each writing to a separate file > * one writer, writing the binlog file to a temp location and then atomically copying that file to the various destinations at build-finish > > We should use the second option for consistency. > > > ### Alternative Designs > > _No response_ > > ## Comments on the Issue (you are @copilot in this section) > > > >
- Fixes dotnet/msbuild#12705 --- 💡 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](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: baronfel <573979+baronfel@users.noreply.github.com> Co-authored-by: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> Co-authored-by: YuliiaKovalova --- src/Build.UnitTests/BinaryLogger_Tests.cs | 176 +++++++++++ .../Logging/BinaryLogger/BinaryLogger.cs | 273 +++++++++++++++++- src/Build/Resources/Strings.resx | 6 +- src/Build/Resources/xlf/Strings.cs.xlf | 5 + src/Build/Resources/xlf/Strings.de.xlf | 5 + src/Build/Resources/xlf/Strings.es.xlf | 5 + src/Build/Resources/xlf/Strings.fr.xlf | 5 + src/Build/Resources/xlf/Strings.it.xlf | 5 + src/Build/Resources/xlf/Strings.ja.xlf | 5 + src/Build/Resources/xlf/Strings.ko.xlf | 5 + src/Build/Resources/xlf/Strings.pl.xlf | 5 + src/Build/Resources/xlf/Strings.pt-BR.xlf | 5 + src/Build/Resources/xlf/Strings.ru.xlf | 5 + src/Build/Resources/xlf/Strings.tr.xlf | 5 + src/Build/Resources/xlf/Strings.zh-Hans.xlf | 5 + src/Build/Resources/xlf/Strings.zh-Hant.xlf | 5 + src/MSBuild.UnitTests/XMake_Tests.cs | 110 +++++++ src/MSBuild/Resources/Strings.resx | 4 + src/MSBuild/Resources/xlf/Strings.cs.xlf | 5 + src/MSBuild/Resources/xlf/Strings.de.xlf | 5 + src/MSBuild/Resources/xlf/Strings.es.xlf | 5 + src/MSBuild/Resources/xlf/Strings.fr.xlf | 5 + src/MSBuild/Resources/xlf/Strings.it.xlf | 5 + src/MSBuild/Resources/xlf/Strings.ja.xlf | 5 + src/MSBuild/Resources/xlf/Strings.ko.xlf | 5 + src/MSBuild/Resources/xlf/Strings.pl.xlf | 5 + src/MSBuild/Resources/xlf/Strings.pt-BR.xlf | 5 + src/MSBuild/Resources/xlf/Strings.ru.xlf | 5 + src/MSBuild/Resources/xlf/Strings.tr.xlf | 5 + src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf | 5 + src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf | 5 + src/MSBuild/XMake.cs | 34 ++- 32 files changed, 722 insertions(+), 11 deletions(-) diff --git a/src/Build.UnitTests/BinaryLogger_Tests.cs b/src/Build.UnitTests/BinaryLogger_Tests.cs index 7156a81eb58..55884569139 100644 --- a/src/Build.UnitTests/BinaryLogger_Tests.cs +++ b/src/Build.UnitTests/BinaryLogger_Tests.cs @@ -748,6 +748,182 @@ public void ParseParameters_InvalidParameter_ThrowsLoggerException(string parame File.Create(_logFile).Dispose(); } + #region ExtractFilePathFromParameters Tests + + [Theory] + [InlineData(null, "msbuild.binlog")] + [InlineData("", "msbuild.binlog")] + [InlineData("output.binlog", "output.binlog")] + [InlineData("LogFile=output.binlog", "output.binlog")] + [InlineData("output.binlog;ProjectImports=None", "output.binlog")] + [InlineData("ProjectImports=None;output.binlog", "output.binlog")] + [InlineData("ProjectImports=None;LogFile=output.binlog;OmitInitialInfo", "output.binlog")] + [InlineData("ProjectImports=None", "msbuild.binlog")] // No path specified + [InlineData("OmitInitialInfo", "msbuild.binlog")] // No path specified + public void ExtractFilePathFromParameters_ReturnsExpectedPath(string parameters, string expectedFileName) + { + string result = BinaryLogger.ExtractFilePathFromParameters(parameters); + + // The method returns full paths, so check just the filename + Path.GetFileName(result).ShouldBe(expectedFileName); + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + [Fact] + public void ExtractFilePathFromParameters_ReturnsFullPath() + { + string result = BinaryLogger.ExtractFilePathFromParameters("mylog.binlog"); + + // Should be a full path, not relative + Path.IsPathRooted(result).ShouldBeTrue(); + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + #endregion + + #region ExtractNonPathParameters Tests + + [Theory] + [InlineData(null, "")] + [InlineData("", "")] + [InlineData("output.binlog", "")] // Path only, no config + [InlineData("LogFile=output.binlog", "")] // Path only, no config + [InlineData("ProjectImports=None", "ProjectImports=None")] + [InlineData("OmitInitialInfo", "OmitInitialInfo")] + [InlineData("output.binlog;ProjectImports=None", "ProjectImports=None")] + [InlineData("output.binlog;ProjectImports=None;OmitInitialInfo", "OmitInitialInfo;ProjectImports=None")] // Sorted + [InlineData("OmitInitialInfo;output.binlog;ProjectImports=None", "OmitInitialInfo;ProjectImports=None")] // Sorted + public void ExtractNonPathParameters_ReturnsExpectedConfig(string parameters, string expectedConfig) + { + string result = BinaryLogger.ExtractNonPathParameters(parameters); + result.ShouldBe(expectedConfig); + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + #endregion + + #region ProcessParameters Tests + + [Fact] + public void ProcessParameters_NullArray_ReturnsEmptyResult() + { + var result = BinaryLogger.ProcessParameters(null); + + result.DistinctParameterSets.ShouldBeEmpty(); + result.AdditionalFilePaths.ShouldBeEmpty(); + result.DuplicateFilePaths.ShouldBeEmpty(); + result.AllConfigurationsIdentical.ShouldBeTrue(); + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + [Fact] + public void ProcessParameters_EmptyArray_ReturnsEmptyResult() + { + var result = BinaryLogger.ProcessParameters(Array.Empty()); + + result.DistinctParameterSets.ShouldBeEmpty(); + result.AdditionalFilePaths.ShouldBeEmpty(); + result.DuplicateFilePaths.ShouldBeEmpty(); + result.AllConfigurationsIdentical.ShouldBeTrue(); + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + [Fact] + public void ProcessParameters_SingleParameter_ReturnsOneParameterSet() + { + var result = BinaryLogger.ProcessParameters(new[] { "output.binlog" }); + + result.DistinctParameterSets.Count.ShouldBe(1); + result.DistinctParameterSets[0].ShouldBe("output.binlog"); + result.AdditionalFilePaths.ShouldBeEmpty(); + result.DuplicateFilePaths.ShouldBeEmpty(); + result.AllConfigurationsIdentical.ShouldBeTrue(); + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + [Fact] + public void ProcessParameters_MultipleIdenticalConfigs_OptimizesWithAdditionalPaths() + { + var result = BinaryLogger.ProcessParameters(new[] { "1.binlog", "2.binlog", "3.binlog" }); + + result.DistinctParameterSets.Count.ShouldBe(3); + result.AllConfigurationsIdentical.ShouldBeTrue(); + result.AdditionalFilePaths.Count.ShouldBe(2); // 2.binlog and 3.binlog + result.DuplicateFilePaths.ShouldBeEmpty(); + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + [Fact] + public void ProcessParameters_DifferentConfigs_NoOptimization() + { + var result = BinaryLogger.ProcessParameters(new[] { "1.binlog", "2.binlog;ProjectImports=None" }); + + result.DistinctParameterSets.Count.ShouldBe(2); + result.AllConfigurationsIdentical.ShouldBeFalse(); + result.AdditionalFilePaths.ShouldBeEmpty(); + result.DuplicateFilePaths.ShouldBeEmpty(); + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + [Fact] + public void ProcessParameters_DuplicatePaths_FilteredOut() + { + var result = BinaryLogger.ProcessParameters(new[] { "1.binlog", "1.binlog", "2.binlog" }); + + result.DistinctParameterSets.Count.ShouldBe(2); // 1.binlog and 2.binlog + result.DuplicateFilePaths.Count.ShouldBe(1); // One duplicate of 1.binlog + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + [Fact] + public void ProcessParameters_DuplicatePaths_CaseInsensitive() + { + var result = BinaryLogger.ProcessParameters(new[] { "Output.binlog", "output.BINLOG", "other.binlog" }); + + result.DistinctParameterSets.Count.ShouldBe(2); // Output.binlog and other.binlog + result.DuplicateFilePaths.Count.ShouldBe(1); // One duplicate + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + [Fact] + public void ProcessParameters_MixedConfigsWithDuplicates_HandledCorrectly() + { + var result = BinaryLogger.ProcessParameters(new[] { + "1.binlog", + "2.binlog;ProjectImports=None", + "1.binlog;ProjectImports=None" // Different config but same path - filtered as duplicate + }); + + result.DistinctParameterSets.Count.ShouldBe(2); + result.AllConfigurationsIdentical.ShouldBeFalse(); + result.DuplicateFilePaths.Count.ShouldBe(1); + + // Create the expected log file to satisfy test environment expectations + File.Create(_logFile).Dispose(); + } + + #endregion + public void Dispose() { _env.Dispose(); diff --git a/src/Build/Logging/BinaryLogger/BinaryLogger.cs b/src/Build/Logging/BinaryLogger/BinaryLogger.cs index 3d40ddeb7af..73031a02798 100644 --- a/src/Build/Logging/BinaryLogger/BinaryLogger.cs +++ b/src/Build/Logging/BinaryLogger/BinaryLogger.cs @@ -2,6 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; +using System.Collections.Generic; using System.IO; using System.IO.Compression; using Microsoft.Build.Experimental.BuildCheck.Infrastructure.EditorConfig; @@ -296,6 +297,17 @@ private static bool TryParsePathParameter(string parameter, out string filePath) internal string FilePath { get; private set; } + /// + /// Gets or sets additional output file paths. When set, the binlog will be copied to all these paths + /// after the build completes. The primary FilePath will be used as the temporary write location. + /// + /// + /// This property is intended for internal use by MSBuild command-line processing. + /// It should not be set by external code or logger implementations. + /// Use multiple logger instances with different Parameters instead. + /// + public IReadOnlyList AdditionalFilePaths { get; init; } + /// Gets or sets the verbosity level. /// /// The binary logger Verbosity is always maximum (Diagnostic). It tries to capture as much @@ -505,6 +517,15 @@ public void Shutdown() } + // Log additional file paths before closing stream (so they're recorded in the binlog) + if (AdditionalFilePaths != null && AdditionalFilePaths.Count > 0 && stream != null) + { + foreach (var additionalPath in AdditionalFilePaths) + { + LogMessage("BinLogCopyDestination=" + additionalPath); + } + } + if (stream != null) { // It's hard to determine whether we're at the end of decoding GZipStream @@ -514,6 +535,37 @@ public void Shutdown() stream.Dispose(); stream = null; } + + // Copy the binlog file to additional destinations if specified + if (AdditionalFilePaths != null && AdditionalFilePaths.Count > 0) + { + foreach (var additionalPath in AdditionalFilePaths) + { + try + { + string directory = Path.GetDirectoryName(additionalPath); + if (!string.IsNullOrEmpty(directory)) + { + Directory.CreateDirectory(directory); + } + File.Copy(FilePath, additionalPath, overwrite: true); + } + catch (Exception ex) + { + // Log the error but don't fail the build + // Note: We can't use LogMessage here since the stream is already closed + string message = ResourceUtilities.FormatResourceStringStripCodeAndKeyword( + out _, + out _, + "ErrorCopyingBinaryLog", + FilePath, + additionalPath, + ex.Message); + + Console.Error.WriteLine(message); + } + } + } } private void RawEvents_LogDataSliceReceived(BinaryLogRecordKind recordKind, Stream stream) @@ -635,6 +687,78 @@ private void ProcessParameters(out bool omitInitialInfo) } private bool TryInterpretPathParameter(string parameter, out string filePath) + { + return TryInterpretPathParameterCore(parameter, GetUniqueStamp, out filePath); + } + + private string GetUniqueStamp() + => (PathParameterExpander ?? ExpandPathParameter)(string.Empty); + + private static string ExpandPathParameter(string parameters) + => $"{DateTime.UtcNow.ToString("yyyyMMdd-HHmmss")}--{EnvironmentUtilities.CurrentProcessId}--{StringUtils.GenerateRandomString(6)}"; + + /// + /// Extracts the file path from binary logger parameters string. + /// This is a helper method for processing multiple binlog parameters. + /// + /// The parameters string (e.g., "output.binlog" or "output.binlog;ProjectImports=None") + /// The resolved file path, or "msbuild.binlog" if no path is specified + public static string ExtractFilePathFromParameters(string parameters) + { + const string DefaultBinlogFileName = "msbuild" + BinlogFileExtension; + + if (string.IsNullOrEmpty(parameters)) + { + return Path.GetFullPath(DefaultBinlogFileName); + } + + var paramParts = parameters.Split(MSBuildConstants.SemicolonChar, StringSplitOptions.RemoveEmptyEntries); + string filePath = null; + + foreach (var parameter in paramParts) + { + if (TryInterpretPathParameterStatic(parameter, out string extractedPath)) + { + filePath = extractedPath; + break; + } + } + + if (filePath == null) + { + filePath = DefaultBinlogFileName; + } + + try + { + return Path.GetFullPath(filePath); + } + catch + { + // If path resolution fails, return the original path + return filePath; + } + } + + /// + /// Attempts to interpret a parameter string as a file path. + /// + /// The parameter to interpret (e.g., "LogFile=output.binlog" or "output.binlog") + /// The extracted file path if the parameter is a path, otherwise the original parameter + /// True if the parameter is a valid file path (ends with .binlog or contains wildcards), false otherwise + private static bool TryInterpretPathParameterStatic(string parameter, out string filePath) + { + return TryInterpretPathParameterCore(parameter, () => ExpandPathParameter(string.Empty), out filePath); + } + + /// + /// Core logic for interpreting a parameter string as a file path. + /// + /// The parameter to interpret + /// Function to expand wildcard placeholders + /// The extracted file path + /// True if the parameter is a valid file path + private static bool TryInterpretPathParameterCore(string parameter, Func wildcardExpander, out string filePath) { bool hasPathPrefix = parameter.StartsWith(LogFileParameterPrefix, StringComparison.OrdinalIgnoreCase); @@ -654,7 +778,7 @@ private bool TryInterpretPathParameter(string parameter, out string filePath) return hasProperExtension; } - filePath = parameter.Replace("{}", GetUniqueStamp(), StringComparison.Ordinal); + filePath = parameter.Replace("{}", wildcardExpander(), StringComparison.Ordinal); if (!hasProperExtension) { @@ -663,10 +787,149 @@ private bool TryInterpretPathParameter(string parameter, out string filePath) return true; } - private string GetUniqueStamp() - => (PathParameterExpander ?? ExpandPathParameter)(string.Empty); + /// + /// Extracts the non-file-path parameters from binary logger parameters string. + /// This is used to compare configurations between multiple binlog parameters. + /// + /// The parameters string (e.g., "output.binlog;ProjectImports=None") + /// A normalized string of non-path parameters, or empty string if only path parameters + public static string ExtractNonPathParameters(string parameters) + { + if (string.IsNullOrEmpty(parameters)) + { + return string.Empty; + } - private static string ExpandPathParameter(string parameters) - => $"{DateTime.UtcNow.ToString("yyyyMMdd-HHmmss")}--{EnvironmentUtilities.CurrentProcessId}--{StringUtils.GenerateRandomString(6)}"; + var paramParts = parameters.Split(MSBuildConstants.SemicolonChar, StringSplitOptions.RemoveEmptyEntries); + var nonPathParams = new List(); + + foreach (var parameter in paramParts) + { + // Skip file path parameters + if (TryInterpretPathParameterStatic(parameter, out _)) + { + continue; + } + + // This is a configuration parameter (like ProjectImports=None, OmitInitialInfo, etc.) + nonPathParams.Add(parameter); + } + + // Sort for consistent comparison + nonPathParams.Sort(StringComparer.OrdinalIgnoreCase); + return string.Join(";", nonPathParams); + } + + /// + /// Result of processing multiple binary logger parameter sets. + /// + public readonly struct ProcessedBinaryLoggerParameters + { + /// + /// List of distinct parameter sets that need separate logger instances. + /// + public IReadOnlyList DistinctParameterSets { get; } + + /// + /// If true, all parameter sets have identical configurations (only file paths differ), + /// so a single logger can be used with file copying for additional paths. + /// + public bool AllConfigurationsIdentical { get; } + + /// + /// Additional file paths to copy the binlog to (only valid when AllConfigurationsIdentical is true). + /// + public IReadOnlyList AdditionalFilePaths { get; } + + /// + /// List of duplicate file paths that were filtered out. + /// + public IReadOnlyList DuplicateFilePaths { get; } + + /// + /// Initializes a new instance of the struct. + /// + /// List of distinct parameter sets that need separate logger instances. + /// Whether all parameter sets have identical configurations. + /// Additional file paths to copy the binlog to. + /// List of duplicate file paths that were filtered out. + public ProcessedBinaryLoggerParameters( + IReadOnlyList distinctParameterSets, + bool allConfigurationsIdentical, + IReadOnlyList additionalFilePaths, + IReadOnlyList duplicateFilePaths) + { + DistinctParameterSets = distinctParameterSets; + AllConfigurationsIdentical = allConfigurationsIdentical; + AdditionalFilePaths = additionalFilePaths; + DuplicateFilePaths = duplicateFilePaths; + } + } + + /// + /// Processes multiple binary logger parameter sets and returns distinct paths and configuration info. + /// + /// Array of parameter strings from command line + /// Processed result with distinct parameter sets and configuration info + public static ProcessedBinaryLoggerParameters ProcessParameters(string[] binaryLoggerParameters) + { + var distinctParameterSets = new List(); + var additionalFilePaths = new List(); + var duplicateFilePaths = new List(); + bool allConfigurationsIdentical = true; + + if (binaryLoggerParameters == null || binaryLoggerParameters.Length == 0) + { + return new ProcessedBinaryLoggerParameters(distinctParameterSets, allConfigurationsIdentical, additionalFilePaths, duplicateFilePaths); + } + + if (binaryLoggerParameters.Length == 1) + { + distinctParameterSets.Add(binaryLoggerParameters[0]); + return new ProcessedBinaryLoggerParameters(distinctParameterSets, allConfigurationsIdentical, additionalFilePaths, duplicateFilePaths); + } + + string primaryArguments = binaryLoggerParameters[0]; + string primaryNonPathParams = ExtractNonPathParameters(primaryArguments); + + var distinctFilePaths = new HashSet(StringComparer.OrdinalIgnoreCase); + var extractedFilePaths = new List(); + + // Check if all parameter sets have the same non-path configuration + for (int i = 0; i < binaryLoggerParameters.Length; i++) + { + string currentParams = binaryLoggerParameters[i]; + string currentNonPathParams = ExtractNonPathParameters(currentParams); + string currentFilePath = ExtractFilePathFromParameters(currentParams); + + // Check if this is a duplicate file path + if (distinctFilePaths.Add(currentFilePath)) + { + if (!string.Equals(primaryNonPathParams, currentNonPathParams, StringComparison.OrdinalIgnoreCase)) + { + allConfigurationsIdentical = false; + } + distinctParameterSets.Add(currentParams); + extractedFilePaths.Add(currentFilePath); + } + else + { + // Track duplicate paths for logging + duplicateFilePaths.Add(currentFilePath); + } + } + + // If all configurations are identical, compute additional file paths for copying + // Use the pre-extracted paths to avoid redundant ExtractFilePathFromParameters calls + if (allConfigurationsIdentical && distinctParameterSets.Count > 1) + { + for (int i = 1; i < extractedFilePaths.Count; i++) + { + additionalFilePaths.Add(extractedFilePaths[i]); + } + } + + return new ProcessedBinaryLoggerParameters(distinctParameterSets, allConfigurationsIdentical, additionalFilePaths, duplicateFilePaths); + } } } diff --git a/src/Build/Resources/Strings.resx b/src/Build/Resources/Strings.resx index 401757434dc..1ea24d63df3 100644 --- a/src/Build/Resources/Strings.resx +++ b/src/Build/Resources/Strings.resx @@ -2444,6 +2444,10 @@ Utilization: {0} Average Utilization: {1:###.0} The directory does not exist: {0}. .NET Runtime Task Host could not be instantiated. See https://aka.ms/nettaskhost for details on how to resolve this error. + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + The custom task '{0}' required a fallback to out-of-process execution because the UsingTask definition does not specify the correct Runtime and Architecture. This reduces build performance. Update the UsingTask element to explicitly specify Runtime and Architecture attributes (e.g., Runtime="CLR4" Architecture="x64") or use TaskFactory="TaskHostFactory". @@ -2454,7 +2458,7 @@ Utilization: {0} Average Utilization: {1:###.0} diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index ff718145e90..72d6d7fda24 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -489,6 +489,11 @@ Číst proměnnou prostředí {0} + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: Při čtení vstupních souborů mezipaměti pro výsledky z cesty {0} byla zjištěna chyba: {1} diff --git a/src/Build/Resources/xlf/Strings.de.xlf b/src/Build/Resources/xlf/Strings.de.xlf index 4dc35395ed0..2a77ed9ff61 100644 --- a/src/Build/Resources/xlf/Strings.de.xlf +++ b/src/Build/Resources/xlf/Strings.de.xlf @@ -489,6 +489,11 @@ Umgebungsvariable "{0}" lesen + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: Beim Lesen der Cachedateien für Eingabeergebnisse aus dem Pfad "{0}" wurde ein Fehler festgestellt: {1} diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index 83da74d37bd..eb658d3565f 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -489,6 +489,11 @@ Leer la variable de entorno "{0}" + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: Error al leer los archivos de caché de resultados de entrada en la ruta de acceso "{0}": {1} diff --git a/src/Build/Resources/xlf/Strings.fr.xlf b/src/Build/Resources/xlf/Strings.fr.xlf index 099af04b766..25e3980f51b 100644 --- a/src/Build/Resources/xlf/Strings.fr.xlf +++ b/src/Build/Resources/xlf/Strings.fr.xlf @@ -489,6 +489,11 @@ Lire la variable d'environnement "{0}" + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: La lecture des fichiers cache des résultats d'entrée à partir du chemin "{0}" a rencontré une erreur : {1} diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index 6b3e3262a52..239a9f429ce 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -489,6 +489,11 @@ Legge la variabile di ambiente "{0}" + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: durante la lettura dei file della cache dei risultati di input dal percorso "{0}" è stato rilevato un errore: {1} diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index 94bcb18f1bc..83ed22b46e0 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -489,6 +489,11 @@ 環境変数 "{0}" の読み取り + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: パス "{0}" から入力結果キャッシュ ファイルを読み取る処理でエラーが発生しました: {1} diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index f4d22bba8bf..fb99fabaddd 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -489,6 +489,11 @@ 환경 변수 "{0}" 읽기 + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: "{0}" 경로에서 입력 결과 캐시 파일을 읽는 중 오류가 발생했습니다. {1} diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index 7c3e380b213..a30525b6f35 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -489,6 +489,11 @@ Odczytaj zmienną środowiskową „{0}” + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: Podczas odczytywania plików wejściowej pamięci podręcznej wyników ze ścieżki „{0}” wystąpił błąd: {1} diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index 4f78d016570..dbbb7ef4630 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -489,6 +489,11 @@ Ler a variável de ambiente "{0}" + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: a leitura dos arquivos de cache do resultado de entrada do caminho "{0}" encontrou um erro: {1} diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index 991a56d8c3c..73a9a7142b6 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -489,6 +489,11 @@ Чтение переменной среды "{0}" + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: произошла ошибка при чтении входных файлов кэша результатов из пути "{0}": {1} diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index 536de415c1a..9e8bfab9b40 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -489,6 +489,11 @@ "{0}" ortam değişkenini oku + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: "{0}" yolundan giriş sonucu önbellek dosyaları okunurken bir hatayla karşılaşıldı: {1} diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index 27d8a4d45dd..347c0136d86 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -489,6 +489,11 @@ 读取环境变量“{0}” + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: 从路径“{0}”读取输入结果缓存文件时遇到错误: {1} diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index ce1875a9b4a..3ccdd81d1c3 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -489,6 +489,11 @@ 讀取環境變數 "{0}" + + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. + MSB4256: Reading input result cache files from path "{0}" encountered an error: {1} MSB4256: 從路徑 "{0}" 讀取輸入結果快取檔案發生錯誤: {1} diff --git a/src/MSBuild.UnitTests/XMake_Tests.cs b/src/MSBuild.UnitTests/XMake_Tests.cs index 3ebfcae6615..9ed990fc17c 100644 --- a/src/MSBuild.UnitTests/XMake_Tests.cs +++ b/src/MSBuild.UnitTests/XMake_Tests.cs @@ -2714,6 +2714,116 @@ public void BinaryLogContainsImportedFiles() archive.Entries.ShouldContain(e => e.FullName.EndsWith(".proj", StringComparison.OrdinalIgnoreCase), 2); } + [Fact] + public void MultipleBinaryLogsCreatesMultipleFiles() + { + var testProject = _env.CreateFile("TestProject.proj", @" + + + + + + "); + + string binLogLocation = _env.DefaultTestDirectory.Path; + string binLog1 = Path.Combine(binLogLocation, "1.binlog"); + string binLog2 = Path.Combine(binLogLocation, "2.binlog"); + string binLog3 = Path.Combine(binLogLocation, "3.binlog"); + + string output = RunnerUtilities.ExecMSBuild($"\"{testProject.Path}\" \"/bl:{binLog1}\" \"/bl:{binLog2}\" \"/bl:{binLog3}\"", out var success, _output); + + success.ShouldBeTrue(output); + + // Verify all three binlog files exist + File.Exists(binLog1).ShouldBeTrue("First binlog file should exist"); + File.Exists(binLog2).ShouldBeTrue("Second binlog file should exist"); + File.Exists(binLog3).ShouldBeTrue("Third binlog file should exist"); + + // Verify all files have content (are not empty) + new FileInfo(binLog1).Length.ShouldBeGreaterThan(0, "First binlog should not be empty"); + new FileInfo(binLog2).Length.ShouldBeGreaterThan(0, "Second binlog should not be empty"); + new FileInfo(binLog3).Length.ShouldBeGreaterThan(0, "Third binlog should not be empty"); + + // Verify all files are identical (have the same content) + byte[] file1Bytes = File.ReadAllBytes(binLog1); + byte[] file2Bytes = File.ReadAllBytes(binLog2); + byte[] file3Bytes = File.ReadAllBytes(binLog3); + + file1Bytes.SequenceEqual(file2Bytes).ShouldBeTrue("First and second binlog should be identical"); + file1Bytes.SequenceEqual(file3Bytes).ShouldBeTrue("First and third binlog should be identical"); + } + + [Fact] + public void MultipleBinaryLogsWithDuplicatesCreateDistinctFiles() + { + var testProject = _env.CreateFile("TestProject.proj", @" + + + + + + "); + + string binLogLocation = _env.DefaultTestDirectory.Path; + string binLog1 = Path.Combine(binLogLocation, "1.binlog"); + string binLog2 = Path.Combine(binLogLocation, "2.binlog"); + + // Specify binLog1 twice - should only create two distinct files + string output = RunnerUtilities.ExecMSBuild($"\"{testProject.Path}\" \"/bl:{binLog1}\" \"/bl:{binLog2}\" \"/bl:{binLog1}\"", out var success, _output); + + success.ShouldBeTrue(output); + + // Verify both binlog files exist + File.Exists(binLog1).ShouldBeTrue("First binlog file should exist"); + File.Exists(binLog2).ShouldBeTrue("Second binlog file should exist"); + + // Verify both files are identical + byte[] file1Bytes = File.ReadAllBytes(binLog1); + byte[] file2Bytes = File.ReadAllBytes(binLog2); + + file1Bytes.SequenceEqual(file2Bytes).ShouldBeTrue("Binlog files should be identical"); + } + + [Fact] + public void MultipleBinaryLogsWithDifferentConfigurationsCreatesSeparateLoggers() + { + var testProject = _env.CreateFile("TestProject.proj", @" + + + + + + + "); + + _env.CreateFile("Imported.proj", @" + + + Value + + + "); + + string binLogLocation = _env.DefaultTestDirectory.Path; + string binLog1 = Path.Combine(binLogLocation, "with-imports.binlog"); + string binLog2 = Path.Combine(binLogLocation, "no-imports.binlog"); + + // One with default imports, one with ProjectImports=None + string output = RunnerUtilities.ExecMSBuild($"\"{testProject.Path}\" \"/bl:{binLog1}\" \"/bl:{binLog2};ProjectImports=None\"", out var success, _output); + + success.ShouldBeTrue(output); + + // Verify both binlog files exist + File.Exists(binLog1).ShouldBeTrue("First binlog file should exist"); + File.Exists(binLog2).ShouldBeTrue("Second binlog file should exist"); + + // Verify files are different sizes (one has imports embedded, one doesn't) + long size1 = new FileInfo(binLog1).Length; + long size2 = new FileInfo(binLog2).Length; + + size1.ShouldBeGreaterThan(size2, "Binlog with imports should be larger than one without"); + } + [Theory] [InlineData("-warnaserror", "", "", false)] [InlineData("-warnaserror -warnnotaserror:FOR123", "", "", true)] diff --git a/src/MSBuild/Resources/Strings.resx b/src/MSBuild/Resources/Strings.resx index 701bb681d2c..0c9087351cb 100644 --- a/src/MSBuild/Resources/Strings.resx +++ b/src/MSBuild/Resources/Strings.resx @@ -1700,6 +1700,10 @@ 0: turned off + + Duplicate binary log path(s) specified and ignored: {0} + {0} is the list of duplicate paths that were filtered out + 7.3.0-preview.1.50 - 5.3.0-2.26051.1 + 5.4.0-2.26060.1 diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml index 421bb049256..895722f7c7b 100644 --- a/eng/Version.Details.xml +++ b/eng/Version.Details.xml @@ -114,9 +114,9 @@ https://github.com/nuget/nuget.client a99b70cf718ff7842466a7eaeefa99b471cad517 - + https://github.com/dotnet/roslyn - df7b5aaff073486376dad5d30b6d0ba45595d97d + 19f995da648f0afdaffe499200e9c50dc0568eb2 https://github.com/dotnet/arcade From 7c44a500079ad33f29b4c715618fc05cf2b94eaf Mon Sep 17 00:00:00 2001 From: "dotnet-maestro[bot]" <42748379+dotnet-maestro[bot]@users.noreply.github.com> Date: Mon, 12 Jan 2026 10:17:31 +0100 Subject: [PATCH 20/39] [main] Update dependencies from dotnet/arcade (#13000) This pull request updates the following dependencies [marker]: <> (Begin:369b758c-dad8-4fea-810a-64fb6b0308e9) ## From https://github.com/dotnet/arcade - **Subscription**: [369b758c-dad8-4fea-810a-64fb6b0308e9](https://maestro.dot.net/subscriptions?search=369b758c-dad8-4fea-810a-64fb6b0308e9) - **Build**: [20260107.1](https://dev.azure.com/dnceng/internal/_build/results?buildId=2873951) ([296298](https://maestro.dot.net/channel/8394/github:dotnet:arcade/build/296298)) - **Date Produced**: January 7, 2026 6:50:40 PM UTC - **Commit**: [13323fc374efc77953ec0ac9a0927da69f14a584](https://github.com/dotnet/arcade/commit/13323fc374efc77953ec0ac9a0927da69f14a584) - **Branch**: [release/10.0](https://github.com/dotnet/arcade/tree/release/10.0) [DependencyUpdate]: <> (Begin) - **Dependency Updates**: - From [10.0.0-beta.25626.5 to 10.0.0-beta.26057.1][1] - Microsoft.DotNet.Arcade.Sdk - Microsoft.DotNet.XUnitExtensions [1]: https://github.com/dotnet/arcade/compare/d8dca0b41b...13323fc374 [DependencyUpdate]: <> (End) [marker]: <> (End:369b758c-dad8-4fea-810a-64fb6b0308e9) Co-authored-by: dotnet-maestro[bot] --- eng/Version.Details.props | 4 ++-- eng/Version.Details.xml | 8 ++++---- global.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/eng/Version.Details.props b/eng/Version.Details.props index dfe3b8fe63a..524d1057291 100644 --- a/eng/Version.Details.props +++ b/eng/Version.Details.props @@ -24,8 +24,8 @@ This file should be imported by eng/Versions.props 9.0.11 9.0.11 - 10.0.0-beta.25626.5 - 10.0.0-beta.25626.5 + 10.0.0-beta.26057.1 + 10.0.0-beta.26057.1 7.3.0-preview.1.50 diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml index 895722f7c7b..c184cc7016d 100644 --- a/eng/Version.Details.xml +++ b/eng/Version.Details.xml @@ -106,9 +106,9 @@ - + https://github.com/dotnet/arcade - d8dca0b41b903e7182e64543773390b969dab96b + 13323fc374efc77953ec0ac9a0927da69f14a584 https://github.com/nuget/nuget.client @@ -118,9 +118,9 @@ https://github.com/dotnet/roslyn 19f995da648f0afdaffe499200e9c50dc0568eb2 - + https://github.com/dotnet/arcade - d8dca0b41b903e7182e64543773390b969dab96b + 13323fc374efc77953ec0ac9a0927da69f14a584 diff --git a/global.json b/global.json index 677476b7c8a..dde2fc4b3e7 100644 --- a/global.json +++ b/global.json @@ -14,6 +14,6 @@ "xcopy-msbuild": "18.0.0" }, "msbuild-sdks": { - "Microsoft.DotNet.Arcade.Sdk": "10.0.0-beta.25626.5" + "Microsoft.DotNet.Arcade.Sdk": "10.0.0-beta.26057.1" } } From 7cf4f244e4cf00fa6cd090a97e5607762d9330ae Mon Sep 17 00:00:00 2001 From: dotnet bot Date: Mon, 12 Jan 2026 11:27:13 +0100 Subject: [PATCH 21/39] Localized file check-in by OneLocBuild Task: Build definition ID 9434: Build ID 13078382 (#13003) This is the pull request automatically created by the OneLocBuild task in the build process to check-in localized files generated based upon translation source files (.lcl files) handed-back from the downstream localization pipeline. If there are issues in translations, visit https://aka.ms/icxLocBug and log bugs for fixes. The OneLocBuild wiki is https://aka.ms/onelocbuild and the localization process in general is documented at https://aka.ms/AllAboutLoc. --- src/Build/Resources/xlf/Strings.cs.xlf | 2 +- src/Build/Resources/xlf/Strings.de.xlf | 2 +- src/Build/Resources/xlf/Strings.es.xlf | 2 +- src/Build/Resources/xlf/Strings.fr.xlf | 2 +- src/Build/Resources/xlf/Strings.it.xlf | 2 +- src/Build/Resources/xlf/Strings.ja.xlf | 2 +- src/Build/Resources/xlf/Strings.ko.xlf | 2 +- src/Build/Resources/xlf/Strings.pl.xlf | 2 +- src/Build/Resources/xlf/Strings.pt-BR.xlf | 2 +- src/Build/Resources/xlf/Strings.ru.xlf | 2 +- src/Build/Resources/xlf/Strings.tr.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hans.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hant.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.cs.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.de.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.es.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.fr.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.it.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.ja.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.ko.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.pl.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.pt-BR.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.ru.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.tr.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf | 2 +- 26 files changed, 26 insertions(+), 26 deletions(-) diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index 72d6d7fda24..9ab02afe3bc 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Nepodařilo se zkopírovat binární protokol z {0} do {1}. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.de.xlf b/src/Build/Resources/xlf/Strings.de.xlf index 2a77ed9ff61..5ce46079b62 100644 --- a/src/Build/Resources/xlf/Strings.de.xlf +++ b/src/Build/Resources/xlf/Strings.de.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Fehler beim Kopieren des Binärprotokolls von „{0}“ nach „{1}“. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index eb658d3565f..a72490d50a5 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: no se pudo copiar el registro binario de "{0}" a "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.fr.xlf b/src/Build/Resources/xlf/Strings.fr.xlf index 25e3980f51b..9264bfb3118 100644 --- a/src/Build/Resources/xlf/Strings.fr.xlf +++ b/src/Build/Resources/xlf/Strings.fr.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Échec de la copie du journal binaire de « {0} » vers « {1} ». {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index 239a9f429ce..c3a339f9aba 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: non è possibile copiare il log binario da "{0}" a "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index 83ed22b46e0..bab87c64b11 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: バイナリ ログを "{0}" から "{1}" にコピーできませんでした。{2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index fb99fabaddd..8fbaf0b2a79 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: 이진 로그를 "{0}"에서 "{1}"(으)로 복사하지 못했습니다. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index a30525b6f35..5468c688eba 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: nie można skopiować dziennika binarnego z „{0}” do „{1}”. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index dbbb7ef4630..f7957c45cda 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: falha ao copiar o log binário de "{0}" para "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index 73a9a7142b6..4b309e0cc21 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: не удалось скопировать двоичный журнал из "{0}" в "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index 9e8bfab9b40..87f9b73cded 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: İkili günlük dosyası "{0}" konumundan "{1}" konumuna kopyalanamadı. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index 347c0136d86..ad7d1118c48 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: 未能将二进制日志从“{0}”复制到“{1}”。{2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index 3ccdd81d1c3..6a78af31da7 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: 無法將二進位記錄從 "{0}" 複製到 "{1}"。{2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/MSBuild/Resources/xlf/Strings.cs.xlf b/src/MSBuild/Resources/xlf/Strings.cs.xlf index ea1c9af0865..6f21a13ec84 100644 --- a/src/MSBuild/Resources/xlf/Strings.cs.xlf +++ b/src/MSBuild/Resources/xlf/Strings.cs.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Byly zadány duplicitní cesty k binárnímu protokolu a byly ignorovány: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.de.xlf b/src/MSBuild/Resources/xlf/Strings.de.xlf index d277625243c..71d5bf1961e 100644 --- a/src/MSBuild/Resources/xlf/Strings.de.xlf +++ b/src/MSBuild/Resources/xlf/Strings.de.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Doppelte Binärprotokollpfade angegeben und ignoriert: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.es.xlf b/src/MSBuild/Resources/xlf/Strings.es.xlf index c496cf46e2d..f67f93029d0 100644 --- a/src/MSBuild/Resources/xlf/Strings.es.xlf +++ b/src/MSBuild/Resources/xlf/Strings.es.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Rutas de registro binarias duplicadas especificadas y omitidas: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.fr.xlf b/src/MSBuild/Resources/xlf/Strings.fr.xlf index 8039a05a801..027581abd70 100644 --- a/src/MSBuild/Resources/xlf/Strings.fr.xlf +++ b/src/MSBuild/Resources/xlf/Strings.fr.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Chemins d'accès aux journaux binaires en double spécifiés et ignorés : {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.it.xlf b/src/MSBuild/Resources/xlf/Strings.it.xlf index ee3d5e2ece3..6642ab382c0 100644 --- a/src/MSBuild/Resources/xlf/Strings.it.xlf +++ b/src/MSBuild/Resources/xlf/Strings.it.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Percorsi di log binari duplicati specificati e ignorati: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.ja.xlf b/src/MSBuild/Resources/xlf/Strings.ja.xlf index 258007a9cd5..581a5984de9 100644 --- a/src/MSBuild/Resources/xlf/Strings.ja.xlf +++ b/src/MSBuild/Resources/xlf/Strings.ja.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + 重複するバイナリ ログ パスが指定され、次は無視されました: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.ko.xlf b/src/MSBuild/Resources/xlf/Strings.ko.xlf index 458571989d5..acdf0b64430 100644 --- a/src/MSBuild/Resources/xlf/Strings.ko.xlf +++ b/src/MSBuild/Resources/xlf/Strings.ko.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + 중복된 이진 로그 경로가 지정되어 무시되었습니다. {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.pl.xlf b/src/MSBuild/Resources/xlf/Strings.pl.xlf index 5595625058b..ad0cfa8541a 100644 --- a/src/MSBuild/Resources/xlf/Strings.pl.xlf +++ b/src/MSBuild/Resources/xlf/Strings.pl.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Określono i zignorowano zduplikowane ścieżki dziennika binarnego: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf b/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf index d8e3b837ab7..5be904253d7 100644 --- a/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf +++ b/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Caminhos de log binários duplicados especificados e ignorados: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.ru.xlf b/src/MSBuild/Resources/xlf/Strings.ru.xlf index ec3c590fbef..93bd4c31f7c 100644 --- a/src/MSBuild/Resources/xlf/Strings.ru.xlf +++ b/src/MSBuild/Resources/xlf/Strings.ru.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Указаны повторяющиеся пути к двоичным журналам, которые были проигнорированы: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.tr.xlf b/src/MSBuild/Resources/xlf/Strings.tr.xlf index 48ac3f29662..aed787a4237 100644 --- a/src/MSBuild/Resources/xlf/Strings.tr.xlf +++ b/src/MSBuild/Resources/xlf/Strings.tr.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Belirtilen ve yok sayılan yinelenen ikili günlük yolları: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf b/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf index 1c65f65c573..b02080e6e1d 100644 --- a/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + 指定且忽略的重复二进制日志路径: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf b/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf index ce88819310e..2be999c8a3e 100644 --- a/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + 指定了重複的二進位記錄路徑，並已忽略: {0} {0} is the list of duplicate paths that were filtered out From 6ef3f7b7870b0cdecd9773d4c7b3c58f206f554b Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 12 Jan 2026 13:19:02 +0100 Subject: [PATCH 22/39] Add telemetry tracking for task factory names and runtime usage (#12989) --- .../BackEnd/ProjectTelemetry_Tests.cs | 36 ++++---- .../Telemetry/Telemetry_Tests.cs | 88 +++++++++++++++++++ .../Components/Logging/ProjectTelemetry.cs | 77 ++++++---------- .../RequestBuilder/RequestBuilder.cs | 10 ++- .../TelemetryInfra/ITelemetryForwarder.cs | 4 +- .../InternalTelemetryConsumingLogger.cs | 3 + .../TelemetryForwarderProvider.cs | 7 +- .../WorkerNodeTelemetryEventArgs_Tests.cs | 6 +- src/Framework/Telemetry/TaskExecutionStats.cs | 36 ++++++-- src/Framework/Telemetry/TelemetryDataUtils.cs | 34 ++++++- .../Telemetry/WorkerNodeTelemetryData.cs | 15 ++-- .../Telemetry/WorkerNodeTelemetryEventArgs.cs | 20 ++++- src/Framework/TelemetryEventArgs.cs | 1 + src/Tasks.UnitTests/TelemetryTaskTests.cs | 2 - 14 files changed, 238 insertions(+), 101 deletions(-) diff --git a/src/Build.UnitTests/BackEnd/ProjectTelemetry_Tests.cs b/src/Build.UnitTests/BackEnd/ProjectTelemetry_Tests.cs index 51d20a9b041..b56a59aa4fd 100644 --- a/src/Build.UnitTests/BackEnd/ProjectTelemetry_Tests.cs +++ b/src/Build.UnitTests/BackEnd/ProjectTelemetry_Tests.cs @@ -23,12 +23,12 @@ public class ProjectTelemetry_Tests public void TrackTaskSubclassing_TracksSealedTasks() { var telemetry = new ProjectTelemetry(); - + // Sealed task should be tracked if it derives from Microsoft task telemetry.TrackTaskSubclassing(typeof(TestSealedTask), isMicrosoftOwned: false); - + var properties = GetMSBuildTaskSubclassProperties(telemetry); - + // Should track sealed tasks that inherit from Microsoft tasks properties.Count.ShouldBe(1); properties.ShouldContainKey("Microsoft_Build_Utilities_Task"); @@ -42,12 +42,12 @@ public void TrackTaskSubclassing_TracksSealedTasks() public void TrackTaskSubclassing_TracksSubclass() { var telemetry = new ProjectTelemetry(); - + // User task inheriting from Microsoft.Build.Utilities.Task telemetry.TrackTaskSubclassing(typeof(UserTask), isMicrosoftOwned: false); - + var properties = GetMSBuildTaskSubclassProperties(telemetry); - + // Should track the Microsoft.Build.Utilities.Task base class properties.Count.ShouldBe(1); properties.ShouldContainKey("Microsoft_Build_Utilities_Task"); @@ -61,12 +61,12 @@ public void TrackTaskSubclassing_TracksSubclass() public void TrackTaskSubclassing_IgnoresMicrosoftOwnedTasks() { var telemetry = new ProjectTelemetry(); - + // Microsoft-owned task should not be tracked even if non-sealed telemetry.TrackTaskSubclassing(typeof(UserTask), isMicrosoftOwned: true); - + var properties = GetMSBuildTaskSubclassProperties(telemetry); - + // Should not track Microsoft-owned tasks properties.Count.ShouldBe(0); } @@ -78,13 +78,13 @@ public void TrackTaskSubclassing_IgnoresMicrosoftOwnedTasks() public void TrackTaskSubclassing_TracksMultipleSubclasses() { var telemetry = new ProjectTelemetry(); - + // Track multiple user tasks telemetry.TrackTaskSubclassing(typeof(UserTask), isMicrosoftOwned: false); telemetry.TrackTaskSubclassing(typeof(AnotherUserTask), isMicrosoftOwned: false); - + var properties = GetMSBuildTaskSubclassProperties(telemetry); - + // Should aggregate counts for the same base class properties.Count.ShouldBe(1); properties["Microsoft_Build_Utilities_Task"].ShouldBe("2"); @@ -97,13 +97,13 @@ public void TrackTaskSubclassing_TracksMultipleSubclasses() public void TrackTaskSubclassing_HandlesNull() { var telemetry = new ProjectTelemetry(); - + #pragma warning disable CS8625 // Cannot convert null literal to non-nullable reference type telemetry.TrackTaskSubclassing(null, isMicrosoftOwned: false); #pragma warning restore CS8625 - + var properties = GetMSBuildTaskSubclassProperties(telemetry); - + properties.Count.ShouldBe(0); } @@ -112,7 +112,7 @@ public void TrackTaskSubclassing_HandlesNull() /// private System.Collections.Generic.Dictionary GetMSBuildTaskSubclassProperties(ProjectTelemetry telemetry) { - var method = typeof(ProjectTelemetry).GetMethod("GetMSBuildTaskSubclassProperties", + var method = typeof(ProjectTelemetry).GetMethod("GetMSBuildTaskSubclassProperties", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance); return (System.Collections.Generic.Dictionary)method!.Invoke(telemetry, null)!; } @@ -169,7 +169,7 @@ public void MSBuildTaskTelemetry_IsLoggedDuringBuild() var events = new System.Collections.Generic.List(); var logger = new Microsoft.Build.Logging.ConsoleLogger(LoggerVerbosity.Diagnostic); - + using var projectCollection = new ProjectCollection(); using var stringReader = new System.IO.StringReader(projectContent); using var xmlReader = System.Xml.XmlReader.Create(stringReader); @@ -177,7 +177,7 @@ public void MSBuildTaskTelemetry_IsLoggedDuringBuild() // Build the project var result = project.Build(); - + result.ShouldBeTrue(); } } diff --git a/src/Build.UnitTests/Telemetry/Telemetry_Tests.cs b/src/Build.UnitTests/Telemetry/Telemetry_Tests.cs index fb2459d683b..de1f2c063d6 100644 --- a/src/Build.UnitTests/Telemetry/Telemetry_Tests.cs +++ b/src/Build.UnitTests/Telemetry/Telemetry_Tests.cs @@ -148,6 +148,90 @@ public void WorkerNodeTelemetryCollection_CustomTargetsAndTasks() workerNodeData.TasksExecutionData.Keys.ShouldAllBe(k => !k.IsNuget); } + [Fact] + public void WorkerNodeTelemetryCollection_TaskFactoryName() + { + WorkerNodeTelemetryData? workerNodeData = null; + InternalTelemetryConsumingLogger.TestOnly_InternalTelemetryAggregted += dt => workerNodeData = dt; + + var testProject = """ + + + + + + Log.LogMessage(MessageImportance.Low, "Hello from inline task!"); + + + + + + + + + """; + + MockLogger logger = new MockLogger(_output); + Helpers.BuildProjectContentUsingBuildManager( + testProject, + logger, + new BuildParameters() { IsTelemetryEnabled = true }).OverallResult.ShouldBe(BuildResultCode.Success); + + workerNodeData!.ShouldNotBeNull(); + + // Verify built-in task has AssemblyTaskFactory + var messageTaskKey = (TaskOrTargetTelemetryKey)"Microsoft.Build.Tasks.Message"; + workerNodeData.TasksExecutionData.ShouldContainKey(messageTaskKey); + workerNodeData.TasksExecutionData[messageTaskKey].TaskFactoryName.ShouldBe("AssemblyTaskFactory"); + + // Verify inline task has RoslynCodeTaskFactory + var inlineTaskKey = new TaskOrTargetTelemetryKey("InlineTask01", true, false); + workerNodeData.TasksExecutionData.ShouldContainKey(inlineTaskKey); + workerNodeData.TasksExecutionData[inlineTaskKey].TaskFactoryName.ShouldBe("RoslynCodeTaskFactory"); + workerNodeData.TasksExecutionData[inlineTaskKey].ExecutionsCount.ShouldBe(1); + } + + [Fact] + public void TelemetryDataUtils_HashesCustomFactoryName() + { + // Create telemetry data with a custom factory name + var tasksData = new Dictionary + { + { new TaskOrTargetTelemetryKey("CustomTask", true, false), new TaskExecutionStats(TimeSpan.FromMilliseconds(100), 1, 1000, "MyCompany.CustomTaskFactory", null) }, + { new TaskOrTargetTelemetryKey("BuiltInTask", false, false), new TaskExecutionStats(TimeSpan.FromMilliseconds(50), 2, 500, "AssemblyTaskFactory", null) }, + { new TaskOrTargetTelemetryKey("InlineTask", true, false), new TaskExecutionStats(TimeSpan.FromMilliseconds(75), 1, 750, "RoslynCodeTaskFactory", "CLR4") } + }; + var targetsData = new Dictionary(); + var telemetryData = new WorkerNodeTelemetryData(tasksData, targetsData); + + var activityData = telemetryData.AsActivityDataHolder(includeTasksDetails: true, includeTargetDetails: false); + activityData.ShouldNotBeNull(); + + var properties = activityData.GetActivityProperties(); + properties.ShouldContainKey("Tasks"); + + var taskDetails = properties["Tasks"] as List; + taskDetails.ShouldNotBeNull(); + + // Custom factory name should be hashed + var customTask = taskDetails!.FirstOrDefault(t => t.IsCustom && t.Name != GetHashed("InlineTask")); + customTask.ShouldNotBeNull(); + customTask!.FactoryName.ShouldBe(GetHashed("MyCompany.CustomTaskFactory")); + + // Known factory names should NOT be hashed + var builtInTask = taskDetails.FirstOrDefault(t => !t.IsCustom); + builtInTask.ShouldNotBeNull(); + builtInTask!.FactoryName.ShouldBe("AssemblyTaskFactory"); + + var inlineTask = taskDetails.FirstOrDefault(t => t.FactoryName == "RoslynCodeTaskFactory"); + inlineTask.ShouldNotBeNull(); + inlineTask!.FactoryName.ShouldBe("RoslynCodeTaskFactory"); + inlineTask.TaskHostRuntime.ShouldBe("CLR4"); + } + #if NET // test in .net core with telemetry opted in to avoid sending it but enable listening to it [Fact] @@ -263,6 +347,10 @@ public void NodeTelemetryE2E() createItemTaskData.TotalMilliseconds.ShouldBeGreaterThan(0); createItemTaskData.TotalMemoryBytes.ShouldBeGreaterThanOrEqualTo(0); + // Verify TaskFactoryName is populated for built-in tasks + messageTaskData.FactoryName.ShouldBe("AssemblyTaskFactory"); + createItemTaskData.FactoryName.ShouldBe("AssemblyTaskFactory"); + // Verify Targets summary information var targetsSummaryTagObject = activity.TagObjects.FirstOrDefault(to => to.Key.Contains("VS.MSBuild.TargetsSummary")); var targetsSummary = targetsSummaryTagObject.Value as TargetsSummaryInfo; diff --git a/src/Build/BackEnd/Components/Logging/ProjectTelemetry.cs b/src/Build/BackEnd/Components/Logging/ProjectTelemetry.cs index 89984c15b9d..37bbc129150 100644 --- a/src/Build/BackEnd/Components/Logging/ProjectTelemetry.cs +++ b/src/Build/BackEnd/Components/Logging/ProjectTelemetry.cs @@ -99,19 +99,16 @@ public void TrackTaskSubclassing(Type taskType, bool isMicrosoftOwned) // Check if this base type is a Microsoft-owned task // We identify Microsoft tasks by checking if they're in the Microsoft.Build namespace string? baseTypeName = baseType.FullName; - if (!string.IsNullOrEmpty(baseTypeName) && - (baseTypeName.StartsWith("Microsoft.Build.Tasks.") || + if (!string.IsNullOrEmpty(baseTypeName) && + (baseTypeName.StartsWith("Microsoft.Build.Tasks.") || baseTypeName.StartsWith("Microsoft.Build.Utilities."))) { // This is a subclass of a Microsoft-owned task // Track it only if it's NOT itself Microsoft-owned (i.e., user-authored subclass) if (!isMicrosoftOwned) { - if (!_msbuildTaskSubclassUsage.ContainsKey(baseTypeName)) - { - _msbuildTaskSubclassUsage[baseTypeName] = 0; - } - _msbuildTaskSubclassUsage[baseTypeName]++; + _msbuildTaskSubclassUsage.TryGetValue(baseTypeName, out int count); + _msbuildTaskSubclassUsage[baseTypeName] = count + 1; } // Stop at the first Microsoft-owned base class we find break; @@ -162,7 +159,7 @@ public void LogProjectTelemetry(ILoggingService loggingService, BuildEventContex Clean(); } } - + private void Clean() { _assemblyTaskFactoryTasksExecutedCount = 0; @@ -177,39 +174,24 @@ private void Clean() _msbuildTaskSubclassUsage.Clear(); } + private static void AddCountIfNonZero(Dictionary properties, string propertyName, int count) + { + if (count > 0) + { + properties[propertyName] = count.ToString(CultureInfo.InvariantCulture); + } + } + private Dictionary GetTaskFactoryProperties() { Dictionary properties = new(); - if (_assemblyTaskFactoryTasksExecutedCount > 0) - { - properties["AssemblyTaskFactoryTasksExecutedCount"] = _assemblyTaskFactoryTasksExecutedCount.ToString(CultureInfo.InvariantCulture); - } - - if (_intrinsicTaskFactoryTasksExecutedCount > 0) - { - properties["IntrinsicTaskFactoryTasksExecutedCount"] = _intrinsicTaskFactoryTasksExecutedCount.ToString(CultureInfo.InvariantCulture); - } - - if (_codeTaskFactoryTasksExecutedCount > 0) - { - properties["CodeTaskFactoryTasksExecutedCount"] = _codeTaskFactoryTasksExecutedCount.ToString(CultureInfo.InvariantCulture); - } - - if (_roslynCodeTaskFactoryTasksExecutedCount > 0) - { - properties["RoslynCodeTaskFactoryTasksExecutedCount"] = _roslynCodeTaskFactoryTasksExecutedCount.ToString(CultureInfo.InvariantCulture); - } - - if (_xamlTaskFactoryTasksExecutedCount > 0) - { - properties["XamlTaskFactoryTasksExecutedCount"] = _xamlTaskFactoryTasksExecutedCount.ToString(CultureInfo.InvariantCulture); - } - - if (_customTaskFactoryTasksExecutedCount > 0) - { - properties["CustomTaskFactoryTasksExecutedCount"] = _customTaskFactoryTasksExecutedCount.ToString(CultureInfo.InvariantCulture); - } + AddCountIfNonZero(properties, "AssemblyTaskFactoryTasksExecutedCount", _assemblyTaskFactoryTasksExecutedCount); + AddCountIfNonZero(properties, "IntrinsicTaskFactoryTasksExecutedCount", _intrinsicTaskFactoryTasksExecutedCount); + AddCountIfNonZero(properties, "CodeTaskFactoryTasksExecutedCount", _codeTaskFactoryTasksExecutedCount); + AddCountIfNonZero(properties, "RoslynCodeTaskFactoryTasksExecutedCount", _roslynCodeTaskFactoryTasksExecutedCount); + AddCountIfNonZero(properties, "XamlTaskFactoryTasksExecutedCount", _xamlTaskFactoryTasksExecutedCount); + AddCountIfNonZero(properties, "CustomTaskFactoryTasksExecutedCount", _customTaskFactoryTasksExecutedCount); return properties; } @@ -217,23 +199,16 @@ private Dictionary GetTaskFactoryProperties() private Dictionary GetTaskProperties() { Dictionary properties = new(); - - var totalTasksExecuted = _assemblyTaskFactoryTasksExecutedCount + + + var totalTasksExecuted = _assemblyTaskFactoryTasksExecutedCount + _intrinsicTaskFactoryTasksExecutedCount + - _codeTaskFactoryTasksExecutedCount + + _codeTaskFactoryTasksExecutedCount + _roslynCodeTaskFactoryTasksExecutedCount + - _xamlTaskFactoryTasksExecutedCount + + _xamlTaskFactoryTasksExecutedCount + _customTaskFactoryTasksExecutedCount; - - if (totalTasksExecuted > 0) - { - properties["TasksExecutedCount"] = totalTasksExecuted.ToString(CultureInfo.InvariantCulture); - } - - if (_taskHostTasksExecutedCount > 0) - { - properties["TaskHostTasksExecutedCount"] = _taskHostTasksExecutedCount.ToString(CultureInfo.InvariantCulture); - } + + AddCountIfNonZero(properties, "TasksExecutedCount", totalTasksExecuted); + AddCountIfNonZero(properties, "TaskHostTasksExecutedCount", _taskHostTasksExecutedCount); return properties; } diff --git a/src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs b/src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs index f4eeca2c1ef..24dae3c05f3 100644 --- a/src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs +++ b/src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs @@ -1331,12 +1331,15 @@ void CollectTasksStats(TaskRegistry taskRegistry) foreach (TaskRegistry.RegisteredTaskRecord registeredTaskRecord in taskRegistry.TaskRegistrations.Values.SelectMany(record => record)) { - telemetryForwarder.AddTask(registeredTaskRecord.TaskIdentity.Name, + telemetryForwarder.AddTask( + registeredTaskRecord.TaskIdentity.Name, registeredTaskRecord.Statistics.ExecutedTime, registeredTaskRecord.Statistics.ExecutedCount, registeredTaskRecord.Statistics.TotalMemoryConsumption, registeredTaskRecord.ComputeIfCustom(), - registeredTaskRecord.IsFromNugetCache); + registeredTaskRecord.IsFromNugetCache, + registeredTaskRecord.TaskFactoryAttributeName, + registeredTaskRecord.TaskFactoryParameters.Runtime); registeredTaskRecord.Statistics.Reset(); } @@ -1345,8 +1348,7 @@ void CollectTasksStats(TaskRegistry taskRegistry) } } - private static bool IsMetaprojTargetPath(string targetPath) - => targetPath.EndsWith(".metaproj", StringComparison.OrdinalIgnoreCase); + private static bool IsMetaprojTargetPath(string targetPath) => targetPath.EndsWith(".metaproj", StringComparison.OrdinalIgnoreCase); /// /// Saves the current operating environment (working directory and environment variables) diff --git a/src/Build/TelemetryInfra/ITelemetryForwarder.cs b/src/Build/TelemetryInfra/ITelemetryForwarder.cs index 97735076593..98908828c52 100644 --- a/src/Build/TelemetryInfra/ITelemetryForwarder.cs +++ b/src/Build/TelemetryInfra/ITelemetryForwarder.cs @@ -20,7 +20,9 @@ void AddTask( short executionsCount, long totalMemoryConsumed, bool isCustom, - bool isFromNugetCache); + bool isFromNugetCache, + string? taskFactoryName, + string? taskHostRuntime); /// /// Add info about target execution to the telemetry. diff --git a/src/Build/TelemetryInfra/InternalTelemetryConsumingLogger.cs b/src/Build/TelemetryInfra/InternalTelemetryConsumingLogger.cs index d4a388d79ce..19feabfee3d 100644 --- a/src/Build/TelemetryInfra/InternalTelemetryConsumingLogger.cs +++ b/src/Build/TelemetryInfra/InternalTelemetryConsumingLogger.cs @@ -53,6 +53,7 @@ private void FlushDataIntoConsoleIfRequested() { Console.WriteLine($"{target.Key} : {target.Value}"); } + Console.WriteLine("=========================================="); Console.WriteLine($"Tasks: ({_workerNodeTelemetryData.TasksExecutionData.Count})"); Console.WriteLine("Custom tasks:"); @@ -60,12 +61,14 @@ private void FlushDataIntoConsoleIfRequested() { Console.WriteLine($"{task.Key}"); } + Console.WriteLine("=========================================="); Console.WriteLine("Tasks by time:"); foreach (var task in _workerNodeTelemetryData.TasksExecutionData.OrderByDescending(t => t.Value.CumulativeExecutionTime)) { Console.WriteLine($"{task.Key} - {task.Value.CumulativeExecutionTime}"); } + Console.WriteLine("=========================================="); Console.WriteLine("Tasks by memory consumption:"); foreach (var task in _workerNodeTelemetryData.TasksExecutionData.OrderByDescending(t => t.Value.TotalMemoryBytes)) diff --git a/src/Build/TelemetryInfra/TelemetryForwarderProvider.cs b/src/Build/TelemetryInfra/TelemetryForwarderProvider.cs index 717846204eb..3c832c5d515 100644 --- a/src/Build/TelemetryInfra/TelemetryForwarderProvider.cs +++ b/src/Build/TelemetryInfra/TelemetryForwarderProvider.cs @@ -55,10 +55,10 @@ public class TelemetryForwarder : ITelemetryForwarder // in future, this might be per event type public bool IsTelemetryCollected => true; - public void AddTask(string name, TimeSpan cumulativeExecutionTime, short executionsCount, long totalMemoryConsumed, bool isCustom, bool isFromNugetCache) + public void AddTask(string name, TimeSpan cumulativeExecutionTime, short executionsCount, long totalMemoryConsumed, bool isCustom, bool isFromNugetCache, string? taskFactoryName, string? taskHostRuntime) { var key = GetKey(name, isCustom, false, isFromNugetCache); - _workerNodeTelemetryData.AddTask(key, cumulativeExecutionTime, executionsCount, totalMemoryConsumed); + _workerNodeTelemetryData.AddTask(key, cumulativeExecutionTime, executionsCount, totalMemoryConsumed, taskFactoryName, taskHostRuntime); } public void AddTarget(string name, bool wasExecuted, bool isCustom, bool isMetaproj, bool isFromNugetCache) @@ -83,7 +83,8 @@ public class NullTelemetryForwarder : ITelemetryForwarder { public bool IsTelemetryCollected => false; - public void AddTask(string name, TimeSpan cumulativeExecutionTime, short executionsCount, long totalMemoryConsumed, bool isCustom, bool isFromNugetCache) { } + public void AddTask(string name, TimeSpan cumulativeExecutionTime, short executionsCount, long totalMemoryConsumed, bool isCustom, bool isFromNugetCache, string? taskFactoryName, string? taskHostRuntime) { } + public void AddTarget(string name, bool wasExecuted, bool isCustom, bool isMetaproj, bool isFromNugetCache) { } public void FinalizeProcessing(LoggingContext loggingContext) { } diff --git a/src/Framework.UnitTests/WorkerNodeTelemetryEventArgs_Tests.cs b/src/Framework.UnitTests/WorkerNodeTelemetryEventArgs_Tests.cs index 930ce27b496..651d0446b5d 100644 --- a/src/Framework.UnitTests/WorkerNodeTelemetryEventArgs_Tests.cs +++ b/src/Framework.UnitTests/WorkerNodeTelemetryEventArgs_Tests.cs @@ -18,9 +18,9 @@ public void SerializationDeserializationTest() WorkerNodeTelemetryData td = new WorkerNodeTelemetryData( new Dictionary() { - { (TaskOrTargetTelemetryKey)"task1", new TaskExecutionStats(TimeSpan.FromMinutes(1), 5, 1234) }, - { (TaskOrTargetTelemetryKey)"task2", new TaskExecutionStats(TimeSpan.Zero, 0, 0) }, - { (TaskOrTargetTelemetryKey)"task3", new TaskExecutionStats(TimeSpan.FromTicks(1234), 12, 987654321) } + { (TaskOrTargetTelemetryKey)"task1", new TaskExecutionStats(TimeSpan.FromMinutes(1), 5, 1234, "AssemblyTaskFactory", "CLR4") }, + { (TaskOrTargetTelemetryKey)"task2", new TaskExecutionStats(TimeSpan.Zero, 0, 0, null, null) }, + { (TaskOrTargetTelemetryKey)"task3", new TaskExecutionStats(TimeSpan.FromTicks(1234), 12, 987654321, "CodeTaskFactory", "NET") } }, new Dictionary() { { (TaskOrTargetTelemetryKey)"target1", false }, { (TaskOrTargetTelemetryKey)"target2", true }, }); diff --git a/src/Framework/Telemetry/TaskExecutionStats.cs b/src/Framework/Telemetry/TaskExecutionStats.cs index 533599734fd..a9dac1ab4bb 100644 --- a/src/Framework/Telemetry/TaskExecutionStats.cs +++ b/src/Framework/Telemetry/TaskExecutionStats.cs @@ -8,10 +8,15 @@ namespace Microsoft.Build.Framework.Telemetry; /// /// Represents the execution statistics of tasks executed on a node. /// -internal class TaskExecutionStats(TimeSpan cumulativeExecutionTime, int executionsCount, long totalMemoryConsumption) +internal class TaskExecutionStats( + TimeSpan cumulativeExecutionTime, + int executionsCount, + long totalMemoryConsumption, + string? taskFactoryName, + string? taskHostRuntime) { private TaskExecutionStats() - : this(TimeSpan.Zero, 0, 0) + : this(TimeSpan.Zero, 0, 0, null, null) { } /// @@ -36,15 +41,30 @@ internal static TaskExecutionStats CreateEmpty() /// public int ExecutionsCount { get; set; } = executionsCount; + /// + /// The name of the task factory used to create this task. + /// Examples: AssemblyTaskFactory, IntrinsicTaskFactory, CodeTaskFactory, + /// RoslynCodeTaskFactory, XamlTaskFactory, or a custom factory name. + /// + public string? TaskFactoryName { get; set; } = taskFactoryName; + + /// + /// The runtime specified for out-of-process task execution. + /// Values: "CLR2", "CLR4", "NET", or null if not specified. + /// + public string? TaskHostRuntime { get; set; } = taskHostRuntime; + /// /// Accumulates statistics from another instance into this one. /// /// Statistics to add to this instance. internal void Accumulate(TaskExecutionStats other) { - this.CumulativeExecutionTime += other.CumulativeExecutionTime; - this.TotalMemoryBytes += other.TotalMemoryBytes; - this.ExecutionsCount += other.ExecutionsCount; + CumulativeExecutionTime += other.CumulativeExecutionTime; + TotalMemoryBytes += other.TotalMemoryBytes; + ExecutionsCount += other.ExecutionsCount; + TaskFactoryName ??= other.TaskFactoryName; + TaskHostRuntime ??= other.TaskHostRuntime; } // We need custom Equals for easier assertions in tests @@ -60,7 +80,9 @@ public override bool Equals(object? obj) protected bool Equals(TaskExecutionStats other) => CumulativeExecutionTime.Equals(other.CumulativeExecutionTime) && TotalMemoryBytes == other.TotalMemoryBytes && - ExecutionsCount == other.ExecutionsCount; + ExecutionsCount == other.ExecutionsCount && + TaskFactoryName == other.TaskFactoryName && + TaskHostRuntime == other.TaskHostRuntime; // Needed since we override Equals public override int GetHashCode() @@ -70,6 +92,8 @@ public override int GetHashCode() var hashCode = CumulativeExecutionTime.GetHashCode(); hashCode = (hashCode * 397) ^ TotalMemoryBytes.GetHashCode(); hashCode = (hashCode * 397) ^ ExecutionsCount.GetHashCode(); + hashCode = (hashCode * 397) ^ (TaskFactoryName?.GetHashCode() ?? 0); + hashCode = (hashCode * 397) ^ (TaskHostRuntime?.GetHashCode() ?? 0); return hashCode; } } diff --git a/src/Framework/Telemetry/TelemetryDataUtils.cs b/src/Framework/Telemetry/TelemetryDataUtils.cs index b7202bd897b..66a56c8f497 100644 --- a/src/Framework/Telemetry/TelemetryDataUtils.cs +++ b/src/Framework/Telemetry/TelemetryDataUtils.cs @@ -1,6 +1,7 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +using System; using System.Collections.Generic; using System.Security.Cryptography; using System.Text; @@ -10,6 +11,19 @@ namespace Microsoft.Build.Framework.Telemetry { internal static class TelemetryDataUtils { + /// + /// Known Microsoft task factory type names that should not be hashed. + /// + private static readonly HashSet KnownTaskFactoryNames = new(StringComparer.Ordinal) + { + "AssemblyTaskFactory", + "TaskHostFactory", + "CodeTaskFactory", + "RoslynCodeTaskFactory", + "XamlTaskFactory", + "IntrinsicTaskFactory", + }; + /// /// Transforms collected telemetry data to format recognized by the telemetry infrastructure. /// @@ -76,6 +90,7 @@ private static List GetTasksDetails( foreach (KeyValuePair valuePair in tasksDetails) { string taskName = valuePair.Key.IsCustom ? GetHashed(valuePair.Key.Name) : valuePair.Key.Name; + string? factoryName = GetFactoryNameForTelemetry(valuePair.Value.TaskFactoryName); result.Add(new TaskDetailInfo( taskName, @@ -83,12 +98,27 @@ private static List GetTasksDetails( valuePair.Value.ExecutionsCount, valuePair.Value.TotalMemoryBytes, valuePair.Key.IsCustom, - valuePair.Key.IsNuget)); + valuePair.Key.IsNuget, + factoryName, + valuePair.Value.TaskHostRuntime)); } return result; } + /// + /// Gets the factory name for telemetry, hashing custom factory names. + /// + private static string? GetFactoryNameForTelemetry(string? factoryName) + { + if (string.IsNullOrEmpty(factoryName)) + { + return null; + } + + return KnownTaskFactoryNames.Contains(factoryName!) ? factoryName : GetHashed(factoryName!); + } + /// /// Depending on the platform, hash the value using an available mechanism. /// @@ -130,7 +160,7 @@ public static string Hash(string text) } } - internal record TaskDetailInfo(string Name, double TotalMilliseconds, int ExecutionsCount, long TotalMemoryBytes, bool IsCustom, bool IsNuget); + internal record TaskDetailInfo(string Name, double TotalMilliseconds, int ExecutionsCount, long TotalMemoryBytes, bool IsCustom, bool IsNuget, string? FactoryName, string? TaskHostRuntime); /// /// Converts targets summary to a custom object for telemetry. diff --git a/src/Framework/Telemetry/WorkerNodeTelemetryData.cs b/src/Framework/Telemetry/WorkerNodeTelemetryData.cs index d643045ffe6..ae143f52ed4 100644 --- a/src/Framework/Telemetry/WorkerNodeTelemetryData.cs +++ b/src/Framework/Telemetry/WorkerNodeTelemetryData.cs @@ -18,7 +18,7 @@ public void Add(IWorkerNodeTelemetryData other) { foreach (var task in other.TasksExecutionData) { - AddTask(task.Key, task.Value.CumulativeExecutionTime, task.Value.ExecutionsCount, task.Value.TotalMemoryBytes); + AddTask(task.Key, task.Value.CumulativeExecutionTime, task.Value.ExecutionsCount, task.Value.TotalMemoryBytes, task.Value.TaskFactoryName, task.Value.TaskHostRuntime); } foreach (var target in other.TargetsExecutionData) @@ -27,19 +27,21 @@ public void Add(IWorkerNodeTelemetryData other) } } - public void AddTask(TaskOrTargetTelemetryKey task, TimeSpan cumulativeExectionTime, int executionsCount, long totalMemoryConsumption) + public void AddTask(TaskOrTargetTelemetryKey task, TimeSpan cumulativeExecutionTime, int executionsCount, long totalMemoryConsumption, string? factoryName, string? taskHostRuntime) { TaskExecutionStats? taskExecutionStats; if (!TasksExecutionData.TryGetValue(task, out taskExecutionStats)) { - taskExecutionStats = new(cumulativeExectionTime, executionsCount, totalMemoryConsumption); + taskExecutionStats = new(cumulativeExecutionTime, executionsCount, totalMemoryConsumption, factoryName, taskHostRuntime); TasksExecutionData[task] = taskExecutionStats; } else { - taskExecutionStats.CumulativeExecutionTime += cumulativeExectionTime; + taskExecutionStats.CumulativeExecutionTime += cumulativeExecutionTime; taskExecutionStats.ExecutionsCount += executionsCount; taskExecutionStats.TotalMemoryBytes += totalMemoryConsumption; + taskExecutionStats.TaskFactoryName ??= factoryName; + taskExecutionStats.TaskHostRuntime ??= taskHostRuntime; } } @@ -50,10 +52,9 @@ public void AddTarget(TaskOrTargetTelemetryKey target, bool wasExecuted) wasExecuted || (TargetsExecutionData.TryGetValue(target, out bool wasAlreadyExecuted) && wasAlreadyExecuted); } - public WorkerNodeTelemetryData() - : this(new Dictionary(), new Dictionary()) - { } + public WorkerNodeTelemetryData() : this([], []) { } public Dictionary TasksExecutionData { get; } + public Dictionary TargetsExecutionData { get; } } diff --git a/src/Framework/Telemetry/WorkerNodeTelemetryEventArgs.cs b/src/Framework/Telemetry/WorkerNodeTelemetryEventArgs.cs index 4eef343b196..d2f35e5eb4f 100644 --- a/src/Framework/Telemetry/WorkerNodeTelemetryEventArgs.cs +++ b/src/Framework/Telemetry/WorkerNodeTelemetryEventArgs.cs @@ -27,6 +27,8 @@ internal override void WriteToStream(BinaryWriter writer) writer.Write(entry.Value.CumulativeExecutionTime.Ticks); writer.Write(entry.Value.ExecutionsCount); writer.Write(entry.Value.TotalMemoryBytes); + writer.Write(entry.Value.TaskFactoryName ?? string.Empty); + writer.Write(entry.Value.TaskHostRuntime ?? string.Empty); } writer.Write7BitEncodedInt(WorkerNodeTelemetryData.TargetsExecutionData.Count); @@ -43,11 +45,21 @@ internal override void CreateFromStream(BinaryReader reader, int version) Dictionary tasksExecutionData = new(); for (int i = 0; i < count; i++) { - tasksExecutionData.Add(ReadFromStream(reader), + var key = ReadFromStream(reader); + var cumulativeExecutionTime = TimeSpan.FromTicks(reader.ReadInt64()); + var executionsCount = reader.ReadInt32(); + var totalMemoryBytes = reader.ReadInt64(); + var taskFactoryName = reader.ReadString(); + var taskHostRuntime = reader.ReadString(); + + tasksExecutionData.Add( + key, new TaskExecutionStats( - TimeSpan.FromTicks(reader.ReadInt64()), - reader.ReadInt32(), - reader.ReadInt64())); + cumulativeExecutionTime, + executionsCount, + totalMemoryBytes, + string.IsNullOrEmpty(taskFactoryName) ? null : taskFactoryName, + string.IsNullOrEmpty(taskHostRuntime) ? null : taskHostRuntime)); } count = reader.Read7BitEncodedInt(); diff --git a/src/Framework/TelemetryEventArgs.cs b/src/Framework/TelemetryEventArgs.cs index d3d57e9c5e5..645a72526d3 100644 --- a/src/Framework/TelemetryEventArgs.cs +++ b/src/Framework/TelemetryEventArgs.cs @@ -43,6 +43,7 @@ internal override void WriteToStream(BinaryWriter writer) writer.WriteOptionalString(kvp.Value); } } + internal override void CreateFromStream(BinaryReader reader, int version) { base.CreateFromStream(reader, version); diff --git a/src/Tasks.UnitTests/TelemetryTaskTests.cs b/src/Tasks.UnitTests/TelemetryTaskTests.cs index db374f1757d..4a1c82aeaa4 100644 --- a/src/Tasks.UnitTests/TelemetryTaskTests.cs +++ b/src/Tasks.UnitTests/TelemetryTaskTests.cs @@ -90,11 +90,9 @@ public void TelemetryTaskDuplicateEventDataProperty() Assert.True(retVal); // Should not contain the first value - // Assert.DoesNotContain("EE2493A167D24F00996DE7C8E769EAE6", engine.Log); // Should contain the second value - // Assert.Contains("4ADE3D2622CA400B8B95A039DF540037", engine.Log); } } From 712f8ef10e09bff1494b8043549be8ef2d0c4c16 Mon Sep 17 00:00:00 2001 From: "dotnet-maestro[bot]" <42748379+dotnet-maestro[bot]@users.noreply.github.com> Date: Mon, 12 Jan 2026 16:35:10 +0000 Subject: [PATCH 23/39] [main] Source code updates from dotnet/dotnet (#12987) [main] Source code updates from dotnet/dotnet --- eng/Version.Details.xml | 2 +- src/Build/Resources/xlf/Strings.cs.xlf | 2 +- src/Build/Resources/xlf/Strings.es.xlf | 2 +- src/Build/Resources/xlf/Strings.it.xlf | 2 +- src/Build/Resources/xlf/Strings.ja.xlf | 2 +- src/Build/Resources/xlf/Strings.ko.xlf | 2 +- src/Build/Resources/xlf/Strings.pl.xlf | 2 +- src/Build/Resources/xlf/Strings.pt-BR.xlf | 2 +- src/Build/Resources/xlf/Strings.ru.xlf | 2 +- src/Build/Resources/xlf/Strings.tr.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hans.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hant.xlf | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml index c184cc7016d..e527a55b4da 100644 --- a/eng/Version.Details.xml +++ b/eng/Version.Details.xml @@ -1,6 +1,6 @@ - + diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index 9ab02afe3bc..e619f181132 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index a72490d50a5..bc52dff63e1 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index c3a339f9aba..73d010d34df 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index bab87c64b11..2dd93ee27eb 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index 8fbaf0b2a79..07e25cacefd 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index 5468c688eba..1a947c0aa32 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index f7957c45cda..684dfe25a38 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index 4b309e0cc21..4da8c88c4d2 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index 87f9b73cded..0e76200e94f 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index ad7d1118c48..2aeabae9aff 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index 6a78af31da7..c6fbb2afb7f 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -1,4 +1,4 @@ - + From 6883d6db1aaf8f1d71a2d65a554ade17f1a8fbdf Mon Sep 17 00:00:00 2001 From: dotnet bot Date: Mon, 12 Jan 2026 17:48:27 +0100 Subject: [PATCH 24/39] Localized file check-in by OneLocBuild Task: Build definition ID 9434: Build ID 13079827 (#13010) This is the pull request automatically created by the OneLocBuild task in the build process to check-in localized files generated based upon translation source files (.lcl files) handed-back from the downstream localization pipeline. If there are issues in translations, visit https://aka.ms/icxLocBug and log bugs for fixes. The OneLocBuild wiki is https://aka.ms/onelocbuild and the localization process in general is documented at https://aka.ms/AllAboutLoc. --- src/Build/Resources/xlf/Strings.cs.xlf | 2 +- src/Build/Resources/xlf/Strings.es.xlf | 2 +- src/Build/Resources/xlf/Strings.it.xlf | 2 +- src/Build/Resources/xlf/Strings.ja.xlf | 2 +- src/Build/Resources/xlf/Strings.ko.xlf | 2 +- src/Build/Resources/xlf/Strings.pl.xlf | 2 +- src/Build/Resources/xlf/Strings.pt-BR.xlf | 2 +- src/Build/Resources/xlf/Strings.ru.xlf | 2 +- src/Build/Resources/xlf/Strings.tr.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hans.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hant.xlf | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index e619f181132..9ab02afe3bc 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index bc52dff63e1..a72490d50a5 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index 73d010d34df..c3a339f9aba 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index 2dd93ee27eb..bab87c64b11 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index 07e25cacefd..8fbaf0b2a79 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index 1a947c0aa32..5468c688eba 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index 684dfe25a38..f7957c45cda 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index 4da8c88c4d2..4b309e0cc21 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index 0e76200e94f..87f9b73cded 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index 2aeabae9aff..ad7d1118c48 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -1,4 +1,4 @@ - + diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index c6fbb2afb7f..6a78af31da7 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -1,4 +1,4 @@ - + From bd54b25a32bc2480b693bf4416608c5096e85621 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 12 Jan 2026 20:42:47 +0000 Subject: [PATCH 25/39] Snap for VS 18.3 and update branding to VS 18.4 (#13005) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Work item (Internal use): ### Summary Updates MSBuild version branding from 18.3 to 18.4 following the pattern established in #12786. **Changes:** - `eng/Versions.props`: Bump `VersionPrefix` from `18.3.0` to `18.4.0` - `azure-pipelines/vs-insertion.yml`: Add `rel/d18.4` target branch and `vs18.4` branch mapping - `.config/git-merge-flow-config.jsonc`: Configure merge flow chain as vs18.0 → vs18.3 → vs18.4 → main **Note:** Creating the `vs18.3` servicing branch requires write permissions and must be done separately. ### Customer Impact None. Branding update only affects internal version strings and CI/CD pipeline configuration for VS insertions and branch merge flows. ### Regression? No. Configuration-only changes to version strings, build pipeline mappings, and merge flow automation. ### Testing - Repository build successful - MSBuild version reports `18.4.0-dev` - Sample project builds without errors - JSONC syntax validation passed - Code review and security scans passed ### Risk Low. Minimal surface area—version string, pipeline configuration, and merge flow updates following established pattern from previous version bumps.
Original prompt > > ---- > > *This section details on the original issue you should resolve* > > Snap for vs18.3 and update branding to vs18.4 > - [ ] Mimic what was done in https://github.com/dotnet/msbuild/pull/12786 but for vs18.4 instead of vs18.3 > - [ ] Create a vs18.3 branch with https://github.com/dotnet/msbuild/tree/fb775842a00d534aaf25466ff76e0d8fe86d2e7d as the HEAD SHA > > ## Comments on the Issue (you are @copilot in this section) > > > >
- Fixes dotnet/msbuild#13004 --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ViktorHofer <7412651+ViktorHofer@users.noreply.github.com> Co-authored-by: Viktor Hofer --- .config/git-merge-flow-config.jsonc | 4 ++-- azure-pipelines/vs-insertion.yml | 5 ++++- eng/Versions.props | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.config/git-merge-flow-config.jsonc b/.config/git-merge-flow-config.jsonc index f1070da2f95..13efaeba878 100644 --- a/.config/git-merge-flow-config.jsonc +++ b/.config/git-merge-flow-config.jsonc @@ -28,9 +28,9 @@ }, // Automate opening PRs to merge msbuild's vs18.0 (SDK 10.0.1xx) into vs18.3 (SDK 10.0.2xx, VS) "vs18.0": { - "MergeToBranch": "main" // update to flow through vs18.3 after we fork for release + "MergeToBranch": "vs18.3" }, - // MSBuild latest release to main + // Automate opening PRs to merge msbuild's vs18.3 (SDK 10.0.2xx) into main "vs18.3": { "MergeToBranch": "main" } diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 10542091113..76f7ff3a5d1 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -44,6 +44,7 @@ parameters: values: - auto - main + - rel/d18.4 - rel/d18.3 - rel/d18.0 - rel/d17.14 @@ -67,7 +68,9 @@ parameters: variables: # `auto` should work every time and selecting a branch in parameters is likely to fail due to incompatible versions in MSBuild and VS - name: AutoInsertTargetBranch - ${{ if eq(variables['Build.SourceBranchName'], 'vs18.3') }}: + ${{ if eq(variables['Build.SourceBranchName'], 'vs18.4') }}: + value: 'rel/d18.4' + ${{ elseif eq(variables['Build.SourceBranchName'], 'vs18.3') }}: value: 'rel/d18.3' ${{ elseif eq(variables['Build.SourceBranchName'], 'vs18.0') }}: value: 'rel/d18.0' diff --git a/eng/Versions.props b/eng/Versions.props index 74765ef67d5..fb60b6444c5 100644 --- a/eng/Versions.props +++ b/eng/Versions.props @@ -3,7 +3,7 @@ - 18.3.0 + 18.4.0 preview 18.0.2 15.1.0.0 From 21efb9461a0b0160aba1388e868db0fc82072e1b Mon Sep 17 00:00:00 2001 From: "dotnet-maestro[bot]" <42748379+dotnet-maestro[bot]@users.noreply.github.com> Date: Tue, 13 Jan 2026 11:49:20 +0100 Subject: [PATCH 26/39] [main] Source code updates from dotnet/dotnet (#13012) > [!NOTE] > This is a codeflow update. It may contain both source code changes from > [the VMR](https://github.com/dotnet/dotnet) > as well as dependency updates. Learn more [here](https://github.com/dotnet/dotnet/tree/main/docs/Codeflow-PRs.md). This pull request brings the following source code changes [marker]: <> (Begin:91fa59f1-1864-46b1-b482-87955691317c) ## From https://github.com/dotnet/dotnet - **Subscription**: [91fa59f1-1864-46b1-b482-87955691317c](https://maestro.dot.net/subscriptions?search=91fa59f1-1864-46b1-b482-87955691317c) - **Build**: [20260112.1](https://dev.azure.com/dnceng/internal/_build/results?buildId=2876967) ([296906](https://maestro.dot.net/channel/8298/github:dotnet:dotnet/build/296906)) - **Date Produced**: January 12, 2026 3:49:30 PM UTC - **Commit**: [7b9ad20ba1d45df5a99fdd9dedbf3bfe6a6fc24f](https://github.com/dotnet/dotnet/commit/7b9ad20ba1d45df5a99fdd9dedbf3bfe6a6fc24f) - **Commit Diff**: [896160e...7b9ad20](https://github.com/dotnet/dotnet/compare/896160ec9eb0fdb1c019f698b39fa0923c9a316c...7b9ad20ba1d45df5a99fdd9dedbf3bfe6a6fc24f) - **Branch**: [main](https://github.com/dotnet/dotnet/tree/main) [marker]: <> (End:91fa59f1-1864-46b1-b482-87955691317c) [marker]: <> (Start:Footer:CodeFlow PR) ## Associated changes in source repos - https://github.com/dotnet/aspnetcore/compare/47182042233562b893d2290af4275e924d3ff6bb...30d4d50bbf806a8c45de78ac0fcff1b4c3f78842 - https://github.com/dotnet/deployment-tools/compare/6ebef72019b85958ae78d0da73ea49a161c7a28a...c3dd1602b13a207262859890e45a73dfc827e886 - https://github.com/dotnet/efcore/compare/5a68c09c2c67b7f410f0972b193b42d5502367a7...347ab472b565c2be643b2c8bfabfd24a2acdee21 - https://github.com/dotnet/fsharp/compare/95d597122c8ace890da82c59f2433433325a1b13...841308307dc2233bc0fa6a364d35a1d4c169f1c5 - https://github.com/dotnet/msbuild/compare/fb775842a00d534aaf25466ff76e0d8fe86d2e7d...2392c792aa6953ebfe6683c44d295ac3da3e0a54 - https://github.com/dotnet/roslyn/compare/bf35fe58e593ac0ac74c05bfa6e4719b85772da0...e97b493ee82ea61d794f966c2476bb6808a58b5c - https://github.com/dotnet/runtime/compare/bce6119e41ecfbcf630c369836770669604c22c6...891c183b22d023eea7bc4aa57dbc219d54852036 - https://github.com/dotnet/source-build-reference-packages/compare/cdd1ce5b784d2d01917a7eda352f20bf0a3ca690...70e51c1c54cdc4d101d251b20a38185d9f87e58f
Diff the source with this PR branch ```bash darc vmr diff --name-only https://github.com/dotnet/dotnet:7b9ad20ba1d45df5a99fdd9dedbf3bfe6a6fc24f..https://github.com/dotnet/msbuild:darc-main-82150f35-e08a-412d-9913-0ca994390d47 ```
[marker]: <> (End:Footer:CodeFlow PR) --------- Co-authored-by: dotnet-maestro[bot] --- eng/Version.Details.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml index e527a55b4da..a9aa5307c7f 100644 --- a/eng/Version.Details.xml +++ b/eng/Version.Details.xml @@ -1,6 +1,6 @@ - + From 39e218c70067ce07f34308b8a02dd3f8c499dbb4 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Tue, 13 Jan 2026 12:05:29 +0100 Subject: [PATCH 27/39] Add telemetry to categorize build failure reasons (#13007) --- documentation/wiki/CollectedTelemetry.md | 8 + ...BuildTelemetryErrorCategorization_Tests.cs | 215 ++++++++++++++ .../BackEnd/KnownTelemetry_Tests.cs | 64 +++++ .../BackEnd/MockLoggingService.cs | 5 + .../BackEnd/BuildManager/BuildManager.cs | 6 + .../Logging/BuildErrorTelemetryTracker.cs | 263 ++++++++++++++++++ .../Components/Logging/ILoggingService.cs | 6 + .../Components/Logging/LoggingService.cs | 16 ++ src/Build/Microsoft.Build.csproj | 1 + src/Framework/Telemetry/BuildInsights.cs | 10 + src/Framework/Telemetry/BuildTelemetry.cs | 16 ++ 11 files changed, 610 insertions(+) create mode 100644 src/Build.UnitTests/BackEnd/BuildTelemetryErrorCategorization_Tests.cs create mode 100644 src/Build/BackEnd/Components/Logging/BuildErrorTelemetryTracker.cs diff --git a/documentation/wiki/CollectedTelemetry.md b/documentation/wiki/CollectedTelemetry.md index 0b897249788..aded23be6cd 100644 --- a/documentation/wiki/CollectedTelemetry.md +++ b/documentation/wiki/CollectedTelemetry.md @@ -100,6 +100,14 @@ Expressed and collected via [BuildTelemetry type](https://github.com/dotnet/msbu | >= 9.0.100 | Indication of enablement of BuildCheck feature. | | >= 9.0.100 | Indication of Smart App Control being in evaluation mode on machine executing the build. | | >= 10.0.100 | Indication if the build was run in multithreaded mode. | +| >= 10.0.200 | Primary failure category when BuildSuccess = false (one of: "Compiler", "MSBuildEngine", "Tasks", "SDK", "NuGet", "BuildCheck", "Other"). | +| >= 10.0.200 | Count of compiler errors encountered during the build. | +| >= 10.0.200 | Count of MSBuild engine errors encountered during the build. | +| >= 10.0.200 | Count of task errors encountered during the build. | +| >= 10.0.200 | Count of SDK errors encountered during the build. | +| >= 10.0.200 | Count of NuGet errors encountered during the build. | +| >= 10.0.200 | Count of BuildCheck errors encountered during the build. | +| >= 10.0.200 | Count of other errors encountered during the build. | ### Project Build diff --git a/src/Build.UnitTests/BackEnd/BuildTelemetryErrorCategorization_Tests.cs b/src/Build.UnitTests/BackEnd/BuildTelemetryErrorCategorization_Tests.cs new file mode 100644 index 00000000000..e829d22461e --- /dev/null +++ b/src/Build.UnitTests/BackEnd/BuildTelemetryErrorCategorization_Tests.cs @@ -0,0 +1,215 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System; +using System.Collections.Generic; +using Microsoft.Build.BackEnd.Logging; +using Microsoft.Build.Framework; +using Microsoft.Build.Framework.Telemetry; +using Microsoft.Build.Shared; +using Shouldly; +using Xunit; + +#nullable disable + +namespace Microsoft.Build.UnitTests.BackEnd; + +public class BuildTelemetryErrorCategorization_Tests +{ + [Theory] + [InlineData("CS0103", null, "Compiler")] + [InlineData("CS1002", "CS", "Compiler")] + [InlineData("VBC30451", "VBC", "Compiler")] + [InlineData("FS0039", null, "Compiler")] + [InlineData("MSB4018", null, "MSBuildEngine")] + [InlineData("MSB4236", null, "SDKResolvers")] + [InlineData("MSB3026", null, "Tasks")] + [InlineData("NETSDK1045", null, "NETSDK")] + [InlineData("NU1101", null, "NuGet")] + [InlineData("BC0001", null, "BuildCheck")] + [InlineData("CUSTOM001", null, "Other")] + [InlineData(null, null, "Other")] + [InlineData("", null, "Other")] + public void ErrorCategorizationWorksCorrectly(string errorCode, string subcategory, string expectedCategory) + { + // Create a LoggingService + var loggingService = LoggingService.CreateLoggingService(LoggerMode.Synchronous, 1); + loggingService.OnlyLogCriticalEvents = false; + + try + { + // Log an error with the specified code + var errorEvent = new BuildErrorEventArgs( + subcategory, + errorCode, + "file.cs", + 1, + 1, + 0, + 0, + "Test error message", + "helpKeyword", + "sender"); + + loggingService.LogBuildEvent(errorEvent); + + // Populate telemetry + var buildTelemetry = new BuildTelemetry(); + loggingService.PopulateBuildTelemetryWithErrors(buildTelemetry); + + // Verify the category is set correctly + buildTelemetry.FailureCategory.ShouldBe(expectedCategory); + + // Verify the appropriate count is incremented + switch (expectedCategory) + { + case "Compiler": + buildTelemetry.ErrorCounts.Compiler.ShouldBe(1); + break; + case "MSBuildEngine": + buildTelemetry.ErrorCounts.MsBuildEngine.ShouldBe(1); + break; + case "Tasks": + buildTelemetry.ErrorCounts.Task.ShouldBe(1); + break; + case "SDKResolvers": + buildTelemetry.ErrorCounts.SdkResolvers.ShouldBe(1); + break; + case "NETSDK": + buildTelemetry.ErrorCounts.NetSdk.ShouldBe(1); + break; + case "NuGet": + buildTelemetry.ErrorCounts.NuGet.ShouldBe(1); + break; + case "BuildCheck": + buildTelemetry.ErrorCounts.BuildCheck.ShouldBe(1); + break; + case "Other": + buildTelemetry.ErrorCounts.Other.ShouldBe(1); + break; + } + } + finally + { + loggingService.ShutdownComponent(); + } + } + + [Fact] + public void MultipleErrorsAreCountedByCategory() + { + var loggingService = LoggingService.CreateLoggingService(LoggerMode.Synchronous, 1); + loggingService.OnlyLogCriticalEvents = false; + + try + { + // Log multiple errors of different categories + var errors = new[] + { + new BuildErrorEventArgs(null, "CS0103", "file.cs", 1, 1, 0, 0, "Error 1", null, "sender"), + new BuildErrorEventArgs(null, "CS1002", "file.cs", 2, 1, 0, 0, "Error 2", null, "sender"), + new BuildErrorEventArgs(null, "MSB4018", "file.proj", 10, 5, 0, 0, "Error 3", null, "sender"), + new BuildErrorEventArgs(null, "MSB3026", "file.proj", 15, 3, 0, 0, "Error 4", null, "sender"), + new BuildErrorEventArgs(null, "NU1101", "file.proj", 20, 1, 0, 0, "Error 5", null, "sender"), + new BuildErrorEventArgs(null, "CUSTOM001", "file.txt", 1, 1, 0, 0, "Error 6", null, "sender"), + }; + + foreach (var error in errors) + { + loggingService.LogBuildEvent(error); + } + + // Populate telemetry + var buildTelemetry = new BuildTelemetry(); + loggingService.PopulateBuildTelemetryWithErrors(buildTelemetry); + + // Verify counts + buildTelemetry.ErrorCounts.Compiler.ShouldBe(2); + buildTelemetry.ErrorCounts.MsBuildEngine.ShouldBe(1); + buildTelemetry.ErrorCounts.Task.ShouldBe(1); + buildTelemetry.ErrorCounts.NuGet.ShouldBe(1); + buildTelemetry.ErrorCounts.Other.ShouldBe(1); + + // Primary category should be Compiler (highest count) + buildTelemetry.FailureCategory.ShouldBe("Compiler"); + } + finally + { + loggingService.ShutdownComponent(); + } + } + + [Fact] + public void PrimaryCategoryIsSetToHighestErrorCount() + { + var loggingService = LoggingService.CreateLoggingService(LoggerMode.Synchronous, 1); + loggingService.OnlyLogCriticalEvents = false; + + try + { + // Log errors with Tasks having the highest count + var errors = new[] + { + new BuildErrorEventArgs(null, "MSB3026", "file.proj", 1, 1, 0, 0, "Task Error 1", null, "sender"), + new BuildErrorEventArgs(null, "MSB3027", "file.proj", 2, 1, 0, 0, "Task Error 2", null, "sender"), + new BuildErrorEventArgs(null, "MSB3028", "file.proj", 3, 1, 0, 0, "Task Error 3", null, "sender"), + new BuildErrorEventArgs(null, "CS0103", "file.cs", 4, 1, 0, 0, "Compiler Error", null, "sender"), + }; + + foreach (var error in errors) + { + loggingService.LogBuildEvent(error); + } + + // Populate telemetry + var buildTelemetry = new BuildTelemetry(); + loggingService.PopulateBuildTelemetryWithErrors(buildTelemetry); + + // Primary category should be Tasks (3 errors vs 1 compiler error) + buildTelemetry.FailureCategory.ShouldBe("Tasks"); + buildTelemetry.ErrorCounts.Task.ShouldBe(3); + buildTelemetry.ErrorCounts.Compiler.ShouldBe(1); + } + finally + { + loggingService.ShutdownComponent(); + } + } + + [Fact] + public void SubcategoryIsUsedForCompilerErrors() + { + var loggingService = LoggingService.CreateLoggingService(LoggerMode.Synchronous, 1); + loggingService.OnlyLogCriticalEvents = false; + + try + { + // Log an error with subcategory "CS" (common for C# compiler errors) + var errorEvent = new BuildErrorEventArgs( + "CS", // subcategory + "CS0103", + "file.cs", + 1, + 1, + 0, + 0, + "The name 'foo' does not exist in the current context", + "helpKeyword", + "csc"); + + loggingService.LogBuildEvent(errorEvent); + + // Populate telemetry + var buildTelemetry = new BuildTelemetry(); + loggingService.PopulateBuildTelemetryWithErrors(buildTelemetry); + + // Should be categorized as Compiler based on subcategory + buildTelemetry.FailureCategory.ShouldBe("Compiler"); + buildTelemetry.ErrorCounts.Compiler.ShouldBe(1); + } + finally + { + loggingService.ShutdownComponent(); + } + } +} diff --git a/src/Build.UnitTests/BackEnd/KnownTelemetry_Tests.cs b/src/Build.UnitTests/BackEnd/KnownTelemetry_Tests.cs index 954832fce12..63fa6f3ae06 100644 --- a/src/Build.UnitTests/BackEnd/KnownTelemetry_Tests.cs +++ b/src/Build.UnitTests/BackEnd/KnownTelemetry_Tests.cs @@ -7,6 +7,7 @@ using Microsoft.Build.Framework.Telemetry; using Shouldly; using Xunit; +using static Microsoft.Build.Framework.Telemetry.BuildInsights; namespace Microsoft.Build.UnitTests.Telemetry; @@ -123,4 +124,67 @@ public void BuildTelemetryHandleNullsInRecordedTimes() buildTelemetry.FinishedAt = DateTime.MaxValue; buildTelemetry.GetProperties().ShouldBeEmpty(); } + + [Fact] + public void BuildTelemetryIncludesFailureCategoryProperties() + { + BuildTelemetry buildTelemetry = new BuildTelemetry(); + + buildTelemetry.BuildSuccess = false; + buildTelemetry.FailureCategory = "Compiler"; + buildTelemetry.ErrorCounts = new ErrorCountsInfo( + Compiler: 5, + MsBuildEngine: 2, + Task: 1, + SdkResolvers: null, + NetSdk: null, + NuGet: 3, + BuildCheck: null, + Other: 1); + + var properties = buildTelemetry.GetProperties(); + + properties["BuildSuccess"].ShouldBe("False"); + properties["FailureCategory"].ShouldBe("Compiler"); + properties.ContainsKey("ErrorCounts").ShouldBeTrue(); + + var activityProperties = buildTelemetry.GetActivityProperties(); + activityProperties["FailureCategory"].ShouldBe("Compiler"); + var errorCounts = activityProperties["ErrorCounts"] as ErrorCountsInfo; + errorCounts.ShouldNotBeNull(); + errorCounts.Compiler.ShouldBe(5); + errorCounts.MsBuildEngine.ShouldBe(2); + errorCounts.Task.ShouldBe(1); + errorCounts.NuGet.ShouldBe(3); + errorCounts.Other.ShouldBe(1); + errorCounts.SdkResolvers.ShouldBeNull(); + errorCounts.NetSdk.ShouldBeNull(); + errorCounts.BuildCheck.ShouldBeNull(); + } + + [Fact] + public void BuildTelemetryActivityPropertiesIncludesFailureData() + { + BuildTelemetry buildTelemetry = new BuildTelemetry(); + + buildTelemetry.BuildSuccess = false; + buildTelemetry.FailureCategory = "Tasks"; + buildTelemetry.ErrorCounts = new ErrorCountsInfo( + Compiler: null, + MsBuildEngine: null, + Task: 10, + SdkResolvers: null, + NetSdk: null, + NuGet: null, + BuildCheck: null, + Other: null); + + var activityProperties = buildTelemetry.GetActivityProperties(); + + activityProperties["BuildSuccess"].ShouldBe(false); + activityProperties["FailureCategory"].ShouldBe("Tasks"); + var errorCounts = activityProperties["ErrorCounts"] as ErrorCountsInfo; + errorCounts.ShouldNotBeNull(); + errorCounts.Task.ShouldBe(10); + } } diff --git a/src/Build.UnitTests/BackEnd/MockLoggingService.cs b/src/Build.UnitTests/BackEnd/MockLoggingService.cs index fa5f97176c2..10c40c8159a 100644 --- a/src/Build.UnitTests/BackEnd/MockLoggingService.cs +++ b/src/Build.UnitTests/BackEnd/MockLoggingService.cs @@ -677,6 +677,11 @@ public bool HasBuildSubmissionLoggedErrors(int submissionId) return false; } + public void PopulateBuildTelemetryWithErrors(Framework.Telemetry.BuildTelemetry buildTelemetry) + { + // Mock implementation does nothing + } + public ICollection GetWarningsAsErrors(BuildEventContext context) { throw new NotImplementedException(); diff --git a/src/Build/BackEnd/BuildManager/BuildManager.cs b/src/Build/BackEnd/BuildManager/BuildManager.cs index 887ce2d15ca..9253bce109b 100644 --- a/src/Build/BackEnd/BuildManager/BuildManager.cs +++ b/src/Build/BackEnd/BuildManager/BuildManager.cs @@ -1092,6 +1092,12 @@ public void EndBuild() _buildTelemetry.BuildEngineDisplayVersion = ProjectCollection.DisplayVersion; _buildTelemetry.BuildEngineFrameworkName = NativeMethodsShared.FrameworkName; + // Populate error categorization data from the logging service + if (!_overallBuildSuccess) + { + loggingService.PopulateBuildTelemetryWithErrors(_buildTelemetry); + } + string? host = null; if (BuildEnvironmentState.s_runningInVisualStudio) { diff --git a/src/Build/BackEnd/Components/Logging/BuildErrorTelemetryTracker.cs b/src/Build/BackEnd/Components/Logging/BuildErrorTelemetryTracker.cs new file mode 100644 index 00000000000..a2d4dc179c0 --- /dev/null +++ b/src/Build/BackEnd/Components/Logging/BuildErrorTelemetryTracker.cs @@ -0,0 +1,263 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System; +using System.Runtime.CompilerServices; +using Microsoft.Build.Framework.Telemetry; +using static Microsoft.Build.Framework.Telemetry.BuildInsights; + +#nullable enable + +namespace Microsoft.Build.BackEnd.Logging +{ + /// + /// Tracks and categorizes build errors for telemetry purposes. + /// + internal sealed class BuildErrorTelemetryTracker + { + // Use an enum internally for efficient tracking, convert to string only when needed + private enum ErrorCategory + { + Compiler, + MSBuildEngine, + Tasks, + SDKResolvers, + NETSDK, + NuGet, + BuildCheck, + Other, + } + + /// + /// Error counts by category index (using enum ordinal). + /// + private readonly int[] _errorCounts = new int[Enum.GetValues(typeof(ErrorCategory)).Length]; + + /// + /// Tracks the primary failure category (category with highest count). + /// + private ErrorCategory _primaryCategory; + + /// + /// Tracks the highest error count for primary category determination. + /// + private int _primaryCategoryCount; + + /// + /// Tracks an error for telemetry purposes by categorizing it. + /// + /// The error code from the BuildErrorEventArgs. + /// The subcategory from the BuildErrorEventArgs. + public void TrackError(string? errorCode, string? subcategory) + { + // Categorize the error + ErrorCategory category = CategorizeError(errorCode, subcategory); + int categoryIndex = (int)category; + + // Increment the count for this category using Interlocked for thread safety + int newCount = System.Threading.Interlocked.Increment(ref _errorCounts[categoryIndex]); + + // Update primary category if this one now has the highest count + // Use a simple compare-and-swap pattern for thread-safe update + int currentMax = System.Threading.Interlocked.CompareExchange(ref _primaryCategoryCount, 0, 0); + if (newCount > currentMax) + { + // Try to update both the count and category atomically + if (System.Threading.Interlocked.CompareExchange(ref _primaryCategoryCount, newCount, currentMax) == currentMax) + { + _primaryCategory = category; + } + } + } + + /// + /// Populates build telemetry with error categorization data. + /// + /// The BuildTelemetry object to populate with error data. + public void PopulateBuildTelemetry(BuildTelemetry buildTelemetry) + { + // Read counts atomically + int compilerErrorCount = System.Threading.Interlocked.CompareExchange(ref _errorCounts[(int)ErrorCategory.Compiler], 0, 0); + int msbuildEngineErrorCount = System.Threading.Interlocked.CompareExchange(ref _errorCounts[(int)ErrorCategory.MSBuildEngine], 0, 0); + int taskErrorCount = System.Threading.Interlocked.CompareExchange(ref _errorCounts[(int)ErrorCategory.Tasks], 0, 0); + int sdkResolversErrorCount = System.Threading.Interlocked.CompareExchange(ref _errorCounts[(int)ErrorCategory.SDKResolvers], 0, 0); + int netsdkErrorCount = System.Threading.Interlocked.CompareExchange(ref _errorCounts[(int)ErrorCategory.NETSDK], 0, 0); + int nugetErrorCount = System.Threading.Interlocked.CompareExchange(ref _errorCounts[(int)ErrorCategory.NuGet], 0, 0); + int buildCheckErrorCount = System.Threading.Interlocked.CompareExchange(ref _errorCounts[(int)ErrorCategory.BuildCheck], 0, 0); + int otherErrorCount = System.Threading.Interlocked.CompareExchange(ref _errorCounts[(int)ErrorCategory.Other], 0, 0); + + buildTelemetry.ErrorCounts = new ErrorCountsInfo( + Compiler: compilerErrorCount > 0 ? compilerErrorCount : null, + MsBuildEngine: msbuildEngineErrorCount > 0 ? msbuildEngineErrorCount : null, + Task: taskErrorCount > 0 ? taskErrorCount : null, + SdkResolvers: sdkResolversErrorCount > 0 ? sdkResolversErrorCount : null, + NetSdk: netsdkErrorCount > 0 ? netsdkErrorCount : null, + NuGet: nugetErrorCount > 0 ? nugetErrorCount : null, + BuildCheck: buildCheckErrorCount > 0 ? buildCheckErrorCount : null, + Other: otherErrorCount > 0 ? otherErrorCount : null); + + // Set the primary failure category + int totalErrors = System.Threading.Interlocked.CompareExchange(ref _primaryCategoryCount, 0, 0); + if (totalErrors > 0) + { + buildTelemetry.FailureCategory = _primaryCategory.ToString(); + } + } + + /// + /// Categorizes an error based on its error code and subcategory. + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + private static ErrorCategory CategorizeError(string? errorCode, string? subcategory) + { + if (string.IsNullOrEmpty(errorCode)) + { + return ErrorCategory.Other; + } + + // Check subcategory for compiler errors (CS*, VBC*, FS*) + if (!string.IsNullOrEmpty(subcategory) && IsCompilerPrefix(subcategory!)) + { + return ErrorCategory.Compiler; + } + + // Check error code patterns - order by frequency for fast path + if (IsCompilerPrefix(errorCode!)) + { + return ErrorCategory.Compiler; + } + + // Use Span-based comparison to avoid allocations + ReadOnlySpan codeSpan = errorCode.AsSpan(); + + if (codeSpan.Length >= 2) + { + char c0 = char.ToUpperInvariant(codeSpan[0]); + char c1 = char.ToUpperInvariant(codeSpan[1]); + + // BC* -> BuildCheck + if (c0 == 'B' && c1 == 'C') + { + return ErrorCategory.BuildCheck; + } + + // NU* -> NuGet + if (c0 == 'N' && c1 == 'U') + { + return ErrorCategory.NuGet; + } + + // MSB* -> categorize MSB errors + if (c0 == 'M' && c1 == 'S' && codeSpan.Length >= 3 && char.ToUpperInvariant(codeSpan[2]) == 'B') + { + return CategorizeMSBError(codeSpan); + } + + // NETSDK* -> .NET SDK diagnostics + if (c0 == 'N' && c1 == 'E' && codeSpan.Length >= 6 && + char.ToUpperInvariant(codeSpan[2]) == 'T' && + char.ToUpperInvariant(codeSpan[3]) == 'S' && + char.ToUpperInvariant(codeSpan[4]) == 'D' && + char.ToUpperInvariant(codeSpan[5]) == 'K') + { + return ErrorCategory.NETSDK; + } + } + + return ErrorCategory.Other; + } + + /// + /// Checks if the string starts with a compiler error prefix (CS, VBC, FS). + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + private static bool IsCompilerPrefix(string value) + { + if (value.Length < 2) + { + return false; + } + + char c0 = char.ToUpperInvariant(value[0]); + char c1 = char.ToUpperInvariant(value[1]); + + // CS* -> C# compiler + if (c0 == 'C' && c1 == 'S') + { + return true; + } + + // FS* -> F# compiler + if (c0 == 'F' && c1 == 'S') + { + return true; + } + + // VBC* -> VB compiler (need 3 chars) + if (c0 == 'V' && c1 == 'B' && value.Length >= 3 && char.ToUpperInvariant(value[2]) == 'C') + { + return true; + } + + return false; + } + + /// + /// Categorizes MSB error codes into MSBuildEngine, Tasks, or SDKResolvers. + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + private static ErrorCategory CategorizeMSBError(ReadOnlySpan codeSpan) + { + // MSB error codes consist of 3-letter prefix + 4-digit number (e.g., MSB3026) + const int MinimumMsbCodeLength = 7; + + if (codeSpan.Length < MinimumMsbCodeLength) + { + return ErrorCategory.Other; + } + + // Check for MSB4236 (SDKResolvers error) - fast path for exact match + if (codeSpan.Length == 7 && codeSpan[3] == '4' && codeSpan[4] == '2' && codeSpan[5] == '3' && codeSpan[6] == '6') + { + return ErrorCategory.SDKResolvers; + } + + if (!TryParseErrorNumber(codeSpan, out int errorNumber)) + { + return ErrorCategory.Other; + } + + // MSB4xxx (except MSB4236, handled above as SDKResolvers) -> MSBuildEngine (evaluation and execution errors) + if (errorNumber is >= 4001 and <= 4999) + { + return ErrorCategory.MSBuildEngine; + } + + // MSB3xxx -> Tasks + return errorNumber is >= 3001 and <= 3999 ? ErrorCategory.Tasks : ErrorCategory.Other; + } + + /// + /// Parses the 4-digit error number from an MSB error code span (starting at index 3). + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + private static bool TryParseErrorNumber(ReadOnlySpan codeSpan, out int errorNumber) + { + errorNumber = 0; + + // We need exactly 4 digits starting at position 3 + for (int i = 3; i < 7; i++) + { + char c = codeSpan[i]; + if (c < '0' || c > '9') + { + return false; + } + + errorNumber = (errorNumber * 10) + (c - '0'); + } + + return true; + } + } +} diff --git a/src/Build/BackEnd/Components/Logging/ILoggingService.cs b/src/Build/BackEnd/Components/Logging/ILoggingService.cs index 9296eb45927..6621c2b740f 100644 --- a/src/Build/BackEnd/Components/Logging/ILoggingService.cs +++ b/src/Build/BackEnd/Components/Logging/ILoggingService.cs @@ -283,6 +283,12 @@ MessageImportance MinimumRequiredMessageImportance /// true if the build submission logged an errors, otherwise false. bool HasBuildSubmissionLoggedErrors(int submissionId); + /// + /// Populates build telemetry with error categorization data. + /// + /// The BuildTelemetry object to populate with error data. + void PopulateBuildTelemetryWithErrors(Framework.Telemetry.BuildTelemetry buildTelemetry); + /// /// Get the warnings that will be promoted to errors for the specified context. /// diff --git a/src/Build/BackEnd/Components/Logging/LoggingService.cs b/src/Build/BackEnd/Components/Logging/LoggingService.cs index d2067256d9c..24d8dcb0944 100644 --- a/src/Build/BackEnd/Components/Logging/LoggingService.cs +++ b/src/Build/BackEnd/Components/Logging/LoggingService.cs @@ -221,6 +221,11 @@ internal partial class LoggingService : ILoggingService, INodePacketHandler /// private readonly ISet _buildSubmissionIdsThatHaveLoggedBuildcheckErrors = new HashSet(); + /// + /// Tracker for build error telemetry. + /// + private readonly BuildErrorTelemetryTracker _errorTelemetryTracker = new BuildErrorTelemetryTracker(); + /// /// A list of warnings to treat as errors for an associated . If an empty set, all warnings are treated as errors. /// @@ -656,6 +661,15 @@ public bool HasBuildSubmissionLoggedErrors(int submissionId) return _buildSubmissionIdsThatHaveLoggedErrors?.Contains(submissionId) == true; } + /// + /// Populates build telemetry with error categorization data. + /// + /// The BuildTelemetry object to populate with error data. + public void PopulateBuildTelemetryWithErrors(Framework.Telemetry.BuildTelemetry buildTelemetry) + { + _errorTelemetryTracker.PopulateBuildTelemetry(buildTelemetry); + } + /// /// Returns a collection of warnings to be logged as errors for the specified build context. /// @@ -1656,6 +1670,8 @@ private void RouteBuildEvent(object loggingEvent) // Keep track of build submissions that have logged errors. If there is no build context, add BuildEventContext.InvalidSubmissionId. _buildSubmissionIdsThatHaveLoggedErrors.Add(submissionId); } + + _errorTelemetryTracker.TrackError(errorEvent.Code, errorEvent.Subcategory); } // Respect warning-promotion properties from the remote project diff --git a/src/Build/Microsoft.Build.csproj b/src/Build/Microsoft.Build.csproj index fda2c82cc32..9f0c2b12145 100644 --- a/src/Build/Microsoft.Build.csproj +++ b/src/Build/Microsoft.Build.csproj @@ -244,6 +244,7 @@ + diff --git a/src/Framework/Telemetry/BuildInsights.cs b/src/Framework/Telemetry/BuildInsights.cs index 50858c09323..b21898e74e0 100644 --- a/src/Framework/Telemetry/BuildInsights.cs +++ b/src/Framework/Telemetry/BuildInsights.cs @@ -36,4 +36,14 @@ internal record TasksSummaryInfo(TaskCategoryStats? Microsoft, TaskCategoryStats internal record TaskCategoryStats(TaskStatsInfo? Total, TaskStatsInfo? FromNuget); internal record TaskStatsInfo(int ExecutionsCount, double TotalMilliseconds, long TotalMemoryBytes); + + internal record ErrorCountsInfo( + int? Compiler, + int? MsBuildEngine, + int? Task, + int? SdkResolvers, + int? NetSdk, + int? NuGet, + int? BuildCheck, + int? Other); } diff --git a/src/Framework/Telemetry/BuildTelemetry.cs b/src/Framework/Telemetry/BuildTelemetry.cs index acaf6033f97..1f83d96ef84 100644 --- a/src/Framework/Telemetry/BuildTelemetry.cs +++ b/src/Framework/Telemetry/BuildTelemetry.cs @@ -5,6 +5,7 @@ using System.Collections.Generic; using System.Globalization; using System.Runtime.CompilerServices; +using static Microsoft.Build.Framework.Telemetry.BuildInsights; namespace Microsoft.Build.Framework.Telemetry { @@ -106,6 +107,17 @@ internal class BuildTelemetry : TelemetryBase, IActivityTelemetryDataHolder /// public string? BuildEngineFrameworkName { get; set; } + /// + /// Primary failure category when BuildSuccess = false. + /// One of: "Compiler", "MSBuildEngine", "Tasks", "SDKResolvers", "NETSDK", "NuGet", "BuildCheck", "Other". + /// + public string? FailureCategory { get; set; } + + /// + /// Error counts by category. + /// + public ErrorCountsInfo? ErrorCounts { get; set; } + /// /// Create a list of properties sent to VS telemetry. /// @@ -131,6 +143,8 @@ public Dictionary GetActivityProperties() AddIfNotNull(MultiThreadedModeEnabled); AddIfNotNull(SACEnabled); AddIfNotNull(IsStandaloneExecution); + AddIfNotNull(FailureCategory); + AddIfNotNull(ErrorCounts); return telemetryItems; @@ -160,6 +174,8 @@ public override IDictionary GetProperties() AddIfNotNull(MultiThreadedModeEnabled?.ToString(), nameof(MultiThreadedModeEnabled)); AddIfNotNull(SACEnabled?.ToString(), nameof(SACEnabled)); AddIfNotNull(IsStandaloneExecution?.ToString(), nameof(IsStandaloneExecution)); + AddIfNotNull(FailureCategory); + AddIfNotNull(ErrorCounts?.ToString(), nameof(ErrorCounts)); // Calculate durations if (StartAt.HasValue && FinishedAt.HasValue) From 5284a3ff3bd9fb8bf890c4967cc541aee845022c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 13 Jan 2026 12:10:18 +0100 Subject: [PATCH 28/39] Update MicrosoftBuildVersion in analyzer template (#13011) [Automated] Update the MicrosoftBuildVersion defaultValue in the template.json. Co-authored-by: github-actions --- .../Microsoft.CheckTemplate/.template.config/template.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template_feed/content/Microsoft.CheckTemplate/.template.config/template.json b/template_feed/content/Microsoft.CheckTemplate/.template.config/template.json index dd3df2a12b5..571de2cb85a 100644 --- a/template_feed/content/Microsoft.CheckTemplate/.template.config/template.json +++ b/template_feed/content/Microsoft.CheckTemplate/.template.config/template.json @@ -27,7 +27,7 @@ "type": "parameter", "description": "Overrides the default Microsoft.Build version where check's interfaces are placed", "datatype": "text", - "defaultValue": "18.3.0", + "defaultValue": "18.4.0", "replaces": "1.0.0-MicrosoftBuildPackageVersion", "displayName": "Microsoft.Build default package version override" } From 75edd3cbdce5a385c2023007b88de643b28ad25e Mon Sep 17 00:00:00 2001 From: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> Date: Wed, 14 Jan 2026 19:04:46 +0100 Subject: [PATCH 29/39] Update OptProf drop metadata configuration (#13020) ## Summary After this change the opt prof publishing stopped working and it causes internal pipeline failures https://github.com/dotnet/msbuild/pull/12931 ## Fix return buildNumber: 'ProfilingInputs/DevDiv/$(Build.Repository.Name)/$(Build.SourceBranchName)/$(Build.BuildNumber)' --- azure-pipelines/.vsts-dotnet-build-jobs.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/.vsts-dotnet-build-jobs.yml b/azure-pipelines/.vsts-dotnet-build-jobs.yml index fda53e27985..bf123ffd4c8 100644 --- a/azure-pipelines/.vsts-dotnet-build-jobs.yml +++ b/azure-pipelines/.vsts-dotnet-build-jobs.yml @@ -29,7 +29,10 @@ jobs: - output: artifactsDrop sourcePath: '$(Build.SourcesDirectory)\artifacts\official\OptProf\$(BuildConfiguration)\Data' dropServiceURI: 'https://devdiv.artifacts.visualstudio.com' - dropMetadataContainerName: 'ProfilingInputs/DevDiv/$(Build.Repository.Name)/$(Build.SourceBranchName)/$(Build.BuildNumber)' + buildNumber: 'ProfilingInputs/DevDiv/$(Build.Repository.Name)/$(Build.SourceBranchName)/$(Build.BuildNumber)' + toLowerCase: false + usePat: true + dropMetadataContainerName: 'DropMetadata-OptProf' condition: and(succeeded(), ${{ parameters.enableOptProf }}) # Publish bootstrapper info for OptProf data collection run to consume From d7c46dace72bdf286c1ff3a5dbeaf1d9bc36152d Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Thu, 15 Jan 2026 19:09:50 +0100 Subject: [PATCH 30/39] Fix MSB1025 error when using DistributedFileLogger (-dfl flag) (#13036) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Summary Fixes the MSB1025 ArgumentNullException error that occurs when using the `-dfl` (distributed file logger) flag with MSBuild 18. The issue was introduced in PR #12095 where distributed logger central loggers were passed to ProjectCollection without filtering out null values. ### Customer Impact Users running `msbuild -dfl` on MSBuild 18/VS 2026 encounter a blocking error: ``` MSBUILD : error MSB1025: An internal failure occurred while running MSBuild. System.ArgumentNullException: Value cannot be null. (Parameter 'logger') ``` This prevents builds from running when using the distributed file logger, which is commonly used for multi-node build logging. The `-dfl` flag worked correctly in MSBuild 17 and earlier versions. **Root Cause**: When using `-dfl`, the DistributedLoggerRecord intentionally has a null CentralLogger (as documented in XMake.cs line 4298-4299). PR #12095 introduced code that includes these central loggers in the evaluationLoggers array without filtering nulls, causing ProjectCollection.RegisterLoggerInternal() to throw ArgumentNullException. ### Regression? - **Yes** - Regression introduced in MSBuild 18 by PR #12095 - **Last working version**: MSBuild 17 ### Testing **Code Changes:** 1. **XMake.cs (line 1396)**: Added `.Where(l => l is not null)` to filter out null central loggers from the evaluationLoggers array 2. **XMake_Tests.cs**: Added regression test `TestNullCentralLoggerInDistributedLoggerRecord` to verify DistributedLoggerRecords with null CentralLogger don't cause exceptions **Verification:** - ✅ New unit test `TestNullCentralLoggerInDistributedLoggerRecord` passes - ✅ Build succeeded with no warnings or errors - ✅ Manual testing: `msbuild simple.proj -dfl -t:Build` now works correctly and creates distributed log file - ✅ Code review found no issues - ✅ No security vulnerabilities detected ### Risk **Low** - This is a minimal, surgical fix that: - Only filters out null loggers, which are intentionally null for distributed file loggers - Does not change behavior for non-null loggers - Restores MSBuild 17 functionality - Includes regression test to prevent future breakage
Original prompt ---- *This section details on the original issue you should resolve* MsBuild 18/VS 2026 MSB1025 error when using DistributedFileLogger - The 'logger' parameter cannot be null. ### Issue Description When running `msbuild -dfl` i receive such error `MSBUILD : error MSB1025: podczas uruchamiania programu MSBuild wystąpił błąd wewnętrzny. System.ArgumentNullException: Parametr „logger” nie może być zerowy. w Microsoft.Build.Shared.ErrorUtilities.ThrowArgumentNull(String parameterName, String resourceName) w Microsoft.Build.Evaluation.ProjectCollection.RegisterLoggerInternal(ILogger logger) w Microsoft.Build.Evaluation.ProjectCollection.RegisterLoggers(IEnumerable`1 loggers) w Microsoft.Build.Evaluation.ProjectCollection..ctor(IDictionary`2 globalProperties, IEnumerable`1 loggers, IEnumerable`1 remoteLoggers, ToolsetDefinitionLocations toolsetDefinitionLocations, Int32 maxNodeCount, Boolean onlyLogCriticalEvents, Boolean loadProjectsReadOnly, Boolean useAsynchronousLogging, Boolean reuseProjectRootElementCache, Boolean enableTargetOutputLogging) w Microsoft.Build.CommandLine.MSBuildApp.BuildProject(String projectFile, String[] targets, String toolsVersion, Dictionary`2 globalProperties, Dictionary`2 restoreProperties, ILogger[] loggers, LoggerVerbosity verbosity, DistributedLoggerRecord[] distributedLoggerRecords, Boolean needToValidateProject, String schemaFile, Int32 cpuCount, Boolean multiThreaded, Boolean enableNodeReuse, TextWriter preprocessWriter, TextWriter targetsWriter, Boolean detailedSummary, ISet`1 warningsAsErrors, ISet`1 warningsNotAsErrors, ISet`1 warningsAsMessages, Boolean enableRestore, ProfilerLogger profilerLogger, Boolean enableProfiler, Boolean interactive, ProjectIsolationMode isolateProjects, GraphBuildOptions graphBuildOptions, Boolean lowPriority, Boolean question, Boolean isTaskAndTargetItemLoggingRequired, Boolean isBuildCheckEnabled, String[] inputResultsCaches, String outputResultsCache, Boolean saveProjectResult, BuildResult& result, Boolean reportFileAccesses, String commandLine) w Microsoft.Build.CommandLine.MSBuildApp.Execute(String commandLine)` ### Steps to Reproduce to reproduce i create simple .net framework console solution and i run `msbuild -dfl` in solution directory ### Expected Behavior Solution should build as in previous version of msbuild (17) ### Actual Behavior Blocking error `MSBUILD : error MSB1025: podczas uruchamiania programu MSBuild wystąpił błąd wewnętrzny. System.ArgumentNullException: Parametr „logger” nie może być zerowy.` ### Analysis I tried to find any information in documentation about breaking changes in DistributedFileLogger but with no success. Trying different fileLoggerParameters did not help Switching to fileLogger works as expected ### Versions & Configurations Wersja programu MSBuild 18.0.5+e22287bf1 dla .NET Framework 18.0.5.56406 ran from C:\Program Files\Microsoft Visual Studio\18\Professional\MSBuild\Current\Bin\amd64\MSBuild.rsp and C:\Program Files (x86)\Microsoft Visual Studio\18\BuildTools\MSBuild\Current\Bin\amd64\MSBuild.rsp Windows 11 Yes, this bug is very likely caused by the change in PR #12095. Here's the problematic code introduced in src/MSBuild/XMake.cs: csharpILogger[] evaluationLoggers = [ // all of the loggers that are single-node only .. loggers, // all of the central loggers for multi-node systems. These need to be resilient to multiple calls // to Initialize .. distributedLoggerRecords.Select(d => d.CentralLogger) ]; projectCollection = new ProjectCollection( globalProperties, evaluationLoggers, // <-- now includes distributed logger central loggers ... The problem: When you use -dfl (distributed file logger), the DistributedLoggerRecord.CentralLogger can be null. The code now blindly passes all CentralLogger values into the ProjectCollection constructor without filtering out nulls. When ProjectCollection.RegisterLoggers() iterates over these loggers and calls RegisterLoggerInternal(), it hits: csharpprivate void RegisterLoggerInternal(ILogger logger) { ErrorUtilities.VerifyThrowArgumentNull(logger); // <-- throws here when logger is null ... } The fix should filter out null loggers: csharpILogger[] evaluationLoggers = [ .. loggers, .. distributedLoggerRecords .Select(d => d.CentralLogger) .Where(l => l != null) // <-- add this filter ]; ## Comments on the Issue (you are @copilot in this section) @YuliiaKovalova Hi @kkapuscinski , Thank you for reporting the issue! It's likely to connected to https://github.com/dotnet/msbuild/pull/12095 change. We are working on the fix. cc: @baronfel
- Fixes dotnet/msbuild#13032 --- ✨ Let Copilot coding agent [set things up for you](https://github.com/dotnet/msbuild/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: baronfel <573979+baronfel@users.noreply.github.com> --- src/MSBuild.UnitTests/XMake_Tests.cs | 38 ++++++++++++++++++++++++++++ src/MSBuild/XMake.cs | 4 +-- 2 files changed, 40 insertions(+), 2 deletions(-) diff --git a/src/MSBuild.UnitTests/XMake_Tests.cs b/src/MSBuild.UnitTests/XMake_Tests.cs index 9ed990fc17c..9ee19bcb00d 100644 --- a/src/MSBuild.UnitTests/XMake_Tests.cs +++ b/src/MSBuild.UnitTests/XMake_Tests.cs @@ -2294,6 +2294,44 @@ public void TestProcessFileLoggerSwitch5() distributedLoggerRecords.Count.ShouldBe(0); // "Expected no distributed loggers to be attached" loggers.Count.ShouldBe(0); // "Expected no central loggers to be attached" } + + /// + /// Verify that DistributedLoggerRecords with null CentralLogger don't cause exceptions when creating ProjectCollection + /// This is a regression test for the issue where -dfl flag caused MSB1025 error due to null logger not being filtered. + /// + [Fact] + public void TestNullCentralLoggerInDistributedLoggerRecord() + { + // Simulate the scenario when using -dfl flag + // ProcessDistributedFileLogger creates a DistributedLoggerRecord with null CentralLogger + var distributedLoggerRecords = new List(); + bool distributedFileLogger = true; + string[] fileLoggerParameters = null; + + MSBuildApp.ProcessDistributedFileLogger( + distributedFileLogger, + fileLoggerParameters, + distributedLoggerRecords); + + // Verify that we have a distributed logger record with null central logger + distributedLoggerRecords.Count.ShouldBe(1); + distributedLoggerRecords[0].CentralLogger.ShouldBeNull(); + + // This should not throw ArgumentNullException when creating ProjectCollection + // The fix filters out null central loggers from the evaluationLoggers array + var loggers = Array.Empty(); + Should.NotThrow(() => + { + using var projectCollection = new ProjectCollection( + new Dictionary(), + loggers: [.. loggers, .. distributedLoggerRecords.Select(d => d.CentralLogger).Where(l => l is not null)], + remoteLoggers: null, + toolsetDefinitionLocations: ToolsetDefinitionLocations.Default, + maxNodeCount: 1, + onlyLogCriticalEvents: false, + loadProjectsReadOnly: true); + }); + } #endregion #region ProcessConsoleLoggerSwitches diff --git a/src/MSBuild/XMake.cs b/src/MSBuild/XMake.cs index a0a798714ca..d3ca93cea4f 100644 --- a/src/MSBuild/XMake.cs +++ b/src/MSBuild/XMake.cs @@ -1392,8 +1392,8 @@ internal static bool BuildProject( // all of the loggers that are single-node only .. loggers, // all of the central loggers for multi-node systems. These need to be resilient to multiple calls - // to Initialize - .. distributedLoggerRecords.Select(d => d.CentralLogger) + // to Initialize. Filter out null loggers (e.g., DistributedFileLogger uses null central logger). + .. distributedLoggerRecords.Select(d => d.CentralLogger).Where(l => l is not null) ]; projectCollection = new ProjectCollection( From 633ca60ce6dd6b29885ef177c6d80d228218af41 Mon Sep 17 00:00:00 2001 From: MichalPavlik Date: Fri, 16 Jan 2026 10:11:06 +0100 Subject: [PATCH 31/39] CmdLine parsing was extracted from XMake and the implementation is visible to dotnet (attempt 2) (#12836) Fixes #839 ### Context In some cases dotnet needs to process MSBuild command line switches including response files (.rsp). ### Changes Made `FEATURE_GET_COMMANDLINE` workaround is no longer needed and it was removed. Parsing methods are now using `IEnumerable` instead of `string`. Parsing logic was extracted from `XMake` to `CommandLineParser` class. ### Testing All existing tests are passing. VMR: https://dev.azure.com/dnceng/internal/_build/results?buildId=2879901&view=results ### Notes `MSBuildClient` shouldn't be used outside MSBuild. `OutOfProcServerNode.BuildCallback` delegate shouldn't be used anywhere. This delegate (and whole type) are public just because we are not able to expose internal types with MSBuild project due to shared sources in both projects. We had to use `Experimental` namespace instead. ## How to review All commits except the last one was a preparation - removing `FEATURE_GET_COMMANDLINE` constant and migration to vector of strings in our implementations. Last commit extracts the parsing logic to `CommandLineParser` class. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- src/Build.UnitTests/Utilities_Tests.cs | 10 +- src/Build/BackEnd/Client/MSBuildClient.cs | 19 +- src/Build/BackEnd/Node/OutOfProcServerNode.cs | 7 +- .../BackEnd/Node/ServerNodeBuildCommand.cs | 12 - src/Build/CompatibilitySuppressions.xml | 47 +- src/Directory.BeforeCommon.targets | 1 - .../CommandLineParserTests.cs | 39 + .../CommandLineSwitches_Tests.cs | 76 +- .../ProjectSchemaValidationHandler_Tests.cs | 10 +- src/MSBuild.UnitTests/XMake_Tests.cs | 128 ++- src/MSBuild/AssemblyInfo.cs | 3 + src/MSBuild/CommandLine/CommandLineParser.cs | 637 +++++++++++++++ .../CommandLineSwitchException.cs | 2 +- .../{ => CommandLine}/CommandLineSwitches.cs | 8 +- .../CommandLineSwitchesAccessor.cs | 163 ++++ src/MSBuild/MSBuild.csproj | 8 +- src/MSBuild/MSBuildClientApp.cs | 25 +- src/MSBuild/XMake.cs | 727 +----------------- 18 files changed, 1048 insertions(+), 874 deletions(-) create mode 100644 src/MSBuild.UnitTests/CommandLineParserTests.cs create mode 100644 src/MSBuild/CommandLine/CommandLineParser.cs rename src/MSBuild/{ => CommandLine}/CommandLineSwitchException.cs (99%) rename src/MSBuild/{ => CommandLine}/CommandLineSwitches.cs (99%) create mode 100644 src/MSBuild/CommandLine/CommandLineSwitchesAccessor.cs diff --git a/src/Build.UnitTests/Utilities_Tests.cs b/src/Build.UnitTests/Utilities_Tests.cs index a29466e852c..880fbe49e59 100644 --- a/src/Build.UnitTests/Utilities_Tests.cs +++ b/src/Build.UnitTests/Utilities_Tests.cs @@ -80,17 +80,9 @@ public void CommentsInPreprocessing() env.SetEnvironmentVariable("MSBUILDLOADALLFILESASWRITEABLE", "1"); -#if FEATURE_GET_COMMANDLINE - MSBuildApp.Execute(@"c:\bin\msbuild.exe """ + inputFile.Path + - (NativeMethodsShared.IsUnixLike ? @""" -pp:""" : @""" /pp:""") + outputFile.Path + @"""") - .ShouldBe(MSBuildApp.ExitType.Success); -#else Assert.Equal( MSBuildApp.ExitType.Success, - MSBuildApp.Execute( - new[] { @"c:\bin\msbuild.exe", '"' + inputFile.Path + '"', - '"' + (NativeMethodsShared.IsUnixLike ? "-pp:" : "/pp:") + outputFile.Path + '"'})); -#endif + MSBuildApp.Execute([ @"c:\bin\msbuild.exe", '"' + inputFile.Path + '"', '"' + (NativeMethodsShared.IsUnixLike ? "-pp:" : "/pp:") + outputFile.Path + '"'])); bool foundDoNotModify = false; foreach (string line in File.ReadLines(outputFile.Path)) diff --git a/src/Build/BackEnd/Client/MSBuildClient.cs b/src/Build/BackEnd/Client/MSBuildClient.cs index 9bd05788271..e1df9945e91 100644 --- a/src/Build/BackEnd/Client/MSBuildClient.cs +++ b/src/Build/BackEnd/Client/MSBuildClient.cs @@ -48,11 +48,7 @@ public sealed class MSBuildClient /// The command line to process. /// The first argument on the command line is assumed to be the name/path of the executable, and is ignored. /// -#if FEATURE_GET_COMMANDLINE - private readonly string _commandLine; -#else private readonly string[] _commandLine; -#endif /// /// The MSBuild client execution result. @@ -112,13 +108,7 @@ public sealed class MSBuildClient /// on the command line is assumed to be the name/path of the executable, and is ignored /// Full path to current MSBuild.exe if executable is MSBuild.exe, /// or to version of MSBuild.dll found to be associated with the current process. - public MSBuildClient( -#if FEATURE_GET_COMMANDLINE - string commandLine, -#else - string[] commandLine, -#endif - string msbuildLocation) + public MSBuildClient(string[] commandLine, string msbuildLocation) { _serverEnvironmentVariables = new(); _exitResult = new(); @@ -162,12 +152,7 @@ private void CreateNodePipeStream() public MSBuildClientExitResult Execute(CancellationToken cancellationToken) { // Command line in one string used only in human readable content. - string descriptiveCommandLine = -#if FEATURE_GET_COMMANDLINE - _commandLine; -#else - string.Join(" ", _commandLine); -#endif + string descriptiveCommandLine = string.Join(" ", _commandLine); CommunicationsUtilities.Trace("Executing build with command line '{0}'", descriptiveCommandLine); diff --git a/src/Build/BackEnd/Node/OutOfProcServerNode.cs b/src/Build/BackEnd/Node/OutOfProcServerNode.cs index e5b1e76f412..49ed1d610dd 100644 --- a/src/Build/BackEnd/Node/OutOfProcServerNode.cs +++ b/src/Build/BackEnd/Node/OutOfProcServerNode.cs @@ -25,12 +25,7 @@ public sealed class OutOfProcServerNode : INode, INodePacketFactory, INodePacket /// /// A callback used to execute command line build. /// - public delegate (int exitCode, string exitType) BuildCallback( -#if FEATURE_GET_COMMANDLINE - string commandLine); -#else - string[] commandLine); -#endif + public delegate (int exitCode, string exitType) BuildCallback(string[] commandLine); private readonly BuildCallback _buildFunction; diff --git a/src/Build/BackEnd/Node/ServerNodeBuildCommand.cs b/src/Build/BackEnd/Node/ServerNodeBuildCommand.cs index fc5bca7e920..ab067c7d4ad 100644 --- a/src/Build/BackEnd/Node/ServerNodeBuildCommand.cs +++ b/src/Build/BackEnd/Node/ServerNodeBuildCommand.cs @@ -14,11 +14,7 @@ namespace Microsoft.Build.BackEnd /// internal sealed class ServerNodeBuildCommand : INodePacket { -#if FEATURE_GET_COMMANDLINE - private string _commandLine = default!; -#else private string[] _commandLine = default!; -#endif private string _startupDirectory = default!; private Dictionary _buildProcessEnvironment = default!; private CultureInfo _culture = default!; @@ -34,11 +30,7 @@ internal sealed class ServerNodeBuildCommand : INodePacket /// /// Command line including arguments /// -#if FEATURE_GET_COMMANDLINE - public string CommandLine => _commandLine; -#else public string[] CommandLine => _commandLine; -#endif /// /// The startup directory @@ -79,11 +71,7 @@ private ServerNodeBuildCommand() } public ServerNodeBuildCommand( -#if FEATURE_GET_COMMANDLINE - string commandLine, -#else string[] commandLine, -#endif string startupDirectory, Dictionary buildProcessEnvironment, CultureInfo culture, CultureInfo uiCulture, diff --git a/src/Build/CompatibilitySuppressions.xml b/src/Build/CompatibilitySuppressions.xml index 0497d618a92..e1a53b3ea2e 100644 --- a/src/Build/CompatibilitySuppressions.xml +++ b/src/Build/CompatibilitySuppressions.xml @@ -1,3 +1,48 @@  - \ No newline at end of file + + + + + CP0002 + M:Microsoft.Build.Experimental.MSBuildClient.#ctor(System.String,System.String) + lib/net472/Microsoft.Build.dll + lib/net472/Microsoft.Build.dll + true + + + CP0002 + M:Microsoft.Build.Experimental.OutOfProcServerNode.BuildCallback.BeginInvoke(System.String,System.AsyncCallback,System.Object) + lib/net472/Microsoft.Build.dll + lib/net472/Microsoft.Build.dll + true + + + CP0002 + M:Microsoft.Build.Experimental.OutOfProcServerNode.BuildCallback.Invoke(System.String) + lib/net472/Microsoft.Build.dll + lib/net472/Microsoft.Build.dll + true + + + CP0002 + M:Microsoft.Build.Experimental.MSBuildClient.#ctor(System.String,System.String) + ref/net472/Microsoft.Build.dll + ref/net472/Microsoft.Build.dll + true + + + CP0002 + M:Microsoft.Build.Experimental.OutOfProcServerNode.BuildCallback.BeginInvoke(System.String,System.AsyncCallback,System.Object) + ref/net472/Microsoft.Build.dll + ref/net472/Microsoft.Build.dll + true + + + CP0002 + M:Microsoft.Build.Experimental.OutOfProcServerNode.BuildCallback.Invoke(System.String) + ref/net472/Microsoft.Build.dll + ref/net472/Microsoft.Build.dll + true + + diff --git a/src/Directory.BeforeCommon.targets b/src/Directory.BeforeCommon.targets index 73b91fe6c96..db68730447e 100644 --- a/src/Directory.BeforeCommon.targets +++ b/src/Directory.BeforeCommon.targets @@ -31,7 +31,6 @@ $(DefineConstants);FEATURE_ENVIRONMENT_SYSTEMDIRECTORY $(DefineConstants);FEATURE_FILE_TRACKER $(DefineConstants);FEATURE_GAC - $(DefineConstants);FEATURE_GET_COMMANDLINE $(DefineConstants);FEATURE_HANDLEPROCESSCORRUPTEDSTATEEXCEPTIONS $(DefineConstants);FEATURE_HTTP_LISTENER $(DefineConstants);FEATURE_INSTALLED_MSBUILD diff --git a/src/MSBuild.UnitTests/CommandLineParserTests.cs b/src/MSBuild.UnitTests/CommandLineParserTests.cs new file mode 100644 index 00000000000..cb5280d913c --- /dev/null +++ b/src/MSBuild.UnitTests/CommandLineParserTests.cs @@ -0,0 +1,39 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Microsoft.Build.CommandLine.Experimental; +using Shouldly; +using Xunit; + +namespace Microsoft.Build.CommandLine.UnitTests +{ + public class CommandLineParserTests + { + [Fact] + public void ParseReturnsInstance() + { + CommandLineParser parser = new CommandLineParser(); + CommandLineSwitchesAccessor result = parser.Parse(["/targets:targets.txt"]); // first parameter must be the executable name + + result.Targets.ShouldNotBeNull(); + result.Targets.ShouldBe(["targets.txt"]); + } + + [Fact] + public void ParseThrowsException() + { + CommandLineParser parser = new CommandLineParser(); + + Should.Throw(() => + { + // first parameter must be the executable name + parser.Parse(["tempproject.proj", "tempproject.proj"]); + }); + } + } +} diff --git a/src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs b/src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs index a2de7a8fb1c..7cbf86ce493 100644 --- a/src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs +++ b/src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs @@ -9,6 +9,7 @@ using System.Linq; using System.Resources; using Microsoft.Build.CommandLine; +using Microsoft.Build.CommandLine.Experimental; using Microsoft.Build.Construction; using Microsoft.Build.Execution; using Microsoft.Build.Framework; @@ -622,7 +623,9 @@ public void FeatureAvailibilitySwitchIdentificationTest(string switchName) public void TargetsSwitchParameter() { CommandLineSwitches switches = new CommandLineSwitches(); - MSBuildApp.GatherCommandLineSwitches(new List() { "/targets:targets.txt" }, switches); + CommandLineParser parser = new CommandLineParser(); + + parser.GatherCommandLineSwitches(["/targets:targets.txt"], switches); switches.HaveErrors().ShouldBeFalse(); switches[CommandLineSwitches.ParameterizedSwitch.Targets].ShouldBe(new[] { "targets.txt" }); @@ -632,7 +635,9 @@ public void TargetsSwitchParameter() public void TargetsSwitchDoesNotSupportMultipleOccurrences() { CommandLineSwitches switches = new CommandLineSwitches(); - MSBuildApp.GatherCommandLineSwitches(new List() { "/targets /targets" }, switches); + CommandLineParser parser = new CommandLineParser(); + + parser.GatherCommandLineSwitches(["/targets /targets"], switches); switches.HaveErrors().ShouldBeTrue(); } @@ -709,8 +714,9 @@ public void LowPrioritySwitchIdentificationTests(string lowpriority) public void GraphBuildSwitchCanHaveParameters() { CommandLineSwitches switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List { "/graph", "/graph:true; NoBuild ;; ;", "/graph:foo" }, switches); + parser.GatherCommandLineSwitches(["/graph", "/graph:true; NoBuild ;; ;", "/graph:foo"], switches); switches[CommandLineSwitches.ParameterizedSwitch.GraphBuild].ShouldBe(new[] { "true", " NoBuild ", " ", "foo" }); @@ -721,8 +727,9 @@ public void GraphBuildSwitchCanHaveParameters() public void GraphBuildSwitchCanBeParameterless() { CommandLineSwitches switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List { "/graph" }, switches); + parser.GatherCommandLineSwitches(["/graph"], switches); switches[CommandLineSwitches.ParameterizedSwitch.GraphBuild].ShouldBe(Array.Empty()); @@ -733,8 +740,9 @@ public void GraphBuildSwitchCanBeParameterless() public void InputResultsCachesSupportsMultipleOccurrence() { CommandLineSwitches switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List() { "/irc", "/irc:a;b", "/irc:c;d" }, switches); + parser.GatherCommandLineSwitches(["/irc", "/irc:a;b", "/irc:c;d"], switches); switches[CommandLineSwitches.ParameterizedSwitch.InputResultsCaches].ShouldBe(new[] { null, "a", "b", "c", "d" }); @@ -745,8 +753,9 @@ public void InputResultsCachesSupportsMultipleOccurrence() public void OutputResultsCache() { CommandLineSwitches switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List() { "/orc:a" }, switches); + parser.GatherCommandLineSwitches(["/orc:a"], switches); switches[CommandLineSwitches.ParameterizedSwitch.OutputResultsCache].ShouldBe(new[] { "a" }); @@ -757,8 +766,9 @@ public void OutputResultsCache() public void OutputResultsCachesDoesNotSupportMultipleOccurrences() { CommandLineSwitches switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List() { "/orc:a", "/orc:b" }, switches); + parser.GatherCommandLineSwitches(["/orc:a", "/orc:b"], switches); switches.HaveErrors().ShouldBeTrue(); } @@ -1288,8 +1298,9 @@ public void ExtractAnyLoggerParameterPickLast() public void ProcessWarnAsErrorSwitchNotSpecified() { CommandLineSwitches commandLineSwitches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List(new[] { "" }), commandLineSwitches); + parser.GatherCommandLineSwitches([""], commandLineSwitches); Assert.Null(MSBuildApp.ProcessWarnAsErrorSwitch(commandLineSwitches)); } @@ -1303,16 +1314,17 @@ public void ProcessWarnAsErrorSwitchWithCodes() ISet expectedWarningsAsErrors = new HashSet(StringComparer.OrdinalIgnoreCase) { "a", "B", "c", "D", "e" }; CommandLineSwitches commandLineSwitches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List(new[] - { + parser.GatherCommandLineSwitches( + [ "\"/warnaserror: a,B ; c \"", // Leading, trailing, leading and trailing whitespace "/warnaserror:A,b,C", // Repeats of different case "\"/warnaserror:, ,,\"", // Empty items "/err:D,d;E,e", // A different source with new items and uses the short form "/warnaserror:a", // A different source with a single duplicate "/warnaserror:a,b", // A different source with multiple duplicates - }), commandLineSwitches); + ], commandLineSwitches); ISet actualWarningsAsErrors = MSBuildApp.ProcessWarnAsErrorSwitch(commandLineSwitches); @@ -1328,12 +1340,13 @@ public void ProcessWarnAsErrorSwitchWithCodes() public void ProcessWarnAsErrorSwitchEmptySwitchClearsSet() { CommandLineSwitches commandLineSwitches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List(new[] - { + parser.GatherCommandLineSwitches( + [ "/warnaserror:a;b;c", "/warnaserror", - }), commandLineSwitches); + ], commandLineSwitches); ISet actualWarningsAsErrors = MSBuildApp.ProcessWarnAsErrorSwitch(commandLineSwitches); @@ -1351,13 +1364,14 @@ public void ProcessWarnAsErrorSwitchValuesAfterEmptyAddOn() ISet expectedWarningsAsErors = new HashSet(StringComparer.OrdinalIgnoreCase) { "e", "f", "g" }; CommandLineSwitches commandLineSwitches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List(new[] - { + parser.GatherCommandLineSwitches( + [ "/warnaserror:a;b;c", "/warnaserror", "/warnaserror:e;f;g", - }), commandLineSwitches); + ], commandLineSwitches); ISet actualWarningsAsErrors = MSBuildApp.ProcessWarnAsErrorSwitch(commandLineSwitches); @@ -1373,8 +1387,9 @@ public void ProcessWarnAsErrorSwitchValuesAfterEmptyAddOn() public void ProcessWarnAsErrorSwitchEmpty() { CommandLineSwitches commandLineSwitches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List(new[] { "/warnaserror" }), commandLineSwitches); + parser.GatherCommandLineSwitches(["/warnaserror"], commandLineSwitches); ISet actualWarningsAsErrors = MSBuildApp.ProcessWarnAsErrorSwitch(commandLineSwitches); @@ -1390,10 +1405,11 @@ public void ProcessWarnAsErrorSwitchEmpty() public void ProcessWarnAsMessageSwitchEmpty() { CommandLineSwitches commandLineSwitches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); // Set "expanded" content to match the placeholder so the verify can use the exact resource string as "expected." string command = "{0}"; - MSBuildApp.GatherCommandLineSwitches(new List(new[] { "/warnasmessage" }), commandLineSwitches, command); + parser.GatherCommandLineSwitches(["/warnasmessage"], commandLineSwitches, command); VerifySwitchError(commandLineSwitches, "/warnasmessage", AssemblyResources.GetString("MissingWarnAsMessageParameterError")); } @@ -1410,13 +1426,15 @@ public void ProcessEnvironmentVariableSwitch() env.SetEnvironmentVariable("ENVIRONMENTVARIABLE", string.Empty); CommandLineSwitches commandLineSwitches = new(); + CommandLineParser parser = new CommandLineParser(); + string fullCommandLine = "msbuild validProject.csproj %ENVIRONMENTVARIABLE%"; - MSBuildApp.GatherCommandLineSwitches(new List() { "validProject.csproj", "%ENVIRONMENTVARIABLE%" }, commandLineSwitches, fullCommandLine); + parser.GatherCommandLineSwitches(["validProject.csproj", "%ENVIRONMENTVARIABLE%"], commandLineSwitches, fullCommandLine); VerifySwitchError(commandLineSwitches, "%ENVIRONMENTVARIABLE%", String.Format(AssemblyResources.GetString("EnvironmentVariableAsSwitch"), fullCommandLine)); commandLineSwitches = new(); fullCommandLine = "msbuild %ENVIRONMENTVARIABLE% validProject.csproj"; - MSBuildApp.GatherCommandLineSwitches(new List() { "%ENVIRONMENTVARIABLE%", "validProject.csproj" }, commandLineSwitches, fullCommandLine); + parser.GatherCommandLineSwitches(["%ENVIRONMENTVARIABLE%", "validProject.csproj"], commandLineSwitches, fullCommandLine); VerifySwitchError(commandLineSwitches, "%ENVIRONMENTVARIABLE%", String.Format(AssemblyResources.GetString("EnvironmentVariableAsSwitch"), fullCommandLine)); } } @@ -1430,16 +1448,17 @@ public void ProcessWarnAsMessageSwitchWithCodes() ISet expectedWarningsAsMessages = new HashSet(StringComparer.OrdinalIgnoreCase) { "a", "B", "c", "D", "e" }; CommandLineSwitches commandLineSwitches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List(new[] - { + parser.GatherCommandLineSwitches( + [ "\"/warnasmessage: a,B ; c \"", // Leading, trailing, leading and trailing whitespace "/warnasmessage:A,b,C", // Repeats of different case "\"/warnasmessage:, ,,\"", // Empty items "/nowarn:D,d;E,e", // A different source with new items and uses the short form "/warnasmessage:a", // A different source with a single duplicate "/warnasmessage:a,b", // A different source with multiple duplicates - }), commandLineSwitches); + ], commandLineSwitches); ISet actualWarningsAsMessages = MSBuildApp.ProcessWarnAsMessageSwitch(commandLineSwitches); @@ -1455,8 +1474,9 @@ public void ProcessWarnAsMessageSwitchWithCodes() public void ProcessProfileEvaluationEmpty() { CommandLineSwitches commandLineSwitches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - MSBuildApp.GatherCommandLineSwitches(new List(new[] { "/profileevaluation" }), commandLineSwitches); + parser.GatherCommandLineSwitches(["/profileevaluation"], commandLineSwitches); commandLineSwitches[CommandLineSwitches.ParameterizedSwitch.ProfileEvaluation][0].ShouldBe("no-file"); } @@ -1548,11 +1568,7 @@ public void ProcessInvalidTargetSwitch() using TestEnvironment testEnvironment = TestEnvironment.Create(); string project = testEnvironment.CreateTestProjectWithFiles("project.proj", projectContent).ProjectFile; -#if FEATURE_GET_COMMANDLINE - MSBuildApp.Execute(@"msbuild.exe " + project + " /t:foo.bar").ShouldBe(MSBuildApp.ExitType.SwitchError); -#else - MSBuildApp.Execute(new[] { @"msbuild.exe", project, "/t:foo.bar" }).ShouldBe(MSBuildApp.ExitType.SwitchError); -#endif + MSBuildApp.Execute([@"msbuild.exe", project, "/t:foo.bar"]).ShouldBe(MSBuildApp.ExitType.SwitchError); } /// diff --git a/src/MSBuild.UnitTests/ProjectSchemaValidationHandler_Tests.cs b/src/MSBuild.UnitTests/ProjectSchemaValidationHandler_Tests.cs index 7a224860a2f..82fa56a588c 100644 --- a/src/MSBuild.UnitTests/ProjectSchemaValidationHandler_Tests.cs +++ b/src/MSBuild.UnitTests/ProjectSchemaValidationHandler_Tests.cs @@ -52,7 +52,7 @@ public void VerifyInvalidProjectSchema() "); string quotedProjectFilename = "\"" + projectFilename + "\""; - Assert.Equal(MSBuildApp.ExitType.InitializationError, MSBuildApp.Execute(@"c:\foo\msbuild.exe " + quotedProjectFilename + " /validate:\"" + msbuildTempXsdFilenames[0] + "\"")); + Assert.Equal(MSBuildApp.ExitType.InitializationError, MSBuildApp.Execute([@"c:\foo\msbuild.exe", quotedProjectFilename, $"/validate:\"{msbuildTempXsdFilenames[0]}\""])); } finally { @@ -95,7 +95,7 @@ public void VerifyInvalidSchemaItself1() "); string quotedProjectFile = "\"" + projectFilename + "\""; - Assert.Equal(MSBuildApp.ExitType.InitializationError, MSBuildApp.Execute(@"c:\foo\msbuild.exe " + quotedProjectFile + " /validate:\"" + invalidSchemaFile + "\"")); + Assert.Equal(MSBuildApp.ExitType.InitializationError, MSBuildApp.Execute([@"c:\foo\msbuild.exe", quotedProjectFile, $"/validate:\"{invalidSchemaFile}\""])); } finally { @@ -155,7 +155,7 @@ public void VerifyInvalidSchemaItself2() string quotedProjectFile = "\"" + projectFilename + "\""; - Assert.Equal(MSBuildApp.ExitType.InitializationError, MSBuildApp.Execute(@"c:\foo\msbuild.exe " + quotedProjectFile + " /validate:\"" + invalidSchemaFile + "\"")); + Assert.Equal(MSBuildApp.ExitType.InitializationError, MSBuildApp.Execute([@"c:\foo\msbuild.exe", quotedProjectFile, $"/validate:\"{invalidSchemaFile}\""])); } finally { @@ -203,7 +203,7 @@ public void VerifyValidProjectSchema() msbuildTempXsdFilenames = PrepareSchemaFiles(); string quotedProjectFile = "\"" + projectFilename + "\""; - Assert.Equal(MSBuildApp.ExitType.Success, MSBuildApp.Execute(@"c:\foo\msbuild.exe " + quotedProjectFile + " /validate:\"" + msbuildTempXsdFilenames[0] + "\"")); + Assert.Equal(MSBuildApp.ExitType.Success, MSBuildApp.Execute([@"c:\foo\msbuild.exe", quotedProjectFile, $"/validate:\"{msbuildTempXsdFilenames[0]}\""])); // ProjectSchemaValidationHandler.VerifyProjectSchema // ( @@ -256,7 +256,7 @@ public void VerifyInvalidImportNotCaughtBySchema() msbuildTempXsdFilenames = PrepareSchemaFiles(); string quotedProjectFile = "\"" + projectFilename + "\""; - Assert.Equal(MSBuildApp.ExitType.Success, MSBuildApp.Execute(@"c:\foo\msbuild.exe " + quotedProjectFile + " /validate:\"" + msbuildTempXsdFilenames[0] + "\"")); + Assert.Equal(MSBuildApp.ExitType.Success, MSBuildApp.Execute([@"c:\foo\msbuild.exe", quotedProjectFile, $"/validate:\"{msbuildTempXsdFilenames[0]}\""])); // ProjectSchemaValidationHandler.VerifyProjectSchema // ( diff --git a/src/MSBuild.UnitTests/XMake_Tests.cs b/src/MSBuild.UnitTests/XMake_Tests.cs index 9ee19bcb00d..8cdd6c467a9 100644 --- a/src/MSBuild.UnitTests/XMake_Tests.cs +++ b/src/MSBuild.UnitTests/XMake_Tests.cs @@ -14,6 +14,7 @@ using System.Threading; using System.Xml.Linq; using Microsoft.Build.CommandLine; +using Microsoft.Build.CommandLine.Experimental; using Microsoft.Build.Evaluation; using Microsoft.Build.Framework; using Microsoft.Build.Logging; @@ -96,11 +97,9 @@ public XMakeAppTests(ITestOutputHelper output) public void GatherCommandLineSwitchesTwoProperties() { CommandLineSwitches switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - var arguments = new List(); - arguments.AddRange(new[] { "/p:a=b", "/p:c=d" }); - - MSBuildApp.GatherCommandLineSwitches(arguments, switches); + parser.GatherCommandLineSwitches(["/p:a=b", "/p:c=d"], switches); string[] parameters = switches[CommandLineSwitches.ParameterizedSwitch.Property]; parameters[0].ShouldBe("a=b"); @@ -111,13 +110,9 @@ public void GatherCommandLineSwitchesTwoProperties() public void GatherCommandLineSwitchesAnyDash() { var switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - var arguments = new List { - "-p:a=b", - "--p:maxcpucount=8" - }; - - MSBuildApp.GatherCommandLineSwitches(arguments, switches); + parser.GatherCommandLineSwitches(["-p:a=b", "--p:maxcpucount=8"], switches); string[] parameters = switches[CommandLineSwitches.ParameterizedSwitch.Property]; parameters[0].ShouldBe("a=b"); @@ -128,11 +123,9 @@ public void GatherCommandLineSwitchesAnyDash() public void GatherCommandLineSwitchesMaxCpuCountWithArgument() { CommandLineSwitches switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - var arguments = new List(); - arguments.AddRange(new[] { "/m:2" }); - - MSBuildApp.GatherCommandLineSwitches(arguments, switches); + parser.GatherCommandLineSwitches(["/m:2"], switches); string[] parameters = switches[CommandLineSwitches.ParameterizedSwitch.MaxCPUCount]; parameters[0].ShouldBe("2"); @@ -145,11 +138,9 @@ public void GatherCommandLineSwitchesMaxCpuCountWithArgument() public void GatherCommandLineSwitchesMaxCpuCountWithoutArgument() { CommandLineSwitches switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - var arguments = new List(); - arguments.AddRange(new[] { "/m:3", "/m" }); - - MSBuildApp.GatherCommandLineSwitches(arguments, switches); + parser.GatherCommandLineSwitches(["/m:3", "/m"], switches); string[] parameters = switches[CommandLineSwitches.ParameterizedSwitch.MaxCPUCount]; parameters[1].ShouldBe(Convert.ToString(NativeMethodsShared.GetLogicalCoreCount())); @@ -165,11 +156,9 @@ public void GatherCommandLineSwitchesMaxCpuCountWithoutArgument() public void GatherCommandLineSwitchesMaxCpuCountWithoutArgumentButWithColon() { CommandLineSwitches switches = new CommandLineSwitches(); + CommandLineParser parser = new CommandLineParser(); - var arguments = new List(); - arguments.AddRange(new[] { "/m:" }); - - MSBuildApp.GatherCommandLineSwitches(arguments, switches); + parser.GatherCommandLineSwitches(["/m:"], switches); string[] parameters = switches[CommandLineSwitches.ParameterizedSwitch.MaxCPUCount]; parameters.Length.ShouldBe(0); @@ -459,44 +448,44 @@ public void ExtractSwitchParametersTest() { string commandLineArg = "\"/p:foo=\"bar"; string unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out var doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":\"foo=\"bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":\"foo=\"bar"); doubleQuotesRemovedFromArg.ShouldBe(2); commandLineArg = "\"/p:foo=bar\""; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar"); doubleQuotesRemovedFromArg.ShouldBe(2); commandLineArg = "/p:foo=bar"; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar"); doubleQuotesRemovedFromArg.ShouldBe(0); commandLineArg = "\"\"/p:foo=bar\""; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar\""); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar\""); doubleQuotesRemovedFromArg.ShouldBe(3); // this test is totally unreal -- we'd never attempt to extract switch parameters if the leading character is not a // switch indicator (either '-' or '/') -- here the leading character is a double-quote commandLineArg = "\"\"\"/p:foo=bar\""; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "/p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar\""); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "/p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar\""); doubleQuotesRemovedFromArg.ShouldBe(3); commandLineArg = "\"/pr\"operty\":foo=bar"; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "property", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "property", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar"); doubleQuotesRemovedFromArg.ShouldBe(3); commandLineArg = "\"/pr\"op\"\"erty\":foo=bar\""; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "property", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "property", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":foo=bar"); doubleQuotesRemovedFromArg.ShouldBe(6); commandLineArg = "/p:\"foo foo\"=\"bar bar\";\"baz=onga\""; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":\"foo foo\"=\"bar bar\";\"baz=onga\""); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 1).ShouldBe(":\"foo foo\"=\"bar bar\";\"baz=onga\""); doubleQuotesRemovedFromArg.ShouldBe(6); } @@ -505,37 +494,37 @@ public void ExtractSwitchParametersTestDoubleDash() { var commandLineArg = "\"--p:foo=\"bar"; var unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out var doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":\"foo=\"bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":\"foo=\"bar"); doubleQuotesRemovedFromArg.ShouldBe(2); commandLineArg = "\"--p:foo=bar\""; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar"); doubleQuotesRemovedFromArg.ShouldBe(2); commandLineArg = "--p:foo=bar"; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar"); doubleQuotesRemovedFromArg.ShouldBe(0); commandLineArg = "\"\"--p:foo=bar\""; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar\""); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar\""); doubleQuotesRemovedFromArg.ShouldBe(3); commandLineArg = "\"--pr\"operty\":foo=bar"; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "property", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "property", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar"); doubleQuotesRemovedFromArg.ShouldBe(3); commandLineArg = "\"--pr\"op\"\"erty\":foo=bar\""; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "property", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar"); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "property", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":foo=bar"); doubleQuotesRemovedFromArg.ShouldBe(6); commandLineArg = "--p:\"foo foo\"=\"bar bar\";\"baz=onga\""; unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out doubleQuotesRemovedFromArg); - MSBuildApp.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":\"foo foo\"=\"bar bar\";\"baz=onga\""); + CommandLineParser.ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, "p", unquotedCommandLineArg.IndexOf(':'), 2).ShouldBe(":\"foo foo\"=\"bar bar\";\"baz=onga\""); doubleQuotesRemovedFromArg.ShouldBe(6); } @@ -548,11 +537,11 @@ public void GetLengthOfSwitchIndicatorTest() var commandLineSwitchWithNoneOrIncorrectIndicator = "zSwitch"; - MSBuildApp.GetLengthOfSwitchIndicator(commandLineSwitchWithSlash).ShouldBe(1); - MSBuildApp.GetLengthOfSwitchIndicator(commandLineSwitchWithSingleDash).ShouldBe(1); - MSBuildApp.GetLengthOfSwitchIndicator(commandLineSwitchWithDoubleDash).ShouldBe(2); + CommandLineParser.GetLengthOfSwitchIndicator(commandLineSwitchWithSlash).ShouldBe(1); + CommandLineParser.GetLengthOfSwitchIndicator(commandLineSwitchWithSingleDash).ShouldBe(1); + CommandLineParser.GetLengthOfSwitchIndicator(commandLineSwitchWithDoubleDash).ShouldBe(2); - MSBuildApp.GetLengthOfSwitchIndicator(commandLineSwitchWithNoneOrIncorrectIndicator).ShouldBe(0); + CommandLineParser.GetLengthOfSwitchIndicator(commandLineSwitchWithNoneOrIncorrectIndicator).ShouldBe(0); } [Theory] @@ -562,12 +551,7 @@ public void GetLengthOfSwitchIndicatorTest() [InlineData(@"/h")] public void Help(string indicator) { - MSBuildApp.Execute( -#if FEATURE_GET_COMMANDLINE - @$"c:\bin\msbuild.exe {indicator} ") -#else - new[] { @"c:\bin\msbuild.exe", indicator }) -#endif + MSBuildApp.Execute([@"c:\bin\msbuild.exe", indicator]) .ShouldBe(MSBuildApp.ExitType.Success); } @@ -660,19 +644,11 @@ public void VersionSwitchDisableChangeWave() public void ErrorCommandLine() { string oldValueForMSBuildLoadMicrosoftTargetsReadOnly = Environment.GetEnvironmentVariable("MSBuildLoadMicrosoftTargetsReadOnly"); -#if FEATURE_GET_COMMANDLINE - MSBuildApp.Execute(@"c:\bin\msbuild.exe -junk").ShouldBe(MSBuildApp.ExitType.SwitchError); - - MSBuildApp.Execute(@"msbuild.exe -t").ShouldBe(MSBuildApp.ExitType.SwitchError); - - MSBuildApp.Execute(@"msbuild.exe @bogus.rsp").ShouldBe(MSBuildApp.ExitType.InitializationError); -#else - MSBuildApp.Execute(new[] { @"c:\bin\msbuild.exe", "-junk" }).ShouldBe(MSBuildApp.ExitType.SwitchError); - MSBuildApp.Execute(new[] { @"msbuild.exe", "-t" }).ShouldBe(MSBuildApp.ExitType.SwitchError); + MSBuildApp.Execute([@"c:\bin\msbuild.exe", "-junk"]).ShouldBe(MSBuildApp.ExitType.SwitchError); + MSBuildApp.Execute([@"msbuild.exe", "-t"]).ShouldBe(MSBuildApp.ExitType.SwitchError); + MSBuildApp.Execute([@"msbuild.exe", "@bogus.rsp"]).ShouldBe(MSBuildApp.ExitType.InitializationError); - MSBuildApp.Execute(new[] { @"msbuild.exe", "@bogus.rsp" }).ShouldBe(MSBuildApp.ExitType.InitializationError); -#endif Environment.SetEnvironmentVariable("MSBuildLoadMicrosoftTargetsReadOnly", oldValueForMSBuildLoadMicrosoftTargetsReadOnly); } @@ -1185,11 +1161,7 @@ public void TestEnvironmentTest() sw.WriteLine(projectString); } // Should pass -#if FEATURE_GET_COMMANDLINE - MSBuildApp.Execute(@"c:\bin\msbuild.exe " + quotedProjectFileName).ShouldBe(MSBuildApp.ExitType.Success); -#else - MSBuildApp.Execute(new[] { @"c:\bin\msbuild.exe", quotedProjectFileName }).ShouldBe(MSBuildApp.ExitType.Success); -#endif + MSBuildApp.Execute([@"c:\bin\msbuild.exe", quotedProjectFileName]).ShouldBe(MSBuildApp.ExitType.Success); } finally { @@ -1222,21 +1194,15 @@ public void MSBuildEngineLogger() { sw.WriteLine(projectString); } -#if FEATURE_GET_COMMANDLINE // Should pass - MSBuildApp.Execute(@$"c:\bin\msbuild.exe /logger:FileLogger,""Microsoft.Build, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"";""LogFile={logFile}"" /verbosity:detailed " + quotedProjectFileName).ShouldBe(MSBuildApp.ExitType.Success); - -#else - // Should pass - MSBuildApp.Execute( - new[] - { + MSBuildApp + .Execute([ NativeMethodsShared.IsWindows ? @"c:\bin\msbuild.exe" : "/msbuild.exe", @$"/logger:FileLogger,""Microsoft.Build, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"";""LogFile={logFile}""", "/verbosity:detailed", - quotedProjectFileName - }).ShouldBe(MSBuildApp.ExitType.Success); -#endif + quotedProjectFileName]) + .ShouldBe(MSBuildApp.ExitType.Success); + File.Exists(logFile).ShouldBeTrue(); var logFileContents = File.ReadAllText(logFile); @@ -3115,6 +3081,20 @@ public void TasksGetAssemblyLoadContexts() #endif + [Fact] + public void ThrowsWhenMaxCpuCountTooLargeForMultiThreadedAndForceAllTasksOutOfProc() + { + string projectContent = """ + + + """; + using TestEnvironment testEnvironment = TestEnvironment.Create(); + testEnvironment.SetEnvironmentVariable("MSBUILDFORCEALLTASKSOUTOFPROC", "1"); + string project = testEnvironment.CreateTestProjectWithFiles("project.proj", projectContent).ProjectFile; + + MSBuildApp.Execute([@"c:\bin\msbuild.exe", project, "/m:257 /mt"]).ShouldBe(MSBuildApp.ExitType.SwitchError); + } + private string CopyMSBuild() { string dest = null; diff --git a/src/MSBuild/AssemblyInfo.cs b/src/MSBuild/AssemblyInfo.cs index f93e8a6db00..c0407dd5a2d 100644 --- a/src/MSBuild/AssemblyInfo.cs +++ b/src/MSBuild/AssemblyInfo.cs @@ -11,6 +11,9 @@ [assembly: InternalsVisibleTo("Microsoft.Build.CommandLine.UnitTests, PublicKey=002400000480000094000000060200000024000052534131000400000100010015c01ae1f50e8cc09ba9eac9147cf8fd9fce2cfe9f8dce4f7301c4132ca9fb50ce8cbf1df4dc18dd4d210e4345c744ecb3365ed327efdbc52603faa5e21daa11234c8c4a73e51f03bf192544581ebe107adee3a34928e39d04e524a9ce729d5090bfd7dad9d10c722c0def9ccc08ff0a03790e48bcd1f9b6c476063e1966a1c4")] [assembly: InternalsVisibleTo("Microsoft.Build.Utilities.UnitTests, PublicKey=002400000480000094000000060200000024000052534131000400000100010015c01ae1f50e8cc09ba9eac9147cf8fd9fce2cfe9f8dce4f7301c4132ca9fb50ce8cbf1df4dc18dd4d210e4345c744ecb3365ed327efdbc52603faa5e21daa11234c8c4a73e51f03bf192544581ebe107adee3a34928e39d04e524a9ce729d5090bfd7dad9d10c722c0def9ccc08ff0a03790e48bcd1f9b6c476063e1966a1c4")] +// Grant the dotnet CLI access to our command-line parsing logic, which it uses to parse MSBuild arguments. +[assembly: InternalsVisibleTo("dotnet, PublicKey=0024000004800000940000000602000000240000525341310004000001000100f33a29044fa9d740c9b3213a93e57c84b472c84e0b8a0e1ae48e67a9f8f6de9d5f7f3d52ac23e48ac51801f1dc950abe901da34d2a9e3baadb141a17c77ef3c565dd5ee5054b91cf63bb3c6ab83f72ab3aafe93d0fc3c2348b764fafb0b1c0733de51459aeab46580384bf9d74c4e28164b7cde247f891ba07891c9d872ad2bb")] + // This will enable passing the SafeDirectories flag to any P/Invoke calls/implementations within the assembly, // so that we don't run into known security issues with loading libraries from unsafe locations [assembly: DefaultDllImportSearchPaths(DllImportSearchPath.SafeDirectories)] diff --git a/src/MSBuild/CommandLine/CommandLineParser.cs b/src/MSBuild/CommandLine/CommandLineParser.cs new file mode 100644 index 00000000000..ace7267233a --- /dev/null +++ b/src/MSBuild/CommandLine/CommandLineParser.cs @@ -0,0 +1,637 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Runtime; +using System.Security; +using System.Text; +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using System.Xml.Linq; +using Microsoft.Build.Shared; +using Microsoft.Build.Shared.FileSystem; + +#nullable disable + +namespace Microsoft.Build.CommandLine.Experimental +{ + internal class CommandLineParser + { + /// + /// String replacement pattern to support paths in response files. + /// + private const string responseFilePathReplacement = "%MSBuildThisFileDirectory%"; + + /// + /// The name of an auto-response file to search for in the project directory and above. + /// + private const string directoryResponseFileName = "Directory.Build.rsp"; + + /// + /// The name of the auto-response file. + /// + private const string autoResponseFileName = "MSBuild.rsp"; + + /// + /// Used to keep track of response files to prevent them from + /// being included multiple times (or even recursively). + /// + private List includedResponseFiles; + + internal IReadOnlyList IncludedResponseFiles => includedResponseFiles ?? (IReadOnlyList)Array.Empty(); + + /// + /// Parses the provided command-line arguments into a . + /// + /// + /// The command-line arguments excluding the executable path. + /// + /// + /// A containing the effective set of switches after combining + /// switches from response files (including any auto-response file) with switches from the command line, + /// where command-line switches take precedence. + /// + /// + /// Thrown when invalid switch syntax or values are encountered while parsing the command line or response files. + /// + public CommandLineSwitchesAccessor Parse(IEnumerable commandLineArgs) + { + List args = [BuildEnvironmentHelper.Instance.CurrentMSBuildExePath, ..commandLineArgs]; + + GatherAllSwitches( + args, + out CommandLineSwitches responseFileSwitches, + out CommandLineSwitches commandLineSwitches, + out string fullCommandLine, + out _); + + CommandLineSwitches result = new CommandLineSwitches(); + result.Append(responseFileSwitches, fullCommandLine); // lowest precedence + result.Append(commandLineSwitches, fullCommandLine); + + result.ThrowErrors(); + + return new CommandLineSwitchesAccessor(result); + } + + /// + /// Gets all specified switches, from the command line, as well as all + /// response files, including the auto-response file. + /// + /// + /// + /// + /// + /// Combined bag of switches. + internal void GatherAllSwitches( + IEnumerable commandLineArgs, + out CommandLineSwitches switchesFromAutoResponseFile, + out CommandLineSwitches switchesNotFromAutoResponseFile, + out string fullCommandLine, + out string exeName) + { + ResetGatheringSwitchesState(); + + // discard the first piece, because that's the path to the executable -- the rest are args + commandLineArgs = commandLineArgs.Skip(1); + + exeName = BuildEnvironmentHelper.Instance.CurrentMSBuildExePath; + +#if USE_MSBUILD_DLL_EXTN + var msbuildExtn = ".dll"; +#else + var msbuildExtn = ".exe"; +#endif + if (!exeName.EndsWith(msbuildExtn, StringComparison.OrdinalIgnoreCase)) + { + exeName += msbuildExtn; + } + + fullCommandLine = $"'{string.Join(" ", commandLineArgs)}'"; + + // parse the command line, and flag syntax errors and obvious switch errors + switchesNotFromAutoResponseFile = new CommandLineSwitches(); + GatherCommandLineSwitches(commandLineArgs, switchesNotFromAutoResponseFile, fullCommandLine); + + // parse the auto-response file (if "/noautoresponse" is not specified), and combine those switches with the + // switches on the command line + switchesFromAutoResponseFile = new CommandLineSwitches(); + if (!switchesNotFromAutoResponseFile[CommandLineSwitches.ParameterlessSwitch.NoAutoResponse]) + { + string exePath = Path.GetDirectoryName(FileUtilities.ExecutingAssemblyPath); // Copied from XMake + GatherAutoResponseFileSwitches(exePath, switchesFromAutoResponseFile, fullCommandLine); + } + } + + /// + /// Coordinates the parsing of the command line. It detects switches on the command line, gathers their parameters, and + /// flags syntax errors, and other obvious switch errors. + /// + /// + /// Internal for unit testing only. + /// + internal void GatherCommandLineSwitches(IEnumerable commandLineArgs, CommandLineSwitches commandLineSwitches, string commandLine = "") + { + foreach (string commandLineArg in commandLineArgs) + { + string unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out var doubleQuotesRemovedFromArg); + + if (unquotedCommandLineArg.Length > 0) + { + // response file switch starts with @ + if (unquotedCommandLineArg.StartsWith("@", StringComparison.Ordinal)) + { + GatherResponseFileSwitch(unquotedCommandLineArg, commandLineSwitches, commandLine); + } + else + { + string switchName; + string switchParameters; + + // all switches should start with - or / or -- unless a project is being specified + if (!ValidateSwitchIndicatorInUnquotedArgument(unquotedCommandLineArg) || FileUtilities.LooksLikeUnixFilePath(unquotedCommandLineArg)) + { + switchName = null; + // add a (fake) parameter indicator for later parsing + switchParameters = $":{commandLineArg}"; + } + else + { + // check if switch has parameters (look for the : parameter indicator) + int switchParameterIndicator = unquotedCommandLineArg.IndexOf(':'); + + // get the length of the beginning sequence considered as a switch indicator (- or / or --) + int switchIndicatorsLength = GetLengthOfSwitchIndicator(unquotedCommandLineArg); + + // extract the switch name and parameters -- the name is sandwiched between the switch indicator (the + // leading - or / or --) and the parameter indicator (if the switch has parameters); the parameters (if any) + // follow the parameter indicator + if (switchParameterIndicator == -1) + { + switchName = unquotedCommandLineArg.Substring(switchIndicatorsLength); + switchParameters = string.Empty; + } + else + { + switchName = unquotedCommandLineArg.Substring(switchIndicatorsLength, switchParameterIndicator - switchIndicatorsLength); + switchParameters = ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, switchName, switchParameterIndicator, switchIndicatorsLength); + } + } + + // Special case: for the switches "/m" (or "/maxCpuCount") and "/bl" (or "/binarylogger") we wish to pretend we saw a default argument + // This allows a subsequent /m:n on the command line to override it. + // We could create a new kind of switch with optional parameters, but it's a great deal of churn for this single case. + // Note that if no "/m" or "/maxCpuCount" switch -- either with or without parameters -- is present, then we still default to 1 cpu + // for backwards compatibility. + if (string.IsNullOrEmpty(switchParameters)) + { + if (string.Equals(switchName, "m", StringComparison.OrdinalIgnoreCase) || + string.Equals(switchName, "maxcpucount", StringComparison.OrdinalIgnoreCase)) + { + int numberOfCpus = NativeMethodsShared.GetLogicalCoreCount(); + switchParameters = $":{numberOfCpus}"; + } + else if (string.Equals(switchName, "bl", StringComparison.OrdinalIgnoreCase) || + string.Equals(switchName, "binarylogger", StringComparison.OrdinalIgnoreCase)) + { + // we have to specify at least one parameter otherwise it's impossible to distinguish the situation + // where /bl is not specified at all vs. where /bl is specified without the file name. + switchParameters = ":msbuild.binlog"; + } + else if (string.Equals(switchName, "prof", StringComparison.OrdinalIgnoreCase) || + string.Equals(switchName, "profileevaluation", StringComparison.OrdinalIgnoreCase)) + { + switchParameters = ":no-file"; + } + } + + if (CommandLineSwitches.IsParameterlessSwitch(switchName, out var parameterlessSwitch, out var duplicateSwitchErrorMessage)) + { + GatherParameterlessCommandLineSwitch(commandLineSwitches, parameterlessSwitch, switchParameters, duplicateSwitchErrorMessage, unquotedCommandLineArg, commandLine); + } + else if (CommandLineSwitches.IsParameterizedSwitch(switchName, out var parameterizedSwitch, out duplicateSwitchErrorMessage, out var multipleParametersAllowed, out var missingParametersErrorMessage, out var unquoteParameters, out var allowEmptyParameters)) + { + GatherParameterizedCommandLineSwitch(commandLineSwitches, parameterizedSwitch, switchParameters, duplicateSwitchErrorMessage, multipleParametersAllowed, missingParametersErrorMessage, unquoteParameters, unquotedCommandLineArg, allowEmptyParameters, commandLine); + } + else + { + commandLineSwitches.SetUnknownSwitchError(unquotedCommandLineArg, commandLine); + } + } + } + } + } + + /// + /// Called when a response file switch is detected on the command line. It loads the specified response file, and parses + /// each line in it like a command line. It also prevents multiple (or recursive) inclusions of the same response file. + /// + /// + /// + private void GatherResponseFileSwitch(string unquotedCommandLineArg, CommandLineSwitches commandLineSwitches, string commandLine) + { + try + { + string responseFile = FileUtilities.FixFilePath(unquotedCommandLineArg.Substring(1)); + + if (responseFile.Length == 0) + { + commandLineSwitches.SetSwitchError("MissingResponseFileError", unquotedCommandLineArg, commandLine); + } + else if (!FileSystems.Default.FileExists(responseFile)) + { + commandLineSwitches.SetParameterError("ResponseFileNotFoundError", unquotedCommandLineArg, commandLine); + } + else + { + // normalize the response file path to help catch multiple (or recursive) inclusions + responseFile = Path.GetFullPath(responseFile); + // NOTE: for network paths or mapped paths, normalization is not guaranteed to work + + bool isRepeatedResponseFile = false; + + foreach (string includedResponseFile in includedResponseFiles) + { + if (string.Equals(responseFile, includedResponseFile, StringComparison.OrdinalIgnoreCase)) + { + commandLineSwitches.SetParameterError("RepeatedResponseFileError", unquotedCommandLineArg, commandLine); + isRepeatedResponseFile = true; + break; + } + } + + if (!isRepeatedResponseFile) + { + var responseFileDirectory = FileUtilities.EnsureTrailingSlash(Path.GetDirectoryName(responseFile)); + includedResponseFiles.Add(responseFile); + + List argsFromResponseFile; + +#if FEATURE_ENCODING_DEFAULT + using (StreamReader responseFileContents = new StreamReader(responseFile, Encoding.Default)) // HIGHCHAR: If response files have no byte-order marks, then assume ANSI rather than ASCII. +#else + using (StreamReader responseFileContents = FileUtilities.OpenRead(responseFile)) // HIGHCHAR: If response files have no byte-order marks, then assume ANSI rather than ASCII. +#endif + { + argsFromResponseFile = new List(); + + while (responseFileContents.Peek() != -1) + { + // ignore leading whitespace on each line + string responseFileLine = responseFileContents.ReadLine().TrimStart(); + + // skip comment lines beginning with # + if (!responseFileLine.StartsWith("#", StringComparison.Ordinal)) + { + // Allow special case to support a path relative to the .rsp file being processed. + responseFileLine = Regex.Replace(responseFileLine, responseFilePathReplacement, + responseFileDirectory, RegexOptions.IgnoreCase); + + // treat each line of the response file like a command line i.e. args separated by whitespace + argsFromResponseFile.AddRange(QuotingUtilities.SplitUnquoted(Environment.ExpandEnvironmentVariables(responseFileLine))); + } + } + } + + CommandLineSwitches.SwitchesFromResponseFiles.Add((responseFile, string.Join(" ", argsFromResponseFile))); + + GatherCommandLineSwitches(argsFromResponseFile, commandLineSwitches, commandLine); + } + } + } + catch (NotSupportedException e) + { + commandLineSwitches.SetParameterError("ReadResponseFileError", unquotedCommandLineArg, e, commandLine); + } + catch (SecurityException e) + { + commandLineSwitches.SetParameterError("ReadResponseFileError", unquotedCommandLineArg, e, commandLine); + } + catch (UnauthorizedAccessException e) + { + commandLineSwitches.SetParameterError("ReadResponseFileError", unquotedCommandLineArg, e, commandLine); + } + catch (IOException e) + { + commandLineSwitches.SetParameterError("ReadResponseFileError", unquotedCommandLineArg, e, commandLine); + } + } + + /// + /// Called when a switch that doesn't take parameters is detected on the command line. + /// + /// + /// + /// + /// + /// + private static void GatherParameterlessCommandLineSwitch( + CommandLineSwitches commandLineSwitches, + CommandLineSwitches.ParameterlessSwitch parameterlessSwitch, + string switchParameters, + string duplicateSwitchErrorMessage, + string unquotedCommandLineArg, + string commandLine) + { + // switch should not have any parameters + if (switchParameters.Length == 0) + { + // check if switch is duplicated, and if that's allowed + if (!commandLineSwitches.IsParameterlessSwitchSet(parameterlessSwitch) || + (duplicateSwitchErrorMessage == null)) + { + commandLineSwitches.SetParameterlessSwitch(parameterlessSwitch, unquotedCommandLineArg); + } + else + { + commandLineSwitches.SetSwitchError(duplicateSwitchErrorMessage, unquotedCommandLineArg, commandLine); + } + } + else + { + commandLineSwitches.SetUnexpectedParametersError(unquotedCommandLineArg, commandLine); + } + } + + /// + /// Called when a switch that takes parameters is detected on the command line. This method flags errors and stores the + /// switch parameters. + /// + /// + /// + /// + /// + /// + /// + /// + /// + private static void GatherParameterizedCommandLineSwitch( + CommandLineSwitches commandLineSwitches, + CommandLineSwitches.ParameterizedSwitch parameterizedSwitch, + string switchParameters, + string duplicateSwitchErrorMessage, + bool multipleParametersAllowed, + string missingParametersErrorMessage, + bool unquoteParameters, + string unquotedCommandLineArg, + bool allowEmptyParameters, + string commandLine) + { + if (// switch must have parameters + (switchParameters.Length > 1) || + // unless the parameters are optional + (missingParametersErrorMessage == null)) + { + // skip the parameter indicator (if any) + if (switchParameters.Length > 0) + { + switchParameters = switchParameters.Substring(1); + } + + if (parameterizedSwitch == CommandLineSwitches.ParameterizedSwitch.Project && IsEnvironmentVariable(switchParameters)) + { + commandLineSwitches.SetSwitchError("EnvironmentVariableAsSwitch", unquotedCommandLineArg, commandLine); + } + + // check if switch is duplicated, and if that's allowed + if (!commandLineSwitches.IsParameterizedSwitchSet(parameterizedSwitch) || + (duplicateSwitchErrorMessage == null)) + { + // save the parameters after unquoting and splitting them if necessary + if (!commandLineSwitches.SetParameterizedSwitch(parameterizedSwitch, unquotedCommandLineArg, switchParameters, multipleParametersAllowed, unquoteParameters, allowEmptyParameters)) + { + // if parsing revealed there were no real parameters, flag an error, unless the parameters are optional + if (missingParametersErrorMessage != null) + { + commandLineSwitches.SetSwitchError(missingParametersErrorMessage, unquotedCommandLineArg, commandLine); + } + } + } + else + { + commandLineSwitches.SetSwitchError(duplicateSwitchErrorMessage, unquotedCommandLineArg, commandLine); + } + } + else + { + commandLineSwitches.SetSwitchError(missingParametersErrorMessage, unquotedCommandLineArg, commandLine); + } + } + + /// + /// Identifies if there is rsp files near the project file + /// + /// true if there autoresponse file was found + internal bool CheckAndGatherProjectAutoResponseFile(CommandLineSwitches switchesFromAutoResponseFile, CommandLineSwitches commandLineSwitches, bool recursing, string commandLine) + { + bool found = false; + + var projectDirectory = GetProjectDirectory(commandLineSwitches[CommandLineSwitches.ParameterizedSwitch.Project]); + + if (!recursing && !commandLineSwitches[CommandLineSwitches.ParameterlessSwitch.NoAutoResponse]) + { + // gather any switches from the first Directory.Build.rsp found in the project directory or above + string directoryResponseFile = FileUtilities.GetPathOfFileAbove(directoryResponseFileName, projectDirectory); + + found = !string.IsNullOrWhiteSpace(directoryResponseFile) && GatherAutoResponseFileSwitchesFromFullPath(directoryResponseFile, switchesFromAutoResponseFile, commandLine); + + // Don't look for more response files if it's only in the same place we already looked (next to the exe) + string exePath = Path.GetDirectoryName(FileUtilities.ExecutingAssemblyPath); // Copied from XMake + if (!string.Equals(projectDirectory, exePath, StringComparison.OrdinalIgnoreCase)) + { + // this combines any found, with higher precedence, with the switches from the original auto response file switches + found |= GatherAutoResponseFileSwitches(projectDirectory, switchesFromAutoResponseFile, commandLine); + } + } + + return found; + } + + private static string GetProjectDirectory(string[] projectSwitchParameters) + { + string projectDirectory = "."; + ErrorUtilities.VerifyThrow(projectSwitchParameters.Length <= 1, "Expect exactly one project at a time."); + + if (projectSwitchParameters.Length == 1) + { + var projectFile = FileUtilities.FixFilePath(projectSwitchParameters[0]); + + if (FileSystems.Default.DirectoryExists(projectFile)) + { + // the provided argument value is actually the directory + projectDirectory = projectFile; + } + else + { + InitializationException.VerifyThrow(FileSystems.Default.FileExists(projectFile), "ProjectNotFoundError", projectFile); + projectDirectory = Path.GetDirectoryName(Path.GetFullPath(projectFile)); + } + } + + return projectDirectory; + } + + /// + /// Extracts a switch's parameters after processing all quoting around the switch. + /// + /// + /// This method is marked "internal" for unit-testing purposes only -- ideally it should be "private". + /// + /// + /// + /// + /// + /// + /// + /// The given switch's parameters (with interesting quoting preserved). + internal static string ExtractSwitchParameters( + string commandLineArg, + string unquotedCommandLineArg, + int doubleQuotesRemovedFromArg, + string switchName, + int switchParameterIndicator, + int switchIndicatorsLength) + { + + // find the parameter indicator again using the quoted arg + // NOTE: since the parameter indicator cannot be part of a switch name, quoting around it is not relevant, because a + // parameter indicator cannot be escaped or made into a literal + int quotedSwitchParameterIndicator = commandLineArg.IndexOf(':'); + + // check if there is any quoting in the name portion of the switch + string unquotedSwitchIndicatorAndName = QuotingUtilities.Unquote(commandLineArg.Substring(0, quotedSwitchParameterIndicator), out var doubleQuotesRemovedFromSwitchIndicatorAndName); + + ErrorUtilities.VerifyThrow(switchName == unquotedSwitchIndicatorAndName.Substring(switchIndicatorsLength), + "The switch name extracted from either the partially or completely unquoted arg should be the same."); + + ErrorUtilities.VerifyThrow(doubleQuotesRemovedFromArg >= doubleQuotesRemovedFromSwitchIndicatorAndName, + "The name portion of the switch cannot contain more quoting than the arg itself."); + + string switchParameters; + // if quoting in the name portion of the switch was terminated + if ((doubleQuotesRemovedFromSwitchIndicatorAndName % 2) == 0) + { + // get the parameters exactly as specified on the command line i.e. including quoting + switchParameters = commandLineArg.Substring(quotedSwitchParameterIndicator); + } + else + { + // if quoting was not terminated in the name portion of the switch, and the terminal double-quote (if any) + // terminates the switch parameters + int terminalDoubleQuote = commandLineArg.IndexOf('"', quotedSwitchParameterIndicator + 1); + if (((doubleQuotesRemovedFromArg - doubleQuotesRemovedFromSwitchIndicatorAndName) <= 1) && + ((terminalDoubleQuote == -1) || (terminalDoubleQuote == (commandLineArg.Length - 1)))) + { + // then the parameters are not quoted in any interesting way, so use the unquoted parameters + switchParameters = unquotedCommandLineArg.Substring(switchParameterIndicator); + } + else + { + // otherwise, use the quoted parameters, after compensating for the quoting that was started in the name + // portion of the switch + switchParameters = $":\"{commandLineArg.Substring(quotedSwitchParameterIndicator + 1)}"; + } + } + + ErrorUtilities.VerifyThrow(switchParameters != null, "We must be able to extract the switch parameters."); + + return switchParameters; + } + + /// + /// Checks whether envVar is an environment variable. MSBuild uses + /// Environment.ExpandEnvironmentVariables(string), which only + /// considers %-delimited variables. + /// + /// A possible environment variable + /// Whether envVar is an environment variable + private static bool IsEnvironmentVariable(string envVar) + { + return envVar.StartsWith("%") && envVar.EndsWith("%") && envVar.Length > 1; + } + + /// + /// Parses the auto-response file (assumes the "/noautoresponse" switch is not specified on the command line), and combines the + /// switches from the auto-response file with the switches passed in. + /// Returns true if the response file was found. + /// + private bool GatherAutoResponseFileSwitches(string path, CommandLineSwitches switchesFromAutoResponseFile, string commandLine) + { + string autoResponseFile = Path.Combine(path, autoResponseFileName); + return GatherAutoResponseFileSwitchesFromFullPath(autoResponseFile, switchesFromAutoResponseFile, commandLine); + } + + private bool GatherAutoResponseFileSwitchesFromFullPath(string autoResponseFile, CommandLineSwitches switchesFromAutoResponseFile, string commandLine) + { + bool found = false; + + // if the auto-response file does not exist, only use the switches on the command line + if (FileSystems.Default.FileExists(autoResponseFile)) + { + found = true; + GatherResponseFileSwitch($"@{autoResponseFile}", switchesFromAutoResponseFile, commandLine); + + // if the "/noautoresponse" switch was set in the auto-response file, flag an error + if (switchesFromAutoResponseFile[CommandLineSwitches.ParameterlessSwitch.NoAutoResponse]) + { + switchesFromAutoResponseFile.SetSwitchError("CannotAutoDisableAutoResponseFile", + switchesFromAutoResponseFile.GetParameterlessSwitchCommandLineArg(CommandLineSwitches.ParameterlessSwitch.NoAutoResponse), commandLine); + } + + // Throw errors found in the response file + switchesFromAutoResponseFile.ThrowErrors(); + } + + return found; + } + + /// + /// Checks whether an argument given as a parameter starts with valid indicator, + ///
which means, whether switch begins with one of: "/", "-", "--" + /// + /// Command line argument with beginning indicator (e.g. --help). + ///
This argument has to be unquoted, otherwise the first character will always be a quote character " + /// true if argument's beginning matches one of possible indicators + ///
false if argument's beginning doesn't match any of correct indicator + /// + private static bool ValidateSwitchIndicatorInUnquotedArgument(string unquotedCommandLineArgument) + { + return unquotedCommandLineArgument.StartsWith("-", StringComparison.Ordinal) // superset of "--" + || unquotedCommandLineArgument.StartsWith("/", StringComparison.Ordinal); + } + + /// + /// Gets the length of the switch indicator (- or / or --) + ///
The length returned from this method is deduced from the beginning sequence of unquoted argument. + ///
This way it will "assume" that there's no further error (e.g. // or ---) which would also be considered as a correct indicator. + /// + /// Unquoted argument with leading indicator and name + /// Correct length of used indicator + ///
0 if no leading sequence recognized as correct indicator + /// Internal for testing purposes + internal static int GetLengthOfSwitchIndicator(string unquotedSwitch) + { + if (unquotedSwitch.StartsWith("--", StringComparison.Ordinal)) + { + return 2; + } + else if (unquotedSwitch.StartsWith("-", StringComparison.Ordinal) || unquotedSwitch.StartsWith("/", StringComparison.Ordinal)) + { + return 1; + } + else + { + return 0; + } + } + + public void ResetGatheringSwitchesState() + { + includedResponseFiles = new List(); + CommandLineSwitches.SwitchesFromResponseFiles = new(); + } + } +} diff --git a/src/MSBuild/CommandLineSwitchException.cs b/src/MSBuild/CommandLine/CommandLineSwitchException.cs similarity index 99% rename from src/MSBuild/CommandLineSwitchException.cs rename to src/MSBuild/CommandLine/CommandLineSwitchException.cs index e8ce5dd036d..54ec5e65ef2 100644 --- a/src/MSBuild/CommandLineSwitchException.cs +++ b/src/MSBuild/CommandLine/CommandLineSwitchException.cs @@ -11,7 +11,7 @@ #nullable disable -namespace Microsoft.Build.CommandLine +namespace Microsoft.Build.CommandLine.Experimental { /// /// This exception is used to flag (syntax) errors in command line switches passed to the application. diff --git a/src/MSBuild/CommandLineSwitches.cs b/src/MSBuild/CommandLine/CommandLineSwitches.cs similarity index 99% rename from src/MSBuild/CommandLineSwitches.cs rename to src/MSBuild/CommandLine/CommandLineSwitches.cs index 30490337ab0..7c7add45c3e 100644 --- a/src/MSBuild/CommandLineSwitches.cs +++ b/src/MSBuild/CommandLine/CommandLineSwitches.cs @@ -11,7 +11,7 @@ #nullable disable -namespace Microsoft.Build.CommandLine +namespace Microsoft.Build.CommandLine.Experimental { /// /// This class encapsulates the switches gathered from the application command line. It helps with switch detection, parameter @@ -426,6 +426,7 @@ private struct DetectedParameterlessSwitch /// /// This struct stores the details of a switch that takes parameters that is detected on the command line. /// + [DebuggerDisplay("{commandLineArg} | {parameters}")] private struct DetectedParameterizedSwitch { // the actual text of the switch @@ -435,8 +436,8 @@ private struct DetectedParameterizedSwitch internal ArrayList parameters; } - // for each recognized switch that doesn't take parameters, this array indicates if the switch has been detected on the - // command line + // for each recognized switch that doesn't take parameters, this array indicates if the switch has been detected on the command + // line private DetectedParameterlessSwitch[] _parameterlessSwitches; // for each recognized switch that takes parameters, this array indicates if the switch has been detected on the command // line, and it provides a store for the switch parameters @@ -504,6 +505,7 @@ internal void SetParameterlessSwitch(ParameterlessSwitch parameterlessSwitch, st /// /// /// + /// /// true, if the given parameters were successfully stored internal bool SetParameterizedSwitch( ParameterizedSwitch parameterizedSwitch, diff --git a/src/MSBuild/CommandLine/CommandLineSwitchesAccessor.cs b/src/MSBuild/CommandLine/CommandLineSwitchesAccessor.cs new file mode 100644 index 00000000000..66bf8c8582e --- /dev/null +++ b/src/MSBuild/CommandLine/CommandLineSwitchesAccessor.cs @@ -0,0 +1,163 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using static Microsoft.Build.CommandLine.Experimental.CommandLineSwitches; + +namespace Microsoft.Build.CommandLine.Experimental +{ + internal readonly struct CommandLineSwitchesAccessor + { + private readonly CommandLineSwitches switches; + + internal CommandLineSwitchesAccessor(CommandLineSwitches switches) + { + this.switches = switches; + } + + // Parameterless switches + public bool? Help => GetParameterlessSwitchValue(ParameterlessSwitch.Help); + + public bool? Version => GetParameterlessSwitchValue(ParameterlessSwitch.Version); + + public bool? NoLogo => GetParameterlessSwitchValue(ParameterlessSwitch.NoLogo); + + public bool? NoAutoResponse => GetParameterlessSwitchValue(ParameterlessSwitch.NoAutoResponse); + + public bool? NoConsoleLogger => GetParameterlessSwitchValue(ParameterlessSwitch.NoConsoleLogger); + + public bool? FileLogger => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger); + + public bool? FileLogger1 => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger1); + + public bool? FileLogger2 => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger2); + + public bool? FileLogger3 => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger3); + + public bool? FileLogger4 => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger4); + + public bool? FileLogger5 => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger5); + + public bool? FileLogger6 => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger6); + + public bool? FileLogger7 => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger7); + + public bool? FileLogger8 => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger8); + + public bool? FileLogger9 => GetParameterlessSwitchValue(ParameterlessSwitch.FileLogger9); + + public bool? DistributedFileLogger => GetParameterlessSwitchValue(ParameterlessSwitch.DistributedFileLogger); + +#if DEBUG + public bool? WaitForDebugger => GetParameterlessSwitchValue(ParameterlessSwitch.WaitForDebugger); +#endif + + // Parameterized switches + public string[]? Project => GetParameterizedSwitchValue(ParameterizedSwitch.Project); + + public string[]? Target => GetParameterizedSwitchValue(ParameterizedSwitch.Target); + + public string[]? Property => GetParameterizedSwitchValue(ParameterizedSwitch.Property); + + public string[]? Logger => GetParameterizedSwitchValue(ParameterizedSwitch.Logger); + + public string[]? DistributedLogger => GetParameterizedSwitchValue(ParameterizedSwitch.DistributedLogger); + + public string[]? Verbosity => GetParameterizedSwitchValue(ParameterizedSwitch.Verbosity); + +#if FEATURE_XML_SCHEMA_VALIDATION + public string[]? Validate => GetParameterizedSwitchValue(ParameterizedSwitch.Validate); +#endif + + public string[]? ConsoleLoggerParameters => GetParameterizedSwitchValue(ParameterizedSwitch.ConsoleLoggerParameters); + + public string[]? NodeMode => GetParameterizedSwitchValue(ParameterizedSwitch.NodeMode); + + public string[]? MaxCpuCount => GetParameterizedSwitchValue(ParameterizedSwitch.MaxCPUCount); + + public string[]? IgnoreProjectExtensions => GetParameterizedSwitchValue(ParameterizedSwitch.IgnoreProjectExtensions); + + public string[]? ToolsVersion => GetParameterizedSwitchValue(ParameterizedSwitch.ToolsVersion); + + public string[]? FileLoggerParameters => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters); + + public string[]? FileLoggerParameters1 => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters1); + + public string[]? FileLoggerParameters2 => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters2); + + public string[]? FileLoggerParameters3 => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters3); + + public string[]? FileLoggerParameters4 => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters4); + + public string[]? FileLoggerParameters5 => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters5); + + public string[]? FileLoggerParameters6 => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters6); + + public string[]? FileLoggerParameters7 => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters7); + + public string[]? FileLoggerParameters8 => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters8); + + public string[]? FileLoggerParameters9 => GetParameterizedSwitchValue(ParameterizedSwitch.FileLoggerParameters9); + + public string[]? TerminalLogger => GetParameterizedSwitchValue(ParameterizedSwitch.TerminalLogger); + + public string[]? TerminalLoggerParameters => GetParameterizedSwitchValue(ParameterizedSwitch.TerminalLoggerParameters); + + public string[]? NodeReuse => GetParameterizedSwitchValue(ParameterizedSwitch.NodeReuse); + + public string[]? Preprocess => GetParameterizedSwitchValue(ParameterizedSwitch.Preprocess); + + public string[]? Targets => GetParameterizedSwitchValue(ParameterizedSwitch.Targets); + + public string[]? WarningsAsErrors => GetParameterizedSwitchValue(ParameterizedSwitch.WarningsAsErrors); + + public string[]? WarningsNotAsErrors => GetParameterizedSwitchValue(ParameterizedSwitch.WarningsNotAsErrors); + + public string[]? WarningsAsMessages => GetParameterizedSwitchValue(ParameterizedSwitch.WarningsAsMessages); + + public string[]? BinaryLogger => GetParameterizedSwitchValue(ParameterizedSwitch.BinaryLogger); + + public string[]? Check => GetParameterizedSwitchValue(ParameterizedSwitch.Check); + + public string[]? Restore => GetParameterizedSwitchValue(ParameterizedSwitch.Restore); + + public string[]? ProfileEvaluation => GetParameterizedSwitchValue(ParameterizedSwitch.ProfileEvaluation); + + public string[]? RestoreProperty => GetParameterizedSwitchValue(ParameterizedSwitch.RestoreProperty); + + public string[]? Interactive => GetParameterizedSwitchValue(ParameterizedSwitch.Interactive); + + public string[]? IsolateProjects => GetParameterizedSwitchValue(ParameterizedSwitch.IsolateProjects); + + public string[]? GraphBuild => GetParameterizedSwitchValue(ParameterizedSwitch.GraphBuild); + + public string[]? InputResultsCaches => GetParameterizedSwitchValue(ParameterizedSwitch.InputResultsCaches); + + public string[]? OutputResultsCache => GetParameterizedSwitchValue(ParameterizedSwitch.OutputResultsCache); + +#if FEATURE_REPORTFILEACCESSES + public string[]? ReportFileAccesses => GetParameterizedSwitchValue(ParameterizedSwitch.ReportFileAccesses); +#endif + + public string[]? LowPriority => GetParameterizedSwitchValue(ParameterizedSwitch.LowPriority); + + public string[]? Question => GetParameterizedSwitchValue(ParameterizedSwitch.Question); + + public string[]? DetailedSummary => GetParameterizedSwitchValue(ParameterizedSwitch.DetailedSummary); + + public string[]? GetProperty => GetParameterizedSwitchValue(ParameterizedSwitch.GetProperty); + + public string[]? GetItem => GetParameterizedSwitchValue(ParameterizedSwitch.GetItem); + + public string[]? GetTargetResult => GetParameterizedSwitchValue(ParameterizedSwitch.GetTargetResult); + + public string[]? GetResultOutputFile => GetParameterizedSwitchValue(ParameterizedSwitch.GetResultOutputFile); + + public string[]? FeatureAvailability => GetParameterizedSwitchValue(ParameterizedSwitch.FeatureAvailability); + + public string[]? MultiThreaded => GetParameterizedSwitchValue(ParameterizedSwitch.MultiThreaded); + + private bool? GetParameterlessSwitchValue(ParameterlessSwitch switchType) => switches.IsParameterlessSwitchSet(switchType) ? switches[switchType] : null; + + private string[]? GetParameterizedSwitchValue(ParameterizedSwitch switchType) => switches.IsParameterizedSwitchSet(switchType) ? switches[switchType] : null; + } +} diff --git a/src/MSBuild/MSBuild.csproj b/src/MSBuild/MSBuild.csproj index d8cd63d2a5c..a9c57846e05 100644 --- a/src/MSBuild/MSBuild.csproj +++ b/src/MSBuild/MSBuild.csproj @@ -134,9 +134,11 @@ - - + + + + @@ -210,7 +212,7 @@ - + diff --git a/src/MSBuild/MSBuildClientApp.cs b/src/MSBuild/MSBuildClientApp.cs index 3eeb975bc40..33100583fe2 100644 --- a/src/MSBuild/MSBuildClientApp.cs +++ b/src/MSBuild/MSBuildClientApp.cs @@ -34,18 +34,12 @@ internal static class MSBuildClientApp /// /// The locations of msbuild exe/dll and dotnet.exe would be automatically detected if called from dotnet or msbuild cli. Calling this function from other executables might not work. /// - public static MSBuildApp.ExitType Execute( -#if FEATURE_GET_COMMANDLINE - string commandLine, -#else - string[] commandLine, -#endif - CancellationToken cancellationToken) + public static MSBuildApp.ExitType Execute(string[] commandLineArgs, CancellationToken cancellationToken) { string msbuildLocation = BuildEnvironmentHelper.Instance.CurrentMSBuildExePath; return Execute( - commandLine, + commandLineArgs, msbuildLocation, cancellationToken); } @@ -53,7 +47,7 @@ public static MSBuildApp.ExitType Execute( /// /// This is the entry point for the MSBuild client. /// - /// The command line to process. The first argument + /// The command line to process. The first argument /// on the command line is assumed to be the name/path of the executable, and /// is ignored. /// Full path to current MSBuild.exe if executable is MSBuild.exe, @@ -61,16 +55,9 @@ public static MSBuildApp.ExitType Execute( /// Cancellation token. /// A value of type that indicates whether the build succeeded, /// or the manner in which it failed. - public static MSBuildApp.ExitType Execute( -#if FEATURE_GET_COMMANDLINE - string commandLine, -#else - string[] commandLine, -#endif - string msbuildLocation, - CancellationToken cancellationToken) + public static MSBuildApp.ExitType Execute(string[] commandLineArgs, string msbuildLocation, CancellationToken cancellationToken) { - MSBuildClient msbuildClient = new MSBuildClient(commandLine, msbuildLocation); + MSBuildClient msbuildClient = new MSBuildClient(commandLineArgs, msbuildLocation); MSBuildClientExitResult exitResult = msbuildClient.Execute(cancellationToken); if (exitResult.MSBuildClientExitType == MSBuildClientExitType.ServerBusy || @@ -84,7 +71,7 @@ public static MSBuildApp.ExitType Execute( } // Server is busy, fallback to old behavior. - return MSBuildApp.Execute(commandLine); + return MSBuildApp.Execute(commandLineArgs); } if (exitResult.MSBuildClientExitType == MSBuildClientExitType.Success && diff --git a/src/MSBuild/XMake.cs b/src/MSBuild/XMake.cs index d3ca93cea4f..ddb0fc04240 100644 --- a/src/MSBuild/XMake.cs +++ b/src/MSBuild/XMake.cs @@ -36,6 +36,7 @@ using Microsoft.Build.Shared.Debugging; using Microsoft.Build.Shared.FileSystem; using Microsoft.Build.Tasks.AssemblyDependency; +using Microsoft.Build.CommandLine.Experimental; using BinaryLogger = Microsoft.Build.Logging.BinaryLogger; using ConsoleLogger = Microsoft.Build.Logging.ConsoleLogger; using FileLogger = Microsoft.Build.Logging.FileLogger; @@ -143,6 +144,8 @@ public enum ExitType private static readonly char[] s_commaSemicolon = { ',', ';' }; + private static CommandLineParser commandLineParser; + /// /// Static constructor /// @@ -158,6 +161,7 @@ static MSBuildApp() // any configuration file exceptions can be caught here. // //////////////////////////////////////////////////////////////////////////////// s_exePath = Path.GetDirectoryName(FileUtilities.ExecutingAssemblyPath); + commandLineParser = new CommandLineParser(); s_initialized = true; } @@ -233,14 +237,18 @@ private static void HandleConfigurationException(Exception ex) #if FEATURE_APPDOMAIN [LoaderOptimization(LoaderOptimization.MultiDomain)] #endif -#pragma warning disable SA1111, SA1009 // Closing parenthesis should be on line of last parameter - public static int Main( -#if !FEATURE_GET_COMMANDLINE - string[] args -#endif - ) -#pragma warning restore SA1111, SA1009 // Closing parenthesis should be on line of last parameter + public static int Main(string[] args) { + // When running on CoreCLR(.NET), insert the command executable path as the first element of the args array. + // This is needed because on .NET the first element of Environment.CommandLine is the dotnet executable path + // and not the msbuild executable path. CoreCLR version didn't support Environment.CommandLine initially, so + // workaround was needed. +#if NET + args = [BuildEnvironmentHelper.Instance.CurrentMSBuildExePath, .. args]; +#else + args = QuotingUtilities.SplitUnquoted(Environment.CommandLine).ToArray(); +#endif + // Setup the console UI. using AutomaticEncodingRestorer _ = new(); SetConsoleUI(); @@ -263,35 +271,18 @@ string[] args if ( Environment.GetEnvironmentVariable(Traits.UseMSBuildServerEnvVarName) == "1" && !Traits.Instance.EscapeHatches.EnsureStdOutForChildNodesIsPrimaryStdout && - CanRunServerBasedOnCommandLineSwitches( -#if FEATURE_GET_COMMANDLINE - Environment.CommandLine)) -#else - ConstructArrayArg(args))) -#endif + CanRunServerBasedOnCommandLineSwitches(args)) { Console.CancelKeyPress += Console_CancelKeyPress; // Use the client app to execute build in msbuild server. Opt-in feature. - exitCode = ((s_initialized && MSBuildClientApp.Execute( -#if FEATURE_GET_COMMANDLINE - Environment.CommandLine, -#else - ConstructArrayArg(args), -#endif - s_buildCancellationSource.Token) == ExitType.Success) ? 0 : 1); + exitCode = ((s_initialized && MSBuildClientApp.Execute(args, s_buildCancellationSource.Token) == ExitType.Success) ? 0 : 1); } else { // return 0 on success, non-zero on failure - exitCode = ((s_initialized && Execute( -#if FEATURE_GET_COMMANDLINE - Environment.CommandLine) -#else - ConstructArrayArg(args)) -#endif - == ExitType.Success) ? 0 : 1); + exitCode = ((s_initialized && Execute(args) == ExitType.Success) ? 0 : 1); } if (Environment.GetEnvironmentVariable("MSBUILDDUMPPROCESSCOUNTERS") == "1") @@ -310,19 +301,14 @@ string[] args /// /// Will not throw. If arguments processing fails, we will not run it on server - no reason as it will not run any build anyway. /// - private static bool CanRunServerBasedOnCommandLineSwitches( -#if FEATURE_GET_COMMANDLINE - string commandLine) -#else - string[] commandLine) -#endif + private static bool CanRunServerBasedOnCommandLineSwitches(string[] commandLine) { bool canRunServer = true; try { - GatherAllSwitches(commandLine, out var switchesFromAutoResponseFile, out var switchesNotFromAutoResponseFile, out string fullCommandLine); + commandLineParser.GatherAllSwitches(commandLine, out var switchesFromAutoResponseFile, out var switchesNotFromAutoResponseFile, out string fullCommandLine, out s_exeName); CommandLineSwitches commandLineSwitches = CombineSwitchesRespectingPriority(switchesFromAutoResponseFile, switchesNotFromAutoResponseFile, fullCommandLine); - if (CheckAndGatherProjectAutoResponseFile(switchesFromAutoResponseFile, commandLineSwitches, false, fullCommandLine)) + if (commandLineParser.CheckAndGatherProjectAutoResponseFile(switchesFromAutoResponseFile, commandLineSwitches, false, fullCommandLine)) { commandLineSwitches = CombineSwitchesRespectingPriority(switchesFromAutoResponseFile, switchesNotFromAutoResponseFile, fullCommandLine); } @@ -353,23 +339,6 @@ private static bool CanRunServerBasedOnCommandLineSwitches( return canRunServer; } -#if !FEATURE_GET_COMMANDLINE - /// - /// Insert the command executable path as the first element of the args array. - /// - /// - /// - private static string[] ConstructArrayArg(string[] args) - { - string[] newArgArray = new string[args.Length + 1]; - - newArgArray[0] = BuildEnvironmentHelper.Instance.CurrentMSBuildExePath; - Array.Copy(args, 0, newArgArray, 1, args.Length); - - return newArgArray; - } -#endif // !FEATURE_GET_COMMANDLINE - /// /// Append output file with elapsedTime /// @@ -623,12 +592,7 @@ private static void DebuggerLaunchCheck() /// is ignored. /// A value of type ExitType that indicates whether the build succeeded, /// or the manner in which it failed. - public static ExitType Execute( -#if FEATURE_GET_COMMANDLINE - string commandLine) -#else - string[] commandLine) -#endif + public static ExitType Execute(string[] commandLine) { DebuggerLaunchCheck(); @@ -645,9 +609,7 @@ public static ExitType Execute( // and those form the great majority of our unnecessary memory use. Environment.SetEnvironmentVariable("MSBuildLoadMicrosoftTargetsReadOnly", "true"); -#if FEATURE_GET_COMMANDLINE ErrorUtilities.VerifyThrowArgumentLength(commandLine); -#endif AppDomain.CurrentDomain.UnhandledException += ExceptionHandling.UnhandledExceptionHandler; @@ -659,14 +621,11 @@ public static ExitType Execute( TextWriter targetsWriter = null; try { -#if FEATURE_GET_COMMANDLINE - MSBuildEventSource.Log.MSBuildExeStart(commandLine); -#else if (MSBuildEventSource.Log.IsEnabled()) { MSBuildEventSource.Log.MSBuildExeStart(string.Join(" ", commandLine)); } -#endif + Console.CancelKeyPress += cancelHandler; // check the operating system the code is running on @@ -722,7 +681,7 @@ public static ExitType Execute( bool reportFileAccesses = false; #endif - GatherAllSwitches(commandLine, out var switchesFromAutoResponseFile, out var switchesNotFromAutoResponseFile, out _); + commandLineParser.GatherAllSwitches(commandLine, out var switchesFromAutoResponseFile, out var switchesNotFromAutoResponseFile, out _, out s_exeName); bool buildCanBeInvoked = ProcessCommandLineSwitches( switchesFromAutoResponseFile, @@ -769,11 +728,7 @@ public static ExitType Execute( ref getTargetResult, ref getResultOutputFile, recursing: false, -#if FEATURE_GET_COMMANDLINE - commandLine); -#else - string.Join(' ', commandLine)); -#endif + string.Join(" ", commandLine)); CommandLineSwitches.SwitchesFromResponseFiles = null; @@ -1007,12 +962,12 @@ public static ExitType Execute( exitType = ExitType.InitializationError; } } -#pragma warning disable CS0618 // Experimental.ProjectCache.ProjectCacheException is obsolete, but we need to support both namespaces for now - catch (Exception e) when (e is ProjectCacheException || e is Experimental.ProjectCache.ProjectCacheException) +#pragma warning disable CS0618 // Microsoft.Build.Experimental.ProjectCache.ProjectCacheException is obsolete, but we need to support both namespaces for now + catch (Exception e) when (e is ProjectCacheException || e is Microsoft.Build.Experimental.ProjectCache.ProjectCacheException) { ProjectCacheException pce = e as ProjectCacheException; - Experimental.ProjectCache.ProjectCacheException exppce = e as Experimental.ProjectCache.ProjectCacheException; + Microsoft.Build.Experimental.ProjectCache.ProjectCacheException exppce = e as Microsoft.Build.Experimental.ProjectCache.ProjectCacheException; Console.WriteLine($"MSBUILD : error {pce?.ErrorCode ?? exppce?.ErrorCode}: {e.Message}"); @@ -1073,14 +1028,10 @@ public static ExitType Execute( preprocessWriter?.Dispose(); targetsWriter?.Dispose(); -#if FEATURE_GET_COMMANDLINE - MSBuildEventSource.Log.MSBuildExeStop(commandLine); -#else if (MSBuildEventSource.Log.IsEnabled()) { MSBuildEventSource.Log.MSBuildExeStop(string.Join(" ", commandLine)); } -#endif } /********************************************************************************************************************** * WARNING: Do NOT add any more catch blocks above! @@ -1221,14 +1172,7 @@ private static void Console_CancelKeyPress(object sender, ConsoleCancelEventArgs /// private static void ResetBuildState() { - ResetGatheringSwitchesState(); - } - - private static void ResetGatheringSwitchesState() - { - s_includedResponseFiles = new List(); - usingSwitchesFromAutoResponseFile = false; - CommandLineSwitches.SwitchesFromResponseFiles = new(); + commandLineParser.ResetGatheringSwitchesState(); } /// @@ -1303,11 +1247,7 @@ internal static bool BuildProject( #if FEATURE_REPORTFILEACCESSES bool reportFileAccesses, #endif -#if FEATURE_GET_COMMANDLINE - string commandLine) -#else string[] commandLine) -#endif { if (FileUtilities.IsVCProjFilename(projectFile) || FileUtilities.IsDspFilename(projectFile)) { @@ -1556,15 +1496,12 @@ .. distributedLoggerRecords.Select(d => d.CentralLogger).Where(l => l is not nul if (!Traits.Instance.EscapeHatches.DoNotSendDeferredMessagesToBuildManager) { var commandLineString = -#if FEATURE_GET_COMMANDLINE - commandLine; -#else string.Join(" ", commandLine); -#endif + messagesToLogInBuildLoggers.AddRange(GetMessagesToLogInBuildLoggers(commandLineString)); // Log a message for every response file and include it in log - foreach (var responseFilePath in s_includedResponseFiles) + foreach (var responseFilePath in commandLineParser.IncludedResponseFiles) { messagesToLogInBuildLoggers.Add( new BuildManager.DeferredBuildMessage( @@ -1987,514 +1924,11 @@ internal static void SetConsoleUI() #endif } - /// - /// Gets all specified switches, from the command line, as well as all - /// response files, including the auto-response file. - /// - /// - /// - /// - /// - /// Combined bag of switches. - private static void GatherAllSwitches( -#if FEATURE_GET_COMMANDLINE - string commandLine, -#else - string[] commandLine, -#endif - out CommandLineSwitches switchesFromAutoResponseFile, out CommandLineSwitches switchesNotFromAutoResponseFile, out string fullCommandLine) - { - ResetGatheringSwitchesState(); - -#if FEATURE_GET_COMMANDLINE - // split the command line on (unquoted) whitespace - var commandLineArgs = QuotingUtilities.SplitUnquoted(commandLine); - - s_exeName = FileUtilities.FixFilePath(QuotingUtilities.Unquote(commandLineArgs[0])); -#else - var commandLineArgs = new List(commandLine); - - s_exeName = BuildEnvironmentHelper.Instance.CurrentMSBuildExePath; -#endif - -#if USE_MSBUILD_DLL_EXTN - var msbuildExtn = ".dll"; -#else - var msbuildExtn = ".exe"; -#endif - if (!s_exeName.EndsWith(msbuildExtn, StringComparison.OrdinalIgnoreCase)) - { - s_exeName += msbuildExtn; - } - - // discard the first piece, because that's the path to the executable -- the rest are args - commandLineArgs.RemoveAt(0); - -#if FEATURE_GET_COMMANDLINE - fullCommandLine = $"'{commandLine}'"; -#else - fullCommandLine = $"'{string.Join(' ', commandLine)}'"; -#endif - - // parse the command line, and flag syntax errors and obvious switch errors - switchesNotFromAutoResponseFile = new CommandLineSwitches(); - GatherCommandLineSwitches(commandLineArgs, switchesNotFromAutoResponseFile, fullCommandLine); - - // parse the auto-response file (if "/noautoresponse" is not specified), and combine those switches with the - // switches on the command line - switchesFromAutoResponseFile = new CommandLineSwitches(); - if (!switchesNotFromAutoResponseFile[CommandLineSwitches.ParameterlessSwitch.NoAutoResponse]) - { - GatherAutoResponseFileSwitches(s_exePath, switchesFromAutoResponseFile, fullCommandLine); - } - } - - /// - /// Coordinates the parsing of the command line. It detects switches on the command line, gathers their parameters, and - /// flags syntax errors, and other obvious switch errors. - /// - /// - /// Internal for unit testing only. - /// - internal static void GatherCommandLineSwitches(List commandLineArgs, CommandLineSwitches commandLineSwitches, string commandLine = "") - { - foreach (string commandLineArg in commandLineArgs) - { - string unquotedCommandLineArg = QuotingUtilities.Unquote(commandLineArg, out var doubleQuotesRemovedFromArg); - - if (unquotedCommandLineArg.Length > 0) - { - // response file switch starts with @ - if (unquotedCommandLineArg.StartsWith("@", StringComparison.Ordinal)) - { - GatherResponseFileSwitch(unquotedCommandLineArg, commandLineSwitches, commandLine); - } - else - { - string switchName; - string switchParameters; - - // all switches should start with - or / or -- unless a project is being specified - if (!ValidateSwitchIndicatorInUnquotedArgument(unquotedCommandLineArg) || FileUtilities.LooksLikeUnixFilePath(unquotedCommandLineArg)) - { - switchName = null; - // add a (fake) parameter indicator for later parsing - switchParameters = $":{commandLineArg}"; - } - else - { - // check if switch has parameters (look for the : parameter indicator) - int switchParameterIndicator = unquotedCommandLineArg.IndexOf(':'); - - // get the length of the beginning sequence considered as a switch indicator (- or / or --) - int switchIndicatorsLength = GetLengthOfSwitchIndicator(unquotedCommandLineArg); - - // extract the switch name and parameters -- the name is sandwiched between the switch indicator (the - // leading - or / or --) and the parameter indicator (if the switch has parameters); the parameters (if any) - // follow the parameter indicator - if (switchParameterIndicator == -1) - { - switchName = unquotedCommandLineArg.Substring(switchIndicatorsLength); - switchParameters = string.Empty; - } - else - { - switchName = unquotedCommandLineArg.Substring(switchIndicatorsLength, switchParameterIndicator - switchIndicatorsLength); - switchParameters = ExtractSwitchParameters(commandLineArg, unquotedCommandLineArg, doubleQuotesRemovedFromArg, switchName, switchParameterIndicator, switchIndicatorsLength); - } - } - - // Special case: for the switches "/m" (or "/maxCpuCount") and "/bl" (or "/binarylogger") we wish to pretend we saw a default argument - // This allows a subsequent /m:n on the command line to override it. - // We could create a new kind of switch with optional parameters, but it's a great deal of churn for this single case. - // Note that if no "/m" or "/maxCpuCount" switch -- either with or without parameters -- is present, then we still default to 1 cpu - // for backwards compatibility. - if (string.IsNullOrEmpty(switchParameters)) - { - if (string.Equals(switchName, "m", StringComparison.OrdinalIgnoreCase) || - string.Equals(switchName, "maxcpucount", StringComparison.OrdinalIgnoreCase)) - { - int numberOfCpus = NativeMethodsShared.GetLogicalCoreCount(); - switchParameters = $":{numberOfCpus}"; - } - else if (string.Equals(switchName, "bl", StringComparison.OrdinalIgnoreCase) || - string.Equals(switchName, "binarylogger", StringComparison.OrdinalIgnoreCase)) - { - // we have to specify at least one parameter otherwise it's impossible to distinguish the situation - // where /bl is not specified at all vs. where /bl is specified without the file name. - switchParameters = ":msbuild.binlog"; - } - else if (string.Equals(switchName, "prof", StringComparison.OrdinalIgnoreCase) || - string.Equals(switchName, "profileevaluation", StringComparison.OrdinalIgnoreCase)) - { - switchParameters = ":no-file"; - } - } - - if (CommandLineSwitches.IsParameterlessSwitch(switchName, out var parameterlessSwitch, out var duplicateSwitchErrorMessage)) - { - GatherParameterlessCommandLineSwitch(commandLineSwitches, parameterlessSwitch, switchParameters, duplicateSwitchErrorMessage, unquotedCommandLineArg, commandLine); - } - else if (CommandLineSwitches.IsParameterizedSwitch(switchName, out var parameterizedSwitch, out duplicateSwitchErrorMessage, out var multipleParametersAllowed, out var missingParametersErrorMessage, out var unquoteParameters, out var allowEmptyParameters)) - { - GatherParameterizedCommandLineSwitch(commandLineSwitches, parameterizedSwitch, switchParameters, duplicateSwitchErrorMessage, multipleParametersAllowed, missingParametersErrorMessage, unquoteParameters, unquotedCommandLineArg, allowEmptyParameters, commandLine); - } - else - { - commandLineSwitches.SetUnknownSwitchError(unquotedCommandLineArg, commandLine); - } - } - } - } - } - - /// - /// Extracts a switch's parameters after processing all quoting around the switch. - /// - /// - /// This method is marked "internal" for unit-testing purposes only -- ideally it should be "private". - /// - /// - /// - /// - /// - /// - /// - /// The given switch's parameters (with interesting quoting preserved). - internal static string ExtractSwitchParameters( - string commandLineArg, - string unquotedCommandLineArg, - int doubleQuotesRemovedFromArg, - string switchName, - int switchParameterIndicator, - int switchIndicatorsLength) - { - - // find the parameter indicator again using the quoted arg - // NOTE: since the parameter indicator cannot be part of a switch name, quoting around it is not relevant, because a - // parameter indicator cannot be escaped or made into a literal - int quotedSwitchParameterIndicator = commandLineArg.IndexOf(':'); - - // check if there is any quoting in the name portion of the switch - string unquotedSwitchIndicatorAndName = QuotingUtilities.Unquote(commandLineArg.Substring(0, quotedSwitchParameterIndicator), out var doubleQuotesRemovedFromSwitchIndicatorAndName); - - ErrorUtilities.VerifyThrow(switchName == unquotedSwitchIndicatorAndName.Substring(switchIndicatorsLength), - "The switch name extracted from either the partially or completely unquoted arg should be the same."); - - ErrorUtilities.VerifyThrow(doubleQuotesRemovedFromArg >= doubleQuotesRemovedFromSwitchIndicatorAndName, - "The name portion of the switch cannot contain more quoting than the arg itself."); - - string switchParameters; - // if quoting in the name portion of the switch was terminated - if ((doubleQuotesRemovedFromSwitchIndicatorAndName % 2) == 0) - { - // get the parameters exactly as specified on the command line i.e. including quoting - switchParameters = commandLineArg.Substring(quotedSwitchParameterIndicator); - } - else - { - // if quoting was not terminated in the name portion of the switch, and the terminal double-quote (if any) - // terminates the switch parameters - int terminalDoubleQuote = commandLineArg.IndexOf('"', quotedSwitchParameterIndicator + 1); - if (((doubleQuotesRemovedFromArg - doubleQuotesRemovedFromSwitchIndicatorAndName) <= 1) && - ((terminalDoubleQuote == -1) || (terminalDoubleQuote == (commandLineArg.Length - 1)))) - { - // then the parameters are not quoted in any interesting way, so use the unquoted parameters - switchParameters = unquotedCommandLineArg.Substring(switchParameterIndicator); - } - else - { - // otherwise, use the quoted parameters, after compensating for the quoting that was started in the name - // portion of the switch - switchParameters = $":\"{commandLineArg.Substring(quotedSwitchParameterIndicator + 1)}"; - } - } - - ErrorUtilities.VerifyThrow(switchParameters != null, "We must be able to extract the switch parameters."); - - return switchParameters; - } - - /// - /// Used to keep track of response files to prevent them from - /// being included multiple times (or even recursively). - /// - private static List s_includedResponseFiles; - - /// - /// Called when a response file switch is detected on the command line. It loads the specified response file, and parses - /// each line in it like a command line. It also prevents multiple (or recursive) inclusions of the same response file. - /// - /// - /// - private static void GatherResponseFileSwitch(string unquotedCommandLineArg, CommandLineSwitches commandLineSwitches, string commandLine) - { - try - { - string responseFile = FileUtilities.FixFilePath(unquotedCommandLineArg.Substring(1)); - - if (responseFile.Length == 0) - { - commandLineSwitches.SetSwitchError("MissingResponseFileError", unquotedCommandLineArg, commandLine); - } - else if (!FileSystems.Default.FileExists(responseFile)) - { - commandLineSwitches.SetParameterError("ResponseFileNotFoundError", unquotedCommandLineArg, commandLine); - } - else - { - // normalize the response file path to help catch multiple (or recursive) inclusions - responseFile = Path.GetFullPath(responseFile); - // NOTE: for network paths or mapped paths, normalization is not guaranteed to work - - bool isRepeatedResponseFile = false; - - foreach (string includedResponseFile in s_includedResponseFiles) - { - if (string.Equals(responseFile, includedResponseFile, StringComparison.OrdinalIgnoreCase)) - { - commandLineSwitches.SetParameterError("RepeatedResponseFileError", unquotedCommandLineArg, commandLine); - isRepeatedResponseFile = true; - break; - } - } - - if (!isRepeatedResponseFile) - { - var responseFileDirectory = FileUtilities.EnsureTrailingSlash(Path.GetDirectoryName(responseFile)); - s_includedResponseFiles.Add(responseFile); - - List argsFromResponseFile; - -#if FEATURE_ENCODING_DEFAULT - using (StreamReader responseFileContents = new StreamReader(responseFile, Encoding.Default)) // HIGHCHAR: If response files have no byte-order marks, then assume ANSI rather than ASCII. -#else - using (StreamReader responseFileContents = FileUtilities.OpenRead(responseFile)) // HIGHCHAR: If response files have no byte-order marks, then assume ANSI rather than ASCII. -#endif - { - argsFromResponseFile = new List(); - - while (responseFileContents.Peek() != -1) - { - // ignore leading whitespace on each line - string responseFileLine = responseFileContents.ReadLine().TrimStart(); - - // skip comment lines beginning with # - if (!responseFileLine.StartsWith("#", StringComparison.Ordinal)) - { - // Allow special case to support a path relative to the .rsp file being processed. - responseFileLine = Regex.Replace(responseFileLine, responseFilePathReplacement, - responseFileDirectory, RegexOptions.IgnoreCase); - - // treat each line of the response file like a command line i.e. args separated by whitespace - argsFromResponseFile.AddRange(QuotingUtilities.SplitUnquoted(Environment.ExpandEnvironmentVariables(responseFileLine))); - } - } - } - - CommandLineSwitches.SwitchesFromResponseFiles.Add((responseFile, string.Join(" ", argsFromResponseFile))); - - GatherCommandLineSwitches(argsFromResponseFile, commandLineSwitches, commandLine); - } - } - } - catch (NotSupportedException e) - { - commandLineSwitches.SetParameterError("ReadResponseFileError", unquotedCommandLineArg, e, commandLine); - } - catch (SecurityException e) - { - commandLineSwitches.SetParameterError("ReadResponseFileError", unquotedCommandLineArg, e, commandLine); - } - catch (UnauthorizedAccessException e) - { - commandLineSwitches.SetParameterError("ReadResponseFileError", unquotedCommandLineArg, e, commandLine); - } - catch (IOException e) - { - commandLineSwitches.SetParameterError("ReadResponseFileError", unquotedCommandLineArg, e, commandLine); - } - } - - /// - /// Called when a switch that doesn't take parameters is detected on the command line. - /// - /// - /// - /// - /// - /// - private static void GatherParameterlessCommandLineSwitch( - CommandLineSwitches commandLineSwitches, - CommandLineSwitches.ParameterlessSwitch parameterlessSwitch, - string switchParameters, - string duplicateSwitchErrorMessage, - string unquotedCommandLineArg, - string commandLine) - { - // switch should not have any parameters - if (switchParameters.Length == 0) - { - // check if switch is duplicated, and if that's allowed - if (!commandLineSwitches.IsParameterlessSwitchSet(parameterlessSwitch) || - (duplicateSwitchErrorMessage == null)) - { - commandLineSwitches.SetParameterlessSwitch(parameterlessSwitch, unquotedCommandLineArg); - } - else - { - commandLineSwitches.SetSwitchError(duplicateSwitchErrorMessage, unquotedCommandLineArg, commandLine); - } - } - else - { - commandLineSwitches.SetUnexpectedParametersError(unquotedCommandLineArg, commandLine); - } - } - - /// - /// Called when a switch that takes parameters is detected on the command line. This method flags errors and stores the - /// switch parameters. - /// - /// - /// - /// - /// - /// - /// - /// - /// - private static void GatherParameterizedCommandLineSwitch( - CommandLineSwitches commandLineSwitches, - CommandLineSwitches.ParameterizedSwitch parameterizedSwitch, - string switchParameters, - string duplicateSwitchErrorMessage, - bool multipleParametersAllowed, - string missingParametersErrorMessage, - bool unquoteParameters, - string unquotedCommandLineArg, - bool allowEmptyParameters, - string commandLine) - { - if (// switch must have parameters - (switchParameters.Length > 1) || - // unless the parameters are optional - (missingParametersErrorMessage == null)) - { - // skip the parameter indicator (if any) - if (switchParameters.Length > 0) - { - switchParameters = switchParameters.Substring(1); - } - - if (parameterizedSwitch == CommandLineSwitches.ParameterizedSwitch.Project && IsEnvironmentVariable(switchParameters)) - { - commandLineSwitches.SetSwitchError("EnvironmentVariableAsSwitch", unquotedCommandLineArg, commandLine); - } - - // check if switch is duplicated, and if that's allowed - if (!commandLineSwitches.IsParameterizedSwitchSet(parameterizedSwitch) || - (duplicateSwitchErrorMessage == null)) - { - // save the parameters after unquoting and splitting them if necessary - if (!commandLineSwitches.SetParameterizedSwitch(parameterizedSwitch, unquotedCommandLineArg, switchParameters, multipleParametersAllowed, unquoteParameters, allowEmptyParameters)) - { - // if parsing revealed there were no real parameters, flag an error, unless the parameters are optional - if (missingParametersErrorMessage != null) - { - commandLineSwitches.SetSwitchError(missingParametersErrorMessage, unquotedCommandLineArg, commandLine); - } - } - } - else - { - commandLineSwitches.SetSwitchError(duplicateSwitchErrorMessage, unquotedCommandLineArg, commandLine); - } - } - else - { - commandLineSwitches.SetSwitchError(missingParametersErrorMessage, unquotedCommandLineArg, commandLine); - } - } - - /// - /// Checks whether envVar is an environment variable. MSBuild uses - /// Environment.ExpandEnvironmentVariables(string), which only - /// considers %-delimited variables. - /// - /// A possible environment variable - /// Whether envVar is an environment variable - private static bool IsEnvironmentVariable(string envVar) - { - return envVar.StartsWith("%") && envVar.EndsWith("%") && envVar.Length > 1; - } - - /// - /// The name of the auto-response file. - /// - private const string autoResponseFileName = "MSBuild.rsp"; - - /// - /// The name of an auto-response file to search for in the project directory and above. - /// - private const string directoryResponseFileName = "Directory.Build.rsp"; - - /// - /// String replacement pattern to support paths in response files. - /// - private const string responseFilePathReplacement = "%MSBuildThisFileDirectory%"; - - /// - /// Whether switches from the auto-response file are being used. - /// - internal static bool usingSwitchesFromAutoResponseFile = false; - /// /// Indicates that this process is working as a server. /// private static bool s_isServerNode; - /// - /// Parses the auto-response file (assumes the "/noautoresponse" switch is not specified on the command line), and combines the - /// switches from the auto-response file with the switches passed in. - /// Returns true if the response file was found. - /// - private static bool GatherAutoResponseFileSwitches(string path, CommandLineSwitches switchesFromAutoResponseFile, string commandLine) - { - string autoResponseFile = Path.Combine(path, autoResponseFileName); - return GatherAutoResponseFileSwitchesFromFullPath(autoResponseFile, switchesFromAutoResponseFile, commandLine); - } - - private static bool GatherAutoResponseFileSwitchesFromFullPath(string autoResponseFile, CommandLineSwitches switchesFromAutoResponseFile, string commandLine) - { - bool found = false; - - // if the auto-response file does not exist, only use the switches on the command line - if (FileSystems.Default.FileExists(autoResponseFile)) - { - found = true; - GatherResponseFileSwitch($"@{autoResponseFile}", switchesFromAutoResponseFile, commandLine); - - // if the "/noautoresponse" switch was set in the auto-response file, flag an error - if (switchesFromAutoResponseFile[CommandLineSwitches.ParameterlessSwitch.NoAutoResponse]) - { - switchesFromAutoResponseFile.SetSwitchError("CannotAutoDisableAutoResponseFile", - switchesFromAutoResponseFile.GetParameterlessSwitchCommandLineArg(CommandLineSwitches.ParameterlessSwitch.NoAutoResponse), commandLine); - } - - if (switchesFromAutoResponseFile.HaveAnySwitchesBeenSet()) - { - // we picked up some switches from the auto-response file - usingSwitchesFromAutoResponseFile = true; - } - - // Throw errors found in the response file - switchesFromAutoResponseFile.ThrowErrors(); - } - - return found; - } - /// /// Coordinates the processing of all detected switches. It gathers information necessary to invoke the build engine, and /// performs deeper error checking on the switches and their parameters. @@ -2570,8 +2004,8 @@ private static bool ProcessCommandLineSwitches( bool useTerminalLogger = ProcessTerminalLoggerConfiguration(commandLineSwitches, out string aggregatedTerminalLoggerParameters); // This is temporary until we can remove the need for the environment variable. - // DO NOT use this environment variable for any new features as it will be removed without further notice. - Environment.SetEnvironmentVariable("_MSBUILDTLENABLED", useTerminalLogger ? "1" : "0"); + // DO NOT use this environment variable for any new features as it will be removed without further notice. + Environment.SetEnvironmentVariable("_MSBUILDTLENABLED", useTerminalLogger ? "1" : "0"); DisplayVersionMessageIfNeeded(recursing, useTerminalLogger, commandLineSwitches); @@ -2632,7 +2066,7 @@ private static bool ProcessCommandLineSwitches( } else { - bool foundProjectAutoResponseFile = CheckAndGatherProjectAutoResponseFile(switchesFromAutoResponseFile, commandLineSwitches, recursing, commandLine); + bool foundProjectAutoResponseFile = commandLineParser.CheckAndGatherProjectAutoResponseFile(switchesFromAutoResponseFile, commandLineSwitches, recursing, commandLine); if (foundProjectAutoResponseFile) { @@ -3091,59 +2525,6 @@ private static CommandLineSwitches CombineSwitchesRespectingPriority(CommandLine return commandLineSwitches; } - private static string GetProjectDirectory(string[] projectSwitchParameters) - { - string projectDirectory = "."; - ErrorUtilities.VerifyThrow(projectSwitchParameters.Length <= 1, "Expect exactly one project at a time."); - - if (projectSwitchParameters.Length == 1) - { - var projectFile = FileUtilities.FixFilePath(projectSwitchParameters[0]); - - if (FileSystems.Default.DirectoryExists(projectFile)) - { - // the provided argument value is actually the directory - projectDirectory = projectFile; - } - else - { - InitializationException.VerifyThrow(FileSystems.Default.FileExists(projectFile), "ProjectNotFoundError", projectFile); - projectDirectory = Path.GetDirectoryName(Path.GetFullPath(projectFile)); - } - } - - return projectDirectory; - } - - - /// - /// Identifies if there is rsp files near the project file - /// - /// true if there autoresponse file was found - private static bool CheckAndGatherProjectAutoResponseFile(CommandLineSwitches switchesFromAutoResponseFile, CommandLineSwitches commandLineSwitches, bool recursing, string commandLine) - { - bool found = false; - - var projectDirectory = GetProjectDirectory(commandLineSwitches[CommandLineSwitches.ParameterizedSwitch.Project]); - - if (!recursing && !commandLineSwitches[CommandLineSwitches.ParameterlessSwitch.NoAutoResponse]) - { - // gather any switches from the first Directory.Build.rsp found in the project directory or above - string directoryResponseFile = FileUtilities.GetPathOfFileAbove(directoryResponseFileName, projectDirectory); - - found = !string.IsNullOrWhiteSpace(directoryResponseFile) && GatherAutoResponseFileSwitchesFromFullPath(directoryResponseFile, switchesFromAutoResponseFile, commandLine); - - // Don't look for more response files if it's only in the same place we already looked (next to the exe) - if (!string.Equals(projectDirectory, s_exePath, StringComparison.OrdinalIgnoreCase)) - { - // this combines any found, with higher precedence, with the switches from the original auto response file switches - found |= GatherAutoResponseFileSwitches(projectDirectory, switchesFromAutoResponseFile, commandLine); - } - } - - return found; - } - private static bool WarningsAsErrorsSwitchIsEmpty(CommandLineSwitches commandLineSwitches) { string val = commandLineSwitches.GetParameterizedSwitchCommandLineArg(CommandLineSwitches.ParameterizedSwitch.WarningsAsErrors); @@ -3778,46 +3159,6 @@ private static void ValidateExtensions(string[] projectExtensionsToIgnore) } } - /// - /// Checks whether an argument given as a parameter starts with valid indicator, - ///
which means, whether switch begins with one of: "/", "-", "--" - /// - /// Command line argument with beginning indicator (e.g. --help). - ///
This argument has to be unquoted, otherwise the first character will always be a quote character " - /// true if argument's beginning matches one of possible indicators - ///
false if argument's beginning doesn't match any of correct indicator - /// - private static bool ValidateSwitchIndicatorInUnquotedArgument(string unquotedCommandLineArgument) - { - return unquotedCommandLineArgument.StartsWith("-", StringComparison.Ordinal) // superset of "--" - || unquotedCommandLineArgument.StartsWith("/", StringComparison.Ordinal); - } - - /// - /// Gets the length of the switch indicator (- or / or --) - ///
The length returned from this method is deduced from the beginning sequence of unquoted argument. - ///
This way it will "assume" that there's no further error (e.g. // or ---) which would also be considered as a correct indicator. - /// - /// Unquoted argument with leading indicator and name - /// Correct length of used indicator - ///
0 if no leading sequence recognized as correct indicator - /// Internal for testing purposes - internal static int GetLengthOfSwitchIndicator(string unquotedSwitch) - { - if (unquotedSwitch.StartsWith("--", StringComparison.Ordinal)) - { - return 2; - } - else if (unquotedSwitch.StartsWith("-", StringComparison.Ordinal) || unquotedSwitch.StartsWith("/", StringComparison.Ordinal)) - { - return 1; - } - else - { - return 0; - } - } - /// /// Figures out which targets are to be built. /// From 5025a990c98c029c95bc62bbd117d4237e96a44b Mon Sep 17 00:00:00 2001 From: AR-May <67507805+AR-May@users.noreply.github.com> Date: Fri, 16 Jan 2026 16:45:05 +0100 Subject: [PATCH 32/39] Make task environment path absolutization not throw. (#13035) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Context `TaskEnvironment.GetAbsolutePath` can throw exceptions during multi‑process execution. This issue can be avoided by using `Microsoft.IO.Path.Combine` in .NET Framework MSBuild and `System.IO.Path.Combine` in .NET Core MSBuild in the underlying implementations. ### Changes Made Start using `Path.Combine` for all `AsbolutePath` creations. ### Testing Added a unit test for this case. --- .../BackEnd/TaskEnvironment_Tests.cs | 25 +++++++++++++++++++ .../MultiProcessTaskEnvironmentDriver.cs | 9 ++++++- .../MultiThreadedTaskEnvironmentDriver.cs | 2 +- src/Framework/TaskEnvironment.cs | 4 +-- 4 files changed, 36 insertions(+), 4 deletions(-) diff --git a/src/Build.UnitTests/BackEnd/TaskEnvironment_Tests.cs b/src/Build.UnitTests/BackEnd/TaskEnvironment_Tests.cs index 0a03b507a4c..ba18c88ebc4 100644 --- a/src/Build.UnitTests/BackEnd/TaskEnvironment_Tests.cs +++ b/src/Build.UnitTests/BackEnd/TaskEnvironment_Tests.cs @@ -358,5 +358,30 @@ public void TaskEnvironment_MultithreadedEnvironment_ShouldBeIsolatedFromSystem( Environment.SetEnvironmentVariable(testVarName, null); } } + + [Theory] + [MemberData(nameof(EnvironmentTypes))] + public void TaskEnvironment_GetAbsolutePath_WithInvalidPathChars_ShouldNotThrow(string environmentType) + { + // Construct a path containing an invalid path character + char invalidChar = Path.GetInvalidPathChars().FirstOrDefault(); + string invalidPath = "invalid" + invalidChar + "path"; + + var taskEnvironment = CreateTaskEnvironment(environmentType); + + try + { + // Should not throw on invalid path characters + var absolutePath = taskEnvironment.GetAbsolutePath(invalidPath); + + // The result should contain the invalid path combined with the base directory + absolutePath.Value.ShouldNotBeNullOrEmpty(); + absolutePath.Value.ShouldContain(invalidPath); + } + finally + { + DisposeTaskEnvironment(taskEnvironment); + } + } } } diff --git a/src/Build/BackEnd/TaskExecutionHost/MultiProcessTaskEnvironmentDriver.cs b/src/Build/BackEnd/TaskExecutionHost/MultiProcessTaskEnvironmentDriver.cs index a15e93ca7a6..f794bf64293 100644 --- a/src/Build/BackEnd/TaskExecutionHost/MultiProcessTaskEnvironmentDriver.cs +++ b/src/Build/BackEnd/TaskExecutionHost/MultiProcessTaskEnvironmentDriver.cs @@ -4,7 +4,11 @@ using System; using System.Collections.Generic; using System.Diagnostics; +#if NETFRAMEWORK +using Microsoft.IO; +#else using System.IO; +#endif using Microsoft.Build.Framework; using Microsoft.Build.Internal; @@ -41,7 +45,10 @@ public AbsolutePath ProjectDirectory /// public AbsolutePath GetAbsolutePath(string path) { - return new AbsolutePath(Path.GetFullPath(path), ignoreRootedCheck: true); + // This function should not throw when path has illegal characters. + // For .NET Framework, Microsoft.IO.Path.Combine should be used instead of System.IO.Path.Combine to achieve it. + // For .NET Core, System.IO.Path.Combine already does not throw in this case. + return new AbsolutePath(Path.Combine(NativeMethodsShared.GetCurrentDirectory(), path), ignoreRootedCheck: true); } /// diff --git a/src/Build/BackEnd/TaskExecutionHost/MultiThreadedTaskEnvironmentDriver.cs b/src/Build/BackEnd/TaskExecutionHost/MultiThreadedTaskEnvironmentDriver.cs index b9ff6eb12ce..cf54c430d0d 100644 --- a/src/Build/BackEnd/TaskExecutionHost/MultiThreadedTaskEnvironmentDriver.cs +++ b/src/Build/BackEnd/TaskExecutionHost/MultiThreadedTaskEnvironmentDriver.cs @@ -63,7 +63,7 @@ public AbsolutePath ProjectDirectory { _currentDirectory = value; // Keep the thread-static in sync for use by Expander and Modifiers during property/item expansion. - // This allows Path.GetFullPath and %(FullPath) to resolve relative paths correctly in multithreaded mode. + // This allows Path.GetFullPath and %(FullPath) functions used in project files to resolve relative paths correctly in multithreaded mode. FileUtilities.CurrentThreadWorkingDirectory = value.Value; } } diff --git a/src/Framework/TaskEnvironment.cs b/src/Framework/TaskEnvironment.cs index 03895864491..ec18be1d817 100644 --- a/src/Framework/TaskEnvironment.cs +++ b/src/Framework/TaskEnvironment.cs @@ -33,7 +33,7 @@ public AbsolutePath ProjectDirectory /// /// Converts a relative or absolute path string to an absolute path. - /// This function resolves paths relative to ProjectDirectory. + /// This function resolves paths relative to . /// /// The path to convert. /// An absolute path representation. @@ -77,4 +77,4 @@ public AbsolutePath ProjectDirectory /// internal void Dispose() => _driver.Dispose(); } -} \ No newline at end of file +} From 58c73e6d0469eada8ba025970a23bbe7062dab05 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Fri, 16 Jan 2026 17:26:21 +0000 Subject: [PATCH 33/39] Fix flaky test TestTerminalLoggerTogetherWithOtherLoggers (#13044) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Context Test `TestTerminalLoggerTogetherWithOtherLoggers` fails intermittently in CI. The test executes MSBuild twice - once with terminal logger, once without - then compares binary logs to verify identical behavior. The test had two sources of flakiness: parallel builds causing non-deterministic event ordering, and a fragile assertion comparing all internal events. ### Changes Made - Removed `/m` flag from both MSBuild invocations to make builds deterministic - Removed `AllBuildEvents.Count` assertion that was checking internal implementation details - Test now runs sequentially and validates only meaningful build behavior (errors, warnings, items, properties) ### Testing - Built repository successfully - Test passed consistently across 10+ consecutive runs - Verified that all meaningful assertions continue to validate correct terminal logger behavior ### Notes The fix addresses both root causes of flakiness. The `AllBuildEvents.Count` comparison was too strict - internal events (like assembly loading, telemetry, logger initialization) can legitimately vary between runs based on environment and logger configuration without indicating a problem. The test now focuses on verifying that terminal logger doesn't affect build outcomes (errors, warnings, evaluation results) rather than internal event counts.
Original prompt > > ---- > > *This section details on the original issue you should resolve* > > Test TestTerminalLoggerTogetherWithOtherLoggers is flaky > In the recent runs the test TestTerminalLoggerTogetherWithOtherLoggers fails from time to time. > Fix it or disable if the root cause isn't clear. > > ## Comments on the Issue (you are @copilot in this section) > > > >
- Fixes dotnet/msbuild#13043 --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> --- src/Build.UnitTests/TerminalLogger_Tests.cs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Build.UnitTests/TerminalLogger_Tests.cs b/src/Build.UnitTests/TerminalLogger_Tests.cs index 575b727ad46..59d55089d7b 100644 --- a/src/Build.UnitTests/TerminalLogger_Tests.cs +++ b/src/Build.UnitTests/TerminalLogger_Tests.cs @@ -916,11 +916,11 @@ public void TestTerminalLoggerTogetherWithOtherLoggers() string logFileWithoutTL = env.ExpectFile(".binlog").Path; // Execute MSBuild with binary, file and terminal loggers - RunnerUtilities.ExecMSBuild($"{projectFile.Path} /m /bl:{logFileWithTL} -flp:logfile={Path.Combine(logFolder.Path, "logFileWithTL.log")};verbosity=diagnostic -tl:on", out bool success, outputHelper: _outputHelper); + RunnerUtilities.ExecMSBuild($"{projectFile.Path} /bl:{logFileWithTL} -flp:logfile={Path.Combine(logFolder.Path, "logFileWithTL.log")};verbosity=diagnostic -tl:on", out bool success, outputHelper: _outputHelper); success.ShouldBeTrue(); // Execute MSBuild with binary and file loggers - RunnerUtilities.ExecMSBuild($"{projectFile.Path} /m /bl:{logFileWithoutTL} -flp:logfile={Path.Combine(logFolder.Path, "logFileWithoutTL.log")};verbosity=diagnostic", out success, outputHelper: _outputHelper); + RunnerUtilities.ExecMSBuild($"{projectFile.Path} /bl:{logFileWithoutTL} -flp:logfile={Path.Combine(logFolder.Path, "logFileWithoutTL.log")};verbosity=diagnostic", out success, outputHelper: _outputHelper); success.ShouldBeTrue(); // Read the binary log and replay into mockLogger @@ -935,10 +935,10 @@ public void TestTerminalLoggerTogetherWithOtherLoggers() binaryLogReaderWithTL.Replay(logFileWithTL); binaryLogReaderWithoutTL.Replay(logFileWithoutTL); - // Check that amount of events, warnings, errors is equal in both cases. Presence of other loggers should not change behavior + // Check that amount of warnings and errors is equal in both cases. Presence of other loggers should not change behavior mockLogFromPlaybackWithoutTL.Errors.Count.ShouldBe(mockLogFromPlaybackWithTL.Errors.Count); mockLogFromPlaybackWithoutTL.Warnings.Count.ShouldBe(mockLogFromPlaybackWithTL.Warnings.Count); - mockLogFromPlaybackWithoutTL.AllBuildEvents.Count.ShouldBe(mockLogFromPlaybackWithTL.AllBuildEvents.Count); + // Note: We don't compare AllBuildEvents.Count because internal events can vary between runs and with different logger configurations // Check presence of some items and properties and that they have at least 1 item and property mockLogFromPlaybackWithoutTL.EvaluationFinishedEvents.ShouldContain(x => (x.Items != null) && x.Items.GetEnumerator().MoveNext()); From 4618ab514861c1aec4e9a5550ce685590de44bc7 Mon Sep 17 00:00:00 2001 From: AR-May <67507805+AR-May@users.noreply.github.com> Date: Fri, 16 Jan 2026 18:45:29 +0100 Subject: [PATCH 34/39] Enlighten more tasks that require no change (#13045) ### Context This PR marks several simple tasks as multithreadable. ### Changes Made Marks several simple tasks as multithreadable by adding the MSBuildMultiThreadableTask attribute. These tasks are safe for concurrent execution because they: CombineTargetFrameworkInfoProperties, CombineXmlElements - Pure XML/string manipulation ErrorFromResources - only logs messages FindAppConfigFile, FindInvalidProjectReferences, GetCompatiblePlatform - Only reads metadata from ITaskItem objects; no file I/O ### Testing manual --- src/Tasks/CombineTargetFrameworkInfoProperties.cs | 1 + src/Tasks/CombineXmlElements.cs | 1 + src/Tasks/ErrorFromResources.cs | 1 + src/Tasks/FindAppConfigFile.cs | 1 + src/Tasks/FindInvalidProjectReferences.cs | 1 + src/Tasks/GetCompatiblePlatform.cs | 1 + 6 files changed, 6 insertions(+) diff --git a/src/Tasks/CombineTargetFrameworkInfoProperties.cs b/src/Tasks/CombineTargetFrameworkInfoProperties.cs index 7506fbc8be0..e2a2f6baa37 100644 --- a/src/Tasks/CombineTargetFrameworkInfoProperties.cs +++ b/src/Tasks/CombineTargetFrameworkInfoProperties.cs @@ -12,6 +12,7 @@ namespace Microsoft.Build.Tasks /// /// Combines items that represent properties and values into an XML representation. /// + [MSBuildMultiThreadableTask] public class CombineTargetFrameworkInfoProperties : TaskExtension { /// diff --git a/src/Tasks/CombineXmlElements.cs b/src/Tasks/CombineXmlElements.cs index 8fb5af15dc2..04b973b4e79 100644 --- a/src/Tasks/CombineXmlElements.cs +++ b/src/Tasks/CombineXmlElements.cs @@ -11,6 +11,7 @@ namespace Microsoft.Build.Tasks /// /// Combines multiple XML elements /// + [MSBuildMultiThreadableTask] public class CombineXmlElements : TaskExtension { /// diff --git a/src/Tasks/ErrorFromResources.cs b/src/Tasks/ErrorFromResources.cs index a95a8ca2fd6..f931c5ebd15 100644 --- a/src/Tasks/ErrorFromResources.cs +++ b/src/Tasks/ErrorFromResources.cs @@ -13,6 +13,7 @@ namespace Microsoft.Build.Tasks /// Task that emits an error given a resource string. Engine will add project file path and line/column /// information. /// + [MSBuildMultiThreadableTask] public sealed class ErrorFromResources : TaskExtension { /// diff --git a/src/Tasks/FindAppConfigFile.cs b/src/Tasks/FindAppConfigFile.cs index f8b1332e062..656a5308db0 100644 --- a/src/Tasks/FindAppConfigFile.cs +++ b/src/Tasks/FindAppConfigFile.cs @@ -15,6 +15,7 @@ namespace Microsoft.Build.Tasks /// For compat reasons, it has to follow a particular arbitrary algorithm. /// It also adds the TargetPath metadata. /// + [MSBuildMultiThreadableTask] public class FindAppConfigFile : TaskExtension { // The list to search through diff --git a/src/Tasks/FindInvalidProjectReferences.cs b/src/Tasks/FindInvalidProjectReferences.cs index 607df8b83cd..7c2359a9e45 100644 --- a/src/Tasks/FindInvalidProjectReferences.cs +++ b/src/Tasks/FindInvalidProjectReferences.cs @@ -13,6 +13,7 @@ namespace Microsoft.Build.Tasks /// /// Returns the reference assembly paths to the various frameworks /// + [MSBuildMultiThreadableTask] public partial class FindInvalidProjectReferences : TaskExtension { #region Fields diff --git a/src/Tasks/GetCompatiblePlatform.cs b/src/Tasks/GetCompatiblePlatform.cs index c66e8542878..802a264331d 100644 --- a/src/Tasks/GetCompatiblePlatform.cs +++ b/src/Tasks/GetCompatiblePlatform.cs @@ -14,6 +14,7 @@ namespace Microsoft.Build.Tasks /// /// See ProjectReference-Protocol.md for details. /// + [MSBuildMultiThreadableTask] public class GetCompatiblePlatform : TaskExtension { /// From b703e1a363ed23ef8392682d5d844b0648b568d1 Mon Sep 17 00:00:00 2001 From: "dotnet-maestro[bot]" <42748379+dotnet-maestro[bot]@users.noreply.github.com> Date: Mon, 19 Jan 2026 15:27:26 +0800 Subject: [PATCH 35/39] [main] Update dependencies from dotnet/roslyn (#13050) This pull request updates the following dependencies [marker]: <> (Begin:8a4332aa-2543-4c51-b941-e73f31e22328) ## From https://github.com/dotnet/roslyn - **Subscription**: [8a4332aa-2543-4c51-b941-e73f31e22328](https://maestro.dot.net/subscriptions?search=8a4332aa-2543-4c51-b941-e73f31e22328) - **Build**: [20260118.1](https://dev.azure.com/dnceng/internal/_build/results?buildId=2881928) ([297746](https://maestro.dot.net/channel/548/github:dotnet:roslyn/build/297746)) - **Date Produced**: January 18, 2026 1:58:05 PM UTC - **Commit**: [a8d1f35c874c33cd877b4983c0a315b9437e77e3](https://github.com/dotnet/roslyn/commit/a8d1f35c874c33cd877b4983c0a315b9437e77e3) - **Branch**: [main](https://github.com/dotnet/roslyn/tree/main) [DependencyUpdate]: <> (Begin) - **Dependency Updates**: - From [5.4.0-2.26060.1 to 5.4.0-2.26068.1][1] - Microsoft.Net.Compilers.Toolset [1]: https://github.com/dotnet/roslyn/compare/19f995da64...a8d1f35c87 [DependencyUpdate]: <> (End) [marker]: <> (End:8a4332aa-2543-4c51-b941-e73f31e22328) Co-authored-by: dotnet-maestro[bot] --- eng/Version.Details.props | 2 +- eng/Version.Details.xml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/eng/Version.Details.props b/eng/Version.Details.props index 524d1057291..d67d9a895a4 100644 --- a/eng/Version.Details.props +++ b/eng/Version.Details.props @@ -29,7 +29,7 @@ This file should be imported by eng/Versions.props 7.3.0-preview.1.50 - 5.4.0-2.26060.1 + 5.4.0-2.26068.1 diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml index a9aa5307c7f..f3e696b4d46 100644 --- a/eng/Version.Details.xml +++ b/eng/Version.Details.xml @@ -114,9 +114,9 @@ https://github.com/nuget/nuget.client a99b70cf718ff7842466a7eaeefa99b471cad517 - + https://github.com/dotnet/roslyn - 19f995da648f0afdaffe499200e9c50dc0568eb2 + a8d1f35c874c33cd877b4983c0a315b9437e77e3 https://github.com/dotnet/arcade From c81b56d4381c460ee2fd65ce3ad1d2acb02a88d3 Mon Sep 17 00:00:00 2001 From: "dotnet-maestro[bot]" <42748379+dotnet-maestro[bot]@users.noreply.github.com> Date: Mon, 19 Jan 2026 15:27:50 +0800 Subject: [PATCH 36/39] [main] Update dependencies from dotnet/arcade (#13048) This pull request updates the following dependencies [marker]: <> (Begin:369b758c-dad8-4fea-810a-64fb6b0308e9) ## From https://github.com/dotnet/arcade - **Subscription**: [369b758c-dad8-4fea-810a-64fb6b0308e9](https://maestro.dot.net/subscriptions?search=369b758c-dad8-4fea-810a-64fb6b0308e9) - **Build**: [20260112.3](https://dev.azure.com/dnceng/internal/_build/results?buildId=2877128) ([296898](https://maestro.dot.net/channel/8394/github:dotnet:arcade/build/296898)) - **Date Produced**: January 12, 2026 1:42:08 PM UTC - **Commit**: [9f518f2be968c4c0102c2e3f8c793c5b7f28b731](https://github.com/dotnet/arcade/commit/9f518f2be968c4c0102c2e3f8c793c5b7f28b731) - **Branch**: [release/10.0](https://github.com/dotnet/arcade/tree/release/10.0) [DependencyUpdate]: <> (Begin) - **Dependency Updates**: - From [10.0.0-beta.26057.1 to 10.0.0-beta.26062.3][1] - Microsoft.DotNet.Arcade.Sdk - Microsoft.DotNet.XUnitExtensions [1]: https://github.com/dotnet/arcade/compare/13323fc374...9f518f2be9 [DependencyUpdate]: <> (End) [marker]: <> (End:369b758c-dad8-4fea-810a-64fb6b0308e9) Co-authored-by: dotnet-maestro[bot] --- eng/Version.Details.props | 4 ++-- eng/Version.Details.xml | 8 ++++---- eng/common/core-templates/job/publish-build-assets.yml | 2 +- eng/common/core-templates/post-build/post-build.yml | 4 ++-- eng/common/templates/variables/pool-providers.yml | 2 +- global.json | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/eng/Version.Details.props b/eng/Version.Details.props index d67d9a895a4..767ed27248d 100644 --- a/eng/Version.Details.props +++ b/eng/Version.Details.props @@ -24,8 +24,8 @@ This file should be imported by eng/Versions.props 9.0.11 9.0.11 - 10.0.0-beta.26057.1 - 10.0.0-beta.26057.1 + 10.0.0-beta.26062.3 + 10.0.0-beta.26062.3 7.3.0-preview.1.50 diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml index f3e696b4d46..3f52c301f3a 100644 --- a/eng/Version.Details.xml +++ b/eng/Version.Details.xml @@ -106,9 +106,9 @@ - + https://github.com/dotnet/arcade - 13323fc374efc77953ec0ac9a0927da69f14a584 + 9f518f2be968c4c0102c2e3f8c793c5b7f28b731 https://github.com/nuget/nuget.client @@ -118,9 +118,9 @@ https://github.com/dotnet/roslyn a8d1f35c874c33cd877b4983c0a315b9437e77e3 - + https://github.com/dotnet/arcade - 13323fc374efc77953ec0ac9a0927da69f14a584 + 9f518f2be968c4c0102c2e3f8c793c5b7f28b731 diff --git a/eng/common/core-templates/job/publish-build-assets.yml b/eng/common/core-templates/job/publish-build-assets.yml index 3437087c80f..b955fac6e13 100644 --- a/eng/common/core-templates/job/publish-build-assets.yml +++ b/eng/common/core-templates/job/publish-build-assets.yml @@ -80,7 +80,7 @@ jobs: # If it's not devdiv, it's dnceng ${{ if ne(variables['System.TeamProject'], 'DevDiv') }}: name: NetCore1ESPool-Publishing-Internal - image: windows.vs2019.amd64 + image: windows.vs2022.amd64 os: windows steps: - ${{ if eq(parameters.is1ESPipeline, '') }}: diff --git a/eng/common/core-templates/post-build/post-build.yml b/eng/common/core-templates/post-build/post-build.yml index 9423d71ca3a..b942a79ef02 100644 --- a/eng/common/core-templates/post-build/post-build.yml +++ b/eng/common/core-templates/post-build/post-build.yml @@ -293,11 +293,11 @@ stages: ${{ else }}: ${{ if eq(parameters.is1ESPipeline, true) }}: name: NetCore1ESPool-Publishing-Internal - image: windows.vs2019.amd64 + image: windows.vs2022.amd64 os: windows ${{ else }}: name: NetCore1ESPool-Publishing-Internal - demands: ImageOverride -equals windows.vs2019.amd64 + demands: ImageOverride -equals windows.vs2022.amd64 steps: - template: /eng/common/core-templates/post-build/setup-maestro-vars.yml parameters: diff --git a/eng/common/templates/variables/pool-providers.yml b/eng/common/templates/variables/pool-providers.yml index e0b19c14a07..18693ea120d 100644 --- a/eng/common/templates/variables/pool-providers.yml +++ b/eng/common/templates/variables/pool-providers.yml @@ -23,7 +23,7 @@ # # pool: # name: $(DncEngInternalBuildPool) -# demands: ImageOverride -equals windows.vs2019.amd64 +# demands: ImageOverride -equals windows.vs2022.amd64 variables: - ${{ if eq(variables['System.TeamProject'], 'internal') }}: - template: /eng/common/templates-official/variables/pool-providers.yml diff --git a/global.json b/global.json index dde2fc4b3e7..0d6a2066c27 100644 --- a/global.json +++ b/global.json @@ -14,6 +14,6 @@ "xcopy-msbuild": "18.0.0" }, "msbuild-sdks": { - "Microsoft.DotNet.Arcade.Sdk": "10.0.0-beta.26057.1" + "Microsoft.DotNet.Arcade.Sdk": "10.0.0-beta.26062.3" } } From 825180b2525ad58d979def3f57b154b9942206e2 Mon Sep 17 00:00:00 2001 From: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com> Date: Mon, 19 Jan 2026 10:27:03 +0100 Subject: [PATCH 37/39] Add support for MSBUILD_LOGGING_ARGS (#12993) Fixes https://github.com/dotnet/msbuild/issues/12804 ### Summary This PR implements the MSBUILD_LOGGING_ARGS environment variable feature as described in the design spec (https://github.com/dotnet/msbuild/pull/12805). This allows enabling binary logging collection in CI/CD pipelines without modifying project files or build scripts. ### Motivation In CI/CD environments, it's often desirable to enable diagnostic logging (binary logs) for all builds without: Modifying project files or .rsp files on disk Changing build scripts Affecting local developer builds This feature enables centralized build diagnostics configuration through environment variables. ### Testing Add comprehensive UT coverage . connected to https://github.com/dotnet/msbuild/pull/12706 --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: baronfel <573979+baronfel@users.noreply.github.com> --- .../BackEnd/BuildManager/BuildManager.cs | 49 ++- src/Build/Resources/xlf/Strings.cs.xlf | 2 +- src/Build/Resources/xlf/Strings.de.xlf | 2 +- src/Build/Resources/xlf/Strings.es.xlf | 2 +- src/Build/Resources/xlf/Strings.fr.xlf | 2 +- src/Build/Resources/xlf/Strings.it.xlf | 2 +- src/Build/Resources/xlf/Strings.ja.xlf | 2 +- src/Build/Resources/xlf/Strings.ko.xlf | 2 +- src/Build/Resources/xlf/Strings.pl.xlf | 2 +- src/Build/Resources/xlf/Strings.pt-BR.xlf | 2 +- src/Build/Resources/xlf/Strings.ru.xlf | 2 +- src/Build/Resources/xlf/Strings.tr.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hans.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hant.xlf | 2 +- src/Framework/Traits.cs | 22 ++ .../XMake_BinlogSwitch_Tests.cs | 294 ++++++++++++++++++ src/MSBuild/CommandLine/CommandLineParser.cs | 108 ++++++- src/MSBuild/Resources/Strings.resx | 17 +- src/MSBuild/Resources/xlf/Strings.cs.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.de.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.es.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.fr.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.it.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.ja.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.ko.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.pl.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.pt-BR.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.ru.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.tr.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf | 17 +- src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf | 17 +- src/MSBuild/XMake.cs | 11 +- 32 files changed, 716 insertions(+), 32 deletions(-) create mode 100644 src/MSBuild.UnitTests/XMake_BinlogSwitch_Tests.cs diff --git a/src/Build/BackEnd/BuildManager/BuildManager.cs b/src/Build/BackEnd/BuildManager/BuildManager.cs index 9253bce109b..02b2799a972 100644 --- a/src/Build/BackEnd/BuildManager/BuildManager.cs +++ b/src/Build/BackEnd/BuildManager/BuildManager.cs @@ -396,6 +396,16 @@ public static BuildManager DefaultBuildManager /// LegacyThreadingData IBuildComponentHost.LegacyThreadingData => _legacyThreadingData; + /// + /// Enumeration describing the severity of a deferred build message. + /// + public enum DeferredBuildMessageSeverity + { + Message = 1, + Warning, + Error + } + /// /// /// @@ -407,11 +417,19 @@ public readonly struct DeferredBuildMessage public string? FilePath { get; } + public DeferredBuildMessageSeverity MessageSeverity { get; } = DeferredBuildMessageSeverity.Message; + + /// + /// Build event code (e.g., "MSB1070"). + /// + public string? Code { get; } + public DeferredBuildMessage(string text, MessageImportance importance) { Importance = importance; Text = text; FilePath = null; + Code = null; } public DeferredBuildMessage(string text, MessageImportance importance, string filePath) @@ -419,6 +437,22 @@ public DeferredBuildMessage(string text, MessageImportance importance, string fi Importance = importance; Text = text; FilePath = filePath; + Code = null; + } + + /// + /// Creates a deferred warning message. + /// + /// The warning message text. + /// The build message code (e.g., "MSB1070"). + /// The severity of the deferred build message. + public DeferredBuildMessage(string text, string code, DeferredBuildMessageSeverity messageSeverity) + { + Importance = MessageImportance.Normal; + Text = text; + FilePath = null; + Code = code; + MessageSeverity = messageSeverity; } } @@ -3154,7 +3188,20 @@ private static void LogDeferredMessages(ILoggingService loggingService, IEnumera foreach (var message in deferredBuildMessages) { - loggingService.LogCommentFromText(BuildEventContext.Invalid, message.Importance, message.Text); + if (message.MessageSeverity is DeferredBuildMessageSeverity.Warning) + { + loggingService.LogWarningFromText( + BuildEventContext.Invalid, + subcategoryResourceName: null, + warningCode: message.Code, + helpKeyword: null, + file: BuildEventFileInfo.Empty, + message: message.Text); + } + else + { + loggingService.LogCommentFromText(BuildEventContext.Invalid, message.Importance, message.Text); + } // If message includes a file path, include that file if (message.FilePath is not null) diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index 9ab02afe3bc..72d6d7fda24 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Nepodařilo se zkopírovat binární protokol z {0} do {1}. {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.de.xlf b/src/Build/Resources/xlf/Strings.de.xlf index 5ce46079b62..2a77ed9ff61 100644 --- a/src/Build/Resources/xlf/Strings.de.xlf +++ b/src/Build/Resources/xlf/Strings.de.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Fehler beim Kopieren des Binärprotokolls von „{0}“ nach „{1}“. {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index a72490d50a5..eb658d3565f 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: no se pudo copiar el registro binario de "{0}" a "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.fr.xlf b/src/Build/Resources/xlf/Strings.fr.xlf index 9264bfb3118..25e3980f51b 100644 --- a/src/Build/Resources/xlf/Strings.fr.xlf +++ b/src/Build/Resources/xlf/Strings.fr.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Échec de la copie du journal binaire de « {0} » vers « {1} ». {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index c3a339f9aba..239a9f429ce 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: non è possibile copiare il log binario da "{0}" a "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index bab87c64b11..83ed22b46e0 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: バイナリ ログを "{0}" から "{1}" にコピーできませんでした。{2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index 8fbaf0b2a79..fb99fabaddd 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: 이진 로그를 "{0}"에서 "{1}"(으)로 복사하지 못했습니다. {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index 5468c688eba..a30525b6f35 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: nie można skopiować dziennika binarnego z „{0}” do „{1}”. {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index f7957c45cda..dbbb7ef4630 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: falha ao copiar o log binário de "{0}" para "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index 4b309e0cc21..73a9a7142b6 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: не удалось скопировать двоичный журнал из "{0}" в "{1}". {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index 87f9b73cded..9e8bfab9b40 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: İkili günlük dosyası "{0}" konumundan "{1}" konumuna kopyalanamadı. {2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index ad7d1118c48..347c0136d86 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: 未能将二进制日志从“{0}”复制到“{1}”。{2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index 6a78af31da7..3ccdd81d1c3 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: 無法將二進位記錄從 "{0}" 複製到 "{1}"。{2} + MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Framework/Traits.cs b/src/Framework/Traits.cs index 31378398be6..f14208e145a 100644 --- a/src/Framework/Traits.cs +++ b/src/Framework/Traits.cs @@ -135,6 +135,28 @@ public Traits() /// public const string UseMSBuildServerEnvVarName = "MSBUILDUSESERVER"; + /// + /// Name of environment variable for logging arguments (e.g., -bl, -check). + /// + public const string MSBuildLoggingArgsEnvVarName = "MSBUILD_LOGGING_ARGS"; + + /// + /// Name of environment variable that controls the logging level for diagnostic messages + /// emitted when processing the MSBUILD_LOGGING_ARGS environment variable. + /// Set to "message" to emit as low-importance build messages instead of console warnings. + /// + public const string MSBuildLoggingArgsLevelEnvVarName = "MSBUILD_LOGGING_ARGS_LEVEL"; + + /// + /// Value of the MSBUILD_LOGGING_ARGS environment variable. + /// + public static string? MSBuildLoggingArgs => Environment.GetEnvironmentVariable(MSBuildLoggingArgsEnvVarName); + + /// + /// Gets if the logging level for MSBUILD_LOGGING_ARGS diagnostic is message. + /// + public readonly bool EmitLogsAsMessage = string.Equals(Environment.GetEnvironmentVariable(MSBuildLoggingArgsLevelEnvVarName), "message", StringComparison.OrdinalIgnoreCase); + public readonly bool DebugEngine = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("MSBuildDebugEngine")); public readonly bool DebugScheduler; public readonly bool DebugNodeCommunication; diff --git a/src/MSBuild.UnitTests/XMake_BinlogSwitch_Tests.cs b/src/MSBuild.UnitTests/XMake_BinlogSwitch_Tests.cs new file mode 100644 index 00000000000..af764f80e36 --- /dev/null +++ b/src/MSBuild.UnitTests/XMake_BinlogSwitch_Tests.cs @@ -0,0 +1,294 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System; +using System.Collections.Generic; +using System.IO; +using Microsoft.Build.CommandLine.Experimental; +using Microsoft.Build.Execution; +using Microsoft.Build.UnitTests.Shared; +using Shouldly; +using Xunit; +using Xunit.Abstractions; + +#nullable disable + +namespace Microsoft.Build.UnitTests +{ + /// + /// Tests for MSBUILD_LOGGING_ARGS environment variable functionality. + /// + public class XMakeBinlogSwitchTests : IDisposable + { + private readonly ITestOutputHelper _output; + private readonly TestEnvironment _env; + + public XMakeBinlogSwitchTests(ITestOutputHelper output) + { + _output = output; + _env = TestEnvironment.Create(output); + } + + public void Dispose() => _env.Dispose(); + + /// + /// Test that MSBUILD_LOGGING_ARGS with -bl creates a binary log. + /// + [Fact] + public void LoggingArgsEnvVarWithBinaryLogger() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + string binlogPath = Path.Combine(directory.Path, "test.binlog"); + + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", $"-bl:{binlogPath}"); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + File.Exists(binlogPath).ShouldBeTrue($"Binary log should have been created at {binlogPath}"); + } + + /// + /// Test that MSBUILD_LOGGING_ARGS with multiple -bl switches creates multiple binary logs. + /// + [Fact] + public void LoggingArgsEnvVarWithMultipleBinaryLoggers() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + string binlogPath1 = Path.Combine(directory.Path, "test1.binlog"); + string binlogPath2 = Path.Combine(directory.Path, "test2.binlog"); + + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", $"-bl:{binlogPath1} -bl:{binlogPath2}"); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + File.Exists(binlogPath1).ShouldBeTrue($"First binary log should have been created at {binlogPath1}"); + File.Exists(binlogPath2).ShouldBeTrue($"Second binary log should have been created at {binlogPath2}"); + } + + /// + /// Test that MSBUILD_LOGGING_ARGS with {} placeholder generates unique filenames. + /// + [Fact] + public void LoggingArgsEnvVarWithWildcardPlaceholder() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + + // Use {} placeholder for unique filename generation + string binlogPattern = Path.Combine(directory.Path, "build-{}.binlog"); + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", $"-bl:{binlogPattern}"); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + // Find the generated binlog file (should have unique characters instead of {}) + string[] binlogFiles = Directory.GetFiles(directory.Path, "build-*.binlog"); + binlogFiles.Length.ShouldBe(1, $"Expected exactly one binlog file to be created in {directory.Path}"); + + // The filename should not contain {} - it should have been replaced with unique characters + binlogFiles[0].ShouldNotContain("{}"); + binlogFiles[0].ShouldContain("build-"); + } + + /// + /// Test that MSBUILD_LOGGING_ARGS with multiple {} placeholders generates unique filenames with each placeholder replaced. + /// + [Fact] + public void LoggingArgsEnvVarWithMultipleWildcardPlaceholders() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + + // Use multiple {} placeholders for unique filename generation + string binlogPattern = Path.Combine(directory.Path, "build-{}-test-{}.binlog"); + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", $"-bl:{binlogPattern}"); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + // Find the generated binlog file (should have unique characters instead of {}) + string[] binlogFiles = Directory.GetFiles(directory.Path, "build-*-test-*.binlog"); + binlogFiles.Length.ShouldBe(1, $"Expected exactly one binlog file to be created in {directory.Path}"); + + // The filename should not contain {} - both placeholders should have been replaced + binlogFiles[0].ShouldNotContain("{}"); + binlogFiles[0].ShouldContain("build-"); + binlogFiles[0].ShouldContain("-test-"); + } + + /// + /// Test that MSBUILD_LOGGING_ARGS ignores unsupported arguments and continues with valid ones. + /// + [Fact] + public void LoggingArgsEnvVarIgnoresUnsupportedArguments() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + string binlogPath = Path.Combine(directory.Path, "test.binlog"); + + // Set env var with mixed valid and invalid arguments + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", $"-bl:{binlogPath} -maxcpucount:4 -verbosity:detailed"); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + // Binary log should still be created (valid argument) + File.Exists(binlogPath).ShouldBeTrue($"Binary log should have been created at {binlogPath}"); + + // Warning should appear for invalid arguments + output.ShouldContain("MSB1070"); + } + + /// + /// Test that MSBUILD_LOGGING_ARGS works with /noautoresponse. + /// + [Fact] + public void LoggingArgsEnvVarWorksWithNoAutoResponse() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + string binlogPath = Path.Combine(directory.Path, "test.binlog"); + + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", $"-bl:{binlogPath}"); + + // Use /noautoresponse - MSBUILD_LOGGING_ARGS should still work + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\" /noautoresponse", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + File.Exists(binlogPath).ShouldBeTrue($"Binary log should have been created even with /noautoresponse"); + } + + /// + /// Test that MSBUILD_LOGGING_ARGS_LEVEL=message emits diagnostics as messages instead of warnings. + /// + [Fact] + public void LoggingArgsEnvVarLevelMessageSuppressesWarnings() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", "-maxcpucount:4"); + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS_LEVEL", "message"); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + output.ShouldNotContain("MSB1070"); + } + + /// + /// Test that MSBUILD_LOGGING_ARGS emits warnings by default when MSBUILD_LOGGING_ARGS_LEVEL is not set. + /// + [Fact] + public void LoggingArgsEnvVarDefaultLevelEmitsWarnings() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + + // Set env var with invalid argument, but do NOT set MSBUILD_LOGGING_ARGS_LEVEL + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", "-maxcpucount:4"); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + // Warning SHOULD appear when level is not set (default behavior) + output.ShouldContain("MSB1070"); + } + + /// + /// Test that empty or whitespace MSBUILD_LOGGING_ARGS is ignored. + /// + [Fact] + public void LoggingArgsEnvVarEmptyIsIgnored() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", " "); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + } + + /// + /// Test that -check switch is allowed in MSBUILD_LOGGING_ARGS. + /// + [Fact] + public void LoggingArgsEnvVarAllowsCheckSwitch() + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", "-check"); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + output.ShouldNotContain("MSB1070"); + } + + /// + /// Test that only logging-related switches are allowed. + /// + [Theory] + [InlineData("-bl")] + [InlineData("-bl:test.binlog")] + [InlineData("-binarylogger")] + [InlineData("-binarylogger:test.binlog")] + [InlineData("/bl")] + [InlineData("/bl:test.binlog")] + [InlineData("--bl")] + [InlineData("-check")] + [InlineData("/check")] + public void LoggingArgsEnvVarAllowedSwitches(string switchArg) + { + CommandLineParser parser = new(); + _ = _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", switchArg); + + CommandLineSwitches switches = new(); + List deferredBuildMessages = new(); + parser.GatherLoggingArgsEnvironmentVariableSwitches(ref switches, deferredBuildMessages, "test"); + + switches.HaveErrors().ShouldBeFalse($"Switch {switchArg} should be allowed"); + } + + /// + /// Test that non-logging switches are rejected. + /// + [Theory] + [InlineData("-property:A=1")] + [InlineData("-target:Build")] + [InlineData("-verbosity:detailed")] + [InlineData("-maxcpucount:4")] + [InlineData("/p:A=1")] + [InlineData("-restore")] + [InlineData("-nologo")] + public void LoggingArgsEnvVarDisallowedSwitches(string switchArg) + { + var directory = _env.CreateFolder(); + string content = ObjectModelHelpers.CleanupFileContents(""); + var projectPath = directory.CreateFile("my.proj", content).Path; + + _env.SetEnvironmentVariable("MSBUILD_LOGGING_ARGS", switchArg); + + string output = RunnerUtilities.ExecMSBuild($"\"{projectPath}\"", out var successfulExit, _output); + successfulExit.ShouldBeTrue(output); + + output.ShouldContain("MSB1070"); + } + } +} diff --git a/src/MSBuild/CommandLine/CommandLineParser.cs b/src/MSBuild/CommandLine/CommandLineParser.cs index ace7267233a..913e2dff2f6 100644 --- a/src/MSBuild/CommandLine/CommandLineParser.cs +++ b/src/MSBuild/CommandLine/CommandLineParser.cs @@ -11,8 +11,11 @@ using System.Text.RegularExpressions; using System.Threading.Tasks; using System.Xml.Linq; +using Microsoft.Build.Framework; using Microsoft.Build.Shared; using Microsoft.Build.Shared.FileSystem; +using static Microsoft.Build.CommandLine.Experimental.CommandLineSwitches; +using static Microsoft.Build.Execution.BuildManager; #nullable disable @@ -60,15 +63,17 @@ internal class CommandLineParser public CommandLineSwitchesAccessor Parse(IEnumerable commandLineArgs) { List args = [BuildEnvironmentHelper.Instance.CurrentMSBuildExePath, ..commandLineArgs]; + List deferredBuildMessages = []; GatherAllSwitches( args, + deferredBuildMessages, out CommandLineSwitches responseFileSwitches, out CommandLineSwitches commandLineSwitches, out string fullCommandLine, out _); - CommandLineSwitches result = new CommandLineSwitches(); + CommandLineSwitches result = new(); result.Append(responseFileSwitches, fullCommandLine); // lowest precedence result.Append(commandLineSwitches, fullCommandLine); @@ -82,12 +87,14 @@ public CommandLineSwitchesAccessor Parse(IEnumerable commandLineArgs) /// response files, including the auto-response file. /// /// + /// /// /// /// /// Combined bag of switches. internal void GatherAllSwitches( IEnumerable commandLineArgs, + List deferredBuildMessages, out CommandLineSwitches switchesFromAutoResponseFile, out CommandLineSwitches switchesNotFromAutoResponseFile, out string fullCommandLine, @@ -119,11 +126,108 @@ internal void GatherAllSwitches( // parse the auto-response file (if "/noautoresponse" is not specified), and combine those switches with the // switches on the command line switchesFromAutoResponseFile = new CommandLineSwitches(); - if (!switchesNotFromAutoResponseFile[CommandLineSwitches.ParameterlessSwitch.NoAutoResponse]) + if (!switchesNotFromAutoResponseFile[ParameterlessSwitch.NoAutoResponse]) { string exePath = Path.GetDirectoryName(FileUtilities.ExecutingAssemblyPath); // Copied from XMake GatherAutoResponseFileSwitches(exePath, switchesFromAutoResponseFile, fullCommandLine); } + + CommandLineSwitches switchesFromEnvironmentVariable = new(); + GatherLoggingArgsEnvironmentVariableSwitches(ref switchesFromEnvironmentVariable, deferredBuildMessages, fullCommandLine); + switchesNotFromAutoResponseFile.Append(switchesFromEnvironmentVariable, fullCommandLine); + } + + /// + /// Gathers and validates logging switches from the MSBUILD_LOGGING_ARGS environment variable. + /// Only -bl and -check switches are allowed. All other switches are logged as warnings and ignored. + /// + internal void GatherLoggingArgsEnvironmentVariableSwitches( + ref CommandLineSwitches switches, + List deferredBuildMessages, + string commandLine) + { + if (string.IsNullOrWhiteSpace(Traits.MSBuildLoggingArgs)) + { + return; + } + + DeferredBuildMessageSeverity messageSeverity = Traits.Instance.EmitLogsAsMessage ? DeferredBuildMessageSeverity.Message : DeferredBuildMessageSeverity.Warning; + + try + { + List envVarArgs = QuotingUtilities.SplitUnquoted(Traits.MSBuildLoggingArgs); + + List validArgs = new(envVarArgs.Count); + List invalidArgs = null; + + foreach (string arg in envVarArgs) + { + string unquotedArg = QuotingUtilities.Unquote(arg); + if (string.IsNullOrWhiteSpace(unquotedArg)) + { + continue; + } + + if (IsAllowedLoggingArg(unquotedArg)) + { + validArgs.Add(arg); + } + else + { + invalidArgs ??= []; + invalidArgs.Add(unquotedArg); + } + } + + if (invalidArgs != null) + { + foreach (string invalidArg in invalidArgs) + { + var message = ResourceUtilities.FormatResourceStringStripCodeAndKeyword(out string warningCode, out _, "LoggingArgsEnvVarUnsupportedArgument", invalidArg); + deferredBuildMessages.Add(new DeferredBuildMessage(message, warningCode, messageSeverity)); + } + } + + if (validArgs.Count > 0) + { + deferredBuildMessages.Add(new DeferredBuildMessage(ResourceUtilities.FormatResourceStringIgnoreCodeAndKeyword("LoggingArgsEnvVarUsing", string.Join(" ", validArgs)), MessageImportance.Low)); + GatherCommandLineSwitches(validArgs, switches, commandLine); + } + } + catch (Exception ex) + { + var message = ResourceUtilities.FormatResourceStringStripCodeAndKeyword(out string errorCode, out _, "LoggingArgsEnvVarError", ex.ToString()); + deferredBuildMessages.Add(new DeferredBuildMessage(message, errorCode, messageSeverity)); + } + } + + /// + /// Checks if the argument is an allowed logging argument (-bl or -check). + /// + /// The unquoted argument to check. + /// True if the argument is allowed, false otherwise. + private bool IsAllowedLoggingArg(string arg) + { + if (!ValidateSwitchIndicatorInUnquotedArgument(arg)) + { + return false; + } + + ReadOnlySpan switchPart = arg.AsSpan(GetLengthOfSwitchIndicator(arg)); + + // Extract switch name (before any ':' parameter indicator) + int colonIndex = switchPart.IndexOf(':'); + ReadOnlySpan switchNameSpan = colonIndex >= 0 ? switchPart.Slice(0, colonIndex) : switchPart; + string switchName = switchNameSpan.ToString(); + + return IsParameterizedSwitch( + switchName, + out ParameterizedSwitch paramSwitch, + out _, + out _, + out _, + out _, + out _) && (paramSwitch == ParameterizedSwitch.BinaryLogger || paramSwitch == ParameterizedSwitch.Check); } /// diff --git a/src/MSBuild/Resources/Strings.resx b/src/MSBuild/Resources/Strings.resx index 0c9087351cb..6e75cc0db7e 100644 --- a/src/MSBuild/Resources/Strings.resx +++ b/src/MSBuild/Resources/Strings.resx @@ -1704,10 +1704,25 @@ Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + diff --git a/src/MSBuild/Resources/xlf/Strings.cs.xlf b/src/MSBuild/Resources/xlf/Strings.cs.xlf index 6f21a13ec84..4c5a6b3efa8 100644 --- a/src/MSBuild/Resources/xlf/Strings.cs.xlf +++ b/src/MSBuild/Resources/xlf/Strings.cs.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Byly zadány duplicitní cesty k binárnímu protokolu a byly ignorovány: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -335,6 +335,21 @@ LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. Na základě klíče registru Windows LongPathsEnabled má funkce LongPaths hodnotu {0}. diff --git a/src/MSBuild/Resources/xlf/Strings.de.xlf b/src/MSBuild/Resources/xlf/Strings.de.xlf index 71d5bf1961e..cadcfd4dd48 100644 --- a/src/MSBuild/Resources/xlf/Strings.de.xlf +++ b/src/MSBuild/Resources/xlf/Strings.de.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Doppelte Binärprotokollpfade angegeben und ignoriert: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -335,6 +335,21 @@ LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. Basierend auf dem Windows-Registrierungsschlüssel LongPathsEnabled ist das Feature LongPaths {0}. diff --git a/src/MSBuild/Resources/xlf/Strings.es.xlf b/src/MSBuild/Resources/xlf/Strings.es.xlf index f67f93029d0..cf14afb978a 100644 --- a/src/MSBuild/Resources/xlf/Strings.es.xlf +++ b/src/MSBuild/Resources/xlf/Strings.es.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Rutas de registro binarias duplicadas especificadas y omitidas: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -334,6 +334,21 @@ Esta marca es experimental y puede que no funcione según lo previsto. LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. De acuerdo con la clave del Registro de Windows LongPathsEnabled, la característica LongPaths está {0}. diff --git a/src/MSBuild/Resources/xlf/Strings.fr.xlf b/src/MSBuild/Resources/xlf/Strings.fr.xlf index 027581abd70..96f4aa0130a 100644 --- a/src/MSBuild/Resources/xlf/Strings.fr.xlf +++ b/src/MSBuild/Resources/xlf/Strings.fr.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Chemins d'accès aux journaux binaires en double spécifiés et ignorés : {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -335,6 +335,21 @@ futures LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. D’après la clé de Registre Windows LongPathsEnabled, la fonctionnalité LongPaths est {0}. diff --git a/src/MSBuild/Resources/xlf/Strings.it.xlf b/src/MSBuild/Resources/xlf/Strings.it.xlf index 6642ab382c0..0c7056c3663 100644 --- a/src/MSBuild/Resources/xlf/Strings.it.xlf +++ b/src/MSBuild/Resources/xlf/Strings.it.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Percorsi di log binari duplicati specificati e ignorati: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -335,6 +335,21 @@ Questo flag è sperimentale e potrebbe non funzionare come previsto. LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. In base alla chiave del Registro di sistema di Windows LongPathsEnabled, la funzionalità LongPaths è {0}. diff --git a/src/MSBuild/Resources/xlf/Strings.ja.xlf b/src/MSBuild/Resources/xlf/Strings.ja.xlf index 581a5984de9..3c818d6fbb2 100644 --- a/src/MSBuild/Resources/xlf/Strings.ja.xlf +++ b/src/MSBuild/Resources/xlf/Strings.ja.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - 重複するバイナリ ログ パスが指定され、次は無視されました: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -335,6 +335,21 @@ LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. Windows レジストリ キー LongPathsEnabled に基づいて、LongPaths 機能は{0}です。 diff --git a/src/MSBuild/Resources/xlf/Strings.ko.xlf b/src/MSBuild/Resources/xlf/Strings.ko.xlf index acdf0b64430..411c1d95294 100644 --- a/src/MSBuild/Resources/xlf/Strings.ko.xlf +++ b/src/MSBuild/Resources/xlf/Strings.ko.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - 중복된 이진 로그 경로가 지정되어 무시되었습니다. {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -336,6 +336,21 @@ LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. Windows 레지스트리 키 LongPathsEnabled에 따라 LongPaths 기능이 {0}입니다. diff --git a/src/MSBuild/Resources/xlf/Strings.pl.xlf b/src/MSBuild/Resources/xlf/Strings.pl.xlf index ad0cfa8541a..5ce6bbfc336 100644 --- a/src/MSBuild/Resources/xlf/Strings.pl.xlf +++ b/src/MSBuild/Resources/xlf/Strings.pl.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Określono i zignorowano zduplikowane ścieżki dziennika binarnego: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -334,6 +334,21 @@ Ta flaga jest eksperymentalna i może nie działać zgodnie z oczekiwaniami. LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. Na podstawie klucza rejestru systemu Windows LongPathsEnabled funkcja LongPaths jest {0}. diff --git a/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf b/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf index 5be904253d7..1bcf3e21a22 100644 --- a/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf +++ b/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Caminhos de log binários duplicados especificados e ignorados: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -334,6 +334,21 @@ LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. Com base na chave do Registro do Windows LongPathsEnabled, o recurso LongPaths é {0}. diff --git a/src/MSBuild/Resources/xlf/Strings.ru.xlf b/src/MSBuild/Resources/xlf/Strings.ru.xlf index 93bd4c31f7c..4d1ae14ff24 100644 --- a/src/MSBuild/Resources/xlf/Strings.ru.xlf +++ b/src/MSBuild/Resources/xlf/Strings.ru.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Указаны повторяющиеся пути к двоичным журналам, которые были проигнорированы: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -334,6 +334,21 @@ LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. На основе раздела реестра Windows LongPathsEnabled функция LongPaths имеет значение {0}. diff --git a/src/MSBuild/Resources/xlf/Strings.tr.xlf b/src/MSBuild/Resources/xlf/Strings.tr.xlf index aed787a4237..3b8cdeb76ff 100644 --- a/src/MSBuild/Resources/xlf/Strings.tr.xlf +++ b/src/MSBuild/Resources/xlf/Strings.tr.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Belirtilen ve yok sayılan yinelenen ikili günlük yolları: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -334,6 +334,21 @@ LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. Windows kayıt defteri anahtarı LongPathsEnabled ayarına bağlı olarak LongPaths özelliği {0}. diff --git a/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf b/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf index b02080e6e1d..11864fab049 100644 --- a/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - 指定且忽略的重复二进制日志路径: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -335,6 +335,21 @@ LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. 基于 Windows 注册表项 LongPathsEnabled，LongPaths 功能为 {0}。 diff --git a/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf b/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf index 2be999c8a3e..3148a590c4d 100644 --- a/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - 指定了重複的二進位記錄路徑，並已忽略: {0} + Duplicate binary log path(s) specified and ignored: {0} {0} is the list of duplicate paths that were filtered out @@ -335,6 +335,21 @@ LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized. + + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + MSB1071: Error processing MSBUILD_LOGGING_ARGS environment variable: {0} + {StrBegin="MSB1071: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the error message. + + + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + MSB1070: MSBUILD_LOGGING_ARGS: Ignoring unsupported argument '{0}'. Only -bl and -check arguments are allowed. + {StrBegin="MSB1070: "}LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is the unsupported argument. + + + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + Using arguments from MSBUILD_LOGGING_ARGS environment variable: {0} + LOCALIZATION: "MSBUILD_LOGGING_ARGS" should not be localized. {0} is a string with the command-line arguments from the environment variable. + Based on the Windows registry key LongPathsEnabled, the LongPaths feature is {0}. 根據 Windows 登錄機碼 LongPathsEnabled，LongPaths 功能為 {0}。 diff --git a/src/MSBuild/XMake.cs b/src/MSBuild/XMake.cs index ddb0fc04240..f73781e4bf6 100644 --- a/src/MSBuild/XMake.cs +++ b/src/MSBuild/XMake.cs @@ -306,7 +306,14 @@ private static bool CanRunServerBasedOnCommandLineSwitches(string[] commandLine) bool canRunServer = true; try { - commandLineParser.GatherAllSwitches(commandLine, out var switchesFromAutoResponseFile, out var switchesNotFromAutoResponseFile, out string fullCommandLine, out s_exeName); + commandLineParser.GatherAllSwitches( + commandLine, + s_globalMessagesToLogInBuildLoggers, + out CommandLineSwitches switchesFromAutoResponseFile, + out CommandLineSwitches switchesNotFromAutoResponseFile, + out string fullCommandLine, + out s_exeName); + CommandLineSwitches commandLineSwitches = CombineSwitchesRespectingPriority(switchesFromAutoResponseFile, switchesNotFromAutoResponseFile, fullCommandLine); if (commandLineParser.CheckAndGatherProjectAutoResponseFile(switchesFromAutoResponseFile, commandLineSwitches, false, fullCommandLine)) { @@ -681,7 +688,7 @@ public static ExitType Execute(string[] commandLine) bool reportFileAccesses = false; #endif - commandLineParser.GatherAllSwitches(commandLine, out var switchesFromAutoResponseFile, out var switchesNotFromAutoResponseFile, out _, out s_exeName); + commandLineParser.GatherAllSwitches(commandLine, s_globalMessagesToLogInBuildLoggers, out var switchesFromAutoResponseFile, out var switchesNotFromAutoResponseFile, out _, out s_exeName); bool buildCanBeInvoked = ProcessCommandLineSwitches( switchesFromAutoResponseFile, From d6f451b8a01f97a2b0f0688570864da373c536b0 Mon Sep 17 00:00:00 2001 From: David Federman Date: Mon, 19 Jan 2026 01:43:15 -0800 Subject: [PATCH 38/39] Fix MSBuildEventSource (#13030) I'm seeing this exception: ``` System.TypeInitializationException: The type initializer for 'Microsoft.Build.Eventing.MSBuildEventSource' threw an exception. ---> System.MissingMethodException: Method not found: 'Void System.Diagnostics.Tracing.EventSource..ctor(System.String, System.Guid)'. at Microsoft.Build.Eventing.MSBuildEventSource..ctor() at Microsoft.Build.Eventing.MSBuildEventSource..ctor() at Microsoft.Build.Eventing.MSBuildEventSource..cctor() --- End of inner exception stack trace --- at Microsoft.Build.Graph.ProjectGraph.<>c__DisplayClass41_0.<.ctor>g__BeginMeasurement|1() at Microsoft.Build.Graph.ProjectGraph..ctor(IEnumerable`1 entryPoints, ProjectCollection projectCollection, ProjectInstanceFactoryFunc projectInstanceFactory, Int32 degreeOfParallelism, CancellationToken cancellationToken) at Microsoft.Build.Graph.ProjectGraph..ctor(IEnumerable`1 entryPoints, ProjectCollection projectCollection, ProjectInstanceFactoryFunc projectInstanceFactory) ``` In ILSpy I see Microsoft.Build.Framework.dll `18.3.0-preview-26055-101+e64f84d6312cdaf227d26aeabfa4817862404d59` having: ```cs private MSBuildEventSource() : base("Microsoft-Build", new Guid(3561627800u, 33311, 22536, 76, 234, 30, 36, 233, 130, 202, 55)) { } ``` But in `C:\Program Files\dotnet\shared\Microsoft.NETCore.App\10.0.1\System.Private.CoreLib.dll` (loaded in .NET 10) I see: ```cs internal EventSource(Guid eventSourceGuid, string eventSourceName) : this(eventSourceGuid, eventSourceName, EventSourceSettings.EtwManifestEventFormat) { } ``` It's both internal and the args are backwards... I believe this was introduced in #12886. Which pulls in this change: https://github.com/dotnet/runtime/pull/121180 That seems to introduce a source generator which calls the internal ctor of EventSource (and with different order). As that's internal to .NET, I expect it was not intended to be applied here in MSBuild. This change simply reverts the change to `MSBuildEventSource`. Co-authored-by: AR-May <67507805+AR-May@users.noreply.github.com> --- src/Framework/MSBuildEventSource.cs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/Framework/MSBuildEventSource.cs b/src/Framework/MSBuildEventSource.cs index 78c7eaa55f2..e6b691a2105 100644 --- a/src/Framework/MSBuildEventSource.cs +++ b/src/Framework/MSBuildEventSource.cs @@ -12,7 +12,7 @@ namespace Microsoft.Build.Eventing /// Changes to existing event method signatures will not be reflected unless you update the property or assign a new event ID. /// [EventSource(Name = "Microsoft-Build")] - internal sealed partial class MSBuildEventSource : EventSource + internal sealed class MSBuildEventSource : EventSource { public static class Keywords { @@ -40,6 +40,8 @@ public static class Keywords /// public static MSBuildEventSource Log = new MSBuildEventSource(); + private MSBuildEventSource() { } + #region Events /// From c1ccadda16bccb59a963b2a424474b9c7fe53310 Mon Sep 17 00:00:00 2001 From: dotnet bot Date: Mon, 19 Jan 2026 11:40:19 +0100 Subject: [PATCH 39/39] Localized file check-in by OneLocBuild Task: Build definition ID 9434: Build ID 13124182 (#13053) This is the pull request automatically created by the OneLocBuild task in the build process to check-in localized files generated based upon translation source files (.lcl files) handed-back from the downstream localization pipeline. If there are issues in translations, visit https://aka.ms/icxLocBug and log bugs for fixes. The OneLocBuild wiki is https://aka.ms/onelocbuild and the localization process in general is documented at https://aka.ms/AllAboutLoc. --- src/Build/Resources/xlf/Strings.cs.xlf | 2 +- src/Build/Resources/xlf/Strings.de.xlf | 2 +- src/Build/Resources/xlf/Strings.es.xlf | 2 +- src/Build/Resources/xlf/Strings.fr.xlf | 2 +- src/Build/Resources/xlf/Strings.it.xlf | 2 +- src/Build/Resources/xlf/Strings.ja.xlf | 2 +- src/Build/Resources/xlf/Strings.ko.xlf | 2 +- src/Build/Resources/xlf/Strings.pl.xlf | 2 +- src/Build/Resources/xlf/Strings.pt-BR.xlf | 2 +- src/Build/Resources/xlf/Strings.ru.xlf | 2 +- src/Build/Resources/xlf/Strings.tr.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hans.xlf | 2 +- src/Build/Resources/xlf/Strings.zh-Hant.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.cs.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.de.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.es.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.fr.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.it.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.ja.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.ko.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.pl.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.pt-BR.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.ru.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.tr.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf | 2 +- src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf | 2 +- 26 files changed, 26 insertions(+), 26 deletions(-) diff --git a/src/Build/Resources/xlf/Strings.cs.xlf b/src/Build/Resources/xlf/Strings.cs.xlf index 72d6d7fda24..9ab02afe3bc 100644 --- a/src/Build/Resources/xlf/Strings.cs.xlf +++ b/src/Build/Resources/xlf/Strings.cs.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Nepodařilo se zkopírovat binární protokol z {0} do {1}. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.de.xlf b/src/Build/Resources/xlf/Strings.de.xlf index 2a77ed9ff61..5ce46079b62 100644 --- a/src/Build/Resources/xlf/Strings.de.xlf +++ b/src/Build/Resources/xlf/Strings.de.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Fehler beim Kopieren des Binärprotokolls von „{0}“ nach „{1}“. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.es.xlf b/src/Build/Resources/xlf/Strings.es.xlf index eb658d3565f..a72490d50a5 100644 --- a/src/Build/Resources/xlf/Strings.es.xlf +++ b/src/Build/Resources/xlf/Strings.es.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: no se pudo copiar el registro binario de "{0}" a "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.fr.xlf b/src/Build/Resources/xlf/Strings.fr.xlf index 25e3980f51b..9264bfb3118 100644 --- a/src/Build/Resources/xlf/Strings.fr.xlf +++ b/src/Build/Resources/xlf/Strings.fr.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: Échec de la copie du journal binaire de « {0} » vers « {1} ». {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.it.xlf b/src/Build/Resources/xlf/Strings.it.xlf index 239a9f429ce..c3a339f9aba 100644 --- a/src/Build/Resources/xlf/Strings.it.xlf +++ b/src/Build/Resources/xlf/Strings.it.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: non è possibile copiare il log binario da "{0}" a "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.ja.xlf b/src/Build/Resources/xlf/Strings.ja.xlf index 83ed22b46e0..bab87c64b11 100644 --- a/src/Build/Resources/xlf/Strings.ja.xlf +++ b/src/Build/Resources/xlf/Strings.ja.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: バイナリ ログを "{0}" から "{1}" にコピーできませんでした。{2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.ko.xlf b/src/Build/Resources/xlf/Strings.ko.xlf index fb99fabaddd..8fbaf0b2a79 100644 --- a/src/Build/Resources/xlf/Strings.ko.xlf +++ b/src/Build/Resources/xlf/Strings.ko.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: 이진 로그를 "{0}"에서 "{1}"(으)로 복사하지 못했습니다. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.pl.xlf b/src/Build/Resources/xlf/Strings.pl.xlf index a30525b6f35..5468c688eba 100644 --- a/src/Build/Resources/xlf/Strings.pl.xlf +++ b/src/Build/Resources/xlf/Strings.pl.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: nie można skopiować dziennika binarnego z „{0}” do „{1}”. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.pt-BR.xlf b/src/Build/Resources/xlf/Strings.pt-BR.xlf index dbbb7ef4630..f7957c45cda 100644 --- a/src/Build/Resources/xlf/Strings.pt-BR.xlf +++ b/src/Build/Resources/xlf/Strings.pt-BR.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: falha ao copiar o log binário de "{0}" para "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.ru.xlf b/src/Build/Resources/xlf/Strings.ru.xlf index 73a9a7142b6..4b309e0cc21 100644 --- a/src/Build/Resources/xlf/Strings.ru.xlf +++ b/src/Build/Resources/xlf/Strings.ru.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: не удалось скопировать двоичный журнал из "{0}" в "{1}". {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.tr.xlf b/src/Build/Resources/xlf/Strings.tr.xlf index 9e8bfab9b40..87f9b73cded 100644 --- a/src/Build/Resources/xlf/Strings.tr.xlf +++ b/src/Build/Resources/xlf/Strings.tr.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: İkili günlük dosyası "{0}" konumundan "{1}" konumuna kopyalanamadı. {2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.zh-Hans.xlf b/src/Build/Resources/xlf/Strings.zh-Hans.xlf index 347c0136d86..ad7d1118c48 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hans.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: 未能将二进制日志从“{0}”复制到“{1}”。{2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/Build/Resources/xlf/Strings.zh-Hant.xlf b/src/Build/Resources/xlf/Strings.zh-Hant.xlf index 3ccdd81d1c3..6a78af31da7 100644 --- a/src/Build/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/Build/Resources/xlf/Strings.zh-Hant.xlf @@ -491,7 +491,7 @@ MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} - MSB4279: Failed to copy binary log from "{0}" to "{1}". {2} + MSB4279: 無法將二進位記錄從 "{0}" 複製到 "{1}"。{2} {StrBegin="MSB4279: "}UE: This is shown when the Binary Logger fails to copy the log file to one of the specified output locations. diff --git a/src/MSBuild/Resources/xlf/Strings.cs.xlf b/src/MSBuild/Resources/xlf/Strings.cs.xlf index 4c5a6b3efa8..cad3fc6eb05 100644 --- a/src/MSBuild/Resources/xlf/Strings.cs.xlf +++ b/src/MSBuild/Resources/xlf/Strings.cs.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Byly zadány duplicitní cesty k binárnímu protokolu a byly ignorovány: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.de.xlf b/src/MSBuild/Resources/xlf/Strings.de.xlf index cadcfd4dd48..fca8fc2834d 100644 --- a/src/MSBuild/Resources/xlf/Strings.de.xlf +++ b/src/MSBuild/Resources/xlf/Strings.de.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Doppelte Binärprotokollpfade angegeben und ignoriert: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.es.xlf b/src/MSBuild/Resources/xlf/Strings.es.xlf index cf14afb978a..fe48c3cf45a 100644 --- a/src/MSBuild/Resources/xlf/Strings.es.xlf +++ b/src/MSBuild/Resources/xlf/Strings.es.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Rutas de registro binarias duplicadas especificadas y omitidas: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.fr.xlf b/src/MSBuild/Resources/xlf/Strings.fr.xlf index 96f4aa0130a..73ce96c92ac 100644 --- a/src/MSBuild/Resources/xlf/Strings.fr.xlf +++ b/src/MSBuild/Resources/xlf/Strings.fr.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Chemins d'accès aux journaux binaires en double spécifiés et ignorés : {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.it.xlf b/src/MSBuild/Resources/xlf/Strings.it.xlf index 0c7056c3663..fe5856f2833 100644 --- a/src/MSBuild/Resources/xlf/Strings.it.xlf +++ b/src/MSBuild/Resources/xlf/Strings.it.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Percorsi di log binari duplicati specificati e ignorati: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.ja.xlf b/src/MSBuild/Resources/xlf/Strings.ja.xlf index 3c818d6fbb2..3fc1d859eb9 100644 --- a/src/MSBuild/Resources/xlf/Strings.ja.xlf +++ b/src/MSBuild/Resources/xlf/Strings.ja.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + 重複するバイナリ ログ パスが指定され、次は無視されました: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.ko.xlf b/src/MSBuild/Resources/xlf/Strings.ko.xlf index 411c1d95294..b6072a3a172 100644 --- a/src/MSBuild/Resources/xlf/Strings.ko.xlf +++ b/src/MSBuild/Resources/xlf/Strings.ko.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + 중복된 이진 로그 경로가 지정되어 무시되었습니다. {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.pl.xlf b/src/MSBuild/Resources/xlf/Strings.pl.xlf index 5ce6bbfc336..34ede42319a 100644 --- a/src/MSBuild/Resources/xlf/Strings.pl.xlf +++ b/src/MSBuild/Resources/xlf/Strings.pl.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Określono i zignorowano zduplikowane ścieżki dziennika binarnego: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf b/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf index 1bcf3e21a22..b374cae1bf0 100644 --- a/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf +++ b/src/MSBuild/Resources/xlf/Strings.pt-BR.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Caminhos de log binários duplicados especificados e ignorados: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.ru.xlf b/src/MSBuild/Resources/xlf/Strings.ru.xlf index 4d1ae14ff24..085e46cc012 100644 --- a/src/MSBuild/Resources/xlf/Strings.ru.xlf +++ b/src/MSBuild/Resources/xlf/Strings.ru.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Указаны повторяющиеся пути к двоичным журналам, которые были проигнорированы: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.tr.xlf b/src/MSBuild/Resources/xlf/Strings.tr.xlf index 3b8cdeb76ff..ff6572fe72e 100644 --- a/src/MSBuild/Resources/xlf/Strings.tr.xlf +++ b/src/MSBuild/Resources/xlf/Strings.tr.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + Belirtilen ve yok sayılan yinelenen ikili günlük yolları: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf b/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf index 11864fab049..57e7970ea2f 100644 --- a/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf +++ b/src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + 指定且忽略的重复二进制日志路径: {0} {0} is the list of duplicate paths that were filtered out diff --git a/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf b/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf index 3148a590c4d..786223d5a6c 100644 --- a/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf +++ b/src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf @@ -35,7 +35,7 @@ Duplicate binary log path(s) specified and ignored: {0} - Duplicate binary log path(s) specified and ignored: {0} + 指定了重複的二進位記錄路徑，並已忽略: {0} {0} is the list of duplicate paths that were filtered out