feat: check ability to detect abstractions and patterns in code INTELLIJ-29

.github/workflows/quality-check.yaml

@@ -120,7 +120,10 @@ jobs:
           sudo apt install -y docker docker-compose
       - name: Run Test Suite
         run: |
-          ./gradlew --stacktrace --console=plain "clean" "cleanTest" "unitTest" "jacocoTestReport" -x "packages:jetbrains-plugin:uiTest"
+          ./gradlew --stacktrace --console=plain "clean" "cleanTest" "unitTest" -x "packages:jetbrains-plugin:uiTest"
+      - name: Generate Coverage Report
+        run: |
+          ./gradlew "jacocoTestReport" $(./gradlew "jacocoTestReport" --dry-run | awk '/^:/ { print "-x" $1 }' | sed '$ d')
       - name: Publish Test Report
         uses: mikepenz/action-junit-report@v4
         if: success() || failure() # always run even if the previous step fails

.gitignore

@@ -34,4 +34,5 @@ packages/jetbrains-plugin/src/main/resources/build.properties
 /**/video
 /**/.DS_Store
 
-FAKE_BROWSER_OUTPUT
+FAKE_BROWSER_OUTPUT
+/.kotlin

CHANGELOG.md

@@ -5,6 +5,8 @@ MongoDB plugin for IntelliJ IDEA.
 ## [Unreleased]
 
 ### Added
