fix: autologin flow can now also be canceled

- rest api is now suspendable giving a chance to the user to propagate the cancellation exception during the execution
- reset the auto-login flag once the user hits back

Author: fioan89

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

@@ -74,26 +74,35 @@ class CoderRemoteEnvironment(
         if (wsRawStatus.canStart()) {
             if (workspace.outdated) {
                 actions.add(Action(context.i18n.ptrl("Update and start")) {
-                    val build = client.updateWorkspace(workspace)
-                    update(workspace.copy(latestBuild = build), agent)
+                    context.cs.launch {
+                        val build = client.updateWorkspace(workspace)
+                        update(workspace.copy(latestBuild = build), agent)
+                    }
                 })
             } else {
                 actions.add(Action(context.i18n.ptrl("Start")) {
-                    val build = client.startWorkspace(workspace)
-                    update(workspace.copy(latestBuild = build), agent)
+                    context.cs.launch {
+                        val build = client.startWorkspace(workspace)
+                        update(workspace.copy(latestBuild = build), agent)
+
+                    }
                 })
             }
         }
         if (wsRawStatus.canStop()) {
             if (workspace.outdated) {
                 actions.add(Action(context.i18n.ptrl("Update and restart")) {
-                    val build = client.updateWorkspace(workspace)
-                    update(workspace.copy(latestBuild = build), agent)
+                    context.cs.launch {
+                        val build = client.updateWorkspace(workspace)
+                        update(workspace.copy(latestBuild = build), agent)
+                    }
                 })
             } else {
                 actions.add(Action(context.i18n.ptrl("Stop")) {
-                    val build = client.stopWorkspace(workspace)
-                    update(workspace.copy(latestBuild = build), agent)
+                    context.cs.launch {
+                        val build = client.stopWorkspace(workspace)
+                        update(workspace.copy(latestBuild = build), agent)
+                    }
                 })
             }
         }

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

@@ -175,7 +175,7 @@ class CoderRemoteProvider(
     private fun logout() {
         // Keep the URL and token to make it easy to log back in, but set
         // rememberMe to false so we do not try to automatically log in.
-        context.secrets.rememberMe = "false"
+        context.secrets.rememberMe = false
         close()
     }
 
@@ -292,7 +292,7 @@ class CoderRemoteProvider(
     /**
      * Return the sign-in page if we do not have a valid client.
 
-     * Otherwise return null, which causes Toolbox to display the environment
+     * Otherwise, return null, which causes Toolbox to display the environment
      * list.
      */
     override fun getOverrideUiPage(): UiPage? {
@@ -327,14 +327,14 @@ class CoderRemoteProvider(
         return null
     }
 
-    private fun shouldDoAutoLogin(): Boolean = firstRun && context.secrets.rememberMe == "true"
+    private fun shouldDoAutoLogin(): Boolean = firstRun && context.secrets.rememberMe == true
 
     private fun onConnect(client: CoderRestClient, cli: CoderCLIManager) {
         // Store the URL and token for use next time.
         context.secrets.lastDeploymentURL = client.url.toString()
         context.secrets.lastToken = client.token ?: ""
         // Currently we always remember, but this could be made an option.
-        context.secrets.rememberMe = "true"
+        context.secrets.rememberMe = true
         this.client = client
         pollError = null
         pollJob?.cancel()

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

@@ -139,7 +139,7 @@ open class CoderRestClient(
      *
      * @throws [APIResponseException].
      */
-    fun authenticate(): User {
+    suspend fun authenticate(): User {
         me = me()
         buildVersion = buildInfo().version
         return me
@@ -149,8 +149,8 @@ open class CoderRestClient(
      * Retrieve the current user.
      * @throws [APIResponseException].
      */
-    fun me(): User {
-        val userResponse = retroRestClient.me().execute()
+    suspend fun me(): User {
+        val userResponse = retroRestClient.me()
         if (!userResponse.isSuccessful) {
             throw APIResponseException("authenticate", url, userResponse)
         }
@@ -162,8 +162,8 @@ open class CoderRestClient(
      * Retrieves the available workspaces created by the user.
      * @throws [APIResponseException].
      */
-    fun workspaces(): List<Workspace> {
-        val workspacesResponse = retroRestClient.workspaces("owner:me").execute()
+    suspend fun workspaces(): List<Workspace> {
+        val workspacesResponse = retroRestClient.workspaces("owner:me")
         if (!workspacesResponse.isSuccessful) {
             throw APIResponseException("retrieve workspaces", url, workspacesResponse)
         }
@@ -175,8 +175,8 @@ open class CoderRestClient(
      * Retrieves a workspace with the provided id.
      * @throws [APIResponseException].
      */
-    fun workspace(workspaceID: UUID): Workspace {
-        val workspacesResponse = retroRestClient.workspace(workspaceID).execute()
+    suspend fun workspace(workspaceID: UUID): Workspace {
+        val workspacesResponse = retroRestClient.workspace(workspaceID)
         if (!workspacesResponse.isSuccessful) {
             throw APIResponseException("retrieve workspace", url, workspacesResponse)
         }
@@ -188,7 +188,7 @@ open class CoderRestClient(
      * Retrieves all the agent names for all workspaces, including those that
      * are off.  Meant to be used when configuring SSH.
      */
-    fun agentNames(workspaces: List<Workspace>): Set<String> {
+    suspend fun agentNames(workspaces: List<Workspace>): Set<String> {
         // It is possible for there to be resources with duplicate names so we
         // need to use a set.
         return workspaces.flatMap { ws ->
@@ -205,17 +205,17 @@ open class CoderRestClient(
      * removing hosts from the SSH config when they are off).
      * @throws [APIResponseException].
      */
-    fun resources(workspace: Workspace): List<WorkspaceResource> {
+    suspend fun resources(workspace: Workspace): List<WorkspaceResource> {
         val resourcesResponse =
-            retroRestClient.templateVersionResources(workspace.latestBuild.templateVersionID).execute()
+            retroRestClient.templateVersionResources(workspace.latestBuild.templateVersionID)
         if (!resourcesResponse.isSuccessful) {
             throw APIResponseException("retrieve resources for ${workspace.name}", url, resourcesResponse)
         }
         return resourcesResponse.body()!!
     }
 
-    fun buildInfo(): BuildInfo {
-        val buildInfoResponse = retroRestClient.buildInfo().execute()
+    suspend fun buildInfo(): BuildInfo {
+        val buildInfoResponse = retroRestClient.buildInfo()
         if (!buildInfoResponse.isSuccessful) {
             throw APIResponseException("retrieve build information", url, buildInfoResponse)
         }
@@ -225,8 +225,8 @@ open class CoderRestClient(
     /**
      * @throws [APIResponseException].
      */
-    private fun template(templateID: UUID): Template {
-        val templateResponse = retroRestClient.template(templateID).execute()
+    private suspend fun template(templateID: UUID): Template {
+        val templateResponse = retroRestClient.template(templateID)
         if (!templateResponse.isSuccessful) {
             throw APIResponseException("retrieve template with ID $templateID", url, templateResponse)
         }
@@ -236,9 +236,9 @@ open class CoderRestClient(
     /**
      * @throws [APIResponseException].
      */
-    fun startWorkspace(workspace: Workspace): WorkspaceBuild {
+    suspend fun startWorkspace(workspace: Workspace): WorkspaceBuild {
         val buildRequest = CreateWorkspaceBuildRequest(null, WorkspaceTransition.START)
-        val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest).execute()
+        val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest)
         if (buildResponse.code() != HttpURLConnection.HTTP_CREATED) {
             throw APIResponseException("start workspace ${workspace.name}", url, buildResponse)
         }
@@ -247,9 +247,9 @@ open class CoderRestClient(
 
     /**
      */
-    fun stopWorkspace(workspace: Workspace): WorkspaceBuild {
+    suspend fun stopWorkspace(workspace: Workspace): WorkspaceBuild {
         val buildRequest = CreateWorkspaceBuildRequest(null, WorkspaceTransition.STOP)
-        val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest).execute()
+        val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest)
         if (buildResponse.code() != HttpURLConnection.HTTP_CREATED) {
             throw APIResponseException("stop workspace ${workspace.name}", url, buildResponse)
         }
@@ -259,9 +259,9 @@ open class CoderRestClient(
     /**
      * @throws [APIResponseException] if issues are encountered during deletion
      */
-    fun removeWorkspace(workspace: Workspace) {
+    suspend fun removeWorkspace(workspace: Workspace) {
         val buildRequest = CreateWorkspaceBuildRequest(null, WorkspaceTransition.DELETE, false)
-        val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest).execute()
+        val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest)
         if (buildResponse.code() != HttpURLConnection.HTTP_CREATED) {
             throw APIResponseException("delete workspace ${workspace.name}", url, buildResponse)
         }
@@ -277,11 +277,11 @@ open class CoderRestClient(
      *    with this information when we do two START builds in a row.
      *  @throws [APIResponseException].
      */
-    fun updateWorkspace(workspace: Workspace): WorkspaceBuild {
+    suspend fun updateWorkspace(workspace: Workspace): WorkspaceBuild {
         val template = template(workspace.templateID)
         val buildRequest =
             CreateWorkspaceBuildRequest(template.activeVersionID, WorkspaceTransition.START)
-        val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest).execute()
+        val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest)
         if (buildResponse.code() != HttpURLConnection.HTTP_CREATED) {
             throw APIResponseException("update workspace ${workspace.name}", url, buildResponse)
         }

src/main/kotlin/com/coder/toolbox/sdk/v2/CoderV2RestFacade.kt

@@ -8,7 +8,7 @@ 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.WorkspacesResponse
-import retrofit2.Call
+import retrofit2.Response
 import retrofit2.http.Body
 import retrofit2.http.GET
 import retrofit2.http.POST
@@ -21,43 +21,43 @@ interface CoderV2RestFacade {
      * Retrieves details about the authenticated user.
      */
     @GET("api/v2/users/me")
-    fun me(): Call<User>
+    suspend fun me(): Response<User>
 
     /**
      * Retrieves all workspaces the authenticated user has access to.
      */
     @GET("api/v2/workspaces")
-    fun workspaces(
+    suspend fun workspaces(
         @Query("q") searchParams: String,
-    ): Call<WorkspacesResponse>
+    ): Response<WorkspacesResponse>
 
     /**
      * Retrieves a workspace with the provided id.
      */
     @GET("api/v2/workspaces/{workspaceID}")
-    fun workspace(
+    suspend fun workspace(
         @Path("workspaceID") workspaceID: UUID
-    ): Call<Workspace>
+    ): Response<Workspace>
 
     @GET("api/v2/buildinfo")
-    fun buildInfo(): Call<BuildInfo>
+    suspend fun buildInfo(): Response<BuildInfo>
 
     /**
      * Queues a new build to occur for a workspace.
      */
     @POST("api/v2/workspaces/{workspaceID}/builds")
-    fun createWorkspaceBuild(
+    suspend fun createWorkspaceBuild(
         @Path("workspaceID") workspaceID: UUID,
         @Body createWorkspaceBuildRequest: CreateWorkspaceBuildRequest,
-    ): Call<WorkspaceBuild>
+    ): Response<WorkspaceBuild>
 
     @GET("api/v2/templates/{templateID}")
-    fun template(
+    suspend fun template(
         @Path("templateID") templateID: UUID,
-    ): Call<Template>
+    ): Response<Template>
 
     @GET("api/v2/templateversions/{templateID}/resources")
-    fun templateVersionResources(
+    suspend fun templateVersionResources(
         @Path("templateID") templateID: UUID,
-    ): Call<List<WorkspaceResource>>
+    ): Response<List<WorkspaceResource>>
 }

src/main/kotlin/com/coder/toolbox/store/CoderSecretsStore.kt

@@ -23,7 +23,7 @@ class CoderSecretsStore(private val store: PluginSecretStore) {
     var lastToken: String
         get() = get("last-token")
         set(value) = set("last-token", value)
-    var rememberMe: String
-        get() = get("remember-me")
-        set(value) = set("remember-me", value)
+    var rememberMe: Boolean
+        get() = get("remember-me").toBoolean()
+        set(value) = set("remember-me", value.toString())
 }

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

@@ -12,15 +12,17 @@ import kotlinx.coroutines.flow.update
 
 class AuthWizardPage(
     private val context: CoderToolboxContext,
-    private val isAutoLogin: Boolean = false,
+    initialAutoLogin: Boolean = false,
     onConnect: (
         client: CoderRestClient,
         cli: CoderCLIManager,
     ) -> Unit,
 ) : CoderPage(context, context.i18n.ptrl("Authenticate to Coder")) {
+    private val shouldAutoLogin = MutableStateFlow(initialAutoLogin)
+
     private val signInStep = SignInStep(context)
     private val tokenStep = TokenStep(context)
-    private val connectStep = ConnectStep(context, this::notify, onConnect)
+    private val connectStep = ConnectStep(context, shouldAutoLogin, this::notify, onConnect)
 
 
     /**
@@ -78,10 +80,9 @@ class AuthWizardPage(
                 actionButtons.update {
                     listOf(
                         Action(context.i18n.ptrl("Back"), closesPage = false, actionBlock = {
-                            if (isAutoLogin) {
-                                AuthWizardState.resetSteps()
-                            } else {
-                                connectStep.onBack()
+                            connectStep.onBack()
+                            shouldAutoLogin.update {
+                                false
                             }
                             displaySteps()
                         })

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

@@ -12,6 +12,7 @@ import com.jetbrains.toolbox.api.ui.components.LabelField
 import com.jetbrains.toolbox.api.ui.components.RowGroup
 import com.jetbrains.toolbox.api.ui.components.ValidationErrorField
 import kotlinx.coroutines.Job
+import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.yield
@@ -24,6 +25,7 @@ private const val USER_HIT_THE_BACK_BUTTON = "User hit the back button"
  */
 class ConnectStep(
     private val context: CoderToolboxContext,
+    private val shouldAutoLogin: StateFlow<Boolean>,
     private val notify: (String, Throwable) -> Unit,
     private val onConnect: (
         client: CoderRestClient,
@@ -70,6 +72,7 @@ class ConnectStep(
         signInJob?.cancel()
         signInJob = context.cs.launch {
             try {
+                statusField.textState.update { (context.i18n.ptrl("Authenticating to ${url.host}...")) }
                 // The http client Toolbox gives us is already set up with the
                 // proxy config, so we do net need to explicitly add it.
                 val client = CoderRestClient(
@@ -91,15 +94,15 @@ class ConnectStep(
                     yield()
                     cli.login(client.token)
                 }
+                statusField.textState.update { (context.i18n.ptrl("Successfully configured ${url.host}...")) }
                 // allows interleaving with the back/cancel action
                 yield()
                 onConnect(client, cli)
                 AuthWizardState.resetSteps()
             } catch (ex: CancellationException) {
-                if (ex.message == USER_HIT_THE_BACK_BUTTON) {
-                    return@launch
+                if (ex.message != USER_HIT_THE_BACK_BUTTON) {
+                    notify("Connection to ${url.host} was configured", ex)
                 }
-                notify("Connection to ${url.host} was configured", ex)
             } catch (ex: Exception) {
                 notify("Failed to configure ${url.host}", ex)
             }
@@ -114,7 +117,12 @@ class ConnectStep(
         try {
             signInJob?.cancel(CancellationException(USER_HIT_THE_BACK_BUTTON))
         } finally {
-            AuthWizardState.goToPreviousStep()
+            if (shouldAutoLogin.value) {
+                AuthWizardState.resetSteps()
+                context.secrets.rememberMe = false
+            } else {
+                AuthWizardState.goToPreviousStep()
+            }
         }
     }
 }