refactor: allow custom handlers for processing push/pull status updates #2342
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
mharwani
force-pushed
the
mharwani/refactor-push-pull
branch
from
61efde6
to
458f034
Compare
ningziwen
reviewed
Jul 13, 2023
pkg/api/types/image_types.go
Outdated
| @@ -165,14 +169,15 @@ type ImagePushOptions struct { | |||
| IpfsAddress string | |||
| // Suppress verbose output | |||
| Quiet bool | |||
| // If non-nil, the Push job will send upload statuses to the handler instead of Stdout | |||
| ProgressHandler jobs.StatusHandler | |||
| // AllowNondistributableArtifacts allow pushing non-distributable artifacts | |||
| AllowNondistributableArtifacts bool | |||
| } | |||
|
|
|||
| // ImagePullOptions specifies options for `nerdctl (image) pull`. | |||
| type ImagePullOptions struct { | |||
| Stdout io.Writer | |||
There was a problem hiding this comment.
How about just removing Stdout and pass progressHandler as jobs.PrintProgress(cmd.OutOrStderr()) in CLI layer?
There was a problem hiding this comment.
Sounds good to me. The push command also prints the image reference to stdout if --quiet flag is set, so I have changed the push/pull method signature to return image reference along with error.
Signed-off-by: Mrudul Harwani <mharwani@amazon.com>
Signed-off-by: Mrudul Harwani <mharwani@amazon.com>
Signed-off-by: Mrudul Harwani <mharwani@amazon.com>
Signed-off-by: Mrudul Harwani <mharwani@amazon.com>
Signed-off-by: Mrudul Harwani <mharwani@amazon.com>
mharwani
force-pushed
the
mharwani/refactor-push-pull
branch
2 times, most recently
from
f29ec0e
to
2df8955
Compare
Signed-off-by: Mrudul Harwani <mharwani@amazon.com>
mharwani
force-pushed
the
mharwani/refactor-push-pull
branch
from
2df8955
to
747fe3d
Compare
ningziwen
approved these changes
Jul 22, 2023
ningziwen
reviewed
Jul 22, 2023
|
Needs rebase |
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.
Contributing to the refactoring issue #1680
Currently, the way image push/pull commands are refactored, it is difficult to obtain download/upload status updates programmatically. Nerdctl has its own printing logic, but users may want to handle status updates directly via code when importing those subcommands. These changes allow users to define custom handlers for processing status updates during push/pull.