feat: Make parameterize function available through browser and node…

… API (#10085)

Move `parameterize` function to core, export it to upstream packages via browser and node.

dev-packages/browser-integration-tests/suites/public-api/captureMessage/parameterized_message/subject.js

@@ -1,6 +1,4 @@
-import { parameterize } from '@sentry/utils';
-
 const x = 'first';
 const y = 'second';
 
-Sentry.captureMessage(parameterize`This is a log statement with ${x} and ${y} params`);
+Sentry.captureMessage(Sentry.parameterize`This is a log statement with ${x} and ${y} params`);

dev-packages/browser-integration-tests/suites/public-api/captureMessage/parameterized_message/test.ts

@@ -5,12 +5,6 @@ import { sentryTest } from '../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';
 
 sentryTest('should capture a parameterized representation of the message', async ({ getLocalTestPath, page }) => {
-  const bundle = process.env.PW_BUNDLE;
-
-  if (bundle && bundle.startsWith('bundle_')) {
-    sentryTest.skip();
-  }
-
   const url = await getLocalTestPath({ testDir: __dirname });
 
   const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

dev-packages/node-integration-tests/suites/public-api/captureMessage/parameterized_message/scenario.ts

@@ -1,5 +1,4 @@
 import * as Sentry from '@sentry/node';
-import { parameterize } from '@sentry/utils';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
@@ -9,4 +8,4 @@ Sentry.init({
 const x = 'first';
 const y = 'second';
 
-Sentry.captureMessage(parameterize`This is a log statement with ${x} and ${y} params`);
+Sentry.captureMessage(Sentry.parameterize`This is a log statement with ${x} and ${y} params`);

packages/astro/src/index.server.ts

@@ -77,6 +77,7 @@ export {
   startSpanManual,
   continueTrace,
   cron,
+  parameterize,
 } from '@sentry/node';
 
 // We can still leave this for the carrier init and type exports

packages/browser/src/exports.ts

@@ -72,6 +72,7 @@ export {
   metrics,
   functionToStringIntegration,
   inboundFiltersIntegration,
+  parameterize,
 } from '@sentry/core';
 
 export { WINDOW } from './helpers';

packages/bun/src/index.ts

@@ -83,6 +83,7 @@ export {
   inboundFiltersIntegration,
   linkedErrorsIntegration,
   requestDataIntegration,
+  parameterize,
 } from '@sentry/core';
 export type { SpanStatusType } from '@sentry/core';
 export { autoDiscoverNodePerformanceMonitoringIntegrations, cron } from '@sentry/node';

packages/core/src/index.ts

@@ -80,6 +80,7 @@ export { createCheckInEnvelope } from './checkin';
 export { hasTracingEnabled } from './utils/hasTracingEnabled';
 export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
 export { handleCallbackErrors } from './utils/handleCallbackErrors';
+export { parameterize } from './utils/parameterize';
 export {
   spanToTraceHeader,
   spanToJSON,

packages/utils/src/parameterize.ts → packages/core/src/utils/parameterize.ts

@@ -3,8 +3,8 @@ import type { ParameterizedString } from '@sentry/types';
 /**
  * Tagged template function which returns paramaterized representation of the message
  * For example: parameterize`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"]
+ * "__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

packages/utils/test/parameterize.test.ts → packages/core/test/lib/utils/parameterize.test.ts

@@ -1,6 +1,6 @@
 import type { ParameterizedString } from '@sentry/types';
 
-import { parameterize } from '../src/parameterize';
+import { parameterize } from '../../../src/utils/parameterize';
 
 describe('parameterize()', () => {
   test('works with empty string', () => {

packages/node/src/index.ts

@@ -79,6 +79,7 @@ export {
   startInactiveSpan,
   startSpanManual,
   continueTrace,
+  parameterize,
   metrics,
   functionToStringIntegration,
   inboundFiltersIntegration,

packages/remix/src/index.server.ts

@@ -68,6 +68,7 @@ export {
   Integrations,
   Handlers,
   cron,
+  parameterize,
 } from '@sentry/node';
 
 // Keeping the `*` exports for backwards compatibility and types

packages/serverless/src/index.ts

@@ -76,4 +76,5 @@ export {
   startInactiveSpan,
   startSpanManual,
   continueTrace,
+  parameterize,
 } from '@sentry/node';

packages/sveltekit/src/server/index.ts

@@ -74,6 +74,7 @@ export {
   startSpanManual,
   continueTrace,
   cron,
+  parameterize,
 } from '@sentry/node';
 
 // We can still leave this for the carrier init and type exports

packages/utils/src/index.ts

@@ -32,7 +32,6 @@ export * from './url';
 export * from './userIntegrations';
 export * from './cache';
 export * from './eventbuilder';
-export * from './parameterize';
 export * from './anr';
 export * from './lru';
 export * from './buildPolyfills';