Skip to content

Anchor MSBuildTask0003 code fix on the flagged call and withhold it where TaskEnvironment cannot bind - #14810

Merged
ViktorHofer merged 8 commits into
mainfrom
copilot/fix-msbuildtask0003-code
Aug 26, 2026
Merged

ViktorHofer merged 8 commits into
mainfrom
copilot/fix-msbuildtask0003-code

Conversation

Copilot AI commented Aug 24, 2026 •

Copy link
Copy Markdown
Contributor

Context

MultiThreadableTaskCodeFixProvider emitted non-compiling code for the MSBuildTask0003 fix ("Wrap with TaskEnvironment.GetAbsolutePath()") in two shapes: nested calls got the outer call's argument wrapped (CS1503), and static contexts got a reference to the instance TaskEnvironment property (CS0120).

The root cause of the first is span aliasing. An ArgumentSyntax and its child expression share a TextSpan, so root.FindNode(span) returns the enclosing argument when the flagged call is nested; FindContainingCall's ancestor walk then climbed to the enclosing call:

// analyzer flags File.Create(OutputPath); fix rewrote new StreamWriter(...)
new StreamWriter(TaskEnvironment.GetAbsolutePath(File.Create(OutputPath)))  // CS1503

This matters at scale — the provider registers BatchFixAllProvider, so bulk application via dotnet format analyzers is the intended workflow, and breakage only surfaces on the next compile.

Changes Made

  • Anchoring — use FindNode(span, getInnermostNodeForTie: true) and drop the ancestor walk. The analyzer always reports on context.Operation.Syntax, so the fix now rewrites exactly the call that was flagged. FindContainingCall is deleted. The MSBuildTask0002 path had the same defect (AncestorsAndSelf().OfType<InvocationExpressionSyntax>()) and is corrected the same way.
  • Argument selection — FindPathArgument resolves the flagged argument through the semantic model, reusing the analyzer's own IsPathParameterName / IsWrappedSafely helpers so fixer and analyzer cannot disagree. This also corrects named-argument ordering (Directory.GetFiles(searchPattern:, path:) no longer wraps the pattern). A syntactic fallback preserves prior behavior when no operation is available.
  • Withholding — a single CanReferenceTaskEnvironment guard covers every way the generated reference could fail to bind, applied to both the 0002 and 0003 fixers since both emit it.

Two adjacent instances of the same defect surfaced while building that guard and are covered:

  • Instance field/property initializers — this isn't usable there (CS0236), including inside a lambda declared in the initializer.
  • Tasks with no TaskEnvironment member — the default all scope analyzes every ITask, but Microsoft.Build.Utilities.Task implements only ITask; the member lives on IMultiThreadableTask/ToolTask. The fix previously emitted CS0103 on ordinary tasks, likely the most common broken shape at scale. Mirrors the existing PreferTypedParameterCodeFixProvider.HasAccessibleTaskEnvironment precedent.

Testing

16 new code-fix tests covering nested object creation and invocation, implicit object creation, named non-path arguments, static method / local function / lambda, lambda in an instance method (still fixed), property initializer, plain task without the member, MSBuildTask0002 in a static method, and a mixed FixAll test mirroring the issue's repro. Microsoft.CodeAnalysis.Testing validates compiler diagnostics on the fixed state, so these assert the emitted code compiles.

End-to-end against the built analyzer, dotnet format analyzers --diagnostics MSBuildTask0003 on the issue's repro now produces its "Expected output" and the rebuild reports 0 errors, down from 3× CS1503 + CS0120.

Notes

Worth knowing before bulk-migrating: dotnet format analyzers derives its FixAll equivalence key from the first reported diagnostic, and Roslyn's BatchFixAllProvider only matches actions whose key is non-null and equal to it. If that first occurrence is one where no fix is offered, the tool logs Unable to fix MSBuildTask0003… and applies nothing. Withholding still seems right — it is what the issue asks for, and PreferTypedParameterCodeFixProvider is already conservative by design — but the caveat and its workaround are now in src/TaskAnalyzer/README.md.