+* [INTELLIJ-29](https://jira.mongodb.org/browse/INTELLIJ-29): Shows an inlay hint near a Java query that shows in which collection the query is
+going to be run in case it could be inferred.
 * [INTELLIJ-17](https://jira.mongodb.org/browse/INTELLIJ-17): Added a toolbar that allows to attach a MongoDB data source to the current editor.
 This data source is used for autocompletion and type checking.
 * [INTELLIJ-14](https://jira.mongodb.org/browse/INTELLIJ-14): Send telemetry when a connection to a MongoDB Cluster fails.

packages/jetbrains-plugin/build.gradle.kts

@@ -26,6 +26,7 @@ dependencies {
     implementation(project(":packages:mongodb-access-adapter:datagrip-access-adapter"))
     implementation(project(":packages:mongodb-autocomplete-engine"))
     implementation(project(":packages:mongodb-dialects"))
+    implementation(project(":packages:mongodb-dialects:java-driver"))
     implementation(project(":packages:mongodb-linting-engine"))
     implementation(project(":packages:mongodb-mql-model"))
 
@@ -40,6 +41,7 @@ dependencies {
     testCompileOnly(libs.testing.intellij.ideImpl)
     testCompileOnly(libs.testing.intellij.coreUi)
 
+    testImplementation(libs.mongodb.driver)
     testImplementation(libs.testing.jsoup)
     testImplementation(libs.testing.video.recorder)
     testImplementation(libs.testing.remoteRobot)

packages/jetbrains-plugin/src/main/kotlin/com/mongodb/jbplugin/editor/EditorToolbarDecorator.kt

@@ -128,7 +128,14 @@ class EditorToolbarDecorator(
 
     private fun isEditingJavaFileWithMongoDbRelatedCode(): Boolean {
         val project = editor.project ?: return false
-        val psiFile = PsiManager.getInstance(project).findFile(editor.virtualFile) ?: return false
+        val psiFileResult = runCatching { PsiManager.getInstance(project).findFile(editor.virtualFile) }
+
+        if (psiFileResult.isFailure) {
+            return false
+        }
+
+        val psiFile = psiFileResult.getOrThrow()!!
+
         if (psiFile.language != JavaLanguage.INSTANCE) {
             return false
         }

packages/jetbrains-plugin/src/main/kotlin/com/mongodb/jbplugin/inlays/JavaDriverQueryNamespaceInlay.kt

@@ -0,0 +1,73 @@
+package com.mongodb.jbplugin.inlays
+
+import com.intellij.codeInsight.hints.declarative.*
+import com.intellij.openapi.editor.Editor
+import com.intellij.psi.PsiDocumentManager
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiFile
+import com.intellij.psi.PsiMethod
+import com.intellij.psi.PsiMethodCallExpression
+import com.intellij.psi.util.parentOfType
+import com.mongodb.jbplugin.dialects.javadriver.glossary.NamespaceExtractor
+import com.mongodb.jbplugin.dialects.javadriver.glossary.findContainingClass
+import com.mongodb.jbplugin.dialects.javadriver.glossary.isMongoDbCollectionClass
+
+/**
+ * This inlay shows for the current query in which namespace is going to run, if possible,
+ * according to the extraction rules of NamespaceExtractor.
+ *
+ * @see NamespaceExtractor
+ */
+class JavaDriverQueryNamespaceInlay : InlayHintsProvider {
+    override fun createCollector(
+        file: PsiFile,
+        editor: Editor,
+    ): InlayHintsCollector = QueryNamespaceInlayHintsCollector()
+
+    class QueryNamespaceInlayHintsCollector : SharedBypassCollector {
+        override fun collectFromElement(
+            element: PsiElement,
+            sink: InlayTreeSink,
+        ) {
+            val asMethodCall = element as? PsiMethodCallExpression
+
+            val callsAcollection =
+                asMethodCall
+                    ?.methodExpression
+                    ?.resolve()
+                    ?.findContainingClass()
+                    ?.isMongoDbCollectionClass(
+                        element.project,
+                    ) == true
+
+            val callsSuperClass =
+                asMethodCall?.findContainingClass() != null &&
+                    asMethodCall.findContainingClass().superClass != null &&
+                    (asMethodCall.methodExpression.resolve() as? PsiMethod)?.containingClass ==
+                    asMethodCall.findContainingClass().superClass
+
+            if (callsAcollection || callsSuperClass) {
+                val namespace =
+                    runCatching {
+                        NamespaceExtractor.extractNamespace(element)
+                            ?: NamespaceExtractor.extractNamespace(element.parentOfType<PsiMethod>()!!)
+                    }.getOrNull()
+
+                namespace ?: return
+
+                val documentManager = PsiDocumentManager.getInstance(element.project)
+                val document = documentManager.getDocument(element.containingFile)!!
+                val lineOfElement = document.getLineNumber(element.textOffset)
+
+                sink.addPresentation(
+                    EndOfLinePosition(lineOfElement),
+                    emptyList(),
+                    "Inferred MongoDB namespace for this query.",
+                    true,
+                ) {
+                    text(namespace.toString())
+                }
+            }
+        }
+    }
+}

packages/jetbrains-plugin/src/main/resources/META-INF/plugin.xml

@@ -22,6 +22,14 @@
                            bundle="messages.TelemetryBundle"
                            key="notification.group.name"
                            />
+        <codeInsight.declarativeInlayProvider
+                group="com.mongodb.jbplugin"
+                implementationClass="com.mongodb.jbplugin.inlays.JavaDriverQueryNamespaceInlay"
+                isEnabledByDefault="true"
+                language="JAVA"
+                nameKey="inlay.namespace.name"
+                bundle="messages.InspectionsAndInlaysBundle"
+                providerId="com.mongodb.jbplugin#JAVA" />
     </extensions>
     <applicationListeners>
     </applicationListeners>

packages/jetbrains-plugin/src/main/resources/messages/InspectionsAndInlaysBundle.properties

@@ -0,0 +1,2 @@
+notification.group.inspection.results=MongoDB Inspection Results
+inlay.namespace.name=MongoDB Namespace Inlay

packages/jetbrains-plugin/src/test/kotlin/com/mongodb/jbplugin/editor/javaEditor/JavaDriverToolbarVisibilityUiTest.kt

@@ -33,7 +33,7 @@ class JavaDriverToolbarVisibilityUiTest {
     @Test
     @RequiresProject("basic-java-project-with-mongodb")
     fun `shows the toolbar in a java file with references to the driver`(remoteRobot: RemoteRobot) {
-        remoteRobot.ideaFrame().openFile("/src/main/java/alt/mongodb/javadriver/JavaDriverRepositoryExample.java")
+        remoteRobot.ideaFrame().openFile("/src/main/java/alt/mongodb/javadriver/JavaDriverRepository.java")
         val toolbar = remoteRobot.findJavaEditorToolbar()
         assertTrue(toolbar.isShowing)
     }
@@ -51,7 +51,7 @@ class JavaDriverToolbarVisibilityUiTest {
         remoteRobot: RemoteRobot,
         url: MongoDbServerUrl,
     ) {
-        remoteRobot.ideaFrame().openFile("/src/main/java/alt/mongodb/javadriver/JavaDriverRepositoryExample.java")
+        remoteRobot.ideaFrame().openFile("/src/main/java/alt/mongodb/javadriver/JavaDriverRepository.java")
 
         val toolbar = remoteRobot.findJavaEditorToolbar()
         assertTrue(toolbar.dataSources.listValues().contains(javaClass.simpleName))
@@ -63,7 +63,7 @@ class JavaDriverToolbarVisibilityUiTest {
         remoteRobot: RemoteRobot,
         url: MongoDbServerUrl,
     ) {
-        remoteRobot.ideaFrame().openFile("/src/main/java/alt/mongodb/javadriver/JavaDriverRepositoryExample.java")
+        remoteRobot.ideaFrame().openFile("/src/main/java/alt/mongodb/javadriver/JavaDriverRepository.java")
 
         val toolbar = remoteRobot.findJavaEditorToolbar()
         assertTrue(toolbar.dataSources.listValues().contains(javaClass.simpleName))