coder · mafredri · Jun 16, 2023 · Jun 14, 2023 · Jun 15, 2023 · Jun 16, 2023
diff --git a/agent/agent.go b/agent/agent.go
@@ -929,6 +929,11 @@ func (a *agent) trackScriptLogs(ctx context.Context, reader io.Reader) (chan str
 			if errors.As(err, &sdkErr) {
 				if sdkErr.StatusCode() == http.StatusRequestEntityTooLarge {
 					a.logger.Warn(ctx, "startup logs too large, dropping logs")
+					// Always send the EOF even if logs overflow.
+					if len(logsToSend) > 1 && logsToSend[len(logsToSend)-1].EOF {
+						logsToSend = logsToSend[len(logsToSend)-1:]
+						continue
+					}
 					break
 				}
 			}
@@ -978,6 +983,14 @@ func (a *agent) trackScriptLogs(ctx context.Context, reader io.Reader) (chan str
 				Output:    scanner.Text(),
 			})
 		}
+		if err := scanner.Err(); err != nil {
+			a.logger.Error(ctx, "scan startup logs", slog.Error(err))
+		}
+		queueLog(agentsdk.StartupLog{
+			CreatedAt: database.Now(),
+			Output:    "",
+			EOF:       true,
+		})
 		defer close(logsFinished)
 		logsFlushed.L.Lock()
 		for {

diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -905,8 +905,10 @@ func TestAgent_StartupScript(t *testing.T) {
 			return len(got) > 0 && got[len(got)-1] == codersdk.WorkspaceAgentLifecycleReady
 		}, testutil.WaitShort, testutil.IntervalMedium)
 
-		require.Len(t, client.getStartupLogs(), 1)
+		require.Len(t, client.getStartupLogs(), 2)
 		require.Equal(t, output, client.getStartupLogs()[0].Output)
+		require.False(t, client.getStartupLogs()[0].EOF)
+		require.True(t, client.getStartupLogs()[1].EOF)
 	})
 	// This ensures that even when coderd sends back that the startup
 	// script has written too many lines it will still succeed!

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/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
@@ -1407,6 +1407,14 @@ func (q *querier) GetWorkspaceAgentStartupLogsAfter(ctx context.Context, arg dat
 	return q.db.GetWorkspaceAgentStartupLogsAfter(ctx, arg)
 }
 
+func (q *querier) GetWorkspaceAgentStartupLogsEOF(ctx context.Context, agentID uuid.UUID) (bool, error) {
+	_, err := q.GetWorkspaceAgentByID(ctx, agentID)
+	if err != nil {
+		return false, err
+	}
+	return q.db.GetWorkspaceAgentStartupLogsEOF(ctx, agentID)
+}
+
 func (q *querier) GetWorkspaceAgentStats(ctx context.Context, createdAfter time.Time) ([]database.GetWorkspaceAgentStatsRow, error) {
 	return q.db.GetWorkspaceAgentStats(ctx, createdAfter)
 }

diff --git a/coderd/database/dbfake/dbfake.go b/coderd/database/dbfake/dbfake.go
@@ -2722,14 +2722,30 @@ func (q *fakeQuerier) GetWorkspaceAgentStartupLogsAfter(_ context.Context, arg d
 		if log.AgentID != arg.AgentID {
 			continue
 		}
-		if arg.CreatedAfter != 0 && log.ID < arg.CreatedAfter {
+		if arg.CreatedAfter != 0 && log.ID <= arg.CreatedAfter {
 			continue
 		}
 		logs = append(logs, log)
 	}
 	return logs, nil
 }
 
+func (q *fakeQuerier) GetWorkspaceAgentStartupLogsEOF(_ context.Context, agentID uuid.UUID) (bool, error) {
+	q.mutex.RLock()
+	defer q.mutex.RUnlock()
+
+	var lastLog database.WorkspaceAgentStartupLog
+	for _, log := range q.workspaceAgentLogs {
+		if log.AgentID != agentID {
+			continue
+		}
+		if log.ID > lastLog.ID {
+			lastLog = log
+		}
+	}
+	return lastLog.EOF, nil
+}
+
 func (q *fakeQuerier) GetWorkspaceAgentStats(_ context.Context, createdAfter time.Time) ([]database.GetWorkspaceAgentStatsRow, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
@@ -4013,7 +4029,7 @@ func (q *fakeQuerier) InsertWorkspaceAgentStartupLogs(_ context.Context, arg dat
 	defer q.mutex.Unlock()
 
 	logs := []database.WorkspaceAgentStartupLog{}
-	id := int64(1)
+	id := int64(0)
 	if len(q.workspaceAgentLogs) > 0 {
 		id = q.workspaceAgentLogs[len(q.workspaceAgentLogs)-1].ID
 	}
@@ -4026,6 +4042,7 @@ func (q *fakeQuerier) InsertWorkspaceAgentStartupLogs(_ context.Context, arg dat
 			CreatedAt: arg.CreatedAt[index],
 			Level:     arg.Level[index],
 			Output:    output,
+			EOF:       arg.EOF[index],
 		})
 		outputLength += int32(len(output))
 	}

