feat: Expose minimal API

HazAT · kamilogorek · commit 790ac56bde8b · 2019-11-01T11:27:04.000+01:00
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -20,6 +20,7 @@ export {
   captureEvent,
   captureMessage,
   configureScope,
+  finishSpan,
   getHubFromCarrier,
   getCurrentHub,
   Hub,
@@ -30,6 +31,7 @@ export {
   setTag,
   setTags,
   setUser,
+  startSpan,
   Span,
   withScope,
 } from '@sentry/core';
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -4,12 +4,14 @@ export {
   captureEvent,
   captureMessage,
   configureScope,
+  finishSpan,
   setContext,
   setExtra,
   setExtras,
   setTag,
   setTags,
   setUser,
+  startSpan,
   withScope,
 } from '@sentry/minimal';
 export { addGlobalEventProcessor, getCurrentHub, getHubFromCarrier, Hub, Scope, Span } from '@sentry/hub';
diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts
@@ -418,34 +418,52 @@ export class Hub implements HubInterface {
   /**
    * @inheritDoc
    */
-  public finishSpan(span: Span): string | undefined {
-    if (!span.timestamp) {
-      span.finish();
+  public finishSpan(span?: Span): string | undefined {
+    const top = this.getStackTop();
+    let passedSpan = span;
+
+    // If the passed span is undefined we try to get the span from the scope and finish it.
+    if (passedSpan === undefined) {
+      if (top.scope && top.client) {
+        const scopeSpan = top.scope.getSpan();
+        if (scopeSpan) {
+          passedSpan = scopeSpan;
+        }
+      }
+    }
+
+    if (passedSpan === undefined) {
+      // We will do nothing since nothing was passed and there is no Span on the scope.
+      return undefined;
+    }
+
+    if (!passedSpan.timestamp) {
+      passedSpan.finish();
     }
 
-    if (!span.transaction) {
+    if (!passedSpan.transaction) {
       return undefined;
     }
 
-    if (!this.getClient()) {
+    if (!top.client) {
       return undefined;
     }
 
     // TODO: if sampled do what?
 
-    const finishedSpans = span.finishedSpans.filter(s => s !== span);
+    const finishedSpans = passedSpan.finishedSpans.filter(s => s !== span);
 
     const eventId = this.captureEvent({
-      contexts: { trace: span.getTraceContext() },
+      contexts: { trace: passedSpan.getTraceContext() },
       spans: finishedSpans,
-      start_timestamp: span.startTimestamp,
-      timestamp: span.timestamp,
-      transaction: span.transaction,
+      start_timestamp: passedSpan.startTimestamp,
+      timestamp: passedSpan.timestamp,
+      transaction: passedSpan.transaction,
       type: 'transaction',
     });
 
     // After sending we reset the finishedSpans array
-    span.finishedSpans = [];
+    passedSpan.finishedSpans = [];
     return eventId;
   }
 }
diff --git a/packages/minimal/src/index.ts b/packages/minimal/src/index.ts
@@ -162,6 +162,7 @@ export function withScope(callback: (scope: Scope) => void): void {
  *
  * @param method The method to call on the client/client.
  * @param args Arguments to pass to the client/fontend.
+ * @hidden
  */
 export function _callOnClient(method: string, ...args: any[]): void {
   callOnHub<void>('_invokeClient', method, ...args);
@@ -188,6 +189,6 @@ export function startSpan(spanContext?: SpanContext, bindOnScope?: boolean): Spa
  *
  * @param span `Span` instance that was created by {@link startSpan}
  */
-export function finishSpan(span: Span): string | undefined {
+export function finishSpan(span?: Span): string | undefined {
   return callOnHub<string | undefined>('startSpan', span);
 }
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -20,8 +20,9 @@ export {
   captureEvent,
   captureMessage,
   configureScope,
-  getCurrentHub,
+  finishSpan,
   getHubFromCarrier,
+  getCurrentHub,
   Hub,
   Scope,
   setContext,
@@ -30,6 +31,7 @@ export {
   setTag,
   setTags,
   setUser,
+  startSpan,
   Span,
   withScope,
 } from '@sentry/core';
diff --git a/packages/types/src/hub.ts b/packages/types/src/hub.ts
@@ -191,5 +191,5 @@ export interface Hub {
    *
    * @param span `Span` instance that was created by {@link startSpan}
    */
-  finishSpan(span: Span): string | undefined;
+  finishSpan(span?: Span): string | undefined;
 }

Original file line number	Diff line number	Diff line change
`@@ -162,6 +162,7 @@ export function withScope(callback: (scope: Scope) => void): void {`
`162`	`162`	`*`
`163`	`163`	`* @param method The method to call on the client/client.`
`164`	`164`	`* @param args Arguments to pass to the client/fontend.`
	`165`	`+ * @hidden`
`165`	`166`	`*/`
`166`	`167`	`export function _callOnClient(method: string, ...args: any[]): void {`
`167`	`168`	`callOnHub<void>('_invokeClient', method, ...args);`
`@@ -188,6 +189,6 @@ export function startSpan(spanContext?: SpanContext, bindOnScope?: boolean): Spa`
`188`	`189`	`*`
`189`	`190`	* @param span `Span` instance that was created by {@link startSpan}
`190`	`191`	`*/`
`191`		`-export function finishSpan(span: Span): string \| undefined {`
	`192`	`+export function finishSpan(span?: Span): string \| undefined {`
`192`	`193`	`return callOnHub<string \| undefined>('startSpan', span);`
`193`	`194`	`}`
Original file line number	Diff line number	Diff line change
`@@ -191,5 +191,5 @@ export interface Hub {`
`191`	`191`	`*`
`192`	`192`	* @param span `Span` instance that was created by {@link startSpan}
`193`	`193`	`*/`
`194`		`- finishSpan(span: Span): string \| undefined;`
	`194`	`+ finishSpan(span?: Span): string \| undefined;`
`195`	`195`	`}`