fix: Prevent needless CLI parsing #884
Merged
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
nderjung
force-pushed
the
nderjung/fix/cmdfactory/double-parsing
branch
from
f2993dd
to
e33b8e3
Compare
Initially, `cmd.ParseFlags` in the `AttributeFlags` method was used to associate the provided list of command-line arguments with the respectively registered flag. However, `AttributeFlags` has since been modified to make this association by directly calling `flag.Set`. Furthermore, calling `cmd.ParseFlags` consistently had the unintended sideaffect of populating initialized slice structures with duplicate values. To mitigate against double parsing, which results in duplicate values in, for example, slice types, remove this additional parsing of the flags. We call `cmd.ParseFlags` only once after the config manager has bee attributed as these values are required by subsequent context systems (e.g. logging). To prevent double parsing on the root command, set `DisableFlagParsing` to true such that cobra's `ExecuteContext` method does not end up calling this again on the root command. This also has the benefit of greatly simplify the code by removing the previously imported `execute` and `executeC` to prevent internal parsing[0]. [0]: unikraft@1e6c1a4 Signed-off-by: Alexander Jung <alex@unikraft.io>
nderjung
force-pushed
the
nderjung/fix/cmdfactory/double-parsing
branch
from
e33b8e3
to
929cffd
Compare
craciunoiuc
approved these changes
Oct 17, 2023
There was a problem hiding this comment.
All good here. Thanks!
Reviewed-by: Cezar Craciunoiu cezar.craciunoiu@unikraft.io
Approved-by: Cezar Craciunoiu cezar.craciunoiu@unikraft.io
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.
Prerequisite checklist
make fmton your commit series before opening this PR;Description of changes
Initially,
cmd.ParseFlagsin theAttributeFlagsmethod was used to associate the provided list of command-line arguments with the respectively registered flag. However,AttributeFlagshas since been modified to make this association by directly callingflag.Set. Furthermore, callingcmd.ParseFlagsconsistently had the unintended side-affect of populating initialized slice structures with duplicate values.To mitigate against double parsing, which results in duplicate values in, for example, slice types, remove this additional parsing of the flags.
We call
cmd.ParseFlagsonly once after the config manager has been attributed as these values are required by subsequent context systems (e.g. logging). To prevent double parsing on the root command, setDisableFlagParsingto true such that cobra'sExecuteContextmethod does not end up calling this again on the root command.This also has the benefit of greatly simplify the code by removing the previously imported
executeandexecuteCto prevent internal parsing and fixing command completion and listing inherited flags.