chord: merge commit

Author: silva-fabio

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

@@ -14,91 +14,115 @@
  * limitations under the License.
  */
 
-import { Span } from './span'
-import { Clock } from '../../internal/clock'
 import * as uuid from 'uuid';
-import { debug } from '../../internal/util'
-import { SpanBaseModel, TraceOptions, TraceContext, OnEndSpanEventListener } from '../types/tracetypes'
-import { Tracer } from './tracer'
 
-export class RootSpan extends SpanBaseModel implements OnEndSpanEventListener {
+import {Clock} from '../../internal/clock';
+import {debug} from '../../internal/util';
+import {OnEndSpanEventListener, SpanBaseModel, TraceContext, TraceOptions} from '../types/tracetypes';
+import {Span} from './span';
+import {Tracer} from './tracer';
 
-    private tracer: Tracer;
-    private _spans: Span[];
-    private _traceId: string;
+/** Defines a root span */
+export class RootSpan extends SpanBaseModel implements OnEndSpanEventListener {
+  private tracer: Tracer;
+  readonly traceId: string;
+  private spansLocal: Span[] = [];
 
-    //TODO - improve root name setup
-    constructor(tracer: Tracer, context?: TraceOptions) {
-        super()
-        this.tracer = tracer;
-        this._traceId = context && context.traceContext && context.traceContext.traceId ? context.traceContext.traceId : (uuid.v4().split('-').join(''));
-        this.name = context && context.name ? context.name : 'undefined';
-        if (context && context.traceContext) {
-            this.setParentSpanId(context.traceContext.spanId || '')
-        }
-        this._spans = [];
+  /**
+   * Constructs a new RootSpan instance.
+   * @param tracer
+   * @param context
+   */
+  constructor(tracer: Tracer, context?: TraceOptions) {
+    super();
+    this.tracer = tracer;
+    this.traceId =
+        context && context.traceContext && context.traceContext.traceId ?
+        context.traceContext.traceId :
+        (uuid.v4().split('-').join(''));
+    // TODO - improve root name setup
+    this.name = context && context.name ? context.name : 'undefined';
+    if (context && context.traceContext) {
+      this.setParentSpanId(context.traceContext.spanId || '');
     }
+  }
 
-    public get spans() {
-        return this._spans;
-    }
+  /** Returns a list of the trace's spans. */
+  get spans() {
+    return this.spansLocal;
+  }
 
-    public get traceId() {
-        return this._traceId;
-    }
+  /** Starts the root span. */
+  start() {
+    super.start();
+    debug('starting %s  %o', this._className, {
+      traceId: this.traceId,
+      id: this.id,
+      parentSpanId: this.getParentSpanId()
+    });
+  }
 
-    public start() {
-        super.start()
-        debug('starting %s  %o', this._className, { traceId: this.traceId, id: this.id, parentSpanId: this.getParentSpanId() })
-    }
+  /** Ends the root span. */
+  end() {
+    super.end();
 
-    public end() {
-        super.end()
+    // TODO - Define logic for list of spans
+    this.spansLocal.map(span => {
+      if (span.ended || !span.started) return;
+      span.truncate();
+    });
 
-        //TODO - Define logic for list of spans
-        this._spans.forEach(function (span) {
-            if (span.ended || !span.started) return
-            span.truncate()
-        })
+    debug('ending %s  %o', this._className, {
+      id: this.id,
+      traceId: this.traceId,
+      name: this.name,
+      startTime: this.startTime,
+      endTime: this.endTime,
+      duration: this.duration
+    });
 
-        debug('ending %s  %o',
-            this._className,
-            {
-                id: this.id,
-                traceId: this.traceId,
-                name: this.name,
-                startTime: this.startTime,
-                endTime: this.endTime,
-                duration: this.duration
-            })
+    this.tracer.onEndSpan(this);
+  }
 
-        this.tracer.onEndSpan(this)
-    }
+  /**
+   * Happens when a span is ended.
+   * @param span
+   */
+  onEndSpan(span: Span) {
+    debug('%s notified ending by %o', {id: span.id, name: span.name});
+  }
 
-    public onEndSpan(span: Span) {
-        debug('%s notified ending by %o', { id: span.id, name: span.name })
+  /**
+   * Starts a span inside the respective trace.
+   * @param name Span's name
+   * @param type Spans's type
+   * @param parentSpanId Span's parent ID
+   */
+  startSpan(name: string, type: string, parentSpanId?: string) {
+    if (!this.started) {
+      debug(
+          'calling %s.startSpan() on un-started %s %o', this._className,
+          this._className, {id: this.id, name: this.name, type: this.type});
+      return;
     }
-
-    public startSpan(name: string, type: string, parentSpanId?: string) {
-        if (!this.started) {
-            debug('calling %s.startSpan() on un-started %s %o',
-                this._className, this._className,
-                { id: this.id, name: this.name, type: this.type })
-            return
-        }
-        if (this.ended) {
-            debug('calling %s.startSpan() on ended %s %o',
-                this._className, this._className,
-                { id: this.id, name: this.name, type: this.type })
-            return
-        }
-        let newSpan = new Span(this);
-        if (name) { newSpan.name = name }
-        if (type) { newSpan.type = type }
-        if (type) { newSpan.setParentSpanId(parentSpanId || '') }
-        newSpan.start();
-        this._spans.push(newSpan);
-        return newSpan;
+    if (this.ended) {
+      debug(
+          'calling %s.startSpan() on ended %s %o', this._className,
+          this._className, {id: this.id, name: this.name, type: this.type});
+      return;
+    }
+    const newSpan = new Span(this);
+    if (name) {
+      newSpan.name = name;
+    }
+    if (type) {
+      newSpan.type = type;
     }
+    if (type) {
+      newSpan.setParentSpanId(parentSpanId || '');
+    }
+    newSpan.start();
+    this.spansLocal.push(newSpan);
+    return newSpan;
+  }
 }
-