Rename formatter to propagator (open-telemetry#851)

* chore: rename formatter to propagator * chore: lint * chore: last few formatter renames * chore: remove test of removed function * chore: remove unused imports
dynatrace-oss-contrib · Mar 13, 2020 · 4a7e3e2 · 4a7e3e2
1 parent 7bd62b7
commit 4a7e3e2
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -26,10 +26,10 @@ Format:
 Example of usage:
 ```javascript
 const { NodeTracerProvider } = require('@opentelemetry/node');
-const { JaegerHttpTraceFormat } = require('@opentelemetry/propagator-jaeger');
+const { JaegerHttpTracePropagator } = require('@opentelemetry/propagator-jaeger');
 
 const provider = new NodeTracerProvider({
-  httpTextFormat: new JaegerHttpTraceFormat()
+  HttpTextPropagator: new JaegerHttpTracePropagator()
 });
 ```
 

diff --git a/src/JaegerHttpTraceFormat.ts → src/JaegerHttpTracePropagator.ts b/src/JaegerHttpTraceFormat.ts → src/JaegerHttpTracePropagator.ts
@@ -16,7 +16,7 @@
 
 import {
   Context,
-  HttpTextFormat,
+  HttpTextPropagator,
   SpanContext,
   TraceFlags,
   SetterFunction,
@@ -44,7 +44,7 @@ export const UBER_TRACE_ID_HEADER = 'uber-trace-id';
  * One byte bitmap, as two hex digits.
  * Inspired by jaeger-client-node project.
  */
-export class JaegerHttpTraceFormat implements HttpTextFormat {
+export class JaegerHttpTracePropagator implements HttpTextPropagator {
   private readonly _jaegerTraceHeader: string;
 
   /**

diff --git a/src/index.ts b/src/index.ts
@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export * from './JaegerHttpTraceFormat';
+export * from './JaegerHttpTracePropagator';
diff --git a/test/JaegerHttpTraceFormat.test.ts → test/JaegerHttpTracePropagator.test.ts b/test/JaegerHttpTraceFormat.test.ts → test/JaegerHttpTracePropagator.test.ts
@@ -27,14 +27,16 @@ import {
 } from '@opentelemetry/core';
 import * as assert from 'assert';
 import {
-  JaegerHttpTraceFormat,
+  JaegerHttpTracePropagator,
   UBER_TRACE_ID_HEADER,
-} from '../src/JaegerHttpTraceFormat';
+} from '../src/JaegerHttpTracePropagator';
 
-describe('JaegerHttpTraceFormat', () => {
-  const jaegerHttpTraceFormat = new JaegerHttpTraceFormat();
+describe('JaegerHttpTracePropagator', () => {
+  const jaegerHttpTracePropagator = new JaegerHttpTracePropagator();
   const customHeader = 'new-header';
-  const customJaegerHttpTraceFormat = new JaegerHttpTraceFormat(customHeader);
+  const customJaegerHttpTracePropagator = new JaegerHttpTracePropagator(
+    customHeader
+  );
   let carrier: { [key: string]: unknown };
 
   beforeEach(() => {
@@ -49,7 +51,7 @@ describe('JaegerHttpTraceFormat', () => {
         traceFlags: TraceFlags.SAMPLED,
       };
 
-      jaegerHttpTraceFormat.inject(
+      jaegerHttpTracePropagator.inject(
         setExtractedSpanContext(Context.ROOT_CONTEXT, spanContext),
         carrier,
         defaultSetter
@@ -67,7 +69,7 @@ describe('JaegerHttpTraceFormat', () => {
         traceFlags: TraceFlags.SAMPLED,
       };
 
-      customJaegerHttpTraceFormat.inject(
+      customJaegerHttpTracePropagator.inject(
         setExtractedSpanContext(Context.ROOT_CONTEXT, spanContext),
         carrier,
         defaultSetter
@@ -84,7 +86,7 @@ describe('JaegerHttpTraceFormat', () => {
       carrier[UBER_TRACE_ID_HEADER] =
         'd4cda95b652f4a1592b449d5929fda1b:6e0c63257de34c92:0:01';
       const extractedSpanContext = getExtractedSpanContext(
-        jaegerHttpTraceFormat.extract(
+        jaegerHttpTracePropagator.extract(
           Context.ROOT_CONTEXT,
           carrier,
           defaultGetter
@@ -103,7 +105,7 @@ describe('JaegerHttpTraceFormat', () => {
       carrier[UBER_TRACE_ID_HEADER] =
         '9c41e35aeb6d1272:45fd2a9709dadcf1:a13699e3fb724f40:1';
       const extractedSpanContext = getExtractedSpanContext(
-        jaegerHttpTraceFormat.extract(
+        jaegerHttpTracePropagator.extract(
           Context.ROOT_CONTEXT,
           carrier,
           defaultGetter
@@ -122,7 +124,7 @@ describe('JaegerHttpTraceFormat', () => {
       carrier[UBER_TRACE_ID_HEADER] =
         'ac1f3dc3c2c0b06e%3A5ac292c4a11a163e%3Ac086aaa825821068%3A1';
       const extractedSpanContext = getExtractedSpanContext(
-        jaegerHttpTraceFormat.extract(
+        jaegerHttpTracePropagator.extract(
           Context.ROOT_CONTEXT,
           carrier,
           defaultGetter
@@ -141,7 +143,7 @@ describe('JaegerHttpTraceFormat', () => {
       carrier[customHeader] =
         'd4cda95b652f4a1592b449d5929fda1b:6e0c63257de34c92:0:01';
       const extractedSpanContext = getExtractedSpanContext(
-        customJaegerHttpTraceFormat.extract(
+        customJaegerHttpTracePropagator.extract(
           Context.ROOT_CONTEXT,
           carrier,
           defaultGetter
@@ -159,7 +161,7 @@ describe('JaegerHttpTraceFormat', () => {
     it('returns undefined if UBER_TRACE_ID_HEADER header is missing', () => {
       assert.deepStrictEqual(
         getExtractedSpanContext(
-          jaegerHttpTraceFormat.extract(
+          jaegerHttpTracePropagator.extract(
             Context.ROOT_CONTEXT,
             carrier,
             defaultGetter
@@ -173,7 +175,7 @@ describe('JaegerHttpTraceFormat', () => {
       carrier[UBER_TRACE_ID_HEADER] = 'invalid!';
       assert.deepStrictEqual(
         getExtractedSpanContext(
-          jaegerHttpTraceFormat.extract(
+          jaegerHttpTracePropagator.extract(
             Context.ROOT_CONTEXT,
             carrier,
             defaultGetter