ref: Rename SpanProps to SpanContext

HazAT · kamilogorek · commit 59516ce583b4 · 2019-11-01T11:26:35.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,
-  SpanProps,
+  SpanContext,
   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(spanProps?: SpanProps): Span {
+  public startSpan(SpanContext?: SpanContext): Span {
     const scope = this.getScope();
 
     if (scope) {
       const span = scope.getSpan();
       if (span) {
-        return span.newSpan(spanProps);
+        return span.newSpan(SpanContext);
       }
     }
 
-    return new Span(spanProps);
+    return new Span(SpanContext);
   }
 
   /**
diff --git a/packages/hub/src/span.ts b/packages/hub/src/span.ts
@@ -1,12 +1,12 @@
-import { Span as SpanInterface, SpanProps } from '@sentry/types';
+import { Span as SpanInterface, SpanContext } from '@sentry/types';
 import { uuid4 } from '@sentry/utils';
 
 export const TRACEPARENT_REGEXP = /^[ \t]*([0-9a-f]{32})?-?([0-9a-f]{16})?-?([01])?[ \t]*$/;
 
 /**
  * Span contains all data about a span
  */
-export class Span implements SpanInterface, SpanProps {
+export class Span implements SpanInterface, SpanContext {
   /**
    * Trace ID
    */
@@ -67,44 +67,44 @@ export class Span implements SpanInterface, SpanProps {
    */
   public finishedSpans: Span[] = [];
 
-  public constructor(spanProps?: SpanProps) {
-    if (!spanProps) {
+  public constructor(SpanContext?: SpanContext) {
+    if (!SpanContext) {
       return this;
     }
 
-    if (spanProps.traceId) {
-      this._traceId = spanProps.traceId;
+    if (SpanContext.traceId) {
+      this._traceId = SpanContext.traceId;
     }
-    if (spanProps.spanId) {
-      this._spanId = spanProps.spanId;
+    if (SpanContext.spanId) {
+      this._spanId = SpanContext.spanId;
     }
-    if (spanProps.parentSpanId) {
-      this._parentSpanId = spanProps.parentSpanId;
+    if (SpanContext.parentSpanId) {
+      this._parentSpanId = SpanContext.parentSpanId;
     }
-    if (spanProps.sampled) {
-      this.sampled = spanProps.sampled;
+    if (SpanContext.sampled) {
+      this.sampled = SpanContext.sampled;
     }
-    if (spanProps.transaction) {
-      this.transaction = spanProps.transaction;
+    if (SpanContext.transaction) {
+      this.transaction = SpanContext.transaction;
     }
-    if (spanProps.op) {
-      this.op = spanProps.op;
+    if (SpanContext.op) {
+      this.op = SpanContext.op;
     }
-    if (spanProps.description) {
-      this.description = spanProps.description;
+    if (SpanContext.description) {
+      this.description = SpanContext.description;
     }
-    if (spanProps.data) {
-      this.data = spanProps.data;
+    if (SpanContext.data) {
+      this.data = SpanContext.data;
     }
-    if (spanProps.tags) {
-      this.tags = spanProps.tags;
+    if (SpanContext.tags) {
+      this.tags = SpanContext.tags;
     }
   }
 
   /** JSDoc */
-  public newSpan(spanProps?: Pick<SpanProps, Exclude<keyof SpanProps, 'spanId'>>): Span {
+  public newSpan(SpanContext?: Pick<SpanContext, Exclude<keyof SpanContext, 'spanId'>>): Span {
     const span = new Span({
-      ...spanProps,
+      ...SpanContext,
       parentSpanId: this._spanId,
       sampled: this.sampled,
       traceId: this._traceId,
@@ -121,7 +121,7 @@ export class Span implements SpanInterface, SpanProps {
    */
   public static fromTraceparent(
     traceparent: string,
-    spanProps?: Pick<SpanProps, Exclude<keyof SpanProps, 'spanId' | 'sampled' | 'traceid'>>,
+    SpanContext?: Pick<SpanContext, Exclude<keyof SpanContext, 'spanId' | 'sampled' | 'traceid'>>,
   ): Span | undefined {
     const matches = traceparent.match(TRACEPARENT_REGEXP);
     if (matches) {
@@ -133,7 +133,7 @@ export class Span implements SpanInterface, SpanProps {
       }
 
       return new Span({
-        ...spanProps,
+        ...SpanContext,
         parentSpanId: matches[2],
         sampled,
         traceId: matches[1],
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, SpanProps } from './span';
+import { Span, SpanContext } from './span';
 import { User } from './user';
 
 /**
@@ -173,7 +173,7 @@ export interface Hub {
   traceHeaders(): { [key: string]: string };
 
   /** JSDoc */
-  startSpan(spanProps?: SpanProps): Span;
+  startSpan(SpanContext?: SpanContext): 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, SpanProps } from './span';
+export { Span, SpanContext } 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 SpanProps {
+export interface SpanContext {
   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 SpanProps {`
	`12`	`+export interface SpanContext {`
`13`	`13`	`description?: string;`
`14`	`14`	`op?: string;`
`15`	`15`	`parentSpanId?: string;`