Improve tests

Author: timfish

packages/core/test/lib/hint.test.ts

@@ -1,7 +1,8 @@
 import { getDefaultTestClientOptions, TestClient } from '../mocks/client';
 import { AddAttachmentTestIntegration } from '../mocks/integration';
 import { initAndBind } from '../../src/sdk';
-import { captureEvent } from '@sentry/hub';
+import { captureEvent, configureScope } from '@sentry/hub';
+import { getGlobalObject } from '@sentry/utils';
 
 const PUBLIC_DSN = 'https://username@domain/123';
 const sendEvent = jest.spyOn(TestClient.prototype, 'sendEvent');
@@ -14,73 +15,87 @@ describe('Hint', () => {
 
   afterEach(() => {
     jest.clearAllMocks();
+    delete getGlobalObject().__SENTRY__;
   });
 
-  test('can be mutated in beforeSend', () => {
-    expect.assertions(1);
+  describe('attachments', () => {
+    test('can be mutated in beforeSend', () => {
+      expect.assertions(1);
 
-    const options = getDefaultTestClientOptions({
-      dsn: PUBLIC_DSN,
-      beforeSend: (event, hint) => {
-        if (hint) {
-          hint.attachments = [...(hint?.attachments || []), { filename: 'another.file', data: 'more text' }];
-        }
+      const options = getDefaultTestClientOptions({
+        dsn: PUBLIC_DSN,
+        beforeSend: (event, hint) => {
+          if (hint) {
+            hint.attachments = [...(hint?.attachments || []), { filename: 'another.file', data: 'more text' }];
+          }
 
-        return event;
-      },
-    });
-
-    const client = new TestClient(options);
-    client.captureEvent({});
+          return event;
+        },
+      });
 
-    const [, hint] = sendEvent.mock.calls[0];
+      const client = new TestClient(options);
+      client.captureEvent({});
 
-    expect(hint).toEqual({
-      attachments: [{ filename: 'another.file', data: 'more text' }],
+      const [, hint] = sendEvent.mock.calls[0];
+      expect(hint).toEqual({ attachments: [{ filename: 'another.file', data: 'more text' }] });
     });
-  });
 
-  test('gets passed through to beforeSend and can be further mutated', () => {
-    expect.assertions(1);
-
-    const options = getDefaultTestClientOptions({
-      dsn: PUBLIC_DSN,
-      beforeSend: (event, hint) => {
-        if (hint) {
-          hint.attachments = [...(hint?.attachments || []), { filename: 'another.file', data: 'more text' }];
-        }
-
-        return event;
-      },
+    test('gets passed through to beforeSend and can be further mutated', () => {
+      expect.assertions(1);
+
+      const options = getDefaultTestClientOptions({
+        dsn: PUBLIC_DSN,
+        beforeSend: (event, hint) => {
+          if (hint) {
+            hint.attachments = [...(hint?.attachments || []), { filename: 'another.file', data: 'more text' }];
+          }
+
+          return event;
+        },
+      });
+
+      const client = new TestClient(options);
+      client.captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });
+
+      const [, hint] = sendEvent.mock.calls[0];
+      expect(hint).toEqual({
+        attachments: [
+          { filename: 'some-file.txt', data: 'Hello' },
+          { filename: 'another.file', data: 'more text' },
+        ],
+      });
     });
 
-    const client = new TestClient(options);
-    client.captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });
-
-    const [, hint] = sendEvent.mock.calls[0];
+    test('can be mutated by an integration via event processor', () => {
+      expect.assertions(1);
 
-    expect(hint).toEqual({
-      attachments: [
-        { filename: 'some-file.txt', data: 'Hello' },
-        { filename: 'another.file', data: 'more text' },
-      ],
-    });
-  });
+      const options = getDefaultTestClientOptions({
+        dsn: PUBLIC_DSN,
+        integrations: [new AddAttachmentTestIntegration()],
+      });
 
-  test('can be mutated by an integration via event processor', () => {
-    expect.assertions(1);
+      initAndBind(TestClient, options);
+      captureEvent({});
 
-    const options = getDefaultTestClientOptions({
-      dsn: PUBLIC_DSN,
-      integrations: [new AddAttachmentTestIntegration()],
+      const [, hint] = sendEvent.mock.calls[0];
+      expect(hint?.attachments).toEqual([{ filename: 'integration.file', data: 'great content!' }]);
     });
 
-    initAndBind(TestClient, options);
+    test('get copied from scope to hint', () => {
+      expect.assertions(1);
 
-    captureEvent({});
+      const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
+      initAndBind(TestClient, options);
 
-    const [, hint] = sendEvent.mock.calls[0];
+      configureScope(scope => scope.addAttachment({ filename: 'scope.file', data: 'great content!' }));
 
-    expect(hint?.attachments).toEqual([{ filename: 'integration.file', data: 'great content!' }]);
+      captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });
+
+      const [, hint] = sendEvent.mock.calls[0];
+      expect(hint?.attachments).toEqual([
+        { filename: 'some-file.txt', data: 'Hello' },
+        { filename: 'scope.file', data: 'great content!' },
+      ]);
+    });
   });
 });