refactor(logging): pass the caller's context to TaskRegistry.Write
Write built its own context.Background() for the handler call, which meant any new caller with a context to offer could not hand it over. Taking the caller's context is what the next commit's park-reason writer needs, and it is what contextcheck requires of a daemon-side writer. No behaviour change: the context is used for the handler's own attribute extraction and never consulted for cancellation -- a park is recorded at exactly the moment a run's context has been cancelled, so a cancelled context must not suppress the entry.
This commit is contained in:
1 parent
537ba9a3fb
commit
3917afeeb3
10 files changed
+26
-19
No files matched your search
@@ -805,7 +805,9 @@ func subscribeSystemLogs(nc *natsio.Conn, taskLogs *logging.TaskRegistry, log *s
|
||||
log.Warn("system log message undecodable", "task", taskID, "err", err)
|
||||
return
|
||||
}
|
||||
taskLogs.Write(taskID, entry)
|
||||
// The NATS callback has no context of its own; the write is an append to
|
||||
// an already-open sink, so there is nothing to cancel.
|
||||
taskLogs.Write(context.Background(), taskID, entry)
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
|
||||
@@ -806,7 +806,7 @@ func TestChatTaskLogReaderAdapterRoundTrip(t *testing.T) {
|
||||
if err := taskLogs.Open(task.ID, task.Attempt); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
taskLogs.Write(task.ID, logging.Entry{Level: "ERROR", Message: "gate failed", Fields: map[string]any{"component": "gate"}})
|
||||
taskLogs.Write(context.Background(), task.ID, logging.Entry{Level: "ERROR", Message: "gate failed", Fields: map[string]any{"component": "gate"}})
|
||||
if err := taskLogs.Close(task.ID); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
@@ -170,7 +170,7 @@ func composeUIProcessWithLog(t *testing.T) (*webui.Server, int64, int) {
|
||||
if err := logs.Open(task.ID, task.Attempt); err != nil {
|
||||
t.Fatalf("open task log: %v", err)
|
||||
}
|
||||
logs.Write(task.ID, logging.Entry{
|
||||
logs.Write(t.Context(), task.ID, logging.Entry{
|
||||
Level: "ERROR", Message: "gate failed", Fields: map[string]any{"component": "gate"},
|
||||
})
|
||||
if err := logs.Close(task.ID); err != nil {
|
||||
|
||||
@@ -46,7 +46,7 @@ func TestTaskLogPageCarriesNoNilCollectionFields(t *testing.T) {
|
||||
if tc.write {
|
||||
// No "component" field at all: Components stays empty while
|
||||
// Entries does not.
|
||||
reader.Write(taskID, logging.Entry{Level: "INFO", Message: "starting"})
|
||||
reader.Write(ctx, taskID, logging.Entry{Level: "INFO", Message: "starting"})
|
||||
}
|
||||
if err := reader.Close(taskID); err != nil {
|
||||
t.Fatalf("close sink: %v", err)
|
||||
|
||||
@@ -33,8 +33,8 @@ func TestTaskLogContract(t *testing.T) {
|
||||
if err := reader.Open(taskID, 0); err != nil {
|
||||
t.Fatalf("open sink: %v", err)
|
||||
}
|
||||
reader.Write(taskID, logging.Entry{Level: "INFO", Message: "starting", Fields: map[string]any{"component": "daemon"}})
|
||||
reader.Write(taskID, logging.Entry{Level: "ERROR", Message: "gate failed", Fields: map[string]any{"component": "gate"}})
|
||||
reader.Write(ctx, taskID, logging.Entry{Level: "INFO", Message: "starting", Fields: map[string]any{"component": "daemon"}})
|
||||
reader.Write(ctx, taskID, logging.Entry{Level: "ERROR", Message: "gate failed", Fields: map[string]any{"component": "gate"}})
|
||||
if err := reader.Close(taskID); err != nil {
|
||||
t.Fatalf("close sink: %v", err)
|
||||
}
|
||||
|
||||
@@ -87,7 +87,12 @@ func (r *TaskRegistry) Close(taskID int64) error {
|
||||
// log message is fire-and-forget best effort, and a late or duplicate
|
||||
// delivery after the task finished (or one this daemon instance never
|
||||
// dispatched) is expected, not exceptional.
|
||||
func (r *TaskRegistry) Write(taskID int64, entry Entry) bool {
|
||||
//
|
||||
// ctx is the caller's, used for the handler's own attribute extraction. It is
|
||||
// not consulted for cancellation: a park is recorded at exactly the moment a
|
||||
// run's context has been cancelled, and that entry is the one an operator most
|
||||
// needs to read.
|
||||
func (r *TaskRegistry) Write(ctx context.Context, taskID int64, entry Entry) bool {
|
||||
if r == nil {
|
||||
return false
|
||||
}
|
||||
@@ -105,7 +110,7 @@ func (r *TaskRegistry) Write(taskID int64, entry Entry) bool {
|
||||
for k, v := range entry.Fields {
|
||||
attrs = append(attrs, slog.Any(k, v))
|
||||
}
|
||||
got.logger.LogAttrs(context.Background(), level, entry.Message, attrs...)
|
||||
got.logger.LogAttrs(ctx, level, entry.Message, attrs...)
|
||||
return true
|
||||
}
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ func TestTaskRegistryOpenWriteCloseRoundTripsThroughTail(t *testing.T) {
|
||||
if err := reg.Open(42, 1); err != nil {
|
||||
t.Fatalf("Open: %v", err)
|
||||
}
|
||||
if ok := reg.Write(42, Entry{Level: "WARN", Message: "gate failed", Fields: map[string]any{"component": "gate"}}); !ok {
|
||||
if ok := reg.Write(t.Context(), 42, Entry{Level: "WARN", Message: "gate failed", Fields: map[string]any{"component": "gate"}}); !ok {
|
||||
t.Fatal("Write() = false, want true for an open task")
|
||||
}
|
||||
if err := reg.Close(42); err != nil {
|
||||
@@ -46,7 +46,7 @@ func TestTaskRegistryWriteMirrorsToTheDashboardFeed(t *testing.T) {
|
||||
if err := reg.Open(1, 1); err != nil {
|
||||
t.Fatalf("Open: %v", err)
|
||||
}
|
||||
reg.Write(1, Entry{Level: "INFO", Message: "hello"})
|
||||
reg.Write(t.Context(), 1, Entry{Level: "INFO", Message: "hello"})
|
||||
if err := reg.Close(1); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@@ -63,7 +63,7 @@ func TestTaskRegistryWriteMirrorsToTheDashboardFeed(t *testing.T) {
|
||||
// expected, not exceptional: no panic, no error return path to check.
|
||||
func TestTaskRegistryWriteWithoutOpenIsANoOp(t *testing.T) {
|
||||
reg := NewTaskRegistry(t.TempDir(), NewFeed(10), TaskSinkOptions{})
|
||||
if ok := reg.Write(999, Entry{Message: "orphan"}); ok {
|
||||
if ok := reg.Write(t.Context(), 999, Entry{Message: "orphan"}); ok {
|
||||
t.Error("Write() = true for a task with no open sink, want false")
|
||||
}
|
||||
}
|
||||
@@ -79,12 +79,12 @@ func TestTaskRegistryOpenReplacesThePreviousAttempt(t *testing.T) {
|
||||
if err := reg.Open(7, 1); err != nil {
|
||||
t.Fatalf("Open attempt 1: %v", err)
|
||||
}
|
||||
reg.Write(7, Entry{Message: "attempt one"})
|
||||
reg.Write(t.Context(), 7, Entry{Message: "attempt one"})
|
||||
|
||||
if err := reg.Open(7, 2); err != nil {
|
||||
t.Fatalf("Open attempt 2: %v", err)
|
||||
}
|
||||
reg.Write(7, Entry{Message: "attempt two"})
|
||||
reg.Write(t.Context(), 7, Entry{Message: "attempt two"})
|
||||
if err := reg.Close(7); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@@ -120,7 +120,7 @@ func TestTaskRegistryRemoveDeletesTheTaskDirectory(t *testing.T) {
|
||||
if err := reg.Open(5, 1); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
reg.Write(5, Entry{Message: "x"})
|
||||
reg.Write(t.Context(), 5, Entry{Message: "x"})
|
||||
if err := reg.Close(5); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@@ -155,7 +155,7 @@ func TestTaskRegistryNilReceiverIsSafe(t *testing.T) {
|
||||
if err := reg.Open(1, 1); err != nil {
|
||||
t.Errorf("Open() on nil registry = %v, want nil", err)
|
||||
}
|
||||
if ok := reg.Write(1, Entry{Message: "x"}); ok {
|
||||
if ok := reg.Write(t.Context(), 1, Entry{Message: "x"}); ok {
|
||||
t.Error("Write() on nil registry = true, want false")
|
||||
}
|
||||
if err := reg.Close(1); err != nil {
|
||||
@@ -207,7 +207,7 @@ func TestTaskRegistryConcurrentTasksDoNotRace(t *testing.T) {
|
||||
t.Errorf("Open(%d): %v", taskID, err)
|
||||
return
|
||||
}
|
||||
reg.Write(taskID, Entry{Message: "line"})
|
||||
reg.Write(t.Context(), taskID, Entry{Message: "line"})
|
||||
if err := reg.Close(taskID); err != nil {
|
||||
t.Errorf("Close(%d): %v", taskID, err)
|
||||
}
|
||||
|
||||
@@ -729,7 +729,7 @@ func TestArchiveRemovesTheTaskLogDirectory(t *testing.T) {
|
||||
if err := logs.Open(task.ID, task.Attempt); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
logs.Write(task.ID, logging.Entry{Message: "line"})
|
||||
logs.Write(ctx, task.ID, logging.Entry{Message: "line"})
|
||||
if err := logs.Close(task.ID); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
@@ -74,7 +74,7 @@ func TestHandleTaskLogsDownloadServesTheAttemptLog(t *testing.T) {
|
||||
if err := logs.Open(task.ID, task.Attempt); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
logs.Write(task.ID, logging.Entry{Level: "ERROR", Message: "gate failed"})
|
||||
logs.Write(ctx, task.ID, logging.Entry{Level: "ERROR", Message: "gate failed"})
|
||||
if err := logs.Close(task.ID); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
@@ -28,7 +28,7 @@ func TestHandleTaskLogsReturnsEntriesForLatestAttemptByDefault(t *testing.T) {
|
||||
if err := logs.Open(task.ID, task.Attempt); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
logs.Write(task.ID, logging.Entry{
|
||||
logs.Write(ctx, task.ID, logging.Entry{
|
||||
Level: "ERROR", Message: "gate failed", Fields: map[string]any{"component": "gate"},
|
||||
})
|
||||
if err := logs.Close(task.ID); err != nil {
|
||||
|
||||
Reference in new issue
Block a user