feat(providers): create AIProvider interface and OpenAIProvider that implements it

Blarc · Blarc · commit 81d623d7d61d · 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
@@ -54,7 +54,7 @@ class AICommitAction : AnAction(), DumbAware {
             val openAIService = OpenAIService.instance
             runBlocking(Dispatchers.Main) {
                 try {
-                    val generatedCommitMessage = openAIService.generateCommitMessage(prompt, 1)
+                    val generatedCommitMessage = openAIService.generateCommitMessage(prompt)
                     commitMessage.setCommitMessage(generatedCommitMessage)
                     AppSettings.instance.recordHit()
                 } catch (e: Exception) {
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/OpenAIService.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/OpenAIService.kt
@@ -1,16 +1,9 @@
 package com.github.blarc.ai.commits.intellij.plugin
 
 import com.aallam.openai.api.chat.*
-import com.aallam.openai.api.http.Timeout
-import com.aallam.openai.api.model.ModelId
-import com.aallam.openai.client.OpenAI
-import com.aallam.openai.client.OpenAIConfig
-import com.aallam.openai.client.OpenAIHost
-import com.aallam.openai.client.ProxyConfig
 import com.github.blarc.ai.commits.intellij.plugin.settings.AppSettings
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.components.Service
-import kotlin.time.Duration.Companion.seconds
 
 
 @Service(Service.Level.APP)
@@ -21,44 +14,16 @@ class OpenAIService {
             get() = ApplicationManager.getApplication().getService(OpenAIService::class.java)
     }
 
-    suspend fun generateCommitMessage(prompt: String, completions: Int): String {
-        val openAI = OpenAI(AppSettings.instance.getOpenAIConfig())
-
-        val chatCompletionRequest = ChatCompletionRequest(
-            ModelId(AppSettings.instance.openAIModelId),
-            listOf(
-                ChatMessage(
-                    role = ChatRole.User,
-                    content = prompt
-                )
-            ),
-            temperature = AppSettings.instance.openAITemperature.toDouble(),
-            topP = 1.0,
-            frequencyPenalty = 0.0,
-            presencePenalty = 0.0,
-            maxTokens = 200,
-            n = completions
-        )
-
-        val completion: ChatCompletion = openAI.chatCompletion(chatCompletionRequest)
-        return completion.choices[0].message.content ?: "API returned an empty response."
+    suspend fun generateCommitMessage(prompt: String): String {
+        return AppSettings.instance.AIProvider.generateCommitMessage(prompt)
     }
 
     suspend fun refreshOpenAIModelIds() {
-        val openAI = OpenAI(AppSettings.instance.getOpenAIConfig())
-        AppSettings.instance.openAIModelIds=openAI.models().map { it.id.id }
+        AppSettings.instance.AIProvider.refreshModels()
     }
 
     @Throws(Exception::class)
-    suspend fun verifyOpenAIConfiguration(host: String, token: String, proxy: String?, socketTimeout: String){
-
-        val config = OpenAIConfig(
-                token,
-                host = host.takeIf { it.isNotBlank() }?.let { OpenAIHost(it) } ?: OpenAIHost.OpenAI,
-                proxy = proxy?.takeIf { it.isNotBlank() }?.let { ProxyConfig.Http(it) },
-                timeout = Timeout(socket = socketTimeout.toInt().seconds)
-        )
-        val openAI = OpenAI(config)
-        openAI.models()
+    suspend fun verifyOpenAIConfiguration(host: String, proxy: String?, timeout: String, token: String){
+        AppSettings.instance.AIProvider.verifyConfiguration(host, proxy, timeout, token)
     }
 }
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/AppSettings.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/AppSettings.kt
@@ -1,53 +1,38 @@
 package com.github.blarc.ai.commits.intellij.plugin.settings
 
-import com.aallam.openai.api.http.Timeout
-import com.aallam.openai.client.OpenAIConfig
-import com.aallam.openai.client.OpenAIHost
-import com.aallam.openai.client.ProxyConfig
 import com.github.blarc.ai.commits.intellij.plugin.AICommitsUtils
 import com.github.blarc.ai.commits.intellij.plugin.notifications.Notification
 import com.github.blarc.ai.commits.intellij.plugin.notifications.sendNotification
-import com.github.blarc.ai.commits.intellij.plugin.settings.prompt.DefaultPrompts
-import com.intellij.credentialStore.CredentialAttributes
-import com.intellij.credentialStore.Credentials
-import com.intellij.ide.passwordSafe.PasswordSafe
+import com.github.blarc.ai.commits.intellij.plugin.settings.prompts.DefaultPrompts
+import com.github.blarc.ai.commits.intellij.plugin.settings.providers.OpenAIProvider
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.components.PersistentStateComponent
 import com.intellij.openapi.components.State
 import com.intellij.openapi.components.Storage
 import com.intellij.util.xmlb.Converter
 import com.intellij.util.xmlb.XmlSerializerUtil
 import com.intellij.util.xmlb.annotations.OptionTag
-import org.jetbrains.kotlin.idea.gradleTooling.get
 import java.util.*
-import kotlin.time.Duration.Companion.seconds
 
 @State(
     name = AppSettings.SERVICE_NAME,
     storages = [Storage("AICommit.xml")]
 )
 class AppSettings : PersistentStateComponent<AppSettings> {
 
-    private val openAITokenTitle = "OpenAIToken"
     private var hits = 0
+    var requestSupport = true
+    var lastVersion: String? = null
 
     @OptionTag(converter = LocaleConverter::class)
     var locale: Locale = Locale.ENGLISH
 
-    var requestSupport = true
-    var lastVersion: String? = null
-    var openAIHost = OpenAIHost.OpenAI.baseUrl
-    var openAIHosts = mutableSetOf(OpenAIHost.OpenAI.baseUrl)
-    var openAISocketTimeout = "30"
-    var proxyUrl: String? = null
+    var AIProvider = OpenAIProvider.instance
+    var AIProviders = setOf(OpenAIProvider.instance)
 
     var prompts = DefaultPrompts.toPromptsMap()
     var currentPrompt = prompts["basic"]!!
 
-    var openAIModelId = "gpt-3.5-turbo"
-    var openAIModelIds = listOf("gpt-3.5-turbo", "gpt-4")
-    var openAITemperature = "0.7"
-
     var appExclusions: Set<String> = setOf()
 
     companion object {
@@ -56,39 +41,6 @@ class AppSettings : PersistentStateComponent<AppSettings> {
             get() = ApplicationManager.getApplication().getService(AppSettings::class.java)
     }
 
-    fun saveOpenAIToken(token: String) {
-        try {
-            PasswordSafe.instance.setPassword(getCredentialAttributes(openAITokenTitle), token)
-        } catch (e: Exception) {
-            sendNotification(Notification.unableToSaveToken())
-        }
-    }
-
-    fun getOpenAIConfig(): OpenAIConfig {
-        val token = getOpenAIToken() ?: throw Exception("OpenAI Token is not set.")
-        return OpenAIConfig(
-            token,
-            host = openAIHost.takeIf { it.isNotBlank() }?.let { OpenAIHost(it) } ?: OpenAIHost.OpenAI,
-            proxy = proxyUrl?.takeIf { it.isNotBlank() }?.let { ProxyConfig.Http(it) },
-            timeout = Timeout(socket = openAISocketTimeout.toInt().seconds)
-        )
-    }
-
-    fun getOpenAIToken(): String? {
-        val credentialAttributes = getCredentialAttributes(openAITokenTitle)
-        val credentials: Credentials = PasswordSafe.instance.get(credentialAttributes) ?: return null
-        return credentials.getPasswordAsString()
-    }
-
-    private fun getCredentialAttributes(title: String): CredentialAttributes {
-        return CredentialAttributes(
-            title,
-            null,
-            this.javaClass,
-            false
-        )
-    }
-
     override fun getState() = this
 
     override fun loadState(state: AppSettings) {
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/AppSettingsConfigurable.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/AppSettingsConfigurable.kt
@@ -3,8 +3,8 @@ package com.github.blarc.ai.commits.intellij.plugin.settings
 import com.aallam.openai.api.exception.OpenAIAPIException
 import 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.settings.prompt.Prompt
-import com.github.blarc.ai.commits.intellij.plugin.settings.prompt.PromptTable
+import com.github.blarc.ai.commits.intellij.plugin.settings.prompts.Prompt
+import com.github.blarc.ai.commits.intellij.plugin.settings.prompts.PromptTable
 import com.intellij.icons.AllIcons
 import com.intellij.openapi.options.BoundConfigurable
 import com.intellij.openapi.progress.runBackgroundableTask
@@ -65,7 +65,7 @@ class AppSettingsConfigurable : BoundConfigurable(message("settings.general.grou
             row {
                 label(message("settings.openAISocketTimeout")).widthGroup("label")
                 cell(socketTimeoutTextField)
-                    .bindText(AppSettings.instance::openAISocketTimeout)
+                    .bindIntText(AppSettings.instance::openAISocketTimeout)
                     .applyToComponent { minimumWidth = 400 }
                     .resizableColumn()
                     .widthGroup("input")
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/AppSettingsListCellRenderer.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/AppSettingsListCellRenderer.kt
@@ -1,7 +1,7 @@
 package com.github.blarc.ai.commits.intellij.plugin.settings
 
 import com.aallam.openai.api.model.ModelId
-import com.github.blarc.ai.commits.intellij.plugin.settings.prompt.Prompt
+import com.github.blarc.ai.commits.intellij.plugin.settings.prompts.Prompt
 import java.awt.Component
 import java.util.*
 import javax.swing.DefaultListCellRenderer
@@ -27,4 +27,4 @@ class AppSettingsListCellRenderer : DefaultListCellRenderer() {
         }
         return component
     }
-}
+}
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/prompts/DefaultPrompts.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/prompts/DefaultPrompts.kt
@@ -1,4 +1,4 @@
-package com.github.blarc.ai.commits.intellij.plugin.settings.prompt
+package com.github.blarc.ai.commits.intellij.plugin.settings.prompts
 
 enum class DefaultPrompts(val title: String, val description: String, val content: String) {
 
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/prompts/Prompt.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/prompts/Prompt.kt
@@ -1,4 +1,4 @@
-package com.github.blarc.ai.commits.intellij.plugin.settings.prompt
+package com.github.blarc.ai.commits.intellij.plugin.settings.prompts
 
 data class Prompt(
         var name: String = "",
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/prompts/PromptTable.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/prompts/PromptTable.kt
@@ -1,4 +1,4 @@
-package com.github.blarc.ai.commits.intellij.plugin.settings.prompt
+package com.github.blarc.ai.commits.intellij.plugin.settings.prompts
 
 import ai.grazie.utils.applyIf
 import com.github.blarc.ai.commits.intellij.plugin.AICommitsBundle.message
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/providers/AIProvider.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/providers/AIProvider.kt
@@ -0,0 +1,57 @@
+package com.github.blarc.ai.commits.intellij.plugin.settings.providers
+
+import com.github.blarc.ai.commits.intellij.plugin.notifications.Notification
+import com.github.blarc.ai.commits.intellij.plugin.notifications.sendNotification
+import com.intellij.credentialStore.CredentialAttributes
+import com.intellij.credentialStore.Credentials
+import com.intellij.ide.passwordSafe.PasswordSafe
+
+interface AIProvider {
+
+    var host: String
+    var hosts: Set<String>
+    var proxyUrl: String?
+    var timeout: Int
+    var modelId: String
+    var modelIds: List<String>
+    var temperature: String
+    var token: String
+        get() { return getToken() }
+        set(token) { saveToken(token) }
+
+    fun displayName(): String
+
+    suspend fun generateCommitMessage(prompt: String): String
+
+    suspend fun refreshModels()
+
+    @Throws(Exception::class)
+    suspend fun verifyConfiguration(
+        newHost: String,
+        newProxy: String?,
+        newTimeout: String,
+        newToken: String
+    )
+
+    private fun saveToken(token: String) {
+        try {
+            PasswordSafe.instance.setPassword(getCredentialAttributes(displayName()), token)
+        } catch (e: Exception) {
+            sendNotification(Notification.unableToSaveToken())
+        }
+    }
+
+    private fun getToken(): String {
+        val credentials: Credentials? = PasswordSafe.instance.get(getCredentialAttributes(displayName()))
+        return credentials?.getPasswordAsString() ?: throw Exception("${displayName()} token is not set.")
+    }
+
+    private fun getCredentialAttributes(title: String): CredentialAttributes {
+        return CredentialAttributes(
+            title,
+            null,
+            this.javaClass,
+            false
+        )
+    }
+}
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/providers/OpenAIProvider.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/providers/OpenAIProvider.kt
@@ -0,0 +1,85 @@
+package com.github.blarc.ai.commits.intellij.plugin.settings.providers
+
+import com.aallam.openai.api.chat.ChatCompletion
+import com.aallam.openai.api.chat.ChatCompletionRequest
+import com.aallam.openai.api.chat.ChatMessage
+import com.aallam.openai.api.chat.ChatRole
+import com.aallam.openai.api.http.Timeout
+import com.aallam.openai.api.model.ModelId
+import com.aallam.openai.client.OpenAI
+import com.aallam.openai.client.OpenAIConfig
+import com.aallam.openai.client.OpenAIHost
+import com.aallam.openai.client.ProxyConfig
+import kotlin.time.Duration.Companion.seconds
+
+class OpenAIProvider(
+    override var host: String = OpenAIHost.OpenAI.baseUrl,
+    override var hosts: Set<String> = setOf(OpenAIHost.OpenAI.baseUrl),
+    override var proxyUrl: String? = null,
+    override var timeout: Int = 30,
+    override var modelId: String = "gpt-3.5-turbo",
+    override var modelIds: List<String> =  listOf("gpt-3.5-turbo", "gpt-4"),
+    override var temperature: String = "0.7"
+) : AIProvider {
+
+    companion object {
+        val instance = OpenAIProvider()
+    }
+
+    override fun displayName() = "OpenAI"
+
+    override suspend fun generateCommitMessage(
+        prompt: String
+    ): String {
+
+        val openAI = OpenAI(openAIConfig())
+        val chatCompletionRequest = ChatCompletionRequest(
+            ModelId(modelId),
+            listOf(
+                ChatMessage(
+                    role = ChatRole.User,
+                    content = prompt
+                )
+            ),
+            temperature = temperature.toDouble(),
+            topP = 1.0,
+            frequencyPenalty = 0.0,
+            presencePenalty = 0.0,
+            maxTokens = 200,
+            n = 1
+        )
+
+        val completion: ChatCompletion = openAI.chatCompletion(chatCompletionRequest)
+        return completion.choices[0].message.content ?: "API returned an empty response."
+    }
+
+    override suspend fun refreshModels() {
+        val openAI = OpenAI(openAIConfig())
+        modelIds = openAI.models().map { it.id.id }
+    }
+
+    @Throws(Exception::class)
+    override suspend fun verifyConfiguration(
+        newHost: String,
+        newProxy: String?,
+        newTimeout: String,
+        newToken: String
+    ) {
+
+        val newConfig = OpenAIConfig(
+            newToken,
+            host = newHost.takeIf { it.isNotBlank() }?.let { OpenAIHost(it) } ?: OpenAIHost.OpenAI,
+            proxy = newProxy?.takeIf { it.isNotBlank() }?.let { ProxyConfig.Http(it) },
+            timeout = Timeout(socket = newTimeout.toInt().seconds)
+        )
+        val openAI = OpenAI(newConfig)
+        openAI.models()
+    }
+
+    private fun openAIConfig() = OpenAIConfig(
+        token,
+        host = host.takeIf { it.isNotBlank() }?.let { OpenAIHost(it) } ?: OpenAIHost.OpenAI,
+        proxy = proxyUrl?.takeIf { it.isNotBlank() }?.let { ProxyConfig.Http(it) },
+        timeout = Timeout(socket = timeout.seconds)
+    )
+}
diff --git a/src/test/kotlin/com/github/blarc/ai/commits/intellij/plugin/HintRegexTest.kt b/src/test/kotlin/com/github/blarc/ai/commits/intellij/plugin/HintRegexTest.kt
@@ -1,6 +1,6 @@
 package com.github.blarc.ai.commits.intellij.plugin
 
-import com.github.blarc.ai.commits.intellij.plugin.settings.prompt.DefaultPrompts
+import com.github.blarc.ai.commits.intellij.plugin.settings.prompts.DefaultPrompts
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.Arguments

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`package com.github.blarc.ai.commits.intellij.plugin.settings`
`2`	`2`
`3`	`3`	`import com.aallam.openai.api.model.ModelId`
`4`		`-import com.github.blarc.ai.commits.intellij.plugin.settings.prompt.Prompt`
	`4`	`+import com.github.blarc.ai.commits.intellij.plugin.settings.prompts.Prompt`
`5`	`5`	`import java.awt.Component`
`6`	`6`	`import java.util.*`
`7`	`7`	`import javax.swing.DefaultListCellRenderer`
`@@ -27,4 +27,4 @@ class AppSettingsListCellRenderer : DefaultListCellRenderer() {`
`27`	`27`	`}`
`28`	`28`	`return component`
`29`	`29`	`}`
`30`		`-}`
	`30`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.github.blarc.ai.commits.intellij.plugin.settings.prompt`
	`1`	`+package com.github.blarc.ai.commits.intellij.plugin.settings.prompts`
`2`	`2`
`3`	`3`	`enum class DefaultPrompts(val title: String, val description: String, val content: String) {`
`4`	`4`