test: Core and browser transport tests

Author: kamilogorek

packages/browser/src/transports/fetch.ts

@@ -27,6 +27,6 @@ export class FetchTransport extends BaseTransport {
         : '') as ReferrerPolicy,
     };
 
-    return global.fetch(this.url, defaultOptions);
+    return (global as Window).fetch(this.url, defaultOptions);
   }
 }

packages/browser/test/backend.test.ts

@@ -0,0 +1,43 @@
+import { expect } from 'chai';
+import { SentryEvent } from '../src';
+import { BrowserBackend } from '../src/backend';
+import { BaseTransport } from '../src/transports';
+
+class SimpleTransport extends BaseTransport {
+  public async send(event: SentryEvent): Promise<Response> {
+    return new Response(event.event_id, {
+      status: 200,
+    });
+  }
+}
+
+const dsn = 'https://[email protected]/42';
+const testEvent = {
+  event_id: '1337',
+  message: 'Pickle Rick',
+  user: {
+    username: 'Morty',
+  },
+};
+
+let backend: BrowserBackend;
+
+describe('BrowserBackend', () => {
+  describe('sendEvent()', () => {
+    it('should throw when no DSN is provided', async () => {
+      backend = new BrowserBackend({ dsn });
+
+      try {
+        await backend.sendEvent(testEvent);
+      } catch (e) {
+        expect(e.message).equal('Cannot sendEvent without a valid DSN');
+      }
+    });
+
+    it('should call send() on provided transport', async () => {
+      backend = new BrowserBackend({ dsn, transport: SimpleTransport });
+      const status = await backend.sendEvent(testEvent);
+      expect(status).equal(200);
+    });
+  });
+});

packages/core/src/base.ts

@@ -249,11 +249,13 @@ export abstract class BaseClient<B extends Backend, O extends Options>
     if (prepared.message) {
       prepared.message = truncate(prepared.message, MAX_URL_LENGTH);
     }
