refactor: address opencensus-core TODOs (#47)

* refactor: changes to address opencensus-core TODOs

* refactor: reveiw TODO for clearCurrentTrace when using continuation-local-storage

* refactor(fix): changes to address review comments

Co-authored-by: Fabio Silva <fgs@cesar.org.br>

Author: 2 people

packages/opencensus-core/package.json

@@ -39,13 +39,13 @@
   },
   "devDependencies": {
     "@types/continuation-local-storage": "^3.2.1",
-    "@types/debug": "0.0.30",
     "@types/mocha": "^2.2.48",
     "@types/node": "^9.4.7",
     "@types/semver": "^5.5.0",
     "@types/shimmer": "^1.0.1",
     "@types/uuid": "^3.4.3",
     "gts": "^0.5.4",
+    "intercept-stdout": "^0.1.2",
     "mocha": "^5.0.4",
     "ncp": "^2.0.0",
     "nyc": "11.6.0",
@@ -54,8 +54,6 @@
   },
   "dependencies": {
     "continuation-local-storage": "^3.2.1",
-    "debug": "^3.1.0",
-    "intercept-stdout": "^0.1.2",
     "log-driver": "^1.2.7",
     "semver": "^5.5.0",
     "shimmer": "^1.2.0",

packages/opencensus-core/src/common/console-logger.ts

@@ -27,9 +27,6 @@ export class ConsoleLogger implements types.Logger {
   static LEVELS = ['silent', 'error', 'warn', 'info', 'debug', 'silly'];
   level: string;
 
-
-  // TODO: reevaluate options to accept numbers as a parameter
-
   /**
    * Constructs a new ConsoleLogger instance
    * @param options A logger configuration object.
@@ -104,19 +101,15 @@ export class ConsoleLogger implements types.Logger {
   }
 }
 
-
-// TODO: reevaluate the need to create a new logger instance on every call to
-// logger();
-
 /**
- *  Function logger exported to others classes.
+ * Function logger exported to others classes. Inspired by:
+ * https://github.com/cainus/logdriver/blob/bba1761737ca72f04d6b445629848538d038484a/index.js#L50
  * @param options A logger options or strig to logger in console
  */
 // tslint:disable-next-line:no-any
-const logger: any = (options?: types.LoggerOptions|string|number) => {
-  const aLogger = new ConsoleLogger(options);
-  logger['logger'] = aLogger;
-  return aLogger;
-};
+const logger: any =
+    (options?: types.LoggerOptions|string|number): types.Logger => {
+      return new ConsoleLogger(options);
+    };
 
 export {logger};

packages/opencensus-core/src/common/types.ts

@@ -19,6 +19,7 @@ export type LogFunction = (message: any, ...args: any[]) => void;
 
 /** Defines an logger interface. */
 export interface Logger {
+  level: string;
   error: LogFunction;
   warn: LogFunction;
   info: LogFunction;

packages/opencensus-core/src/exporters/console-exporter.ts

@@ -25,7 +25,9 @@ export class NoopExporter implements types.Exporter {
   logger: loggerTypes.Logger;
   onStartSpan(root: modelTypes.RootSpan) {}
   onEndSpan(root: modelTypes.RootSpan) {}
-  publish(rootSpans: modelTypes.RootSpan[]) {}
+  publish(rootSpans: modelTypes.RootSpan[]) {
+    return Promise.resolve();
+  }
 }
 
 /** Format and sends span data to the console. */
@@ -72,5 +74,6 @@ export class ConsoleExporter implements types.Exporter {
           `${SPANS_STR.join('\n')}`);
       console.log(`${result}`);
     });
+    return Promise.resolve();
   }
 }

packages/opencensus-core/src/exporters/types.ts

@@ -25,7 +25,8 @@ export interface Exporter extends modelTypes.SpanEventListener {
    * Sends a list of root spans to the service.
    * @param rootSpans A list of root spans to publish.
    */
-  publish(rootSpans: modelTypes.RootSpan[]): void;
+
+  publish(rootSpans: modelTypes.RootSpan[]): Promise<number|string|void>;
 }
 
 export type ExporterConfig = configTypes.BufferConfig;

