Add VSSDK009 analyzer to flag non-UI thread related VsTaskRunContext arguments#390
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces a new Roslyn analyzer (VSSDK009) to prevent passing non-UI-thread-related VsTaskRunContext values into selected VsTaskLibraryHelper helpers, which can otherwise lead to ArgumentOutOfRangeException at runtime.
Changes:
- Added
VSSDK009UseUIThreadVsTaskRunContextAnalyzerto flag disallowedVsTaskRunContextarguments forStartOnIdle,RunAsync, andWithPriority. - Added unit tests covering flagged and non-flagged call patterns.
- Updated analyzer metadata and documentation (unshipped releases list, docs page, and docs index).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/Microsoft.VisualStudio.SDK.Analyzers.Tests/VSSDK009UseUIThreadVsTaskRunContextAnalyzerTests.cs | Adds unit tests for VSSDK009 diagnostics and non-diagnostics. |
| src/Microsoft.VisualStudio.SDK.Analyzers/VSSDK009UseUIThreadVsTaskRunContextAnalyzer.cs | Implements the VSSDK009 analyzer logic and diagnostic descriptor. |
| src/Microsoft.VisualStudio.SDK.Analyzers/Types.cs | Adds Types.VsTaskLibraryHelper / Types.VsTaskRunContext symbols used by the analyzer. |
| src/Microsoft.VisualStudio.SDK.Analyzers/AnalyzerReleases.Unshipped.md | Registers the new analyzer as unshipped. |
| doc/VSSDK009.md | Adds end-user documentation for VSSDK009 with examples and solution. |
| doc/index.md | Links VSSDK009 from the analyzer index. |
AArnott
force-pushed
the
dev/andarno/vssdk009-uicontext
branch
from
c254acd to
fa9b73e
Compare
davkean
approved these changes
Jun 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Passing a non-UI thread related
VsTaskRunContextto any of a few methods onVsTaskLibraryHelperleads to anArgumentOutOfRangeExceptionbeing thrown. Such a bug has been introduced to the product and merged multiple times.