Fix unhandled exception in /getItem and /getTargetResult for items with illegal path characters by Copilot · Pull Request #12841 · dotnet/msbuild

Copilot · 2025-11-27T13:52:43Z

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

<issue_title>[Unhandled Exception]: /getItem and /getTargetResult fail for target GetCompileCommands</issue_title>
<issue_description>### 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

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 [Unhandled Exception]: /getItem and /getTargetResult fail for target GetCompileCommands #12589

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…egal path characters Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>

…ilt-in modifier' Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>

JanProvaznik · 2025-11-27T14:28:20Z

PS C:\Users\janprovaznik\Downloads\tidytest> D:\msbuilds\msb9\artifacts\bin\bootstrap\net472\MSBuild\Current\Bin\amd64\MSBuild.exe tidytest.vcxproj /t:GetCompileCommands /getItem:CompileCommands
{
  "Items": {
    "CompileCommands": [
      {
        "Identity": "/c /nologo /W3 /WX- /diagnostics:column /Od /Oy- /D WIN32 /D _DEBUG /D _CONSOLE /D _UNICODE /D UNICODE /EHsc /RTC1 /MDd /GS /fp:precise /permissive- /Fa\u0022tidytest\\Debug\\\\\u0022 /Fo\u0022tidytest\\Debug\\\\\u0022 /Gd --target=i686-pc-windows-msvc   /TP",
        "WorkingDirectory": "C:\\Users\\janprovaznik\\Downloads\\tidytest",
        "Files": "C:\\Users\\janprovaznik\\Downloads\\tidytest\\main.cpp",
        "ToolPath": "C:\\Windows\\system32\\CL.exe",
        "FullPath": "",
        "RootDir": "",
        "Filename": "",
        "Extension": "",
        "RelativeDir": "",
        "Directory": "",
        "RecursiveDir": "",
        "ModifiedTime": "",
        "CreatedTime": "",
        "AccessedTime": "",
        "DefiningProjectFullPath": "C:\\Program Files\\Microsoft Visual Studio\\2022\\Enterprise\\Msbuild\\Microsoft\\VC\\v170\\Microsoft.Cpp.ClangTidy.targets",
        "DefiningProjectDirectory": "C:\\Program Files\\Microsoft Visual Studio\\2022\\Enterprise\\Msbuild\\Microsoft\\VC\\v170\\",
        "DefiningProjectName": "Microsoft.Cpp.ClangTidy",
        "DefiningProjectExtension": ".targets"
      }
    ]
  }
}
PS C:\Users\janprovaznik\Downloads\tidytest> D:\msbuilds\msb9\artifacts\bin\bootstrap\net472\MSBuild\Current\Bin\amd64\MSBuild.exe tidytest.vcxproj /t:GetCompileCommands /getTargetResult:GetCompileCommands
{
  "TargetResults": {
    "GetCompileCommands": {
      "Result": "Success",
      "Items": [
        {
          "Identity": "/c /nologo /W3 /WX- /diagnostics:column /Od /Oy- /D WIN32 /D _DEBUG /D _CONSOLE /D _UNICODE /D UNICODE /EHsc /RTC1 /MDd /GS /fp:precise /permissive- /Fa\u0022tidytest\\Debug\\\\\u0022 /Fo\u0022tidytest\\Debug\\\\\u0022 /Gd --target=i686-pc-windows-msvc   /TP",
          "WorkingDirectory": "C:\\Users\\janprovaznik\\Downloads\\tidytest",
          "Files": "C:\\Users\\janprovaznik\\Downloads\\tidytest\\main.cpp",
          "ToolPath": "C:\\Windows\\system32\\CL.exe",
          "FullPath": "",
          "RootDir": "",
          "Filename": "",
          "Extension": "",
          "RelativeDir": "",
          "Directory": "",
          "RecursiveDir": "",
          "ModifiedTime": "",
          "CreatedTime": "",
          "AccessedTime": "",
          "DefiningProjectFullPath": "C:\\Program Files\\Microsoft Visual Studio\\2022\\Enterprise\\Msbuild\\Microsoft\\VC\\v170\\Microsoft.Cpp.ClangTidy.targets",
          "DefiningProjectDirectory": "C:\\Program Files\\Microsoft Visual Studio\\2022\\Enterprise\\Msbuild\\Microsoft\\VC\\v170\\",
          "DefiningProjectName": "Microsoft.Cpp.ClangTidy",
          "DefiningProjectExtension": ".targets"
        }
      ]
    }
  }
}

the command output from original issue makes sense

JanProvaznik

lgtm

Copilot

Pull request overview

This PR fixes an unhandled exception that occurs when using /getItem or /getTargetResult with items whose specs contain illegal path characters, such as compiler command-line flags from ClangTidy's GetCompileCommands target.

Key Changes