packages/opencensus-core/src/internal/cls-ah.ts

@@ -37,7 +37,7 @@ class AsyncHooksNamespace implements CLSNamespace {
   }
 
   get active(): Context {
-    throw new Error('Not implemented');
+    return current;
   }
 
   createContext(): Context {

packages/opencensus-core/src/internal/cls.ts

@@ -27,10 +27,6 @@ const useAsyncHooks: boolean = semver.satisfies(
     process.version, '>=8');  //&&
                               // !!process.env.GCLOUD_TRACE_NEW_CONTEXT;
 
-import * as Debug from 'debug';
-const debug = Debug('opencensus');
-debug('useAsyncHooks = %s', useAsyncHooks);
-
 const cls: typeof CLS = useAsyncHooks ? require('./cls-ah') : CLS;
 
 

packages/opencensus-core/src/internal/util.ts

@@ -19,9 +19,6 @@
 
 import * as crypto from 'crypto';
 
-
-// TODO: rethink this snippet aproach
-
 // Use 6 bytes of randomness only as JS numbers are doubles not 64-bit ints.
 const SPAN_ID_RANDOM_BYTES = 6;
 

packages/opencensus-core/src/trace/instrumentation/base-plugin.ts

@@ -26,15 +26,15 @@ import * as types from './types';
  * Maps a name (key) representing a internal file module and its exports
  */
 export type ModuleExportsMapping = {
-  // tslint:disable:no-any
+  // tslint:disable-next-line:no-any
   [key: string]: any;
 };
 
 
 /** This class represent the base to patch plugin. */
 export abstract class BasePlugin implements types.Plugin {
   /** Exports from the nodejs module to be instrumented */
-  // tslint:disable:no-any
+  // tslint:disable-next-line:no-any
   protected moduleExports: any;
   /** The module name */
   protected moduleName: string;
@@ -66,8 +66,8 @@ export abstract class BasePlugin implements types.Plugin {
    * @param version module version description
    * @param basedir module absolute path
    */
-  // tslint:disable:no-any
   private setPluginContext(
+      // tslint:disable-next-line:no-any
       moduleExports: any, tracer: modelTypes.Tracer, version: string,
       basedir?: string) {
     this.moduleExports = moduleExports;
@@ -78,7 +78,6 @@ export abstract class BasePlugin implements types.Plugin {
     this.internalFilesExports = this.loadInternalFiles();
   }
 
-
   /**
    * Method that enables the instrumentation patch.
    *
@@ -91,9 +90,9 @@ export abstract class BasePlugin implements types.Plugin {
    * @param version version of the current instaled module to patch
    * @param basedir module absolute path
    */
-  enable(
-      // tslint:disable:no-any
-      moduleExports: any, tracer: modelTypes.Tracer, version: string,
+  enable<T>(
+      // tslint:disable-next-line:no-any
+      moduleExports: T, tracer: modelTypes.Tracer, version: string,
       basedir: string) {
     this.setPluginContext(moduleExports, tracer, version, basedir);
     return this.applyPatch();
@@ -108,10 +107,10 @@ export abstract class BasePlugin implements types.Plugin {
    * This method implements the GoF Template Method Pattern,
    * 'applyPatch' is the variant part, each instrumentation should
    * implement its own version, 'enable' method is the invariant.
-   * Wil be called when enable is called.
+   * It will be called when enable is called.
    *
    */
-  // tslint:disable:no-any
+  // tslint:disable-next-line:no-any
   protected abstract applyPatch(): any;
   protected abstract applyUnpatch(): void;
 

packages/opencensus-core/src/trace/model/root-span.ts

@@ -74,8 +74,6 @@ export class RootSpan extends SpanBase implements types.RootSpan {
     this.tracer.onStartSpan(this);
   }
 
-  // TODO: review end() behavior if it should throw an error when it is called
-  // before start()
   /** Ends a rootspan instance. */
   end() {
     super.end();