add unit tests for lineage

Author: ezhang6811

propagators/propagator-aws-xray/test/AWSXRayPropagator.test.ts

@@ -24,6 +24,7 @@ import {
   TraceFlags,
   trace,
   TextMapGetter,
+  propagation,
 } from '@opentelemetry/api';
 import { TraceState } from '@opentelemetry/core';
 
@@ -33,6 +34,7 @@ describe('AWSXRayPropagator', () => {
   const xrayPropagator = new AWSXRayPropagator();
   const TRACE_ID = '8a3c60f7d188f8fa79d48a391a778fa6';
   const SPAN_ID = '53995c3f42cd8ad8';
+  const LINEAGE_ID = '100:e3b0c442:11';
   const SAMPLED_TRACE_FLAG = TraceFlags.SAMPLED;
   const NOT_SAMPLED_TRACE_FLAG = TraceFlags.NONE;
 
@@ -119,6 +121,26 @@ describe('AWSXRayPropagator', () => {
 
       assert.deepStrictEqual(carrier, {});
     });
+    
+    it('should inject with lineage', () => {
+      const spanContext: SpanContext = {
+        traceId: TRACE_ID,
+        spanId: SPAN_ID,
+        traceFlags: SAMPLED_TRACE_FLAG,
+      };
+      xrayPropagator.inject(
+        propagation.setBaggage(trace.setSpan(ROOT_CONTEXT, trace.wrapSpanContext(spanContext)), propagation.createBaggage({
+          'Lineage': { value: LINEAGE_ID }
+        })),
+        carrier,
+        defaultTextMapSetter
+      );
+
+      assert.deepStrictEqual(
+        carrier[AWSXRAY_TRACE_ID_HEADER],
+        'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1;Lineage=100:e3b0c442:11'
+      );
+    });
   });
 
   describe('.extract()', () => {
@@ -345,6 +367,36 @@ describe('AWSXRayPropagator', () => {
       });
     });
 
+    it('should extract lineage into baggage', () => {
+      carrier[AWSXRAY_TRACE_ID_HEADER] =
+        'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1;Lineage=100:e3b0c442:11';
+      const extractedContext = xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
+
+      assert.deepStrictEqual(propagation.getBaggage(extractedContext)?.getEntry('Lineage'), {
+        "value": LINEAGE_ID
+      });
+    });
+
+    const invalidLineageHeaders = [
+      "",
+      "::",
+      "1::",
+      "1::1",
+      "1:badc0de:13",
+      ":fbadc0de:13",
+      "65535:fbadc0de:255"
+    ];
+
+    invalidLineageHeaders.forEach((lineageHeader) => {
+      it(`should ignore invalid lineage header: ${lineageHeader}`, () => {
+        carrier[AWSXRAY_TRACE_ID_HEADER] =
+          `Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1;Lineage=${lineageHeader}`;
+        const extractedContext = xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
+
+        assert.deepStrictEqual(propagation.getBaggage(extractedContext), undefined);
+      });
+    });
+
     describe('.fields()', () => {
       it('should return a field with AWS X-Ray Trace ID header', () => {
         const expectedField = xrayPropagator.fields();