feat(core): Deprecate validSeverityLevels

Author: Luca Forstner

packages/core/src/api.ts

@@ -1,6 +1,5 @@
 import type { DsnComponents, DsnLike, SdkInfo } from '@sentry/types';
 import { dsnToString, makeDsn } from './utils-hoist/dsn';
-import { urlEncode } from './utils-hoist/object';
 
 const SENTRY_API_VERSION = '7';
 
@@ -18,13 +17,21 @@ function _getIngestEndpoint(dsn: DsnComponents): string {
 
 /** Returns a URL-encoded string with auth config suitable for a query string. */
 function _encodedAuth(dsn: DsnComponents, sdkInfo: SdkInfo | undefined): string {
-  return urlEncode({
+  const params: Record<string, string> = {
+    sentry_version: SENTRY_API_VERSION,
+  };
+
+  if (dsn.publicKey) {
     // We send only the minimum set of required information. See
     // https://github.com/getsentry/sentry-javascript/issues/2572.
-    sentry_key: dsn.publicKey,
-    sentry_version: SENTRY_API_VERSION,
-    ...(sdkInfo && { sentry_client: `${sdkInfo.name}/${sdkInfo.version}` }),
-  });
+    params.sentry_key = dsn.publicKey;
+  }
+
+  if (sdkInfo) {
+    params.sentry_client = `${sdkInfo.name}/${sdkInfo.version}`;
+  }
+
+  return new URLSearchParams(params).toString();
 }
 
 /**

packages/core/src/utils-hoist/index.ts

@@ -83,6 +83,7 @@ export type {
   TransactionNamingScheme,
 } from './requestdata';
 
+// eslint-disable-next-line deprecation/deprecation
 export { severityLevelFromString, validSeverityLevels } from './severity';
 export {
   UNKNOWN_FUNCTION,

packages/core/src/utils-hoist/severity.ts

@@ -1,15 +1,8 @@
 import type { SeverityLevel } from '@sentry/types';
 
-// Note: Ideally the `SeverityLevel` type would be derived from `validSeverityLevels`, but that would mean either
-//
-// a) moving `validSeverityLevels` to `@sentry/types`,
-// b) moving the`SeverityLevel` type here, or
-// c) importing `validSeverityLevels` from here into `@sentry/types`.
-//
-// Option A would make `@sentry/types` a runtime dependency of `@sentry/core` (not good), and options B and C would
-// create a circular dependency between `@sentry/types` and `@sentry/core` (also not good). So a TODO accompanying the
-// type, reminding anyone who changes it to change this list also, will have to do.
-
+/**
+ * @deprecated This variable has been deprecated and will be removed in the next major version.
+ */
 export const validSeverityLevels = ['fatal', 'error', 'warning', 'log', 'info', 'debug'];
 
 /**
@@ -19,5 +12,7 @@ export const validSeverityLevels = ['fatal', 'error', 'warning', 'log', 'info',
  * @returns The `SeverityLevel` corresponding to the given string, or 'log' if the string isn't a valid level.
  */
 export function severityLevelFromString(level: SeverityLevel | string): SeverityLevel {
-  return (level === 'warn' ? 'warning' : validSeverityLevels.includes(level) ? level : 'log') as SeverityLevel;
+  return (
+    level === 'warn' ? 'warning' : ['fatal', 'error', 'warning', 'log', 'info', 'debug'].includes(level) ? level : 'log'
+  ) as SeverityLevel;
 }

packages/core/test/utils-hoist/severity.test.ts

@@ -1,4 +1,4 @@
-import { severityLevelFromString, validSeverityLevels } from '../../src/utils-hoist/severity';
+import { severityLevelFromString } from '../../src/utils-hoist/severity';
 
 describe('severityLevelFromString()', () => {
   test("converts 'warn' to 'warning'", () => {
@@ -10,7 +10,7 @@ describe('severityLevelFromString()', () => {
   });
 
   test('acts as a pass-through for valid level strings', () => {
-    for (const level of validSeverityLevels) {
+    for (const level of ['fatal', 'error', 'warning', 'log', 'info', 'debug']) {
       expect(severityLevelFromString(level)).toBe(level);
     }
   });

packages/types/src/severity.ts

@@ -1,3 +1 @@
-// Note: If this is ever changed, the `validSeverityLevels` array in `@sentry/core` needs to be changed, also. (See
-// note there for why we can't derive one from the other.)
 export type SeverityLevel = 'fatal' | 'error' | 'warning' | 'log' | 'info' | 'debug';