feat(clients): show background progress

Blarc · Blarc · commit 16d0ad19b193 · 2024-06-08T15:24:28.000+02:00
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/AICommitAction.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/AICommitAction.kt
@@ -1,6 +1,5 @@
 package com.github.blarc.ai.commits.intellij.plugin
 
-import com.github.blarc.ai.commits.intellij.plugin.AICommitsBundle.message
 import com.github.blarc.ai.commits.intellij.plugin.AICommitsUtils.commonBranch
 import com.github.blarc.ai.commits.intellij.plugin.AICommitsUtils.computeDiff
 import com.github.blarc.ai.commits.intellij.plugin.AICommitsUtils.constructPrompt
@@ -9,7 +8,6 @@ import com.github.blarc.ai.commits.intellij.plugin.notifications.sendNotificatio
 import com.github.blarc.ai.commits.intellij.plugin.settings.AppSettings2
 import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
-import com.intellij.openapi.progress.runBackgroundableTask
 import com.intellij.openapi.project.DumbAware
 import com.intellij.openapi.vcs.VcsDataKeys
 import com.intellij.openapi.vcs.ui.CommitMessage
@@ -33,30 +31,27 @@ class AICommitAction : AnAction(), DumbAware {
         val includedChanges = commitWorkflowHandler.ui.getIncludedChanges()
         val commitMessage = VcsDataKeys.COMMIT_MESSAGE_CONTROL.getData(e.dataContext) as CommitMessage?
 
-        // FIXME @Blarc: Use coroutine with Dispatchers.IO!!!!!!!!!!!
-        runBackgroundableTask(message("action.background"), project) {
-            val diff = computeDiff(includedChanges, false, project)
-            if (diff.isBlank()) {
-                sendNotification(Notification.emptyDiff())
-                return@runBackgroundableTask
-            }
+        val diff = computeDiff(includedChanges, false, project)
+        if (diff.isBlank()) {
+            sendNotification(Notification.emptyDiff())
+            return
+        }
 
-            val branch = commonBranch(includedChanges, project)
-            val hint = commitMessage?.text
-            val prompt = constructPrompt(AppSettings2.instance.activePrompt.content, diff, branch, hint)
+        val branch = commonBranch(includedChanges, project)
+        val hint = commitMessage?.text
+        val prompt = constructPrompt(AppSettings2.instance.activePrompt.content, diff, branch, hint)
 
-            // TODO @Blarc: add support for different clients
+        // TODO @Blarc: add support for different clients
 //            if (isPromptTooLarge(prompt)) {
 //                sendNotification(Notification.promptTooLarge())
 //                return@runBackgroundableTask
 //            }
 
-            if (commitMessage == null) {
-                sendNotification(Notification.noCommitMessage())
-                return@runBackgroundableTask
-            }
-
-            llmClient.generateCommitMessage(prompt, commitMessage)
+        if (commitMessage == null) {
+            sendNotification(Notification.noCommitMessage())
+            return
         }
+
+        llmClient.generateCommitMessage(prompt, project, commitMessage)
     }
 }
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/AICommitsUtils.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/AICommitsUtils.kt
@@ -90,7 +90,7 @@ object AICommitsUtils {
         val changesByRepository = includedChanges
             .filter {
                 it.virtualFile?.path?.let { path ->
-                    AICommitsUtils.isPathExcluded(path, project)
+                    isPathExcluded(path, project)
                 } ?: false
             }
             .mapNotNull { change ->
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/notifications/Notification.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/notifications/Notification.kt
@@ -27,7 +27,7 @@ data class Notification(
 
         fun star() = Notification(
             message = """
-                Finding AI Commit useful? Show your support 💖 and ⭐ the repository 🙏.
+                Finding AI Commits useful? Show your support 💖 and ⭐ the repository 🙏.
             """.trimIndent(),
             actions = setOf(
                 NotificationAction.openRepository() {
@@ -39,7 +39,7 @@ data class Notification(
             )
         )
 
-        fun emptyDiff() = Notification(DEFAULT_TITLE, message = message("notifications.empty-diff"))
+        fun emptyDiff() = Notification(DEFAULT_TITLE, message = message("notifications.empty-diff"), type = Type.TRANSIENT)
         fun promptTooLarge() = Notification(DEFAULT_TITLE, message = message("notifications.prompt-too-large"))
         fun unsuccessfulRequest(message: String) = Notification(message = message("notifications.unsuccessful-request", message))
         fun noCommitMessage() = Notification(message = message("notifications.no-commit-message"))
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/LLMClientConfiguration.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/LLMClientConfiguration.kt
@@ -1,5 +1,6 @@
 package com.github.blarc.ai.commits.intellij.plugin.settings.clients
 
+import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.ComboBox
 import com.intellij.openapi.vcs.ui.CommitMessage
 import com.intellij.util.xmlb.annotations.Attribute
@@ -40,7 +41,7 @@ abstract class LLMClientConfiguration(
         getSharedState().modelIds.add(modelId)
     }
 
-    abstract fun generateCommitMessage(prompt: String, commitMessage: CommitMessage)
+    abstract fun generateCommitMessage(prompt: String, project: Project, commitMessage: CommitMessage)
 
     abstract fun getRefreshModelsFunction(): ((ComboBox<String>) -> Unit)?
 
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/LLMClientService.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/LLMClientService.kt
@@ -5,7 +5,9 @@ import com.github.blarc.ai.commits.intellij.plugin.settings.AppSettings2
 import com.github.blarc.ai.commits.intellij.plugin.wrap
 import com.intellij.icons.AllIcons
 import com.intellij.openapi.application.EDT
+import com.intellij.openapi.project.Project
 import com.intellij.openapi.vcs.ui.CommitMessage
+import com.intellij.platform.ide.progress.withBackgroundProgress
 import com.intellij.ui.components.JBLabel
 import dev.langchain4j.data.message.UserMessage
 import dev.langchain4j.model.chat.ChatLanguageModel
@@ -18,18 +20,20 @@ abstract class LLMClientService<T : LLMClientConfiguration>(private val cs: Coro
 
     abstract suspend fun buildChatModel(client: T): ChatLanguageModel
 
-    fun generateCommitMessage(client: T, prompt: String, commitMessage: CommitMessage) {
+    fun generateCommitMessage(client: T, prompt: String, project: Project, commitMessage: CommitMessage) {
         cs.launch(Dispatchers.Default) {
-            sendRequest(client, prompt, onSuccess = {
-                withContext(Dispatchers.EDT) {
-                    commitMessage.setCommitMessage(it)
-                }
-                AppSettings2.instance.recordHit()
-            }, onError = {
-                withContext(Dispatchers.EDT) {
-                    commitMessage.setCommitMessage(it)
-                }
-            })
+            withBackgroundProgress(project, "Generating commit") {
+                sendRequest(client, prompt, onSuccess = {
+                    withContext(Dispatchers.EDT) {
+                        commitMessage.setCommitMessage(it)
+                    }
+                    AppSettings2.instance.recordHit()
+                }, onError = {
+                    withContext(Dispatchers.EDT) {
+                        commitMessage.setCommitMessage(it)
+                    }
+                })
+            }
         }
     }
 
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/ollama/OllamaClientConfiguration.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/ollama/OllamaClientConfiguration.kt
@@ -3,6 +3,7 @@ package com.github.blarc.ai.commits.intellij.plugin.settings.clients.ollama
 import com.github.blarc.ai.commits.intellij.plugin.Icons
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.LLMClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.LLMClientSharedState
+import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.ComboBox
 import com.intellij.openapi.vcs.ui.CommitMessage
 import javax.swing.Icon
@@ -32,8 +33,8 @@ class OllamaClientConfiguration : LLMClientConfiguration(
         return OllamaClientSharedState.getInstance()
     }
 
-    override fun generateCommitMessage(prompt: String, commitMessage: CommitMessage) {
-        return OllamaClientService.getInstance().generateCommitMessage(this, prompt, commitMessage)
+    override fun generateCommitMessage(prompt: String, project: Project, commitMessage: CommitMessage) {
+        return OllamaClientService.getInstance().generateCommitMessage(this, prompt, project, commitMessage)
     }
 
     override fun getRefreshModelsFunction() = fun (cb: ComboBox<String>) {
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/openAi/OpenAiClientConfiguration.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/openAi/OpenAiClientConfiguration.kt
@@ -2,6 +2,7 @@ package com.github.blarc.ai.commits.intellij.plugin.settings.clients.openAi
 
 import com.github.blarc.ai.commits.intellij.plugin.Icons
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.LLMClientConfiguration
+import com.intellij.openapi.project.Project
 import com.intellij.openapi.vcs.ui.CommitMessage
 import com.intellij.util.xmlb.annotations.Transient
 import javax.swing.Icon
@@ -35,8 +36,8 @@ class OpenAiClientConfiguration : LLMClientConfiguration(
         return OpenAiClientSharedState.getInstance()
     }
 
-    override fun generateCommitMessage(prompt: String, commitMessage: CommitMessage) {
-        return OpenAiClientService.getInstance().generateCommitMessage(this, prompt, commitMessage)
+    override fun generateCommitMessage(prompt: String, project: Project, commitMessage: CommitMessage) {
+        return OpenAiClientService.getInstance().generateCommitMessage(this, prompt, project, commitMessage)
     }
 
     // Model names are retrieved from Enum and do not need to be refreshed.

Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ object AICommitsUtils {`
`90`	`90`	`val changesByRepository = includedChanges`
`91`	`91`	`.filter {`
`92`	`92`	`it.virtualFile?.path?.let { path ->`
`93`		`- AICommitsUtils.isPathExcluded(path, project)`
	`93`	`+ isPathExcluded(path, project)`
`94`	`94`	`} ?: false`
`95`	`95`	`}`
`96`	`96`	`.mapNotNull { change ->`