feat: Add values to exception interface

HazAT · kamilogorek · commit d3ec75523fec · 2018-06-25T10:47:24.000+02:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -13,7 +13,7 @@
     "**/dist/": true
   },
   "typescript.tsdk": "./node_modules/typescript/lib",
-  "tslint.enable": false,
+  "tslint.autoFixOnSave": true,
   "[json]": {
     "editor.formatOnType": false,
     "editor.formatOnPaste": false,
diff --git a/packages/browser/src/backend.ts b/packages/browser/src/backend.ts
@@ -1,32 +1,11 @@
 import { Backend, Options, SentryError } from '@sentry/core';
 import { addBreadcrumb, captureEvent } from '@sentry/minimal';
-import { SentryEvent, SentryException } from '@sentry/types';
+import { SentryEvent } from '@sentry/types';
 import { Raven, SendMethod } from './raven';
 
 /** Original raven send function. */
 const sendRavenEvent = Raven._sendProcessedPayload.bind(Raven) as SendMethod;
 
-/** Normalizes the event so it is consistent with our domain interface. */
-function normalizeRavenEvent(event?: SentryEvent): SentryEvent | undefined {
-  const ex = ((event && event.exception) || {}) as {
-    values?: SentryException[];
-  };
-  if (event && ex && ex.values) {
-    event.exception = ex.values;
-  }
-  return event;
-}
-
-/** Prepares an event so it can be send with raven-js. */
-function prepareEventForRaven(event: SentryEvent): SentryEvent {
-  const ravenEvent = event as any;
-  if (event.exception) {
-    // tslint:disable-next-line:no-unsafe-any
-    ravenEvent.exception = { values: event.exception };
-  }
-  return ravenEvent as SentryEvent;
-}
-
 /**
  * Configuration options for the Sentry Browser SDK.
  * @see BrowserClient for more information.
@@ -95,15 +74,7 @@ export class BrowserBackend implements Backend {
       return false;
     });
 
-    // Hook into Raven's internal event sending mechanism. This allows us to
-    // pass events to the client, before they will be sent back here for
-    // actual submission.
-    Raven._sendProcessedPayload = event => {
-      const normalizedEvent = normalizeRavenEvent(event);
-      if (normalizedEvent) {
-        captureEvent(normalizedEvent);
-      }
-    };
+    Raven._sendProcessedPayload = captureEvent;
 
     return true;
   }
@@ -119,11 +90,7 @@ export class BrowserBackend implements Backend {
         event = evt;
       };
       Raven.captureException(exception);
-      const normalizedEvent = normalizeRavenEvent(event);
-      if (normalizedEvent) {
-        return normalizedEvent;
-      }
-      throw new SentryError('Event was undefined when it should be an event');
+      return event;
     } finally {
       Raven._sendProcessedPayload = originalSend;
     }
@@ -140,11 +107,7 @@ export class BrowserBackend implements Backend {
         event = evt;
       };
       Raven.captureMessage(message);
-      const normalizedEvent = normalizeRavenEvent(event);
-      if (normalizedEvent) {
-        return normalizedEvent;
-      }
-      throw new SentryError('Event was undefined when it should be an event');
+      return event;
     } finally {
       Raven._sendProcessedPayload = originalSend;
     }
@@ -155,7 +118,7 @@ export class BrowserBackend implements Backend {
    */
   public async sendEvent(event: SentryEvent): Promise<number> {
     return new Promise<number>(resolve => {
-      sendRavenEvent(prepareEventForRaven(event), error => {
+      sendRavenEvent(event, error => {
         // TODO: Check the response status code
         resolve(error ? 500 : 200);
       });
diff --git a/packages/browser/test/index.test.ts b/packages/browser/test/index.test.ts
@@ -121,10 +121,10 @@ describe('SentryBrowser', () => {
         new BrowserClient({
           afterSend: (event: SentryEvent) => {
             expect(event.exception).to.not.be.undefined;
-            expect(event.exception![0]).to.not.be.undefined;
-            expect(event.exception![0].type).to.equal('Error');
-            expect(event.exception![0].value).to.equal('test');
-            expect(event.exception![0].stacktrace).to.not.be.empty;
+            expect(event.exception!.values[0]).to.not.be.undefined;
+            expect(event.exception!.values[0].type).to.equal('Error');
+            expect(event.exception!.values[0].value).to.equal('test');
+            expect(event.exception!.values[0].stacktrace).to.not.be.empty;
             done();
           },
           dsn,
diff --git a/packages/hub/src/global.ts b/packages/hub/src/global.ts
@@ -1,14 +1,6 @@
-import { Hub } from './hub';
+import { API_VERSION, Hub } from './hub';
 import { Carrier } from './interfaces';
 
-/**
- * API compatibility version of this hub.
- *
- * WARNING: This number should only be incresed when the global interface
- * changes a and new methods are introduced.
- */
-export const API_VERSION = 2;
-
 /** Global interface helper for type safety. */
 interface Global {
   __SENTRY__: Carrier;
diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts
@@ -1,8 +1,15 @@
 import { Breadcrumb, SentryEvent } from '@sentry/types';
-import { API_VERSION } from './global';
 import { Layer } from './interfaces';
 import { Scope } from './scope';
 
+/**
+ * API compatibility version of this hub.
+ *
+ * WARNING: This number should only be incresed when the global interface
+ * changes a and new methods are introduced.
+ */
+export const API_VERSION = 2;
+
 /**
  * Internal class used to make sure we always have the latest internal functions
  * working in case we have a version conflict.
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -110,7 +110,9 @@ export interface SentryEvent {
   request?: Request;
   modules?: { [key: string]: string };
   fingerprint?: string[];
-  exception?: SentryException[];
+  exception?: {
+    values: SentryException[];
+  };
   stacktrace?: Stacktrace;
   breadcrumbs?: Breadcrumb[];
   contexts?: { [key: string]: object };
diff --git a/tsconfig.json b/tsconfig.json
@@ -4,7 +4,9 @@
     "baseUrl": "packages",
     "types": ["node"],
     "paths": {
-      "@sentry/*": ["*/src"]
+      "@sentry/*": ["*/src"],
+      "raven-js": ["raven-js/src/singleton.js"],
+      "raven-node": ["raven-node/lib/client.js"]
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,9 @@`
`4`	`4`	`"baseUrl": "packages",`
`5`	`5`	`"types": ["node"],`
`6`	`6`	`"paths": {`
`7`		`- "@sentry/": ["/src"]`
	`7`	`+ "@sentry/": ["/src"],`
	`8`	`+ "raven-js": ["raven-js/src/singleton.js"],`
	`9`	`+ "raven-node": ["raven-node/lib/client.js"]`
`8`	`10`	`}`
`9`	`11`	`}`
`10`	`12`	`}`