Support legacy start and stop script format

coder · kylecarbs · Sep 25, 2023 · Sep 3, 2023 · Sep 5, 2023 · Sep 5, 2023
commit 89c7af1118053e3445b1abcfbeee9b8aa94291d4
diff --git a/agent/agent.go b/agent/agent.go
@@ -976,13 +976,13 @@ func (a *agent) runDERPMapSubscriber(ctx context.Context, network *tailnet.Conn)
 }
 
 func (a *agent) runScript(ctx context.Context, script codersdk.WorkspaceAgentScript) (err error) {
-	if script.Script == "" {
+	if script.Source == "" {
 		return nil
 	}
 
 	logger := a.logger.With(slog.F("log_source", script.LogSourceDisplayName))
 
-	logger.Info(ctx, "running script", slog.F("script", script.Script))
+	logger.Info(ctx, "running script", slog.F("script", script.Source))
 	fileWriter, err := a.filesystem.OpenFile(filepath.Join(a.logDir, fmt.Sprintf("coder-%s-script.log", script.LogSourceDisplayName)), os.O_CREATE|os.O_RDWR, 0o600)
 	if err != nil {
 		return xerrors.Errorf("open %s script log file: %w", script.LogSourceDisplayName, err)
@@ -994,7 +994,7 @@ func (a *agent) runScript(ctx context.Context, script codersdk.WorkspaceAgentScr
 		}
 	}()
 
-	cmdPty, err := a.sshServer.CreateCommand(ctx, script.Script, nil)
+	cmdPty, err := a.sshServer.CreateCommand(ctx, script.Source, nil)
 	if err != nil {
 		return xerrors.Errorf("%s script: create command: %w", script.LogSourceDisplayName, err)
 	}

diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -1209,7 +1209,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, _ := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Script:     "sleep 3",
+				Source:     "sleep 3",
 				Timeout:    time.Nanosecond,
 				RunOnStart: true,
 			}},
@@ -1234,7 +1234,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, _ := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Script:     "false",
+				Source:     "false",
 				Timeout:    30 * time.Second,
 				RunOnStart: true,
 			}},
@@ -1259,7 +1259,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, _ := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Script:     "true",
+				Source:     "true",
 				Timeout:    30 * time.Second,
 				RunOnStart: true,
 			}},
@@ -1284,7 +1284,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, closer := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Script:    "sleep 3",
+				Source:    "sleep 3",
 				Timeout:   30 * time.Second,
 				RunOnStop: true,
 			}},
@@ -1325,7 +1325,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, closer := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Script:    "sleep 3",
+				Source:    "sleep 3",
 				Timeout:   time.Nanosecond,
 				RunOnStop: true,
 			}},
@@ -1367,7 +1367,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, closer := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Script:    "false",
+				Source:    "false",
 				Timeout:   30 * time.Second,
 				RunOnStop: true,
 			}},
@@ -1417,11 +1417,11 @@ func TestAgent_Lifecycle(t *testing.T) {
 				DERPMap: derpMap,
 				Scripts: []codersdk.WorkspaceAgentScript{{
 					LogSourceDisplayName: "startup",
-					Script:               "echo 1",
+					Source:               "echo 1",
 					RunOnStart:           true,
 				}, {
 					LogSourceDisplayName: "shutdown",
-					Script:               "echo " + expected,
+					Source:               "echo " + expected,
 					RunOnStop:            true,
 				}},
 			},

