Bring back fmt.Stringer implementation for interpreter.Value #969
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
Codecov Report
@@ Coverage Diff @@
## master #969 +/- ##
==========================================
+ Coverage 75.42% 75.46% +0.03%
==========================================
Files 268 268
Lines 32773 32868 +95
==========================================
+ Hits 24720 24803 +83
- Misses 6921 6929 +8
- Partials 1132 1136 +4
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
SupunS
approved these changes
Jun 3, 2021
| @@ -6751,7 +6858,7 @@ func formatComposite(typeId string, fields *StringValueOrderedMap, results Strin | |||
| Value string | |||
| }{ | |||
| Name: fieldName, | |||
| Value: value.String(results), | |||
| Value: value.RecursiveString(results), | |||
Co-authored-by: Supun Setunga <supun.setunga@gmail.com>
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.
Description
In #906 we refactored the string formatting of interpreter values so it supports recursive structures (due to references). This PR then removed support for
fmt.Stringer.This is problematic, because many parts of the code, most prominently errors, rely on values implementing
String()implicitly by usingfmtfunctions with the%sformat directive.Now that support for
String()was removed from values, error messages were rendered incorrectly.Most notably, address values are just byte slices, and Go's default formatting, which will be used when the value does not implement
fmt.Stringer, will encode the bytes directly as-is. For example, the byte slice[]byte{0x1, 0x2}results in the Go string"\x01\x02"– which is not valid UTF-8.This results in problems in downstream dependencies like flow-go, which requires strings to be valid UTF-8 (e.g. for Protocol Buffer encoding).
Bringing back support for
fmt.Stringerthus also fixes many error messages that are currently incorrectly formatted.masterbranchFiles changedin the Github PR explorer