feat: implemented settings to disable editor push notification (redhat-developer#763)

Signed-off-by: Andre Dietisheim <[email protected]>

Author: adietish

src/main/kotlin/com/redhat/devtools/intellij/kubernetes/editor/ResourceEditor.kt

@@ -23,14 +23,10 @@ import com.intellij.openapi.util.Disposer
 import com.intellij.openapi.util.Key
 import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.psi.PsiDocumentManager
+import com.intellij.util.messages.MessageBusConnection
 import com.redhat.devtools.intellij.common.utils.MetadataClutter
 import com.redhat.devtools.intellij.common.validation.KubernetesResourceInfo
-import com.redhat.devtools.intellij.kubernetes.editor.notification.DeletedNotification
-import com.redhat.devtools.intellij.kubernetes.editor.notification.ErrorNotification
-import com.redhat.devtools.intellij.kubernetes.editor.notification.PullNotification
-import com.redhat.devtools.intellij.kubernetes.editor.notification.PulledNotification
-import com.redhat.devtools.intellij.kubernetes.editor.notification.PushNotification
-import com.redhat.devtools.intellij.kubernetes.editor.notification.PushedNotification
+import com.redhat.devtools.intellij.kubernetes.editor.notification.Notifications
 import com.redhat.devtools.intellij.kubernetes.editor.util.getDocument
 import com.redhat.devtools.intellij.kubernetes.editor.util.isKubernetesResource
 import com.redhat.devtools.intellij.kubernetes.model.IResourceModel
@@ -39,6 +35,8 @@ import com.redhat.devtools.intellij.kubernetes.model.context.IActiveContext
 import com.redhat.devtools.intellij.kubernetes.model.util.ResourceException
 import com.redhat.devtools.intellij.kubernetes.model.util.toMessage
 import com.redhat.devtools.intellij.kubernetes.model.util.toTitle
+import com.redhat.devtools.intellij.kubernetes.settings.SettingsChangeListener
+import com.redhat.devtools.intellij.kubernetes.settings.SettingsConfigurable
 import io.fabric8.kubernetes.api.model.HasMetadata
 import java.util.concurrent.CompletableFuture
 
@@ -57,18 +55,7 @@ open class ResourceEditor(
     // for mocking purposes
     private val createResourceFileForVirtual: (file: VirtualFile?) -> ResourceFile? =
         ResourceFile.Factory::create,
-    // for mocking purposes
-    private val pushNotification: PushNotification = PushNotification(editor, project),
-    // for mocking purposes
-    private val pushedNotification: PushedNotification = PushedNotification(editor, project),
-    // for mocking purposes
-    private val pullNotification: PullNotification = PullNotification(editor, project),
-    // for mocking purposes
-    private val pulledNotification: PulledNotification = PulledNotification(editor, project),
-    // for mocking purposes
-    private val deletedNotification: DeletedNotification = DeletedNotification(editor, project),
-    // for mocking purposes
-    private val errorNotification: ErrorNotification = ErrorNotification(editor, project),
+    private val notifications: Notifications = Notifications(editor, project),
     // for mocking purposes
     private val getDocument: (FileEditor) -> Document? = ::getDocument,
     // for mocking purposes
@@ -81,14 +68,18 @@ open class ResourceEditor(
     // for mocking purposes
     private val diff: ResourceDiff = ResourceDiff(project),
     // for mocking purposes
-    protected val editorResources: EditorResources = EditorResources(resourceModel)
+    protected val editorResources: EditorResources = EditorResources(resourceModel),
+    private val connection: MessageBusConnection = ApplicationManager.getApplication().messageBus.connect()
 ) : Disposable {
 
     init {
         Disposer.register(editor, this)
         editorResources.resourceChangedListener = onResourceChanged()
         resourceModel.addListener(onNamespaceOrContextChanged())
-        runAsync { enableEditingNonProjectFile() }
+        runAsync {
+            enableEditingNonProjectFile()
+            connection.subscribe(SettingsChangeListener.CHANGED, onSettingsChanged())
+        }
     }
 
     companion object {
@@ -117,15 +108,15 @@ open class ResourceEditor(
                 if (editorResources.size == 1) {
                     // show notification for 1 resource
                     val editorResource = editorResources.firstOrNull() ?: return@runAsync
-                    showNotification(editorResource)
+                    notifications.show(editorResource)
                 } else if (editorResources.size > 1) {
                     // show notification for multiple resources
-                    showNotification(editorResources)
+                    notifications.show(editorResources)
                 }
             } catch (e: Exception) {
                 runInUI {
-                    hideNotifications()
-                    errorNotification.show(
+                    notifications.hideAll()
+                    notifications.showError(
                         toTitle(e),
                         toMessage(e.cause)
                     )
@@ -134,108 +125,14 @@ open class ResourceEditor(
         }
     }
 
-    open protected fun updateDeleted(deleted: HasMetadata?) {
+    protected open fun updateDeleted(deleted: HasMetadata?) {
         if (deleted == null) {
             return
         }
         editorResources.setDeleted(deleted)
         update()
     }
 
-    private fun showNotification(editorResource: EditorResource) {
-        val state = editorResource.getState()
-        val resource = editorResource.getResource()
-        when (state) {
-            is Error ->
-                showErrorNotification(state.title, state.message)
-            is Pushed ->
-                showPushedNotification(listOf(editorResource))
-            is DeletedOnCluster ->
-                showDeletedNotification(resource)
-/**
- * avoid too many notifications, don't notify outdated
-            is Outdated ->
-                showPullNotification(resource)
- */
-            is Modified ->
-                showPushNotification(true, listOf(editorResource))
-
-            else ->
-                runInUI {
-                    hideNotifications()
-                }
-        }
-    }
-
-    private fun showNotification(editorResources: Collection<EditorResource>) {
-        val toPush = editorResources.filter(FILTER_TO_PUSH)
-        if (toPush.isNotEmpty()) {
-            showPushNotification(false, toPush)
-            return
-        }
-        val inError = editorResources.filter(FILTER_ERROR)
-        if (inError.isNotEmpty()) {
-            showErrorNotification(inError)
-        } else {
-            runInUI {
-                hideNotifications()
-            }
-        }
-    }
-
-    private fun showErrorNotification(title: String, message: String?) {
-        runInUI {
-            hideNotifications()
-            errorNotification.show(title, message)
-        }
-    }
-
-    private fun showErrorNotification(editorResources: Collection<EditorResource>) {
-        val inError = editorResources.filter(FILTER_ERROR)
-        val toDisplay = inError.firstOrNull()?.getState() as? Error ?: return
-        showErrorNotification(toDisplay.title, toDisplay.message)
-    }
-
-    private fun showPushNotification(showPull: Boolean, editorResources: Collection<EditorResource>) {
-        runInUI {
-            // hide & show in the same UI thread runnable avoid flickering
-            hideNotifications()
-            pushNotification.show(showPull, editorResources)
-        }
-    }
-
-    private fun showPushedNotification(editorResources: Collection<EditorResource>) {
-        runInUI {
-            // hide & show in the same UI thread runnable avoid flickering
-            hideNotifications()
-            pushedNotification.show(editorResources)
-        }
-    }
-
-    private fun showPullNotification(resource: HasMetadata) {
-        runInUI {
-            hideNotifications()
-            pullNotification.show(resource)
-        }
-    }
-
-    private fun showDeletedNotification(resource: HasMetadata) {
-        runInUI {
-            // hide & show in the same UI thread runnable avoid flickering
-            hideNotifications()
-            deletedNotification.show(resource)
-        }
-    }
-
-    private fun hideNotifications() {
-        errorNotification.hide()
-        pullNotification.hide()
-        deletedNotification.hide()
-        pushNotification.hide()
-        pushedNotification.hide()
-        pulledNotification.hide()
-    }
-
     /**
      * Pulls the resource from the cluster and replaces the content of this editor.
      * Does nothing if it doesn't exist.
@@ -248,7 +145,7 @@ open class ResourceEditor(
         }
         runInUI {
             // hide before running pull. Pull may take quite some time on remote cluster
-            hideNotifications()
+            notifications.hideAll()
         }
         val resource = resources.firstOrNull() ?: return
 
@@ -293,7 +190,7 @@ open class ResourceEditor(
     fun push(all: Boolean) {
         runInUI {
             // hide before running push. Push may take quite some time on remote cluster
-            hideNotifications()
+            notifications.hideAll()
         }
         runAsync {
             if (all) {
@@ -370,7 +267,7 @@ open class ResourceEditor(
         }
         runInUI {
             replaceDocument(resources)
-            hideNotifications()
+            notifications.hideAll()
         }
     }
 
@@ -431,6 +328,21 @@ open class ResourceEditor(
         }
     }
 
+    protected open fun onSettingsChanged(): SettingsChangeListener {
+        return object : SettingsChangeListener {
+            override fun changed(property: String, value: String?) {
+                if (value != null
+                    && SettingsConfigurable.EDITOR_NOTIFICATIONS_DISABLED == property) {
+                    if (true == value.toBoolean()) {
+                        notifications.hideAll()
+                    } else {
+                        update()
+                    }
+                }
+            }
+        }
+    }
+
     /**
      * Closes this instance and cleans up references to it.
      * - Removes the resource model listener,
@@ -496,5 +408,6 @@ open class ResourceEditor(
     override fun dispose() {
         resourceModel.removeListener(onNamespaceContextChanged)
         editorResources.dispose()
+        connection.dispose()
     }
 }