Check the agent's status #232

code-asher · 2023-04-25T21:41:59Z

Some more information in the individual commits.

Interestingly this may also improve the perception of how long it takes to select an editor because the time waiting for the agent will be spent on the initial connect screen rather than the select editor screen.

Looks like there is already a property that is the composite of the two fields we were checking.

code-asher · 2023-04-25T21:42:40Z

src/main/kotlin/com/coder/gateway/models/WorkspaceAndAgentStatus.kt

+    // We want to check that the workspace is `running`, the agent is
+    // `connected`, and the agent lifecycle state is `ready` to ensure the best
+    // possible scenario for attempting a connection.
+    //
+    // We can also choose to allow `start_timeout` and `start_error` for the
+    // agent state; this means the startup script did not successfully complete
+    // but the agent will accept SSH connections.
+    //
+    // Lastly we can also allow connections when the agent lifecycle state is
+    // `starting` if `login_before_ready` is true on the workspace response.
+    //
+    // Note that latest_build.status is derived from latest_build.job.status and
+    // latest_build.job.transition so there is no need to check those.
+    companion object {
+        fun from(workspace: Workspace, agent: WorkspaceAgent? = null) = when (workspace.latestBuild.status) {
+            WorkspaceStatus.PENDING -> QUEUED
+            WorkspaceStatus.STARTING -> STARTING
+            WorkspaceStatus.RUNNING -> when (agent?.status) {
+                WorkspaceAgentStatus.CONNECTED -> when (agent.lifecycleState) {
+                    WorkspaceAgentLifecycleState.CREATED -> CREATED
+                    WorkspaceAgentLifecycleState.STARTING -> if (agent.loginBeforeReady == true) AGENT_STARTING_READY else AGENT_STARTING
+                    WorkspaceAgentLifecycleState.START_TIMEOUT -> START_TIMEOUT
+                    WorkspaceAgentLifecycleState.START_ERROR -> START_ERROR
+                    WorkspaceAgentLifecycleState.READY -> READY
+                    WorkspaceAgentLifecycleState.SHUTTING_DOWN -> SHUTTING_DOWN
+                    WorkspaceAgentLifecycleState.SHUTDOWN_TIMEOUT -> SHUTDOWN_TIMEOUT
+                    WorkspaceAgentLifecycleState.SHUTDOWN_ERROR -> SHUTDOWN_ERROR
+                    WorkspaceAgentLifecycleState.OFF -> OFF
+                }
+
+                WorkspaceAgentStatus.DISCONNECTED -> DISCONNECTED
+                WorkspaceAgentStatus.TIMEOUT -> TIMEOUT
+                WorkspaceAgentStatus.CONNECTING -> CONNECTING
+                else -> RUNNING
+            }
+
+            WorkspaceStatus.STOPPING -> STOPPING
+            WorkspaceStatus.STOPPED -> STOPPED
+            WorkspaceStatus.FAILED -> FAILED
+            WorkspaceStatus.CANCELING -> CANCELING
+            WorkspaceStatus.CANCELED -> CANCELED
+            WorkspaceStatus.DELETING -> DELETING
+            WorkspaceStatus.DELETED -> DELETED
+        }


@mafredri does this look right to you?

I use this computed state to determine whether to enable the connect button:

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

Lines 135 to 139 in 664c383

val ready = listOf(

WorkspaceAndAgentStatus.READY, WorkspaceAndAgentStatus.START_ERROR,

WorkspaceAndAgentStatus.START_TIMEOUT, WorkspaceAndAgentStatus.AGENT_STARTING_READY

).contains(selectedObject?.agentStatus)

setNextButtonEnabled(ready && selectedObject?.agentOS == OS.LINUX)

Yep, it looks mostly correct 👍. The start timeout behaves a bit different so needs some extra consideration but didn't spot any other issues.

We can just check if the list is empty then add the workspace-only "agent" model rather than duplicate the block.

Previously we only checked the workspace, now we also check the agent. Should help ensure we only connect when the connection will succeed.

code-asher · 2023-04-25T22:37:07Z

src/main/kotlin/com/coder/gateway/models/WorkspaceAndAgentStatus.kt

+ * WorkspaceAndAgentStatus represents the combined status of a single agent and
+ * its workspace (or just the workspace if there are no agents).
+ */
+enum class WorkspaceAndAgentStatus(val label: String, val description: String) {


Something feels a bit off to me about this, like maybe we should just have the workspace status and agent status and check both whenever we need to rather than have this computed state but my thoughts about it are a bit fuzzy and we already had it architectured like this so I left it for now.

src/main/kotlin/com/coder/gateway/models/WorkspaceAndAgentStatus.kt

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

mafredri · 2023-04-26T07:44:04Z

src/main/kotlin/com/coder/gateway/models/WorkspaceAndAgentStatus.kt

+    // We want to check that the workspace is `running`, the agent is
+    // `connected`, and the agent lifecycle state is `ready` to ensure the best
+    // possible scenario for attempting a connection.
+    //
+    // We can also choose to allow `start_timeout` and `start_error` for the
+    // agent state; this means the startup script did not successfully complete
+    // but the agent will accept SSH connections.
+    //
+    // Lastly we can also allow connections when the agent lifecycle state is
+    // `starting` if `login_before_ready` is true on the workspace response.
+    //
+    // Note that latest_build.status is derived from latest_build.job.status and
+    // latest_build.job.transition so there is no need to check those.
+    companion object {
+        fun from(workspace: Workspace, agent: WorkspaceAgent? = null) = when (workspace.latestBuild.status) {
+            WorkspaceStatus.PENDING -> QUEUED
+            WorkspaceStatus.STARTING -> STARTING
+            WorkspaceStatus.RUNNING -> when (agent?.status) {
+                WorkspaceAgentStatus.CONNECTED -> when (agent.lifecycleState) {
+                    WorkspaceAgentLifecycleState.CREATED -> CREATED
+                    WorkspaceAgentLifecycleState.STARTING -> if (agent.loginBeforeReady == true) AGENT_STARTING_READY else AGENT_STARTING
+                    WorkspaceAgentLifecycleState.START_TIMEOUT -> START_TIMEOUT
+                    WorkspaceAgentLifecycleState.START_ERROR -> START_ERROR
+                    WorkspaceAgentLifecycleState.READY -> READY
+                    WorkspaceAgentLifecycleState.SHUTTING_DOWN -> SHUTTING_DOWN
+                    WorkspaceAgentLifecycleState.SHUTDOWN_TIMEOUT -> SHUTDOWN_TIMEOUT
+                    WorkspaceAgentLifecycleState.SHUTDOWN_ERROR -> SHUTDOWN_ERROR
+                    WorkspaceAgentLifecycleState.OFF -> OFF
+                }
+
+                WorkspaceAgentStatus.DISCONNECTED -> DISCONNECTED
+                WorkspaceAgentStatus.TIMEOUT -> TIMEOUT
+                WorkspaceAgentStatus.CONNECTING -> CONNECTING
+                else -> RUNNING
+            }
+
+            WorkspaceStatus.STOPPING -> STOPPING
+            WorkspaceStatus.STOPPED -> STOPPED
+            WorkspaceStatus.FAILED -> FAILED
+            WorkspaceStatus.CANCELING -> CANCELING
+            WorkspaceStatus.CANCELED -> CANCELED
+            WorkspaceStatus.DELETING -> DELETING
+            WorkspaceStatus.DELETED -> DELETED
+        }


Yep, it looks mostly correct 👍. The start timeout behaves a bit different so needs some extra consideration but didn't spot any other issues.

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

These mean the script is still running and is taking longer than expected. Also we can connect with login_before_ready when in the start_timeout state.

I think it still has a chance to connect so this wording makes that clearer.

mafredri

Nice, LGTM!

Simplify workspace status check

ed37ab0

Looks like there is already a property that is the composite of the two fields we were checking.

code-asher commented Apr 25, 2023

View reviewed changes

code-asher added 2 commits April 25, 2023 14:01

Simplify agent model list

3b06d9f

We can just check if the list is empty then add the workspace-only "agent" model rather than duplicate the block.

Add lifecycle_state and login_before_ready to agent response

9b787c7

code-asher force-pushed the ready-state branch from 10bdacc to c59feac Compare April 25, 2023 22:06

code-asher added 4 commits April 25, 2023 14:16

Check agent status

9ab8769

Previously we only checked the workspace, now we also check the agent. Should help ensure we only connect when the connection will succeed.

Remove unused expressions

5f31f55

Add tooltips to describe the status

176d868

Simplify some borders

d5abf2b

code-asher force-pushed the ready-state branch from c59feac to d5abf2b Compare April 25, 2023 22:16

code-asher marked this pull request as ready for review April 25, 2023 22:33

code-asher requested review from johnstcn and mafredri April 25, 2023 22:33

code-asher commented Apr 25, 2023

View reviewed changes

mafredri reviewed Apr 26, 2023

View reviewed changes

johnstcn reviewed Apr 26, 2023

View reviewed changes

src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt Outdated Show resolved Hide resolved

code-asher force-pushed the ready-state branch from fcc6863 to 4ec0a7a Compare April 26, 2023 17:44

code-asher added 2 commits April 26, 2023 09:45

Fix start/shutdown timeout status

596934c

These mean the script is still running and is taking longer than expected. Also we can connect with login_before_ready when in the start_timeout state.

Extract ready logic to WorkspaceAndAgentStatus

a70a32b

code-asher force-pushed the ready-state branch from 4ec0a7a to a70a32b Compare April 26, 2023 17:46

Change agent timeout description

55e4a61

I think it still has a chance to connect so this wording makes that clearer.

code-asher requested a review from mafredri April 26, 2023 18:07

mafredri approved these changes Apr 26, 2023

View reviewed changes

code-asher merged commit d2a3649 into main Apr 26, 2023

code-asher deleted the ready-state branch April 26, 2023 19:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Check the agent's status #232

Check the agent's status #232

Uh oh!

code-asher commented Apr 25, 2023 •

edited

Loading

Uh oh!

code-asher Apr 25, 2023 •

edited

Loading

Uh oh!

mafredri Apr 26, 2023

Uh oh!

code-asher Apr 25, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mafredri Apr 26, 2023

Uh oh!

Uh oh!

mafredri left a comment

Uh oh!

Uh oh!

	val ready = listOf(
	WorkspaceAndAgentStatus.READY, WorkspaceAndAgentStatus.START_ERROR,
	WorkspaceAndAgentStatus.START_TIMEOUT, WorkspaceAndAgentStatus.AGENT_STARTING_READY
	).contains(selectedObject?.agentStatus)
	setNextButtonEnabled(ready && selectedObject?.agentOS == OS.LINUX)

Check the agent's status #232

Check the agent's status #232

Uh oh!

Conversation

code-asher commented Apr 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

code-asher Apr 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mafredri Apr 26, 2023

Choose a reason for hiding this comment

Uh oh!

code-asher Apr 25, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mafredri Apr 26, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mafredri left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

code-asher commented Apr 25, 2023 •

edited

Loading

code-asher Apr 25, 2023 •

edited

Loading