fix: apply suggestions from review

coder · DanielleMaywood · Sep 24, 2024 · Sep 17, 2024 · Sep 17, 2024 · Sep 17, 2024
commit 79a620b43e1527d143a33a2a1699eaef2ad4f56b
diff --git a/agent/agentscripts/agentscripts.go b/agent/agentscripts/agentscripts.go
@@ -355,14 +355,14 @@ func (r *Runner) run(ctx context.Context, script codersdk.WorkspaceAgentScript,
 
 			var status proto.Timing_Status
 			switch {
-			case !timedOut && !pipesLeftOpen && exitCode == 0:
-				status = proto.Timing_OK
-			case !timedOut && !pipesLeftOpen && exitCode != 0:
-				status = proto.Timing_EXIT_FAILURE
 			case timedOut:
 				status = proto.Timing_TIMED_OUT
 			case pipesLeftOpen:
 				status = proto.Timing_PIPES_LEFT_OPEN
+			case exitCode != 0:
+				status = proto.Timing_EXIT_FAILURE
+			default:
+				status = proto.Timing_OK
 			}
 
 			reportTimeout := 30 * time.Second

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000257_workspace_agent_script_timings.up.sql b/coderd/database/migrations/000257_workspace_agent_script_timings.up.sql
@@ -4,14 +4,18 @@ CREATE TYPE workspace_agent_script_timing_stage AS ENUM (
     'start',
     'stop',
     'cron'
-    );
+);
+
+COMMENT ON TYPE workspace_agent_script_timing_stage IS 'What stage the script was ran in.';
 
 CREATE TYPE workspace_agent_script_timing_status AS ENUM (
     'ok',
     'exit_failure',
     'timed_out',
     'pipes_left_open'
-    );
+);
+
+COMMENT ON TYPE workspace_agent_script_timing_status IS 'What the exit status of the script is.';
 
 CREATE TABLE workspace_agent_script_timings
 (
@@ -20,7 +24,8 @@ CREATE TABLE workspace_agent_script_timings
     ended_at      timestamp with time zone             NOT NULL,
     exit_code     int                                  NOT NULL,
     stage         workspace_agent_script_timing_stage  NOT NULL,
-    status        workspace_agent_script_timing_status NOT NULL
+    status        workspace_agent_script_timing_status NOT NULL,
+    UNIQUE (script_id, started_at)
 );
 
-ALTER TABLE workspace_agent_script_timings ADD UNIQUE (script_id, started_at);
+COMMENT ON TYPE workspace_agent_script_timings IS 'Timing and execution information about a script run.';
diff --git a/coderd/database/models.go b/coderd/database/models.go