fix: add type checking in propagators (open-telemetry#904)

dynatrace-oss-contrib · Mar 27, 2020 · 1e643a8 · 1e643a8
1 parent 83fca25
commit 1e643a8
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/src/JaegerHttpTracePropagator.ts b/src/JaegerHttpTracePropagator.ts
@@ -71,11 +71,12 @@ export class JaegerHttpTracePropagator implements HttpTextPropagator {
 
   extract(context: Context, carrier: unknown, getter: GetterFunction): Context {
     const uberTraceIdHeader = getter(carrier, this._jaegerTraceHeader);
-    if (!uberTraceIdHeader) return context;
     const uberTraceId = Array.isArray(uberTraceIdHeader)
       ? uberTraceIdHeader[0]
       : uberTraceIdHeader;
 
+    if (typeof uberTraceId !== 'string') return context;
+
     const spanContext = deserializeSpanContext(uberTraceId);
     if (!spanContext) return context;
 

diff --git a/test/JaegerHttpTracePropagator.test.ts b/test/JaegerHttpTracePropagator.test.ts
@@ -185,4 +185,26 @@ describe('JaegerHttpTracePropagator', () => {
       );
     });
   });
+
+  it('should fail gracefully on bad responses from getter', () => {
+    const ctx1 = jaegerHttpTracePropagator.extract(
+      Context.ROOT_CONTEXT,
+      carrier,
+      (c, k) => 1 // not a number
+    );
+    const ctx2 = jaegerHttpTracePropagator.extract(
+      Context.ROOT_CONTEXT,
+      carrier,
+      (c, k) => [] // empty array
+    );
+    const ctx3 = jaegerHttpTracePropagator.extract(
+      Context.ROOT_CONTEXT,
+      carrier,
+      (c, k) => undefined // missing value
+    );
+
+    assert.ok(ctx1 === Context.ROOT_CONTEXT);
+    assert.ok(ctx2 === Context.ROOT_CONTEXT);
+    assert.ok(ctx3 === Context.ROOT_CONTEXT);
+  });
 });