ref: Make sure that captureMessage input is a primitive (#1825)

Author: kamilogorek

CHANGELOG.md

@@ -10,6 +10,7 @@
   `7` lines pre/post
 - [core]: ref: Change way how transports are initialized
 - [core]: ref: Rename `RequestBuffer` to `PromiseBuffer`, also introduce limit
+- [core]: ref: Make sure that captureMessage input is a primitive
 - [browser] fix: Prevent empty exception values
 
 ## 4.4.2

packages/core/src/baseclient.ts

@@ -11,6 +11,7 @@ import {
   Status,
 } from '@sentry/types';
 import { forget } from '@sentry/utils/async';
+import { isPrimitive } from '@sentry/utils/is';
 import { logger } from '@sentry/utils/logger';
 import { consoleSandbox, uuid4 } from '@sentry/utils/misc';
 import { truncate } from '@sentry/utils/string';
@@ -155,7 +156,10 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
   ): Promise<SentryResponse> {
     return this.buffer.add(
       (async () => {
-        const event = await this.getBackend().eventFromMessage(message, level, hint);
+        const event = isPrimitive(message)
+          ? await this.getBackend().eventFromMessage(`${message}`, level, hint)
+          : await this.getBackend().eventFromException(message, hint);
+
         return this.captureEvent(event, hint, scope);
       })(),
     );

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

@@ -191,6 +191,23 @@ describe('BaseClient', () => {
         message: 'test message',
       });
     });
+
+    test.only('should call eventFromException if input to captureMessage is not a primitive', async () => {
+      const client = new TestClient({ dsn: PUBLIC_DSN });
+      const scope = new Scope();
+      const spy = jest.spyOn(TestBackend.instance!, 'eventFromException');
+
+      await client.captureMessage('foo', undefined, undefined, scope);
+      await client.captureMessage(null, undefined, undefined, scope);
+      await client.captureMessage(undefined, undefined, undefined, scope);
+      await client.captureMessage(1, undefined, undefined, scope);
+      await client.captureMessage(false, undefined, undefined, scope);
+      expect(spy.mock.calls.length).toEqual(0);
+
+      await client.captureMessage({}, undefined, undefined, scope);
+      await client.captureMessage([], undefined, undefined, scope);
+      expect(spy.mock.calls.length).toEqual(2);
+    });
   });
 
   describe('captureEvent() / prepareEvent()', () => {

packages/utils/src/is.ts

@@ -84,6 +84,17 @@ export function isString(wat: any): boolean {
   return Object.prototype.toString.call(wat) === '[object String]';
 }
 
+/**
+ * Checks whether given value's is a primitive (undefined, null, number, boolean, string)
+ * {@link isPrimitive}.
+ *
+ * @param wat A value to be checked.
+ * @returns A boolean representing the result.
+ */
+export function isPrimitive(wat: any): boolean {
+  return wat === null || (typeof wat !== 'object' && typeof wat !== 'function');
+}
+
 /**
  * Checks whether given value's type is an array
  * {@link isArray}.

packages/utils/test/is.test.ts

@@ -1,4 +1,4 @@
-import { isDOMError, isDOMException, isError, isErrorEvent } from '../src/is';
+import { isDOMError, isDOMException, isError, isErrorEvent, isPrimitive } from '../src/is';
 import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../src/supports';
 
 class SentryError extends Error {
@@ -56,3 +56,18 @@ if (supportsErrorEvent()) {
     });
   });
 }
+
+describe('isPrimitive()', () => {
+  test('should work as advertised', () => {
+    expect(isPrimitive(undefined)).toEqual(true);
+    expect(isPrimitive(null)).toEqual(true);
+    expect(isPrimitive(true)).toEqual(true);
+    expect(isPrimitive('foo')).toEqual(true);
+    expect(isPrimitive(42)).toEqual(true);
+
+    expect(isPrimitive({})).toEqual(false);
+    expect(isPrimitive([])).toEqual(false);
+    expect(isPrimitive(new Error('foo'))).toEqual(false);
+    expect(isPrimitive(new Date())).toEqual(false);
+  });
+});