feat: Add wrap (#2060)

* feat: Add context

* fix: Rename context to wrap

* fix: Rename to wrap

* fix: Docs

* fix: Changelog

* fix: Wrap function

Author: HazAT

CHANGELOG.md

@@ -2,7 +2,9 @@
 
 ## Unreleased
 
-- [browser] - feat: Added `onLoad` callback to `showReportDialog`
+- [browser] feat: Expose `wrap` function in `@sentry/browser`
+- [browser] feat: Added `onLoad` callback to `showReportDialog`
+- [browser] fix: Use 'native code' as a filename for some frames
 
 ## 5.2.0
 

packages/browser/src/client.ts

@@ -28,6 +28,7 @@ export interface ReportDialogOptions {
   errorGeneric?: string;
   errorFormEntry?: string;
   successMessage?: string;
+  /** Callback after reportDialog showed up */
   onLoad?(): void;
 }
 

packages/browser/src/integrations/helpers.ts renamed to packages/browser/src/helpers.ts

@@ -71,6 +71,7 @@ export function wrap(
 
     const args = Array.prototype.slice.call(arguments);
 
+    // tslint:disable:no-unsafe-any
     try {
       // Attempt to invoke user-land function
       // NOTE: If you are a Sentry user, and you are seeing this stack frame, it
@@ -82,6 +83,7 @@ export function wrap(
         return fn.handleEvent.apply(this, wrappedArguments);
       }
       return fn.apply(this, wrappedArguments);
+      // tslint:enable:no-unsafe-any
     } catch (ex) {
       ignoreNextOnError();
 

packages/browser/src/index.ts

@@ -29,7 +29,7 @@ export {
 
 export { BrowserOptions } from './backend';
 export { BrowserClient, ReportDialogOptions } from './client';
-export { defaultIntegrations, forceLoad, init, lastEventId, onLoad, showReportDialog, flush, close } from './sdk';
+export { defaultIntegrations, forceLoad, init, lastEventId, onLoad, showReportDialog, flush, close, wrap } from './sdk';
 export { SDK_NAME, SDK_VERSION } from './version';
 
 import { Integrations as CoreIntegrations } from '@sentry/core';

packages/browser/src/integrations/breadcrumbs.ts

@@ -14,8 +14,7 @@ import {
 } from '@sentry/utils';
 
 import { BrowserClient } from '../client';
-
-import { breadcrumbEventHandler, keypressEventHandler, wrap } from './helpers';
+import { breadcrumbEventHandler, keypressEventHandler, wrap } from '../helpers';
 
 const global = getGlobalObject<Window>();
 let lastHref: string | undefined;

packages/browser/src/integrations/globalhandlers.ts

@@ -2,6 +2,7 @@ import { getCurrentHub } from '@sentry/core';
 import { Event, Integration } from '@sentry/types';
 import { addExceptionTypeValue, isString, logger, normalize, truncate } from '@sentry/utils';
 
+import { shouldIgnoreOnError } from '../helpers';
 import { eventFromStacktrace } from '../parsers';
 import {
   _installGlobalHandler,
@@ -10,8 +11,6 @@ import {
   StackTrace as TraceKitStackTrace,
 } from '../tracekit';
 
-import { shouldIgnoreOnError } from './helpers';
-
 /** JSDoc */
 interface GlobalHandlersIntegrations {
   onerror: boolean;

packages/browser/src/integrations/trycatch.ts

@@ -1,7 +1,7 @@
 import { Integration, WrappedFunction } from '@sentry/types';
 import { fill, getGlobalObject } from '@sentry/utils';
 
-import { wrap } from './helpers';
+import { wrap } from '../helpers';
 
 /** Wrap timer functions and event targets to catch errors and provide better meta data */
 export class TryCatch implements Integration {

packages/browser/src/sdk.ts

@@ -2,6 +2,7 @@ import { getCurrentHub, initAndBind, Integrations as CoreIntegrations } from '@s
 
 import { BrowserOptions } from './backend';
 import { BrowserClient, ReportDialogOptions } from './client';
+import { wrap as internalWrap } from './helpers';
 import { Breadcrumbs, GlobalHandlers, LinkedErrors, TryCatch, UserAgent } from './integrations';
 
 export const defaultIntegrations = [
@@ -145,3 +146,13 @@ export function close(timeout?: number): Promise<boolean> {
   }
   return Promise.reject(false);
 }
+
+/**
+ * Wrap code within a try/catch block so the SDK is able to capture errors.
+ *
+ * @param fn A function to wrap.
+ */
+export function wrap(fn: Function): void {
+  // tslint:disable-next-line: no-unsafe-any
+  internalWrap(fn)();
+}

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

@@ -2,7 +2,7 @@ import { WrappedFunction } from '@sentry/types';
 import { expect } from 'chai';
 import { SinonSpy, spy } from 'sinon';
 
-import { wrap } from '../../src/integrations/helpers';
+import { wrap } from '../../src/helpers';
 
 describe('wrap()', () => {
   it('should wrap only functions', () => {