fix: Span changes

HazAT · kamilogorek · commit 206c46bca5e2 · 2019-11-01T11:27:38.000+01:00
diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts
@@ -404,7 +404,7 @@ export class Hub implements HubInterface {
       const span = top.scope.getSpan();
 
       if (span) {
-        return span.newSpan(spanContext);
+        return span.makeChild(spanContext);
       }
     }
 
diff --git a/packages/hub/src/span.ts b/packages/hub/src/span.ts
@@ -10,7 +10,7 @@ export const TRACEPARENT_REGEXP = /^[ \t]*([0-9a-f]{32})?-?([0-9a-f]{16})?-?([01
  */
 export class Span implements SpanInterface, SpanContext {
   /**
-   * @inheritDoc
+   * The reference to the current hub.
    */
   private readonly _hub: Hub = getCurrentHub();
 
@@ -116,7 +116,7 @@ export class Span implements SpanInterface, SpanContext {
    * Creates a new `Span` while setting the current `Span.id` as `parentSpanId`.
    * Also the `sampled` decision will be inherited.
    */
-  public newSpan(spanContext?: Pick<SpanContext, Exclude<keyof SpanContext, 'spanId'>>): Span {
+  public makeChild(spanContext?: Pick<SpanContext, Exclude<keyof SpanContext, 'spanId'>>): Span {
     const span = new Span({
       ...spanContext,
       parentSpanId: this._spanId,
diff --git a/packages/hub/test/span.test.ts b/packages/hub/test/span.test.ts
@@ -12,15 +12,15 @@ describe('Span', () => {
   describe('newSpan', () => {
     test('simple', () => {
       const span = new Span({ sampled: true });
-      const span2 = span.newSpan();
+      const span2 = span.makeChild();
       expect((span2 as any)._parentSpanId).toBe((span as any)._spanId);
       expect((span2 as any)._traceId).toBe((span as any)._traceId);
       expect((span2 as any).sampled).toBe((span as any).sampled);
     });
 
     test('gets currentHub', () => {
       const span = new Span({});
-      const span2 = span.newSpan();
+      const span2 = span.makeChild();
       expect((span as any)._hub).toBeInstanceOf(Hub);
       expect((span2 as any)._hub).toBeInstanceOf(Hub);
     });
@@ -74,15 +74,15 @@ describe('Span', () => {
   describe('newSpan', () => {
     test('simple', () => {
       const span = new Span({ sampled: true });
-      const span2 = span.newSpan();
+      const span2 = span.makeChild();
       expect((span2 as any)._parentSpanId).toBe((span as any)._spanId);
       expect((span2 as any)._traceId).toBe((span as any)._traceId);
       expect((span2 as any).sampled).toBe((span as any).sampled);
     });
 
     test('gets currentHub', () => {
       const span = new Span({});
-      const span2 = span.newSpan();
+      const span2 = span.makeChild();
       expect((span as any)._hub).toBeInstanceOf(Hub);
       expect((span2 as any)._hub).toBeInstanceOf(Hub);
     });
@@ -178,7 +178,7 @@ describe('Span', () => {
     test('finish a scope span with transaction + child span', () => {
       const spy = jest.spyOn(hub as any, 'captureEvent') as any;
       const parentSpan = new Span({ transaction: 'test' }, hub);
-      const childSpan = parentSpan.newSpan();
+      const childSpan = parentSpan.makeChild();
       childSpan.finish();
       parentSpan.finish();
       expect(spy).toHaveBeenCalled();
diff --git a/packages/minimal/src/index.ts b/packages/minimal/src/index.ts
@@ -171,24 +171,9 @@ export function _callOnClient(method: string, ...args: any[]): void {
 /**
  * This functions starts a span. If just a `SpanContext` is passed and there is already a Span
  * on the Scope, the created Span will have a reference to the one on the Scope.
- * If a Span is on the current Scope it is considered a `transaction`.
- * When using the second parameter it will set the created Span on the Scope (replacing whats there).
- * This can be used as a shortcut to not set it manually on the Scope.
  *
  * @param spanContext Properties with which the span should be created
- * @param bindOnScope Determines if the started span will be set on the Scope
  */
-export function startSpan(spanContext?: SpanContext, bindOnScope?: boolean): Span {
-  return callOnHub<Span>('startSpan', spanContext, bindOnScope);
-}
-
-/**
- * This finishes the passed `Span`. If the `Span` has the property `transaction` set and it's bound on the
- * current Scope, an `transaction` Event will be sent to Sentry containing all finished Spans inbetween.
- * Returns either an `event.id` or `undefined` in case event wasn't sent.
- *
- * @param span `Span` instance that was created by {@link startSpan}
- */
-export function finishSpan(span?: Span): string | undefined {
-  return callOnHub<string | undefined>('finishSpan', span);
+export function startSpan(spanContext?: SpanContext): Span {
+  return callOnHub<Span>('startSpan', spanContext);
 }

Original file line number	Diff line number	Diff line change
`@@ -404,7 +404,7 @@ export class Hub implements HubInterface {`
`404`	`404`	`const span = top.scope.getSpan();`
`405`	`405`
`406`	`406`	`if (span) {`
`407`		`- return span.newSpan(spanContext);`
	`407`	`+ return span.makeChild(spanContext);`
`408`	`408`	`}`
`409`	`409`	`}`
`410`	`410`