fix(accesslog): os: invalid use of WriteAt on file opened with O_APPEND

This commit is contained in:
yusing 2025-04-29 00:46:30 +08:00
parent ce4bf2f646
commit bca3cd84d1
3 changed files with 58 additions and 10 deletions

View file

@ -43,6 +43,12 @@ type (
Name() string // file name or path Name() string // file name or path
} }
SupportRotate interface {
io.Writer
supportRotate
Name() string
}
RequestFormatter interface { RequestFormatter interface {
// AppendRequestLog appends a log line to line with or without a trailing newline // AppendRequestLog appends a log line to line with or without a trailing newline
AppendRequestLog(line []byte, req *http.Request, res *http.Response) []byte AppendRequestLog(line []byte, req *http.Request, res *http.Response) []byte

View file

@ -2,8 +2,9 @@ package accesslog
import ( import (
"fmt" "fmt"
"io"
"os" "os"
pathPkg "path" "path/filepath"
"sync" "sync"
"github.com/yusing/go-proxy/internal/logging" "github.com/yusing/go-proxy/internal/logging"
@ -11,7 +12,7 @@ import (
) )
type File struct { type File struct {
*os.File f *os.File
// os.File.Name() may not equal to key of `openedFiles`. // os.File.Name() may not equal to key of `openedFiles`.
// Store it for later delete from `openedFiles`. // Store it for later delete from `openedFiles`.
@ -25,21 +26,25 @@ var (
openedFilesMu sync.Mutex openedFilesMu sync.Mutex
) )
func newFileIO(path string) (WriterWithName, error) { func newFileIO(path string) (SupportRotate, error) {
openedFilesMu.Lock() openedFilesMu.Lock()
defer openedFilesMu.Unlock() defer openedFilesMu.Unlock()
var file *File var file *File
path = pathPkg.Clean(path) path = filepath.Clean(path)
if opened, ok := openedFiles[path]; ok { if opened, ok := openedFiles[path]; ok {
opened.refCount.Add() opened.refCount.Add()
return opened, nil return opened, nil
} else { } else {
f, err := os.OpenFile(path, os.O_APPEND|os.O_CREATE|os.O_RDWR, 0o644) // cannot open as O_APPEND as we need Seek and WriteAt
f, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0o644)
if err != nil { if err != nil {
return nil, fmt.Errorf("access log open error: %w", err) return nil, fmt.Errorf("access log open error: %w", err)
} }
file = &File{File: f, path: path, refCount: utils.NewRefCounter()} if _, err := f.Seek(0, io.SeekEnd); err != nil {
return nil, fmt.Errorf("access log seek error: %w", err)
}
file = &File{f: f, path: path, refCount: utils.NewRefCounter()}
openedFiles[path] = file openedFiles[path] = file
go file.closeOnZero() go file.closeOnZero()
} }
@ -47,6 +52,30 @@ func newFileIO(path string) (WriterWithName, error) {
return file, nil return file, nil
} }
func (f *File) Name() string {
return f.f.Name()
}
func (f *File) Write(p []byte) (n int, err error) {
return f.f.Write(p)
}
func (f *File) ReadAt(p []byte, off int64) (n int, err error) {
return f.f.ReadAt(p, off)
}
func (f *File) WriteAt(p []byte, off int64) (n int, err error) {
return f.f.WriteAt(p, off)
}
func (f *File) Seek(offset int64, whence int) (int64, error) {
return f.f.Seek(offset, whence)
}
func (f *File) Truncate(size int64) error {
return f.f.Truncate(size)
}
func (f *File) Close() error { func (f *File) Close() error {
f.refCount.Sub() f.refCount.Sub()
return nil return nil
@ -62,5 +91,5 @@ func (f *File) closeOnZero() {
openedFilesMu.Lock() openedFilesMu.Lock()
delete(openedFiles, f.path) delete(openedFiles, f.path)
openedFilesMu.Unlock() openedFilesMu.Unlock()
f.File.Close() f.f.Close()
} }

View file

@ -12,7 +12,7 @@ import (
) )
type supportRotate interface { type supportRotate interface {
io.ReadSeeker io.Seeker
io.ReaderAt io.ReaderAt
io.WriterAt io.WriterAt
Truncate(size int64) error Truncate(size int64) error
@ -66,9 +66,23 @@ var rotateBytePool = synk.NewBytesPool(0, 16*1024*1024)
// If the file does not need to be rotated, it returns nil, nil. // If the file does not need to be rotated, it returns nil, nil.
func rotateLogFile(file supportRotate, config *Retention) (result *RotateResult, err error) { func rotateLogFile(file supportRotate, config *Retention) (result *RotateResult, err error) {
if config.KeepSize > 0 { if config.KeepSize > 0 {
return rotateLogFileBySize(file, config) result, err = rotateLogFileBySize(file, config)
} else {
result, err = rotateLogFileByPolicy(file, config)
} }
if err != nil {
return nil, err
}
if _, err := file.Seek(0, io.SeekEnd); err != nil {
return nil, err
}
return result, nil
}
func rotateLogFileByPolicy(file supportRotate, config *Retention) (result *RotateResult, err error) {
var shouldStop func() bool var shouldStop func() bool
t := utils.TimeNow() t := utils.TimeNow()
@ -234,7 +248,6 @@ var timeJSON = []byte(`"time":"`)
// //
// The returned time is not validated. // The returned time is not validated.
func ExtractTime(line []byte) []byte { func ExtractTime(line []byte) []byte {
//TODO: optimize this
switch line[0] { switch line[0] {
case '{': // JSON format case '{': // JSON format
if i := bytes.Index(line, timeJSON); i != -1 { if i := bytes.Index(line, timeJSON); i != -1 {