impl: wait for workspace to be running

- starts and waits for the workspace to be running before showing the env page
- improved error handling

Author: fioan89

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

@@ -169,6 +169,19 @@ open class CoderRestClient(
         return workspacesResponse.body()!!.workspaces
     }
 
+    /**
+     * Retrieves a workspace with the provided id.
+     * @throws [APIResponseException].
+     */
+    fun workspace(workspaceID: UUID): Workspace {
+        val workspacesResponse = retroRestClient.workspace(workspaceID).execute()
+        if (!workspacesResponse.isSuccessful) {
+            throw APIResponseException("retrieve workspace", url, workspacesResponse)
+        }
+
+        return workspacesResponse.body()!!
+    }
+
     /**
      * Retrieves all the agent names for all workspaces, including those that
      * are off.  Meant to be used when configuring SSH.

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

@@ -4,6 +4,7 @@ import com.coder.toolbox.sdk.v2.models.BuildInfo
 import com.coder.toolbox.sdk.v2.models.CreateWorkspaceBuildRequest
 import com.coder.toolbox.sdk.v2.models.Template
 import com.coder.toolbox.sdk.v2.models.User
+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
@@ -30,6 +31,14 @@ interface CoderV2RestFacade {
         @Query("q") searchParams: String,
     ): Call<WorkspacesResponse>
 
+    /**
+     * Retrieves a workspace with the provided id.
+     */
+    @GET("api/v2/workspaces/{workspaceID}")
+    fun workspace(
+        @Path("workspaceID") workspaceID: UUID
+    ): Call<Workspace>
+
     @GET("api/v2/buildinfo")
     fun buildInfo(): Call<BuildInfo>
 

src/main/kotlin/com/coder/toolbox/util/CoderProtocolHandler.kt

@@ -10,14 +10,20 @@ import com.coder.toolbox.sdk.v2.models.Workspace
 import com.coder.toolbox.sdk.v2.models.WorkspaceAgent
 import com.coder.toolbox.sdk.v2.models.WorkspaceStatus
 import com.coder.toolbox.settings.CoderSettings
+import kotlinx.coroutines.TimeoutCancellationException
+import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.filter
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.time.withTimeout
 import kotlinx.coroutines.yield
 import okhttp3.OkHttpClient
 import java.net.HttpURLConnection
 import java.net.URI
 import java.net.URL
+import kotlin.time.Duration.Companion.minutes
+import kotlin.time.Duration.Companion.seconds
+import kotlin.time.toJavaDuration
 
 open class CoderProtocolHandler(
     private val context: CoderToolboxContext,
@@ -81,29 +87,27 @@ open class CoderProtocolHandler(
 
         when (workspace.latestBuild.status) {
             WorkspaceStatus.PENDING, WorkspaceStatus.STARTING ->
-                // TODO: Wait for the workspace to turn on.
-                throw IllegalArgumentException(
-                    "The workspace \"$workspaceName\" is ${
-                        workspace.latestBuild.status.toString().lowercase()
-                    }; please wait then try again",
-                )
+                if (restClient.waitForReady(workspace) != true) {
+                    context.logger.error("$workspaceName from $deploymentURL could not be ready on time")
+                    context.ui.showErrorInfoPopup(MissingArgumentException("Can't handle URI because workspace $workspaceName could not be ready on time"))
+                    return
+                }
 
             WorkspaceStatus.STOPPING, WorkspaceStatus.STOPPED,
-            WorkspaceStatus.CANCELING, WorkspaceStatus.CANCELED,
-                ->
-                // TODO: Turn on the workspace.
-                throw IllegalArgumentException(
-                    "The workspace \"$workspaceName\" is ${
-                        workspace.latestBuild.status.toString().lowercase()
-                    }; please start the workspace and try again",
-                )
+            WorkspaceStatus.CANCELING, WorkspaceStatus.CANCELED -> {
+                restClient.startWorkspace(workspace)
+                if (restClient.waitForReady(workspace) != true) {
+                    context.logger.error("$workspaceName from $deploymentURL could not be started on time")
+                    context.ui.showErrorInfoPopup(MissingArgumentException("Can't handle URI because workspace $workspaceName could not be started on time"))
+                    return
+                }
+            }
 
-            WorkspaceStatus.FAILED, WorkspaceStatus.DELETING, WorkspaceStatus.DELETED ->
-                throw IllegalArgumentException(
-                    "The workspace \"$workspaceName\" is ${
-                        workspace.latestBuild.status.toString().lowercase()
-                    }; unable to connect",
-                )
+            WorkspaceStatus.FAILED, WorkspaceStatus.DELETING, WorkspaceStatus.DELETED -> {
+                context.logger.error("Unable to connect to $workspaceName from $deploymentURL")
+                context.ui.showErrorInfoPopup(MissingArgumentException("Can't handle URI because because we're unable to connect to workspace $workspaceName"))
+                return
+            }
 
             WorkspaceStatus.RUNNING -> Unit // All is well
         }
@@ -157,6 +161,21 @@ open class CoderProtocolHandler(
         }
     }
 
+    private suspend fun CoderRestClient.waitForReady(workspace: Workspace): Boolean {
+        var status = workspace.latestBuild.status
+        try {
+            withTimeout(2.minutes.toJavaDuration()) {
+                while (status != WorkspaceStatus.RUNNING) {
+                    delay(1.seconds)
+                    status = this@waitForReady.workspace(workspace.id).latestBuild.status
+                }
+            }
+            return true
+        } catch (_: TimeoutCancellationException) {
+            return false
+        }
+    }
+
     private suspend fun askUrl(): String? {
         context.ui.showWindow()
         context.envPageManager.showPluginEnvironmentsPage(false)