chore(ux): improve copy error message by Wwwsylvia · Pull Request #1773 · oras-project/oras

Wwwsylvia · 2025-07-04T09:27:05Z

What this PR does / why we need it:

Optimize the error message for oras cp

Before:
After

Optimize the error message from registry error response by removing "recognizable error message not found:", impacting oras login and oras ls

Before:
After ("recognizable error message not found" is removed):

Improve error message for the "path traversal disallowed" error (resolving part of Improve error message for pushing/pulling files with absolute paths #1744)
- Before:

After:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1469

Please check the following list:

Does the affected code have corresponding tests, e.g. unit test, E2E test?
Does this change require a documentation update?
Does this introduce breaking changes that would require an announcement or bumping the major version?
Do all new files have an appropriate license header?

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

codecov · 2025-07-08T11:08:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.54%. Comparing base (90b42bd) to head (2638976).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1773      +/-   ##
==========================================
+ Coverage   85.43%   85.54%   +0.11%     
==========================================
  Files         137      137              
  Lines        5966     5993      +27     
==========================================
+ Hits         5097     5127      +30     
+ Misses        618      615       -3     
  Partials      251      251

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

This reverts commit bbd116c. Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

This reverts commit df2dd33. Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

qweeah

LGTM with minor suggestions

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Copilot

Pull Request Overview

This PR improves error messages across multiple ORAS commands to provide clearer and more user-friendly feedback. The changes focus on optimizing error message formatting for oras cp, registry error responses, and path traversal errors.

Key changes include:

Improved error message prefixes for copy operations to specify source/destination registry context
Removed the "recognizable error message not found:" prefix from registry error responses
Enhanced path traversal error messages with clearer user guidance

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
cmd/oras/internal/errors/errors.go	Replaces `TrimErrResp` with `ReportErrResp` and adds `UnwrapCopyError` function
cmd/oras/internal/option/target.go	Updates error handling method from `Modify` to `ModifyError` with improved logic
cmd/oras/internal/option/remote.go	Updates method name and uses new `ReportErrResp` function
cmd/oras/internal/option/binary_target.go	Adds comprehensive copy error handling with specific prefixes
cmd/oras/root/pull.go	Enhances path traversal error with user-friendly recommendation
cmd/oras/root/push.go	Unwraps copy errors to remove unnecessary context
cmd/oras/root/cp.go	Preserves copy error context for proper prefix processing
cmd/oras/root/attach.go	Unwraps copy errors to remove unnecessary context
test/e2e/internal/utils/const.go	Removes `EmptyBodyPrefix` constant
test/e2e/suite/command/resolve.go	Updates test to remove empty body prefix
test/e2e/suite/command/cp.go	Updates test expectations for new error format
test/e2e/suite/auth/auth.go	Restructures tests and adds new test for modified error prefix
cmd/oras/internal/option/target_test.go	Updates all test method names from `Modify` to `ModifyError`
cmd/oras/internal/option/binary_target_test.go	Adds comprehensive tests for copy error handling
cmd/oras/internal/errors/errors_test.go	Adds tests for new `ReportErrResp` and `UnwrapCopyError` functions

Comments suppressed due to low confidence (2)

test/e2e/suite/auth/auth.go:37

The removal of the copy command test from this location should be verified to ensure equivalent test coverage exists elsewhere. The copy command appears to be covered by the new test below, but this should be confirmed.

			RunWithoutLogin("attach", ZOTHost+"/repo:tag", "-a", "test=true", "--artifact-type", "doc/example", "--registry-config", authConfigPath)

test/e2e/suite/auth/auth.go:63

The removal of push and pull commands from the invalid credentials test reduces test coverage. These commands should be tested elsewhere or the removal should be justified.

			RunWithInvalidCreds("attach", ZOTHost+"/repo:tag", "-a", "test=true", "--artifact-type", "doc/example")

shizhMSFT

LGTM

shizhMSFT

LGTM

Wwwsylvia added 10 commits July 7, 2025 13:42

draft

23814f1

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

update

5360f0d

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

rename

c74ee24

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

clean up

c662ffa

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

refine

643ea77

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

add test

b918404

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

fix test

07ec1a7

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

more tests

d434e59

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

better unit tests

25130dc

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

fix

fc78ff8

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Wwwsylvia force-pushed the cp_err_refactor branch from 2ce7602 to fc78ff8 Compare July 7, 2025 05:43

Wwwsylvia added 9 commits July 7, 2025 14:58

refine

e6452de

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

e2e

1a29069

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

clean up focus

7e62918

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

handle not found

947e423

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

re-handle not found

3c81a27

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

part fix

64ea69e

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

refactor with binary targets

73c0757

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

try fix

90f2c60

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

try fix again

67fc432

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Wwwsylvia added 9 commits July 9, 2025 15:35

hanle path traversal, run e2e

747fca8

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

refine

d2b35f8

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

refactor binary target + tests

aa987ee

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

fix ModifyErr name

3ae1d67

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

do not unwrap?

a490dfe

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

fix binary target

4aa8d88

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

unwrap in pull, push, attach

49f13f2

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

fix pull

a30a6e7

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

format docs

f988a96

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Wwwsylvia requested a review from Copilot July 10, 2025 02:47

This comment was marked as outdated.

Sign in to view

tiny

c671803

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

qweeah reviewed Jul 11, 2025

View reviewed changes

Comment thread cmd/oras/internal/errors/errors.go Outdated

Comment thread cmd/oras/internal/errors/errors.go Outdated

qweeah reviewed Jul 11, 2025

View reviewed changes

Comment thread cmd/oras/internal/option/binary_target.go Outdated

qweeah reviewed Jul 11, 2025

View reviewed changes

Comment thread cmd/oras/internal/option/binary_target.go

Wwwsylvia added 3 commits July 11, 2025 16:02

use rewrap instead of UnwrapCopyError

cee204d

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

refactor modifyErr

2c2b5e2

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

use UnwrapCopyError back

028e13b

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Wwwsylvia force-pushed the cp_err_refactor branch from 3e8f0f1 to 028e13b Compare July 11, 2025 08:23

Wwwsylvia added 5 commits July 12, 2025 10:43

try extract copy error

df2dd33

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

fix, extract->rewrap

bbd116c

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Revert "fix, extract->rewrap"

4f494f1

This reverts commit bbd116c. Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Revert "try extract copy error"

38dbde0

This reverts commit df2dd33. Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

optimize structure of binary target

524cf68

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

qweeah approved these changes Jul 14, 2025

View reviewed changes

Comment thread cmd/oras/root/pull.go Outdated

Comment thread cmd/oras/root/attach.go Outdated

Comment thread cmd/oras/root/push.go Outdated

refine commands

9c63f71

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Wwwsylvia requested a review from Copilot July 14, 2025 03:08

This comment was marked as outdated.

Sign in to view

address AI comments

2829bc9

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>

Wwwsylvia requested a review from Copilot July 14, 2025 03:17

Copilot AI reviewed Jul 14, 2025

View reviewed changes

shizhMSFT approved these changes Jul 14, 2025

View reviewed changes

Merge branch 'main' into cp_err_refactor

2638976

shizhMSFT approved these changes Jul 14, 2025

View reviewed changes

Wwwsylvia merged commit 943ca76 into oras-project:main Jul 14, 2025
8 checks passed

Wwwsylvia deleted the cp_err_refactor branch July 14, 2025 04:32

This was referenced Aug 7, 2025

bump: tag and release ORAS CLI v1.3.0-beta.4 #1798

Closed

bump: tag and release ORAS CLI v1.3.0-beta.4 #1799

Merged

Wwwsylvia mentioned this pull request Sep 3, 2025

bump: tag and release ORAS CLI v1.3.0 #1839

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(ux): improve copy error message#1773

chore(ux): improve copy error message#1773
Wwwsylvia merged 41 commits into
oras-project:mainfrom
Wwwsylvia:cp_err_refactor

Wwwsylvia commented Jul 4, 2025 •

edited

Loading

Uh oh!

codecov Bot commented Jul 8, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qweeah left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

shizhMSFT left a comment

Uh oh!

shizhMSFT left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Wwwsylvia commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qweeah left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

shizhMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

shizhMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Wwwsylvia commented Jul 4, 2025 •

edited

Loading

codecov Bot commented Jul 8, 2025 •

edited

Loading