create utility function for getting org id

Author: s1gr1d

packages/core/src/tracing/dynamicSamplingContext.ts

@@ -15,9 +15,8 @@ import {
   baggageHeaderToDynamicSamplingContext,
   dynamicSamplingContextToSentryBaggageHeader,
 } from '../utils-hoist/baggage';
-import { extractOrgIdFromDsnHost } from '../utils-hoist/dsn';
 import { addNonEnumerableProperty } from '../utils-hoist/object';
-import { getCapturedScopesOnSpan } from './utils';
+import { deriveOrgIdFromClient, getCapturedScopesOnSpan } from './utils';
 
 /**
  * If you change this value, also update the terser plugin config to
@@ -45,14 +44,7 @@ export function freezeDscOnSpan(span: Span, dsc: Partial<DynamicSamplingContext>
 export function getDynamicSamplingContextFromClient(trace_id: string, client: Client): DynamicSamplingContext {
   const options = client.getOptions();
 
-  const { publicKey: public_key, host } = client.getDsn() || {};
-
-  let org_id: string | undefined;
-  if (options.orgId) {
-    org_id = String(options.orgId);
-  } else if (host) {
-    org_id = extractOrgIdFromDsnHost(host);
-  }
+  const { publicKey: public_key } = client.getDsn() || {};
 
   // Instead of conditionally adding non-undefined values, we add them and then remove them if needed
   // otherwise, the order of baggage entries changes, which "breaks" a bunch of tests etc.
@@ -61,7 +53,7 @@ export function getDynamicSamplingContextFromClient(trace_id: string, client: Cl
     release: options.release,
     public_key,
     trace_id,
-    org_id,
+    org_id: deriveOrgIdFromClient(client),
   };
 
   client.emit('createDsc', dsc);

packages/core/src/tracing/trace.ts

@@ -17,7 +17,6 @@ import { parseSampleRate } from '../utils/parseSampleRate';
 import { _getSpanForScope, _setSpanForScope } from '../utils/spanOnScope';
 import { addChildSpanToSpan, getRootSpan, spanIsSampled, spanTimeInputToSeconds, spanToJSON } from '../utils/spanUtils';
 import { baggageHeaderToDynamicSamplingContext } from '../utils-hoist/baggage';
-import { extractOrgIdFromDsnHost } from '../utils-hoist/dsn';
 import { logger } from '../utils-hoist/logger';
 import { generateTraceId } from '../utils-hoist/propagationContext';
 import { propagationContextFromHeaders } from '../utils-hoist/tracing';
@@ -27,7 +26,7 @@ import { sampleSpan } from './sampling';
 import { SentryNonRecordingSpan } from './sentryNonRecordingSpan';
 import { SentrySpan } from './sentrySpan';
 import { SPAN_STATUS_ERROR } from './spanstatus';
-import { setCapturedScopesOnSpan } from './utils';
+import { deriveOrgIdFromClient, setCapturedScopesOnSpan } from './utils';
 
 const SUPPRESS_TRACING_KEY = '__SENTRY_SUPPRESS_TRACING__';
 
@@ -225,11 +224,7 @@ export const continueTrace = <V>(
   const incomingDsc = baggageHeaderToDynamicSamplingContext(baggage);
   const baggageOrgId = incomingDsc?.org_id;
 
-  let sdkOrgId: string | undefined;
-  const dsn = client?.getDsn();
-  if (dsn?.host) {
-    sdkOrgId = extractOrgIdFromDsnHost(dsn.host);
-  }
+  const sdkOrgId = deriveOrgIdFromClient(client);
 
   const shouldStartNewTrace = (): boolean => {
     // Case: baggage org ID and SDK org ID don't match - always start new trace

packages/core/src/tracing/utils.ts

@@ -1,5 +1,7 @@
+import type { Client } from '../client';
 import type { Scope } from '../scope';
 import type { Span } from '../types-hoist/span';
+import { extractOrgIdFromDsnHost } from '../utils-hoist/dsn';
 import { addNonEnumerableProperty } from '../utils-hoist/object';
 
 const SCOPE_ON_START_SPAN_FIELD = '_sentryScope';
@@ -27,3 +29,24 @@ export function getCapturedScopesOnSpan(span: Span): { scope?: Scope; isolationS
     isolationScope: (span as SpanWithScopes)[ISOLATION_SCOPE_ON_START_SPAN_FIELD],
   };
 }
+
+/**
+ *  Returns the organization ID of the client.
+ *
+ *  The organization ID is extracted from the DSN. If the client options include a `orgId`, this will always take precedence.
+ */
+export function deriveOrgIdFromClient(client: Client | undefined): string | undefined {
+  const options = client?.getOptions();
+
+  const { host } = client?.getDsn() || {};
+
+  let org_id: string | undefined;
+
+  if (options?.orgId) {
+    org_id = String(options.orgId);
+  } else if (host) {
+    org_id = extractOrgIdFromDsnHost(host);
+  }
+
+  return org_id;
+}

packages/core/test/lib/tracing/utils.test.ts

@@ -0,0 +1,53 @@
+import { beforeEach, describe, expect, test, vi } from 'vitest';
+import { deriveOrgIdFromClient } from '../../../src/tracing/utils';
+import { getDefaultTestClientOptions, TestClient } from '../../mocks/client';
+
+describe('deriveOrgIdFromClient', () => {
+  let client: TestClient;
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  test('returns orgId from client options when available', () => {
+    client = new TestClient(
+      getDefaultTestClientOptions({
+        orgId: '00222111',
+        dsn: 'https://[email protected]/1',
+      }),
+    );
+
+    const result = deriveOrgIdFromClient(client);
+    expect(result).toBe('00222111');
+  });
+
+  test('converts non-string orgId to string', () => {
+    client = new TestClient(
+      getDefaultTestClientOptions({
+        orgId: 12345,
+        dsn: 'https://[email protected]/1',
+      }),
+    );
+
+    const result = deriveOrgIdFromClient(client);
+    expect(result).toBe('12345');
+  });
+
+  test('extracts orgId from DSN host when options.orgId is not available', () => {
+    client = new TestClient(
+      getDefaultTestClientOptions({
+        dsn: 'https://[email protected]/1',
+      }),
+    );
+
+    const result = deriveOrgIdFromClient(client);
+    expect(result).toBe('012300');
+  });
+
+  test('returns undefined when neither options.orgId nor DSN host are available', () => {
+    client = new TestClient(getDefaultTestClientOptions({}));
+
+    const result = deriveOrgIdFromClient(client);
+    expect(result).toBeUndefined();
+  });
+});

packages/core/tsconfig.test.json

@@ -5,6 +5,7 @@
 
   "compilerOptions": {
     "lib": ["DOM", "ES2018"],
+    "module": "ESNext", // support dynamic import()
     // should include all types from `./tsconfig.json` plus types for all test frameworks used
     "types": ["node"]