fix: some tests and tslint issues

Author: silva-fabio

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

@@ -35,9 +35,9 @@ export class Buffer {
   /** Max time for a buffer can wait before being sent */
   private bufferTimeout: number;
   /** Manage when the buffer timeout needs to be reseted */
-  private resetTimeout: boolean = false;
+  private resetTimeout = false;
   /** Indicates when the buffer timeout is running */
-  private bufferTimeoutInProgress: boolean = false;
+  private bufferTimeoutInProgress = false;
 
   constructor(exporter: Exporter, config: BufferConfig) {
     this.exporter = exporter;

packages/opencensus-core/src/index.ts

@@ -15,7 +15,7 @@
  */
 
 
-// opencensus core api interfaces 
+// opencensus core api interfaces
 export * from './trace/types';
 export * from './trace/model/types';
 export * from './trace/config/types';
@@ -33,7 +33,7 @@ export * from './trace/config/sampler';
 // base instrumetation class
 export * from './trace/instrumentation/baseplugin';
 
-// console exporter and buffer impls 
+// console exporter and buffer impls
 export * from './exporters/buffer';
 export * from './exporters/consolelog-exporter';
 

packages/opencensus-core/src/trace/config/types.ts

@@ -42,7 +42,7 @@ export interface Sampler {
  */
 export interface BufferConfig {
   bufferSize?: number;
-  bufferTimeout?: number
+  bufferTimeout?: number;
 }
 
 /** Defines tracer configuration parameters */

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

@@ -20,6 +20,7 @@ import {Tracer} from '../model/types';
  * This class represent the base to patch plugin
  */
 export abstract class BasePlugin {
+  // tslint:disable:no-any
   exporter: any;
   moduleName: string;
   tracer: Tracer;
@@ -34,14 +35,15 @@ export abstract class BasePlugin {
    * @param tracer tracer relating to context
    * @param version module version description
    */
+  // tslint:disable:no-any
   protected setPluginContext(exporter: any, tracer: Tracer, version: string) {
     this.exporter = exporter;
     this.tracer = tracer;
     this.version = version;
   }
 
-  protected wrap(nodule, name, wrapper ) {
-      shimmer.wrap(nodule, name, wrapper )
+  protected wrap(nodule, name, wrapper) {
+      shimmer.wrap(nodule, name, wrapper);
   }
 
   protected unwrap(nodule, name) {

packages/opencensus-core/src/trace/instrumentation/types.ts

@@ -20,6 +20,7 @@ import {Tracer} from "../model/types";
  * Interface Plugin to apply patch.
  */
 export interface Plugin {
+  // tslint:disable:no-any
   applyPatch(module: {}, tracer: Tracer, version: string): any;
   applyUnpatch(): void;
 }

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

@@ -137,10 +137,10 @@ export abstract class SpanBaseModel implements Span {
     addAnnotation(description: string, timestamp: number,
         attributes?: Attributes) {
       this.annotations.push({
-        description: description,
-        timestamp: timestamp,
-        attributes: attributes,
-      } as Annotation)
+        'description': description,
+        'timestamp': timestamp,
+        'attributes': attributes,
+      } as Annotation);
     }
 
     /**
@@ -153,11 +153,11 @@ export abstract class SpanBaseModel implements Span {
     addLink(traceId: string, spanId: string, type: string,
         attributes?: Attributes) {
       this.links.push({
-        traceId: traceId,
-        SpanId: spanId,
-        type: type,
-        attributes: attributes
-      } as Link)
+        'traceId': traceId,
+        'spanId': spanId,
+        'type': type,
+        'attributes': attributes
+      } as Link);
     }
 
     /**
@@ -167,9 +167,9 @@ export abstract class SpanBaseModel implements Span {
      */
     addMessageEvent(type: string, id: string) {
       this.messageEvents.push({
-        type: type,
-        id: id,
-      } as MessageEvent)
+        'type': type,
+        'id': id,
+      } as MessageEvent);
     }
 
     /** Starts a span. */

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

@@ -22,7 +22,7 @@ import {OnEndSpanEventListener, Func } from './types';
 import {Sampler, TracerConfig} from '../config/types';
 import {Config} from '../config/types';
 import {SpanImpl} from './span';
-import {SamplerImpl} from '../config/sampler'
+import {SamplerImpl} from '../config/sampler';
 import {RootSpanImpl} from './rootspan';
 
 
@@ -38,9 +38,6 @@ export class TracerImpl implements Tracer {
     private eventListenersLocal: OnEndSpanEventListener[] = [];
     //TODO: temp solution 
     private endedTraces: RootSpan[] = [];
-      
- 
-    samplingRate: number;
 
     constructor() {
         this.activeLocal = false;
@@ -79,14 +76,13 @@ export class TracerImpl implements Tracer {
             let newRoot = null;
             if(this.active) {
                 newRoot = new RootSpanImpl (this, options);
-                this.currentRootSpan = newRoot;
-
                 if (this.sampler.shouldSample(newRoot.traceId)) {
                     newRoot.start();
+                    this.currentRootSpan = newRoot;
                     return fn(newRoot);
                 }
             } else {
-                debug("Tracer is inactive, can't start new RootSpan")
+                debug("Tracer is inactive, can't start new RootSpan");
             }
             return fn(newRoot);
         });

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

@@ -17,6 +17,7 @@
 import { Sampler, Config, TracerConfig } from '../config/types';
 
 /** Default type for functions */
+// tslint:disable:no-any
 export type Func<T> = (...args: any[]) => T;
 
 /** Maps a label to a string, number or boolean. */
@@ -25,19 +26,19 @@ export interface Attributes { [attributeKey: string]: string|number|boolean; }
 /** A text annotation with a set of attributes. */
 export interface Annotation {
   /** A user-supplied message describing the event. */
-  description: string,
+  description: string;
   /** A timestamp that maks the event. */
-  timestamp: number,
+  timestamp: number;
   /** A set of attributes on the annotation. */
-  attributes: Attributes
+  attributes: Attributes;
 }
 
 /** An event describing a message sent/received between Spans. */
 export interface MessageEvent {
   /** Indicates whether the message was sent or received. */
-  type: string,
+  type: string;
   /** An identifier for the MessageEvent's message. */
-  id: string,
+  id: string;
 }
 
 /**
@@ -46,13 +47,13 @@ export interface MessageEvent {
  */
 export interface Link {
   /** The trace ID for a trace within a project. */
-  traceId: string,
+  traceId: string;
   /** The span ID for a span within a trace. */
-  SpanId: string,
+  spanId: string;
   /** The relationship of the current span relative to the linked. */
-  type: string,
+  type: string;
   /** A set of attributes on the link. */
-  attributes: Attributes
+  attributes: Attributes;
 }
 
 

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

@@ -19,13 +19,43 @@ import {Sampler} from './config/types';
 import {Exporter} from '../exporters/types';
 import {Config} from './config/types';
 
+//TODO: Improve JSDoc
 
+/**
+ *  Main interface for tracing. Holds instances for {@link Tracer} and
+ *  {@link Exporter}.
+ *
+ */
 export interface Tracing {
+  
+  /**
+   * Returns the {@link Tracer} object responsible for managing a trace.
+   * @return the {@link Tracer} implementation.
+   */
   readonly tracer: Tracer;
-  // readonly sampler: Sampler;
+
+  /**
+   * Returns the {@link Exportert} 
+   * @return the {@link ExportComponent} implementation.
+   */
   readonly exporter: Exporter;
-  start(config?:Config): Tracing;
+
+  /**
+   * Enable tracing process.
+   * @param userConfig Configuration provided by a client
+   */
+  start(userConfig?:Config): Tracing;
+
+  /**
+   * Stop tracing.
+   * 
+   */
   stop(): void;
+
+  /**
+   * Registers an exporter to send the collected traces to.
+   * @param exporter The exporter to send the traces to.
+   */
   registerExporter(exporter: Exporter): Tracing;
 }
 

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

@@ -27,6 +27,10 @@ const DEFAULT_BUFFER_SIZE = 3;
 const DEFAULT_BUFFER_TIMEOUT = 20000;  // time in milliseconds
 const tracer = new TracerImpl();
 
+const defaultBufferConfig = {
+  bufferSize: DEFAULT_BUFFER_SIZE,
+  bufferTimeout: DEFAULT_BUFFER_TIMEOUT
+};
 
 describe('Buffer', () => {
   /**
@@ -35,8 +39,7 @@ describe('Buffer', () => {
    */
   describe('new Buffer()', () => {
     it('should create a Buffer instance', () => {
-      const buffer =
-          new Buffer(exporter, DEFAULT_BUFFER_SIZE, DEFAULT_BUFFER_TIMEOUT);
+      const buffer = new Buffer(exporter, defaultBufferConfig);
       assert.ok(buffer instanceof Buffer);
     });
   });
@@ -46,7 +49,7 @@ describe('Buffer', () => {
    */
   describe('setBufferSize', () => {
     it('should return the Buffer instance', () => {
-      const buffer = new Buffer(exporter);
+      const buffer = new Buffer(exporter, defaultBufferConfig);
       const bufferResize = buffer.setBufferSize(DEFAULT_BUFFER_SIZE);
       assert.ok(bufferResize instanceof Buffer);
     });
@@ -57,7 +60,7 @@ describe('Buffer', () => {
    */
   describe('addToBuffer', () => {
     it('should return the Buffer instance', () => {
-      const buffer = new Buffer(exporter);
+      const buffer = new Buffer(exporter, defaultBufferConfig);
       const rootSpan = new RootSpanImpl(tracer);
       const bufferAdd = buffer.addToBuffer(rootSpan);
       assert.ok(bufferAdd instanceof Buffer);
@@ -69,7 +72,7 @@ describe('Buffer', () => {
    */
   describe('addToBuffer force flush ', () => {
     it('should return the Buffer instance', () => {
-      const buffer = new Buffer(exporter);
+      const buffer = new Buffer(exporter, defaultBufferConfig);
       const bufferResize = buffer.setBufferSize(0);
       const rootSpan = new RootSpanImpl(tracer);
       const bufferAdd = bufferResize.addToBuffer(rootSpan);
@@ -82,7 +85,8 @@ describe('Buffer', () => {
    */
   describe('addToBuffer force flush by timeout ', () => {
     it('should return the Buffer instance', () => {
-      const buffer = new Buffer(exporter, DEFAULT_BUFFER_SIZE, 0);
+      const buffer = new Buffer(
+          exporter, {bufferSize: DEFAULT_BUFFER_SIZE, bufferTimeout: 0});
       const rootSpan = new RootSpanImpl(tracer);
       let bufferAdd = buffer.addToBuffer(rootSpan);
       bufferAdd = buffer.addToBuffer(rootSpan);