impl: ssh config improvements (#41)

- different header blocks to differentiate between Gateway and Toolbox
ssh config
- different key for Toolbox for workspace usage
- honors the `disable autostart` setting in the URI handling
-  plugin's display name was changed from Coder Toolbox to Coder
- adds support for ssh wildcard config, configurable from plugin's
Settings page.
- the settings models were reworked because there was too much confusion
around CoderSettings, CoderSettingsState, CoderSettingsService. Lots of
properties and some models were introduced only to inject data during
tests.
- among other issues, test related properties were leaking in the
business code and there was no clear definition
between the readable and writable interface. With this PR we have
CoderSettingsStore exposing read+write, CoderSettings exposing reads +
PluginSettingsStore the underlying persistable store.
- the tests control data via an instance of PluginSettingsStore just
like the business code
- some of the options that did not make sense to be configurable and
were only used in the tests were removed:
  - setupCommand
  - ignoreSetupFailures

- two settings are now also exposed and configurable in the UI
(previously only from tests):
  - ssh log dir
  - ssh extra arguments to the proxy command

- resolves #40
- resolves #46

Author: fioan89

build.gradle.kts

@@ -71,7 +71,7 @@ val extension = ExtensionJson(
 
     version = properties("version"),
     meta = ExtensionJsonMeta(
-        name = "Coder Toolbox",
+        name = "Coder",
         description = "Connects your JetBrains IDE to Coder workspaces",
         vendor = "Coder",
         url = "https://github.com/coder/coder-jetbrains-toolbox-plugin",
@@ -145,7 +145,8 @@ fun CopySpec.fromCompileDependencies() {
                     "core-api",
                     "ui-api",
                     "annotations",
-                    "localization-api"
+                    "localization-api",
+                    "slf4j-api"
                 ).any { file.name.contains(it) }
             }
         },

src/main/kotlin/com/coder/toolbox/CoderRemoteEnvironment.kt

@@ -123,7 +123,12 @@ class CoderRemoteEnvironment(
      * have to do is provide it a host name.
      */
     override suspend
-    fun getContentsView(): EnvironmentContentsView = EnvironmentView(client.url, workspace, agent)
+    fun getContentsView(): EnvironmentContentsView = EnvironmentView(
+        context.settingsStore.readOnly(),
+        client.url,
+        workspace,
+        agent
+    )
 
     override val connectionRequest: MutableStateFlow<Boolean>? = MutableStateFlow(false)
 

src/main/kotlin/com/coder/toolbox/CoderRemoteProvider.kt

@@ -3,10 +3,7 @@ package com.coder.toolbox
 import com.coder.toolbox.cli.CoderCLIManager
 import com.coder.toolbox.sdk.CoderRestClient
 import com.coder.toolbox.sdk.v2.models.WorkspaceStatus
-import com.coder.toolbox.services.CoderSecretsService
-import com.coder.toolbox.services.CoderSettingsService
-import com.coder.toolbox.settings.CoderSettings
-import com.coder.toolbox.settings.Source
+import com.coder.toolbox.settings.SettingSource
 import com.coder.toolbox.util.CoderProtocolHandler
 import com.coder.toolbox.util.DialogUi
 import com.coder.toolbox.views.Action
@@ -46,12 +43,11 @@ class CoderRemoteProvider(
     private var pollJob: Job? = null
     private var lastEnvironments: Set<CoderRemoteEnvironment>? = null
 
+    private val cSettings = context.settingsStore.readOnly()
+
     // Create our services from the Toolbox ones.
-    private val settingsService = CoderSettingsService(context.settingsStore)
-    private val settings: CoderSettings = CoderSettings(settingsService, context.logger)
-    private val secrets: CoderSecretsService = CoderSecretsService(context.secretsStore)
-    private val settingsPage: CoderSettingsPage = CoderSettingsPage(context, settingsService)
-    private val dialogUi = DialogUi(context, settings)
+    private val settingsPage: CoderSettingsPage = CoderSettingsPage(context)
+    private val dialogUi = DialogUi(context)
 
     // The REST client, if we are signed in
     private var client: CoderRestClient? = null
@@ -65,7 +61,7 @@ class CoderRemoteProvider(
     private var firstRun = true
     private val isInitialized: MutableStateFlow<Boolean> = MutableStateFlow(false)
     private var coderHeaderPage = NewEnvironmentPage(context, context.i18n.pnotr(getDeploymentURL()?.first ?: ""))
-    private val linkHandler = CoderProtocolHandler(context, settings, httpClient, dialogUi, isInitialized)
+    private val linkHandler = CoderProtocolHandler(context, httpClient, dialogUi, isInitialized)
     override val environments: MutableStateFlow<LoadableState<List<RemoteProviderEnvironment>>> = MutableStateFlow(
         LoadableState.Value(emptyList())
     )
@@ -151,7 +147,7 @@ class CoderRemoteProvider(
     private fun logout() {
         // Keep the URL and token to make it easy to log back in, but set
         // rememberMe to false so we do not try to automatically log in.
-        secrets.rememberMe = "false"
+        context.secrets.rememberMe = "false"
         close()
     }
 
@@ -272,9 +268,9 @@ class CoderRemoteProvider(
             // When coming back to the application, authenticate immediately.
             val autologin = shouldDoAutoLogin()
             var autologinEx: Exception? = null
-            secrets.lastToken.let { lastToken ->
-                secrets.lastDeploymentURL.let { lastDeploymentURL ->
-                    if (autologin && lastDeploymentURL.isNotBlank() && (lastToken.isNotBlank() || !settings.requireTokenAuth)) {
+            context.secrets.lastToken.let { lastToken ->
+                context.secrets.lastDeploymentURL.let { lastDeploymentURL ->
+                    if (autologin && lastDeploymentURL.isNotBlank() && (lastToken.isNotBlank() || !cSettings.requireTokenAuth)) {
                         try {
                             return createConnectPage(URL(lastDeploymentURL), lastToken)
                         } catch (ex: Exception) {
@@ -309,7 +305,7 @@ class CoderRemoteProvider(
         return null
     }
 
-    private fun shouldDoAutoLogin(): Boolean = firstRun && secrets.rememberMe == "true"
+    private fun shouldDoAutoLogin(): Boolean = firstRun && context.secrets.rememberMe == "true"
 
     /**
      * Create a connect page that starts polling and resets the UI on success.
@@ -318,15 +314,14 @@ class CoderRemoteProvider(
         context,
         deploymentURL,
         token,
-        settings,
         httpClient,
         ::goToEnvironmentsPage,
     ) { client, cli ->
         // Store the URL and token for use next time.
-        secrets.lastDeploymentURL = client.url.toString()
-        secrets.lastToken = client.token ?: ""
+        context.secrets.lastDeploymentURL = client.url.toString()
+        context.secrets.lastToken = client.token ?: ""
         // Currently we always remember, but this could be made an option.
-        secrets.rememberMe = "true"
+        context.secrets.rememberMe = "true"
         this.client = client
         pollError = null
         pollJob?.cancel()
@@ -343,11 +338,11 @@ class CoderRemoteProvider(
      * 2. Token on disk for this deployment.
      * 3. Global token for Coder, if it matches the deployment.
      */
-    private fun getToken(deploymentURL: URL): Pair<String, Source>? = secrets.lastToken.let {
-        if (it.isNotBlank() && secrets.lastDeploymentURL == deploymentURL.toString()) {
-            it to Source.LAST_USED
+    private fun getToken(deploymentURL: URL): Pair<String, SettingSource>? = context.secrets.lastToken.let {
+        if (it.isNotBlank() && context.secrets.lastDeploymentURL == deploymentURL.toString()) {
+            it to SettingSource.LAST_USED
         } else {
-            settings.token(deploymentURL)
+            cSettings.token(deploymentURL)
         }
     }
 
@@ -361,11 +356,11 @@ class CoderRemoteProvider(
      * 3. CODER_URL.
      * 4. URL in global cli config.
      */
-    private fun getDeploymentURL(): Pair<String, Source>? = secrets.lastDeploymentURL.let {
+    private fun getDeploymentURL(): Pair<String, SettingSource>? = context.secrets.lastDeploymentURL.let {
         if (it.isNotBlank()) {
-            it to Source.LAST_USED
+            it to SettingSource.LAST_USED
         } else {
-            settings.defaultURL()
+            context.settingsStore.defaultURL()
         }
     }
 }

src/main/kotlin/com/coder/toolbox/CoderToolboxContext.kt

@@ -1,7 +1,7 @@
 package com.coder.toolbox
 
-import com.jetbrains.toolbox.api.core.PluginSecretStore
-import com.jetbrains.toolbox.api.core.PluginSettingsStore
+import com.coder.toolbox.store.CoderSecretsStore
+import com.coder.toolbox.store.CoderSettingsStore
 import com.jetbrains.toolbox.api.core.diagnostics.Logger
 import com.jetbrains.toolbox.api.localization.LocalizableStringFactory
 import com.jetbrains.toolbox.api.remoteDev.connection.ClientHelper
@@ -18,6 +18,6 @@ data class CoderToolboxContext(
     val cs: CoroutineScope,
     val logger: Logger,
     val i18n: LocalizableStringFactory,
-    val settingsStore: PluginSettingsStore,
-    val secretsStore: PluginSecretStore
+    val settingsStore: CoderSettingsStore,
+    val secrets: CoderSecretsStore
 )

src/main/kotlin/com/coder/toolbox/CoderToolboxExtension.kt

@@ -1,5 +1,8 @@
 package com.coder.toolbox
 
+import com.coder.toolbox.settings.Environment
+import com.coder.toolbox.store.CoderSecretsStore
+import com.coder.toolbox.store.CoderSettingsStore
 import com.jetbrains.toolbox.api.core.PluginSecretStore
 import com.jetbrains.toolbox.api.core.PluginSettingsStore
 import com.jetbrains.toolbox.api.core.ServiceLocator
@@ -20,6 +23,7 @@ import okhttp3.OkHttpClient
 class CoderToolboxExtension : RemoteDevExtension {
     // All services must be passed in here and threaded as necessary.
     override fun createRemoteProviderPluginInstance(serviceLocator: ServiceLocator): RemoteProvider {
+        val logger = serviceLocator.getService(Logger::class.java)
         return CoderRemoteProvider(
             CoderToolboxContext(
                 serviceLocator.getService(ToolboxUi::class.java),
@@ -29,8 +33,8 @@ class CoderToolboxExtension : RemoteDevExtension {
                 serviceLocator.getService(CoroutineScope::class.java),
                 serviceLocator.getService(Logger::class.java),
                 serviceLocator.getService(LocalizableStringFactory::class.java),
-                serviceLocator.getService(PluginSettingsStore::class.java),
-                serviceLocator.getService(PluginSecretStore::class.java),
+                CoderSettingsStore(serviceLocator.getService(PluginSettingsStore::class.java), Environment(), logger),
+                CoderSecretsStore(serviceLocator.getService(PluginSecretStore::class.java)),
             ),
             OkHttpClient(),
         )