ref: Return function call result from wrap method

Author: kamilogorek

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - [core] fix: When using enabled:false integrations shouldnt be installed (#2181)
 - [browser] feat: Add support for custom schemes to Tracekit
+- [browser] ref: Return function call result from `wrap` method
 - [browser] ref: Better UnhandledRejection messages (#2185)
 - [browser] test: Complete rewrite of Browser Integration Tests (#2176)
 - [node] feat: Add cookies as an optional property in the request handler (#2167)

packages/browser/src/sdk.ts

@@ -159,8 +159,10 @@ export function close(timeout?: number): Promise<boolean> {
  * Wrap code within a try/catch block so the SDK is able to capture errors.
  *
  * @param fn A function to wrap.
+ *
+ * @returns The result of wrapped function call.
  */
-export function wrap(fn: Function): void {
+export function wrap<T>(fn: () => T): ReturnType<typeof fn> {
   // tslint:disable-next-line: no-unsafe-any
-  internalWrap(fn)();
+  return internalWrap(fn)();
 }

packages/browser/test/unit/index.test.ts

@@ -14,6 +14,7 @@ import {
   init,
   Integrations,
   Scope,
+  wrap,
 } from '../../src';
 
 import { SimpleTransport } from './mocks/simpletransport';
@@ -180,3 +181,48 @@ describe('SentryBrowser initialization', () => {
     expect(global.__SENTRY__.hub._stack[0].client.getOptions().release).to.be.undefined;
   });
 });
+
+describe('wrap()', () => {
+  it('should wrap and call function while capturing error', done => {
+    getCurrentHub().bindClient(
+      new BrowserClient({
+        beforeSend: (event: Event) => {
+          expect(event.exception!.values![0].type).to.equal('TypeError');
+          expect(event.exception!.values![0].value).to.equal('mkey');
+          done();
+          return null;
+        },
+        dsn,
+      }),
+    );
+
+    wrap(() => {
+      throw new TypeError('mkey');
+    });
+  });
+
+  it('should return result of a function call', () => {
+    const result = wrap(() => 2);
+    expect(result).to.equal(2);
+  });
+
+  it('should allow for passing this and arguments through binding', () => {
+    const result = wrap(
+      function(this: any, a: string, b: number): any[] {
+        return [this, a, b];
+      }.bind({ context: 'this' }, 'b', 42),
+    );
+
+    expect((result as any[])[0]).to.deep.equal({ context: 'this' });
+    expect((result as any[])[1]).to.equal('b');
+    expect((result as any[])[2]).to.equal(42);
+
+    const result2 = wrap(
+      function(this: { x: number }): number {
+        return this.x;
+      }.bind({ x: 42 }),
+    );
+
+    expect(result2).to.equal(42);
+  });
+});

packages/browser/test/unit/integrations/helpers.test.ts

@@ -4,7 +4,7 @@ import { SinonSpy, spy } from 'sinon';
 
 import { wrap } from '../../../src/helpers';
 
-describe('wrap()', () => {
+describe('internal wrap()', () => {
   it('should wrap only functions', () => {
     const fn = () => 1337;
     const obj = { pickle: 'Rick' };