Skip to content

Ensure bufferWriter is always closed in Migration.Buffer and propagate close errors #1308

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
merged 4 commits into from
Aug 23, 2025
Merged

Ensure bufferWriter is always closed in Migration.Buffer and propagate close errors #1308

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89e4f3e
Ensure bufferWriter is always closed and error is returned in Buffer()
chandrakant-cohesity Aug 19, 2025
849fb88
Ensure bufferWriter is always closed and error is returned in Buffer()
chandrakant-cohesity Aug 19, 2025
0701543
addressed review comments. used named error and joined error to retur…
chandrakant-cohesity Aug 20, 2025
7b96ecb
Fixed defer block
chandrakant-cohesity Aug 23, 2025
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
29 changes: 17 additions & 12 deletions migration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package migrate

import (
"bufio"
"errors"
"fmt"
"io"
"time"
Expand Down Expand Up @@ -118,7 +119,7 @@ func (m *Migration) LogString() string {

// Buffer buffers Body up to BufferSize.
// Calling this function blocks. Call with goroutine.
func (m *Migration) Buffer() error {
func (m *Migration) Buffer() (berr error) {
if m.Body == nil {
return nil
}
Expand All @@ -127,6 +128,21 @@ func (m *Migration) Buffer() error {

b := bufio.NewReaderSize(m.Body, int(m.BufferSize))

// defer closing buffer writer and body.
defer func() {
// close bufferWriter so Buffer knows that there is no
// more data coming.
if err := m.bufferWriter.Close(); err != nil {
berr = errors.Join(berr, err)
}

// it's safe to close the Body too.
if err := m.Body.Close(); err != nil {
berr = errors.Join(berr, err)
}

}()

// start reading from body, peek won't move the read pointer though
// poor man's solution?
if _, err := b.Peek(int(m.BufferSize)); err != nil && err != io.EOF {
Expand All @@ -145,16 +161,5 @@ func (m *Migration) Buffer() error {
m.FinishedReading = time.Now()
m.BytesRead = n

// close bufferWriter so Buffer knows that there is no
// more data coming
if err := m.bufferWriter.Close(); err != nil {
return err
}

// it's safe to close the Body too
if err := m.Body.Close(); err != nil {
return err
}

return nil
}