Merge a6ede59 into ed9ba80

Author: dyladan

.eslintrc.js

@@ -44,6 +44,7 @@ module.exports = {
  "files": ["test/**/*.ts"],
  "rules": {
  "no-empty": "off",
+ "@typescript-eslint/ban-ts-comment": "off",
  "@typescript-eslint/ban-ts-ignore": "off",
  "@typescript-eslint/no-empty-function": "off",
  "@typescript-eslint/no-explicit-any": "off",

src/api/context.ts

@@ -17,12 +17,12 @@
 import { NoopContextManager } from '../context/NoopContextManager';
 import { Context, ContextManager } from '../context/types';
 import {
- API_BACKWARDS_COMPATIBILITY_VERSION,
- GLOBAL_CONTEXT_MANAGER_API_KEY,
- makeGetter,
- _global,
-} from './global-utils';
+ getGlobal,
+ registerGlobal,
+ unregisterGlobal,
+} from '../internal/global-utils';
 
+const API_NAME = 'context';
 const NOOP_CONTEXT_MANAGER = new NoopContextManager();
 
 /**
@@ -49,17 +49,7 @@ export class ContextAPI {
  public setGlobalContextManager(
  contextManager: ContextManager
  ): ContextManager {
- if (_global[GLOBAL_CONTEXT_MANAGER_API_KEY]) {
- // global context manager has already been set
- return this._getContextManager();
- }
-
- _global[GLOBAL_CONTEXT_MANAGER_API_KEY] = makeGetter(
- API_BACKWARDS_COMPATIBILITY_VERSION,
- contextManager,
- NOOP_CONTEXT_MANAGER
- );
-
+ registerGlobal(API_NAME, contextManager);
  return contextManager;
  }
 
@@ -98,16 +88,12 @@ export class ContextAPI {
  }
 
  private _getContextManager(): ContextManager {
- return (
- _global[GLOBAL_CONTEXT_MANAGER_API_KEY]?.(
- API_BACKWARDS_COMPATIBILITY_VERSION
- ) ?? NOOP_CONTEXT_MANAGER
- );
+ return getGlobal(API_NAME) || NOOP_CONTEXT_MANAGER;
  }
 
  /** Disable and remove the global context manager */
  public disable() {
  this._getContextManager().disable();
- delete _global[GLOBAL_CONTEXT_MANAGER_API_KEY];
+ unregisterGlobal(API_NAME);
  }
 }

src/api/diag.ts

