Change the type of SpanNameFormatter from interface to function (#185)

* Change the type of SpanNameFormatter from interface to function * Update CHANGELOG * Add breaking change notice * Fix tests * Fix linter
XSAM · Sep 14, 2023 · 5b3eed6 · 5b3eed6
1 parent 4dbdf2f
commit 5b3eed6
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,9 +8,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+### ⚠️ Notice ⚠️
+
+This update contains a breaking change of the type of `SpanNameFormatter`. If you use `SpanNameFormatter` in your code, you need to change the type of `SpanNameFormatter` to function.
+
 ### Changed
 
 - Upgrade OTel to version `v1.18.0/v0.41.0`. (#184)
+- The type of `SpanNameFormatter` has been changed to function for easier use. (#185)
 
 ## [0.24.0] - 2023-09-08
 

diff --git a/config.go b/config.go
@@ -34,11 +34,8 @@ var (
 	queryMethodKey      = attribute.Key("method")
 )
 
-// SpanNameFormatter is an interface that used to format span names.
-// TODO(Sam): change this to function instead of interface.
-type SpanNameFormatter interface {
-	Format(ctx context.Context, method Method, query string) string
-}
+// SpanNameFormatter supports formatting span names.
+type SpanNameFormatter func(ctx context.Context, method Method, query string) string
 
 // AttributesGetter provides additional attributes on spans creation.
 type AttributesGetter func(ctx context.Context, method Method, query string, args []driver.NamedValue) []attribute.KeyValue
@@ -124,9 +121,7 @@ type SpanOptions struct {
 	SpanFilter SpanFilter
 }
 
-type defaultSpanNameFormatter struct{}
-
-func (f *defaultSpanNameFormatter) Format(_ context.Context, method Method, _ string) string {
+func defaultSpanNameFormatter(_ context.Context, method Method, _ string) string {
 	return string(method)
 }
 
@@ -135,7 +130,7 @@ func newConfig(options ...Option) config {
 	cfg := config{
 		TracerProvider:    otel.GetTracerProvider(),
 		MeterProvider:     otel.GetMeterProvider(),
-		SpanNameFormatter: &defaultSpanNameFormatter{},
+		SpanNameFormatter: defaultSpanNameFormatter,
 	}
 	for _, opt := range options {
 		opt.Apply(&cfg)

diff --git a/config_test.go b/config_test.go
@@ -15,6 +15,7 @@
 package otelsql
 
 import (
+	"context"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -27,7 +28,13 @@ import (
 
 func TestNewConfig(t *testing.T) {
 	cfg := newConfig(WithSpanOptions(SpanOptions{Ping: true}), WithAttributes(semconv.DBSystemMySQL))
-	assert.Equal(t, config{
+
+	// Compare function result
+	assert.Equal(t, defaultSpanNameFormatter(context.Background(), "foo", "bar"), cfg.SpanNameFormatter(context.Background(), "foo", "bar"))
+	// Ignore function compare
+	cfg.SpanNameFormatter = nil
+
+	assert.EqualValues(t, config{
 		TracerProvider: otel.GetTracerProvider(),
 		Tracer: otel.GetTracerProvider().Tracer(
 			instrumentationName,
@@ -44,8 +51,7 @@ func TestNewConfig(t *testing.T) {
 		Attributes: []attribute.KeyValue{
 			semconv.DBSystemMySQL,
 		},
-		SpanNameFormatter: &defaultSpanNameFormatter{},
-		SQLCommenter:      newCommenter(false),
+		SQLCommenter: newCommenter(false),
 	}, cfg)
 	assert.NotNil(t, cfg.Instruments)
 }
diff --git a/option_test.go b/option_test.go
@@ -56,8 +56,8 @@ func TestOptions(t *testing.T) {
 		},
 		{
 			name:           "WithSpanNameFormatter",
-			option:         WithSpanNameFormatter(&defaultSpanNameFormatter{}),
-			expectedConfig: config{SpanNameFormatter: &defaultSpanNameFormatter{}},
+			option:         WithSpanNameFormatter(nil),
+			expectedConfig: config{SpanNameFormatter: nil},
 		},
 		{
 			name:           "WithSpanOptions",

diff --git a/utils.go b/utils.go
@@ -97,7 +97,7 @@ func createSpan(
 		attrs = append(attrs, cfg.AttributesGetter(ctx, method, query, args)...)
 	}
 
-	return cfg.Tracer.Start(ctx, cfg.SpanNameFormatter.Format(ctx, method, query),
+	return cfg.Tracer.Start(ctx, cfg.SpanNameFormatter(ctx, method, query),
 		trace.WithSpanKind(trace.SpanKindClient),
 		trace.WithAttributes(attrs...),
 	)

diff --git a/utils_test.go b/utils_test.go
@@ -141,7 +141,7 @@ func newMockConfig(t *testing.T, tracer trace.Tracer) config {
 		Meter:             meter,
 		Instruments:       instruments,
 		Attributes:        []attribute.KeyValue{defaultattribute},
-		SpanNameFormatter: &defaultSpanNameFormatter{},
+		SpanNameFormatter: defaultSpanNameFormatter,
 		SQLCommenter:      newCommenter(false),
 	}
 }