fix: NPE during error reporting (#186)

The try/catch block raised NPE in the `notify` if another exception was raised after the context containing the URL was reset - so that means an error in the onConnect handler. In addition, some of the reset steps were moved after onConnect to make sure they execute only if onConnect callback is successful. Because of the fault in how the steps were arranged, the original exception was never logged instead a misleading NPE was treated by the coroutine's exception handler.

Author: fioan89

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - improved diagnose support
 
+### Fixed
+
+- NPE during error reporting
+
 ## 0.6.3 - 2025-08-25
 
 ### Added

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

@@ -409,7 +409,6 @@ class CoderRemoteProvider(
  context.logger.info("Displaying ${client.url} in the UI")
  pollJob = poll(client, cli)
  context.logger.info("Workspace poll job created with reference $pollJob")
- context.envPageManager.showPluginEnvironmentsPage()
  }
 
 privatefun MutableStateFlow<LoadableState<List<CoderRemoteEnvironment>>>.showLoadingMessage(){

src/main/kotlin/com/coder/toolbox/views/CoderCliSetupWizardPage.kt

@@ -3,22 +3,19 @@ package com.coder.toolbox.views
 importcom.coder.toolbox.CoderToolboxContext
 importcom.coder.toolbox.cli.CoderCLIManager
 importcom.coder.toolbox.sdk.CoderRestClient
-importcom.coder.toolbox.sdk.ex.APIResponseException
 importcom.coder.toolbox.views.state.CoderCliSetupWizardState
 importcom.coder.toolbox.views.state.WizardStep
 importcom.jetbrains.toolbox.api.remoteDev.ProviderVisibilityState
 importcom.jetbrains.toolbox.api.ui.actions.RunnableActionDescription
 importcom.jetbrains.toolbox.api.ui.components.UiField
-importkotlinx.coroutines.CoroutineName
 importkotlinx.coroutines.flow.MutableStateFlow
+importkotlinx.coroutines.flow.StateFlow
 importkotlinx.coroutines.flow.update
-importkotlinx.coroutines.launch
-importjava.util.UUID
 
 classCoderCliSetupWizardPage(
 privatevalcontext:CoderToolboxContext,
 privatevalsettingsPage:CoderSettingsPage,
-privatevalvisibilityState:MutableStateFlow<ProviderVisibilityState>,
+visibilityState:StateFlow<ProviderVisibilityState>,
 initialAutoSetup:Boolean = false,
 jumpToMainPageOnError:Boolean = false,
 onConnect:suspend (
@@ -31,33 +28,28 @@ class CoderCliSetupWizardPage(
  context.ui.showUiPage(settingsPage)
  })
 
-privateval deploymentUrlStep =DeploymentUrlStep(context, this::notify)
+privateval deploymentUrlStep =DeploymentUrlStep(context, visibilityState)
 privateval tokenStep =TokenStep(context)
 privateval connectStep =ConnectStep(
  context,
  shouldAutoLogin = shouldAutoSetup,
  jumpToMainPageOnError,
-this::notify,
+visibilityState,
 this::displaySteps,
  onConnect
  )
+privateval errorReporter =ErrorReporter.create(context, visibilityState, this.javaClass)
 
 /**
  * Fields for this page, displayed in order.
 */
 overrideval fields:MutableStateFlow<List<UiField>> =MutableStateFlow(emptyList())
 overrideval actionButtons:MutableStateFlow<List<RunnableActionDescription>> =MutableStateFlow(emptyList())
 
-privateval errorBuffer = mutableListOf<Throwable>()
 
 overridefunbeforeShow(){
  displaySteps()
-if (errorBuffer.isNotEmpty() && visibilityState.value.applicationVisible){
- errorBuffer.forEach{
- showError(it)
- }
- errorBuffer.clear()
- }
+ errorReporter.flush()
  }
 
 privatefundisplaySteps(){
@@ -124,30 +116,5 @@ class CoderCliSetupWizardPage(
 /**
  * Show an error as a popup on this page.
 */
-funnotify(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)
- }
-
-privatefunshowError(ex:Throwable){
-val textError =if (ex isAPIResponseException){
-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")
- )
- }
- }
+funnotify(message:String, ex:Throwable) = errorReporter.report(message, ex)
 }

src/main/kotlin/com/coder/toolbox/views/ConnectStep.kt

@@ -7,6 +7,7 @@ import com.coder.toolbox.plugin.PluginManager
 importcom.coder.toolbox.sdk.CoderRestClient
 importcom.coder.toolbox.views.state.CoderCliSetupContext
 importcom.coder.toolbox.views.state.CoderCliSetupWizardState
+importcom.jetbrains.toolbox.api.remoteDev.ProviderVisibilityState
 importcom.jetbrains.toolbox.api.ui.components.LabelField
 importcom.jetbrains.toolbox.api.ui.components.RowGroup
 importcom.jetbrains.toolbox.api.ui.components.ValidationErrorField
@@ -27,24 +28,23 @@ class ConnectStep(
 privatevalcontext:CoderToolboxContext,
 privatevalshouldAutoLogin:StateFlow<Boolean>,
 privatevaljumpToMainPageOnError:Boolean,
-privatevalnotify: (String, Throwable) ->Unit,
+visibilityState:StateFlow<ProviderVisibilityState>,
 privatevalrefreshWizard: () ->Unit,
-privatevalonConnect:suspend (
- client: CoderRestClient,
- cli: CoderCLIManager,
- ) ->Unit,
+privatevalonConnect:suspend (client: CoderRestClient, cli: CoderCLIManager) ->Unit,
 ) : WizardStep{
 privatevar signInJob:Job?=null
 
 privateval statusField =LabelField(context.i18n.pnotr(""))
 privateval errorField =ValidationErrorField(context.i18n.pnotr(""))
+privateval errorReporter =ErrorReporter.create(context, visibilityState, this.javaClass)
 
 overrideval panel:RowGroup=RowGroup(
 RowGroup.RowField(statusField),
 RowGroup.RowField(errorField)
  )
 
 overridefunonVisible(){
+ errorReporter.flush()
  errorField.textState.update{
  context.i18n.pnotr("")
  }
@@ -73,6 +73,9 @@ class ConnectStep(
  errorField.textState.update{context.i18n.ptrl("Token is required") }
 return
  }
+// Capture the host name early for error reporting
+val hostName =CoderCliSetupContext.url!!.host
+
  signInJob?.cancel()
  signInJob = context.cs.launch(CoroutineName("Http and CLI Setup")){
 try{
@@ -100,21 +103,23 @@ class ConnectStep(
 yield()
  cli.login(client.token!!)
  }
- logAndReportProgress("Successfully configured ${CoderCliSetupContext.url!!.host}...")
+ logAndReportProgress("Successfully configured ${hostName}...")
 // allows interleaving with the back/cancel action
 yield()
-CoderCliSetupContext.reset()
-CoderCliSetupWizardState.goToFirstStep()
  context.logger.info("Connection setup done, initializing the workspace poller...")
  onConnect(client, cli)
+
+CoderCliSetupContext.reset()
+CoderCliSetupWizardState.goToFirstStep()
+ context.envPageManager.showPluginEnvironmentsPage()
  } catch (ex:CancellationException){
 if (ex.message !=USER_HIT_THE_BACK_BUTTON){
-notify("Connection to ${CoderCliSetupContext.url!!.host} was configured", ex)
+errorReporter.report("Connection to $hostName was configured", ex)
  handleNavigation()
  refreshWizard()
  }
  } catch (ex:Exception){
-notify("Failed to configure ${CoderCliSetupContext.url!!.host}", ex)
+errorReporter.report("Failed to configure $hostName", ex)
  handleNavigation()
  refreshWizard()
  }

src/main/kotlin/com/coder/toolbox/views/DeploymentUrlStep.kt

@@ -6,13 +6,15 @@ import com.coder.toolbox.util.toURL
 importcom.coder.toolbox.util.validateStrictWebUrl
 importcom.coder.toolbox.views.state.CoderCliSetupContext
 importcom.coder.toolbox.views.state.CoderCliSetupWizardState
+importcom.jetbrains.toolbox.api.remoteDev.ProviderVisibilityState
 importcom.jetbrains.toolbox.api.ui.components.CheckboxField
 importcom.jetbrains.toolbox.api.ui.components.LabelField
 importcom.jetbrains.toolbox.api.ui.components.LabelStyleType
 importcom.jetbrains.toolbox.api.ui.components.RowGroup
 importcom.jetbrains.toolbox.api.ui.components.TextField
 importcom.jetbrains.toolbox.api.ui.components.TextType
 importcom.jetbrains.toolbox.api.ui.components.ValidationErrorField
+importkotlinx.coroutines.flow.StateFlow
 importkotlinx.coroutines.flow.update
 importjava.net.MalformedURLException
 importjava.net.URL
@@ -25,9 +27,11 @@ import java.net.URL
 */
 classDeploymentUrlStep(
 privatevalcontext:CoderToolboxContext,
-privatevalnotify: (String, Throwable) ->Unit
+visibilityState:StateFlow<ProviderVisibilityState>,
 ) :
 WizardStep{
+privateval errorReporter =ErrorReporter.create(context, visibilityState, this.javaClass)
+
 privateval urlField =TextField(context.i18n.ptrl("Deployment URL"), "", TextType.General)
 privateval emptyLine =LabelField(context.i18n.pnotr(""), LabelStyleType.Normal)
 
@@ -66,6 +70,7 @@ class DeploymentUrlStep(
  signatureFallbackStrategyField.checkedState.update{
  context.settingsStore.fallbackOnCoderForSignatures.isAllowed()
  }
+ errorReporter.flush()
  }
 
 overridefunonNext(): 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)
 returnfalse
  }
 if (context.settingsStore.requireTokenAuth){

src/main/kotlin/com/coder/toolbox/views/ErrorReporter.kt

@@ -0,0 +1,73 @@
+packagecom.coder.toolbox.views
+
+importcom.coder.toolbox.CoderToolboxContext
+importcom.coder.toolbox.sdk.ex.APIResponseException
+importcom.jetbrains.toolbox.api.remoteDev.ProviderVisibilityState
+importkotlinx.coroutines.flow.StateFlow
+importkotlinx.coroutines.launch
+importjava.util.UUID
+
+sealedclassErrorReporter{
+
+/**
+ * Logs and show errors as popups.
+*/
+abstractfunreport(message:String, ex:Throwable)
+
+/**
+ * Processes any buffered errors when the application becomes visible.
+*/
+abstractfunflush()
+
+companionobject{
+funcreate(
+context:CoderToolboxContext,
+visibilityState:StateFlow<ProviderVisibilityState>,
+callerClass:Class<*>
+ ): ErrorReporter=ErrorReporterImpl(context, visibilityState, callerClass)
+ }
+}
+
+privateclassErrorReporterImpl(
+privatevalcontext:CoderToolboxContext,
+privatevalvisibilityState:StateFlow<ProviderVisibilityState>,
+privatevalcallerClass:Class<*>
+) : ErrorReporter(){
+privateval errorBuffer = mutableListOf<Throwable>()
+
+overridefunreport(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)
+ }
+
+privatefunshowError(ex:Throwable){
+val textError =if (ex isAPIResponseException){
+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")
+ )
+ }
+ }
+
+
+overridefunflush(){
+if (errorBuffer.isNotEmpty() && visibilityState.value.applicationVisible){
+ errorBuffer.forEach{
+ showError(it)
+ }
+ errorBuffer.clear()
+ }
+ }
+}