-    if (prepared.exception) {
-      const exception = prepared.exception.values[0];
-      if (exception.value) {
-        exception.value = truncate(exception.value, MAX_URL_LENGTH);
-      }
+
+    const exception =
+      prepared.exception &&
+      prepared.exception.values &&
+      prepared.exception.values[0];
+    if (exception && exception.value) {
+      exception.value = truncate(exception.value, MAX_URL_LENGTH);
     }
 
     const request = prepared.request;

packages/core/test/lib/base.test.ts

@@ -6,6 +6,15 @@ import { TEST_SDK, TestClient } from '../mocks/client';
 
 const PUBLIC_DSN = 'https://username@domain/path';
 
+jest.mock('@sentry/utils', () => ({
+  uuid4(): string {
+    return '42';
+  },
+  truncate(str: string): string {
+    return str;
+  },
+}));
+
 describe('BaseClient', () => {
   describe('constructor() / getDSN()', () => {
     test('returns the DSN', () => {
@@ -151,6 +160,7 @@ describe('BaseClient', () => {
       const scope = new Scope();
       await client.captureException(new Error('test exception'), scope);
       expect(TestBackend.instance!.event).toEqual({
+        event_id: '42',
         exception: [
           {
             type: 'Error',
@@ -167,6 +177,7 @@ describe('BaseClient', () => {
       const scope = new Scope();
       await client.captureMessage('test message', scope);
       expect(TestBackend.instance!.event).toEqual({
+        event_id: '42',
         message: 'test message',
         sdk: TEST_SDK,
       });
@@ -194,6 +205,7 @@ describe('BaseClient', () => {
       await client.captureEvent({ message: 'message' }, scope);
       expect(TestBackend.instance!.event!.message).toBe('message');
       expect(TestBackend.instance!.event).toEqual({
+        event_id: '42',
         message: 'message',
         sdk: TEST_SDK,
       });
@@ -208,6 +220,7 @@ describe('BaseClient', () => {
       await client.captureEvent({ message: 'message' }, scope);
       expect(TestBackend.instance!.event!).toEqual({
         environment: 'env',
+        event_id: '42',
         message: 'message',
         sdk: TEST_SDK,
       });
@@ -221,6 +234,7 @@ describe('BaseClient', () => {
       const scope = new Scope();
       await client.captureEvent({ message: 'message' }, scope);
       expect(TestBackend.instance!.event!).toEqual({
+        event_id: '42',
         message: 'message',
         release: 'v1.0.0',
         sdk: TEST_SDK,
@@ -234,6 +248,7 @@ describe('BaseClient', () => {
       await client.captureEvent({ message: 'message' }, scope);
       expect(TestBackend.instance!.event!).toEqual({
         breadcrumbs: [{ message: 'breadcrumb' }],
+        event_id: '42',
         message: 'message',
         sdk: TEST_SDK,
       });
@@ -247,6 +262,7 @@ describe('BaseClient', () => {
       await client.captureEvent({ message: 'message' }, scope);
       expect(TestBackend.instance!.event!).toEqual({
         breadcrumbs: [{ message: '2' }],
+        event_id: '42',
         message: 'message',
         sdk: TEST_SDK,
       });
@@ -260,6 +276,7 @@ describe('BaseClient', () => {
       scope.setUser({ id: 'user' });
       await client.captureEvent({ message: 'message' }, scope);
       expect(TestBackend.instance!.event!).toEqual({
+        event_id: '42',
         extra: { b: 'b' },
         message: 'message',
         sdk: TEST_SDK,
@@ -274,6 +291,7 @@ describe('BaseClient', () => {
       scope.setFingerprint(['abcd']);
       await client.captureEvent({ message: 'message' }, scope);
       expect(TestBackend.instance!.event!).toEqual({
+        event_id: '42',
         fingerprint: ['abcd'],
         message: 'message',
         sdk: TEST_SDK,
@@ -286,6 +304,7 @@ describe('BaseClient', () => {
       const scope = new Scope();
       await client.captureEvent({ message: 'hello' }, scope);
       expect(TestBackend.instance!.event).toEqual({
+        event_id: '42',
         message: 'hello',
         sdk: TEST_SDK,
       });

packages/utils/src/index.ts

@@ -3,12 +3,12 @@ export { mkdirp, mkdirpSync } from './fs';
 export { clone, deserialize, fill, serialize, urlEncode } from './object';
 export { Store } from './store';
 export { isError, isErrorEvent, isDOMError, isDOMException } from './is';
-export { truncate, uuid4 } from './string';
+export { truncate } from './string';
 export {
   supportsDOMError,
   supportsDOMException,
   supportsErrorEvent,
   supportsFetch,
   supportsReferrerPolicy,
 } from './supports';
-export { getGlobalObject } from './misc';
+export { getGlobalObject, uuid4 } from './misc';

packages/utils/src/misc.ts

@@ -9,6 +9,66 @@ export function getGlobalObject(): Window | NodeJS.Global | {} {
     ? window
     : typeof global !== 'undefined'
       ? global
-      : typeof self !== 'undefined' ? self : {};
+      : typeof self !== 'undefined'
+        ? self
+        : {};
 }
 // tslint:enable:strict-type-predicates
+
+/**
+ * Extended Window interface that allows for Crypto API usage in IE browsers
+ */
+interface MsCryptoWindow extends Window {
+  msCrypto?: Crypto;
+}
+
+/**
+ * UUID4 generator
+ *
+ * @returns string Generated UUID4.
+ */
+export function uuid4(): string {
+  const global = getGlobalObject() as MsCryptoWindow;
+  const crypto = global.crypto || global.msCrypto;
+
+  if (!(crypto === void 0) && crypto.getRandomValues) {
+    // Use window.crypto API if available
+    const arr = new Uint16Array(8);
+    crypto.getRandomValues(arr);
+
+    // set 4 in byte 7
+    // tslint:disable-next-line:no-bitwise
+    arr[3] = (arr[3] & 0xfff) | 0x4000;
+    // set 2 most significant bits of byte 9 to '10'
+    // tslint:disable-next-line:no-bitwise
+    arr[4] = (arr[4] & 0x3fff) | 0x8000;
+
+    const pad = (num: number): string => {
+      let v = num.toString(16);
+      while (v.length < 4) {
+        v = `0${v}`;
+      }
+      return v;
+    };
+
+    return (
+      pad(arr[0]) +
+      pad(arr[1]) +
+      pad(arr[2]) +
+      pad(arr[3]) +
+      pad(arr[4]) +
+      pad(arr[5]) +
+      pad(arr[6]) +
+      pad(arr[7])
+    );
+  } else {
+    // http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#2117523
+    return 'xxxxxxxxxxxx4xxxyxxxxxxxxxxxxxxx'.replace(/[xy]/g, c => {
+      // tslint:disable-next-line:no-bitwise
+      const r = (Math.random() * 16) | 0;
+      // tslint:disable-next-line:no-bitwise
+      const v = c === 'x' ? r : (r & 0x3) | 0x8;
+      return v.toString(16);
+    });
+  }
+}

packages/utils/src/string.ts

@@ -1,5 +1,3 @@
-import { getGlobalObject } from './misc';
-
 /**
  * Encodes given object into url-friendly format
  *
@@ -14,61 +12,3 @@ export function truncate(str: string, max: number): string {
   }
   return str.length <= max ? str : `${str.substr(0, max)}\u2026`;
 }
-
-/**
- * Extended Window interface that allows for Crypto API usage in IE browsers
- */
-interface MsCryptoWindow extends Window {
-  msCrypto?: Crypto;
-}
-
-/**
- * UUID4 generator
- *
- * @returns string Generated UUID4.
- */
-export function uuid4(): string {
-  const global = getGlobalObject() as MsCryptoWindow;
-  const crypto = global.crypto || global.msCrypto;
-
-  if (!(crypto === void 0) && crypto.getRandomValues) {
-    // Use window.crypto API if available
-    const arr = new Uint16Array(8);
-    crypto.getRandomValues(arr);
-
-    // set 4 in byte 7
-    // tslint:disable-next-line:no-bitwise
-    arr[3] = (arr[3] & 0xfff) | 0x4000;
-    // set 2 most significant bits of byte 9 to '10'
-    // tslint:disable-next-line:no-bitwise
-    arr[4] = (arr[4] & 0x3fff) | 0x8000;
-
-    const pad = (num: number): string => {
-      let v = num.toString(16);
-      while (v.length < 4) {
-        v = `0${v}`;
-      }
-      return v;
-    };
-
-    return (
-      pad(arr[0]) +
-      pad(arr[1]) +
-      pad(arr[2]) +
-      pad(arr[3]) +
-      pad(arr[4]) +
-      pad(arr[5]) +
-      pad(arr[6]) +
-      pad(arr[7])
-    );
-  } else {
-    // http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#2117523
-    return 'xxxxxxxxxxxx4xxxyxxxxxxxxxxxxxxx'.replace(/[xy]/g, c => {
-      // tslint:disable-next-line:no-bitwise
-      const r = (Math.random() * 16) | 0;
-      // tslint:disable-next-line:no-bitwise
-      const v = c === 'x' ? r : (r & 0x3) | 0x8;
-      return v.toString(16);
-    });
-  }
-}