Skip to content

feat: add CRC64-NVME upload checksums to S3 cache #282

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
joshfriend merged 1 commit into from
Apr 30, 2026
Merged

feat: add CRC64-NVME upload checksums to S3 cache #282

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
4 changes: 3 additions & 1 deletion internal/cache/s3.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,9 +418,11 @@ func (w *s3Writer) upload(pr *io.PipeReader, r io.Reader) {
userMetadata["Headers"] = string(headersJSON)
}

// Configure upload options
// Configure upload options. CRC64-NVME is computed as data streams through and sent as a
// trailing header so S3 validates integrity server-side, preventing corrupt or truncated uploads.
opts := minio.PutObjectOptions{
UserMetadata: userMetadata,
AutoChecksum: minio.ChecksumCRC64NVME,
}

// Enable concurrent streaming for multi-part uploads if configured
Expand Down
50 changes: 24 additions & 26 deletions internal/cache/s3_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,29 @@ import (
"github.com/block/cachew/internal/s3client/s3clienttest"
)

// TestS3Cache tests the S3 cache implementation using MinIO in Docker.
func TestS3Cache(t *testing.T) {
bucket := s3clienttest.Start(t)
func newS3Cache(t *testing.T, bucket string) cache.Cache {
t.Helper()
s3clienttest.CleanBucket(t, bucket)
_, ctx := logging.Configure(t.Context(), logging.Config{Level: slog.LevelDebug})

cachetest.Suite(t, func(t *testing.T) cache.Cache {
s3clienttest.CleanBucket(t, bucket)
_, ctx := logging.Configure(t.Context(), logging.Config{Level: slog.LevelDebug})
clientProvider := s3client.NewClientProvider(ctx, s3client.Config{
Endpoint: s3clienttest.Addr,
UseSSL: false,
})

clientProvider := s3client.NewClientProvider(ctx, s3client.Config{
Endpoint: s3clienttest.Addr,
Region: "",
UseSSL: false,
SkipSSLVerify: false,
})
c, err := cache.NewS3(ctx, cache.S3Config{
Bucket: bucket,
MaxTTL: 500 * time.Millisecond,
Comment thread
joshfriend marked this conversation as resolved.
UploadPartSizeMB: 16,
}, clientProvider)
assert.NoError(t, err)
return c
}

c, err := cache.NewS3(ctx, cache.S3Config{
Bucket: bucket,
MaxTTL: 500 * time.Millisecond,
UploadPartSizeMB: 16,
}, clientProvider)
assert.NoError(t, err)
return c
})
// TestS3Cache tests the S3 cache implementation using MinIO in Docker.
func TestS3Cache(t *testing.T) {
bucket := s3clienttest.Start(t)
cachetest.Suite(t, func(t *testing.T) cache.Cache { return newS3Cache(t, bucket) })
}

func TestS3CacheSoak(t *testing.T) {
Expand All @@ -46,14 +46,12 @@ func TestS3CacheSoak(t *testing.T) {
}

bucket := s3clienttest.Start(t)

_, ctx := logging.Configure(t.Context(), logging.Config{Level: slog.LevelError})
s3clienttest.CleanBucket(t, bucket)
_, ctx := logging.Configure(t.Context(), logging.Config{Level: slog.LevelDebug})

clientProvider := s3client.NewClientProvider(ctx, s3client.Config{
Endpoint: s3clienttest.Addr,
Region: "",
UseSSL: false,
SkipSSLVerify: false,
Endpoint: s3clienttest.Addr,
UseSSL: false,
})

c, err := cache.NewS3(ctx, cache.S3Config{
Expand Down
7 changes: 4 additions & 3 deletions internal/s3client/s3client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,10 @@ func NewClient(ctx context.Context, config Config) (*minio.Client, error) {
})

options := &minio.Options{
Creds: creds,
Secure: config.UseSSL,
Region: config.Region,
Creds: creds,
Secure: config.UseSSL,
Region: config.Region,
TrailingHeaders: true,
}

if transport != nil {
Expand Down