Move CLI init into background process

This lets you see the initialization progress so if it hangs due to a
timeout for example you are not stuck on the main screen while it
completes.

Next step is probably to make it cancelable.

As a side effect this does change the flow a little; if the token is
invalid/expired we now always show the token dialog again.  I think that
could be a good change anyway though.

Because showing the dialog again results in the browser window opening
repeatedly I made it only open the first time and added a link so they
can open it themselves if they do need a new token.  I also show the
current token so users can validate the bad token.

Also added an error log for when the connection times out.

Author: code-asher

src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt

@@ -75,6 +75,7 @@ import java.awt.event.MouseListener
 import java.awt.event.MouseMotionListener
 import java.awt.font.TextAttribute
 import java.awt.font.TextAttribute.UNDERLINE_ON
+import java.net.SocketTimeoutException
 import javax.swing.Icon
 import javax.swing.JTable
 import javax.swing.JTextField
@@ -214,12 +215,12 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
                 tfUrl = textField().resizableColumn().horizontalAlign(HorizontalAlign.FILL).gap(RightGap.SMALL).bindText(localWizardModel::coderURL).applyToComponent {
                     addActionListener {
                         poller?.cancel()
-                        askTokenAndOpenSession()
+                        askTokenAndOpenSession(true)
                     }
                 }.component
                 button(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.connect.text")) {
                     poller?.cancel()
-                    askTokenAndOpenSession()
+                    askTokenAndOpenSession(true)
                 }.applyToComponent {
                     background = WelcomeScreenUIManager.getMainAssociatedComponentBackground()
                 }
@@ -316,25 +317,7 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
                 localWizardModel.coderURL = url
                 localWizardModel.token = token
                 tfUrl?.text = url
-
-                poller?.cancel()
-                try {
-                    coderClient.initClientSession(url.toURL(), token)
-                    loginAndLoadWorkspace(token)
-                } catch (e: Exception) {
-                    when (e) {
-                        is AuthenticationResponseException -> {
-                            // probably the token is expired
-                            askTokenAndOpenSession()
-                        }
-
-                        else -> {
-                            logger.warn("An exception was encountered while opening ${localWizardModel.coderURL}. Reason: ${e.message}")
-                            localWizardModel.token = ""
-                        }
-                    }
-
-                }
+                loginAndLoadWorkspace(token, true)
             }
         }
         updateWorkspaceActions()
@@ -372,49 +355,44 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
         ActivityTracker.getInstance().inc()
     }
 