@@ -19,66 +19,42 @@ import {
  DiagLogFunction,
  createNoopDiagLogger,
  diagLoggerFunctions,
+ FilteredDiagLogger,
 } from '../diag/logger';
 import { DiagLogLevel, createLogLevelDiagLogger } from '../diag/logLevel';
 import {
- API_BACKWARDS_COMPATIBILITY_VERSION,
- GLOBAL_DIAG_LOGGER_API_KEY,
- makeGetter,
- _global,
-} from './global-utils';
-
-/** Internal simple Noop Diag API that returns a noop logger and does not allow any changes */
-function noopDiagApi(): DiagAPI {
- const noopApi = createNoopDiagLogger() as DiagAPI;
-
- noopApi.getLogger = () => noopApi;
- noopApi.setLogger = noopApi.getLogger;
- noopApi.setLogLevel = () => {};
-
- return noopApi;
-}
+ getGlobal,
+ registerGlobal,
+ unregisterGlobal,
+} from '../internal/global-utils';
 
 /**
  * Singleton object which represents the entry point to the OpenTelemetry internal
  * diagnostic API
  */
 export class DiagAPI implements DiagLogger {
+ private static _instance?: DiagAPI;
+
  /** Get the singleton instance of the DiagAPI API */
  public static instance(): DiagAPI {
- let theInst = null;
- if (_global[GLOBAL_DIAG_LOGGER_API_KEY]) {
- // Looks like a previous instance was set, so try and fetch it
- theInst = _global[GLOBAL_DIAG_LOGGER_API_KEY]?.(
- API_BACKWARDS_COMPATIBILITY_VERSION
- ) as DiagAPI;
- }
-
- if (!theInst) {
- theInst = new DiagAPI();
- _global[GLOBAL_DIAG_LOGGER_API_KEY] = makeGetter(
- API_BACKWARDS_COMPATIBILITY_VERSION,
- theInst,
- noopDiagApi()
- );
+ if (!this._instance) {
+ this._instance = new DiagAPI();
  }
 
- return theInst;
+ return this._instance;
  }
 
  /**
  * Private internal constructor
  * @private
  */
  private constructor() {
- let _logLevel: DiagLogLevel = DiagLogLevel.INFO;
- let _filteredLogger: DiagLogger | null;
- let _logger: DiagLogger = createNoopDiagLogger();
+ const _noopLogger = createNoopDiagLogger();
 
  function _logProxy(funcName: keyof DiagLogger): DiagLogFunction {
  return function () {
  const orgArguments = arguments as unknown;
- const theLogger = _filteredLogger || _logger;
+ const theLogger = self.getLogger();
  const theFunc = theLogger[funcName];
  if (typeof theFunc === 'function') {
  return theFunc.apply(
@@ -94,29 +70,23 @@ export class DiagAPI implements DiagLogger {
 
  // DiagAPI specific functions
 
- self.getLogger = (): DiagLogger => {
- // Return itself if no existing logger is defined (defaults effectively to a Noop)
- return _logger;
+ self.getLogger = (): FilteredDiagLogger => {
+ return getGlobal('diag') || _noopLogger;
  };
 
- self.setLogger = (logger?: DiagLogger): DiagLogger => {
- const prevLogger = _logger;
- if (!logger || logger !== self) {
-  // Simple special case to avoid any possible infinite recursion on the logging functions
-  _logger = logger || createNoopDiagLogger();
-  _filteredLogger = createLogLevelDiagLogger(_logLevel, _logger);
- }
-
- return prevLogger;
+ self.setLogger = (
+ logger: DiagLogger,
+ logLevel: DiagLogLevel = DiagLogLevel.INFO
+ ) => {
+ // This is required to prevent an endless loop in the case where the diag
+ // is used as a child of itself accidentally.
+ logger = logger === self ? self.getLogger().getChild() : logger;
+ logger = logger ?? _noopLogger;
+ registerGlobal('diag', createLogLevelDiagLogger(logLevel, logger), true);
  };
 
- self.setLogLevel = (maxLogLevel: DiagLogLevel) => {
- if (maxLogLevel !== _logLevel) {
- _logLevel = maxLogLevel;
- if (_logger) {
- _filteredLogger = createLogLevelDiagLogger(maxLogLevel, _logger);
- }
- }
+ self.disable = () => {
+ unregisterGlobal('diag');
  };
 
  for (let i = 0; i < diagLoggerFunctions.length; i++) {
@@ -129,22 +99,27 @@ export class DiagAPI implements DiagLogger {
  * Return the currently configured logger instance, if no logger has been configured
  * it will return itself so any log level filtering will still be applied in this case.
  */
- public getLogger!: () => DiagLogger;
+ public getLogger!: () => FilteredDiagLogger;
 
  /**
- * Set the DiagLogger instance
- * @param logger - [Optional] The DiagLogger instance to set as the default logger, if not provided it will set it back as a noop
+ * Set the global DiagLogger and DiagLogLevel.
+ * If a global diag logger is already set, this will override it.
+ *
+ * @param logger - [Optional] The DiagLogger instance to set as the default logger.
+ * @param logLevel - [Optional] The DiagLogLevel used to filter logs sent to the logger. If not provided it will default to INFO.
  * @returns The previously registered DiagLogger
  */
- public setLogger!: (logger?: DiagLogger) => DiagLogger;
-
- /** Set the default maximum diagnostic logging level */
- public setLogLevel!: (maxLogLevel: DiagLogLevel) => void;
+ public setLogger!: (logger: DiagLogger, logLevel?: DiagLogLevel) => void;
 
  // DiagLogger implementation
  public verbose!: DiagLogFunction;
  public debug!: DiagLogFunction;
  public info!: DiagLogFunction;
  public warn!: DiagLogFunction;
  public error!: DiagLogFunction;
+
+ /**
+ * Unregister the global logger and return to Noop
+ */
+ public disable!: () => void;
 }

src/api/global-utils.ts

@@ -24,11 +24,12 @@ import {
  TextMapSetter,
 } from '../propagation/TextMapPropagator';
 import {
- API_BACKWARDS_COMPATIBILITY_VERSION,
- GLOBAL_PROPAGATION_API_KEY,
- makeGetter,
- _global,
-} from './global-utils';
+ getGlobal,
+ registerGlobal,
+ unregisterGlobal,
+} from '../internal/global-utils';
+
+const API_NAME = 'propagation';
 
 /**
  * Singleton object which represents the entry point to the OpenTelemetry Propagation API
@@ -52,17 +53,7 @@ export class PropagationAPI {
  * Set the current propagator. Returns the initialized propagator
  */
  public setGlobalPropagator(propagator: TextMapPropagator): TextMapPropagator {
- if (_global[GLOBAL_PROPAGATION_API_KEY]) {
- // global propagator has already been set
- return this._getGlobalPropagator();
- }
-
- _global[GLOBAL_PROPAGATION_API_KEY] = makeGetter(
- API_BACKWARDS_COMPATIBILITY_VERSION,
- propagator,
- NOOP_TEXT_MAP_PROPAGATOR
- );
-
+ registerGlobal(API_NAME, propagator);
  return propagator;
  }
 
@@ -105,14 +96,10 @@ export class PropagationAPI {
 
  /** Remove the global propagator */
  public disable() {
- delete _global[GLOBAL_PROPAGATION_API_KEY];
+ unregisterGlobal(API_NAME);
  }
 
  private _getGlobalPropagator(): TextMapPropagator {
- return (
- _global[GLOBAL_PROPAGATION_API_KEY]?.(
- API_BACKWARDS_COMPATIBILITY_VERSION
- ) ?? NOOP_TEXT_MAP_PROPAGATOR
- );
+ return getGlobal(API_NAME) || NOOP_TEXT_MAP_PROPAGATOR;
  }
 }