Skip to content

Commit

Permalink
feat(wrapper): output the number of objects with an error (#170)
Browse files Browse the repository at this point in the history
* fix(wrapper): total number of deletions is not accurate when errors occured

* change msgs

* change tests

* wrap an error

* comment

* handle of writer.Flush()

* not to display error counts if errors
  • Loading branch information
go-to-k authored Jul 18, 2024
1 parent e5e0715 commit 943aa22
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 16 deletions.
30 changes: 16 additions & 14 deletions internal/wrapper/s3_wrapper.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ func (s *S3Wrapper) ClearS3Objects(

eg := errgroup.Group{}
errorStr := ""
errorsCount := 0
errorsMtx := sync.Mutex{}
deletedVersionsCount := 0
deletedVersionsCountMtx := sync.Mutex{}
Expand All @@ -58,7 +59,6 @@ func (s *S3Wrapper) ClearS3Objects(

var keyMarker *string
var versionIdMarker *string
isFirstLoop := true
for {
var versions []types.ObjectIdentifier

Expand All @@ -79,11 +79,12 @@ func (s *S3Wrapper) ClearS3Objects(
break
}

if isFirstLoop {
eg.Go(func() error {
deletedVersionsCountMtx.Lock()
deletedVersionsCount += len(versions)
fmt.Fprintf(writer, "Clearing... %d objects\n", deletedVersionsCount)
}
deletedVersionsCountMtx.Unlock()

eg.Go(func() error {
// One DeleteObjects is executed for each loop of the List, and it usually ends during
// the next loop. Therefore, there seems to be no throttling concern, so the number of
// parallels is not limited by semaphore. (Throttling occurs at about 3500 deletions
Expand All @@ -93,13 +94,9 @@ func (s *S3Wrapper) ClearS3Objects(
return err
}

deletedVersionsCountMtx.Lock()
deletedVersionsCount += len(versions)
fmt.Fprintf(writer, "Clearing... %d objects\n", deletedVersionsCount)
deletedVersionsCountMtx.Unlock()

if len(gotErrors) > 0 {
errorsMtx.Lock()
errorsCount += len(gotErrors)
for _, error := range gotErrors {
errorStr += fmt.Sprintf("\nCode: %v\n", *error.Code)
errorStr += fmt.Sprintf("Key: %v\n", *error.Key)
Expand All @@ -115,18 +112,23 @@ func (s *S3Wrapper) ClearS3Objects(
if keyMarker == nil && versionIdMarker == nil {
break
}

isFirstLoop = false
}

if err := eg.Wait(); err != nil {
return err
}

writer.Flush()
if err := writer.Flush(); err != nil {
return err
}

if errorStr != "" {
return fmt.Errorf("DeleteObjectsError: followings %v", errorStr)
if errorsCount > 0 {
// The error is from `DeleteObjectsOutput.Errors`, not `err`.
// However, we want to treat it as an error, so we use `client.ClientError`.
return &client.ClientError{
ResourceName: aws.String(bucketName),
Err: fmt.Errorf("DeleteObjectsError: %v objects with errors were found. %v", errorsCount, errorStr),
}
}

if deletedVersionsCount == 0 {
Expand Down
4 changes: 2 additions & 2 deletions internal/wrapper/s3_wrapper_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ func TestS3Wrapper_ClearS3Objects(t *testing.T) {
}, nil,
)
},
want: fmt.Errorf("DeleteObjectsError: followings \nCode: Code\nKey: Key\nVersionId: VersionId\nMessage: Message\n"),
want: fmt.Errorf("[resource test] DeleteObjectsError: 1 objects with errors were found. \nCode: Code\nKey: Key\nVersionId: VersionId\nMessage: Message\n"),
wantErr: true,
},
{
Expand Down Expand Up @@ -387,7 +387,7 @@ func TestS3Wrapper_ClearS3Objects(t *testing.T) {
}, nil,
)
},
want: fmt.Errorf("DeleteObjectsError: followings \nCode: Code\nKey: Key\nVersionId: VersionId\nMessage: Message\n"),
want: fmt.Errorf("[resource test] DeleteObjectsError: 1 objects with errors were found. \nCode: Code\nKey: Key\nVersionId: VersionId\nMessage: Message\n"),
wantErr: true,
},
{
Expand Down

0 comments on commit 943aa22

Please sign in to comment.