Fixing issue #2392 #2402
Draft
Fixing issue #2392 #2402
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
There were two problems addressed here. First, the call to Diagram was causing the second error to be added to the ParseResult.Errors collection. The diagram call, was being invoked by the debugger as part of the ParseResult.ToString() method. Causing the number of errors to change when inspecting a parse result. The second issue was the error message text. It was implying that the option expected a single value, when its arity allowed for more.
| @@ -14,11 +14,23 @@ namespace System.CommandLine | |||
| internal static class LocalizationResources | |||
| { | |||
| /// <summary> | |||
| /// Interpolates values into a localized string similar to Command '{0}' expects a single argument but {1} were provided. | |||
| /// Interpolates values into a localized string similar to Option '{0}' expects a single argument but {1} were provided. | |||
There was a problem hiding this comment.
Isn't this used by both options and commands?
There was a problem hiding this comment.
This was to make the comment match the actual value that is getting returned. I believe the only usage is for options. I suspect this comment was wrong from a copy and paste error when we initially did the localization resources.
| @@ -125,7 +125,7 @@ private void ValidateOptions(bool completeValidation) | |||
| // When_there_is_an_arity_error_then_further_errors_are_not_reported | |||
| if (!ArgumentArity.Validate(argumentResult, out var error)) | |||
| { | |||
| optionResult.AddError(error.ErrorMessage!); | |||
| argumentResult.AddError(error.ErrorMessage!); | |||
There was a problem hiding this comment.
I do not understand this change. If this is on options, I thought we got the errors from the option. Do we get them from the option's argument?
There was a problem hiding this comment.
This was one of the key fixes, that was causing the diagram command to insert a duplicate error.
The process looks like this:
- During the Parse, this line was invoked and the error was added to the OptionResult.
- The AddError method adds the error into the SymbolResultTree, and keys it based on the symbol. However, ArgumentResult.AddError method has a special case for options, where it will use the OptionResult if that is the parent. So in either case the error is added to the SymbolResultTree with the OptionResult as the key. However, in the case of the ArgumentResult.AddError it also sets the _conversionResult. So the change here still sets the error on the OptionResult, but it also causes the
_conversionResultfield to be set. - When calling the Diagram (and likely this bug exists with other code paths as well), it will call ArgumentResult.GetArgumentConversionResult. That method will call
ValidateAndConvertif the_conversionResultis null. CallingValidateAndConvertwill add an error to the result. This was the result of the second error being added. - Because Diagram was being invoked from the ParseResult.ToString() it was being invoked whenever the debugger inspected a ParseResult. This was the reason for the un-usual behavior that you saw.
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.
There were two problems addressed here.
First, the call to Diagram was causing the second error to be added to the ParseResult.Errors collection. The diagram call, was being invoked by the debugger as part of the ParseResult.ToString() method. Causing the number of errors to change when inspecting a parse result.
The second issue was the error message text. It was implying that the option expected a single value, when its arity allowed for more.