Fix comments

kylecarbs · kylecarbs · commit ad0d678e10d1 · 2023-09-19T15:53:27.000Z
diff --git a/agent/agent.go b/agent/agent.go
@@ -682,7 +682,7 @@ func (a *agent) run(ctx context.Context) error {
 			} else {
 				a.setLifecycle(ctx, codersdk.WorkspaceAgentLifecycleReady)
 			}
-			a.scriptRunner.StartCRON()
+			a.scriptRunner.StartCron()
 		})
 		if err != nil {
 			return xerrors.Errorf("track conn goroutine: %w", err)
diff --git a/agent/agentscripts/agentscripts.go b/agent/agentscripts/agentscripts.go
@@ -87,9 +87,9 @@ func (r *Runner) Init(ctx context.Context, scripts []codersdk.WorkspaceAgentScri
 	return nil
 }
 
-// StartCRON starts the cron scheduler.
+// StartCron starts the cron scheduler.
 // This is done async to allow for the caller to execute scripts prior.
-func (r *Runner) StartCRON() {
+func (r *Runner) StartCron() {
 	r.cron.Start()
 }
 
@@ -123,16 +123,16 @@ func (r *Runner) Execute(ctx context.Context, filter func(script codersdk.Worksp
 // If the process does not exit after a few seconds, it is forcefully killed.
 // This function immediately returns after a timeout, and does not wait for the process to exit.
 func (r *Runner) run(ctx context.Context, script codersdk.WorkspaceAgentScript) error {
-	logger := r.Logger.With(slog.F("log_source", script.LogPath))
-	logger.Info(ctx, "running agent script", slog.F("script", script.Script))
-
 	logPath := script.LogPath
 	if logPath == "" {
 		logPath = fmt.Sprintf("coder-%s-script.log", script.LogSourceID)
 	}
 	if !filepath.IsAbs(logPath) {
 		logPath = filepath.Join(r.LogDir, logPath)
 	}
+	logger := r.Logger.With(slog.F("log_path", logPath))
+	logger.Info(ctx, "running agent script", slog.F("script", script.Script))
+
 	fileWriter, err := r.Filesystem.OpenFile(logPath, os.O_CREATE|os.O_RDWR, 0o600)
 	if err != nil {
 		return xerrors.Errorf("open %s script log file: %w", logPath, err)
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/foreign_key_constraint.go b/coderd/database/foreign_key_constraint.go
diff --git a/coderd/database/migrations/000156_workspace_agent_script.up.sql b/coderd/database/migrations/000156_workspace_agent_script.up.sql
@@ -1,6 +1,6 @@
 BEGIN;
 CREATE TABLE workspace_agent_log_sources (
-	workspace_agent_id uuid NOT NULL,
+	workspace_agent_id uuid NOT NULL REFERENCES workspace_agents(id) ON DELETE CASCADE,
 	id uuid NOT NULL,
 	created_at timestamptz NOT NULL,
 	display_name varchar(127) NOT NULL,
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -1438,7 +1438,8 @@ func convertWorkspaceAgentMetadataDesc(mds []database.WorkspaceAgentMetadatum) [
 
 func convertWorkspaceAgent(derpMap *tailcfg.DERPMap, coordinator tailnet.Coordinator,
 	dbAgent database.WorkspaceAgent, apps []codersdk.WorkspaceApp, scripts []codersdk.WorkspaceAgentScript, logSources []codersdk.WorkspaceAgentLogSource,
-	agentInactiveDisconnectTimeout time.Duration, agentFallbackTroubleshootingURL string) (codersdk.WorkspaceAgent, error) {
+	agentInactiveDisconnectTimeout time.Duration, agentFallbackTroubleshootingURL string,
+) (codersdk.WorkspaceAgent, error) {
 	var envs map[string]string
 	if dbAgent.EnvironmentVariables.Valid {
 		err := json.Unmarshal(dbAgent.EnvironmentVariables.RawMessage, &envs)
@@ -1455,6 +1456,17 @@ func convertWorkspaceAgent(derpMap *tailcfg.DERPMap, coordinator tailnet.Coordin
 		subsystems[i] = codersdk.AgentSubsystem(subsystem)
 	}
 
+	legacyStartupScriptBehavior := codersdk.WorkspaceAgentStartupScriptBehaviorNonBlocking
+	for _, script := range scripts {
+		if !script.RunOnStart {
+			continue
+		}
+		if !script.StartBlocksLogin {
+			continue
+		}
+		legacyStartupScriptBehavior = codersdk.WorkspaceAgentStartupScriptBehaviorBlocking
+	}
+
 	workspaceAgent := codersdk.WorkspaceAgent{
 		ID:                       dbAgent.ID,
 		CreatedAt:                dbAgent.CreatedAt,
@@ -1465,7 +1477,7 @@ func convertWorkspaceAgent(derpMap *tailcfg.DERPMap, coordinator tailnet.Coordin
 		Architecture:             dbAgent.Architecture,
 		OperatingSystem:          dbAgent.OperatingSystem,
 		Scripts:                  scripts,
-		StartupScriptBehavior:    codersdk.WorkspaceAgentStartupScriptBehaviorNonBlocking,
+		StartupScriptBehavior:    legacyStartupScriptBehavior,
 		LogsLength:               dbAgent.LogsLength,
 		LogsOverflowed:           dbAgent.LogsOverflowed,
 		LogSources:               logSources,

Original file line number	Diff line number	Diff line change
`@@ -682,7 +682,7 @@ func (a *agent) run(ctx context.Context) error {`
`682`	`682`	`} else {`
`683`	`683`	`a.setLifecycle(ctx, codersdk.WorkspaceAgentLifecycleReady)`
`684`	`684`	`}`
`685`		`- a.scriptRunner.StartCRON()`
	`685`	`+ a.scriptRunner.StartCron()`
`686`	`686`	`})`
`687`	`687`	`if err != nil {`
`688`	`688`	`return xerrors.Errorf("track conn goroutine: %w", err)`