diff --git a/agent/agentscripts/agentscripts.go b/agent/agentscripts/agentscripts.go
@@ -65,11 +65,11 @@ func (r *Runner) Init(scripts []codersdk.WorkspaceAgentScript) error {
 	r.scripts = scripts
 
 	for _, script := range scripts {
-		if script.Schedule == "" {
+		if script.CRON == "" {
 			continue
 		}
 		script := script
-		_, err := r.cron.AddFunc(script.Schedule, func() {
+		_, err := r.cron.AddFunc(script.CRON, func() {
 			err := r.run(script)
 			if err != nil {
 				r.Logger.Warn(r.ctx, "run agent script on schedule", slog.Error(err))
@@ -114,7 +114,7 @@ func (r *Runner) Execute(filter func(script codersdk.WorkspaceAgentScript) bool)
 func (r *Runner) run(script codersdk.WorkspaceAgentScript) error {
 	logger := r.Logger.With(slog.F("log_source", script.LogSourceDisplayName))
 	ctx := r.ctx
-	logger.Info(ctx, "running agent script", slog.F("script", script.Script))
+	logger.Info(ctx, "running agent script", slog.F("script", script.Source))
 	fileWriter, err := r.Filesystem.OpenFile(filepath.Join(r.LogDir, fmt.Sprintf("coder-%s-script.log", script.LogSourceDisplayName)), os.O_CREATE|os.O_RDWR, 0o600)
 	if err != nil {
 		return xerrors.Errorf("open %s script log file: %w", script.LogSourceDisplayName, err)
@@ -134,7 +134,7 @@ func (r *Runner) run(script codersdk.WorkspaceAgentScript) error {
 		defer cancel()
 	}
 
-	cmdPty, err := r.SSHServer.CreateCommand(ctx, script.Script, nil)
+	cmdPty, err := r.SSHServer.CreateCommand(ctx, script.Source, nil)
 	if err != nil {
 		return xerrors.Errorf("%s script: create command: %w", script.LogSourceDisplayName, err)
 	}

diff --git a/agent/agentscripts/agentscripts_test.go b/agent/agentscripts/agentscripts_test.go
@@ -32,7 +32,7 @@ func TestExecuteBasic(t *testing.T) {
 	defer runner.Close()
 	err := runner.Init([]codersdk.WorkspaceAgentScript{{
 		LogSourceDisplayName: "test",
-		Script:               "echo hello",
+		Source:               "echo hello",
 	}})
 	require.NoError(t, err)
 	require.NoError(t, runner.Execute(func(script codersdk.WorkspaceAgentScript) bool {
@@ -47,7 +47,7 @@ func TestTimeout(t *testing.T) {
 	runner := setup(t, nil)
 	defer runner.Close()
 	err := runner.Init([]codersdk.WorkspaceAgentScript{{
-		Script:  "sleep 3",
+		Source:  "sleep 3",
 		Timeout: time.Nanosecond,
 	}})
 	require.NoError(t, err)

diff --git a/cli/cliui/agent_test.go b/cli/cliui/agent_test.go
@@ -288,11 +288,10 @@ func TestAgent(t *testing.T) {
 
 			var buf bytes.Buffer
 			agent := codersdk.WorkspaceAgent{
-				ID:                    uuid.New(),
-				Status:                codersdk.WorkspaceAgentConnecting,
-				StartupScriptBehavior: codersdk.WorkspaceAgentStartupScriptBehaviorNonBlocking,
-				CreatedAt:             time.Now(),
-				LifecycleState:        codersdk.WorkspaceAgentLifecycleCreated,
+				ID:             uuid.New(),
+				Status:         codersdk.WorkspaceAgentConnecting,
+				CreatedAt:      time.Now(),
+				LifecycleState: codersdk.WorkspaceAgentLifecycleCreated,
 			}
 			logs := make(chan []codersdk.WorkspaceAgentLog, 1)
 

diff --git a/cli/ssh.go b/cli/ssh.go
@@ -143,13 +143,11 @@ func (r *RootCmd) ssh() *clibase.Cmd {
 			case "no":
 				wait = false
 			case "auto":
-				switch workspaceAgent.StartupScriptBehavior {
-				case codersdk.WorkspaceAgentStartupScriptBehaviorBlocking:
-					wait = true
-				case codersdk.WorkspaceAgentStartupScriptBehaviorNonBlocking:
-					wait = false
-				default:
-					return xerrors.Errorf("unknown startup script behavior %q", workspaceAgent.StartupScriptBehavior)
+				for _, script := range workspaceAgent.Scripts {
+					if script.StartBlocksLogin {
+						wait = true
+						break
+					}
 				}
 			default:
 				return xerrors.Errorf("unknown wait value %q", waitEnum)

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -1250,32 +1250,21 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 
 		agentID := uuid.New()
 		dbAgent, err := db.InsertWorkspaceAgent(ctx, database.InsertWorkspaceAgentParams{
-			ID:                   agentID,
-			CreatedAt:            dbtime.Now(),
-			UpdatedAt:            dbtime.Now(),
-			ResourceID:           resource.ID,
-			Name:                 prAgent.Name,
-			AuthToken:            authToken,
-			AuthInstanceID:       instanceID,
-			Architecture:         prAgent.Architecture,
-			EnvironmentVariables: env,
-			Directory:            prAgent.Directory,
-			OperatingSystem:      prAgent.OperatingSystem,
-			StartupScript: sql.NullString{
-				String: prAgent.StartupScript,
-				Valid:  prAgent.StartupScript != "",
-			},
-			ConnectionTimeoutSeconds:    prAgent.GetConnectionTimeoutSeconds(),
-			TroubleshootingURL:          prAgent.GetTroubleshootingUrl(),
-			MOTDFile:                    prAgent.GetMotdFile(),
-			StartupScriptBehavior:       database.StartupScriptBehavior(prAgent.GetStartupScriptBehavior()),
-			StartupScriptTimeoutSeconds: prAgent.GetStartupScriptTimeoutSeconds(),
-			ShutdownScript: sql.NullString{
-				String: prAgent.ShutdownScript,
-				Valid:  prAgent.ShutdownScript != "",
-			},
-			ShutdownScriptTimeoutSeconds: prAgent.GetShutdownScriptTimeoutSeconds(),
-			DisplayApps:                  convertDisplayApps(prAgent.GetDisplayApps()),
+			ID:                       agentID,
+			CreatedAt:                dbtime.Now(),
+			UpdatedAt:                dbtime.Now(),
+			ResourceID:               resource.ID,
+			Name:                     prAgent.Name,
+			AuthToken:                authToken,
+			AuthInstanceID:           instanceID,
+			Architecture:             prAgent.Architecture,
+			EnvironmentVariables:     env,
+			Directory:                prAgent.Directory,
+			OperatingSystem:          prAgent.OperatingSystem,
+			ConnectionTimeoutSeconds: prAgent.GetConnectionTimeoutSeconds(),
+			TroubleshootingURL:       prAgent.GetTroubleshootingUrl(),
+			MOTDFile:                 prAgent.GetMotdFile(),
+			DisplayApps:              convertDisplayApps(prAgent.GetDisplayApps()),
 		})
 		if err != nil {
 			return xerrors.Errorf("insert agent: %w", err)

diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -190,11 +190,11 @@ type WorkspaceAgentLogSource struct {
 type WorkspaceAgentScript struct {
 	LogSourceDisplayName string        `json:"log_source_display_name"`
 	LogSourceID          uuid.UUID     `json:"log_source_id" format:"uuid"`
-	Script               string        `json:"script"`
-	Schedule             string        `json:"schedule"`
+	Source               string        `json:"source"`
+	CRON                 string        `json:"cron"`
 	RunOnStart           bool          `json:"run_on_start"`
 	RunOnStop            bool          `json:"run_on_stop"`
-	LoginBeforeReady     bool          `json:"login_before_ready"`
+	StartBlocksLogin     bool          `json:"start_blocks_login"`
 	Timeout              time.Duration `json:"timeout_seconds"`
 }
 
@@ -767,10 +767,11 @@ const (
 )
 
 type WorkspaceAgentLog struct {
-	ID        int64     `json:"id"`
-	CreatedAt time.Time `json:"created_at" format:"date-time"`
-	Output    string    `json:"output"`
-	Level     LogLevel  `json:"level"`
+	ID          int64     `json:"id"`
+	CreatedAt   time.Time `json:"created_at" format:"date-time"`
+	Output      string    `json:"output"`
+	Level       LogLevel  `json:"level"`
+	LogSourceID uuid.UUID `json:"log_source_id" format:"uuid"`
 }
 
 type AgentSubsystem string