fix double completion of option sets in CLI #1015
Open
+27
−7
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
mandelsoft
requested review from
hilmarf,
fabianburth and
8R0WNI3
and removed request for
8R0WNI3
hilmarf
added
the
area/performance
hilmarf
previously approved these changes
Oct 25, 2024
Skarlso
reviewed
Oct 25, 2024
| @@ -70,16 +71,19 @@ type OptionWithSessionCompleter interface { | |||
| CompleteWithSession(ctx clictx.OCM, session ocm.Session) error | |||
| } | |||
|
|
|||
| func CompleteOptionsWithSession(ctx clictx.Context, session ocm.Session) options.OptionsProcessor { | |||
| func CompleteOptionsWithSession(ctx clictx.Context, session ocm.Session, all ...bool) options.OptionsProcessor { | |||
| other := general.Optional(all...) | |||
There was a problem hiding this comment.
This conveys no information for me. Why are we using this? What does this accomplish? What is other? Why is this needed here? What is Complete doing? What is Configure doing? This code doesn't explain anything and the names don't mean anything.
Please add some documentation or comments or rename some variables.
There was a problem hiding this comment.
The PR docu is not in the code. If I look at this code a couple days from now, I won't be trying to look up the PR to find what's going on in there. Please add documentation directly on the function.
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
CLI Option objects typically feature some completion method. It is used to check values set by CLI options and to provide derived fields.
There are different flavors for such completion methods, without any argument, with some context object or with a session object, according to the requirement of the completion function.
The
Runmethod of a CLI command is called by a Cobra wrapper. THis wrapper knows about the context object for the command and already calls the session-less compöletion flavors.Some commands have options whose completion method requires a session object. This cannot be called by the command wrapper, because the existence of a session is specific for dedicated command implementations. Therefore, those command call the function
CompleteOptionsWithSessionto create an option processor completing the configured optio set with a session.The current implementation not only tries the session variant but all other variants, also.
Therefore, completion of options using the standard completion behaviour are completed twice.
The fix changed this behaviour to process the standard completion flavors only if explicitly requested. By default, only the session variant is called (because the others are already called by the used command wrapper.
This problem has be detected, because configured upload handlers (per CLI option) were registered twice.
Which issue(s) this PR fixes