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 flush method to flush buffer #3521

Merged
merged 3 commits into from
Apr 21, 2023
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
1 change: 1 addition & 0 deletions common/flusher/flusher.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ type (
Flusher[T any] interface {
common.Daemon
Buffer(item T) future.Future[struct{}]
Flush()
}

FlushItem[T any] struct {
Expand Down
20 changes: 20 additions & 0 deletions common/flusher/flusher_impl.go
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,26 @@ func (f *flusherImpl[T]) Buffer(item T) future.Future[struct{}] {
return flushItem.Future
}

func (f *flusherImpl[T]) Flush() {
if f.shutdownChan.IsShutdown() {
return
}

f.Lock()
defer f.Unlock()

if f.shutdownChan.IsShutdown() {
return
}

if len(f.flushBuffer) == 0 {
// nothing to flush
return
}
f.stopTimerLocked()
f.pushDirtyBufferLocked()
}

func (f *flusherImpl[T]) appendLocked(flushItem FlushItem[T]) {
if len(f.flushBuffer) == 0 { // start timer if it's first Item insertion
f.startTimerLocked()
Expand Down
77 changes: 54 additions & 23 deletions common/flusher/flusher_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,10 @@ func (s *flusherSuite) TestBuffer_Switch() {
s.Equal([]*fakeTask{}, writer.Get())
}

func (s *flusherSuite) TestBuffer_Full() {
bufferCapacity := 1
func (s *flusherSuite) TestBuffer_Timer() {
bufferCapacity := 2
numBuffer := 2
flushTimeout := time.Minute
flushTimeout := time.Millisecond
writer := &fakeWriter{}
flushBuffer := NewFlusher[*fakeTask](
bufferCapacity,
Expand All @@ -153,35 +153,28 @@ func (s *flusherSuite) TestBuffer_Full() {
writer,
log.NewTestLogger(),
)
flushBuffer.Start()
defer flushBuffer.Stop()

task0 := newFakeTask()
task1 := newFakeTask()
task2 := newFakeTask()
fut0 := flushBuffer.Buffer(task0)
fut1 := flushBuffer.Buffer(task1)
fut2 := flushBuffer.Buffer(task2)
s.False(fut0.Ready())
s.False(fut1.Ready())
_, err := fut2.Get(s.ctx)
s.Equal(ErrFull, err)
task := newFakeTask()
fut := flushBuffer.Buffer(task)
_, err := fut.Get(s.ctx)
s.NoError(err)

flushBuffer.Lock()
defer flushBuffer.Unlock()
s.Equal(0, len(flushBuffer.flushBuffer))
s.Nil(flushBuffer.flushBufferPointer)
s.Equal(0, len(flushBuffer.freeBufferChan))
s.Equal(2, len(flushBuffer.fullBufferChan))
buffer := <-flushBuffer.fullBufferChan
s.Equal(task0, buffer[0].Item)
buffer = <-flushBuffer.fullBufferChan
s.Equal(task1, buffer[0].Item)
s.Equal([]*fakeTask{}, writer.Get())
s.Equal(1, len(flushBuffer.freeBufferChan))
s.Equal(0, len(flushBuffer.fullBufferChan))
flushBuffer.Unlock()

s.Equal([]*fakeTask{task}, writer.Get())
}

func (s *flusherSuite) TestBuffer_Timer() {
func (s *flusherSuite) TestBuffer_Flush() {
bufferCapacity := 2
numBuffer := 2
flushTimeout := time.Millisecond
flushTimeout := time.Minute
writer := &fakeWriter{}
flushBuffer := NewFlusher[*fakeTask](
bufferCapacity,
Expand All @@ -195,6 +188,7 @@ func (s *flusherSuite) TestBuffer_Timer() {

task := newFakeTask()
fut := flushBuffer.Buffer(task)
flushBuffer.Flush()
_, err := fut.Get(s.ctx)
s.NoError(err)

Expand All @@ -208,6 +202,43 @@ func (s *flusherSuite) TestBuffer_Timer() {
s.Equal([]*fakeTask{task}, writer.Get())
}

func (s *flusherSuite) TestBuffer_Full() {
bufferCapacity := 1
numBuffer := 2
flushTimeout := time.Minute
writer := &fakeWriter{}
flushBuffer := NewFlusher[*fakeTask](
bufferCapacity,
numBuffer,
flushTimeout,
writer,
log.NewTestLogger(),
)

task0 := newFakeTask()
task1 := newFakeTask()
task2 := newFakeTask()
fut0 := flushBuffer.Buffer(task0)
fut1 := flushBuffer.Buffer(task1)
fut2 := flushBuffer.Buffer(task2)
s.False(fut0.Ready())
s.False(fut1.Ready())
_, err := fut2.Get(s.ctx)
s.Equal(ErrFull, err)

flushBuffer.Lock()
defer flushBuffer.Unlock()
s.Equal(0, len(flushBuffer.flushBuffer))
s.Nil(flushBuffer.flushBufferPointer)
s.Equal(0, len(flushBuffer.freeBufferChan))
s.Equal(2, len(flushBuffer.fullBufferChan))
buffer := <-flushBuffer.fullBufferChan
s.Equal(task0, buffer[0].Item)
buffer = <-flushBuffer.fullBufferChan
s.Equal(task1, buffer[0].Item)
s.Equal([]*fakeTask{}, writer.Get())
}

func (s *flusherSuite) TestBuffer_Shutdown() {
bufferCapacity := 2
numBuffer := 2
Expand Down