feat(utils): Add parameterize function

packages/browser/src/eventbuilder.ts

@@ -265,13 +265,11 @@ export function eventFromUnknownInput(
  */
 export function eventFromString(
   stackParser: StackParser,
-  input: string,
+  input: string & { __sentry_template_string__?: string; __sentry_template_values__?: string[] },
   syntheticException?: Error,
   attachStacktrace?: boolean,
 ): Event {
-  const event: Event = {
-    message: input,
-  };
+  const event: Event = {};
 
   if (attachStacktrace && syntheticException) {
     const frames = parseStackFrames(stackParser, syntheticException);
@@ -282,6 +280,17 @@ export function eventFromString(
     }
   }
 
+  const { __sentry_template_string__, __sentry_template_values__ } = input;
+
+  if (__sentry_template_string__ && __sentry_template_values__) {
+    event.logentry = {
+      message: __sentry_template_string__,
+      params: __sentry_template_values__,
+    };
+    return event;
+  }
+
+  event.message = input;
   return event;
 }
 

packages/types/src/event.ts

@@ -19,6 +19,10 @@ import type { User } from './user';
 export interface Event {
   event_id?: string;
   message?: string;
+  logentry?: {
+    message?: string;
+    params?: string[];
+  };
   timestamp?: number;
   start_timestamp?: number;
   // eslint-disable-next-line deprecation/deprecation

packages/utils/src/eventbuilder.ts

@@ -119,7 +119,7 @@ export function eventFromUnknownInput(
  */
 export function eventFromMessage(
   stackParser: StackParser,
-  message: string,
+  input: string & { __sentry_template_string__?: string; __sentry_template_values__?: string[] },
   // eslint-disable-next-line deprecation/deprecation
   level: Severity | SeverityLevel = 'info',
   hint?: EventHint,
@@ -128,7 +128,6 @@ export function eventFromMessage(
   const event: Event = {
     event_id: hint && hint.event_id,
     level,
-    message,
   };
 
   if (attachStacktrace && hint && hint.syntheticException) {
@@ -137,13 +136,24 @@ export function eventFromMessage(
       event.exception = {
         values: [
           {
-            value: message,
+            value: input,
             stacktrace: { frames },
           },
         ],
       };
     }
   }
 
+  const { __sentry_template_string__, __sentry_template_values__ } = input;
+
+  if (__sentry_template_string__ && __sentry_template_values__) {
+    event.logentry = {
+      message: __sentry_template_string__,
+      params: __sentry_template_values__,
+    };
+    return event;
+  }
+
+  event.message = input;
   return event;
 }

packages/utils/src/index.ts

@@ -31,4 +31,5 @@ export * from './url';
 export * from './userIntegrations';
 export * from './cache';
 export * from './eventbuilder';
+export * from './parametrize';
 export * from './anr';

packages/utils/src/parametrize.ts

@@ -0,0 +1,20 @@
+export interface ParamerizedString extends String {
+  __sentry_template_string__: string;
+  __sentry_template_values__: string[];
+}
+
+/**
+ * Tagged template function which returns paramaterized representation of the message
+ * For example: parametrize`This is a log statement with ${x} and ${y} params`, would return:
+ * "__sentry_template_string__": "My raw message with interpreted strings like %s",
+ * "__sentry_template_values__": ["this"]
+ * @param strings An array of string values splitted between expressions
+ * @param values Expressions extracted from template string
+ * @returns String with template information in __sentry_template_string__ and __sentry_template_values__ properties
+ */
+export function parametrize(strings: TemplateStringsArray, ...values: string[]): ParamerizedString {
+  const formatted = new String(String.raw(strings, ...values)) as ParamerizedString;
+  formatted.__sentry_template_string__ = strings.join('\x00').replace(/%/g, '%%').replace(/\0/g, '%s');
+  formatted.__sentry_template_values__ = values;
+  return formatted;
+}

packages/utils/test/parametrize.test.ts

@@ -0,0 +1,26 @@
+import type { ParamerizedString } from '../src/parametrize';
+import { parametrize } from '../src/parametrize';
+
+describe('parametrize()', () => {
+  test('works with empty string', () => {
+    const string = new String() as ParamerizedString;
+    string.__sentry_template_string__ = '';
+    string.__sentry_template_values__ = [];
+
+    const formatted = parametrize``;
+    expect(formatted.__sentry_template_string__).toEqual('');
+    expect(formatted.__sentry_template_values__).toEqual([]);
+  });
+
+  test('works as expected with template literals', () => {
+    const x = 'first';
+    const y = 'second';
+    const string = new String() as ParamerizedString;
+    string.__sentry_template_string__ = 'This is a log statement with %s and %s params';
+    string.__sentry_template_values__ = ['first', 'second'];
+
+    const formatted = parametrize`This is a log statement with ${x} and ${y} params`;
+    expect(formatted.__sentry_template_string__).toEqual(string.__sentry_template_string__);
+    expect(formatted.__sentry_template_values__).toEqual(string.__sentry_template_values__);
+  });
+});