Skip to content

Raise VSTHRD010 diagnostics transitively #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AArnott merged 2 commits into from
Feb 27, 2018
Merged

Raise VSTHRD010 diagnostics transitively #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01a8821
Raise VSTHRD010 diagnostics transitively
AArnott Feb 26, 2018
3d2f82f
Better discernment between property getters and setters
AArnott Feb 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 115 additions & 0 deletions ...Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,121 @@ void VerifyOnUIThread() {
this.VerifyCSharpDiagnostic(test, this.expect);
}

[Fact]
public void RequiresUIThreadTransitive()
{
var test = @"
using System;
using Microsoft.VisualStudio.Shell.Interop;

class Test {
void F() {
VerifyOnUIThread();
IVsSolution sln = null;
sln.SetProperty(1000, null);
}

void G() {
F();
}

void H() {
G();
}

int MainThreadGetter {
get {
H();
return 0;
}

set {
}
}

int MainThreadSetter {
get => 0;
set => H();
}

int CallMainThreadGetter_get() => MainThreadGetter; // Flagged
int CallMainThreadGetter_get2() => this.MainThreadGetter; // Flagged
int CallMainThreadGetter_get3() => ((Test)this).MainThreadGetter; // Flagged
int CallMainThreadGetter_set() => MainThreadGetter = 1;
int CallMainThreadGetter_set2() => this.MainThreadGetter = 1;

int CallMainThreadSetter_get() => MainThreadSetter;
int CallMainThreadSetter_get2() => this.MainThreadSetter;
int CallMainThreadSetter_set() => MainThreadSetter = 1; // Flagged
int CallMainThreadSetter_set2() => this.MainThreadSetter = 1; // Flagged
int CallMainThreadSetter_set3() => ((Test)this).MainThreadSetter = 1; // Flagged

// None of these should produce diagnostics since we're not invoking the members.
string NameOfFoo1() => nameof(MainThreadGetter);
string NameOfFoo2() => nameof(MainThreadSetter);
string NameOfThisFoo1() => nameof(this.MainThreadGetter);
string NameOfThisFoo2() => nameof(this.MainThreadSetter);
string NameOfH() => nameof(H);
Action GAsDelegate() => this.G;

void VerifyOnUIThread() {
}
}
";
DiagnosticResult CreateDiagnostic(int line, int column, int endLine, int endColumn) =>
new DiagnosticResult
{
Id = this.expect.Id,
Message = this.expect.Message,
SkipVerifyMessage = this.expect.SkipVerifyMessage,
Severity = this.expect.Severity,
Locations = new[] { new DiagnosticResultLocation("Test0.cs", line, column, endLine, endColumn) },
};
var expect = new DiagnosticResult[]
{
CreateDiagnostic(12, 10, 12, 11),
CreateDiagnostic(16, 10, 16, 11),
CreateDiagnostic(21, 9, 21, 12),
CreateDiagnostic(32, 9, 32, 12),
CreateDiagnostic(35, 9, 35, 33),
CreateDiagnostic(36, 9, 36, 34),
CreateDiagnostic(37, 9, 37, 34),
CreateDiagnostic(43, 9, 43, 33),
CreateDiagnostic(44, 9, 44, 34),
CreateDiagnostic(45, 9, 45, 34),
};
this.VerifyCSharpDiagnostic(test, expect);
}

[Fact]
public void RequiresUIThreadNotTransitiveIfNotExplicit()
{
var test = @"
using System;
using Microsoft.VisualStudio.Shell.Interop;

class Test {
void F() {
IVsSolution sln = null;
sln.SetProperty(1000, null);
}

void G() {
F();
}

void H() {
G();
}

void VerifyOnUIThread() {
}
}
";
this.expect.Locations = new[] { new DiagnosticResultLocation("Test0.cs", 8, 13, 8, 24) };
this.VerifyCSharpDiagnostic(test, this.expect);
}

[Fact]
public void InvokeVsSolutionAfterSwitchedToMainThreadAsync()
{
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.cs.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.de.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.es.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.fr.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.it.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.ja.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.ko.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.pl.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...ding.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.pt-BR.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.ru.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...reading.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.tr.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...ng.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.zh-Hans.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
5 changes: 5 additions & 0 deletions ...ng.Analyzers/MultilingualResources/Microsoft.VisualStudio.Threading.Analyzers.zh-Hant.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</source>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</note>
</trans-unit>
<trans-unit id="VSTHRD010_MessageFormat_TransitiveMainThreadUser" translate="yes" xml:space="preserve">
<source>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</source>
<target state="new">Add call to {0}() at start of member body because this member invokes other members that require the main thread.</target>
<note from="MultilingualBuild" annotates="source" priority="2">{0} is a method name.</note>
</trans-unit>
</group>
</body>
</file>
Expand Down
9 changes: 9 additions & 0 deletions src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions src/Microsoft.VisualStudio.Threading.Analyzers/Strings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,4 +257,8 @@ Use AsyncLazy&lt;T&gt; instead.</value>
Await JoinableTaskFactory.SwitchToMainThreadAsync() first.</value>
<comment>{0} is a type name and {1} is the name of a method that throws if not called from the main thread.</comment>
</data>
<data name="VSTHRD010_MessageFormat_TransitiveMainThreadUser" xml:space="preserve">
<value>Add call to {0}() at start of member body because this member invokes other members that require the main thread.</value>
<comment>{0} is a method name.</comment>
</data>
</root>
20 changes: 18 additions & 2 deletions src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,22 @@ internal static bool IsObsolete(this ISymbol symbol)
return symbol.GetAttributes().Any(a => a.AttributeClass.Name == nameof(ObsoleteAttribute) && a.AttributeClass.BelongsToNamespace(Namespaces.System));
}

internal static bool IsOnLeftHandOfAssignment(SyntaxNode syntaxNode)
{
SyntaxNode parent = null;
while ((parent = syntaxNode.Parent) != null)
{
if (parent is AssignmentExpressionSyntax assignment)
{
return assignment.Left == syntaxNode;
}

syntaxNode = parent;
}

return false;
}

internal static IEnumerable<ITypeSymbol> FindInterfacesImplemented(this ISymbol symbol)
{
if (symbol == null)
Expand Down Expand Up @@ -607,9 +623,9 @@ internal static NameSyntax QualifyName(IReadOnlyList<string> qualifiers, SimpleN
/// <summary>
/// Determines whether an expression appears inside a C# "nameof" pseudo-method.
/// </summary>
internal static bool IsWithinNameOf(ExpressionSyntax memberAccess)
internal static bool IsWithinNameOf(SyntaxNode syntaxNode)
{
var invocation = memberAccess?.FirstAncestorOrSelf<InvocationExpressionSyntax>();
var invocation = syntaxNode?.FirstAncestorOrSelf<InvocationExpressionSyntax>();
return (invocation?.Expression as IdentifierNameSyntax)?.Identifier.Text == "nameof"
&& invocation.ArgumentList.Arguments.Count == 1;
}
Expand Down
Loading