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.

Sign up for GitHub

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

Fix logger name without suffix #2534

Merged
merged 1 commit into from
Jan 14, 2024
Merged

Fix logger name without suffix #2534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion common/logger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ func (jl *jobLogger) OpenLog() {
return
}

file, err := NewRotatingWriter(path.Join(jl.logFileFolder, jl.jobID.String()+jl.logFileNameSuffix), maxLogSize)
file, err := NewRotatingWriter(path.Join(jl.logFileFolder, jl.jobID.String()+jl.logFileNameSuffix+".log"), maxLogSize)
PanicIfErr(err)

jl.file = file
Expand Down
8 changes: 3 additions & 5 deletions common/rotatingWriter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"fmt"
"io"
"os"
"strings"
"sync"
"sync/atomic"
)
Expand Down Expand Up @@ -68,8 +69,8 @@ func (w *rotatingWriter) rotate(suffix int32) error {
return err
}

suffixString := fmt.Sprintf(".%d.log", w.currentSuffix)
if err := os.Rename(w.filePath, w.filePath + suffixString); err != nil {
logFileName := strings.TrimSuffix(w.filePath, ".log") + fmt.Sprintf(".%d.log", w.currentSuffix)
if err := os.Rename(w.filePath, logFileName); err != nil {
return err
}

Expand All @@ -91,9 +92,6 @@ func (w *rotatingWriter) Close() error {
if err := w.file.Close(); err != nil {
return err
}
if err := os.Rename(w.filePath, w.filePath + ".log"); err != nil {
return err
}
return nil
}

Expand Down
26 changes: 13 additions & 13 deletions common/rotatingWriter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,32 +40,32 @@ func TestRotatingWriter(t *testing.T) {
}

a := assert.New(t)
logFileName := "logfile"
logFileNameWithoutSuffix := "logfile"
data := "This string is one hundred bytes. Also has some junk to make actually make it one hundred bytes. Bye"

tmpDir, err := os.MkdirTemp("", "")
defer os.RemoveAll(tmpDir)

a.Nil(err)
logFile := path.Join(tmpDir, logFileName)
logFile := path.Join(tmpDir, logFileNameWithoutSuffix)

// 1. Create a rotating writer of size 100B
w, err := NewRotatingWriter(logFile, 100)
w, err := NewRotatingWriter(logFile + ".log", 100)
a.Nil(err)

// write 10 bytes and verify there is only one file in tmpDir
w.Write([]byte(data[:10]))
entries, err := os.ReadDir(tmpDir)
a.Nil(err)
a.Equal(1, len(entries))
a.Equal(logFileName, entries[0].Name())
a.Equal(logFileNameWithoutSuffix + ".log", entries[0].Name())

// write 90 more bytes and verify there is still only one file
w.Write([]byte(data[:90]))
entries, err = os.ReadDir(tmpDir)
a.Nil(err)
a.Equal(1, len(entries))
a.Equal(logFileName, entries[0].Name())
a.Equal(logFileNameWithoutSuffix + ".log", entries[0].Name())

// write 10 more bytes and verify a new log file is created
n, err := w.Write([]byte(data[:10]))
Expand All @@ -76,8 +76,8 @@ func TestRotatingWriter(t *testing.T) {
a.Nil(err)
a.Equal(2, len(entries))
f := convertToMap(entries)
a.Contains(f, logFileName)
a.Contains(f, logFileName + ".0.log")
a.Contains(f, logFileNameWithoutSuffix + ".log")
a.Contains(f, logFileNameWithoutSuffix + ".0.log")

// Write 80 bytes to prepare for next test
w.Write([]byte(data[:80]))
Expand All @@ -102,17 +102,17 @@ func TestRotatingWriter(t *testing.T) {
a.Nil(err)
a.Equal(3, len(entries))
f = convertToMap(entries)
a.Contains(f, logFileName)
a.Contains(f, logFileName + ".0.log")
a.Contains(f, logFileName + ".1.log")
a.Contains(f, logFileNameWithoutSuffix + ".log")
a.Contains(f, logFileNameWithoutSuffix + ".0.log")
a.Contains(f, logFileNameWithoutSuffix + ".1.log")

// close and verify we've 3 log files
w.Close()
entries, err = os.ReadDir(tmpDir)
a.Nil(err)
a.Equal(3, len(entries))
f = convertToMap(entries)
a.Contains(f, logFileName + ".log")
a.Contains(f, logFileName + ".0.log")
a.Contains(f, logFileName + ".1.log")
a.Contains(f, logFileNameWithoutSuffix + ".log")
a.Contains(f, logFileNameWithoutSuffix + ".0.log")
a.Contains(f, logFileNameWithoutSuffix + ".1.log")
}
Loading