[fix] tools-v2: fix incorrect error output #2802
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
Signed-off-by: saicaca <zephyird@gmail.com>
|
cicheck |
Cyber-SiKu
reviewed
Oct 23, 2023
| @@ -69,7 +70,7 @@ func (ce *CmdError) ToError() error { | |||
| if ce.Code == CODE_SUCCESS { | |||
| return nil | |||
| } | |||
| return fmt.Errorf(ce.Message) | |||
| return errors.New(ce.Message) | |||
There was a problem hiding this comment.
The effect is the same, why is it modified like this?
There was a problem hiding this comment.
As described in #2801, fmt.Errorf treats the input string as a format string. This can be problematic when the error message contains a % character (For example a web URL with non-ASCII characters). In such cases, the % character is mistakenly treated as the beginning of a format verb, leading to incorrect output. Using errors.New can fix this problem.
To illustrate, the following code snippet
msg := "GET failed: https://example.com?msg=hello%20world"
err1 := fmt.Errorf(msg)
err2 := errors.New(msg)
fmt.Println(err1.Error())
fmt.Println(err2.Error())outputs
GET failed: https://example.com?msg=hello%!w(MISSING)orld
GET failed: https://example.com?msg=hello%20world
|
cicheck |
baytan0720
approved these changes
Nov 2, 2023
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 problem does this PR solve?
Issue Number: #2801
Problem Summary: Error messages contains character
%cannot be output correctly because%is treated as the prefix of a format verb.What is changed and how it works?
What's Changed: Replaced
fmt.Errorf(ce.Message)witherrors.New(ce.Message)inToError()How it Works:
errors.Newtreats the error messages as plain text instead of format strings.Side effects(Breaking backward compatibility? Performance regression?):
Check List