refactor: update and standardize use of types module namespace

Author: silva-fabio

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

@@ -14,15 +14,15 @@
  * limitations under the License.
  */
 
-import {Logger, LoggerOptions} from './types';
+import * as types from './types';
 
 const logDriver = require('log-driver');
 
 
 /**
  * This class represente a console-logger
  */
-class ConsoleLogger implements Logger {
+class ConsoleLogger implements types.Logger {
   // tslint:disable:no-any
   private logger: any; 
   static LEVELS = ['error', 'warn', 'info', 'debug', 'silly'];
@@ -31,8 +31,8 @@ class ConsoleLogger implements Logger {
    * Constructs a new ConsoleLogger instance
    * @param options A logger configuration object.
    */
-  constructor(options?: LoggerOptions|string) {
-    let opt: LoggerOptions = {};
+  constructor(options?: types.LoggerOptions|string) {
+    let opt: types.LoggerOptions = {};
     if (typeof options === 'string') {
       opt = {level: options};
     } else {
@@ -102,7 +102,7 @@ let defaultLogger = null;
  *  Function logger exported to others classes.
  * @param options A logger options or strig to logger in console
  */
-const logger = (options?: LoggerOptions|string) => {
+const logger = (options?: types.LoggerOptions|string) => {
   defaultLogger = new ConsoleLogger(options);
   logger['logger'] = defaultLogger;
   return defaultLogger;

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

@@ -15,21 +15,17 @@
  */
 
 import * as uuidv4 from 'uuid/v4';
-
-import {debug} from '../internal/util';
-import {RootSpan} from '../trace/model/types';
-import {OnEndSpanEventListener} from '../trace/model/types';
-import {Logger} from '../common/types';
-import {Exporter} from './types';
-import {Config, BufferConfig} from '../trace/config/types';
-
+import * as types from './types';
+import * as modelTypes from '../trace/model/types';
+import * as configTypes from '../trace/config/types';
+import * as loggerTypes from '../common/types';
 import * as logger from '../common/console-logger';
 
 
 /** Controls the sending of traces to exporters. */
 export class Buffer {
   /** The service to send the collected spans. */
-  private exporter: Exporter;
+  private exporter: types.Exporter;
   /** Maximum size of a buffer. */
   private bufferSize: number;
   /** Max time for a buffer can wait before being sent */
@@ -39,16 +35,16 @@ export class Buffer {
   /** Indicates when the buffer timeout is running */
   private bufferTimeoutInProgress = false;
   /** An object to log information to */
-  logger: Logger;
+  logger: loggerTypes.Logger;
   /** Trace queue of a buffer */
-  queue: RootSpan[] = [];
+  queue: modelTypes.RootSpan[] = [];
 
   /**
    * Constructs a new Buffer instance.
    * @param exporter The service to send the collected spans.
    * @param config A buffer configuration object to create a buffer.
    */
-  constructor(exporter: Exporter, config: BufferConfig) {
+  constructor(exporter: types.Exporter, config: configTypes.BufferConfig) {
     this.exporter = exporter;
     this.logger = config.logger || logger.logger();
     this.bufferSize = config.bufferSize;
@@ -69,7 +65,7 @@ export class Buffer {
    * Add a trace (rootSpan) in the buffer.
    * @param trace RootSpan to be added in the buffer.
    */
-  addToBuffer(trace: RootSpan) {
+  addToBuffer(trace: modelTypes.RootSpan) {
     this.queue.push(trace);
     this.logger.debug('BUFFER: added new trace');
 

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

@@ -14,31 +14,31 @@
  * limitations under the License.
  */
 
-import {Exporter, ExporterConfig} from '../exporters/types';
-import {RootSpan} from '../trace/model/types';
-import {Buffer} from './buffer';
-import {Logger} from '../common/types';
+import * as types from './types';
+import * as modelTypes from '../trace/model/types';
+import * as loggerTypes from '../common/types';
 
+import {Buffer} from './buffer';
 
 /** Do not send span data */
-export class NoopExporter implements Exporter {
-  logger: Logger;
-  onEndSpan(root: RootSpan) {}
-  publish(rootSpans: RootSpan[]) {}
+export class NoopExporter implements types.Exporter {
+  logger: loggerTypes.Logger;
+  onEndSpan(root: modelTypes.RootSpan) {}
+  publish(rootSpans: modelTypes.RootSpan[]) {}
 }
 
 /** Format and sends span data to the console. */
-export class ConsoleExporter implements Exporter {
+export class ConsoleExporter implements types.Exporter {
   /** Buffer object to store the spans. */
   private buffer: Buffer;
-  logger: Logger;
+  logger: loggerTypes.Logger;
 
   /**
    * Constructs a new ConsoleLogExporter instance.
    * @param config Exporter configuration object to create a console log
    * exporter.
    */
-  constructor(config: ExporterConfig) {
+  constructor(config: types.ExporterConfig) {
     this.buffer = new Buffer(this, config);
     this.logger = config.logger;
   }
@@ -47,15 +47,15 @@ export class ConsoleExporter implements Exporter {
    * Event called when a span is ended.
    * @param root Ended span.
    */
-  onEndSpan(root: RootSpan) {
+  onEndSpan(root: modelTypes.RootSpan) {
     this.buffer.addToBuffer(root);
   }
 
   /**
    * Sends the spans information to the console.
    * @param rootSpans
    */
-  publish(rootSpans: RootSpan[]) {
+  publish(rootSpans: modelTypes.RootSpan[]) {
     rootSpans.map((root) => {
       const ROOT_STR: string = (`
                 RootSpan: {traceId: ${root.traceId}, 

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

@@ -15,20 +15,20 @@
  */
 
 
-import {OnEndSpanEventListener, RootSpan} from '../trace/model/types';
-import {BufferConfig} from '../trace/config/types';
-import {Logger} from '../common/types';
+import * as modelTypes from '../trace/model/types';
+import * as configTypes from '../trace/config/types';
+import * as loggerTypes from '../common/types';
 
 /** Defines an exporter interface. */
-export interface Exporter extends OnEndSpanEventListener {
+export interface Exporter extends modelTypes.OnEndSpanEventListener {
   /** An object to log information to */
-  logger: Logger;
+  logger: loggerTypes.Logger;
 
   /**
    * Sends a list of root spans to the service.
    * @param rootSpans A list of root spans to publish.
    */
-  publish(rootSpans: RootSpan[]);
+  publish(rootSpans: modelTypes.RootSpan[]);
 }
 
-export type  ExporterConfig = BufferConfig;
+export type  ExporterConfig = configTypes.BufferConfig;

packages/opencensus-core/src/index-classes.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright 2018 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// all classes
+
+// domain models impls
+export * from './trace/model/root-span';
+export * from './trace/model/span';
+export * from './trace/model/tracer';
+
+// sampler impl
+export * from './trace/sampler/sampler';
+
+// base instrumetation class
+export * from './trace/instrumentation/base-plugin';
+
+// console exporter and buffer impls
+export * from './exporters/buffer';
+export * from './exporters/console-exporter';

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

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+// all types
 export * from './trace/types';
 export * from './trace/model/types';
 export * from './trace/config/types';

packages/opencensus-core/src/index.ts

@@ -15,24 +15,8 @@
  */
 
 
-// opencensus core api interfaces
-export * from './trace/types';
-export * from './trace/model/types';
-export * from './trace/config/types';
-export * from './trace/sampler/types';
-export * from './trace/instrumentation/types';
-export * from './exporters/types';
-export * from './common/types';
-
-// base instrumetation class
-export * from './trace/instrumentation/base-plugin';
-
-// console exporter and buffer impls
-export * from './exporters/buffer';
-export * from './exporters/console-exporter';
-
-// util
-export * from './internal/util';
-
+import * as logger from './common/console-logger';
+import * as classes from './index-classes';
 import * as types from './index-types';
-export {types};
+
+export {classes, logger, types};

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

@@ -18,7 +18,6 @@ import * as CLS from 'continuation-local-storage';
 import * as semver from 'semver';
 
 import * as cls_ah from './cls-ah';
-import {debug} from './util';
 
 export type Namespace = CLS.Namespace;
 export type Func<T> = CLS.Func<T>;
@@ -27,6 +26,8 @@ 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 =

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

@@ -15,9 +15,6 @@
  */
 
 import * as crypto from 'crypto';
-import * as Debug from 'debug';
-
-export const debug = Debug('opencensus');
 
 
 // TODO: rethink this snippet aproach

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

@@ -15,7 +15,7 @@
  */
 import * as shimmer from 'shimmer';
 import * as types from './types';
-import {Tracer} from '../model/types';
+import * as modelTypes from '../model/types';
 
 /** This class represent the base to patch plugin. */
 export abstract class BasePlugin implements types.Plugin {
@@ -26,7 +26,7 @@ export abstract class BasePlugin implements types.Plugin {
   /** The module name */
   protected moduleName: string;
   /** A tracer object. */
-  protected tracer: Tracer;
+  protected tracer: modelTypes.Tracer;
   /** The module version. */
   protected version: string;
 
@@ -45,7 +45,7 @@ export abstract class BasePlugin implements types.Plugin {
    * @param version module version description
    */
   // tslint:disable:no-any
-  protected setPluginContext(exporter: any, tracer: Tracer, version: string) {
+  protected setPluginContext(exporter: any, tracer: modelTypes.Tracer, version: string) {
     this.exporter = exporter;
     this.tracer = tracer;
     this.version = version;
@@ -90,7 +90,7 @@ export abstract class BasePlugin implements types.Plugin {
   } 
 
   // tslint:disable:no-any
-  applyPatch(exporter: any, tracer: Tracer, version: string): any{
+  applyPatch(exporter: any, tracer: modelTypes.Tracer, version: string): any{
     this.setPluginContext(exporter, tracer, version); 
   }