[pdata] Rename NumberDataPoint/Exemplar.Type methods to ValueType (…

…#4850) Deprecate `NumberDataPoint.Type()` and `Exemplar.Type()` in favor of `NumberDataPoint.ValueType()` and `Exemplar.ValueType()` instead. Do not use accessorType in the pdatagen, always rely on proto field type for consistency.
open-telemetry · Feb 11, 2022 · 4137ef0 · 4137ef0
1 parent 8646986
commit 4137ef0
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 40 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,11 @@
 - Reject invalid queue size exporterhelper (#4799)
 - Transform configmapprovider.Retrieved interface to a struct (#4789)
 
+## 🚩 Deprecations 🚩
+
+- Deprecate `pdata.NumberDataPoint.Type()` and `pdata.Exemplar.Type()` in favor of `NumberDataPoint.ValueType()` and
+  `Exemplar.ValueType()` (#4850)
+
 ## v0.44.0 Beta
 
 ## 🛑 Breaking changes 🛑

diff --git a/internal/otlptext/databuffer.go b/internal/otlptext/databuffer.go
@@ -97,7 +97,7 @@ func (b *dataBuffer) logNumberDataPoints(ps pdata.NumberDataPointSlice) {
 
 		b.logEntry("StartTimestamp: %s", p.StartTimestamp())
 		b.logEntry("Timestamp: %s", p.Timestamp())
-		switch p.Type() {
+		switch p.ValueType() {
 		case pdata.MetricValueTypeInt:
 			b.logEntry("Value: %d", p.IntVal())
 		case pdata.MetricValueTypeDouble:

diff --git a/model/internal/cmd/pdatagen/internal/base_fields.go b/model/internal/cmd/pdatagen/internal/base_fields.go
@@ -53,41 +53,41 @@ func (ms ${structName}) Set${fieldName}(v ${returnType}) {
 	(*ms.orig).${originFieldName} = v
 }`
 
-const oneOfTypeAccessorHeaderTemplate = `// ${typeAccessor} returns the type of the ${lowerOriginFieldName} for this ${structName}.
+const oneOfTypeAccessorHeaderTemplate = `// ${originFieldName}Type returns the type of the ${lowerOriginFieldName} for this ${structName}.
 // Calling this function on zero-initialized ${structName} will cause a panic.
-func (ms ${structName}) ${typeAccessor}() ${typeName} {
+func (ms ${structName}) ${originFieldName}Type() ${typeName} {
 	switch ms.orig.${originFieldName}.(type) {`
 
-const oneOfTypeAccessorHeaderTestTemplate = `func Test${structName}${typeAccessor}(t *testing.T) {
+const oneOfTypeAccessorHeaderTestTemplate = `func Test${structName}${originFieldName}Type(t *testing.T) {
 	tv := New${structName}()
-	assert.Equal(t, ${typeName}None, tv.${typeAccessor}())
+	assert.Equal(t, ${typeName}None, tv.${originFieldName}Type())
 	assert.Equal(t, "", ${typeName}(1000).String())`
 
 const accessorsOneOfMessageTemplate = `// ${fieldName} returns the ${lowerFieldName} associated with this ${structName}.
-// Calling this function when ${typeAccessor}() != ${typeName} will cause a panic.
+// Calling this function when ${originOneOfFieldName}Type() != ${typeName} will cause a panic.
 // Calling this function on zero-initialized ${structName} will cause a panic.
 func (ms ${structName}) ${fieldName}() ${returnType} {
 	return new${returnType}((*ms.orig).${originOneOfFieldName}.(*${originStructType}).${originFieldName})
 }`
 
 const accessorsOneOfMessageTestTemplate = `func Test${structName}_${fieldName}(t *testing.T) {
 	ms := New${structName}()
-	ms.Set${typeAccessor}(${typeName})
+	ms.Set${originOneOfFieldName}Type(${typeName})
 	fillTest${returnType}(ms.${fieldName}())
 	assert.EqualValues(t, generateTest${returnType}(), ms.${fieldName}())
 }
 
 func Test${structName}_CopyTo_${fieldName}(t *testing.T) {
 	ms := New${structName}()
-	ms.Set${typeAccessor}(${typeName})
+	ms.Set${originOneOfFieldName}Type(${typeName})
 	fillTest${returnType}(ms.${fieldName}())
 	dest := New${structName}()
 	ms.CopyTo(dest)
 	assert.EqualValues(t, ms, dest)
 }`
 
 const copyToValueOneOfMessageTemplate = `	case ${typeName}:
-		dest.Set${typeAccessor}(${typeName})
+		dest.Set${originOneOfFieldName}Type(${typeName})
 		ms.${fieldName}().CopyTo(dest.${fieldName}())`
 
 const accessorsOneOfPrimitiveTemplate = `// ${fieldName} returns the ${lowerFieldName} associated with this ${structName}.
@@ -411,7 +411,6 @@ var _ baseField = (*primitiveStructField)(nil)
 type oneOfField struct {
 	originTypePrefix string
 	originFieldName  string
-	typeAccessor     string
 	typeName         string
 	testValueIdx     int
 	values           []oneOfValue
@@ -435,8 +434,6 @@ func (of *oneOfField) generateTypeAccessors(ms baseStruct, sb *strings.Builder)
 			return of.originFieldName
 		case "structName":
 			return ms.getName()
-		case "typeAccessor":
-			return of.typeAccessor
 		case "typeName":
 			return of.typeName
 		default:
@@ -466,8 +463,8 @@ func (of *oneOfField) generateTypeAccessorsTest(ms baseStruct, sb *strings.Build
 		switch name {
 		case "structName":
 			return ms.getName()
-		case "typeAccessor":
-			return of.typeAccessor
+		case "originFieldName":
+			return of.originFieldName
 		case "typeName":
 			return of.typeName
 		default:
@@ -477,7 +474,8 @@ func (of *oneOfField) generateTypeAccessorsTest(ms baseStruct, sb *strings.Build
 	sb.WriteString("\n")
 	for _, v := range of.values {
 		v.generateSetWithTestValue(of, sb)
-		sb.WriteString("\n\tassert.Equal(t, " + of.typeName + v.getFieldType() + ", tv." + of.typeAccessor + "())\n")
+		sb.WriteString("\n\tassert.Equal(t, " + of.typeName + v.getFieldType() + ", " +
+			"tv." + of.originFieldName + "Type())\n")
 	}
 	sb.WriteString("}\n")
 }
@@ -487,7 +485,7 @@ func (of *oneOfField) generateSetWithTestValue(sb *strings.Builder) {
 }
 
 func (of *oneOfField) generateCopyToValue(sb *strings.Builder) {
-	sb.WriteString("\tswitch ms." + of.typeAccessor + "() {\n")
+	sb.WriteString("\tswitch ms." + of.originFieldName + "Type() {\n")
 	for _, v := range of.values {
 		v.generateCopyToValue(of, sb)
 	}
@@ -603,8 +601,6 @@ func (omv *oneOfMessageValue) generateAccessors(ms baseStruct, of *oneOfField, s
 			return omv.returnMessage.structName
 		case "structName":
 			return ms.getName()
-		case "typeAccessor":
-			return of.typeAccessor
 		case "typeName":
 			return of.typeName + omv.returnMessage.structName
 		default:
@@ -623,8 +619,8 @@ func (omv *oneOfMessageValue) generateTests(ms baseStruct, of *oneOfField, sb *s
 			return omv.fieldName
 		case "returnType":
 			return omv.returnMessage.structName
-		case "typeAccessor":
-			return of.typeAccessor
+		case "originOneOfFieldName":
+			return of.originFieldName
 		case "typeName":
 			return of.typeName + omv.returnMessage.structName
 		default:
@@ -635,7 +631,7 @@ func (omv *oneOfMessageValue) generateTests(ms baseStruct, of *oneOfField, sb *s
 }
 
 func (omv *oneOfMessageValue) generateSetWithTestValue(of *oneOfField, sb *strings.Builder) {
-	sb.WriteString("tv.Set" + of.typeAccessor + "(" + of.typeName + omv.returnMessage.structName + ")\n")
+	sb.WriteString("tv.Set" + of.originFieldName + "Type(" + of.typeName + omv.returnMessage.structName + ")\n")
 	sb.WriteString("fillTest" + omv.returnMessage.structName + "(tv." + omv.fieldName + "())")
 }
 
@@ -644,8 +640,8 @@ func (omv *oneOfMessageValue) generateCopyToValue(of *oneOfField, sb *strings.Bu
 		switch name {
 		case "fieldName":
 			return omv.fieldName
-		case "typeAccessor":
-			return of.typeAccessor
+		case "originOneOfFieldName":
+			return of.originFieldName
 		case "typeName":
 			return of.typeName + omv.fieldName
 		default:

diff --git a/model/internal/cmd/pdatagen/internal/metrics_structs.go b/model/internal/cmd/pdatagen/internal/metrics_structs.go
@@ -123,7 +123,6 @@ var metric = &messageValueStruct{
 			testVal:         `"1"`,
 		},
 		&oneOfField{
-			typeAccessor:     "DataType",
 			typeName:         "MetricDataType",
 			originFieldName:  "Data",
 			originTypePrefix: "otlpmetrics.Metric_",
@@ -243,7 +242,6 @@ var numberDataPoint = &messageValueStruct{
 		startTimeField,
 		timeField,
 		&oneOfField{
-			typeAccessor:     "Type",
 			typeName:         "MetricValueType",
 			originFieldName:  "Value",
 			originTypePrefix: "otlpmetrics.NumberDataPoint_",
@@ -414,7 +412,6 @@ var exemplar = &messageValueStruct{
 	fields: []baseField{
 		timeField,
 		&oneOfField{
-			typeAccessor:     "Type",
 			typeName:         "MetricValueType",
 			originFieldName:  "Value",
 			originTypePrefix: "otlpmetrics.Exemplar_",

diff --git a/model/pdata/generated_metrics.go b/model/pdata/generated_metrics.go
diff --git a/model/pdata/generated_metrics_test.go b/model/pdata/generated_metrics_test.go
diff --git a/model/pdata/metrics.go b/model/pdata/metrics.go
@@ -245,3 +245,13 @@ func (mdt MetricValueType) String() string {
 	}
 	return ""
 }
+
+// Deprecated: [v0.45.0] Use ValueType instead.
+func (ms NumberDataPoint) Type() MetricValueType {
+	return ms.ValueType()
+}
+
+// Deprecated: [v0.45.0] Use ValueType instead.
+func (ms Exemplar) Type() MetricValueType {
+	return ms.ValueType()
+}
diff --git a/model/pdata/metrics_test.go b/model/pdata/metrics_test.go
@@ -661,6 +661,18 @@ func TestMetricsDataPointFlags(t *testing.T) {
 	assert.Equal(t, "FLAG_NO_RECORDED_VALUE", gauge.DataPoints().At(0).Flags().String())
 }
 
+// TestNumberDataPointType tests deprecated NumberDataPoint.Type
+func TestNumberDataPointType(t *testing.T) {
+	tv := NewNumberDataPoint()
+	assert.Equal(t, tv.ValueType(), tv.Type())
+}
+
+// TestExemplarType tests deprecated Exemplar.Type
+func TestExemplarType(t *testing.T) {
+	tv := NewExemplar()
+	assert.Equal(t, tv.ValueType(), tv.Type())
+}
+
 func BenchmarkMetricsClone(b *testing.B) {
 	metrics := NewMetrics()
 	fillTestResourceMetricsSlice(metrics.ResourceMetrics())