Skip to content

Recognize AbsolutePath.Value canonicalization in task analyzers - #14970

Merged
ViktorHofer merged 2 commits into
mainfrom
janprovaznik-taskanalyzer-arcade-investigation
Sep 8, 2026
Merged

ViktorHofer merged 2 commits into
mainfrom
janprovaznik-taskanalyzer-arcade-investigation

Conversation

@JanProvaznik

Copy link
Copy Markdown
Member

Fixes #14955

Context

Path.GetFullPath(absolutePath.Value) canonicalizes an already fully qualified value; it does not resolve a relative path against the process working directory. This is the underlying BCL operation used by MSBuild itself. AbsolutePath.GetCanonicalForm() returns:

return new AbsolutePath(System.IO.Path.GetFullPath(Value), OriginalValue, ignoreRootedCheck: true);

The analyzer already accepts native GetCanonicalForm() results through their AbsolutePath type. However, writing the normalization directly in a task produces MSBuildTask0002, and writing it in a source polyfill/helper produces MSBuildTask0005. This prevents downlevel consumers such as Arcade from implementing the operation without suppression.

The exception belongs at Path.GetFullPath(AbsolutePath.Value), not at a helper named GetCanonicalForm.

Changes Made

  • Share recognition of the one-argument BCL Path.GetFullPath call over the resolved Microsoft.Build.Framework.AbsolutePath instance string Value property between direct and transitive analysis.
  • Preserve the normalized result's absolute-path proof for MSBuildTask0003 consumers.
  • Resolve BCL Path through the intrinsic string type's assembly, rejecting source-defined and aliased-metadata lookalikes rather than comparing display names.
  • Cover both scopes, identity casts, nullable path access, aliases/named arguments, extension/static helper calls, and downstream I/O.
  • Keep diagnostics for OriginalValue, unrelated Value properties, unproven/reassigned strings, transformed inputs, and other overloads. No helper name whitelist or general-purpose dataflow exemption is added.
  • Document the narrow exception.

Testing

Built TaskAnalyzer.Tests.csproj and ran MultiThreadableTaskAnalyzerTests, TransitiveCallChainAnalyzerTests, and MultiThreadableTaskCodeFixProviderTests: 143 passed, zero failed or skipped.

Used Arcade as the real-project reproduction at f1ce2c65fd8036c495df221b7257e2680e15b4a2, retaining its Framework/Utilities 18.8.2 references and existing multithreadable_only configuration. Rebuilt the actual Templating project using isolated variants of GenerateFileFromTemplate, with I/O rooted and retained as AbsolutePath. A compile-item overlay kept the original Arcade snapshot unchanged.

Real Arcade task variant Before After
Direct Path.GetFullPath(outputPath.Value) One MSBuildTask0002 No TaskAnalyzer diagnostics
Same operation inside GetCanonicalForm extension One MSBuildTask0005 No TaskAnalyzer diagnostics

No suppressions or broad-scope overrides were used. Compiler logs confirm the 18.8.2 references and the locally built analyzer. Both variants were rebuilt after tightening BCL symbol identity.

Notes

  • Red-team review found the initial type-name comparison could accept a user-defined System.IO.Path. This was fixed and covered for source and referenced lookalikes; the follow-up review found no remaining actionable or blocking issues.
  • This only removes false positives under the existing AbsolutePath contract. It adds no runtime/API changes, diagnostic IDs, or severity changes, so no ChangeWave is needed.
  • This is not a blanket Arcade migration or a promise of exact runtime parity for every downlevel polyfill. Older-host rooting behavior (fixed separately by Fix AbsolutePath.GetCanonicalForm process state leak on Windows  #13788) and preservation of OriginalValue remain separate compatibility concerns. No Arcade production changes are included.

Accept the same Path.GetFullPath sink used by AbsolutePath.GetCanonicalForm in direct and transitive task analysis, while retaining diagnostics for unproven inputs and lookalike APIs.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI lite review requested due to automatic review settings September 7, 2026 16:55

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The change is narrowly scoped, well-documented, and covered by targeted tests across both direct and transitive analyzer paths.

Pull request overview

This PR updates the MSBuild task analyzers to recognize the specific canonicalization pattern Path.GetFullPath(absolutePath.Value) as equivalent to AbsolutePath.GetCanonicalForm() behavior, avoiding false positives in both direct (MSBuildTask0002) and transitive (MSBuildTask0005) analysis while still treating the resulting string as absolute for MSBuildTask0003.

Changes:

  • Add a narrowly-scoped exemption for Path.GetFullPath(AbsolutePath.Value) in both MultiThreadableTaskAnalyzer and TransitiveCallChainAnalyzer.
  • Teach the absolute-path proof logic (MSBuildTask0003) that this exact canonicalization yields a safe absolute string.
  • Document the exception and add unit tests covering safe/unsafe inputs and “lookalike” System.IO.Path scenarios.
File summaries
File Description
src/TaskAnalyzer/TransitiveCallChainAnalyzer.cs Skips recording a banned-API violation when the invocation matches the AbsolutePath canonicalization pattern.
src/TaskAnalyzer/SharedAnalyzerHelpers.cs Introduces IsAbsolutePathCanonicalization and uses it to treat the canonicalization result as safely absolute.
src/TaskAnalyzer/README.md Documents the new narrow canonicalization exception and its boundaries.
src/TaskAnalyzer/MultiThreadableTaskAnalyzer.cs Avoids reporting MSBuildTask0002/0004 for the canonicalization call when it matches the approved pattern.
src/TaskAnalyzer.Tests/TransitiveCallChainAnalyzerTests.cs Adds coverage ensuring polyfills/helpers performing canonicalization don’t trigger diagnostics and unsafe variants still do.
src/TaskAnalyzer.Tests/MultiThreadableTaskAnalyzerTests.cs Adds direct analyzer coverage for canonicalization, unsafe variants, and “lookalike Path” negative cases.
Review details
  • Files reviewed: 6/6 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

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

Copy link
Copy Markdown
Member

I'm gonna merge this in so that I can consume an updated analyzer in arcade soon.

@ViktorHofer
ViktorHofer merged commit f5675f0 into main Sep 8, 2026
14 checks passed
@ViktorHofer
ViktorHofer deleted the janprovaznik-taskanalyzer-arcade-investigation branch September 8, 2026 10:09
This was referenced Nov 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Verify that the task analyzer understands and recommends the AbsolutePath.GetCanonicalForm API

3 participants