refactor(progress): generic progress tracking by shizhMSFT · Pull Request #1524 · oras-project/oras

shizhMSFT · 2024-11-01T04:41:27Z

This PR is an implementation of oras-project/oras-go#839. The goal is to refactor the core code of progress reporting from the oras CLI code base in order to put it into oras-go for others to implement their own progress reporting method. The refactored code is in the internal/progress package.

This PR refactors and unit tests the cmd/oras/internal/display/status/progress package.

This PR improves the UX with the changes below:

Add a red ✗ when error occurs
Add a padding to the second line of the progress view to fix the line overlapping issue
Improve performance

github-actions · 2024-12-17T02:07:07Z

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 30 days.

codecov · 2024-12-30T10:00:25Z

Codecov Report

Attention: Patch coverage is 87.03072% with 38 lines in your changes missing coverage. Please review.

Project coverage is 84.27%. Comparing base (724f56b) to head (9b0a7a1).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/oras/internal/display/status/track/target.go	51.61%	10 Missing and 5 partials ⚠️
...d/oras/internal/display/status/progress/manager.go	80.00%	5 Missing and 1 partial ⚠️
cmd/oras/root/blob/fetch.go	0.00%	4 Missing and 2 partials ⚠️
cmd/oras/root/blob/push.go	20.00%	2 Missing and 2 partials ⚠️
internal/progress/tracker.go	94.28%	3 Missing and 1 partial ⚠️
cmd/oras/internal/display/status/tty.go	90.62%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1524      +/-   ##
==========================================
- Coverage   84.33%   84.27%   -0.06%     
==========================================
  Files         120      121       +1     
  Lines        5464     5566     +102     
==========================================
+ Hits         4608     4691      +83     
- Misses        608      621      +13     
- Partials      248      254       +6

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

shizhMSFT · 2024-12-31T09:53:35Z

Now we have a failure mark on error:

Wwwsylvia

Built the code and tested a little bit. Got "panic: send on closed channel" error when running oras push localhost:5000/test:v1 foo.

shizhMSFT · 2025-01-07T09:40:02Z

Got "panic: send on closed channel" error when running

A ha. This PR indeed requires further refactoring.

Wwwsylvia

The panic problem is gone now. But it looks like the "Restored" keyword is not correctly showed.

shizhMSFT · 2025-02-17T14:42:09Z

The panic problem is gone now. But it looks like the "Restored" keyword is not correctly showed.

It's the skip. Thanks for catching it. And it is fixed.

qweeah

LGTM with minor suggestions.

Tracker.Update and some private methods in status.go can be further improved but it can be done in another PR.

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

qweeah

LGTM

shizhMSFT added the experimental Issues or pull requests depending on WIP specs label Nov 1, 2024

shizhMSFT mentioned this pull request Nov 1, 2024

Copy progress - feature request oras-project/oras-go#839

Open

github-actions Bot added the stale Inactive issues or pull requests label Dec 17, 2024

shizhMSFT force-pushed the progress branch from e275faa to 1a7b303 Compare December 30, 2024 06:23

shizhMSFT removed the stale Inactive issues or pull requests label Dec 30, 2024

shizhMSFT marked this pull request as ready for review December 31, 2024 09:51

shizhMSFT requested review from SteveLasker, TerryHowe, qweeah and sajayantony as code owners December 31, 2024 09:51

shizhMSFT changed the title ~~refactor(oras-go): generic progress tracking~~ refactor(progress): generic progress tracking Dec 31, 2024

shizhMSFT mentioned this pull request Dec 31, 2024

feat: track progress oras-project/oras-go#852

Closed

Wwwsylvia reviewed Jan 6, 2025

View reviewed changes

Comment thread cmd/oras/internal/display/status/tty.go Outdated

shizhMSFT force-pushed the progress branch 2 times, most recently from 5444f0a to 41eef7a Compare February 13, 2025 09:26

shizhMSFT force-pushed the progress branch from 58a1fd6 to 43a5165 Compare February 17, 2025 08:59

Wwwsylvia reviewed Feb 17, 2025

View reviewed changes

shizhMSFT force-pushed the progress branch from bcf769d to cd6b069 Compare February 18, 2025 12:58

shizhMSFT requested a review from Wwwsylvia February 18, 2025 12:59

shizhMSFT added this to the v1.3.0-beta.2 milestone Feb 18, 2025

shizhMSFT added enhancement New feature or request and removed experimental Issues or pull requests depending on WIP specs labels Feb 18, 2025

qweeah approved these changes Feb 19, 2025

View reviewed changes

shizhMSFT added 2 commits February 19, 2025 17:25

feat: add track manager

ae2a994

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

feat: use new track

09316f3

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

shizhMSFT added 22 commits February 19, 2025 17:25

fix: fix bugs and tests

0b60ea3

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

fix: fix status

b90bd20

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

fix: fix tracker and add tests

bec200d

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

refactor: remove unused ManagerFunc

f1a5a3f

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

feat: add failure case

19d6361

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

test: add test for status

fa8bddd

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

docs: fix typo

0623344

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

refactor: better render control

1f7aaac

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

refactor: refactor status

d323a45

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

docs: add doc to private methods

c97e76d

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

fix: fix the accidental reader close by http client

756d40a

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

fix: fix tty issue

b3954f3

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

chore: ignore error for stop tracker

d98616a

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

test: init status tests

191abef

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

test: test status

6c9775e

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

refactor: simplify and test messenger

476a25e

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

test: test manager

6a54bc1

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

feat: add a new restored status

5aa6733

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

refactor: rename prompt to prompts

8bddee4

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

docs: update docs for test utils

bc1e555

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

refactor: make messenger private

cee298f

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

docs: add docs to messenger

9b0a7a1

Signed-off-by: Shiwei Zhang <shizh@microsoft.com>

shizhMSFT force-pushed the progress branch from 594d101 to 9b0a7a1 Compare February 19, 2025 09:25

shizhMSFT mentioned this pull request Feb 19, 2025

refactor: use handlers for oras blob push command #1618

Merged

4 tasks

qweeah approved these changes Feb 19, 2025

View reviewed changes

shizhMSFT merged commit a9004d4 into oras-project:main Feb 19, 2025

shizhMSFT deleted the progress branch February 19, 2025 14:13

Wwwsylvia mentioned this pull request Feb 25, 2025

bump: tag and release ORAS CLI v1.3.0-beta.2 #1635

Merged

6 tasks

TerryHowe mentioned this pull request Apr 2, 2025

refactor: simplify track reader manager and messenger use #1474

Closed

Wwwsylvia mentioned this pull request Sep 3, 2025

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

Merged

6 tasks

Conversation

shizhMSFT commented Nov 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Dec 17, 2024

Uh oh!

codecov Bot commented Dec 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

shizhMSFT commented Dec 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Wwwsylvia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shizhMSFT commented Jan 7, 2025

Uh oh!

Wwwsylvia left a comment

Choose a reason for hiding this comment

Uh oh!

shizhMSFT commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qweeah left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qweeah left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

shizhMSFT commented Nov 1, 2024 •

edited

Loading

codecov Bot commented Dec 30, 2024 •

edited

Loading

shizhMSFT commented Dec 31, 2024 •

edited

Loading

shizhMSFT commented Feb 17, 2025 •

edited

Loading