Added parametrize function

Author: AleshaOleg

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__);
+  });
+});