diff --git a/coderd/database/dbmetrics/dbmetrics.go b/coderd/database/dbmetrics/dbmetrics.go
diff --git a/coderd/database/dbmock/dbmock.go b/coderd/database/dbmock/dbmock.go
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000127_add_startup_logs_eof.down.sql b/coderd/database/migrations/000127_add_startup_logs_eof.down.sql
@@ -0,0 +1 @@
+ALTER TABLE workspace_agent_startup_logs DROP COLUMN eof;
diff --git a/coderd/database/migrations/000127_add_startup_logs_eof.up.sql b/coderd/database/migrations/000127_add_startup_logs_eof.up.sql
@@ -0,0 +1,3 @@
+ALTER TABLE workspace_agent_startup_logs ADD COLUMN eof boolean NOT NULL DEFAULT false;
+
+COMMENT ON COLUMN workspace_agent_startup_logs.eof IS 'End of file reached';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/querier_test.go b/coderd/database/querier_test.go
@@ -114,6 +114,7 @@ func TestInsertWorkspaceAgentStartupLogs(t *testing.T) {
 		CreatedAt: []time.Time{database.Now()},
 		Output:    []string{"first"},
 		Level:     []database.LogLevel{database.LogLevelInfo},
+		EOF:       []bool{false},
 		// 1 MB is the max
 		OutputLength: 1 << 20,
 	})
@@ -125,6 +126,7 @@ func TestInsertWorkspaceAgentStartupLogs(t *testing.T) {
 		CreatedAt:    []time.Time{database.Now()},
 		Output:       []string{"second"},
 		Level:        []database.LogLevel{database.LogLevelInfo},
+		EOF:          []bool{false},
 		OutputLength: 1,
 	})
 	require.True(t, database.IsStartupLogsLimitError(err))

diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspaceagents.sql b/coderd/database/queries/workspaceagents.sql
@@ -146,18 +146,31 @@ WHERE
 		id > @created_after
 	) ORDER BY id ASC;
 
+-- name: GetWorkspaceAgentStartupLogsEOF :one
+SELECT CASE WHEN EXISTS (
+	SELECT
+		*
+	FROM
+		workspace_agent_startup_logs
+	WHERE
+		agent_id = $1
+		AND eof = true
+	LIMIT 1
+) THEN TRUE ELSE FALSE END;
+
 -- name: InsertWorkspaceAgentStartupLogs :many
 WITH new_length AS (
 	UPDATE workspace_agents SET
 	startup_logs_length = startup_logs_length + @output_length WHERE workspace_agents.id = @agent_id
 )
 INSERT INTO
-		workspace_agent_startup_logs (agent_id, created_at, output, level)
+		workspace_agent_startup_logs (agent_id, created_at, output, level, eof)
 	SELECT
 		@agent_id :: uuid AS agent_id,
 		unnest(@created_at :: timestamptz [ ]) AS created_at,
 		unnest(@output :: VARCHAR(1024) [ ]) AS output,
-		unnest(@level :: log_level [ ]) AS level
+		unnest(@level :: log_level [ ]) AS level,
+		unnest(@eof :: boolean [ ]) AS eof
 	RETURNING workspace_agent_startup_logs.*;
 
 -- If an agent hasn't connected in the last 7 days, we purge it's logs.

diff --git a/coderd/database/sqlc.yaml b/coderd/database/sqlc.yaml
@@ -55,6 +55,7 @@ overrides:
       uuid: UUID
       failure_ttl: FailureTTL
       inactivity_ttl: InactivityTTL
+      eof: EOF
 
 sql:
   - schema: "./dump.sql"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE workspace_agent_startup_logs DROP COLUMN eof;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		ALTER TABLE workspace_agent_startup_logs ADD COLUMN eof boolean NOT NULL DEFAULT false;

		COMMENT ON COLUMN workspace_agent_startup_logs.eof IS 'End of file reached';