Skip to content
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

Add support in ErrorProne for a new ThreadSafeTypeParamerter annotation that is replacing ThreadSafe.TypeParameter. #4463

Merged
merged 1 commit into from
Jul 12, 2024
+31 −3
Merged

Add support in ErrorProne for a new ThreadSafeTypeParamerter annotation that is replacing ThreadSafe.TypeParameter. #4463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions core/src/main/java/com/google/errorprone/bugpatterns/threadsafety/ThreadSafeChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,10 @@ public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState

@Override
public Description matchNewClass(NewClassTree tree, VisitorState state) {
// check instantiations of `@ThreadSafe.TypeParameter`s in generic constructor invocations
// check instantiations of `@ThreadSafeTypeParameter`s in generic constructor invocations
checkInvocation(
tree, ((JCNewClass) tree).constructorType, state, ((JCNewClass) tree).constructor);
// check instantiations of `@ThreadSafe.TypeParameter`s in class constructor invocations
// check instantiations of `@ThreadSafeTypeParameter`s in class constructor invocations
ThreadSafeAnalysis analysis = new ThreadSafeAnalysis(this, state, wellKnownThreadSafety);
Violation info =
analysis.checkInstantiation(
Expand Down Expand Up @@ -137,6 +137,7 @@ public Description matchTypeParameter(TypeParameterTree tree, VisitorState state
ThreadSafeAnalysis analysis = new ThreadSafeAnalysis(this, state, wellKnownThreadSafety);
if (analysis.hasThreadSafeTypeParameterAnnotation((TypeVariableSymbol) sym)) {
if (analysis.getThreadSafeAnnotation(sym.owner, state) == null) {
// TODO: b/324092874 -- Update this message to use the new annotation name.
return buildDescription(tree)
.setMessage("@ThreadSafe.TypeParameter is only supported on threadsafe classes")
.build();
Expand Down Expand Up @@ -198,6 +199,7 @@ public Description matchClass(ClassTree tree, VisitorState state) {
.map(Entry::getKey)
.collect(toImmutableSet());
if (!threadSafeAndContainer.isEmpty()) {
// TODO: b/324092874 -- Update this message to use the new annotation name.
return buildDescription(tree)
.setMessage(
String.format(
Expand Down
28 changes: 27 additions & 1 deletion core/src/test/java/com/google/errorprone/bugpatterns/threadsafety/ThreadSafeCheckerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,14 @@
public class ThreadSafeCheckerTest {

private final CompilationTestHelper compilationHelper =
CompilationTestHelper.newInstance(ThreadSafeChecker.class, getClass());
CompilationTestHelper.newInstance(ThreadSafeChecker.class, getClass())
// TODO: b/339025111 - Remove this once ThreadSafeTypeParameter actually exists.
.addSourceLines(
"ThreadSafeTypeParameter.java",
"package com.google.errorprone.annotations;",
"@java.lang.annotation.Target(java.lang.annotation.ElementType.TYPE_PARAMETER)",
"@java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.RUNTIME)",
"public @interface ThreadSafeTypeParameter {}");

private final BugCheckerRefactoringTestHelper refactoringHelper =
BugCheckerRefactoringTestHelper.newInstance(ThreadSafeChecker.class, getClass());
Expand Down Expand Up @@ -1001,6 +1008,16 @@ public void knownThreadSafeFlag() {
.doTest();
}

// TODO: b/324092874 - Remove this test once ThreadSafe.TypeParameter is removed.

// TODO: b/324092874 - Remove this test once ThreadSafe.TypeParameter is removed.

// TODO: b/324092874 - Remove this test once ThreadSafe.TypeParameter is removed.

// TODO: b/324092874 - Remove this test once ThreadSafe.TypeParameter is removed.

// TODO: b/324092874 - Remove this test once ThreadSafe.TypeParameter is removed.

@Test
public void annotatedClassType() {
compilationHelper
Expand All @@ -1015,7 +1032,16 @@ public void annotatedClassType() {
.doTest();
}

// TODO: b/324092874 - Remove this test once ThreadSafe.TypeParameter is removed.

// Regression test for b/117937500
// TODO: b/324092874 - Remove this test once ThreadSafe.TypeParameter is removed.

// Regression test for b/117937500

// javac does not instantiate type variables when they are not used for target typing, so we
// cannot check whether their instantiations are thread-safe.
// TODO: b/324092874 - Remove this test once ThreadSafe.TypeParameter is removed.

// javac does not instantiate type variables when they are not used for target typing, so we
// cannot check whether their instantiations are thread-safe.
Expand Down
Loading