fix: RunCommand() should not throw when exit is checked #11871
Merged
+21
−37
Conversation
This file contains hidden or 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
Some methods intend to check the Git output, but the command always throws at exit. throwOnErrorExit need to be configurable for these methods. This occurs for instance when checking the characters in a branch name and staging files.
RussKie
approved these changes
Sep 3, 2024
gerhardol
commented
Sep 3, 2024
src/app/GitCommands/Git/GitModule.cs
Outdated
| GitArgumentBuilder args = new("check-ref-format") | ||
| { | ||
| "--branch", | ||
| branchName.QuoteNE() | ||
| }; | ||
| return _gitExecutable.RunCommand(args); | ||
| return _gitExecutable.RunCommand(args, throwOnErrorExit: false); |
There was a problem hiding this comment.
Will change this call to the standard execute that return result to get rid of the printout too.
mstv
reviewed
Sep 3, 2024
src/app/GitCommands/Git/GitModule.cs
Outdated
| @@ -1779,7 +1779,8 @@ public bool StageFile(string file) | |||
| { | |||
| "--add", | |||
| file.ToPosixPath().Quote() | |||
| }); | |||
| }, | |||
| throwOnErrorExit: false); | |||
There was a problem hiding this comment.
As the result of StageFile is never evaluated, rather remove the return value and throw.
If there are known uncritical exit codes, please handle them explicitly.
There was a problem hiding this comment.
OK, changes requires changes of the plugin interface though.
Some methods intend to check the Git output, but the command always throws at exit. throwOnErrorExit need to be configurable for these methods. This occurs for instance when checking the characters in a branch name and staging files. Avoid echoing the branchname when creating a branch (as output in RunCommand() is written to the console).
mstv
approved these changes
Sep 4, 2024
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.
Fixes #11869
Proposed changes
Some methods intend to check the Git output, but the command always throws at exit.
throwOnErrorExit need to be configurable for these methods.
Quotes were additionally quouted too (done in QuoteNE())
This occurs for instance when checking the characters in a branch name and staging files.
Note that the command still echoes the branchname to the console.
While Git allows quotes in branch names, Windows does not (this is a file) allow quotes in the name.
Note: There are a few calls of RunCommand() that could be supressed in addition to those thatactually check the output, but I left it at the checked calls.
This cannot be be too commonly occurring as the throwOnErrorExit checks were added in 4.1 or 4.0.
Screenshots
Before
NBug
After
Test methodology
Manual
Merge strategy
I agree that the maintainer squash merge this PR (if the commit message is clear).
✒️ I contribute this code under The Developer Certificate of Origin.