refactor: Create tracked reader interface #1511
Closed
Conversation
This file contains 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
TerryHowe
requested review from
sajayantony,
shizhMSFT,
SteveLasker and
qweeah
as code owners
Signed-off-by: Terry Howe <[email protected]>
TerryHowe
force-pushed
the
track-reader
branch
from
7df760f to
0a4e476
Compare
qweeah
requested changes
Sep 29, 2024
| @@ -23,6 +23,14 @@ import ( | |||
| "oras.land/oras/cmd/oras/internal/display/status/progress" | |||
| ) | |||
|
|
|||
| type Reader interface { | |||
There was a problem hiding this comment.
Need comment doc for this interface.
| @@ -74,7 +76,7 @@ func (t *graphTarget) Mount(ctx context.Context, desc ocispec.Descriptor, fromRe | |||
|
|
|||
| // Push pushes the content to the base oras.GraphTarget with tracking. | |||
| func (t *graphTarget) Push(ctx context.Context, expected ocispec.Descriptor, content io.Reader) error { | |||
| r, err := managedReader(content, expected, t.manager, t.actionPrompt, t.donePrompt) | |||
| r, err := NewReader(content, expected, t.actionPrompt, t.donePrompt, t.tty) | |||
There was a problem hiding this comment.
A manager controls output to tty and cannot be be shared between track.Readers. I think that's why the unit tests are failing.
Comment on lines
+45
to
-58
| func NewReader(r io.Reader, descriptor ocispec.Descriptor, actionPrompt string, donePrompt string, tty *os.File) (Reader, error) { | ||
| manager, err := progress.NewManager(tty) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return managedReader(r, descriptor, manager, actionPrompt, donePrompt) | ||
| } | ||
|
|
||
| func managedReader(r io.Reader, descriptor ocispec.Descriptor, manager progress.Manager, actionPrompt string, donePrompt string) (*reader, error) { | ||
| messenger, err := manager.Add() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &reader{ | ||
| tr := reader{ | ||
| base: r, | ||
| descriptor: descriptor, | ||
| actionPrompt: actionPrompt, | ||
| donePrompt: donePrompt, | ||
| manager: manager, | ||
| messenger: messenger, | ||
| }, nil |
There was a problem hiding this comment.
It's not right to merge managedReader into NewReader. I would suggest to move it to target.go.
qweeah
reviewed
Sep 29, 2024
| @@ -35,6 +35,7 @@ type GraphTarget interface { | |||
|
|
|||
| type graphTarget struct { | |||
| oras.GraphTarget | |||
| tty *os.File | |||
There was a problem hiding this comment.
Manager should be the only way to access tty, trackable readers or targets should not access tty directly.
There was a problem hiding this comment.
The weirdness here is because this PR is part of #1474
Now that the console interface has merged, maybe the older PR is small enough
qweeah
requested changes
Sep 29, 2024
1 task
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.
What this PR does / why we need it:
Create an interface for the tracked reader.
This breaks out a small change from #1474