Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: do not escape CSV output #24311

Merged
merged 1 commit into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cmd/influx_inspect/dumptsi/dumptsi.go
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ func (cmd *Command) printSeries(sfile *tsdb.SeriesFile) error {

deleted := sfile.IsDeleted(e.SeriesID)

fmt.Fprintf(tw, "%s%s\t%v\n", name, tags.HashKey(), deletedString(deleted))
fmt.Fprintf(tw, "%s%s\t%v\n", name, tags.HashKey(true), deletedString(deleted))
}

// Flush & write footer spacing.
Expand Down Expand Up @@ -373,7 +373,7 @@ func (cmd *Command) printTagValueSeries(sfile *tsdb.SeriesFile, fs *tsi1.FileSet
continue
}

fmt.Fprintf(tw, " %s%s\n", name, tags.HashKey())
fmt.Fprintf(tw, " %s%s\n", name, tags.HashKey(true))
if err := tw.Flush(); err != nil {
return fmt.Errorf("failed to flush tabwriter: %w", err)
}
Expand Down
10 changes: 5 additions & 5 deletions models/points.go
Original file line number Diff line number Diff line change
Expand Up @@ -1647,7 +1647,7 @@ func AppendMakeKey(dst []byte, name []byte, tags Tags) []byte {
// unescape the name and then re-escape it to avoid double escaping.
// The key should always be stored in escaped form.
dst = append(dst, EscapeMeasurement(unescapeMeasurement(name))...)
dst = tags.AppendHashKey(dst)
dst = tags.AppendHashKey(dst, true)
return dst
}

Expand Down Expand Up @@ -2208,8 +2208,8 @@ func (a Tags) Merge(other map[string]string) Tags {
}

