impl: rework the settings models

- too much confusion around CoderSettings, CoderSettingsState, CoderSettingsService
- lots of properties and some models were introduced only to inject data during tests
- test related properties were leaking in the business code and there was no clear definition
  between the readable and writable interface
- with this commit 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
- 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
- some of the options that did not make sense to be configurable and were only used in the tests were removed:
  - setupCommand
  - ignoreSetupFailures
- these two are Gateway specific

Author: fioan89

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

@@ -3,8 +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.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
@@ -44,10 +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 settings: CoderSettings = CoderSettings(context.settings, context.logger)
     private val settingsPage: CoderSettingsPage = CoderSettingsPage(context)
-    private val dialogUi = DialogUi(context, settings)
+    private val dialogUi = DialogUi(context)
 
     // The REST client, if we are signed in
     private var client: CoderRestClient? = null
@@ -61,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())
     )
@@ -270,7 +270,7 @@ class CoderRemoteProvider(
             var autologinEx: Exception? = null
             context.secrets.lastToken.let { lastToken ->
                 context.secrets.lastDeploymentURL.let { lastDeploymentURL ->
-                    if (autologin && lastDeploymentURL.isNotBlank() && (lastToken.isNotBlank() || !settings.requireTokenAuth)) {
+                    if (autologin && lastDeploymentURL.isNotBlank() && (lastToken.isNotBlank() || !cSettings.requireTokenAuth)) {
                         try {
                             return createConnectPage(URL(lastDeploymentURL), lastToken)
                         } catch (ex: Exception) {
@@ -314,7 +314,6 @@ class CoderRemoteProvider(
         context,
         deploymentURL,
         token,
-        settings,
         httpClient,
         ::goToEnvironmentsPage,
     ) { client, cli ->
@@ -339,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>? = context.secrets.lastToken.let {
+    private fun getToken(deploymentURL: URL): Pair<String, SettingSource>? = context.secrets.lastToken.let {
         if (it.isNotBlank() && context.secrets.lastDeploymentURL == deploymentURL.toString()) {
-            it to Source.LAST_USED
+            it to SettingSource.LAST_USED
         } else {
-            settings.token(deploymentURL)
+            cSettings.token(deploymentURL)
         }
     }
 
@@ -357,11 +356,11 @@ class CoderRemoteProvider(
      * 3. CODER_URL.
      * 4. URL in global cli config.
      */
-    private fun getDeploymentURL(): Pair<String, Source>? = context.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.coder.toolbox.services.CoderSecretsService
-import com.coder.toolbox.services.CoderSettingsService
+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 settings: CoderSettingsService,
-    val secrets: CoderSecretsService
+    val settingsStore: CoderSettingsStore,
+    val secrets: CoderSecretsStore
 )

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

@@ -1,7 +1,8 @@
 package com.coder.toolbox
 
-import com.coder.toolbox.services.CoderSecretsService
-import com.coder.toolbox.services.CoderSettingsService
+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
@@ -22,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),
@@ -31,8 +33,8 @@ class CoderToolboxExtension : RemoteDevExtension {
                 serviceLocator.getService(CoroutineScope::class.java),
                 serviceLocator.getService(Logger::class.java),
                 serviceLocator.getService(LocalizableStringFactory::class.java),
-                CoderSettingsService(serviceLocator.getService(PluginSettingsStore::class.java)),
-                CoderSecretsService(serviceLocator.getService(PluginSecretStore::class.java)),
+                CoderSettingsStore(serviceLocator.getService(PluginSettingsStore::class.java), Environment(), logger),
+                CoderSecretsStore(serviceLocator.getService(PluginSecretStore::class.java)),
             ),
             OkHttpClient(),
         )

src/main/kotlin/com/coder/toolbox/cli/CoderCLIManager.kt

@@ -5,7 +5,6 @@ import com.coder.toolbox.cli.ex.MissingVersionException
 import com.coder.toolbox.cli.ex.ResponseException
 import com.coder.toolbox.cli.ex.SSHConfigFormatException
 import com.coder.toolbox.settings.CoderSettings
-import com.coder.toolbox.settings.CoderSettingsState
 import com.coder.toolbox.util.CoderHostnameVerifier
 import com.coder.toolbox.util.InvalidVersionException
 import com.coder.toolbox.util.OS
@@ -59,8 +58,8 @@ fun ensureCLI(
     context: CoderToolboxContext,
     deploymentURL: URL,
     buildVersion: String,
-    settings: CoderSettings,
 ): CoderCLIManager {
+    val settings = context.settingsStore.readOnly()
     val cli = CoderCLIManager(deploymentURL, context.logger, settings)
 
     // Short-circuit if we already have the expected version.  This
@@ -123,7 +122,7 @@ class CoderCLIManager(
     private val deploymentURL: URL,
     private val logger: Logger,
     // Plugin configuration.
-    private val settings: CoderSettings = CoderSettings(CoderSettingsState(), logger),
+    private val settings: CoderSettings,
     // If the binary directory is not writable, this can be used to force the
     // manager to download to the data directory instead.
     forceDownloadToData: Boolean = false,
@@ -138,7 +137,7 @@ class CoderCLIManager(
     fun download(): Boolean {
         val eTag = getBinaryETag()
         val conn = remoteBinaryURL.openConnection() as HttpURLConnection
-        if (settings.headerCommand.isNotBlank()) {
+        if (!settings.headerCommand.isNullOrBlank()) {
             val headersFromHeaderCommand = getHeaders(deploymentURL, settings.headerCommand)
             for ((key, value) in headersFromHeaderCommand) {
                 conn.setRequestProperty(key, value)
@@ -232,7 +231,7 @@ class CoderCLIManager(
      * Return the contents of the SSH config or null if it does not exist.
      */
     private fun readSSHConfig(): String? = try {
-        settings.sshConfigPath.toFile().readText()
+        Path.of(settings.sshConfigPath).toFile().readText()
     } catch (e: FileNotFoundException) {
         null
     }
@@ -264,21 +263,21 @@ class CoderCLIManager(
                 // always use the correct URL.
                 "--url",
                 escape(deploymentURL.toString()),
-                if (settings.headerCommand.isNotBlank()) "--header-command" else null,
-                if (settings.headerCommand.isNotBlank()) escapeSubcommand(settings.headerCommand) else null,
+                if (!settings.headerCommand.isNullOrBlank()) "--header-command" else null,
+                if (!settings.headerCommand.isNullOrBlank()) escapeSubcommand(settings.headerCommand) else null,
                 "ssh",
                 "--stdio",
                 if (settings.disableAutostart && feats.disableAutostart) "--disable-autostart" else null,
             )
         val proxyArgs = baseArgs + listOfNotNull(
-            if (settings.sshLogDirectory.isNotBlank()) "--log-dir" else null,
-            if (settings.sshLogDirectory.isNotBlank()) escape(settings.sshLogDirectory) else null,
+            if (!settings.sshLogDirectory.isNullOrBlank()) "--log-dir" else null,
+            if (!settings.sshLogDirectory.isNullOrBlank()) escape(settings.sshLogDirectory) else null,
             if (feats.reportWorkspaceUsage) "--usage-app=toolbox" else null,
         )
         val backgroundProxyArgs =
             baseArgs + listOfNotNull(if (feats.reportWorkspaceUsage) "--usage-app=disable" else null)
         val extraConfig =
-            if (settings.sshConfigOptions.isNotBlank()) {
+            if (!settings.sshConfigOptions.isNullOrBlank()) {
                 "\n" + settings.sshConfigOptions.prependIndent("  ")
             } else {
                 ""
@@ -379,10 +378,13 @@ class CoderCLIManager(
      */
     private fun writeSSHConfig(contents: String?) {
         if (contents != null) {
-            settings.sshConfigPath.parent.toFile().mkdirs()
-            settings.sshConfigPath.toFile().writeText(contents)
+            if (!settings.sshConfigPath.isNullOrBlank()) {
+                val sshConfPath = Path.of(settings.sshConfigPath)
+                sshConfPath.parent.toFile().mkdirs()
+                sshConfPath.toFile().writeText(contents)
+            }
             // The Coder cli will *not* create the log directory.
-            if (settings.sshLogDirectory.isNotBlank()) {
+            if (!settings.sshLogDirectory.isNullOrBlank()) {
                 Path.of(settings.sshLogDirectory).toFile().mkdirs()
             }
         }

src/main/kotlin/com/coder/toolbox/sdk/CoderRestClient.kt

@@ -15,8 +15,6 @@ import com.coder.toolbox.sdk.v2.models.Workspace
 import com.coder.toolbox.sdk.v2.models.WorkspaceBuild
 import com.coder.toolbox.sdk.v2.models.WorkspaceResource
 import com.coder.toolbox.sdk.v2.models.WorkspaceTransition
-import com.coder.toolbox.settings.CoderSettings
-import com.coder.toolbox.settings.CoderSettingsState
 import com.coder.toolbox.util.CoderHostnameVerifier
 import com.coder.toolbox.util.coderSocketFactory
 import com.coder.toolbox.util.coderTrustManagers
@@ -53,11 +51,11 @@ open class CoderRestClient(
     context: CoderToolboxContext,
     val url: URL,
     val token: String?,
-    private val settings: CoderSettings = CoderSettings(CoderSettingsState(), context.logger),
     private val proxyValues: ProxyValues? = null,
     private val pluginVersion: String = "development",
     existingHttpClient: OkHttpClient? = null,
 ) {
+    private val settings = context.settingsStore.readOnly()
     private val httpClient: OkHttpClient
     private val retroRestClient: CoderV2RestFacade