chore: refactor the error reporter

fioan89 · fioan89 · commit 7bbc1618a6b4 · 2025-09-01T23:09:19.000+03:00
diff --git a/src/main/kotlin/com/coder/toolbox/views/CoderCliSetupWizardPage.kt b/src/main/kotlin/com/coder/toolbox/views/CoderCliSetupWizardPage.kt
@@ -3,22 +3,19 @@ package com.coder.toolbox.views
 import com.coder.toolbox.CoderToolboxContext
 import com.coder.toolbox.cli.CoderCLIManager
 import com.coder.toolbox.sdk.CoderRestClient
-import com.coder.toolbox.sdk.ex.APIResponseException
 import com.coder.toolbox.views.state.CoderCliSetupWizardState
 import com.coder.toolbox.views.state.WizardStep
 import com.jetbrains.toolbox.api.remoteDev.ProviderVisibilityState
 import com.jetbrains.toolbox.api.ui.actions.RunnableActionDescription
 import com.jetbrains.toolbox.api.ui.components.UiField
-import kotlinx.coroutines.CoroutineName
 import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.update
-import kotlinx.coroutines.launch
-import java.util.UUID
 
 class CoderCliSetupWizardPage(
     private val context: CoderToolboxContext,
     private val settingsPage: CoderSettingsPage,
-    private val visibilityState: MutableStateFlow<ProviderVisibilityState>,
+    visibilityState: StateFlow<ProviderVisibilityState>,
     initialAutoSetup: Boolean = false,
     jumpToMainPageOnError: Boolean = false,
     onConnect: suspend (
@@ -31,33 +28,28 @@ class CoderCliSetupWizardPage(
         context.ui.showUiPage(settingsPage)
     })
 
-    private val deploymentUrlStep = DeploymentUrlStep(context, this::notify)
+    private val deploymentUrlStep = DeploymentUrlStep(context, visibilityState)
     private val tokenStep = TokenStep(context)
     private val connectStep = ConnectStep(
         context,
         shouldAutoLogin = shouldAutoSetup,
         jumpToMainPageOnError,
-        this::notify,
+        visibilityState,
         this::displaySteps,
         onConnect
     )
+    private val errorReporter = ErrorReporter.create(context, visibilityState, this.javaClass)
 
     /**
      * Fields for this page, displayed in order.
      */
     override val fields: MutableStateFlow<List<UiField>> = MutableStateFlow(emptyList())
     override val actionButtons: MutableStateFlow<List<RunnableActionDescription>> = MutableStateFlow(emptyList())
 
-    private val errorBuffer = mutableListOf<Throwable>()
 
     override fun beforeShow() {
         displaySteps()
-        if (errorBuffer.isNotEmpty() && visibilityState.value.applicationVisible) {
-            errorBuffer.forEach {
-                showError(it)
-            }
-            errorBuffer.clear()
-        }
+        errorReporter.flush()
     }
 
     private fun displaySteps() {
@@ -124,30 +116,5 @@ class CoderCliSetupWizardPage(
     /**
      * Show an error as a popup on this page.
      */
-    fun notify(logPrefix: String, ex: Throwable) {
-        context.logger.error(ex, logPrefix)
-        if (!visibilityState.value.applicationVisible) {
-            context.logger.debug("Toolbox is not yet visible, scheduling error to be displayed later")
-            errorBuffer.add(ex)
-            return
-        }
-        showError(ex)
-    }
-
-    private fun showError(ex: Throwable) {
-        val textError = if (ex is APIResponseException) {
-            if (!ex.reason.isNullOrBlank()) {
-                ex.reason
-            } else ex.message
-        } else ex.message
-
-        context.cs.launch(CoroutineName("Coder Setup Visual Error Reporting")) {
-            context.ui.showSnackbar(
-                UUID.randomUUID().toString(),
-                context.i18n.ptrl("Error encountered while setting up Coder"),
-                context.i18n.pnotr(textError ?: ""),
-                context.i18n.ptrl("Dismiss")
-            )
-        }
-    }
+    fun notify(message: String, ex: Throwable) = errorReporter.report(message, ex)
 }
diff --git a/src/main/kotlin/com/coder/toolbox/views/ConnectStep.kt b/src/main/kotlin/com/coder/toolbox/views/ConnectStep.kt
@@ -7,6 +7,7 @@ import com.coder.toolbox.plugin.PluginManager
 import com.coder.toolbox.sdk.CoderRestClient
 import com.coder.toolbox.views.state.CoderCliSetupContext
 import com.coder.toolbox.views.state.CoderCliSetupWizardState
+import com.jetbrains.toolbox.api.remoteDev.ProviderVisibilityState
 import com.jetbrains.toolbox.api.ui.components.LabelField
 import com.jetbrains.toolbox.api.ui.components.RowGroup
 import com.jetbrains.toolbox.api.ui.components.ValidationErrorField
@@ -27,24 +28,23 @@ class ConnectStep(
     private val context: CoderToolboxContext,
     private val shouldAutoLogin: StateFlow<Boolean>,
     private val jumpToMainPageOnError: Boolean,
-    private val notify: (String, Throwable) -> Unit,
+    visibilityState: StateFlow<ProviderVisibilityState>,
     private val refreshWizard: () -> Unit,
-    private val onConnect: suspend (
-        client: CoderRestClient,
-        cli: CoderCLIManager,
-    ) -> Unit,
+    private val onConnect: suspend (client: CoderRestClient, cli: CoderCLIManager) -> Unit,
 ) : WizardStep {
     private var signInJob: Job? = null
 
     private val statusField = LabelField(context.i18n.pnotr(""))
     private val errorField = ValidationErrorField(context.i18n.pnotr(""))
+    private val errorReporter = ErrorReporter.create(context, visibilityState, this.javaClass)
 
     override val panel: RowGroup = RowGroup(
         RowGroup.RowField(statusField),
         RowGroup.RowField(errorField)
     )
 
     override fun onVisible() {
+        errorReporter.flush()
         errorField.textState.update {
             context.i18n.pnotr("")
         }
@@ -114,12 +114,12 @@ class ConnectStep(
                 context.envPageManager.showPluginEnvironmentsPage()
             } catch (ex: CancellationException) {
                 if (ex.message != USER_HIT_THE_BACK_BUTTON) {
-                    notify("Connection to $hostName was configured", ex)
+                    errorReporter.report("Connection to $hostName was configured", ex)
                     handleNavigation()
                     refreshWizard()
                 }
             } catch (ex: Exception) {
-                notify("Failed to configure $hostName", ex)
+                errorReporter.report("Failed to configure $hostName", ex)
                 handleNavigation()
                 refreshWizard()
             }
diff --git a/src/main/kotlin/com/coder/toolbox/views/DeploymentUrlStep.kt b/src/main/kotlin/com/coder/toolbox/views/DeploymentUrlStep.kt
@@ -6,13 +6,15 @@ import com.coder.toolbox.util.toURL
 import com.coder.toolbox.util.validateStrictWebUrl
 import com.coder.toolbox.views.state.CoderCliSetupContext
 import com.coder.toolbox.views.state.CoderCliSetupWizardState
+import com.jetbrains.toolbox.api.remoteDev.ProviderVisibilityState
 import com.jetbrains.toolbox.api.ui.components.CheckboxField
 import com.jetbrains.toolbox.api.ui.components.LabelField
 import com.jetbrains.toolbox.api.ui.components.LabelStyleType
 import com.jetbrains.toolbox.api.ui.components.RowGroup
 import com.jetbrains.toolbox.api.ui.components.TextField
 import com.jetbrains.toolbox.api.ui.components.TextType
 import com.jetbrains.toolbox.api.ui.components.ValidationErrorField
+import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.update
 import java.net.MalformedURLException
 import java.net.URL
@@ -25,9 +27,11 @@ import java.net.URL
  */
 class DeploymentUrlStep(
     private val context: CoderToolboxContext,
-    private val notify: (String, Throwable) -> Unit
+    visibilityState: StateFlow<ProviderVisibilityState>,
 ) :
     WizardStep {
+    private val errorReporter = ErrorReporter.create(context, visibilityState, this.javaClass)
+
     private val urlField = TextField(context.i18n.ptrl("Deployment URL"), "", TextType.General)
     private val emptyLine = LabelField(context.i18n.pnotr(""), LabelStyleType.Normal)
 
@@ -66,6 +70,7 @@ class DeploymentUrlStep(
         signatureFallbackStrategyField.checkedState.update {
             context.settingsStore.fallbackOnCoderForSignatures.isAllowed()
         }
+        errorReporter.flush()
     }
 
     override fun onNext(): Boolean {
@@ -78,7 +83,7 @@ class DeploymentUrlStep(
         try {
             CoderCliSetupContext.url = validateRawUrl(url)
         } catch (e: MalformedURLException) {
-            notify("URL is invalid", e)
+            errorReporter.report("URL is invalid", e)
             return false
         }
         if (context.settingsStore.requireTokenAuth) {
diff --git a/src/main/kotlin/com/coder/toolbox/views/ErrorReporter.kt b/src/main/kotlin/com/coder/toolbox/views/ErrorReporter.kt
@@ -0,0 +1,73 @@
+package com.coder.toolbox.views
+
+import com.coder.toolbox.CoderToolboxContext
+import com.coder.toolbox.sdk.ex.APIResponseException
+import com.jetbrains.toolbox.api.remoteDev.ProviderVisibilityState
+import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.launch
+import java.util.UUID
+
+sealed class ErrorReporter {
+
+    /**
+     * Logs and show errors as popups.
+     */
+    abstract fun report(message: String, ex: Throwable)
+
+    /**
+     * Processes any buffered errors when the application becomes visible.
+     */
+    abstract fun flush()
+
+    companion object {
+        fun create(
+            context: CoderToolboxContext,
+            visibilityState: StateFlow<ProviderVisibilityState>,
+            callerClass: Class<*>
+        ): ErrorReporter = ErrorReporterImpl(context, visibilityState, callerClass)
+    }
+}
+
+private class ErrorReporterImpl(
+    private val context: CoderToolboxContext,
+    private val visibilityState: StateFlow<ProviderVisibilityState>,
+    private val callerClass: Class<*>
+) : ErrorReporter() {
+    private val errorBuffer = mutableListOf<Throwable>()
+
+    override fun report(message: String, ex: Throwable) {
+        context.logger.error(ex, "[${callerClass.simpleName}] $message")
+        if (!visibilityState.value.applicationVisible) {
+            context.logger.debug("Toolbox is not yet visible, scheduling error to be displayed later")
+            errorBuffer.add(ex)
+            return
+        }
+        showError(ex)
+    }
+
+    private fun showError(ex: Throwable) {
+        val textError = if (ex is APIResponseException) {
+            if (!ex.reason.isNullOrBlank()) {
+                ex.reason
+            } else ex.message
+        } else ex.message ?: ex.toString()
+        context.cs.launch {
+            context.ui.showSnackbar(
+                UUID.randomUUID().toString(),
+                context.i18n.ptrl("Error encountered while setting up Coder"),
+                context.i18n.pnotr(textError ?: ""),
+                context.i18n.ptrl("Dismiss")
+            )
+        }
+    }
+
+
+    override fun flush() {
+        if (errorBuffer.isNotEmpty() && visibilityState.value.applicationVisible) {
+            errorBuffer.forEach {
+                showError(it)
+            }
+            errorBuffer.clear()
+        }
+    }
+}
