feat: Some cleanup and changes

HazAT · kamilogorek · commit 48da3f8375ee · 2019-11-01T11:25:42.000+01:00
diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts
@@ -8,7 +8,7 @@ import {
   Integration,
   IntegrationClass,
   Severity,
-  SpanDetails,
+  SpanProps,
   User,
 } from '@sentry/types';
 import { consoleSandbox, dynamicRequire, getGlobalObject, isNodeEnv, logger, uuid4 } from '@sentry/utils';
@@ -389,17 +389,17 @@ export class Hub implements HubInterface {
   /**
    * @inheritDoc
    */
-  public startSpan(spanDetails?: SpanDetails): Span {
+  public startSpan(spanProps?: SpanProps): Span {
     const scope = this.getScope();
 
     if (scope) {
       const span = scope.getSpan();
       if (span) {
-        return span.newSpan(spanDetails);
+        return span.newSpan(spanProps);
       }
     }
 
-    return new Span(spanDetails);
+    return new Span(spanProps);
   }
 
   /**
diff --git a/packages/hub/src/span.ts b/packages/hub/src/span.ts
@@ -1,12 +1,12 @@
-import { Span as SpanInterface, SpanDetails } from '@sentry/types';
+import { Span as SpanInterface, SpanProps } from '@sentry/types';
 import { uuid4 } from '@sentry/utils';
 
 export const TRACEPARENT_REGEXP = /^[ \t]*([0-9a-f]{32})?-?([0-9a-f]{16})?-?([01])?[ \t]*$/;
 
 /**
- * Span containg all data about a span
+ * Span contains all data about a span
  */
-export class Span implements SpanInterface {
+export class Span implements SpanInterface, SpanProps {
   /**
    * Trace ID
    */
@@ -57,38 +57,38 @@ export class Span implements SpanInterface {
    */
   public finishedSpans: Span[] = [];
 
-  public constructor(spanDetails?: SpanDetails) {
-    if (!spanDetails) {
+  public constructor(spanProps?: SpanProps) {
+    if (!spanProps) {
       return this;
     }
 
-    if (spanDetails.traceId) {
-      this._traceId = spanDetails.traceId;
+    if (spanProps.traceId) {
+      this._traceId = spanProps.traceId;
     }
-    if (spanDetails.spanId) {
-      this._spanId = spanDetails.spanId;
+    if (spanProps.spanId) {
+      this._spanId = spanProps.spanId;
     }
-    if (spanDetails.parentSpanId) {
-      this._parentSpanId = spanDetails.parentSpanId;
+    if (spanProps.parentSpanId) {
+      this._parentSpanId = spanProps.parentSpanId;
     }
-    if (spanDetails.sampled) {
-      this.sampled = spanDetails.sampled;
+    if (spanProps.sampled) {
+      this.sampled = spanProps.sampled;
     }
-    if (spanDetails.transaction) {
-      this.transaction = spanDetails.transaction;
+    if (spanProps.transaction) {
+      this.transaction = spanProps.transaction;
     }
-    if (spanDetails.op) {
-      this.op = spanDetails.op;
+    if (spanProps.op) {
+      this.op = spanProps.op;
     }
-    if (spanDetails.description) {
-      this.description = spanDetails.description;
+    if (spanProps.description) {
+      this.description = spanProps.description;
     }
   }
 
   /** JSDoc */
-  public newSpan(spanDetails?: Pick<SpanDetails, Exclude<keyof SpanDetails, 'spanId'>>): Span {
+  public newSpan(spanProps?: Pick<SpanProps, Exclude<keyof SpanProps, 'spanId'>>): Span {
     const span = new Span({
-      ...spanDetails,
+      ...spanProps,
       parentSpanId: this._parentSpanId,
       sampled: this.sampled,
       traceId: this._traceId,
@@ -99,27 +99,19 @@ export class Span implements SpanInterface {
     return span;
   }
 
-  /**
-   * Setter for transaction.
-   */
-  public setTransaction(transaction: string | undefined): this {
-    this.transaction = transaction;
-    return this;
-  }
-
   /**
    * Continues a trace
    * @param traceparent Traceparent string
    */
   public static fromTraceparent(
     traceparent: string,
-    spanDetails?: Pick<SpanDetails, Exclude<keyof SpanDetails, 'spanId' | 'sampled' | 'traceid'>>,
+    spanProps?: Pick<SpanProps, Exclude<keyof SpanProps, 'spanId' | 'sampled' | 'traceid'>>,
   ): Span | undefined {
     const matches = traceparent.match(TRACEPARENT_REGEXP);
     if (matches) {
       const [traceId, spanId, sampled] = matches;
       return new Span({
-        ...spanDetails,
+        ...spanProps,
         sampled,
         spanId,
         traceId,
@@ -142,6 +134,7 @@ export class Span implements SpanInterface {
   public toTraceparent(): string {
     return `${this._traceId}-${this._spanId}${this.sampled ? '-1' : '0'}`;
   }
+
   /**
    * @inheritDoc
    */
diff --git a/packages/integrations/src/tracing.ts b/packages/integrations/src/tracing.ts
@@ -6,7 +6,6 @@ interface TracingOptions {
   tracingOrigins?: Array<string | RegExp>;
   traceFetch?: boolean;
   traceXHR?: boolean;
-  autoStartOnDomReady?: boolean;
 }
 
 /**
@@ -56,31 +55,6 @@ export class Tracing implements Integration {
     if (this._options.traceFetch !== false) {
       this._traceFetch(getCurrentHub);
     }
-    if (this._options.autoStartOnDomReady !== false) {
-      getGlobalObject<Window>().addEventListener('DOMContentLoaded', () => {
-        Tracing.startTrace(getCurrentHub(), getGlobalObject<Window>().location.href);
-      });
-      getGlobalObject<Window>().document.onreadystatechange = () => {
-        if (document.readyState === 'complete') {
-          Tracing.startTrace(getCurrentHub(), getGlobalObject<Window>().location.href);
-        }
-      };
-    }
-  }
-
-  /**
-   * Starts a new trace
-   * @param hub The hub to start the trace on
-   * @param transaction Optional transaction
-   */
-  public static startTrace(hub: Hub, transaction?: string): void {
-    const span = hub.startSpan({
-      transaction,
-    });
-
-    hub.configureScope(scope => {
-      scope.setSpan(span);
-    });
   }
 
   /**
diff --git a/packages/types/src/hub.ts b/packages/types/src/hub.ts
@@ -4,7 +4,7 @@ import { Event, EventHint } from './event';
 import { Integration, IntegrationClass } from './integration';
 import { Scope } from './scope';
 import { Severity } from './severity';
-import { Span, SpanDetails } from './span';
+import { Span, SpanProps } from './span';
 import { User } from './user';
 
 /**
@@ -173,7 +173,7 @@ export interface Hub {
   traceHeaders(): { [key: string]: string };
 
   /** JSDoc */
-  startSpan(spanDetails?: SpanDetails): Span;
+  startSpan(spanProps?: SpanProps): Span;
 
   /** JSDoc */
   finishSpan(span: Span): string | undefined;
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -16,7 +16,7 @@ export { Response } from './response';
 export { Scope } from './scope';
 export { SdkInfo } from './sdkinfo';
 export { Severity } from './severity';
-export { Span, SpanDetails } from './span';
+export { Span, SpanProps } from './span';
 export { StackFrame } from './stackframe';
 export { Stacktrace } from './stacktrace';
 export { Status } from './status';
diff --git a/packages/types/src/span.ts b/packages/types/src/span.ts
@@ -9,7 +9,7 @@ export interface Span {
 }
 
 /** JSDoc */
-export interface SpanDetails {
+export interface SpanProps {
   description?: string;
   op?: string;
   parentSpanId?: string;

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ export interface Span {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`/** JSDoc */`
`12`		`-export interface SpanDetails {`
	`12`	`+export interface SpanProps {`
`13`	`13`	`description?: string;`
`14`	`14`	`op?: string;`
`15`	`15`	`parentSpanId?: string;`