-    private fun askTokenAndOpenSession() {
+    private fun askTokenAndOpenSession(openBrowser: Boolean) {
         // force bindings to be filled
         component.apply()
 
-        val pastedToken = askToken()
+        val pastedToken = askToken(openBrowser)
         if (pastedToken.isNullOrBlank()) {
             return
         }
-        loginAndLoadWorkspace(pastedToken)
+        // False so that subsequent authentication failures do not keep opening
+        // the browser as it was already opened earlier.
+        loginAndLoadWorkspace(pastedToken, false)
     }
 
-    private fun loginAndLoadWorkspace(token: String) {
-        try {
-            coderClient.initClientSession(localWizardModel.coderURL.toURL(), token)
-            if (!CoderSemVer.isValidVersion(coderClient.buildVersion)) {
-                notificationBanner.apply {
-                    component.isVisible = true
-                    showWarning(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.invalid.coder.version", coderClient.buildVersion))
-                }
-            } else {
-                val coderVersion = CoderSemVer.parse(coderClient.buildVersion)
-                if (!coderVersion.isInClosedRange(CoderSupportedVersions.minCompatibleCoderVersion, CoderSupportedVersions.maxCompatibleCoderVersion)) {
-                    notificationBanner.apply {
-                        component.isVisible = true
-                        showWarning(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.unsupported.coder.version", coderClient.buildVersion))
-                    }
-                }
+    private fun loginAndLoadWorkspace(token: String, openBrowser: Boolean) {
+        LifetimeDefinition().launchUnderBackgroundProgress(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.cli.downloader.dialog.title"), canBeCancelled = false, isIndeterminate = true) {
+            this.indicator.apply {
+                text = "Authenticating..."
             }
-        } catch (e: AuthenticationResponseException) {
-            logger.error("Could not authenticate on ${localWizardModel.coderURL}. Reason $e")
-            return
-        }
-        appPropertiesService.setValue(CODER_URL_KEY, localWizardModel.coderURL)
-        appPropertiesService.setValue(SESSION_TOKEN, token)
-        val cliManager = CoderCLIManager(localWizardModel.coderURL.toURL(), coderClient.buildVersion)
 
-        localWizardModel.apply {
-            this.token = token
-            buildVersion = coderClient.buildVersion
-            localCliPath = cliManager.localCli.toAbsolutePath().toString()
-        }
+            try {
+                authenticate(token)
+            } catch (e: AuthenticationResponseException) {
+                logger.error("Unable to authenticate to ${localWizardModel.coderURL}; has your token expired?", e)
+                askTokenAndOpenSession(openBrowser)
+                return@launchUnderBackgroundProgress
+            } catch (e: SocketTimeoutException) {
+                logger.error("Unable to connect to ${localWizardModel.coderURL}; is it up?", e)
+                return@launchUnderBackgroundProgress
+            }
+
+            val cliManager = CoderCLIManager(localWizardModel.coderURL.toURL(), coderClient.buildVersion)
+
+            localWizardModel.apply {
+                this.token = token
+                buildVersion = coderClient.buildVersion
+                localCliPath = cliManager.localCli.toAbsolutePath().toString()
+            }
 
-        LifetimeDefinition().launchUnderBackgroundProgress(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.cli.downloader.dialog.title"), canBeCancelled = false, isIndeterminate = true) {
             this.indicator.apply {
                 isIndeterminate = false
                 text = "Retrieving Workspaces..."
@@ -458,15 +436,18 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
         }
     }
 
-    private fun askToken(): String? {
-        BrowserUtil.browse(localWizardModel.coderURL.toURL().withPath("/login?redirect=%2Fcli-auth"))
+    private fun askToken(openBrowser: Boolean): String? {
+        val getTokenUrl = localWizardModel.coderURL.toURL().withPath("/login?redirect=%2Fcli-auth")
+        if (openBrowser) {
+            BrowserUtil.browse(getTokenUrl)
+        }
         return invokeAndWaitIfNeeded(ModalityState.any()) {
             lateinit var sessionTokenTextField: JBTextField
 
             val panel = panel {
                 row {
-                    label(CoderGatewayBundle.message("gateway.connector.view.login.token.label"))
-                    sessionTokenTextField = textField().applyToComponent {
+                    browserLink(CoderGatewayBundle.message("gateway.connector.view.login.token.label"), getTokenUrl.toString())
+                    sessionTokenTextField = textField().bindText(localWizardModel::token).applyToComponent {
                         minimumSize = Dimension(320, -1)
                     }.component
                 }
@@ -491,6 +472,33 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
         }
     }
 
+    /**
+     * Check that the token is valid for the URL in the wizard and throw if not.
+     * On success store the URL and token and display warning banners if
+     * versions do not match.
+     */
+    private fun authenticate(token: String) {
+        coderClient.initClientSession(localWizardModel.coderURL.toURL(), token)
+
+        if (!CoderSemVer.isValidVersion(coderClient.buildVersion)) {
+            notificationBanner.apply {
+                component.isVisible = true
+                showWarning(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.invalid.coder.version", coderClient.buildVersion))
+            }
+        } else {
+            val coderVersion = CoderSemVer.parse(coderClient.buildVersion)
+            if (!coderVersion.isInClosedRange(CoderSupportedVersions.minCompatibleCoderVersion, CoderSupportedVersions.maxCompatibleCoderVersion)) {
+                notificationBanner.apply {
+                    component.isVisible = true
+                    showWarning(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.unsupported.coder.version", coderClient.buildVersion))
+                }
+            }
+        }
+
+        appPropertiesService.setValue(CODER_URL_KEY, localWizardModel.coderURL)
+        appPropertiesService.setValue(SESSION_TOKEN, token)
+    }
+
     private suspend fun loadWorkspaces() {
         val ws = withContext(Dispatchers.IO) {
             val timeBeforeRequestingWorkspaces = System.currentTimeMillis()
@@ -809,4 +817,4 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
     companion object {
         val logger = Logger.getInstance(CoderWorkspacesStepView::class.java.simpleName)
     }
-}
+}