Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 50 additions & 15 deletions pkg/log/writer.go
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
package log

import (
"bytes"
"io"
"sync"

"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)

// Writer returns an io.WriteCloser that writes each line as a log entry at the given level.
// Level uses the package constants: LevelInfo, LevelDebug, etc.
// maxPendingLine bounds how much unterminated output levelWriter buffers
// before logging it anyway, so a subprocess that never emits a newline
// can't grow the pending line without limit.
const maxPendingLine = 64 * 1024

func Writer(level int) io.WriteCloser {
zapLevel := verbosityConstToZapLevel(level)
w, closer, _ := zap.Open("stderr")
_ = closer // stderr doesn't need closing
return &levelWriter{
sink: w,
level: zapLevel,
core: sugar.Load().Desugar().Core(),
}
return &levelWriter{level: verbosityConstToZapLevel(level)}
}

func verbosityConstToZapLevel(level int) zapcore.Level {
Expand All @@ -34,18 +31,56 @@ func verbosityConstToZapLevel(level int) zapcore.Level {
}

type levelWriter struct {
sink zapcore.WriteSyncer
level zapcore.Level
core zapcore.Core

mu sync.Mutex
buf bytes.Buffer
}

func (w *levelWriter) Write(p []byte) (int, error) {
if !w.core.Enabled(w.level) {
w.mu.Lock()
defer w.mu.Unlock()

if !sugar.Load().Desugar().Core().Enabled(w.level) {
return len(p), nil // discard if below current level
}
return w.sink.Write(p)

total := len(p)
for {
i := bytes.IndexByte(p, '\n')
if i < 0 {
break
}
w.buf.Write(p[:i])
w.logLine(w.buf.String())
w.buf.Reset()
p = p[i+1:]
}
w.buf.Write(p)
if w.buf.Len() > maxPendingLine {
w.logLine(w.buf.String())
w.buf.Reset()
}
return total, nil
}

func (w *levelWriter) Close() error {
w.mu.Lock()
defer w.mu.Unlock()
if w.buf.Len() > 0 {
w.logLine(w.buf.String())
w.buf.Reset()
}
return nil
}

func (w *levelWriter) logLine(line string) {
switch w.level {
case zapcore.DebugLevel:
Debug(line)
case zapcore.ErrorLevel:
Error(line)
default:
Info(line)
}
}
151 changes: 151 additions & 0 deletions pkg/log/writer_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
package log

import (
"bytes"
"encoding/json"
"strings"
"testing"
)

const testFormatJSON = "json"

func TestWriter_EmitsStructuredJSONLine(t *testing.T) {
Init(Config{Verbosity: 2, Format: testFormatJSON})

var sink bytes.Buffer
remove := AddSink(&sink)
defer remove()

w := Writer(LevelInfo)
_, err := w.Write([]byte("Cloning into 'repo'...\n"))
if err != nil {
t.Fatalf("Write: %v", err)
}
_ = Sync()

got := strings.TrimSpace(sink.String())
if !strings.HasPrefix(got, "{") || !strings.HasSuffix(got, "}") {
t.Fatalf("expected a single JSON object, got %q", got)
}
if !strings.Contains(got, `"msg":"Cloning into 'repo'..."`) {
t.Errorf("missing expected msg field: %q", got)
}
if !strings.Contains(got, `"level":"info"`) {
t.Errorf("missing expected level field: %q", got)
}
}

func TestWriter_SplitsMultipleLinesInOneWrite(t *testing.T) {
Init(Config{Verbosity: 2, Format: testFormatJSON})

var sink bytes.Buffer
remove := AddSink(&sink)
defer remove()

w := Writer(LevelInfo)
_, err := w.Write([]byte("line one\nline two\n"))
if err != nil {
t.Fatalf("Write: %v", err)
}

// A line split across two Write calls (as os/exec delivers subprocess
// output in arbitrary chunks) must still be logged as one complete
// record, not two fragments.
if _, err := w.Write([]byte("line three\nline ")); err != nil {
t.Fatalf("Write: %v", err)
}
if _, err := w.Write([]byte("four\n")); err != nil {
t.Fatalf("Write: %v", err)
}
_ = Sync()

lines := strings.Split(strings.TrimSpace(sink.String()), "\n")
wantMsgs := []string{"line one", "line two", "line three", "line four"}
if len(lines) != len(wantMsgs) {
t.Fatalf("got %d lines, want %d: %q", len(lines), len(wantMsgs), lines)
}
for i, l := range lines {
assertJSONLineMsg(t, i, l, wantMsgs[i])
}
}

func assertJSONLineMsg(t *testing.T, i int, line, wantMsg string) {
t.Helper()
if !strings.HasPrefix(line, "{") || !strings.HasSuffix(line, "}") {
t.Errorf("line %d is not valid single-object JSON: %q", i, line)
return
}
var rec struct {
Msg string `json:"msg"`
}
if err := json.Unmarshal([]byte(line), &rec); err != nil {
t.Errorf("line %d: json.Unmarshal: %v", i, err)
return
}
if rec.Msg != wantMsg {
t.Errorf("line %d msg = %q, want %q", i, rec.Msg, wantMsg)
Comment on lines +72 to +86

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Validate the blank record through the JSON helper.

The substring check can accept malformed output, while Msg string cannot distinguish a missing field from {"msg":""}. Make Msg a pointer (or validate the raw field), then call assertJSONLineMsg(t, 1, lines[1], "").

Proposed test hardening
 	var rec struct {
-		Msg string `json:"msg"`
+		Msg *string `json:"msg"`
 	}
 	if err := json.Unmarshal([]byte(line), &rec); err != nil {
 		t.Errorf("line %d: json.Unmarshal: %v", i, err)
 		return
 	}
-	if rec.Msg != wantMsg {
-		t.Errorf("line %d msg = %q, want %q", i, rec.Msg, wantMsg)
+	if rec.Msg == nil {
+		t.Errorf("line %d is missing msg", i)
+		return
+	}
+	if *rec.Msg != wantMsg {
+		t.Errorf("line %d msg = %q, want %q", i, *rec.Msg, wantMsg)
 	}
 
-	if !strings.Contains(lines[1], `"msg":""`) {
-		t.Errorf("line 1 = %q, want an empty msg field", lines[1])
-	}
+	assertJSONLineMsg(t, 1, lines[1], "")

Also applies to: 131-133

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@pkg/log/writer_test.go` around lines 72 - 86, Update assertJSONLineMsg to
distinguish a missing msg field from an explicit empty value by making the
decoded Msg field nullable or validating the raw JSON field, and reject missing
fields. Replace the separate substring assertion for the blank record with
assertJSONLineMsg(t, 1, lines[1], ""), including the corresponding assertion
path around the later blank-record check.

}
}

func TestWriter_FlushesTrailingPartialLineOnClose(t *testing.T) {
Init(Config{Verbosity: 2, Format: testFormatJSON})

var sink bytes.Buffer
remove := AddSink(&sink)
defer remove()

w := Writer(LevelInfo)
_, _ = w.Write([]byte("no trailing newline"))
_ = Sync()
if sink.Len() != 0 {
t.Errorf("expected nothing logged before Close, got %q", sink.String())
}

if err := w.Close(); err != nil {
t.Fatalf("Close: %v", err)
}
_ = Sync()

if !strings.Contains(sink.String(), "no trailing newline") {
t.Errorf("expected trailing partial line flushed on Close, got %q", sink.String())
}
}

func TestWriter_PreservesBlankLines(t *testing.T) {
Init(Config{Verbosity: 2, Format: testFormatJSON})

var sink bytes.Buffer
remove := AddSink(&sink)
defer remove()

w := Writer(LevelInfo)
if _, err := w.Write([]byte("one\n\ntwo\n")); err != nil {
t.Fatalf("Write: %v", err)
}
_ = Sync()

lines := strings.Split(strings.TrimSpace(sink.String()), "\n")
if len(lines) != 3 {
t.Fatalf("got %d lines, want 3 (blank line preserved): %q", len(lines), lines)
}
if !strings.Contains(lines[1], `"msg":""`) {
t.Errorf("line 1 = %q, want an empty msg field", lines[1])
}
}

func TestWriter_DiscardsBelowConfiguredLevel(t *testing.T) {
Init(Config{Verbosity: 1, Format: testFormatJSON}) // info+ only, debug disabled

var sink bytes.Buffer
remove := AddSink(&sink)
defer remove()

w := Writer(LevelDebug)
_, _ = w.Write([]byte("should not appear\n"))
_ = w.Close()
_ = Sync()

if sink.Len() != 0 {
t.Errorf("expected debug output discarded below configured level, got %q", sink.String())
}
}
Loading