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

Add function to create WAL files #18605

Merged
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
2 changes: 1 addition & 1 deletion server/storage/wal/file_pipeline.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ func (fp *filePipeline) Close() error {
func (fp *filePipeline) alloc() (f *fileutil.LockedFile, err error) {
// count % 2 so this file isn't the same as the one last published
fpath := filepath.Join(fp.dir, fmt.Sprintf("%d.tmp", fp.count%2))
if f, err = fileutil.LockFile(fpath, os.O_CREATE|os.O_WRONLY, fileutil.PrivateFileMode); err != nil {
if f, err = createNewWALFile[*fileutil.LockedFile](fpath, false); err != nil {
return nil, err
}
if err = fileutil.Preallocate(f.File, fp.size, true); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion server/storage/wal/repair.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func Repair(lg *zap.Logger, dirpath string) bool {

case errors.Is(err, io.ErrUnexpectedEOF):
brokenName := f.Name() + ".broken"
bf, bferr := os.OpenFile(brokenName, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, fileutil.PrivateFileMode)
bf, bferr := createNewWALFile[*os.File](brokenName, true)
if bferr != nil {
lg.Warn("failed to create backup file", zap.String("path", brokenName), zap.Error(bferr))
return false
Expand Down
27 changes: 26 additions & 1 deletion server/storage/wal/wal.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ func Create(lg *zap.Logger, dirpath string, metadata []byte) (*WAL, error) {
}

p := filepath.Join(tmpdirpath, walName(0, 0))
f, err := fileutil.LockFile(p, os.O_WRONLY|os.O_CREATE, fileutil.PrivateFileMode)
f, err := createNewWALFile[*fileutil.LockedFile](p, false)
if err != nil {
lg.Warn(
"failed to flock an initial WAL file",
Expand Down Expand Up @@ -233,6 +233,31 @@ func Create(lg *zap.Logger, dirpath string, metadata []byte) (*WAL, error) {
return w, nil
}

// createNewWALFile creates a WAL file.
// To create a locked file, use *fileutil.LockedFile type parameter.
// To create a standard file, use *os.File type parameter.
// If forceNew is true, the file will be truncated if it already exists.
func createNewWALFile[T *os.File | *fileutil.LockedFile](path string, forceNew bool) (T, error) {
flag := os.O_WRONLY | os.O_CREATE
if forceNew {
flag |= os.O_TRUNC
}

if _, isLockedFile := any(T(nil)).(*fileutil.LockedFile); isLockedFile {
lockedFile, err := fileutil.LockFile(path, flag, fileutil.PrivateFileMode)
if err != nil {
return nil, err
}
return any(lockedFile).(T), nil
}

file, err := os.OpenFile(path, flag, fileutil.PrivateFileMode)
if err != nil {
return nil, err
}
return any(file).(T), nil
}

func (w *WAL) Reopen(lg *zap.Logger, snap walpb.Snapshot) (*WAL, error) {
err := w.Close()
if err != nil {
Expand Down
69 changes: 69 additions & 0 deletions server/storage/wal/wal_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,75 @@ func TestNew(t *testing.T) {
}
}

func TestCreateNewWALFile(t *testing.T) {
tests := []struct {
name string
fileType interface{}
forceNew bool
}{
{
name: "creating standard file should succeed and not truncate file",
fileType: &os.File{},
forceNew: false,
},
{
name: "creating locked file should succeed and not truncate file",
fileType: &fileutil.LockedFile{},
forceNew: false,
},
{
name: "creating standard file with forceNew should truncate file",
fileType: &os.File{},
forceNew: true,
},
{
name: "creating locked file with forceNew should truncate file",
fileType: &fileutil.LockedFile{},
forceNew: true,
},
}

for i, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
p := filepath.Join(t.TempDir(), walName(0, uint64(i)))

// create initial file with some data to verify truncate behavior
err := os.WriteFile(p, []byte("test data"), fileutil.PrivateFileMode)
require.NoError(t, err)

var f interface{}
switch tt.fileType.(type) {
case *os.File:
f, err = createNewWALFile[*os.File](p, tt.forceNew)
require.IsType(t, &os.File{}, f)
case *fileutil.LockedFile:
f, err = createNewWALFile[*fileutil.LockedFile](p, tt.forceNew)
require.IsType(t, &fileutil.LockedFile{}, f)
Comment on lines +137 to +142
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
case *os.File:
f, err = createNewWALFile[*os.File](p, tt.forceNew)
require.IsType(t, &os.File{}, f)
case *fileutil.LockedFile:
f, err = createNewWALFile[*fileutil.LockedFile](p, tt.forceNew)
require.IsType(t, &fileutil.LockedFile{}, f)
case *os.File:
f, err = createNewWALFile[*os.File](p, tt.forceNew)
require.IsType(t, &os.File{}, f)
case *fileutil.LockedFile:
f, err = createNewWALFile[*fileutil.LockedFile](p, tt.forceNew)
require.IsType(t, &fileutil.LockedFile{}, f)
default:
panic("unknown file type")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a default case to handle unknown file types. Good catch on handling that scenario

default:
panic("unknown file type")
}

require.NoError(t, err)

// validate the file permissions
fi, err := os.Stat(p)
require.NoError(t, err)
expectedPerms := fmt.Sprintf("%o", os.FileMode(fileutil.PrivateFileMode))
actualPerms := fmt.Sprintf("%o", fi.Mode().Perm())
require.Equal(t, expectedPerms, actualPerms, "unexpected file permissions on %q", p)

content, err := os.ReadFile(p)
require.NoError(t, err)

if tt.forceNew {
require.Empty(t, string(content), "file content should be truncated but it wasn't")
} else {
require.Equal(t, "test data", string(content), "file content should not be truncated but it was")
}
})
}
}

func TestCreateFailFromPollutedDir(t *testing.T) {
p := t.TempDir()
os.WriteFile(filepath.Join(p, "test.wal"), []byte("data"), os.ModeTemporary)
Expand Down
Loading