coder · mafredri · Jan 27, 2023 · Jan 27, 2023 · Jan 27, 2023 · Jan 27, 2023
diff --git a/cli/cliui/agent.go b/cli/cliui/agent.go
@@ -45,7 +45,7 @@ func Agent(ctx context.Context, writer io.Writer, opts AgentOptions) error {
 	// We don't take the fast path for opts.NoWait yet because we want to
 	// show the message.
 	if agent.Status == codersdk.WorkspaceAgentConnected &&
-		(!agent.DelayLoginUntilReady || agent.LifecycleState == codersdk.WorkspaceAgentLifecycleReady) {
+		(agent.LoginBeforeReady || agent.LifecycleState == codersdk.WorkspaceAgentLifecycleReady) {
 		return nil
 	}
 
@@ -93,7 +93,7 @@ func Agent(ctx context.Context, writer io.Writer, opts AgentOptions) error {
 	// we do this just before starting the spinner to avoid needless
 	// spinning.
 	if agent.Status == codersdk.WorkspaceAgentConnected &&
-		agent.DelayLoginUntilReady && opts.NoWait {
+		!agent.LoginBeforeReady && opts.NoWait {
 		showMessage()
 		return nil
 	}
@@ -137,7 +137,7 @@ func Agent(ctx context.Context, writer io.Writer, opts AgentOptions) error {
 			// NOTE(mafredri): Once we have access to the workspace agent's
 			// startup script logs, we can show them here.
 			// https://github.com/coder/coder/issues/2957
-			if agent.DelayLoginUntilReady && !opts.NoWait {
+			if !agent.LoginBeforeReady && !opts.NoWait {
 				switch agent.LifecycleState {
 				case codersdk.WorkspaceAgentLifecycleReady:
 					return nil

diff --git a/cli/cliui/agent_test.go b/cli/cliui/agent_test.go
@@ -30,7 +30,8 @@ func TestAgent(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status: codersdk.WorkspaceAgentDisconnected,
+						Status:           codersdk.WorkspaceAgentDisconnected,
+						LoginBeforeReady: true,
 					}
 					if disconnected.Load() {
 						agent.Status = codersdk.WorkspaceAgentConnected
@@ -73,6 +74,7 @@ func TestAgent_TimeoutWithTroubleshootingURL(t *testing.T) {
 					agent := codersdk.WorkspaceAgent{
 						Status:             codersdk.WorkspaceAgentConnecting,
 						TroubleshootingURL: wantURL,
+						LoginBeforeReady:   true,
 					}
 					switch {
 					case !connected.Load() && timeout.Load():
@@ -119,10 +121,10 @@ func TestAgent_StartupTimeout(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:               codersdk.WorkspaceAgentConnecting,
-						DelayLoginUntilReady: true,
-						LifecycleState:       codersdk.WorkspaceAgentLifecycleCreated,
-						TroubleshootingURL:   wantURL,
+						Status:             codersdk.WorkspaceAgentConnecting,
+						LoginBeforeReady:   false,
+						LifecycleState:     codersdk.WorkspaceAgentLifecycleCreated,
+						TroubleshootingURL: wantURL,
 					}
 
 					if s := status.Load(); s != "" {
@@ -177,10 +179,10 @@ func TestAgent_StartErrorExit(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:               codersdk.WorkspaceAgentConnecting,
-						DelayLoginUntilReady: true,
-						LifecycleState:       codersdk.WorkspaceAgentLifecycleCreated,
-						TroubleshootingURL:   wantURL,
+						Status:             codersdk.WorkspaceAgentConnecting,
+						LoginBeforeReady:   false,
+						LifecycleState:     codersdk.WorkspaceAgentLifecycleCreated,
+						TroubleshootingURL: wantURL,
 					}
 
 					if s := status.Load(); s != "" {
@@ -232,10 +234,10 @@ func TestAgent_NoWait(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:               codersdk.WorkspaceAgentConnecting,
-						DelayLoginUntilReady: true,
-						LifecycleState:       codersdk.WorkspaceAgentLifecycleCreated,
-						TroubleshootingURL:   wantURL,
+						Status:             codersdk.WorkspaceAgentConnecting,
+						LoginBeforeReady:   false,
+						LifecycleState:     codersdk.WorkspaceAgentLifecycleCreated,
+						TroubleshootingURL: wantURL,
 					}
 
 					if s := status.Load(); s != "" {
@@ -284,7 +286,7 @@ func TestAgent_NoWait(t *testing.T) {
 	require.NoError(t, <-done, "ready - should exit early")
 }
 
-func TestAgent_DelayLoginUntilReadyDisabled(t *testing.T) {
+func TestAgent_LoginBeforeReadyEnabled(t *testing.T) {
 	t.Parallel()
 
 	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
@@ -301,10 +303,10 @@ func TestAgent_DelayLoginUntilReadyDisabled(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:               codersdk.WorkspaceAgentConnecting,
-						DelayLoginUntilReady: false,
-						LifecycleState:       codersdk.WorkspaceAgentLifecycleCreated,
-						TroubleshootingURL:   wantURL,
+						Status:             codersdk.WorkspaceAgentConnecting,
+						LoginBeforeReady:   true,
+						LifecycleState:     codersdk.WorkspaceAgentLifecycleCreated,
+						TroubleshootingURL: wantURL,
 					}
 
 					if s := status.Load(); s != "" {

diff --git a/cli/cliui/resources_test.go b/cli/cliui/resources_test.go
@@ -26,6 +26,7 @@ func TestWorkspaceResources(t *testing.T) {
 				Agents: []codersdk.WorkspaceAgent{{
 					Name:            "dev",
 					Status:          codersdk.WorkspaceAgentConnected,
+					LifecycleState:  codersdk.WorkspaceAgentLifecycleCreated,
 					Architecture:    "amd64",
 					OperatingSystem: "linux",
 				}},
@@ -60,6 +61,7 @@ func TestWorkspaceResources(t *testing.T) {
 				Agents: []codersdk.WorkspaceAgent{{
 					CreatedAt:       database.Now().Add(-10 * time.Second),
 					Status:          codersdk.WorkspaceAgentConnecting,
+					LifecycleState:  codersdk.WorkspaceAgentLifecycleCreated,
 					Name:            "dev",
 					OperatingSystem: "linux",
 					Architecture:    "amd64",
@@ -70,12 +72,14 @@ func TestWorkspaceResources(t *testing.T) {
 				Name:       "dev",
 				Agents: []codersdk.WorkspaceAgent{{
 					Status:          codersdk.WorkspaceAgentConnected,
+					LifecycleState:  codersdk.WorkspaceAgentLifecycleReady,
 					Name:            "go",
 					Architecture:    "amd64",
 					OperatingSystem: "linux",
 				}, {
 					DisconnectedAt:  &disconnected,
 					Status:          codersdk.WorkspaceAgentDisconnected,
+					LifecycleState:  codersdk.WorkspaceAgentLifecycleReady,
 					Name:            "postgres",
 					Architecture:    "amd64",
 					OperatingSystem: "linux",

diff --git a/cli/ssh.go b/cli/ssh.go
@@ -250,7 +250,7 @@ func ssh() *cobra.Command {
 	cliflag.BoolVarP(cmd.Flags(), &forwardGPG, "forward-gpg", "G", "CODER_SSH_FORWARD_GPG", false, "Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on both the client and workspace. The GPG agent must already be running locally and will not be started for you. If a GPG agent is already running in the workspace, it will be attempted to be killed.")
 	cliflag.StringVarP(cmd.Flags(), &identityAgent, "identity-agent", "", "CODER_SSH_IDENTITY_AGENT", "", "Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled")
 	cliflag.DurationVarP(cmd.Flags(), &wsPollInterval, "workspace-poll-interval", "", "CODER_WORKSPACE_POLL_INTERVAL", workspacePollInterval, "Specifies how often to poll for workspace automated shutdown.")
-	cliflag.BoolVarP(cmd.Flags(), &noWait, "no-wait", "", "CODER_SSH_NO_WAIT", false, "Specifies whether to wait for a workspace to become ready before logging in (only applicable when the delay login until ready option is enabled). Note that the workspace agent may still be in the process of executing the startup script and the workspace may be in an incomplete state.")
+	cliflag.BoolVarP(cmd.Flags(), &noWait, "no-wait", "", "CODER_SSH_NO_WAIT", false, "Specifies whether to wait for a workspace to become ready before logging in (only applicable when the login before ready option has not been enabled). Note that the workspace agent may still be in the process of executing the startup script and the workspace may be in an incomplete state.")
 	return cmd
 }
 

diff --git a/cli/testdata/coder_ssh_--help.golden b/cli/testdata/coder_ssh_--help.golden
@@ -22,8 +22,8 @@ Flags:
                                            Consumes $CODER_SSH_IDENTITY_AGENT
       --no-wait                            Specifies whether to wait for a workspace to become
                                            ready before logging in (only applicable when the
-                                           delay login until ready option is enabled). Note
-                                           that the workspace agent may still be in the
+                                           login before ready option has not been enabled).
+                                           Note that the workspace agent may still be in the
                                            process of executing the startup script and the
                                            workspace may be in an incomplete state.
                                            Consumes $CODER_SSH_NO_WAIT

diff --git a/cmd/cliui/main.go b/cmd/cliui/main.go
@@ -163,7 +163,8 @@ func main() {
 		Use: "agent",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			agent := codersdk.WorkspaceAgent{
-				Status: codersdk.WorkspaceAgentDisconnected,
+				Status:         codersdk.WorkspaceAgentDisconnected,
+				LifecycleState: codersdk.WorkspaceAgentLifecycleReady,
 			}
 			go func() {
 				time.Sleep(3 * time.Second)
@@ -203,6 +204,7 @@ func main() {
 				Agents: []codersdk.WorkspaceAgent{{
 					CreatedAt:       database.Now().Add(-10 * time.Second),
 					Status:          codersdk.WorkspaceAgentConnecting,
+					LifecycleState:  codersdk.WorkspaceAgentLifecycleCreated,
 					Name:            "dev",
 					OperatingSystem: "linux",
 					Architecture:    "amd64",
@@ -213,12 +215,14 @@ func main() {
 				Name:       "dev",
 				Agents: []codersdk.WorkspaceAgent{{
 					Status:          codersdk.WorkspaceAgentConnected,
+					LifecycleState:  codersdk.WorkspaceAgentLifecycleReady,
 					Name:            "go",
 					Architecture:    "amd64",
 					OperatingSystem: "linux",
 				}, {
 					DisconnectedAt:  &disconnected,
 					Status:          codersdk.WorkspaceAgentDisconnected,
+					LifecycleState:  codersdk.WorkspaceAgentLifecycleReady,
 					Name:            "postgres",
 					Architecture:    "amd64",
 					OperatingSystem: "linux",

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/.../000093_add_workspace_agent_invert_delay_login_until_ready_to_login_before_ready.down.sql b/.../000093_add_workspace_agent_invert_delay_login_until_ready_to_login_before_ready.down.sql
@@ -0,0 +1,8 @@
+BEGIN;
+ALTER TABLE workspace_agents RENAME COLUMN login_before_ready TO delay_login_until_ready;
+ALTER TABLE workspace_agents ALTER COLUMN delay_login_until_ready SET DEFAULT false;
+
+UPDATE workspace_agents SET delay_login_until_ready = NOT delay_login_until_ready;
+
+COMMENT ON COLUMN workspace_agents.delay_login_until_ready IS 'If true, the agent will delay logins until it is ready (e.g. executing startup script has ended).';
+COMMIT;
diff --git a/...ns/000093_add_workspace_agent_invert_delay_login_until_ready_to_login_before_ready.up.sql b/...ns/000093_add_workspace_agent_invert_delay_login_until_ready_to_login_before_ready.up.sql
@@ -0,0 +1,8 @@
+BEGIN;
+ALTER TABLE workspace_agents RENAME COLUMN delay_login_until_ready TO login_before_ready;
+ALTER TABLE workspace_agents ALTER COLUMN login_before_ready SET DEFAULT true;
+
+UPDATE workspace_agents SET login_before_ready = NOT login_before_ready;
+
+COMMENT ON COLUMN workspace_agents.login_before_ready IS 'If true, the agent will not prevent login before it is ready (e.g. startup script is still executing).';
+COMMIT;
diff --git a/coderd/database/models.go b/coderd/database/models.go