refactor: remove Impl classes suffixes and use module namespace for types

Author: luanamartinssantos

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

@@ -21,4 +21,3 @@ export * from './trace/sampler/types';
 export * from './trace/instrumentation/types';
 export * from './exporters/types';
 export * from './common/types';
-

packages/opencensus-core/src/index.ts

@@ -24,15 +24,6 @@ export * from './trace/instrumentation/types';
 export * from './exporters/types';
 export * from './common/types';
 
-// domain models impls
-export * from './trace/model/root-span';
-export * from './trace/model/span';
-export * from './trace/model/tracer';
-export * from './common/console-logger';
-
-// sampler impl
-export * from './trace/sampler/sampler';
-
 // base instrumetation class
 export * from './trace/instrumentation/base-plugin';
 
@@ -41,4 +32,7 @@ export * from './exporters/buffer';
 export * from './exporters/console-exporter';
 
 // util
-export * from './internal/util';
+export * from './internal/util';
+
+import * as types from './index-types';
+export {types};

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

@@ -14,11 +14,12 @@
  * limitations under the License.
  */
 import * as shimmer from 'shimmer';
-import {Plugin} from './types';
+import * as types from './types';
 import {Tracer} from '../model/types';
 
 /** This class represent the base to patch plugin. */
-export abstract class BasePlugin implements Plugin {
+export abstract class BasePlugin implements types.Plugin {
+
   /** The service to send the collected traces */
   // tslint:disable:no-any
   protected exporter: any;

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

@@ -19,15 +19,15 @@ import * as uuid from 'uuid';
 import {Clock} from '../../internal/clock';
 import {debug} from '../../internal/util';
 
-import {SpanImpl} from './span';
+import {Span} from './span';
 import {SpanBaseModel} from './span-base-model';
-import {TracerImpl} from './tracer';
-import {OnEndSpanEventListener, RootSpan, Span, TraceContext, TraceOptions, Tracer} from './types';
+import {Tracer} from './tracer';
 
 import * as logger from '../../common/console-logger';
+import * as types from './types';
 
 /** Defines a root span */
-export class RootSpanImpl extends SpanBaseModel implements RootSpan {
+export class RootSpan extends SpanBaseModel implements types.RootSpan {
   /** A tracer object */
   private tracer: Tracer;
   /** A list of child spans. */
@@ -40,7 +40,7 @@ export class RootSpanImpl extends SpanBaseModel implements RootSpan {
    * @param tracer A tracer object.
    * @param context A trace options object to build the root span.
    */
-  constructor(tracer: Tracer, context?: TraceOptions) {
+  constructor(tracer: Tracer, context?: types.TraceOptions) {
     super();
     this.tracer = tracer;
     this.traceIdLocal =
@@ -113,15 +113,15 @@ export class RootSpanImpl extends SpanBaseModel implements RootSpan {
       this.logger.debug(
           'calling %s.startSpan() on ended %s %o', this.className,
           this.className, {id: this.id, name: this.name, type: this.type});
-      return;
+      return null;
     }
     if (!this.started) {
       this.logger.debug(
           'calling %s.startSpan() on un-started %s %o', this.className,
           this.className, {id: this.id, name: this.name, type: this.type});
-      return;
+      return null;
     }
-    const newSpan = new SpanImpl(this);
+    const newSpan = new Span(this);
     if (name) {
       newSpan.name = name;
     }

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

@@ -14,15 +14,13 @@
  * limitations under the License.
  */
 
+import {Logger} from '../../common/types';
 import {Clock} from '../../internal/clock';
 import {debug, randomSpanId} from '../../internal/util';
-import {Sampler} from '../sampler/types';
-
-import {Annotation, Attributes, Link, MessageEvent, Span, TraceContext} from './types';
-import {Logger} from '../../common/types';
+import * as types from './types';
 
 /** Defines a base model for spans. */
-export abstract class SpanBaseModel implements Span {
+export abstract class SpanBaseModel implements types.Span {
   protected className: string;
   /** The clock used to mesure the beginning and ending of a span */
   private clock: Clock = null;
@@ -37,13 +35,13 @@ export abstract class SpanBaseModel implements Span {
   /** An object to log information to */
   logger: Logger;
   /** A set of attributes, each in the format [KEY]:[VALUE] */
-  attributes: Attributes = {};
+  attributes: types.Attributes = {};
   /** A text annotation with a set of attributes. */
-  annotations: Annotation[] = [];
+  annotations: types.Annotation[] = [];
   /** An event describing a message sent/received between Spans */
-  messageEvents: MessageEvent[] = [];
+  messageEvents: types.MessageEvent[] = [];
   /** Pointers from the current span to another span */
-  links: Link[] = [];
+  links: types.Link[] = [];
   /** If the parent span is in another process. */
   remoteParent: boolean;
   /** The span ID of this span's parent. If it's a root span, must be empty */
@@ -115,12 +113,12 @@ export abstract class SpanBaseModel implements Span {
   }
 
   /** Gives the TraceContext of the span. */
-  get traceContext(): TraceContext {
+  get traceContext(): types.TraceContext {
     return {
       traceId: this.traceId.toString(),
       spanId: this.id.toString(),
       parentSpanId: this.parentSpanId
-    } as TraceContext;
+    } as types.TraceContext;
   }
 
   /**
@@ -139,12 +137,12 @@ export abstract class SpanBaseModel implements Span {
    * @param attributes A set of attributes on the annotation.
    */
   addAnnotation(
-      description: string, timestamp: number, attributes?: Attributes) {
+      description: string, timestamp: number, attributes?: types.Attributes) {
     this.annotations.push({
       'description': description,
       'timestamp': timestamp,
       'attributes': attributes,
-    } as Annotation);
+    } as types.Annotation);
   }
 
   /**
@@ -155,13 +153,13 @@ export abstract class SpanBaseModel implements Span {
    * @param attributes A set of attributes on the link.
    */
   addLink(
-      traceId: string, spanId: string, type: string, attributes?: Attributes) {
+      traceId: string, spanId: string, type: string, attributes?: types.Attributes) {
     this.links.push({
       'traceId': traceId,
       'spanId': spanId,
       'type': type,
       'attributes': attributes
-    } as Link);
+    } as types.Link);
   }
 
   /**
@@ -173,7 +171,7 @@ export abstract class SpanBaseModel implements Span {
     this.messageEvents.push({
       'type': type,
       'id': id,
-    } as MessageEvent);
+    } as types.MessageEvent);
   }
 
   /** Starts the span. */

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

@@ -16,14 +16,14 @@
 
 import {debug, randomSpanId} from '../../internal/util';
 
-import {RootSpanImpl} from './root-span';
+import {RootSpan} from './root-span';
 import {SpanBaseModel} from './span-base-model';
-import {RootSpan, Span, TraceContext} from './types';
 
 import * as logger from '../../common/console-logger';
+import * as types from './types';
 
 /** Defines a Span. */
-export class SpanImpl extends SpanBaseModel implements Span {
+export class Span extends SpanBaseModel implements types.Span {
   private root: RootSpan;
 
   /**
@@ -42,7 +42,7 @@ export class SpanImpl extends SpanBaseModel implements Span {
   }
 
   /** Gets trace context of span. */
-  get traceContext(): TraceContext {
+  get traceContext(): types.TraceContext {
     return {
       traceId: this.traceId.toString(),
       spanId: this.id.toString(),

packages/opencensus-core/src/trace/model/tracer.ts

@@ -16,25 +16,24 @@
 
 import * as cls from '../../internal/cls';
 import {debug} from '../../internal/util';
-import {SamplerImpl} from '../sampler/sampler';
+import {Sampler} from '../sampler/sampler';
 import {TracerConfig} from '../config/types';
-import {Sampler} from '../sampler/types';
 
 import {Config} from '../config/types';
 
-import {RootSpanImpl} from './root-span';
-import {SpanImpl} from './span';
-import {RootSpan, Span} from './types';
-import {TraceOptions, Tracer} from './types';
+import {RootSpan} from './root-span';
+import {Span} from './span';
+import {TraceOptions} from './types';
 import {Func, OnEndSpanEventListener} from './types';
 import {Logger} from '../../common/types';
+import * as types from './types';
 
 import * as logger from '../../common/console-logger';
 
 /**
  * This class represent a tracer.
  */
-export class TracerImpl implements Tracer {
+export class Tracer implements types.Tracer {
   /** Indicates if the tracer is active */
   private activeLocal: boolean;
   /** TODO */
@@ -75,7 +74,7 @@ export class TracerImpl implements Tracer {
     this.activeLocal = true;
     this.config = config;
     this.logger = this.config.logger || logger.logger();
-    this.sampler = new SamplerImpl().probability(config.samplingRate);
+    this.sampler = new Sampler().probability(config.samplingRate);
     return this;
   }
 
@@ -103,7 +102,7 @@ export class TracerImpl implements Tracer {
     return this.contextManager.runAndReturn((root) => {
       let newRoot = null;
       if (this.active) {
-        newRoot = new RootSpanImpl(this, options);
+        newRoot = new RootSpan(this, options);
         if (this.sampler.shouldSample(newRoot.traceId)) {
           newRoot.start();
           this.currentRootSpan = newRoot;

packages/opencensus-core/src/trace/sampler/sampler.ts

@@ -15,13 +15,13 @@
  */
 
 import {debug, randomSpanId} from '../../internal/util';
-import {Sampler} from './types';
+import * as types from './types';
 
 const MIN_NUMBER = 1e-4;
 const MAX_NUMBER = 0xffffffffffffffff;
 
 /** This class represent the probability of a tracer. */
-export class SamplerImpl implements Sampler {
+export class Sampler implements types.Sampler {
   private idUpperBound: number;
 
   /**

packages/opencensus-core/test/test-buffer.ts

@@ -19,13 +19,13 @@ import * as mocha from 'mocha';
 
 import {Buffer} from '../src/exporters/buffer';
 import {NoopExporter} from '../src/exporters/console-exporter';
-import {RootSpanImpl} from '../src/trace/model/root-span';
-import {TracerImpl} from '../src/trace/model/tracer';
+import {RootSpan} from '../src/trace/model/root-span';
+import {Tracer} from '../src/trace/model/tracer';
 
 const exporter = new NoopExporter();
 const DEFAULT_BUFFER_SIZE = 3;
 const DEFAULT_BUFFER_TIMEOUT = 20000;  // time in milliseconds
-const tracer = new TracerImpl();
+const tracer = new Tracer();
 
 const defaultBufferConfig = {
   bufferSize: DEFAULT_BUFFER_SIZE,
@@ -61,7 +61,7 @@ describe('Buffer', () => {
   describe('addToBuffer', () => {
     it('should return the Buffer instance', () => {
       const buffer = new Buffer(exporter, defaultBufferConfig);
-      const rootSpan = new RootSpanImpl(tracer);
+      const rootSpan = new RootSpan(tracer);
       const bufferAdd = buffer.addToBuffer(rootSpan);
       assert.ok(bufferAdd instanceof Buffer);
     });
@@ -74,7 +74,7 @@ describe('Buffer', () => {
     it('should return the Buffer instance', () => {
       const buffer = new Buffer(exporter, defaultBufferConfig);
       const bufferResize = buffer.setBufferSize(0);
-      const rootSpan = new RootSpanImpl(tracer);
+      const rootSpan = new RootSpan(tracer);
       const bufferAdd = bufferResize.addToBuffer(rootSpan);
       assert.ok(bufferAdd instanceof Buffer);
     });
@@ -87,7 +87,7 @@ describe('Buffer', () => {
     it('should return the Buffer instance', () => {
       const buffer = new Buffer(
           exporter, {bufferSize: DEFAULT_BUFFER_SIZE, bufferTimeout: 0});
-      const rootSpan = new RootSpanImpl(tracer);
+      const rootSpan = new RootSpan(tracer);
       let bufferAdd = buffer.addToBuffer(rootSpan);
       bufferAdd = buffer.addToBuffer(rootSpan);
       assert.ok(bufferAdd instanceof Buffer);

packages/opencensus-core/test/test-console-exporter.ts

@@ -19,11 +19,10 @@ import * as mocha from 'mocha';
 
 import {Buffer} from '../src/exporters/buffer';
 import {ConsoleExporter, NoopExporter} from '../src/exporters/console-exporter';
-import {RootSpanImpl} from '../src/trace/model/root-span';
-import {TracerImpl} from '../src/trace/model/tracer';
-import {RootSpan} from '../src/trace/model/types';
+import {RootSpan} from '../src/trace/model/root-span';
+import {Tracer} from '../src/trace/model/tracer';
 
-const tracer = new TracerImpl();
+const tracer = new Tracer();
 const DEFAULT_BUFFER_SIZE = 3;
 const DEFAULT_BUFFER_TIMEOUT = 20000;  // time in milliseconds
 const defaultBufferConfig = {
@@ -36,7 +35,7 @@ describe('NoopExporter', () => {
   describe('onEndSpan()', () => {
     it('should do anything', () => {
       const exporter = new NoopExporter();
-      const rootSpan = new RootSpanImpl(tracer);
+      const rootSpan = new RootSpan(tracer);
       exporter.onEndSpan(rootSpan);
       assert.ok(true);
     });
@@ -46,7 +45,7 @@ describe('NoopExporter', () => {
   describe('publish()', () => {
     it('should do anything', () => {
       const exporter = new NoopExporter();
-      const rootSpan = new RootSpanImpl(tracer);
+      const rootSpan = new RootSpan(tracer);
       const queue: RootSpan[] = [];
       queue.push(rootSpan);
 
@@ -61,7 +60,7 @@ describe('ConsoleLogExporter', () => {
   describe('onEndSpan()', () => {
     it('should end a span', () => {
       const exporter = new ConsoleExporter(defaultBufferConfig);
-      const rootSpan = new RootSpanImpl(tracer);
+      const rootSpan = new RootSpan(tracer);
       exporter.onEndSpan(rootSpan);
       assert.ok(true);
     });
@@ -71,7 +70,7 @@ describe('ConsoleLogExporter', () => {
   describe('publish()', () => {
     it('should publish the rootspans in queue', () => {
       const exporter = new ConsoleExporter(defaultBufferConfig);
-      const rootSpan = new RootSpanImpl(tracer);
+      const rootSpan = new RootSpan(tracer);
       rootSpan.startSpan('name', 'type', rootSpan.traceId);
       const queue: RootSpan[] = [];
       queue.push(rootSpan);