From e7ae4dd15bd6b3d30e3bc5b71b88b2c3d28ba14f Mon Sep 17 00:00:00 2001 From: Katie Byers Date: Tue, 26 Jan 2021 20:08:25 -0800 Subject: [PATCH 1/3] simplify `getHubFromActiveDomain` method and remove unused `DomainAsCarrier` interface --- packages/hub/src/hub.ts | 15 ++------------- packages/hub/src/index.ts | 12 ++---------- packages/hub/src/interfaces.ts | 5 ----- 3 files changed, 4 insertions(+), 28 deletions(-) diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts index 1a3fb04ec00a..ebe9fc381af7 100644 --- a/packages/hub/src/hub.ts +++ b/packages/hub/src/hub.ts @@ -22,7 +22,7 @@ import { } from '@sentry/types'; import { consoleSandbox, dateTimestampInSeconds, getGlobalObject, isNodeEnv, logger, uuid4 } from '@sentry/utils'; -import { Carrier, DomainAsCarrier, Layer } from './interfaces'; +import { Carrier, Layer } from './interfaces'; import { Scope } from './scope'; import { Session } from './session'; @@ -471,24 +471,13 @@ export function getCurrentHub(): Hub { return getHubFromCarrier(registry); } -/** - * Returns the active domain, if one exists - * - * @returns The domain, or undefined if there is no active domain - */ -export function getActiveDomain(): DomainAsCarrier | undefined { - const sentry = getMainCarrier().__SENTRY__; - - return sentry && sentry.extensions && sentry.extensions.domain && sentry.extensions.domain.active; -} - /** * Try to read the hub from an active domain, and fallback to the registry if one doesn't exist * @returns discovered hub */ function getHubFromActiveDomain(registry: Carrier): Hub { try { - const activeDomain = getActiveDomain(); + const activeDomain = getMainCarrier().__SENTRY__?.extensions?.domain?.active; // If there's no active domain, just return global hub if (!activeDomain) { diff --git a/packages/hub/src/index.ts b/packages/hub/src/index.ts index dd4ee95a2a23..15c54fa62586 100644 --- a/packages/hub/src/index.ts +++ b/packages/hub/src/index.ts @@ -1,12 +1,4 @@ -export { Carrier, DomainAsCarrier, Layer } from './interfaces'; +export { Carrier, Layer } from './interfaces'; export { addGlobalEventProcessor, Scope } from './scope'; export { Session } from './session'; -export { - getActiveDomain, - getCurrentHub, - getHubFromCarrier, - getMainCarrier, - Hub, - makeMain, - setHubOnCarrier, -} from './hub'; +export { getCurrentHub, getHubFromCarrier, getMainCarrier, Hub, makeMain, setHubOnCarrier } from './hub'; diff --git a/packages/hub/src/interfaces.ts b/packages/hub/src/interfaces.ts index a18f6513666a..ea03c211801a 100644 --- a/packages/hub/src/interfaces.ts +++ b/packages/hub/src/interfaces.ts @@ -33,8 +33,3 @@ export interface Carrier { }; }; } - -export interface DomainAsCarrier extends Carrier { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - members: { [key: string]: any }[]; -} From fa88b0e32d9796e2120b1be3d2b8a46f15243d60 Mon Sep 17 00:00:00 2001 From: Katie Byers Date: Mon, 1 Feb 2021 15:20:41 -0800 Subject: [PATCH 2/3] fix docstring --- packages/types/src/transaction.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/types/src/transaction.ts b/packages/types/src/transaction.ts index 519ebb18e1dc..e38093404bd8 100644 --- a/packages/types/src/transaction.ts +++ b/packages/types/src/transaction.ts @@ -94,8 +94,8 @@ export interface SamplingContext extends CustomSamplingContext { parentSampled?: boolean; /** - * Object representing the URL of the current page or worker script. Passed by default in a browser or service worker - * context. + * Object representing the URL of the current page or worker script. Passed by default when using the `BrowserTracing` + * integration. */ location?: WorkerLocation; From 98c4d8ad4c57e6b8bcca54d82290ad7b8268e2cb Mon Sep 17 00:00:00 2001 From: Katie Byers Date: Tue, 2 Feb 2021 07:55:00 -0800 Subject: [PATCH 3/3] revert most of original change; convert to deprecations --- packages/hub/src/hub.ts | 16 +++++++++++++++- packages/hub/src/index.ts | 14 ++++++++++++-- packages/hub/src/interfaces.ts | 9 +++++++++ 3 files changed, 36 insertions(+), 3 deletions(-) diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts index ebe9fc381af7..2ce1f3ae256c 100644 --- a/packages/hub/src/hub.ts +++ b/packages/hub/src/hub.ts @@ -22,7 +22,7 @@ import { } from '@sentry/types'; import { consoleSandbox, dateTimestampInSeconds, getGlobalObject, isNodeEnv, logger, uuid4 } from '@sentry/utils'; -import { Carrier, Layer } from './interfaces'; +import { Carrier, DomainAsCarrier, Layer } from './interfaces'; import { Scope } from './scope'; import { Session } from './session'; @@ -471,6 +471,20 @@ export function getCurrentHub(): Hub { return getHubFromCarrier(registry); } +/** + * Returns the active domain, if one exists + * @deprecated No longer used; remove in v7 + * @returns The domain, or undefined if there is no active domain + */ +// eslint-disable-next-line deprecation/deprecation +export function getActiveDomain(): DomainAsCarrier | undefined { + logger.warn('Function `getActiveDomain` is deprecated and will be removed in a future version.'); + + const sentry = getMainCarrier().__SENTRY__; + + return sentry && sentry.extensions && sentry.extensions.domain && sentry.extensions.domain.active; +} + /** * Try to read the hub from an active domain, and fallback to the registry if one doesn't exist * @returns discovered hub diff --git a/packages/hub/src/index.ts b/packages/hub/src/index.ts index 15c54fa62586..56b2d666ad1f 100644 --- a/packages/hub/src/index.ts +++ b/packages/hub/src/index.ts @@ -1,4 +1,14 @@ -export { Carrier, Layer } from './interfaces'; +// eslint-disable-next-line deprecation/deprecation +export { Carrier, DomainAsCarrier, Layer } from './interfaces'; export { addGlobalEventProcessor, Scope } from './scope'; export { Session } from './session'; -export { getCurrentHub, getHubFromCarrier, getMainCarrier, Hub, makeMain, setHubOnCarrier } from './hub'; +export { + // eslint-disable-next-line deprecation/deprecation + getActiveDomain, + getCurrentHub, + getHubFromCarrier, + getMainCarrier, + Hub, + makeMain, + setHubOnCarrier, +} from './hub'; diff --git a/packages/hub/src/interfaces.ts b/packages/hub/src/interfaces.ts index ea03c211801a..9adbf4d5a8de 100644 --- a/packages/hub/src/interfaces.ts +++ b/packages/hub/src/interfaces.ts @@ -33,3 +33,12 @@ export interface Carrier { }; }; } + +/** + * @hidden + * @deprecated Can be removed once `Hub.getActiveDomain` is removed. + */ +export interface DomainAsCarrier extends Carrier { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + members: { [key: string]: any }[]; +}