// HashKey hashes all of a tag's keys.
func (a Tags) HashKey() []byte {
return a.AppendHashKey(nil)
func (a Tags) HashKey(escapeTags bool) []byte {
return a.AppendHashKey(nil, escapeTags)
}

func (a Tags) needsEscape() bool {
Expand All @@ -2226,7 +2226,7 @@ func (a Tags) needsEscape() bool {
}

// AppendHashKey appends the result of hashing all of a tag's keys and values to dst and returns the extended buffer.
func (a Tags) AppendHashKey(dst []byte) []byte {
func (a Tags) AppendHashKey(dst []byte, escapeTags bool) []byte {
// Empty maps marshal to empty bytes.
if len(a) == 0 {
return dst
Expand All @@ -2236,7 +2236,7 @@ func (a Tags) AppendHashKey(dst []byte) []byte {

sz := 0
var escaped Tags
if a.needsEscape() {
if escapeTags && a.needsEscape() {
var tmp [20]Tag
if len(a) < len(tmp) {
escaped = tmp[:len(a)]
Expand Down
8 changes: 4 additions & 4 deletions models/points_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ var (
)

func TestMarshal(t *testing.T) {
got := tags.HashKey()
got := tags.HashKey(true)
if exp := ",apple=orange,foo=bar,host=serverA,region=uswest"; string(got) != exp {
t.Log("got: ", string(got))
t.Log("exp: ", exp)
Expand Down Expand Up @@ -84,7 +84,7 @@ func TestMarshalFields(t *testing.T) {

func TestTags_HashKey(t *testing.T) {
tags = models.NewTags(map[string]string{"A FOO": "bar", "APPLE": "orange", "host": "serverA", "region": "uswest"})
got := tags.HashKey()
got := tags.HashKey(true)
if exp := ",A\\ FOO=bar,APPLE=orange,host=serverA,region=uswest"; string(got) != exp {
t.Log("got: ", string(got))
t.Log("exp: ", exp)
Expand All @@ -94,7 +94,7 @@ func TestTags_HashKey(t *testing.T) {

func BenchmarkMarshal(b *testing.B) {
for i := 0; i < b.N; i++ {
tags.HashKey()
tags.HashKey(true)
}
}
func TestPoint_Tags(t *testing.T) {
Expand Down Expand Up @@ -2526,7 +2526,7 @@ func BenchmarkTags_HashKey(b *testing.B) {
b.Run(bm.name, func(b *testing.B) {
b.ReportAllocs()
for i := 0; i < b.N; i++ {
bm.t.HashKey()
bm.t.HashKey(true)
}
})
}
Expand Down
4 changes: 2 additions & 2 deletions monitor/service_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ func TestMonitor_Expvar(t *testing.T) {
var found1, found3 bool
for _, pt := range points {
if bytes.Equal(pt.Name(), []byte("expvar1")) {
if got, want := pt.Tags().HashKey(), []byte(fmt.Sprintf(",hostname=%s,region=uswest2", hostname)); !reflect.DeepEqual(got, want) {
if got, want := pt.Tags().HashKey(true), []byte(fmt.Sprintf(",hostname=%s,region=uswest2", hostname)); !reflect.DeepEqual(got, want) {
t.Errorf("unexpected expvar1 tags: got=%v want=%v", string(got), string(want))
}
fields, _ := pt.Fields()
Expand All @@ -367,7 +367,7 @@ func TestMonitor_Expvar(t *testing.T) {
} else if bytes.Equal(pt.Name(), []byte("expvar2")) {
t.Error("found expvar2 statistic")
} else if bytes.Equal(pt.Name(), []byte("expvar3")) {
if got, want := pt.Tags().HashKey(), []byte(fmt.Sprintf(",hostname=%s", hostname)); !reflect.DeepEqual(got, want) {
if got, want := pt.Tags().HashKey(true), []byte(fmt.Sprintf(",hostname=%s", hostname)); !reflect.DeepEqual(got, want) {
t.Errorf("unexpected expvar3 tags: got=%v want=%v", string(got), string(want))
}
fields, _ := pt.Fields()
Expand Down
2 changes: 1 addition & 1 deletion services/httpd/response_writer.go
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ func (f *csvFormatter) WriteResponse(w io.Writer, resp Response) (err error) {
f.columns[0] = row.Name
f.columns[1] = ""
if len(row.Tags) > 0 {
hashKey := models.NewTags(row.Tags).HashKey()
hashKey := models.NewTags(row.Tags).HashKey(false)
if len(hashKey) > 0 {
f.columns[1] = string(hashKey[1:])
}
Expand Down
2 changes: 1 addition & 1 deletion storage/reads/resultset_lineprotocol.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ func ResultSetToLineProtocol(wr io.Writer, rs ResultSet) (err error) {
line = append(line[:0], name...)
if tags.Len() > 2 {
tags = tags[1 : len(tags)-1] // take first and last elements which are measurement and field keys
line = tags.AppendHashKey(line)
line = tags.AppendHashKey(line, true)
}

line = append(line, ' ')
Expand Down
2 changes: 1 addition & 1 deletion storage/reads/store_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ func joinString(b [][]byte) string {
}

func tagsToString(wr io.Writer, tags models.Tags, opts ...optionFn) {
if k := tags.HashKey(); len(k) > 0 {
if k := tags.HashKey(true); len(k) > 0 {
fmt.Fprintf(wr, "%s", string(k[1:]))
}
fmt.Fprintln(wr)
Expand Down
2 changes: 1 addition & 1 deletion tsdb/engine/tsm1/engine_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1141,7 +1141,7 @@ func TestIndex_SeriesIDSet(t *testing.T) {
}

name, tags := tsdb.ParseSeriesKey(engine.sfile.SeriesKey(e.SeriesID))
key := fmt.Sprintf("%s%s", name, tags.HashKey())
key := fmt.Sprintf("%s%s", name, tags.HashKey(true))
seriesIDMap[key] = e.SeriesID
}

Expand Down
2 changes: 1 addition & 1 deletion tsdb/index_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ func (idx *Index) IndexSet() *tsdb.IndexSet {

func (idx *Index) AddSeries(name string, tags map[string]string) error {
t := models.NewTags(tags)
key := fmt.Sprintf("%s,%s", name, t.HashKey())
key := fmt.Sprintf("%s,%s", name, t.HashKey(true))
return idx.CreateSeriesIfNotExists([]byte(key), []byte(name), t, tsdb.NoopStatsTracker())
}

Expand Down