chore: improvements on flakiness of UI tests INTELLIJ-107

.github/workflows/quality-check.yaml

@@ -213,7 +213,7 @@ jobs:
           path: |
             **/build/reports/**/*.html
             **/build/reports/**/*.log
-            **/build/reports/*/*.png
+            **/build/reports/**/*.png
             **/build/idea-sandbox/system/**/*.log
             **/build/idea-sandbox/system-test/**/*.log
             **/video/**/*.avi

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

@@ -1,13 +1,16 @@
 package com.mongodb.jbplugin.editor.inputs
 
 import com.intellij.database.dataSource.LocalDataSource
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.application.ModalityState
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.ComboBox
 import com.intellij.openapi.ui.asSequence
 import com.intellij.sql.indexOf
 import com.intellij.ui.AnimatedIcon.ANIMATION_IN_RENDERER_ALLOWED
 import com.intellij.ui.components.JBLabel
 import com.mongodb.jbplugin.accessadapter.datagrip.adapter.isConnected
+import com.mongodb.jbplugin.editor.models.ToolbarState
 import com.mongodb.jbplugin.editor.models.getToolbarModel
 import com.mongodb.jbplugin.i18n.Icons
 import com.mongodb.jbplugin.i18n.Icons.scaledToText
@@ -98,15 +101,10 @@ class DataSourceComboBox(
         var isFirstInit = true
         coroutineScope.launch {
             project.getToolbarModel().toolbarState.collect { state ->
-                withoutSelectionChangedListener {
-                    selectedDataSourceConnecting = state.selectedDataSourceConnecting
-                    selectedDataSourceFailedConnecting = state.selectedDataSourceConnectionFailed
-                    if (isFirstInit || state.dataSources != dataSources) {
-                        isFirstInit = false
-                        populateComboBoxWithDataSources(state.dataSources)
-                    }
-                    selectDataSourceByUniqueId(state.selectedDataSource?.uniqueId)
-                }
+                ApplicationManager.getApplication().invokeLater({
+                    updateComboBoxState(state, isFirstInit)
+                    isFirstInit = false
+                }, ModalityState.stateForComponent(comboBoxComponent))
             }
         }
     }
@@ -120,11 +118,28 @@ class DataSourceComboBox(
         }
     }
 
