Treat output from TextMarshaler as string #698
Merged
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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #698 +/- ##
==========================================
+ Coverage 77.89% 77.92% +0.03%
==========================================
Files 22 22
Lines 7965 7965
==========================================
+ Hits 6204 6207 +3
+ Misses 1348 1346 -2
+ Partials 413 412 -1 🚀 New features to boost your workflow:
|
goccy
reviewed
May 5, 2025
| @@ -400,20 +400,21 @@ func (e *Encoder) encodeByMarshaler(ctx context.Context, v reflect.Value, column | |||
| if t, ok := iface.(time.Time); ok { | |||
| return e.encodeTime(t, column), nil | |||
| } | |||
| // Handle *time.Time explicitly since it implements TextMarshaler and shouldn't be treated as plain text | |||
| if t, ok := iface.(*time.Time); ok && t != nil { | |||
There was a problem hiding this comment.
This works correctly 👍
Since isInvalidValue becomes true at the beginning of encodeValue when *time.Time is nil, this process is always executed only when *time.Time is not nil.
|
Thank you for your great PR ! LGTM 👍 |
nieomylnieja
added a commit
to nobl9/nobl9-go
that referenced
this pull request
May 12, 2025
…65] (#708) ## Summary Pinned the `go-yaml` version until goccy/go-yaml#698 is released. ## Release Notes Fixes segmentation violation errors when `apiVersion` was set to an empty string in any of the v1alpha objects.
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.
Closes #689.
The original issue was that since
null.StringFromimplements theTextMarshalerinterface,goccy/go-yamltries to interpret its output as a YAML document usinge.encodeDocument. However, because the output contains a special character (in this case,#), the parser fails to handle it correctly and returnsnil.IIUC, the output from a
TextMarshalerimplementation should not be interpreted as a YAML document. It should be treated as a plain string, sinceTextMarshaleris intended to return a textual representation of a value. This behavior is consistent withgopkg.in/yaml.v3.One side effect I noticed after making this change is related to how
*time.Timeis encoded. Previously, since*time.Timealso implementsTextMarshaler, it was being encoded by the code block below. After treating the output fromMarshalText()as a string, the library started wrapping*time.Timevalues in double quotes. To prevent this, I updated theencodeByMarshalerfunction to handle*time.Timeexplicitly.