From e03d0de36631b41698395a2af286193a3bb61c2e Mon Sep 17 00:00:00 2001
From: Philip Leonard <phillyleonard@gmail.com>
Date: Mon, 31 Jul 2023 17:19:39 +0200
Subject: [PATCH] Introduce `MongoDBTextFilterUsage` check (#649)

---
 error-prone-contrib/pom.xml                   |  5 ++
 .../bugpatterns/MongoDBTextFilterUsage.java   | 47 +++++++++++++++++++
 .../MongoDBTextFilterUsageTest.java           | 26 ++++++++++
 pom.xml                                       | 13 +++++
 4 files changed, 91 insertions(+)
 create mode 100644 error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MongoDBTextFilterUsage.java
 create mode 100644 error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/MongoDBTextFilterUsageTest.java

diff --git a/error-prone-contrib/pom.xml b/error-prone-contrib/pom.xml
index 18dd0e6d78..75a31b47b3 100644
--- a/error-prone-contrib/pom.xml
+++ b/error-prone-contrib/pom.xml
@@ -176,6 +176,11 @@
             <artifactId>mockito-core</artifactId>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>org.mongodb</groupId>
+            <artifactId>mongodb-driver-core</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.reactivestreams</groupId>
             <artifactId>reactive-streams</artifactId>
diff --git a/error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MongoDBTextFilterUsage.java b/error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MongoDBTextFilterUsage.java
new file mode 100644
index 0000000000..77208f673e
--- /dev/null
+++ b/error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MongoDBTextFilterUsage.java
@@ -0,0 +1,47 @@
+package tech.picnic.errorprone.bugpatterns;
+
+import static com.google.errorprone.BugPattern.LinkType.CUSTOM;
+import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION;
+import static com.google.errorprone.BugPattern.StandardTags.PERFORMANCE;
+import static com.google.errorprone.matchers.method.MethodMatchers.staticMethod;
+import static tech.picnic.errorprone.bugpatterns.util.Documentation.BUG_PATTERNS_BASE_URL;
+
+import com.google.auto.service.AutoService;
+import com.google.errorprone.BugPattern;
+import com.google.errorprone.VisitorState;
+import com.google.errorprone.bugpatterns.BugChecker;
+import com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher;
+import com.google.errorprone.matchers.Description;
+import com.google.errorprone.matchers.Matcher;
+import com.sun.source.tree.ExpressionTree;
+import com.sun.source.tree.MethodInvocationTree;
+
+/**
+ * A {@link BugChecker} that flags usages of MongoDB {@code $text} filter usages.
+ *
+ * @see <a href="https://www.mongodb.com/docs/manual/text-search/">MongoDB Text Search</a>
+ */
+@AutoService(BugChecker.class)
+@BugPattern(
+    summary =
+        "Avoid MongoDB's `$text` filter operator, as it can trigger heavy queries and even cause the server to run out of memory",
+    link = BUG_PATTERNS_BASE_URL + "MongoDBTextFilterUsage",
+    linkType = CUSTOM,
+    severity = SUGGESTION,
+    tags = PERFORMANCE)
+public final class MongoDBTextFilterUsage extends BugChecker
+    implements MethodInvocationTreeMatcher {
+  private static final long serialVersionUID = 1L;
+  private static final Matcher<ExpressionTree> MONGO_FILTERS_TEXT_METHOD =
+      staticMethod().onClass("com.mongodb.client.model.Filters").named("text");
+
+  /** Instantiates a new {@link MongoDBTextFilterUsage} instance. */
+  public MongoDBTextFilterUsage() {}
+
+  @Override
+  public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) {
+    return MONGO_FILTERS_TEXT_METHOD.matches(tree, state)
+        ? describeMatch(tree)
+        : Description.NO_MATCH;
+  }
+}
diff --git a/error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/MongoDBTextFilterUsageTest.java b/error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/MongoDBTextFilterUsageTest.java
new file mode 100644
index 0000000000..ea9ca288a8
--- /dev/null
+++ b/error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/MongoDBTextFilterUsageTest.java
@@ -0,0 +1,26 @@
+package tech.picnic.errorprone.bugpatterns;
+
+import com.google.errorprone.CompilationTestHelper;
+import org.junit.jupiter.api.Test;
+
+final class MongoDBTextFilterUsageTest {
+  @Test
+  void identification() {
+    CompilationTestHelper.newInstance(MongoDBTextFilterUsage.class, getClass())
+        .addSourceLines(
+            "A.java",
+            "import com.mongodb.client.model.Filters;",
+            "import com.mongodb.client.model.TextSearchOptions;",
+            "",
+            "class A {",
+            "  void m() {",
+            "    Filters.eq(\"foo\", \"bar\");",
+            "    // BUG: Diagnostic contains:",
+            "    Filters.text(\"foo\");",
+            "    // BUG: Diagnostic contains:",
+            "    Filters.text(\"foo\", new TextSearchOptions());",
+            "  }",
+            "}")
+        .doTest();
+  }
+}
diff --git a/pom.xml b/pom.xml
index b8855c75ea..265360736b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -443,6 +443,19 @@
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
+            <dependency>
+                <groupId>org.mongodb</groupId>
+                <artifactId>mongodb-driver-core</artifactId>
+                <version>4.10.2</version>
+                <!-- XXX: Drop this exclusion once we forgo enforcement of JDK
+                11 bytecode version compatibility. -->
+                <exclusions>
+                    <exclusion>
+                        <groupId>org.mongodb</groupId>
+                        <artifactId>bson-record-codec</artifactId>
+                    </exclusion>
+                </exclusions>
+            </dependency>
             <dependency>
                 <groupId>org.slf4j</groupId>
                 <artifactId>slf4j-api</artifactId>