fix: ParamaterizeString typing to allow more than string values

Author: AbhiPrasad

packages/core/src/exports.ts

@@ -12,6 +12,7 @@ import type {
   Extras,
   FinishedCheckIn,
   MonitorConfig,
+  ParameterizedString,
   Primitive,
   Session,
   SessionContext,
@@ -23,7 +24,7 @@ import { logger } from './utils-hoist/logger';
 import { uuid4 } from './utils-hoist/misc';
 import { timestampInSeconds } from './utils-hoist/time';
 import { GLOBAL_OBJ } from './utils-hoist/worldwide';
-import { parameterize } from './utils/parameterize';
+import { parameterizeStringTemplate } from './utils/parameterize';
 import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
 import { parseEventHintOrCaptureContext } from './utils/prepareEvent';
 
@@ -436,7 +437,7 @@ export const _experiment_log = {
    * Sentry._experiment_log.fmt`This is a log statement with ${x} and ${y} params`
    * ```
    */
-  fmt: parameterize,
+  fmt: parameterizeStringTemplate,
 
   /**
    * A flexible utility to record a log with a custom level and send it to sentry.

packages/core/src/log.ts

@@ -114,8 +114,8 @@ function addToLogBuffer(client: Client, log: Log, scope: Scope): void {
 export function sendLog(
   level: LogSeverityLevel,
   severityNumber?: number,
-): (message: ParameterizedString | string, customAttributes?: Record<string, unknown>) => void {
-  return (message: ParameterizedString | string, attributes: Record<string, unknown> = {}): void =>
+): (message: ParameterizedString<unknown[]> | string, customAttributes?: Record<string, unknown>) => void {
+  return (message: ParameterizedString<unknown[]> | string, attributes: Record<string, unknown> = {}): void =>
     captureLog({ level, message, attributes, severityNumber });
 }
 
@@ -129,7 +129,7 @@ export function captureLog({
   severityNumber,
 }: {
   level: LogSeverityLevel;
-  message: ParameterizedString | string;
+  message: ParameterizedString<unknown[]> | string;
   attributes?: Record<string, unknown>;
   severityNumber?: number;
 }): void {

packages/core/src/types-hoist/parameterize.ts

@@ -1,4 +1,4 @@
-export type ParameterizedString = string & {
+export type ParameterizedString<Values = string[]> = string & {
   __sentry_template_string__?: string;
-  __sentry_template_values__?: string[];
+  __sentry_template_values__?: Values;
 };

packages/core/src/utils/parameterize.ts

@@ -15,3 +15,22 @@ export function parameterize(strings: TemplateStringsArray, ...values: string[])
   formatted.__sentry_template_values__ = values;
   return formatted;
 }
+
+/**
+ * Tagged template function which returns parameterized representation of the message
+ * For example: parameterize`This is a log statement with ${x} and ${y} params`, would return:
+ * "__sentry_template_string__": 'This is a log statement with %s and %s params',
+ * "__sentry_template_values__": ['first', 'second']
+ * @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 parameterizeStringTemplate(
+  strings: TemplateStringsArray,
+  ...values: unknown[]
+): ParameterizedString<unknown[]> {
+  const formatted = new String(String.raw(strings, ...values)) as ParameterizedString<unknown[]>;
+  formatted.__sentry_template_string__ = strings.join('\x00').replace(/%/g, '%%').replace(/\0/g, '%s');
+  formatted.__sentry_template_values__ = values;
+  return formatted;
+}