Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

log: make NewBufferLogger safe to read/write across goroutines #314

Merged
merged 1 commit into from
Jul 21, 2023
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
37 changes: 33 additions & 4 deletions log/logger_impl.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"runtime"
"sort"
"strings"
"sync"
"testing"
"time"

Expand Down Expand Up @@ -44,11 +45,39 @@ func NewTestLogger() Logger {
return NewNopLogger()
}

func NewBufferLogger() (*strings.Builder, Logger) {
buffer := strings.Builder{}
writer := log.NewLogfmtLogger(log.NewSyncWriter(&buffer))
func NewBufferLogger() (*BufferedLogger, Logger) {
buffer := &BufferedLogger{
buf: &strings.Builder{},
}
writer := log.NewLogfmtLogger(log.NewSyncWriter(buffer))
log := NewLogger(writer)
return &buffer, log
return buffer, log
}

type BufferedLogger struct {
mu sync.RWMutex
buf *strings.Builder
}

func (bl *BufferedLogger) Write(p []byte) (n int, err error) {
bl.mu.Lock()
defer bl.mu.Unlock()

return bl.buf.Write(p)
}

func (bl *BufferedLogger) Reset() {
bl.mu.Lock()
defer bl.mu.Unlock()

bl.buf.Reset()
}

func (bl *BufferedLogger) String() string {
bl.mu.RLock()
defer bl.mu.RUnlock()

return bl.buf.String()
}

func NewLogger(writer log.Logger) Logger {
Expand Down
23 changes: 22 additions & 1 deletion log/logger_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"
"regexp"
"strings"
"sync"
"testing"
"time"

Expand Down Expand Up @@ -297,7 +298,27 @@ func Test_Caller(t *testing.T) {
a.Regexp(regexp.MustCompile(`caller_0=(.*?)(\/log\/logger_test\.go)`), buffer.String())
}

func Setup(t *testing.T) (*assert.Assertions, *strings.Builder, lib.Logger) {
func Test_BufferedLogger_Concurrent(t *testing.T) {
_, buffer, log := Setup(t)

var wg sync.WaitGroup
wg.Add(1000)
for i := 0; i < 1000; i++ {
go func(idx int) {
defer wg.Done()

if idx%3 == 0 {
t.Log(buffer.String()) // read
} else {
log.Info().Logf("idx %d", idx)
adamdecaf marked this conversation as resolved.
Show resolved Hide resolved
}
}(i)
}

wg.Wait()
}

func Setup(t *testing.T) (*assert.Assertions, *lib.BufferedLogger, lib.Logger) {
a := assert.New(t)
buffer, log := lib.NewBufferLogger()
return a, buffer, log
Expand Down
Loading