Skip to content

external: improve S3 error message #59327

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 1 commit into from
Feb 8, 2025
Merged

external: improve S3 error message #59327

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
10 changes: 8 additions & 2 deletions br/pkg/storage/ks3.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,8 +512,14 @@ func (rs *KS3Storage) open(
}

if startOffset != r.Start || (endOffset != 0 && endOffset != r.End+1) {
return nil, r, errors.Annotatef(berrors.ErrStorageUnknown, "open file '%s' failed, expected range: %s, got: %v",
path, *rangeOffset, result.ContentRange)
rangeStr := "<empty>"
if result.ContentRange != nil {
rangeStr = *result.ContentRange
}
return nil, r, errors.Annotatef(
berrors.ErrStorageUnknown,
"open file '%s' failed, expected range: %s, got: %s",
path, *rangeOffset, rangeStr)
}

return result.Body, r, nil
Expand Down
9 changes: 7 additions & 2 deletions br/pkg/storage/s3.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -875,8 +875,13 @@ func (rs *S3Storage) open(
}

if startOffset != r.Start || (endOffset != 0 && endOffset != r.End+1) {
return nil, r, errors.Annotatef(berrors.ErrStorageUnknown, "open file '%s' failed, expected range: %s, got: %v",
path, *rangeOffset, result.ContentRange)
rangeStr := "<empty>"
if result.ContentRange != nil {
rangeStr = *result.ContentRange
}
return nil, r, errors.Annotatef(berrors.ErrStorageUnknown,
"open file '%s' failed, expected range: %s, got: %s",
path, *rangeOffset, rangeStr)
}

return result.Body, r, nil
Expand Down
27 changes: 27 additions & 0 deletions br/pkg/storage/s3_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1472,3 +1472,30 @@ func TestS3ReadFileRetryable(t *testing.T) {
require.Error(t, err)
require.True(t, strings.Contains(err.Error(), errMsg))
}

func TestOpenRangeMismatchErrorMsg(t *testing.T) {
s := createS3Suite(t)
ctx := aws.BackgroundContext()
start, end := int64(10), int64(30)

s.s3.EXPECT().
GetObjectWithContext(ctx, gomock.Any()).
DoAndReturn(func(context.Context, *s3.GetObjectInput, ...request.Option) (*s3.GetObjectOutput, error) {
return &s3.GetObjectOutput{
ContentRange: aws.String("bytes 10-20/20"),
}, nil
})
reader, err := s.storage.Open(ctx, "test", &ReaderOption{StartOffset: &start, EndOffset: &end})
require.ErrorContains(t, err, "expected range: bytes=10-29, got: bytes 10-20/20")
require.Nil(t, reader)

s.s3.EXPECT().
GetObjectWithContext(ctx, gomock.Any()).
DoAndReturn(func(context.Context, *s3.GetObjectInput, ...request.Option) (*s3.GetObjectOutput, error) {
return &s3.GetObjectOutput{}, nil
})
reader, err = s.storage.Open(ctx, "test", &ReaderOption{StartOffset: &start, EndOffset: &end})
// other function will throw error
require.ErrorContains(t, err, "ContentRange is empty")
require.Nil(t, reader)
}