cleanup types, reduce bundle size a bit

Author: Lms24

packages/core/src/carrier.ts

@@ -1,4 +1,4 @@
-import type { Integration, Scope, VersionString } from '@sentry/types';
+import type { Client, Integration, MetricsAggregator, Scope, VersionString } from '@sentry/types';
 import { GLOBAL_OBJ } from '@sentry/utils';
 import { SDK_VERSION } from '@sentry/utils';
 import type { AsyncContextStack } from './asyncContext/stackStrategy';
@@ -19,20 +19,19 @@ type VersionedCarrier = {
 
 interface SentryCarrier {
   acs?: AsyncContextStrategy;
-  /**
-   * Extra Hub properties injected by various SDKs
-   */
-  integrations?: Integration[];
-  extensions?: {
-    /** Extension methods for the hub, which are bound to the current Hub instance */
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    [key: string]: Function;
-  };
   stack?: AsyncContextStack;
 
   globalScope?: Scope;
   defaultIsolationScope?: Scope;
   defaultCurrentScope?: Scope;
+  globalMetricsAggregators?: WeakMap<Client, MetricsAggregator> | undefined;
+
+  // TODO(v9): Remove these properties - they are no longer used and were left over in v8
+  integrations?: Integration[];
+  extensions?: {
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    [key: string]: Function;
+  };
 }
 
 /**
@@ -50,21 +49,12 @@ export function getMainCarrier(): Carrier {
 
 /** Will either get the existing sentry carrier, or create a new one. */
 export function getSentryCarrier(carrier: Carrier): SentryCarrier {
-  if (!carrier.__SENTRY__) {
-    carrier.__SENTRY__ = {};
-  }
+  const __SENTRY__ = (carrier.__SENTRY__ = carrier.__SENTRY__ || {});
 
   // For now: First SDK that sets the .version property wins
-  if (!carrier.__SENTRY__.version) {
-    carrier.__SENTRY__.version = SDK_VERSION;
-  }
+  __SENTRY__.version = __SENTRY__.version || SDK_VERSION;
 
   // Intentionally populating and returning the version of "this" SDK instance
   // rather than what's set in .version so that "this" SDK always gets its carrier
-  if (!carrier.__SENTRY__[SDK_VERSION]) {
-    carrier.__SENTRY__[SDK_VERSION] = {
-      extensions: {},
-    };
-  }
-  return carrier.__SENTRY__[SDK_VERSION];
+  return (__SENTRY__[SDK_VERSION] = __SENTRY__[SDK_VERSION] || {});
 }

packages/core/test/lib/carrier.test.ts

@@ -1,22 +1,18 @@
+import { SDK_VERSION } from '@sentry/utils';
 import { getSentryCarrier } from '../../src/carrier';
-import { SDK_VERSION } from '../../src/version';
 
 describe('getSentryCarrier', () => {
   describe('base case (one SDK)', () => {
     it('populates the default sentry carrier object if it does not exist', () => {
       const globalObject = {};
       const sentryCarrier = getSentryCarrier(globalObject);
 
-      expect(sentryCarrier).toEqual({
-        extensions: {},
-      });
+      expect(sentryCarrier).toEqual({});
 
       expect(globalObject).toEqual({
         __SENTRY__: {
           version: SDK_VERSION,
-          [SDK_VERSION]: {
-            extensions: {},
-          },
+          [SDK_VERSION]: {},
         },
       });
     });
@@ -71,26 +67,23 @@ describe('getSentryCarrier', () => {
           version: '8.0.0' as const,
           '8.0.0': {
             // and this object
-            integrations: [() => {}],
+            acs: {},
           },
         },
       };
 
+      // @ts-expect-error - this is just a test object, no need to pass a hub
       const sentryCarrier = getSentryCarrier(globalObject);
 
-      expect(sentryCarrier).toEqual({
-        extensions: {},
-      });
+      expect(sentryCarrier).toEqual({});
 
       expect(globalObject).toEqual({
         __SENTRY__: {
           version: '8.0.0',
           '8.0.0': {
-            integrations: [expect.any(Function)],
-          },
-          [SDK_VERSION]: {
-            extensions: {},
+            acs: {},
           },
+          [SDK_VERSION]: {},
         },
       });
     });

packages/utils/src/worldwide.ts

@@ -17,10 +17,23 @@ import type { Client, MetricsAggregator, Scope, VersionString } from '@sentry/ty
 import type { SdkSource } from './env';
 import { SDK_VERSION } from './version';
 
-type BackwardsCompatibleSentryCarrier = {
-  // v8 scope stack (replaces .hub)
-  stack?: any;
+interface SentryCarrier {
   acs?: any;
+  stack?: any;
+
+  globalScope?: Scope;
+  defaultIsolationScope?: Scope;
+  defaultCurrentScope?: Scope;
+  globalMetricsAggregators: WeakMap<Client, MetricsAggregator> | undefined;
+
+  /** Overwrites TextEncoder used in `@sentry/utils`, need for `[email protected]` and older */
+  encodePolyfill?: (input: string) => Uint8Array;
+  /** Overwrites TextDecoder used in `@sentry/utils`, need for `[email protected]` and older */
+  decodePolyfill?: (input: Uint8Array) => string;
+}
+
+// TODO(v9): Clean up or remove this type
+type BackwardsCompatibleSentryCarrier = SentryCarrier & {
   // pre-v7 hub (replaced by .stack)
   hub: any;
   integrations?: any[];
@@ -30,14 +43,6 @@ type BackwardsCompatibleSentryCarrier = {
     // eslint-disable-next-line @typescript-eslint/ban-types
     [key: string]: Function;
   };
-  globalScope: Scope | undefined;
-  defaultCurrentScope: Scope | undefined;
-  defaultIsolationScope: Scope | undefined;
-  globalMetricsAggregators: WeakMap<Client, MetricsAggregator> | undefined;
-  /** Overwrites TextEncoder used in `@sentry/utils`, need for `[email protected]` and older */
-  encodePolyfill?: (input: string) => Uint8Array;
-  /** Overwrites TextDecoder used in `@sentry/utils`, need for `[email protected]` and older */
-  decodePolyfill?: (input: Uint8Array) => string;
 };
 
 /** Internal global with common properties and Sentry extensions  */
@@ -68,7 +73,7 @@ export type InternalGlobal = {
    */
   _sentryDebugIds?: Record<string, string>;
   __SENTRY__: {
-    [key: VersionString]: BackwardsCompatibleSentryCarrier;
+    [key: VersionString]: SentryCarrier;
     version: VersionString;
   } & BackwardsCompatibleSentryCarrier;
   /**
@@ -83,10 +88,8 @@ export type InternalGlobal = {
 /** Get's the global object for the current JavaScript runtime */
 export const GLOBAL_OBJ = globalThis as unknown as InternalGlobal;
 
-type SingletonKeys = Exclude<keyof InternalGlobal['__SENTRY__'], 'version' | VersionString>;
-
 /**
- * Returns a global singleton contained in the global `__SENTRY__` object.
+ * Returns a global singleton contained in the global `__SENTRY__[]` object.
  *
  * If the singleton doesn't already exist in `__SENTRY__`, it will be created using the given factory
  * function and added to the `__SENTRY__` object.
@@ -96,7 +99,7 @@ type SingletonKeys = Exclude<keyof InternalGlobal['__SENTRY__'], 'version' | Ver
  * @param obj (Optional) The global object on which to look for `__SENTRY__`, if not `GLOBAL_OBJ`'s return value
  * @returns the singleton
  */
-export function getGlobalSingleton<T>(name: SingletonKeys, creator: () => T, obj?: unknown): T {
+export function getGlobalSingleton<T>(name: keyof SentryCarrier, creator: () => T, obj?: unknown): T {
   const gbl = (obj || GLOBAL_OBJ) as InternalGlobal;
   const __SENTRY__ = (gbl.__SENTRY__ = gbl.__SENTRY__ || {});
   const versionedCarrier = (__SENTRY__[SDK_VERSION] = __SENTRY__[SDK_VERSION] || {});