Skip to content

Commit

Permalink
fix race condition for SetFormatter and properly fix SetReportCaller …
Browse files Browse the repository at this point in the history
…race as well
  • Loading branch information
rubensayshi committed Jun 16, 2021
1 parent b50299c commit 5873dd5
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
4 changes: 2 additions & 2 deletions entry.go
Original file line number Diff line number Diff line change
Expand Up @@ -284,13 +284,13 @@ func (entry *Entry) fireHooks() {
}

func (entry *Entry) write() {
entry.Logger.mu.Lock()
defer entry.Logger.mu.Unlock()
serialized, err := entry.Logger.Formatter.Format(entry)
if err != nil {
fmt.Fprintf(os.Stderr, "Failed to obtain reader, %v\n", err)
return
}
entry.Logger.mu.Lock()
defer entry.Logger.mu.Unlock()
if _, err := entry.Logger.Out.Write(serialized); err != nil {
fmt.Fprintf(os.Stderr, "Failed to write to log, %v\n", err)
}
Expand Down
20 changes: 20 additions & 0 deletions entry_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -269,10 +269,30 @@ func TestEntryLogfLevel(t *testing.T) {
func TestEntryReportCallerRace(t *testing.T) {
logger := New()
entry := NewEntry(logger)

// logging before SetReportCaller has the highest chance of causing a race condition
// to be detected, but doing it twice just to increase the likelyhood of detecting the race
go func() {
entry.Info("should not race")
}()
go func() {
logger.SetReportCaller(true)
}()
go func() {
entry.Info("should not race")
}()
}

func TestEntryFormatterRace(t *testing.T) {
logger := New()
entry := NewEntry(logger)

// logging before SetReportCaller has the highest chance of causing a race condition
// to be detected, but doing it twice just to increase the likelyhood of detecting the race
go func() {
entry.Info("should not race")
}()
go func() {
logger.SetFormatter(&TextFormatter{})
}()
}

0 comments on commit 5873dd5

Please sign in to comment.