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

[pdata] Rename pcommon.NewValueString to pcommon.NewValueStr #6209

Merged
merged 1 commit into from
Sep 30, 2022
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 @@ -5,6 +5,7 @@
### 🚩 Deprecations 🚩

- Deprecate `p[metric|log|trace]otlp.RegiserServer` in favor of `p[metric|log|trace]otlp.RegiserGRPCServer` (#6180)
- Deprecate `pcommon.NewValueString` in favor of `pcommon.NewValueStr` (#6209)

### 💡 Enhancements 💡

Expand Down
9 changes: 6 additions & 3 deletions pdata/pcommon/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ func (avt ValueType) String() string {
//
// func f1(val Value) { val.SetInt(234) }
// func f2() {
// v := NewValueString("a string")
// v := NewValueStr("a string")
// f1(v)
// _ := v.Type() // this will return ValueTypeInt
// }
Expand All @@ -93,11 +93,14 @@ func NewValueEmpty() Value {
return newValue(&otlpcommon.AnyValue{})
}

// NewValueString creates a new Value with the given string value.
func NewValueString(v string) Value {
// NewValueStr creates a new Value with the given string value.
func NewValueStr(v string) Value {
return newValue(&otlpcommon.AnyValue{Value: &otlpcommon.AnyValue_StringValue{StringValue: v}})
}

// Deprecated: [0.62.0] Use NewValueStr instead.
var NewValueString = NewValueStr

// NewValueInt creates a new Value with the given int64 value.
func NewValueInt(v int64) Value {
return newValue(&otlpcommon.AnyValue{Value: &otlpcommon.AnyValue_IntValue{IntValue: v}})
Expand Down
28 changes: 14 additions & 14 deletions pdata/pcommon/common_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import (
)

func TestValue(t *testing.T) {
v := NewValueString("abc")
v := NewValueStr("abc")
assert.EqualValues(t, ValueTypeStr, v.Type())
assert.EqualValues(t, "abc", v.Str())

Expand Down Expand Up @@ -89,7 +89,7 @@ func TestValueMap(t *testing.T) {
assert.Equal(t, 1, m2.Len())
got, exists = m2.Get("key_in_child")
assert.True(t, exists)
assert.Equal(t, NewValueString("somestr"), got)
assert.Equal(t, NewValueStr("somestr"), got)

// Insert the second map as a child. This should perform a deep copy.
assert.EqualValues(t, 2, m1.MapVal().Len())
Expand All @@ -105,26 +105,26 @@ func TestValueMap(t *testing.T) {
assert.EqualValues(t, 1, m2.Len())
got, exists = m2.Get("key_in_child")
assert.True(t, exists)
assert.Equal(t, NewValueString("somestr2"), got)
assert.Equal(t, NewValueStr("somestr2"), got)

// The child map inside m1 should be modified.
childMap, childMapExists := m1.MapVal().Get("child_map")
require.True(t, childMapExists)
got, exists = childMap.Map().Get("key_in_child")
require.True(t, exists)
assert.Equal(t, NewValueString("somestr2"), got)
assert.Equal(t, NewValueStr("somestr2"), got)

// Now modify the inserted map (not the source)
childMap.MapVal().PutString("key_in_child", "somestr3")
assert.EqualValues(t, 1, childMap.MapVal().Len())
got, exists = childMap.MapVal().Get("key_in_child")
require.True(t, exists)
assert.Equal(t, NewValueString("somestr3"), got)
assert.Equal(t, NewValueStr("somestr3"), got)

// The source child map should be modified.
got, exists = m2.Get("key_in_child")
require.True(t, exists)
assert.Equal(t, NewValueString("somestr3"), got)
assert.Equal(t, NewValueStr("somestr3"), got)

removed := m1.Map().Remove("double_key")
assert.True(t, removed)
Expand Down Expand Up @@ -180,14 +180,14 @@ func TestValueEqual(t *testing.T) {
av2 := NewValueEmpty()
assert.True(t, av1.Equal(av2))

av2 = NewValueString("abc")
av2 = NewValueStr("abc")
assert.False(t, av1.Equal(av2))
assert.False(t, av2.Equal(av1))

av1 = NewValueString("abc")
av1 = NewValueStr("abc")
assert.True(t, av1.Equal(av2))

av2 = NewValueString("edf")
av2 = NewValueStr("edf")
assert.False(t, av1.Equal(av2))

av2 = NewValueInt(123)
Expand Down Expand Up @@ -755,7 +755,7 @@ func TestValueSlice(t *testing.T) {

a2.Slice().AppendEmpty().SetStr("somestr")
assert.EqualValues(t, 1, a2.Slice().Len())
assert.EqualValues(t, NewValueString("somestr"), a2.Slice().At(0))
assert.EqualValues(t, NewValueStr("somestr"), a2.Slice().At(0))

// Insert the second array as a child.
a2.CopyTo(a1.Slice().AppendEmpty())
Expand Down Expand Up @@ -806,7 +806,7 @@ func TestAsString(t *testing.T) {
}{
{
name: "string",
input: NewValueString("string value"),
input: NewValueStr("string value"),
expected: "string value",
},
{
Expand Down Expand Up @@ -881,7 +881,7 @@ func TestValueAsRaw(t *testing.T) {
}{
{
name: "string",
input: NewValueString("value"),
input: NewValueStr("value"),
expected: "value",
},
{
Expand Down Expand Up @@ -961,7 +961,7 @@ func TestNewValueFromRaw(t *testing.T) {
{
name: "string",
input: "text",
expected: NewValueString("text"),
expected: NewValueStr("text"),
},
{
name: "int",
Expand Down Expand Up @@ -1079,7 +1079,7 @@ func TestNewValueFromRaw(t *testing.T) {
name: "invalid value",
input: ValueTypeDouble,
expected: (func() Value {
return NewValueString("<Invalid value type pcommon.ValueType>")
return NewValueStr("<Invalid value type pcommon.ValueType>")
})(),
},
}
Expand Down