Implement W3C Correlation Context propagator (#179)

* Implement W3C Correlation Context propagator * PR comments * PR comments * Update test to inject context properly * Fix merge
2025-11-29 23:07:45 +02:00 · 2019-10-17 15:08:44 -07:00
parent 0025ffcc71
commit e11b90cab2
9 changed files with 309 additions and 30 deletions
--- a/propagation/http_trace_context_propagator_test.go
+++ b/propagation/http_trace_context_propagator_test.go
@@ -17,13 +17,15 @@ package propagation_test
 import (
 	"context"
 	"net/http"
+	"strings"
 	"testing"

-	"go.opentelemetry.io/api/trace"
-
 	"github.com/google/go-cmp/cmp"

 	"go.opentelemetry.io/api/core"
+	dctx "go.opentelemetry.io/api/distributedcontext"
+	"go.opentelemetry.io/api/key"
+	"go.opentelemetry.io/api/trace"
 	mocktrace "go.opentelemetry.io/internal/trace"
 	"go.opentelemetry.io/propagation"
 )
@@ -42,7 +44,7 @@ func TestExtractValidTraceContextFromHTTPReq(t *testing.T) {
 		wantSc core.SpanContext
 	}{
 		{
-			name:   "valid b3Header",
+			name:   "valid w3cHeader",
 			header: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00",
 			wantSc: core.SpanContext{
 				TraceID: traceID,
@@ -50,7 +52,7 @@ func TestExtractValidTraceContextFromHTTPReq(t *testing.T) {
 			},
 		},
 		{
-			name:   "valid b3Header and sampled",
+			name:   "valid w3cHeader and sampled",
 			header: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
 			wantSc: core.SpanContext{
 				TraceID:    traceID,
@@ -119,7 +121,7 @@ func TestExtractValidTraceContextFromHTTPReq(t *testing.T) {
 			req.Header.Set("traceparent", tt.header)

 			ctx := context.Background()
-			gotSc := propagator.Extract(ctx, req.Header)
+			gotSc, _ := propagator.Extract(ctx, req.Header)
 			if diff := cmp.Diff(gotSc, tt.wantSc); diff != "" {
 				t.Errorf("Extract Tracecontext: %s: -got +want %s", tt.name, diff)
 			}
@@ -207,7 +209,7 @@ func TestExtractInvalidTraceContextFromHTTPReq(t *testing.T) {
 			req.Header.Set("traceparent", tt.header)

 			ctx := context.Background()
-			gotSc := propagator.Extract(ctx, req.Header)
+			gotSc, _ := propagator.Extract(ctx, req.Header)
 			if diff := cmp.Diff(gotSc, wantSc); diff != "" {
 				t.Errorf("Extract Tracecontext: %s: -got +want %s", tt.name, diff)
 			}
@@ -276,9 +278,201 @@ func TestInjectTraceContextToHTTPReq(t *testing.T) {
 	}
 }

+func TestExtractValidDistributedContextFromHTTPReq(t *testing.T) {
+	trace.SetGlobalTracer(&mocktrace.MockTracer{})
+	propagator := propagation.HTTPTraceContextPropagator{}
+	tests := []struct {
+		name    string
+		header  string
+		wantKVs []core.KeyValue
+	}{
+		{
+			name:   "valid w3cHeader",
+			header: "key1=val1,key2=val2",
+			wantKVs: []core.KeyValue{
+				key.New("key1").String("val1"),
+				key.New("key2").String("val2"),
+			},
+		},
+		{
+			name:   "valid w3cHeader with spaces",
+			header: "key1 =   val1,  key2 =val2   ",
+			wantKVs: []core.KeyValue{
+				key.New("key1").String("val1"),
+				key.New("key2").String("val2"),
+			},
+		},
+		{
+			name:   "valid w3cHeader with properties",
+			header: "key1=val1,key2=val2;prop=1",
+			wantKVs: []core.KeyValue{
+				key.New("key1").String("val1"),
+				key.New("key2").String("val2;prop=1"),
+			},
+		},
+		{
+			name:   "valid header with url-escaped comma",
+			header: "key1=val1,key2=val2%2Cval3",
+			wantKVs: []core.KeyValue{
+				key.New("key1").String("val1"),
+				key.New("key2").String("val2,val3"),
+			},
+		},
+		{
+			name:   "valid header with an invalid header",
+			header: "key1=val1,key2=val2,a,val3",
+			wantKVs: []core.KeyValue{
+				key.New("key1").String("val1"),
+				key.New("key2").String("val2"),
+			},
+		},
+		{
+			name:   "valid header with no value",
+			header: "key1=,key2=val2",
+			wantKVs: []core.KeyValue{
+				key.New("key1").String(""),
+				key.New("key2").String("val2"),
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			req, _ := http.NewRequest("GET", "http://example.com", nil)
+			req.Header.Set("Correlation-Context", tt.header)
+
+			ctx := context.Background()
+			_, gotCorCtx := propagator.Extract(ctx, req.Header)
+			wantCorCtx := dctx.NewMap(dctx.MapUpdate{MultiKV: tt.wantKVs})
+			if gotCorCtx.Len() != wantCorCtx.Len() {
+				t.Errorf(
+					"Got and Want CorCtx are not the same size %d != %d",
+					gotCorCtx.Len(),
+					wantCorCtx.Len(),
+				)
+			}
+			totalDiff := ""
+			wantCorCtx.Foreach(func(kv core.KeyValue) bool {
+				val, _ := gotCorCtx.Value(kv.Key)
+				diff := cmp.Diff(kv, core.KeyValue{Key: kv.Key, Value: val})
+				if diff != "" {
+					totalDiff += diff + "\n"
+				}
+				return true
+			})
+			if totalDiff != "" {
+				t.Errorf("Extract Tracecontext: %s: -got +want %s", tt.name, totalDiff)
+			}
+		})
+	}
+}
+
+func TestExtractInvalidDistributedContextFromHTTPReq(t *testing.T) {
+	trace.SetGlobalTracer(&mocktrace.MockTracer{})
+	propagator := propagation.HTTPTraceContextPropagator{}
+	tests := []struct {
+		name   string
+		header string
+	}{
+		{
+			name:   "no key values",
+			header: "header1",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			req, _ := http.NewRequest("GET", "http://example.com", nil)
+			req.Header.Set("Correlation-Context", tt.header)
+
+			ctx := context.Background()
+			_, gotCorCtx := propagator.Extract(ctx, req.Header)
+			if gotCorCtx.Len() != 0 {
+				t.Errorf("Got and Want CorCtx are not the same size %d != %d", gotCorCtx.Len(), 0)
+			}
+		})
+	}
+}
+
+func TestInjectCorrelationContextToHTTPReq(t *testing.T) {
+	propagator := propagation.HTTPTraceContextPropagator{}
+	tests := []struct {
+		name         string
+		kvs          []core.KeyValue
+		wantInHeader []string
+		wantedLen    int
+	}{
+		{
+			name: "two simple values",
+			kvs: []core.KeyValue{
+				key.New("key1").String("val1"),
+				key.New("key2").String("val2"),
+			},
+			wantInHeader: []string{"key1=val1", "key2=val2"},
+		},
+		{
+			name: "two values with escaped chars",
+			kvs: []core.KeyValue{
+				key.New("key1").String("val1,val2"),
+				key.New("key2").String("val3=4"),
+			},
+			wantInHeader: []string{"key1=val1%2Cval2", "key2=val3%3D4"},
+		},
+		{
+			name: "values of non-string types",
+			kvs: []core.KeyValue{
+				key.New("key1").Bool(true),
+				key.New("key2").Int(123),
+				key.New("key3").Int64(123),
+				key.New("key4").Int32(123),
+				key.New("key5").Uint(123),
+				key.New("key6").Uint32(123),
+				key.New("key7").Uint64(123),
+				key.New("key8").Float64(123.567),
+				key.New("key9").Float32(123.567),
+				key.New("key10").Bytes([]byte{0x68, 0x69}),
+			},
+			wantInHeader: []string{
+				"key1=true",
+				"key2=123",
+				"key3=123",
+				"key4=123",
+				"key5=123",
+				"key6=123",
+				"key7=123",
+				"key8=123.567",
+				"key9=123.56700134277344",
+				"key10=hi",
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			req, _ := http.NewRequest("GET", "http://example.com", nil)
+			ctx := dctx.WithMap(context.Background(), dctx.NewMap(dctx.MapUpdate{MultiKV: tt.kvs}))
+			propagator.Inject(ctx, req.Header)
+
+			gotHeader := req.Header.Get("Correlation-Context")
+			wantedLen := len(strings.Join(tt.wantInHeader, ","))
+			if wantedLen != len(gotHeader) {
+				t.Errorf(
+					"%s: Inject Correlation-Context incorrect length %d != %d.", tt.name, tt.wantedLen, len(gotHeader),
+				)
+			}
+			for _, inHeader := range tt.wantInHeader {
+				if !strings.Contains(gotHeader, inHeader) {
+					t.Errorf(
+						"%s: Inject Correlation-Context missing part of header: %s in %s", tt.name, inHeader, gotHeader,
+					)
+				}
+			}
+		})
+	}
+}
+
 func TestHttpTraceContextPropagator_GetAllKeys(t *testing.T) {
 	var propagator propagation.HTTPTraceContextPropagator
-	want := []string{"Traceparent"}
+	want := []string{"Traceparent", "Correlation-Context"}
 	got := propagator.GetAllKeys()
 	if diff := cmp.Diff(got, want); diff != "" {
 		t.Errorf("GetAllKeys: -got +want %s", diff)