custom exception class for setup command

Author: kirillk

src/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt

@@ -161,25 +161,38 @@ class CoderRemoteConnectionHandle {
                 )
                 logger.info("Adding ${parameters.ideName} for ${parameters.hostname}:${parameters.projectPath} to recent connections")
                 recentConnectionsService.addRecentConnection(parameters.toRecentWorkspaceConnection())
+            } catch (e: CoderSetupCommandException) {
+                logger.error("Failed to run setup command", e)
+                showConnectionErrorMessage(
+                    e.message ?: "Unknown error",
+                    "gateway.connector.coder.setup-command.failed",
+                )
             } catch (e: Exception) {
                 if (isCancellation(e)) {
                     logger.info("Connection canceled due to ${e.javaClass.simpleName}")
                 } else {
                     logger.error("Failed to connect (will not retry)", e)
-                    // The dialog will close once we return so write the error
-                    // out into a new dialog.
-                    ApplicationManager.getApplication().invokeAndWait {
-                        Messages.showMessageDialog(
-                            e.message ?: e.javaClass.simpleName ?: "Aborted",
-                            CoderGatewayBundle.message("gateway.connector.coder.connection.failed"),
-                            Messages.getErrorIcon(),
-                        )
-                    }
+                    showConnectionErrorMessage(
+                        e.message ?: e.javaClass.simpleName ?: "Aborted",
+                        "gateway.connector.coder.connection.failed"
+                    )
                 }
             }
         }
     }
 
+    // The dialog will close once we return so write the error
+    // out into a new dialog.
+    private fun showConnectionErrorMessage(message: String, titleKey: String) {
+        ApplicationManager.getApplication().invokeAndWait {
+            Messages.showMessageDialog(
+                message,
+                CoderGatewayBundle.message(titleKey),
+                Messages.getErrorIcon(),
+            )
+        }
+    }
+
     /**
      * Return a new (non-EAP) IDE if we should update.
      */
@@ -521,6 +534,7 @@ class CoderRemoteConnectionHandle {
 
     companion object {
         val logger = Logger.getInstance(CoderRemoteConnectionHandle::class.java.simpleName)
+        @Throws(CoderSetupCommandException::class)
         fun processSetupCommand(
             ignoreSetupFailure: Boolean,
             execCommand: () -> String
@@ -533,11 +547,11 @@ class CoderRemoteConnectionHandle {
                     ?.let { it.substring(it.indexOf(GATEWAY_SETUP_COMMAND_ERROR) + GATEWAY_SETUP_COMMAND_ERROR.length).trim() }
 
                 if (!errorText.isNullOrBlank()) {
-                    throw Exception(errorText)
+                    throw CoderSetupCommandException(errorText)
                 }
             } catch (ex: Exception) {
                 if (!ignoreSetupFailure) {
-                    throw ex
+                    throw CoderSetupCommandException(ex.message ?: "Unknown error", ex)
                 }
             }
         }

src/main/kotlin/com/coder/gateway/CoderSetupCommandException.kt

@@ -0,0 +1,7 @@
+package com.coder.gateway
+
+class CoderSetupCommandException : Exception {
+
+    constructor(message: String) : super(message)
+    constructor(message: String, cause: Throwable) : super(message, cause)
+}

src/main/resources/messages/CoderGatewayBundle.properties

@@ -49,6 +49,7 @@ gateway.connector.coder.connection.provider.title=Connecting to Coder workspace.
 gateway.connector.coder.connecting=Connecting...
 gateway.connector.coder.connecting.retry=Connecting (attempt {0})...
 gateway.connector.coder.connection.failed=Failed to connect
+gateway.connector.coder.setup-command.failed=Failed to set up
 gateway.connector.coder.connecting.failed.retry=Failed to connect...retrying {0}
 gateway.connector.settings.data-directory.title=Data directory
 gateway.connector.settings.data-directory.comment=Directories are created \

src/test/kotlin/com/coder/gateway/util/SetupCommandTest.kt

@@ -1,6 +1,7 @@
 package com.coder.gateway.util
 
 import com.coder.gateway.CoderRemoteConnectionHandle.Companion.processSetupCommand
+import com.coder.gateway.CoderSetupCommandException
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertThrows
 import kotlin.test.assertEquals
@@ -11,7 +12,7 @@ internal class SetupCommandTest {
     fun executionErrors() {
         assertEquals(
             "Execution error",
-            assertThrows<Exception> {
+            assertThrows<CoderSetupCommandException> {
                 processSetupCommand(false) { throw Exception("Execution error") }
             }.message
         )
@@ -22,7 +23,7 @@ internal class SetupCommandTest {
     fun setupScriptError() {
         assertEquals(
             "Your IDE is expired, please update",
-            assertThrows<Exception> {
+            assertThrows<CoderSetupCommandException> {
                 processSetupCommand(false) {
                     """
                 execution line 1