Added exception handling for InvalidOperationException when retrieving metadata that requires path computation
Created three helper methods (TryGetMetadata and two TryGetMetadataValue overloads) to safely retrieve metadata
Added regression test to verify the fix works for both /getItem and /getTargetResult switches

Reviewed changes

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

File	Description
src/MSBuild/JsonOutputFormatter.cs	Added exception handling in metadata retrieval to prevent crashes when item specs contain illegal path characters; added three helper methods to safely get metadata values
src/MSBuild.UnitTests/XMake_Tests.cs	Added regression test that verifies both `/getItem` and `/getTargetResult` work correctly with items containing compiler flags as item specs

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

src/MSBuild/JsonOutputFormatter.cs

…mmands

src/MSBuild/JsonOutputFormatter.cs

Co-authored-by: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com>

Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>

Initial plan

e82dcbb

Copilot AI assigned Copilot and JanProvaznik Nov 27, 2025

Copilot started work on behalf of JanProvaznik November 27, 2025 13:53 View session

Copilot AI and others added 2 commits November 27, 2025 14:04

Fix unhandled exception in getItem/getTargetResult for items with ill…

067b446

…egal path characters Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>

Fix documentation terminology: use 'built-in metadata' instead of 'bu…

1c9d0b6

…ilt-in modifier' Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Fix unhandled exception for GetCompileCommands target~~ Fix unhandled exception in /getItem and /getTargetResult for items with illegal path characters Nov 27, 2025

Copilot AI requested a review from JanProvaznik November 27, 2025 14:12

Copilot finished work on behalf of JanProvaznik November 27, 2025 14:12

JanProvaznik approved these changes Nov 27, 2025

View reviewed changes

JanProvaznik marked this pull request as ready for review December 1, 2025 10:29

Copilot AI review requested due to automatic review settings December 1, 2025 10:29

Copilot started reviewing on behalf of JanProvaznik December 1, 2025 10:29 View session

Copilot finished reviewing on behalf of JanProvaznik December 1, 2025 10:32

Copilot AI reviewed Dec 1, 2025

View reviewed changes

src/MSBuild/JsonOutputFormatter.cs Show resolved Hide resolved

baronfel added the bug label Dec 15, 2025

Merge branch 'main' into copilot/fix-unhandled-exception-getcompileco…

33782d5

…mmands

YuliiaKovalova reviewed Jan 5, 2026

View reviewed changes

src/MSBuild/JsonOutputFormatter.cs Show resolved Hide resolved

Copilot started work on behalf of YuliiaKovalova January 5, 2026 12:36 View session

Make exception handling more specific with exception filter

b2caa37

Co-authored-by: YuliiaKovalova <95473390+YuliiaKovalova@users.noreply.github.com>

Copilot finished work on behalf of YuliiaKovalova January 5, 2026 12:44

Copilot AI requested a review from YuliiaKovalova January 5, 2026 12:44

YuliiaKovalova approved these changes Jan 5, 2026

View reviewed changes

Copilot started work on behalf of JanProvaznik January 5, 2026 12:52 View session

Revert exception filter to support all locales

d23469c

Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>

Copilot AI requested a review from JanProvaznik January 5, 2026 12:58

Copilot finished work on behalf of JanProvaznik January 5, 2026 12:58

JanProvaznik enabled auto-merge (squash) January 5, 2026 13:22

JanProvaznik approved these changes Jan 5, 2026

View reviewed changes

JanProvaznik merged commit 49a6fd4 into main Jan 5, 2026
10 checks passed

JanProvaznik deleted the copilot/fix-unhandled-exception-getcompilecommands branch January 5, 2026 14:12

This was referenced Jan 6, 2026

[main] Source code updates from dotnet/msbuild dotnet/dotnet#3987

Merged

[release/10.0.2xx] Source code updates from dotnet/msbuild dotnet/dotnet#4054

Merged

dotnet-maestro bot mentioned this pull request Feb 12, 2026

[release/10.0.2xx] Source code updates from dotnet/msbuild dotnet/dotnet#4825

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix unhandled exception in /getItem and /getTargetResult for items with illegal path characters#12841

Fix unhandled exception in /getItem and /getTargetResult for items with illegal path characters#12841
JanProvaznik merged 6 commits intomainfrom
copilot/fix-unhandled-exception-getcompilecommands

Copilot AI commented Nov 27, 2025 •

edited

Loading

Uh oh!

JanProvaznik commented Nov 27, 2025 •

edited

Loading

Uh oh!

JanProvaznik left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

Copilot AI commented Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Changes Made

Testing

Notes

Steps to Reproduce

Actual Behavior

Analysis

Versions & Co...

Uh oh!

JanProvaznik commented Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JanProvaznik left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Nov 27, 2025 •

edited

Loading

JanProvaznik commented Nov 27, 2025 •

edited

Loading