refactor: deprecate login_before_ready in favor of startup_script_behavior (#7837)

Fixes #7758

cli/cliui/agent.go

@@ -48,7 +48,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.LoginBeforeReady || agent.LifecycleState == codersdk.WorkspaceAgentLifecycleReady) {
+		(agent.StartupScriptBehavior == codersdk.WorkspaceAgentStartupScriptBehaviorNonBlocking || agent.LifecycleState == codersdk.WorkspaceAgentLifecycleReady) {
 		return nil
 	}
 
@@ -96,7 +96,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.LoginBeforeReady && opts.NoWait {
+		agent.StartupScriptBehavior == codersdk.WorkspaceAgentStartupScriptBehaviorBlocking && opts.NoWait {
 		showMessage()
 		return nil
 	}
@@ -140,7 +140,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.LoginBeforeReady && !opts.NoWait {
+			if agent.StartupScriptBehavior == codersdk.WorkspaceAgentStartupScriptBehaviorBlocking && !opts.NoWait {
 				switch agent.LifecycleState {
 				case codersdk.WorkspaceAgentLifecycleReady:
 					return nil

cli/cliui/agent_test.go

@@ -30,8 +30,8 @@ func TestAgent(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:           codersdk.WorkspaceAgentDisconnected,
-						LoginBeforeReady: true,
+						Status:                codersdk.WorkspaceAgentDisconnected,
+						StartupScriptBehavior: codersdk.WorkspaceAgentStartupScriptBehaviorNonBlocking,
 					}
 					if disconnected.Load() {
 						agent.Status = codersdk.WorkspaceAgentConnected
@@ -73,9 +73,9 @@ func TestAgent_TimeoutWithTroubleshootingURL(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:             codersdk.WorkspaceAgentConnecting,
-						TroubleshootingURL: wantURL,
-						LoginBeforeReady:   true,
+						Status:                codersdk.WorkspaceAgentConnecting,
+						TroubleshootingURL:    wantURL,
+						StartupScriptBehavior: codersdk.WorkspaceAgentStartupScriptBehaviorNonBlocking,
 					}
 					switch {
 					case !connected.Load() && timeout.Load():
@@ -124,10 +124,10 @@ func TestAgent_StartupTimeout(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:             codersdk.WorkspaceAgentConnecting,
-						LoginBeforeReady:   false,
-						LifecycleState:     codersdk.WorkspaceAgentLifecycleCreated,
-						TroubleshootingURL: wantURL,
+						Status:                codersdk.WorkspaceAgentConnecting,
+						StartupScriptBehavior: codersdk.WorkspaceAgentStartupScriptBehaviorBlocking,
+						LifecycleState:        codersdk.WorkspaceAgentLifecycleCreated,
+						TroubleshootingURL:    wantURL,
 					}
 
 					if s := status.Load(); s != "" {
@@ -183,10 +183,10 @@ func TestAgent_StartErrorExit(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:             codersdk.WorkspaceAgentConnecting,
-						LoginBeforeReady:   false,
-						LifecycleState:     codersdk.WorkspaceAgentLifecycleCreated,
-						TroubleshootingURL: wantURL,
+						Status:                codersdk.WorkspaceAgentConnecting,
+						StartupScriptBehavior: codersdk.WorkspaceAgentStartupScriptBehaviorBlocking,
+						LifecycleState:        codersdk.WorkspaceAgentLifecycleCreated,
+						TroubleshootingURL:    wantURL,
 					}
 
 					if s := status.Load(); s != "" {
@@ -239,10 +239,10 @@ func TestAgent_NoWait(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:             codersdk.WorkspaceAgentConnecting,
-						LoginBeforeReady:   false,
-						LifecycleState:     codersdk.WorkspaceAgentLifecycleCreated,
-						TroubleshootingURL: wantURL,
+						Status:                codersdk.WorkspaceAgentConnecting,
+						StartupScriptBehavior: codersdk.WorkspaceAgentStartupScriptBehaviorBlocking,
+						LifecycleState:        codersdk.WorkspaceAgentLifecycleCreated,
+						TroubleshootingURL:    wantURL,
 					}
 
 					if s := status.Load(); s != "" {
@@ -292,7 +292,7 @@ func TestAgent_NoWait(t *testing.T) {
 	require.NoError(t, <-done, "ready - should exit early")
 }
 
-func TestAgent_LoginBeforeReadyEnabled(t *testing.T) {
+func TestAgent_StartupScriptBehaviorNonBlocking(t *testing.T) {
 	t.Parallel()
 
 	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
@@ -309,10 +309,10 @@ func TestAgent_LoginBeforeReadyEnabled(t *testing.T) {
 				WorkspaceName: "example",
 				Fetch: func(_ context.Context) (codersdk.WorkspaceAgent, error) {
 					agent := codersdk.WorkspaceAgent{
-						Status:             codersdk.WorkspaceAgentConnecting,
-						LoginBeforeReady:   true,
-						LifecycleState:     codersdk.WorkspaceAgentLifecycleCreated,
-						TroubleshootingURL: wantURL,
+						Status:                codersdk.WorkspaceAgentConnecting,
+						StartupScriptBehavior: codersdk.WorkspaceAgentStartupScriptBehaviorNonBlocking,
+						LifecycleState:        codersdk.WorkspaceAgentLifecycleCreated,
+						TroubleshootingURL:    wantURL,
 					}
 
 					if s := status.Load(); s != "" {

cli/ssh.go

@@ -350,7 +350,7 @@ func (r *RootCmd) ssh() *clibase.Cmd {
 		{
 			Flag:        "no-wait",
 			Env:         "CODER_SSH_NO_WAIT",
-			Description: "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.",
+			Description: "Specifies whether to wait for a workspace to become ready before logging in (only applicable when the startup script behavior is blocking). 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.",
 			Value:       clibase.BoolOf(&noWait),
 		},
 		{

cli/testdata/coder_ssh_--help.golden

@@ -26,9 +26,9 @@ Start a shell into a workspace
 
       --no-wait bool, $CODER_SSH_NO_WAIT
           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
+          logging in (only applicable when the startup script behavior is
+          blocking). 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.
 
       --stdio bool, $CODER_SSH_STDIO