feat: Add Sentry.getTransaction

HazAT · HazAT · commit 5728da3f884b · 2020-06-11T11:46:20.000+02:00
diff --git a/packages/apm/src/hubextensions.ts b/packages/apm/src/hubextensions.ts
@@ -19,6 +19,19 @@ function traceHeaders(this: Hub): { [key: string]: string } {
   return {};
 }
 
+/**
+ * {@see Hub.getTransaction}
+ */
+function getTransaction(this: Hub, callback: (transaction: Transaction) => void): void {
+  const scope = this.getScope();
+  if (scope) {
+    const span = scope.getSpan() as Transaction;
+    if (span) {
+      callback(span);
+    }
+  }
+}
+
 /**
  * {@see Hub.startTransaction}
  */
@@ -96,6 +109,9 @@ export function addExtensionMethods(): void {
     if (!carrier.__SENTRY__.extensions.startSpan) {
       carrier.__SENTRY__.extensions.startSpan = startSpan;
     }
+    if (!carrier.__SENTRY__.extensions.getTransaction) {
+      carrier.__SENTRY__.extensions.getTransaction = getTransaction;
+    }
     if (!carrier.__SENTRY__.extensions.traceHeaders) {
       carrier.__SENTRY__.extensions.traceHeaders = traceHeaders;
     }
diff --git a/packages/apm/test/hub.test.ts b/packages/apm/test/hub.test.ts
@@ -11,6 +11,28 @@ describe('Hub', () => {
     jest.useRealTimers();
   });
 
+  describe('getTransaction', () => {
+    test('simple invoke', () => {
+      const hub = new Hub(new BrowserClient({ tracesSampleRate: 1 }));
+      const transaction = hub.startTransaction({ name: 'foo' });
+      hub.configureScope(scope => {
+        scope.setSpan(transaction);
+      });
+      hub.getTransaction(t => {
+        expect(t).toBe(transaction);
+      });
+    });
+
+    test('not invoke', () => {
+      const hub = new Hub(new BrowserClient({ tracesSampleRate: 1 }));
+      const transaction = hub.startTransaction({ name: 'foo' });
+      hub.getTransaction(_ => {
+        expect(true).toBe(false);
+      });
+      transaction.finish();
+    });
+  });
+
   describe('spans', () => {
     describe('sampling', () => {
       test('set tracesSampleRate 0 on span', () => {
diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts
@@ -380,6 +380,13 @@ export class Hub implements HubInterface {
     return this._callExtensionMethod('startTransaction', context);
   }
 
+  /**
+   * @inheritDoc
+   */
+  public getTransaction(callback: (transaction: Transaction) => void): void {
+    this._callExtensionMethod('getTransaction', callback);
+  }
+
   /**
    * @inheritDoc
    */
diff --git a/packages/minimal/src/index.ts b/packages/minimal/src/index.ts
@@ -196,3 +196,11 @@ export function _callOnClient(method: string, ...args: any[]): void {
 export function startTransaction(context: TransactionContext): Transaction {
   return callOnHub('startTransaction', { ...context });
 }
+
+/**
+ * Callback to retrieve an ongoing Transaction in case there is one.
+ * @param callback Will only be invoked in case there is an active transaction
+ */
+export function getTransaction(callback: (transaction: Transaction) => void): void {
+  callOnHub<void>('getTransaction', callback);
+}
diff --git a/packages/types/src/hub.ts b/packages/types/src/hub.ts
@@ -199,4 +199,10 @@ export interface Hub {
    * @param context Properties of the new `Transaction`.
    */
   startTransaction(context: TransactionContext): Transaction;
+
+  /**
+   * Callback to retrieve an ongoing Transaction in case there is one.
+   * @param callback Will only be invoked in case there is an active transaction
+   */
+  getTransaction(callback: (transaction: Transaction) => void): void;
 }
