Allow class types in DangerousIdentityKey (#2036)

palantir · Jan 13, 2022 · ad9a16e · ad9a16e
1 parent eba4ba3
commit ad9a16e
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/...line-error-prone/src/main/java/com/palantir/baseline/errorprone/DangerousIdentityKey.java b/...line-error-prone/src/main/java/com/palantir/baseline/errorprone/DangerousIdentityKey.java
@@ -22,6 +22,7 @@
 import com.google.errorprone.BugPattern.SeverityLevel;
 import com.google.errorprone.VisitorState;
 import com.google.errorprone.bugpatterns.BugChecker;
+import com.google.errorprone.util.ASTHelpers;
 import com.sun.tools.javac.code.Symbol.MethodSymbol;
 import com.sun.tools.javac.code.Type;
 import com.sun.tools.javac.code.Types;
@@ -42,10 +43,20 @@ public final class DangerousIdentityKey extends MoreAbstractAsKeyOfSetOrMap {
 
     @Override
     protected boolean isBadType(Type type, VisitorState state) {
-        // Only flag final types, otherwise we'll encounter false positives when presented with overrides.
-        if (type == null || !type.isFinal()) {
+        if (type == null) {
             return false;
         }
+
+        // Ignore non-final types, otherwise we'll encounter false positives when presented with overrides.
+        if (!type.isFinal()) {
+            return false;
+        }
+
+        // Ignore class types
+        if (ASTHelpers.isSameType(type, state.getSymtab().classType, state)) {
+            return false;
+        }
+
         return !implementsMethod(state.getTypes(), type, state.getNames().equals, state)
                 || !implementsMethod(state.getTypes(), type, state.getNames().hashCode, state);
     }

diff --git a/...-error-prone/src/test/java/com/palantir/baseline/errorprone/DangerousIdentityKeyTest.java b/...-error-prone/src/test/java/com/palantir/baseline/errorprone/DangerousIdentityKeyTest.java
@@ -122,6 +122,20 @@ public void testValidEnum() {
                 .doTest();
     }
 
+    @Test
+    public void testValidClass() {
+        compilationHelper
+                .addSourceLines(
+                        "Test.java",
+                        "import java.util.*;",
+                        "class Test {",
+                        "    private Object test() {",
+                        "        return new HashSet<Class<String>>();",
+                        "    }",
+                        "}")
+                .doTest();
+    }
+
     @Test
     public void testInvalidNoEquals() {
         compilationHelper

diff --git a/changelog/@unreleased/pr-2036.v2.yml b/changelog/@unreleased/pr-2036.v2.yml
@@ -0,0 +1,6 @@
+type: fix
+fix:
+  description: '`DangerousIdentityKey` now allows `Class` to be used as a map or set
+    key.'
+  links:
+  - https://github.com/palantir/gradle-baseline/pull/2036