Skip to content

Implement Close() for GarbageCollectedWAL #430

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

Merged
yacovm merged 1 commit into from
Jul 2, 2026
Merged

Implement Close() for GarbageCollectedWAL #430

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
21 changes: 20 additions & 1 deletion wal/gc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import (
"github.com/ava-labs/simplex/common"
)

const (
defaultMaxWALSize = 100 * 1024 * 1024 // 100 MB
)

// Creator creates a DeletableWAL. Returns an error upon failure.
type Creator func() (DeletableWAL, error)

Expand Down Expand Up @@ -60,6 +64,11 @@ func NewGarbageCollectedWAL(WALs []DeletableWAL, creator Creator, reader Reader,
}
wals = append(wals, wal)
}

if maxWALSize == 0 {
maxWALSize = defaultMaxWALSize
}

return &GarbageCollectedWAL{
maxWalSize: maxWALSize,
reader: reader,
Expand Down Expand Up @@ -158,7 +167,7 @@ func (gcw *GarbageCollectedWAL) ReadAll() ([][]byte, error) {
return allEntries, nil
}

func (gcw *GarbageCollectedWAL) Truncate(retentionTerm uint64) error {
func (gcw *GarbageCollectedWAL) GarbageCollect(retentionTerm uint64) error {
newWALs := make([]garbageCollectedWAL, 0, len(gcw.wals))

for i, wal := range gcw.wals {
Expand All @@ -177,3 +186,13 @@ func (gcw *GarbageCollectedWAL) Truncate(retentionTerm uint64) error {

return nil
}

func (gcw *GarbageCollectedWAL) Close() error {
for i, wal := range gcw.wals {
if err := wal.Close(); err != nil {
return fmt.Errorf("error closing WAL %d: %v", i, err)
}
}
gcw.wals = nil
return nil
}
4 changes: 2 additions & 2 deletions wal/gc_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ func TestGarbageCollectedWAL(t *testing.T) {
require.NoError(t, err)
require.Equal(t, records, walRecords)

require.NoError(t, gcw.Truncate(6))
require.NoError(t, gcw.GarbageCollect(6))
walRecords, err = gcw.ReadAll()
require.NoError(t, err)
require.Equal(t, records[6:], walRecords)

require.NoError(t, gcw.Truncate(10))
require.NoError(t, gcw.GarbageCollect(10))
walRecords, err = gcw.ReadAll()
require.NoError(t, err)
require.Empty(t, walRecords)
Expand Down
Loading