refactor: rename HttpText to TextMap propagator (open-telemetry#1458)

Co-authored-by: Daniel Dyla <[email protected]> Co-authored-by: Valentin Marchaud <[email protected]>
dyladan · Feb 18, 2021 · 2b6c32d · 2b6c32d
1 parent ae1bdd1
commit 2b6c32d
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 18 deletions.
diff --git a/api/src/api/global-utils.ts b/api/src/api/global-utils.ts
@@ -15,7 +15,7 @@
  */
 
 import { ContextManager } from '@opentelemetry/context-base';
-import { HttpTextPropagator } from '../context/propagation/HttpTextPropagator';
+import { TextMapPropagator } from '../context/propagation/TextMapPropagator';
 import { MeterProvider } from '../metrics/MeterProvider';
 import { TracerProvider } from '../trace/tracer_provider';
 import { _globalThis } from '../platform';
@@ -35,7 +35,7 @@ type Get<T> = (version: number) => T;
 type OtelGlobal = Partial<{
   [GLOBAL_CONTEXT_MANAGER_API_KEY]: Get<ContextManager>;
   [GLOBAL_METRICS_API_KEY]: Get<MeterProvider>;
-  [GLOBAL_PROPAGATION_API_KEY]: Get<HttpTextPropagator>;
+  [GLOBAL_PROPAGATION_API_KEY]: Get<TextMapPropagator>;
   [GLOBAL_TRACE_API_KEY]: Get<TracerProvider>;
 }>;
 

diff --git a/api/src/api/propagation.ts b/api/src/api/propagation.ts
@@ -16,8 +16,8 @@
 
 import { Context } from '@opentelemetry/context-base';
 import { defaultGetter, GetterFunction } from '../context/propagation/getter';
-import { HttpTextPropagator } from '../context/propagation/HttpTextPropagator';
-import { NOOP_HTTP_TEXT_PROPAGATOR } from '../context/propagation/NoopHttpTextPropagator';
+import { TextMapPropagator } from '../context/propagation/TextMapPropagator';
+import { NOOP_TEXT_MAP_PROPAGATOR } from '../context/propagation/NoopTextMapPropagator';
 import { defaultSetter, SetterFunction } from '../context/propagation/setter';
 import { ContextAPI } from './context';
 import {
@@ -50,9 +50,7 @@ export class PropagationAPI {
   /**
    * Set the current propagator. Returns the initialized propagator
    */
-  public setGlobalPropagator(
-    propagator: HttpTextPropagator
-  ): HttpTextPropagator {
+  public setGlobalPropagator(propagator: TextMapPropagator): TextMapPropagator {
     if (_global[GLOBAL_PROPAGATION_API_KEY]) {
       // global propagator has already been set
       return this._getGlobalPropagator();
@@ -61,7 +59,7 @@ export class PropagationAPI {
     _global[GLOBAL_PROPAGATION_API_KEY] = makeGetter(
       API_BACKWARDS_COMPATIBILITY_VERSION,
       propagator,
-      NOOP_HTTP_TEXT_PROPAGATOR
+      NOOP_TEXT_MAP_PROPAGATOR
     );
 
     return propagator;
@@ -102,11 +100,11 @@ export class PropagationAPI {
     delete _global[GLOBAL_PROPAGATION_API_KEY];
   }
 
-  private _getGlobalPropagator(): HttpTextPropagator {
+  private _getGlobalPropagator(): TextMapPropagator {
     return (
       _global[GLOBAL_PROPAGATION_API_KEY]?.(
         API_BACKWARDS_COMPATIBILITY_VERSION
-      ) ?? NOOP_HTTP_TEXT_PROPAGATOR
+      ) ?? NOOP_TEXT_MAP_PROPAGATOR
     );
   }
 }
diff --git a/...ext/propagation/NoopHttpTextPropagator.ts → ...text/propagation/NoopTextMapPropagator.ts b/...ext/propagation/NoopHttpTextPropagator.ts → ...text/propagation/NoopTextMapPropagator.ts
@@ -15,12 +15,12 @@
  */
 
 import { Context } from '@opentelemetry/context-base';
-import { HttpTextPropagator } from './HttpTextPropagator';
+import { TextMapPropagator } from './TextMapPropagator';
 
 /**
- * No-op implementations of {@link HttpTextPropagator}.
+ * No-op implementations of {@link TextMapPropagator}.
  */
-export class NoopHttpTextPropagator implements HttpTextPropagator {
+export class NoopTextMapPropagator implements TextMapPropagator {
   /** 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 NoopHttpTextPropagator implements HttpTextPropagator {
   }
 }
 
-export const NOOP_HTTP_TEXT_PROPAGATOR = new NoopHttpTextPropagator();
+export const NOOP_TEXT_MAP_PROPAGATOR = new NoopTextMapPropagator();
diff --git a/...context/propagation/HttpTextPropagator.ts → .../context/propagation/TextMapPropagator.ts b/...context/propagation/HttpTextPropagator.ts → .../context/propagation/TextMapPropagator.ts
@@ -29,11 +29,11 @@ import { GetterFunction } from './getter';
  * usually implemented via library-specific request interceptors, where the
  * client-side injects values and the server-side extracts them.
  */
-export interface HttpTextPropagator {
+export interface TextMapPropagator {
   /**
    * Injects values from a given `Context` into a carrier.
    *
-   * OpenTelemetry defines a common set of format values (HttpTextPropagator),
+   * OpenTelemetry defines a common set of format values (TextMapPropagator),
    * and each has an expected `carrier` type.
    *
    * @param context the Context from which to extract values to transmit over

diff --git a/api/src/index.ts b/api/src/index.ts
@@ -18,8 +18,8 @@ export * from './common/Exception';
 export * from './common/Logger';
 export * from './common/Time';
 export * from './context/propagation/getter';
-export * from './context/propagation/HttpTextPropagator';
-export * from './context/propagation/NoopHttpTextPropagator';
+export * from './context/propagation/TextMapPropagator';
+export * from './context/propagation/NoopTextMapPropagator';
 export * from './context/propagation/setter';
 export * from './correlation_context/CorrelationContext';
 export * from './correlation_context/EntryValue';