feat: escape tabs in tag strings #111
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
bednar
reviewed
Oct 17, 2024
influxdb3/point.go
Outdated
Comment on lines
251
to
265
| // N.B. Some customers have requested support for newline and tab chars in tag values (EAR 5476) | ||
| // Though this is outside the lineprotocol specification, it was supported in | ||
| // previous GO client versions. | ||
| tagEscapes := map[string]string{ | ||
| "\n": "\\n", | ||
| "\t": "\\t", | ||
| } | ||
|
|
||
| replacer := func(reps map[string]string, s string) string { | ||
| result := s | ||
| for key, val := range reps { | ||
| result = strings.ReplaceAll(result, key, val) | ||
| } | ||
| return result | ||
| } |
There was a problem hiding this comment.
What do you thinks about using package level Replacer?
Something like:
var replacer = strings.NewReplacer(
"\n", "\\n",
"\t", "\\t",
)and then use:
if value, ok := p.Values.Tags[tagKey]; ok {
enc.AddTag(tagKey, replacer.Replace(value))
} else {
enc.AddTag(tagKey, replacer.Replace(defaultTags[tagKey]))
}There was a problem hiding this comment.
Aha... I was unaware that the Replacer type already exists in the strings package. Updated.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #111 +/- ##
==========================================
+ Coverage 86.05% 86.12% +0.06%
==========================================
Files 15 15
Lines 1205 1211 +6
==========================================
+ Hits 1037 1043 +6
Misses 139 139
Partials 29 29 ☔ View full report in Codecov by Sentry. |
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.
Related https://github.com/influxdata/EAR/issues/5476#issuecomment-2417071571
Proposed Changes
point.MarshallBinaryWithDefaultTagsadd a mapping of strings to be escaped.TestPointWithNewLineTagstoTestPointWithEscapedTagsclient_e2e_testof tab (i.e.\t) escapes in tags.Checklist