-    private fun populateComboBoxWithDataSources(dataSources: List<LocalDataSource>) {
-        comboBoxModel.removeAllElements()
-        // First item is purposely a null to render "Detach data source label"
-        comboBoxModel.addElement(null)
-        comboBoxModel.addAll(dataSources)
+    private fun updateComboBoxState(state: ToolbarState, isFirstInit: Boolean) = withoutSelectionChangedListener {
+        selectedDataSourceConnecting = state.selectedDataSourceConnecting
+        selectedDataSourceFailedConnecting = state.selectedDataSourceConnectionFailed
+        if (isFirstInit || state.dataSources != dataSources) {
+            populateComboBoxWithDataSources(state.dataSources.toSet())
+        }
+        selectDataSourceByUniqueId(state.selectedDataSource?.uniqueId)
+    }
+
+    private fun populateComboBoxWithDataSources(newDataSources: Set<LocalDataSource>) {
+        val oldDataSources = dataSources.toSet()
+
+        val dataSourcesToAdd = newDataSources - oldDataSources
+        val dataSourcesToRemove = oldDataSources - newDataSources
+
+        dataSourcesToAdd.forEach { comboBoxModel.addElement(it) }
+        dataSourcesToRemove.forEach { comboBoxModel.removeElement(it) }
+
+        if (comboBoxModel.getIndexOf(null) != 0) {
+            comboBoxModel.removeElement(null)
+            comboBoxModel.insertElementAt(null, 0)
+        }
     }
 
     private fun selectDataSourceByUniqueId(uniqueId: String?) {

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

@@ -1,10 +1,13 @@
 package com.mongodb.jbplugin.editor.inputs
 
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.application.ModalityState
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.ComboBox
 import com.intellij.openapi.ui.asSequence
 import com.intellij.ui.AnimatedIcon.ANIMATION_IN_RENDERER_ALLOWED
 import com.intellij.ui.components.JBLabel
+import com.mongodb.jbplugin.editor.models.ToolbarState
 import com.mongodb.jbplugin.editor.models.getToolbarModel
 import com.mongodb.jbplugin.i18n.Icons
 import com.mongodb.jbplugin.i18n.Icons.scaledToText
@@ -78,14 +81,10 @@ class DatabaseComboBox(
         var isFirstInit = true
         coroutineScope.launch {
             project.getToolbarModel().toolbarState.collect { state ->
-                withoutSelectionChangedListener {
-                    loadingDatabases = state.databasesLoadingForSelectedDataSource
-                    if (isFirstInit || state.databases != databases) {
-                        isFirstInit = false
-                        populateComboBoxWithDatabases(state.databases)
-                    }
-                    selectDatabaseAndNotify(state.selectedDatabase)
-                }
+                ApplicationManager.getApplication().invokeLater({
+                    updateComboBoxState(state, isFirstInit)
+                    isFirstInit = false
+                }, ModalityState.stateForComponent(comboBoxComponent))
             }
         }
     }
@@ -99,11 +98,27 @@ class DatabaseComboBox(
         }
     }
 
-    private fun populateComboBoxWithDatabases(databases: List<String>) {
-        comboBoxModel.removeAllElements()
-        // First item is purposely a null to render "Detach data source label"
-        comboBoxModel.addElement(null)
-        comboBoxModel.addAll(databases)
+    private fun updateComboBoxState(state: ToolbarState, isFirstInit: Boolean) = withoutSelectionChangedListener {
+        loadingDatabases = state.databasesLoadingForSelectedDataSource
+        if (isFirstInit || state.databases != databases) {
+            populateComboBoxWithDatabases(state.databases.toSet())
+        }
+        selectDatabaseAndNotify(state.selectedDatabase)
+    }
+
+    private fun populateComboBoxWithDatabases(newDatabases: Set<String>) {
+        val oldDatabases = databases.toSet()
+
+        val databasesToAdd = newDatabases - oldDatabases
+        val databasesToRemove = oldDatabases - newDatabases
+
+        databasesToAdd.forEach { comboBoxModel.addElement(it) }
+        databasesToRemove.forEach { comboBoxModel.removeElement(it) }
+
+        if (comboBoxModel.getIndexOf(null) != 0) {
+            comboBoxModel.removeElement(null)
+            comboBoxModel.insertElementAt(null, 0)
+        }
     }
 
     private fun selectDatabaseAndNotify(database: String?) {

packages/jetbrains-plugin/src/test/kotlin/com/mongodb/jbplugin/codeActions/impl/MongoDbRunQueryActionUiTest.kt

@@ -2,15 +2,15 @@ package com.mongodb.jbplugin.codeActions.impl
 
 import com.intellij.remoterobot.RemoteRobot
 import com.mongodb.jbplugin.fixtures.*
-import com.mongodb.jbplugin.fixtures.components.findJavaEditorToolbar
-import com.mongodb.jbplugin.fixtures.components.findJavaEditorToolbarPopup
-import com.mongodb.jbplugin.fixtures.components.findRunQueryGutter
 import com.mongodb.jbplugin.fixtures.components.idea.ideaFrame
+import com.mongodb.jbplugin.fixtures.components.openRunQueryPopup
 import org.junit.jupiter.api.AfterEach
-import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import kotlin.time.Duration.Companion.minutes
+import kotlin.time.Duration.Companion.seconds
+import kotlin.time.toJavaDuration
 
 @UiTest
 @RequiresMongoDbCluster
@@ -20,6 +20,7 @@ class MongoDbRunQueryActionUiTest {
         remoteRobot: RemoteRobot,
         url: MongoDbServerUrl,
     ) {
+        remoteRobot.ideaFrame().cleanDataSources()
         remoteRobot.ideaFrame().addDataSourceWithUrl(javaClass.simpleName, url)
     }
 
@@ -34,8 +35,7 @@ class MongoDbRunQueryActionUiTest {
         remoteRobot.ideaFrame().openFile(
             "/src/main/java/alt/mongodb/javadriver/JavaDriverRepository.java"
         )
-        remoteRobot.findRunQueryGutter(atLine = 24)!!.click()
-        val popup = remoteRobot.findJavaEditorToolbarPopup()
+        val popup = remoteRobot.openRunQueryPopup(atLine = 24)
         popup.cancel()
     }
 
@@ -45,16 +45,11 @@ class MongoDbRunQueryActionUiTest {
         remoteRobot.ideaFrame().openFile(
             "/src/main/java/alt/mongodb/javadriver/JavaDriverRepository.java"
         )
-        remoteRobot.findJavaEditorToolbar().detachDataSource()
-        remoteRobot.findRunQueryGutter(atLine = 24)!!.click()
-        // because we are disconnected, we should now try to connect
-        val popup = remoteRobot.findJavaEditorToolbarPopup()
-        popup.dataSources.selectItem(
-            javaClass.simpleName
-        )
+        val popup = remoteRobot.openRunQueryPopup(atLine = 24)
+        popup.selectDataSource(javaClass.simpleName)
         popup.ok("Run Query", timeout = 1.minutes)
         // check that we open a console
-        eventually {
+        eventually(30.seconds.toJavaDuration()) {
             val currentEditor = remoteRobot.ideaFrame().currentTab()
             assertTrue(currentEditor.editor.fileName.startsWith("console"))
         }

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

@@ -6,8 +6,7 @@ import com.mongodb.jbplugin.fixtures.components.findJavaEditorToolbar
 import com.mongodb.jbplugin.fixtures.components.idea.ideaFrame
 import com.mongodb.jbplugin.fixtures.components.isJavaEditorToolbarHidden
 import org.junit.jupiter.api.AfterEach
-import org.junit.jupiter.api.Assertions.assertFalse
-import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import kotlin.time.Duration.Companion.minutes
@@ -21,6 +20,7 @@ class JavaDriverToolbarVisibilityUiTest {
         remoteRobot: RemoteRobot,
         url: MongoDbServerUrl,
     ) {
+        remoteRobot.ideaFrame().cleanDataSources()
         remoteRobot.ideaFrame().addDataSourceWithUrl(javaClass.simpleName, url)
     }
 
@@ -30,7 +30,7 @@ class JavaDriverToolbarVisibilityUiTest {
     }
 
     @Test
-    @RequiresProject("basic-java-project-with-mongodb")
+    @RequiresProject("basic-java-project-with-mongodb", smartMode = true)
     fun `shows the toolbar in a java file with references to the driver`(remoteRobot: RemoteRobot) {
         remoteRobot.ideaFrame().openFile(
             "/src/main/java/alt/mongodb/javadriver/JavaDriverRepository.java"
@@ -40,7 +40,7 @@ class JavaDriverToolbarVisibilityUiTest {
     }
 
     @Test
-    @RequiresProject("basic-java-project-with-mongodb")
+    @RequiresProject("basic-java-project-with-mongodb", smartMode = true)
     fun `shows the toolbar in all the java files with references to the driver`(
         remoteRobot: RemoteRobot
     ) {
@@ -63,7 +63,7 @@ class JavaDriverToolbarVisibilityUiTest {
     }
 
     @Test
-    @RequiresProject("basic-java-project-with-mongodb")
+    @RequiresProject("basic-java-project-with-mongodb", smartMode = true)
     fun `does not show the toolbar in a java file without references to the driver`(
         remoteRobot: RemoteRobot
     ) {
@@ -74,7 +74,7 @@ class JavaDriverToolbarVisibilityUiTest {
     }
 
     @Test
-    @RequiresProject("basic-java-project-with-mongodb")
+    @RequiresProject("basic-java-project-with-mongodb", smartMode = true)
     fun `does show existing data sources in the combo box`(
         remoteRobot: RemoteRobot,
         url: MongoDbServerUrl,
@@ -88,7 +88,7 @@ class JavaDriverToolbarVisibilityUiTest {
     }
 
     @Test
-    @RequiresProject("basic-java-project-with-mongodb")
+    @RequiresProject("basic-java-project-with-mongodb", smartMode = true)
     fun `does not show the database select on a java driver file`(
         remoteRobot: RemoteRobot,
         url: MongoDbServerUrl,
@@ -102,7 +102,7 @@ class JavaDriverToolbarVisibilityUiTest {
     }
 
     @Test
-    @RequiresProject("basic-java-project-with-mongodb")
+    @RequiresProject("basic-java-project-with-mongodb", smartMode = true)
     fun `does show the database select on a spring criteria file`(
         remoteRobot: RemoteRobot,
         url: MongoDbServerUrl,
@@ -114,34 +114,31 @@ class JavaDriverToolbarVisibilityUiTest {
         val toolbar = remoteRobot.findJavaEditorToolbar()
         assertTrue(toolbar.hasDatabasesComboBox)
 
-        eventually(1.minutes.toJavaDuration()) {
-            // when we select a cluster, it will connect asynchronously
-            toolbar.dataSources.selectItem(javaClass.simpleName)
-        }
+        toolbar.selectDataSource(javaClass.simpleName)
+
         eventually(1.minutes.toJavaDuration()) {
             // it can take a few seconds, we will retry every few milliseconds
             // but wait at least for a minute if we can't select a database
-            toolbar.databases.selectItem("admin")
+            toolbar.selectDatabase("admin")
         }
     }
 
     @Test
-    @RequiresProject("basic-java-project-with-mongodb")
+    @RequiresProject("basic-java-project-with-mongodb", smartMode = true)
     fun `shows the toolbar when a reference to the driver is added`(
         remoteRobot: RemoteRobot,
         url: MongoDbServerUrl,
     ) {
-        assertTrue(remoteRobot.isJavaEditorToolbarHidden())
-
         remoteRobot.ideaFrame().openFile(
             "/src/main/java/alt/mongodb/javadriver/NoDriverReference.java"
         )
+        assertTrue(remoteRobot.isJavaEditorToolbarHidden())
         val editor = remoteRobot.ideaFrame().currentTab().editor
         val textBeforeChanges = editor.text
 
         editor.insertTextAtLine(1, 0, "import com.mongodb.client.MongoClient;")
-
-        remoteRobot.findJavaEditorToolbar()
-        editor.text = textBeforeChanges.replace("\n", "\\\n")
+        assertTrue(remoteRobot.findJavaEditorToolbar().isShowing)
+        editor.replaceText("import com.mongodb.client.MongoClient;", "")
+        assertTrue(remoteRobot.isJavaEditorToolbarHidden())
     }
 }