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

log: Fix comparison of unordered map values #5306

Merged
merged 8 commits into from
May 15, 2024
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
### Fixed

- Fix the empty output of `go.opentelemetry.io/otel/log.Value` in `go.opentelemetry.io/otel/exporters/stdout/stdoutlog`. (#5311)
- Comparison of unordered maps in `go.opentelemetry.io/otel/log.KeyValue` and `go.opentelemetry.io/otel/log.Value`. (#5306)

## [1.26.0/0.48.0/0.2.0-alpha] 2024-04-24

Expand Down
15 changes: 14 additions & 1 deletion log/keyvalue.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ package log // import "go.opentelemetry.io/otel/log"

import (
"bytes"
"cmp"
"errors"
"fmt"
"math"
Expand Down Expand Up @@ -256,7 +257,9 @@ func (v Value) Equal(w Value) bool {
case KindSlice:
return slices.EqualFunc(v.asSlice(), w.asSlice(), Value.Equal)
case KindMap:
return slices.EqualFunc(v.asMap(), w.asMap(), KeyValue.Equal)
sv := sortMap(v.asMap())
sw := sortMap(w.asMap())
return slices.EqualFunc(sv, sw, KeyValue.Equal)
case KindBytes:
return bytes.Equal(v.asBytes(), w.asBytes())
case KindEmpty:
Expand All @@ -267,6 +270,16 @@ func (v Value) Equal(w Value) bool {
}
}

func sortMap(m []KeyValue) []KeyValue {
sm := make([]KeyValue, len(m))
copy(sm, m)
slices.SortFunc(sm, func(a, b KeyValue) int {
return cmp.Compare(a.Key, b.Key)
})

return sm
dmathieu marked this conversation as resolved.
Show resolved Hide resolved
}

// String returns Value's value as a string, formatted like [fmt.Sprint].
//
// The returned string is meant for debugging;
Expand Down
31 changes: 31 additions & 0 deletions log/keyvalue_bench_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,34 @@ func BenchmarkString(b *testing.B) {
}
})
}

func BenchmarkValueEqual(b *testing.B) {
vals := []log.Value{
{},
log.Int64Value(1),
log.Int64Value(2),
log.Float64Value(3.5),
log.Float64Value(3.7),
log.BoolValue(true),
log.BoolValue(false),
log.StringValue("hi"),
log.StringValue("bye"),
log.BytesValue([]byte{1, 3, 5}),
log.SliceValue(log.StringValue("foo")),
log.SliceValue(log.IntValue(3), log.StringValue("foo")),
log.MapValue(log.Bool("b", true), log.Int("i", 3)),
log.MapValue(
log.Slice("l", log.IntValue(3), log.StringValue("foo")),
log.Bytes("b", []byte{3, 5, 7}),
log.Empty("e"),
),
}
for _, v1 := range vals {
for _, v2 := range vals {
b.Run(v1.String()+" with "+v2.String(), func(b *testing.B) {
b.ReportAllocs()
_ = v1.Equal(v2)
})
}
}
}
25 changes: 25 additions & 0 deletions log/keyvalue_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,31 @@ func TestValueEqual(t *testing.T) {
}
}

func TestSortedValueEqual(t *testing.T) {
testCases := []struct {
value log.Value
value2 log.Value
}{
{
value: log.MapValue(
log.Slice("l", log.IntValue(3), log.StringValue("foo")),
log.Bytes("b", []byte{3, 5, 7}),
log.Empty("e"),
),
value2: log.MapValue(
log.Bytes("b", []byte{3, 5, 7}),
log.Slice("l", log.IntValue(3), log.StringValue("foo")),
log.Empty("e"),
),
},
}
for _, tc := range testCases {
t.Run(tc.value.String(), func(t *testing.T) {
assert.Equal(t, true, tc.value.Equal(tc.value2), "%v.Equal(%v)", tc.value, tc.value2)
})
}
dmathieu marked this conversation as resolved.
Show resolved Hide resolved
}

func TestValueEmpty(t *testing.T) {
v := log.Value{}
t.Run("Value.Empty", func(t *testing.T) {
Expand Down