feat: introduce CopyError to identify error source in copy operations#933
Merged
Conversation
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #933 +/- ##
==========================================
+ Coverage 81.25% 81.69% +0.44%
==========================================
Files 63 64 +1
Lines 6076 6119 +43
==========================================
+ Hits 4937 4999 +62
+ Misses 801 790 -11
+ Partials 338 330 -8 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new error type, CopyError, to better indicate error origins in copy operations by wrapping errors with additional context. Key changes include:
- Replacing plain error messages with structured CopyError instances across copy and extended copy functions.
- Updating test cases to assert error types and origins using errors.Is and type assertions.
- Adding dedicated tests and examples for CopyError behavior.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| internal/platform/platform_test.go | Updated error assertions to use errors.Is |
| internal/platform/platform.go | Wrapped error with errdef.ErrUnsupported using error wrapping |
| extendedcopy_test.go | Modified tests to check for CopyError and correct origins |
| extendedcopy.go | Updated error handling in ExtendedCopy functions |
| example_copyerror_test.go | Added an example demonstrating CopyError usage |
| copyerror_test.go | Added tests for CopyError creation and behavior |
| copyerror.go | Introduced the new CopyError type and its helper function |
| copy_test.go | Updated copy tests to assert new error wrapping |
| copy.go | Updated Copy and helper functions to use newCopyError |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new error type, CopyError, to provide more precise identification of error sources during copy operations. Key changes include:
- Wrapping error returns with newCopyError to incorporate error origin (source, destination, internal).
- Updating error expectations in tests to use errors.Is comparisons.
- Adding tests and examples to verify and demonstrate the CopyError functionality.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| internal/platform/*.go | Updated error handling to wrap errors with CopyError for unsupported configuration cases. |
| extendedcopy_test.go | Renamed test function and updated error assertions to verify CopyError usage. |
| extendedcopy.go | Modified error returns to use newCopyError, ensuring consistent error wrapping. |
| example_copyerror_test.go | Added an example demonstrating how to inspect CopyError fields. |
| copyerror*.go and copy_test.go | Created and tested CopyError implementation with comprehensive unit tests. |
| copy.go | Refactored error handling in copy operations to use CopyError for designated error origins. |
shizhMSFT
reviewed
Apr 2, 2025
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
shizhMSFT
reviewed
Apr 14, 2025
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Contributor
There was a problem hiding this comment.
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
copy.go:273
- [nitpick] Consider using newCopyError instead of fmt.Errorf here for consistent error wrapping and to preserve error origin information.
return fmt.Errorf("failed to check cache existence: %s: %w", desc.Digest, err)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CopyErrorand return it fromCopyandExtendedCopywhen necessaryCopyErrortypeResolve #677