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

Author: dyladan

api/src/api/propagation.ts

@@ -16,8 +16,8 @@
 
 import { Context } from '@opentelemetry/scope-base';
 import { defaultGetter, GetterFunction } from '../context/propagation/getter';
-import { HttpTextFormat } from '../context/propagation/HttpTextFormat';
-import { NOOP_HTTP_TEXT_FORMAT } from '../context/propagation/NoopHttpTextFormat';
+import { HttpTextPropagator } from '../context/propagation/HttpTextPropagator';
+import { NOOP_HTTP_TEXT_PROPAGATOR } from '../context/propagation/NoopHttpTextPropagator';
 import { defaultSetter, SetterFunction } from '../context/propagation/setter';
 import { ContextAPI } from './context';
 
@@ -28,7 +28,7 @@ const contextApi = ContextAPI.getInstance();
  */
 export class PropagationAPI {
   private static _instance?: PropagationAPI;
-  private _propagator: HttpTextFormat = NOOP_HTTP_TEXT_FORMAT;
+  private _propagator: HttpTextPropagator = NOOP_HTTP_TEXT_PROPAGATOR;
 
   /** Empty private constructor prevents end users from constructing a new instance of the API */
   private constructor() {}
@@ -45,7 +45,9 @@ export class PropagationAPI {
   /**
    * Set the current propagator. Returns the initialized propagator
    */
-  public setGlobalPropagator(propagator: HttpTextFormat): HttpTextFormat {
+  public setGlobalPropagator(
+    propagator: HttpTextPropagator
+  ): HttpTextPropagator {
     this._propagator = propagator;
     return propagator;
   }

api/src/context/propagation/HttpTextFormat.ts renamed to api/src/context/propagation/HttpTextPropagator.ts

@@ -27,11 +27,11 @@ import { GetterFunction } from './getter';
  * The carrier of propagated data on both the client (injector) and server
  * (extractor) side is usually an object such as http headers.
  */
-export interface HttpTextFormat {
+export interface HttpTextPropagator {
   /**
    * Injects values from a given {@link Context} into a carrier.
    *
-   * OpenTelemetry defines a common set of format values (HTTPTextFormat), and
+   * OpenTelemetry defines a common set of format values (HttpTextPropagator), and
    * each has an expected `carrier` type.
    *
    * @param context the Context from which to extract values to transmit over

api/src/context/propagation/NoopHttpTextFormat.ts renamed to api/src/context/propagation/NoopHttpTextPropagator.ts

@@ -15,12 +15,12 @@
  */
 
 import { Context } from '@opentelemetry/scope-base';
-import { HttpTextFormat } from './HttpTextFormat';
+import { HttpTextPropagator } from './HttpTextPropagator';
 
 /**
- * No-op implementations of {@link HttpTextFormat}.
+ * No-op implementations of {@link HttpTextPropagator}.
  */
-export class NoopHttpTextFormat implements HttpTextFormat {
+export class NoopHttpTextPropagator implements HttpTextPropagator {
   /** Noop inject function does nothing */
   inject(context: Context, carrier: unknown, setter: Function): void {}
   /** Noop extract function does nothing and returns the input context */
@@ -29,4 +29,4 @@ export class NoopHttpTextFormat implements HttpTextFormat {
   }
 }
 
-export const NOOP_HTTP_TEXT_FORMAT = new NoopHttpTextFormat();
+export const NOOP_HTTP_TEXT_PROPAGATOR = new NoopHttpTextPropagator();

api/src/index.ts

@@ -17,8 +17,8 @@
 export * from './common/Logger';
 export * from './common/Time';
 export * from './context/propagation/getter';
-export * from './context/propagation/HttpTextFormat';
-export * from './context/propagation/NoopHttpTextFormat';
+export * from './context/propagation/HttpTextPropagator';
+export * from './context/propagation/NoopHttpTextPropagator';
 export * from './context/propagation/setter';
 export * from './correlation_context/CorrelationContext';
 export * from './correlation_context/EntryValue';

api/src/trace/NoopTracer.ts

@@ -14,8 +14,7 @@
  * limitations under the License.
  */
 
-import { HttpTextFormat, Span, SpanOptions, Tracer } from '..';
-import { NOOP_HTTP_TEXT_FORMAT } from '../context/propagation/NoopHttpTextFormat';
+import { Span, SpanOptions, Tracer } from '..';
 import { NOOP_SPAN } from './NoopSpan';
 
 /**
@@ -41,11 +40,6 @@ export class NoopTracer implements Tracer {
   bind<T>(target: T, span?: Span): T {
     return target;
   }
-
-  // By default does nothing
-  getHttpTextFormat(): HttpTextFormat {
-    return NOOP_HTTP_TEXT_FORMAT;
-  }
 }
 
 export const NOOP_TRACER = new NoopTracer();

api/test/api/api.test.ts

@@ -25,12 +25,7 @@ import api, {
 } from '../../src';
 
 describe('API', () => {
-  const functions = [
-    'getCurrentSpan',
-    'startSpan',
-    'withSpan',
-    'getHttpTextFormat',
-  ];
+  const functions = ['getCurrentSpan', 'startSpan', 'withSpan'];
 
   it('should expose a tracer provider via getTracerProvider', () => {
     const tracer = api.trace.getTracerProvider();

api/test/noop-implementations/noop-tracer.test.ts

@@ -14,11 +14,8 @@
  * limitations under the License.
  */
 
-import { Context } from '@opentelemetry/scope-base';
 import * as assert from 'assert';
 import { NoopTracer, NOOP_SPAN, SpanKind } from '../../src';
-import { defaultGetter } from '../../src/context/propagation/getter';
-import { defaultSetter } from '../../src/context/propagation/setter';
 
 describe('NoopTracer', () => {
   it('should not crash', () => {
@@ -37,14 +34,6 @@ describe('NoopTracer', () => {
     );
 
     assert.deepStrictEqual(tracer.getCurrentSpan(), NOOP_SPAN);
-    const httpTextFormat = tracer.getHttpTextFormat();
-    assert.ok(httpTextFormat);
-
-    httpTextFormat.inject(Context.ROOT_CONTEXT, {}, defaultSetter);
-    assert.deepStrictEqual(
-      httpTextFormat.extract(Context.ROOT_CONTEXT, {}, defaultGetter),
-      Context.ROOT_CONTEXT
-    );
   });
 
   it('should not crash when .withSpan()', done => {