docs: address inefficiency in S3 object digest calculation

kamushadenes · kamushadenes · commit 24fcda73b180 · 2024-11-13T11:01:49.000-03:00
diff --git a/internal/sync/s3.go b/internal/sync/s3.go
@@ -192,6 +192,7 @@ func pushS3WithSession(ctx context.Context, s3Session *s3.S3, bucket *string, im
 }
 
 func syncObject(ctx context.Context, s3Session *s3.S3, bucket *string, key string, acl *string, contentType *string, r io.ReadSeeker) error {
+	// FIXME: we are reading the object every time to calculate the digest. This is inefficient.
 	h := sha256.New()
 	if _, err := io.Copy(h, r); err != nil {
 		return err

Original file line number	Diff line number	Diff line change
`@@ -192,6 +192,7 @@ func pushS3WithSession(ctx context.Context, s3Session s3.S3, bucket string, im`
`192`	`192`	`}`
`193`	`193`
`194`	`194`	`func syncObject(ctx context.Context, s3Session s3.S3, bucket string, key string, acl string, contentType string, r io.ReadSeeker) error {`
	`195`	`+ // FIXME: we are reading the object every time to calculate the digest. This is inefficient.`
`195`	`196`	`h := sha256.New()`
`196`	`197`	`if _, err := io.Copy(h, r); err != nil {`
`197`	`198`	`return err`