A consequence worth reviewer attention: the fix is no longer offered inside [MSBuildMultiThreadableTaskAnalyzed] helper classes unless the helper itself declares a TaskEnvironment member. That is strictly better than emitting CS0103, but it narrows what that attribute buys you, so the README wording there was adjusted.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Hello @copilot, I noticed that you’re changing an .swr file or any file under src/Package/MSBuild.VSSetup.. Please make sure to validate this change by an experimental VS insertion. This is accomplished by pushing to an exp/* branch, which requires write permissions to this repo.

Copilot AI and others added 4 commits August 24, 2026 06:54
Co-authored-by: ViktorHofer <7412651+ViktorHofer@users.noreply.github.com>
Co-authored-by: ViktorHofer <7412651+ViktorHofer@users.noreply.github.com>
Co-authored-by: ViktorHofer <7412651+ViktorHofer@users.noreply.github.com>
Co-authored-by: ViktorHofer <7412651+ViktorHofer@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix MSBuildTask0003 code fix for nested calls and static methods Anchor MSBuildTask0003 code fix on the flagged call and withhold it where TaskEnvironment cannot bind Aug 24, 2026
Copilot AI requested a review from ViktorHofer August 24, 2026 07:26
@ViktorHofer
ViktorHofer marked this pull request as ready for review August 24, 2026 08:53
Copilot AI lite review requested due to automatic review settings August 24, 2026 08:53
@ViktorHofer
ViktorHofer requested a review from VolPlita August 24, 2026 08:57

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.

Pull request overview

This pull request updates the TaskAnalyzer code fix provider for MSBuildTask0002/MSBuildTask0003 so fixes are applied to the exact flagged call/argument and are withheld in contexts where TaskEnvironment cannot be referenced, and expands the test suite and documentation to cover these scenarios.

Changes:

  • Anchor the code fix on the analyzer-reported syntax node (FindNode(..., getInnermostNodeForTie: true)) and semantically select the correct “path” argument to wrap.
  • Add guarding to withhold MSBuildTask0002/0003 fixes when referencing the instance TaskEnvironment member would not compile.
  • Add targeted code-fix tests and update TaskAnalyzer README guidance (including FixAll caveats).
Show a summary per file
File Description
src/TaskAnalyzer/MultiThreadableTaskCodeFixProvider.cs Re-anchors and refines MSBuildTask0002/0003 code-fix selection and adds TaskEnvironment reference guards.
src/TaskAnalyzer.Tests/MultiThreadableTaskCodeFixProviderTests.cs Adds new coverage for nested calls, named arguments, static contexts, missing TaskEnvironment, and FixAll behavior.
src/TaskAnalyzer/README.md Documents the anchoring behavior, fix withholding rules, and dotnet format analyzers FixAll limitations/workarounds.

Review details

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

  • Files reviewed: 3/3 changed files
  • Comments generated: 1
  • Review effort level: Lite

Co-authored-by: ViktorHofer <7412651+ViktorHofer@users.noreply.github.com>

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.

Review details

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

src/TaskAnalyzer/MultiThreadableTaskCodeFixProvider.cs:186

  • Checking only for any field/property with this name does not prove that the generated receiver will bind or have the required API. For an attributed helper, an inaccessible inherited TaskEnvironment, a write-only/wrongly typed member, or a local/parameter that shadows a valid member makes the offered fix emit non-compiling code. Resolve the exact receiver at node.SpanStart (or generate this.TaskEnvironment) and require an accessible readable member of the framework TaskEnvironment type before registering the fix.
                foreach (var member in current.GetMembers("TaskEnvironment"))
                {
                    if (member is IPropertySymbol or IFieldSymbol)
                    {
                        return true;
  • Files reviewed: 3/3 changed files
  • Comments generated: 1
  • Review effort level: Balanced

Co-authored-by: ViktorHofer <7412651+ViktorHofer@users.noreply.github.com>
Copilot AI requested a review from ViktorHofer August 24, 2026 09:37
@ViktorHofer
ViktorHofer requested a balanced review from Copilot August 24, 2026 10:09
This was referenced Nov 17, 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.

TaskAnalyzer: MSBuildTask0003 code fix produces non-compiling code for nested calls and static methods

6 participants