Improve tests

Author: timfish

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

@@ -1,86 +1,102 @@
-import { getDefaultTestClientOptions, TestClient } from '../mocks/client';
-import { AddAttachmentTestIntegration } from '../mocks/integration';
-import { initAndBind } from '../../src/sdk';
-import { captureEvent } from '@sentry/hub';
-
-const PUBLIC_DSN = 'https://username@domain/123';
-const sendEvent = jest.spyOn(TestClient.prototype, 'sendEvent');
-
-describe('Hint', () => {
-  beforeEach(() => {
-    TestClient.sendEventCalled = undefined;
-    TestClient.instance = undefined;
-  });
-
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  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' }];
-        }
-
-        return event;
-      },
-    });
-
-    const client = new TestClient(options);
-    client.captureEvent({});
-
-    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;
-      },
-    });
-
-    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' },
-      ],
-    });
-  });
-
-  test('can be mutated by an integration via event processor', () => {
-    expect.assertions(1);
-
-    const options = getDefaultTestClientOptions({
-      dsn: PUBLIC_DSN,
-      integrations: [new AddAttachmentTestIntegration()],
-    });
-
-    initAndBind(TestClient, options);
-
-    captureEvent({});
-
-    const [, hint] = sendEvent.mock.calls[0];
-
-    expect(hint?.attachments).toEqual([{ filename: 'integration.file', data: 'great content!' }]);
-  });
-});
+import { captureEvent, configureScope } from '@sentry/hub';
+import { getGlobalObject } from '@sentry/utils';
+
+import { initAndBind } from '../../src/sdk';
+import { getDefaultTestClientOptions, TestClient } from '../mocks/client';
+import { AddAttachmentTestIntegration } from '../mocks/integration';
+
+const PUBLIC_DSN = 'https://username@domain/123';
+const sendEvent = jest.spyOn(TestClient.prototype, 'sendEvent');
+
+describe('Hint', () => {
+  beforeEach(() => {
+    TestClient.sendEventCalled = undefined;
+    TestClient.instance = undefined;
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+    delete getGlobalObject().__SENTRY__;
+  });
+
+  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' }];
+          }
+
+          return event;
+        },
+      });
+
+      const client = new TestClient(options);
+      client.captureEvent({});
+
+      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;
+        },
+      });
+
+      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' },
+        ],
+      });
+    });
+
+    test('can be mutated by an integration via event processor', () => {
+      expect.assertions(1);
+
+      const options = getDefaultTestClientOptions({
+        dsn: PUBLIC_DSN,
+        integrations: [new AddAttachmentTestIntegration()],
+      });
+
+      initAndBind(TestClient, options);
+      captureEvent({});
+
+      const [, hint] = sendEvent.mock.calls[0];
+      expect(hint?.attachments).toEqual([{ filename: 'integration.file', data: 'great content!' }]);
+    });
+
+    test('get copied from scope to hint', () => {
+      expect.assertions(1);
+
+      const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
+      initAndBind(TestClient, options);
+
+      configureScope(scope => scope.addAttachment({ filename: 'scope.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!' },
+      ]);
+    });
+  });
+});

packages/serverless/src/awslambda.ts

@@ -79,7 +79,7 @@ export function init(options: Sentry.NodeOptions = {}): void {
     version: Sentry.SDK_VERSION,
   };
 
-  options.dsn = extensionRelayDSN(options.dsn)
+  options.dsn = extensionRelayDSN(options.dsn);
 
   Sentry.init(options);
   Sentry.addGlobalEventProcessor(serverlessEventProcessor);

packages/utils/src/dsn.ts

@@ -108,7 +108,6 @@ export function makeDsn(from: DsnLike): DsnComponents {
   return components;
 }
 
-
 /**
  * Changes a Dsn to point to the `relay` server running in the Lambda Extension.
  *