feat(v7/types): Deprecate Hub interface#11530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 5 commits into from
Apr 10, 2024
Merged

feat(v7/types): Deprecate Hub interface #11530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd82818
feat(v7/types): Deprecate `Hub` interface
Lms24 Apr 10, 2024
5396579
fix lint pls?
Lms24 Apr 10, 2024
547a8af
this is annoying...
Lms24 Apr 10, 2024
aa4b89f
painful :(
Lms24 Apr 10, 2024
bca19a1
.
Lms24 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,7 @@ export interface Carrier {
* themselves and will also be removed in version 8. More information:
* - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
*/
// eslint-disable-next-line deprecation/deprecation
export class Hub implements HubInterface {
/** Is a {@link Layer}[] containing the client and scope */
private readonly _stack: Layer[];
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils/isSentryRequestUrl.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import type { Client, DsnComponents, Hub } from '@sentry/types';
*
* TODO(v8): Remove Hub fallback type
*/
// eslint-disable-next-line deprecation/deprecation
export function isSentryRequestUrl(url: string, hubOrClient: Hub | Client | undefined): boolean {
const client =
hubOrClient && isHub(hubOrClient)
Expand DownExpand Up@@ -34,6 +35,7 @@ function removeTrailingSlash(str: string): string {
return str[str.length - 1] === '/' ? str.slice(0, -1) : str;
}

// eslint-disable-next-line deprecation/deprecation
function isHub(hubOrClient: Hub | Client | undefined): hubOrClient is Hub {
// eslint-disable-next-line deprecation/deprecation
return (hubOrClient as Hub).getClient !== undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/utils/isSentryRequestUrl.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ describe('isSentryRequestUrl', () => {
getClient: () => {
return client;
},
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

// Works with hub passed
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/test/reportingobserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ const withScope = jest.fn(callback => {

const captureMessage = jest.fn();

// eslint-disable-next-line deprecation/deprecation
const mockHub = {} as unknown as Hub;

const mockReportingObserverConstructor = jest.fn();
Expand Down
1 change: 1 addition & 0 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,7 @@ export class Http implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
// No need to instrument if we don't want to track anything
if (!this._breadcrumbs && this._spans === false) {
Expand Down
2 changes: 1 addition & 1 deletion packages/node-experimental/src/sdk/globals.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export function getGlobalCarrier(): SentryCarrier {
* Calls global extension method and binding current instance to the function call
*/
// @ts-expect-error Function lacks ending return statement and return type does not include 'undefined'. ts(2366)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// eslint-disable-next-line @typescript-eslint/no-explicit-any,deprecation/deprecation
export function callExtensionMethod<T>(hub: Hub, method: string, ...args: any[]): T {
const carrier = getGlobalCarrier();

Expand Down
3 changes: 3 additions & 0 deletions packages/node-experimental/src/sdk/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ export function setupGlobalHub(): void {
/**
* This is for legacy reasons, and returns a proxy object instead of a hub to be used.
*/
// eslint-disable-next-line deprecation/deprecation
export function getCurrentHub(): Hub {
return {
isOlderThan(_version: number): boolean {
Expand DownExpand Up@@ -88,6 +89,7 @@ export function getCurrentHub(): Hub {
// eslint-disable-next-line deprecation/deprecation
configureScope: configureScope,

// eslint-disable-next-line deprecation/deprecation
run(callback: (hub: Hub) => void): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return withScope(() => callback(this as any));
Expand DownExpand Up@@ -142,6 +144,7 @@ export function getCurrentHub(): Hub {
*
* @returns The old replaced hub
*/
// eslint-disable-next-line deprecation/deprecation
export function makeMain(hub: Hub): Hub {
// eslint-disable-next-line no-console
console.warn('makeMain is a noop in @sentry/node-experimental. Use `setCurrentClient` instead.');
Expand Down
2 changes: 2 additions & 0 deletions packages/node-experimental/src/sdk/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ export interface AsyncContextStrategy {
getScopes: () => CurrentScopes | undefined;

/** This is here for legacy reasons. */
// eslint-disable-next-line deprecation/deprecation
getCurrentHub: () => Hub;

/**
Expand All@@ -67,6 +68,7 @@ export interface SentryCarrier {
acs?: AsyncContextStrategy;

// hub is here for legacy reasons
// eslint-disable-next-line deprecation/deprecation
hub?: Hub;

extensions?: {
Expand Down
1 change: 1 addition & 0 deletions packages/node/test/eventbuilders.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ describe('eventFromUnknownInput', () => {
return { normalizeDepth: 6 };
},
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
});

Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry-node/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry-node/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/custom/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { uuid4 } from '@sentry/utils';
* This is a fork of core's tracing/hubextensions.ts _startTransaction,
* with some OTEL specifics.
*/
// eslint-disable-next-line deprecation/deprecation
export function startTransaction(hub: HubInterface, transactionContext: TransactionContext): Transaction {
// eslint-disable-next-line deprecation/deprecation
const client = hub.getClient();
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/contextData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,14 +23,17 @@ export function setPropagationContextOnContext(context: Context, propagationCont
* Try to get the Hub from the given OTEL context.
* This requires a Context Manager that was wrapped with getWrappedContextManager.
*/
// eslint-disable-next-line deprecation/deprecation
export function getHubFromContext(context: Context): Hub | undefined {
// eslint-disable-next-line deprecation/deprecation
return context.getValue(SENTRY_HUB_CONTEXT_KEY) as Hub | undefined;
}

/**
* Set a Hub on an OTEL context..
* This will return a forked context with the Propagation Context set.
*/
// eslint-disable-next-line deprecation/deprecation
export function setHubOnContext(context: Context, hub: Hub): Context {
return context.setValue(SENTRY_HUB_CONTEXT_KEY, hub);
}
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/spanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { AbstractSpan } from '../types';
// and since we are using weakmaps, we do not need to clean up after ourselves
const SpanScope = new WeakMap<AbstractSpan, Scope>();
const SpanFinishScope = new WeakMap<AbstractSpan, Scope>();
// eslint-disable-next-line deprecation/deprecation
const SpanHub = new WeakMap<AbstractSpan, Hub>();
const SpanParent = new WeakMap<AbstractSpan, Span>();
const SpanMetadata = new WeakMap<AbstractSpan, Partial<TransactionMetadata>>();
Expand All@@ -23,11 +24,13 @@ export function getSpanScope(span: AbstractSpan): Scope | undefined {
}

/** Set the Sentry hub on an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function setSpanHub(span: AbstractSpan, hub: Hub): void {
SpanHub.set(span, hub);
}

/** Get the Sentry hub of an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function getSpanHub(span: AbstractSpan): Hub | undefined {
return SpanHub.get(span);
}
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { isValidSampleRate } from './utils';
export const MAX_PROFILE_DURATION_MS = 30 * 1000;

type StartTransaction = (
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand DownExpand Up@@ -142,6 +143,7 @@ export function stopTransactionProfile(
*/
export function __PRIVATE__wrapStartTransactionWithProfiling(startTransaction: StartTransaction): StartTransaction {
return function wrappedStartTransaction(
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ export class ProfilingIntegration implements Integration {
* @inheritDoc
*/
public readonly name: string;
// eslint-disable-next-line deprecation/deprecation
public getCurrentHub?: () => Hub;

public constructor() {
Expand All@@ -64,6 +65,7 @@ export class ProfilingIntegration implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
this.getCurrentHub = getCurrentHub;
// eslint-disable-next-line deprecation/deprecation
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/test/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ function makeHubMock({
}: {
profilesSampleRate: number | undefined;
client?: Partial<NodeClient>;
// eslint-disable-next-line deprecation/deprecation
}): Hub {
return {
getClient: jest.fn().mockImplementation(() => {
Expand All@@ -59,6 +60,7 @@ function makeHubMock({
...(client ?? {}),
};
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(v7/types): Deprecate Hub interface#11530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 5 commits into from
Apr 10, 2024
Merged

feat(v7/types): Deprecate Hub interface #11530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd82818
feat(v7/types): Deprecate `Hub` interface
Lms24 Apr 10, 2024
5396579
fix lint pls?
Lms24 Apr 10, 2024
547a8af
this is annoying...
Lms24 Apr 10, 2024
aa4b89f
painful :(
Lms24 Apr 10, 2024
bca19a1
.
Lms24 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,7 @@ export interface Carrier {
* themselves and will also be removed in version 8. More information:
* - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
*/
// eslint-disable-next-line deprecation/deprecation
export class Hub implements HubInterface {
/** Is a {@link Layer}[] containing the client and scope */
private readonly _stack: Layer[];
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils/isSentryRequestUrl.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import type { Client, DsnComponents, Hub } from '@sentry/types';
*
* TODO(v8): Remove Hub fallback type
*/
// eslint-disable-next-line deprecation/deprecation
export function isSentryRequestUrl(url: string, hubOrClient: Hub | Client | undefined): boolean {
const client =
hubOrClient && isHub(hubOrClient)
Expand DownExpand Up@@ -34,6 +35,7 @@ function removeTrailingSlash(str: string): string {
return str[str.length - 1] === '/' ? str.slice(0, -1) : str;
}

// eslint-disable-next-line deprecation/deprecation
function isHub(hubOrClient: Hub | Client | undefined): hubOrClient is Hub {
// eslint-disable-next-line deprecation/deprecation
return (hubOrClient as Hub).getClient !== undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/utils/isSentryRequestUrl.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ describe('isSentryRequestUrl', () => {
getClient: () => {
return client;
},
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

// Works with hub passed
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/test/reportingobserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ const withScope = jest.fn(callback => {

const captureMessage = jest.fn();

// eslint-disable-next-line deprecation/deprecation
const mockHub = {} as unknown as Hub;

const mockReportingObserverConstructor = jest.fn();
Expand Down
1 change: 1 addition & 0 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,7 @@ export class Http implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
// No need to instrument if we don't want to track anything
if (!this._breadcrumbs && this._spans === false) {
Expand Down
2 changes: 1 addition & 1 deletion packages/node-experimental/src/sdk/globals.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export function getGlobalCarrier(): SentryCarrier {
* Calls global extension method and binding current instance to the function call
*/
// @ts-expect-error Function lacks ending return statement and return type does not include 'undefined'. ts(2366)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// eslint-disable-next-line @typescript-eslint/no-explicit-any,deprecation/deprecation
export function callExtensionMethod<T>(hub: Hub, method: string, ...args: any[]): T {
const carrier = getGlobalCarrier();

Expand Down
3 changes: 3 additions & 0 deletions packages/node-experimental/src/sdk/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ export function setupGlobalHub(): void {
/**
* This is for legacy reasons, and returns a proxy object instead of a hub to be used.
*/
// eslint-disable-next-line deprecation/deprecation
export function getCurrentHub(): Hub {
return {
isOlderThan(_version: number): boolean {
Expand DownExpand Up@@ -88,6 +89,7 @@ export function getCurrentHub(): Hub {
// eslint-disable-next-line deprecation/deprecation
configureScope: configureScope,

// eslint-disable-next-line deprecation/deprecation
run(callback: (hub: Hub) => void): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return withScope(() => callback(this as any));
Expand DownExpand Up@@ -142,6 +144,7 @@ export function getCurrentHub(): Hub {
*
* @returns The old replaced hub
*/
// eslint-disable-next-line deprecation/deprecation
export function makeMain(hub: Hub): Hub {
// eslint-disable-next-line no-console
console.warn('makeMain is a noop in @sentry/node-experimental. Use `setCurrentClient` instead.');
Expand Down
2 changes: 2 additions & 0 deletions packages/node-experimental/src/sdk/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ export interface AsyncContextStrategy {
getScopes: () => CurrentScopes | undefined;

/** This is here for legacy reasons. */
// eslint-disable-next-line deprecation/deprecation
getCurrentHub: () => Hub;

/**
Expand All@@ -67,6 +68,7 @@ export interface SentryCarrier {
acs?: AsyncContextStrategy;

// hub is here for legacy reasons
// eslint-disable-next-line deprecation/deprecation
hub?: Hub;

extensions?: {
Expand Down
1 change: 1 addition & 0 deletions packages/node/test/eventbuilders.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ describe('eventFromUnknownInput', () => {
return { normalizeDepth: 6 };
},
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
});

Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry-node/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry-node/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/custom/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { uuid4 } from '@sentry/utils';
* This is a fork of core's tracing/hubextensions.ts _startTransaction,
* with some OTEL specifics.
*/
// eslint-disable-next-line deprecation/deprecation
export function startTransaction(hub: HubInterface, transactionContext: TransactionContext): Transaction {
// eslint-disable-next-line deprecation/deprecation
const client = hub.getClient();
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/contextData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,14 +23,17 @@ export function setPropagationContextOnContext(context: Context, propagationCont
* Try to get the Hub from the given OTEL context.
* This requires a Context Manager that was wrapped with getWrappedContextManager.
*/
// eslint-disable-next-line deprecation/deprecation
export function getHubFromContext(context: Context): Hub | undefined {
// eslint-disable-next-line deprecation/deprecation
return context.getValue(SENTRY_HUB_CONTEXT_KEY) as Hub | undefined;
}

/**
* Set a Hub on an OTEL context..
* This will return a forked context with the Propagation Context set.
*/
// eslint-disable-next-line deprecation/deprecation
export function setHubOnContext(context: Context, hub: Hub): Context {
return context.setValue(SENTRY_HUB_CONTEXT_KEY, hub);
}
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/spanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { AbstractSpan } from '../types';
// and since we are using weakmaps, we do not need to clean up after ourselves
const SpanScope = new WeakMap<AbstractSpan, Scope>();
const SpanFinishScope = new WeakMap<AbstractSpan, Scope>();
// eslint-disable-next-line deprecation/deprecation
const SpanHub = new WeakMap<AbstractSpan, Hub>();
const SpanParent = new WeakMap<AbstractSpan, Span>();
const SpanMetadata = new WeakMap<AbstractSpan, Partial<TransactionMetadata>>();
Expand All@@ -23,11 +24,13 @@ export function getSpanScope(span: AbstractSpan): Scope | undefined {
}

/** Set the Sentry hub on an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function setSpanHub(span: AbstractSpan, hub: Hub): void {
SpanHub.set(span, hub);
}

/** Get the Sentry hub of an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function getSpanHub(span: AbstractSpan): Hub | undefined {
return SpanHub.get(span);
}
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { isValidSampleRate } from './utils';
export const MAX_PROFILE_DURATION_MS = 30 * 1000;

type StartTransaction = (
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand DownExpand Up@@ -142,6 +143,7 @@ export function stopTransactionProfile(
*/
export function __PRIVATE__wrapStartTransactionWithProfiling(startTransaction: StartTransaction): StartTransaction {
return function wrappedStartTransaction(
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ export class ProfilingIntegration implements Integration {
* @inheritDoc
*/
public readonly name: string;
// eslint-disable-next-line deprecation/deprecation
public getCurrentHub?: () => Hub;

public constructor() {
Expand All@@ -64,6 +65,7 @@ export class ProfilingIntegration implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
this.getCurrentHub = getCurrentHub;
// eslint-disable-next-line deprecation/deprecation
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/test/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ function makeHubMock({
}: {
profilesSampleRate: number | undefined;
client?: Partial<NodeClient>;
// eslint-disable-next-line deprecation/deprecation
}): Hub {
return {
getClient: jest.fn().mockImplementation(() => {
Expand All@@ -59,6 +60,7 @@ function makeHubMock({
...(client ?? {}),
};
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(v7/types): Deprecate Hub interface#11530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 5 commits into from
Apr 10, 2024
Merged

feat(v7/types): Deprecate Hub interface #11530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd82818
feat(v7/types): Deprecate `Hub` interface
Lms24 Apr 10, 2024
5396579
fix lint pls?
Lms24 Apr 10, 2024
547a8af
this is annoying...
Lms24 Apr 10, 2024
aa4b89f
painful :(
Lms24 Apr 10, 2024
bca19a1
.
Lms24 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,7 @@ export interface Carrier {
* themselves and will also be removed in version 8. More information:
* - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
*/
// eslint-disable-next-line deprecation/deprecation
export class Hub implements HubInterface {
/** Is a {@link Layer}[] containing the client and scope */
private readonly _stack: Layer[];
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils/isSentryRequestUrl.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import type { Client, DsnComponents, Hub } from '@sentry/types';
*
* TODO(v8): Remove Hub fallback type
*/
// eslint-disable-next-line deprecation/deprecation
export function isSentryRequestUrl(url: string, hubOrClient: Hub | Client | undefined): boolean {
const client =
hubOrClient && isHub(hubOrClient)
Expand DownExpand Up@@ -34,6 +35,7 @@ function removeTrailingSlash(str: string): string {
return str[str.length - 1] === '/' ? str.slice(0, -1) : str;
}

// eslint-disable-next-line deprecation/deprecation
function isHub(hubOrClient: Hub | Client | undefined): hubOrClient is Hub {
// eslint-disable-next-line deprecation/deprecation
return (hubOrClient as Hub).getClient !== undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/utils/isSentryRequestUrl.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ describe('isSentryRequestUrl', () => {
getClient: () => {
return client;
},
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

// Works with hub passed
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/test/reportingobserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ const withScope = jest.fn(callback => {

const captureMessage = jest.fn();

// eslint-disable-next-line deprecation/deprecation
const mockHub = {} as unknown as Hub;

const mockReportingObserverConstructor = jest.fn();
Expand Down
1 change: 1 addition & 0 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,7 @@ export class Http implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
// No need to instrument if we don't want to track anything
if (!this._breadcrumbs && this._spans === false) {
Expand Down
2 changes: 1 addition & 1 deletion packages/node-experimental/src/sdk/globals.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export function getGlobalCarrier(): SentryCarrier {
* Calls global extension method and binding current instance to the function call
*/
// @ts-expect-error Function lacks ending return statement and return type does not include 'undefined'. ts(2366)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// eslint-disable-next-line @typescript-eslint/no-explicit-any,deprecation/deprecation
export function callExtensionMethod<T>(hub: Hub, method: string, ...args: any[]): T {
const carrier = getGlobalCarrier();

Expand Down
3 changes: 3 additions & 0 deletions packages/node-experimental/src/sdk/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ export function setupGlobalHub(): void {
/**
* This is for legacy reasons, and returns a proxy object instead of a hub to be used.
*/
// eslint-disable-next-line deprecation/deprecation
export function getCurrentHub(): Hub {
return {
isOlderThan(_version: number): boolean {
Expand DownExpand Up@@ -88,6 +89,7 @@ export function getCurrentHub(): Hub {
// eslint-disable-next-line deprecation/deprecation
configureScope: configureScope,

// eslint-disable-next-line deprecation/deprecation
run(callback: (hub: Hub) => void): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return withScope(() => callback(this as any));
Expand DownExpand Up@@ -142,6 +144,7 @@ export function getCurrentHub(): Hub {
*
* @returns The old replaced hub
*/
// eslint-disable-next-line deprecation/deprecation
export function makeMain(hub: Hub): Hub {
// eslint-disable-next-line no-console
console.warn('makeMain is a noop in @sentry/node-experimental. Use `setCurrentClient` instead.');
Expand Down
2 changes: 2 additions & 0 deletions packages/node-experimental/src/sdk/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ export interface AsyncContextStrategy {
getScopes: () => CurrentScopes | undefined;

/** This is here for legacy reasons. */
// eslint-disable-next-line deprecation/deprecation
getCurrentHub: () => Hub;

/**
Expand All@@ -67,6 +68,7 @@ export interface SentryCarrier {
acs?: AsyncContextStrategy;

// hub is here for legacy reasons
// eslint-disable-next-line deprecation/deprecation
hub?: Hub;

extensions?: {
Expand Down
1 change: 1 addition & 0 deletions packages/node/test/eventbuilders.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ describe('eventFromUnknownInput', () => {
return { normalizeDepth: 6 };
},
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
});

Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry-node/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry-node/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/custom/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { uuid4 } from '@sentry/utils';
* This is a fork of core's tracing/hubextensions.ts _startTransaction,
* with some OTEL specifics.
*/
// eslint-disable-next-line deprecation/deprecation
export function startTransaction(hub: HubInterface, transactionContext: TransactionContext): Transaction {
// eslint-disable-next-line deprecation/deprecation
const client = hub.getClient();
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/contextData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,14 +23,17 @@ export function setPropagationContextOnContext(context: Context, propagationCont
* Try to get the Hub from the given OTEL context.
* This requires a Context Manager that was wrapped with getWrappedContextManager.
*/
// eslint-disable-next-line deprecation/deprecation
export function getHubFromContext(context: Context): Hub | undefined {
// eslint-disable-next-line deprecation/deprecation
return context.getValue(SENTRY_HUB_CONTEXT_KEY) as Hub | undefined;
}

/**
* Set a Hub on an OTEL context..
* This will return a forked context with the Propagation Context set.
*/
// eslint-disable-next-line deprecation/deprecation
export function setHubOnContext(context: Context, hub: Hub): Context {
return context.setValue(SENTRY_HUB_CONTEXT_KEY, hub);
}
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/spanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { AbstractSpan } from '../types';
// and since we are using weakmaps, we do not need to clean up after ourselves
const SpanScope = new WeakMap<AbstractSpan, Scope>();
const SpanFinishScope = new WeakMap<AbstractSpan, Scope>();
// eslint-disable-next-line deprecation/deprecation
const SpanHub = new WeakMap<AbstractSpan, Hub>();
const SpanParent = new WeakMap<AbstractSpan, Span>();
const SpanMetadata = new WeakMap<AbstractSpan, Partial<TransactionMetadata>>();
Expand All@@ -23,11 +24,13 @@ export function getSpanScope(span: AbstractSpan): Scope | undefined {
}

/** Set the Sentry hub on an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function setSpanHub(span: AbstractSpan, hub: Hub): void {
SpanHub.set(span, hub);
}

/** Get the Sentry hub of an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function getSpanHub(span: AbstractSpan): Hub | undefined {
return SpanHub.get(span);
}
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { isValidSampleRate } from './utils';
export const MAX_PROFILE_DURATION_MS = 30 * 1000;

type StartTransaction = (
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand DownExpand Up@@ -142,6 +143,7 @@ export function stopTransactionProfile(
*/
export function __PRIVATE__wrapStartTransactionWithProfiling(startTransaction: StartTransaction): StartTransaction {
return function wrappedStartTransaction(
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ export class ProfilingIntegration implements Integration {
* @inheritDoc
*/
public readonly name: string;
// eslint-disable-next-line deprecation/deprecation
public getCurrentHub?: () => Hub;

public constructor() {
Expand All@@ -64,6 +65,7 @@ export class ProfilingIntegration implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
this.getCurrentHub = getCurrentHub;
// eslint-disable-next-line deprecation/deprecation
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/test/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ function makeHubMock({
}: {
profilesSampleRate: number | undefined;
client?: Partial<NodeClient>;
// eslint-disable-next-line deprecation/deprecation
}): Hub {
return {
getClient: jest.fn().mockImplementation(() => {
Expand All@@ -59,6 +60,7 @@ function makeHubMock({
...(client ?? {}),
};
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(v7/types): Deprecate Hub interface#11530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 5 commits into from
Apr 10, 2024
Merged

feat(v7/types): Deprecate Hub interface #11530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd82818
feat(v7/types): Deprecate `Hub` interface
Lms24 Apr 10, 2024
5396579
fix lint pls?
Lms24 Apr 10, 2024
547a8af
this is annoying...
Lms24 Apr 10, 2024
aa4b89f
painful :(
Lms24 Apr 10, 2024
bca19a1
.
Lms24 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,7 @@ export interface Carrier {
* themselves and will also be removed in version 8. More information:
* - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
*/
// eslint-disable-next-line deprecation/deprecation
export class Hub implements HubInterface {
/** Is a {@link Layer}[] containing the client and scope */
private readonly _stack: Layer[];
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils/isSentryRequestUrl.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import type { Client, DsnComponents, Hub } from '@sentry/types';
*
* TODO(v8): Remove Hub fallback type
*/
// eslint-disable-next-line deprecation/deprecation
export function isSentryRequestUrl(url: string, hubOrClient: Hub | Client | undefined): boolean {
const client =
hubOrClient && isHub(hubOrClient)
Expand DownExpand Up@@ -34,6 +35,7 @@ function removeTrailingSlash(str: string): string {
return str[str.length - 1] === '/' ? str.slice(0, -1) : str;
}

// eslint-disable-next-line deprecation/deprecation
function isHub(hubOrClient: Hub | Client | undefined): hubOrClient is Hub {
// eslint-disable-next-line deprecation/deprecation
return (hubOrClient as Hub).getClient !== undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/utils/isSentryRequestUrl.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ describe('isSentryRequestUrl', () => {
getClient: () => {
return client;
},
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

// Works with hub passed
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/test/reportingobserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ const withScope = jest.fn(callback => {

const captureMessage = jest.fn();

// eslint-disable-next-line deprecation/deprecation
const mockHub = {} as unknown as Hub;

const mockReportingObserverConstructor = jest.fn();
Expand Down
1 change: 1 addition & 0 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,7 @@ export class Http implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
// No need to instrument if we don't want to track anything
if (!this._breadcrumbs && this._spans === false) {
Expand Down
2 changes: 1 addition & 1 deletion packages/node-experimental/src/sdk/globals.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export function getGlobalCarrier(): SentryCarrier {
* Calls global extension method and binding current instance to the function call
*/
// @ts-expect-error Function lacks ending return statement and return type does not include 'undefined'. ts(2366)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// eslint-disable-next-line @typescript-eslint/no-explicit-any,deprecation/deprecation
export function callExtensionMethod<T>(hub: Hub, method: string, ...args: any[]): T {
const carrier = getGlobalCarrier();

Expand Down
3 changes: 3 additions & 0 deletions packages/node-experimental/src/sdk/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ export function setupGlobalHub(): void {
/**
* This is for legacy reasons, and returns a proxy object instead of a hub to be used.
*/
// eslint-disable-next-line deprecation/deprecation
export function getCurrentHub(): Hub {
return {
isOlderThan(_version: number): boolean {
Expand DownExpand Up@@ -88,6 +89,7 @@ export function getCurrentHub(): Hub {
// eslint-disable-next-line deprecation/deprecation
configureScope: configureScope,

// eslint-disable-next-line deprecation/deprecation
run(callback: (hub: Hub) => void): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return withScope(() => callback(this as any));
Expand DownExpand Up@@ -142,6 +144,7 @@ export function getCurrentHub(): Hub {
*
* @returns The old replaced hub
*/
// eslint-disable-next-line deprecation/deprecation
export function makeMain(hub: Hub): Hub {
// eslint-disable-next-line no-console
console.warn('makeMain is a noop in @sentry/node-experimental. Use `setCurrentClient` instead.');
Expand Down
2 changes: 2 additions & 0 deletions packages/node-experimental/src/sdk/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ export interface AsyncContextStrategy {
getScopes: () => CurrentScopes | undefined;

/** This is here for legacy reasons. */
// eslint-disable-next-line deprecation/deprecation
getCurrentHub: () => Hub;

/**
Expand All@@ -67,6 +68,7 @@ export interface SentryCarrier {
acs?: AsyncContextStrategy;

// hub is here for legacy reasons
// eslint-disable-next-line deprecation/deprecation
hub?: Hub;

extensions?: {
Expand Down
1 change: 1 addition & 0 deletions packages/node/test/eventbuilders.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ describe('eventFromUnknownInput', () => {
return { normalizeDepth: 6 };
},
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
});

Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry-node/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry-node/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/custom/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { uuid4 } from '@sentry/utils';
* This is a fork of core's tracing/hubextensions.ts _startTransaction,
* with some OTEL specifics.
*/
// eslint-disable-next-line deprecation/deprecation
export function startTransaction(hub: HubInterface, transactionContext: TransactionContext): Transaction {
// eslint-disable-next-line deprecation/deprecation
const client = hub.getClient();
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/contextData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,14 +23,17 @@ export function setPropagationContextOnContext(context: Context, propagationCont
* Try to get the Hub from the given OTEL context.
* This requires a Context Manager that was wrapped with getWrappedContextManager.
*/
// eslint-disable-next-line deprecation/deprecation
export function getHubFromContext(context: Context): Hub | undefined {
// eslint-disable-next-line deprecation/deprecation
return context.getValue(SENTRY_HUB_CONTEXT_KEY) as Hub | undefined;
}

/**
* Set a Hub on an OTEL context..
* This will return a forked context with the Propagation Context set.
*/
// eslint-disable-next-line deprecation/deprecation
export function setHubOnContext(context: Context, hub: Hub): Context {
return context.setValue(SENTRY_HUB_CONTEXT_KEY, hub);
}
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/spanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { AbstractSpan } from '../types';
// and since we are using weakmaps, we do not need to clean up after ourselves
const SpanScope = new WeakMap<AbstractSpan, Scope>();
const SpanFinishScope = new WeakMap<AbstractSpan, Scope>();
// eslint-disable-next-line deprecation/deprecation
const SpanHub = new WeakMap<AbstractSpan, Hub>();
const SpanParent = new WeakMap<AbstractSpan, Span>();
const SpanMetadata = new WeakMap<AbstractSpan, Partial<TransactionMetadata>>();
Expand All@@ -23,11 +24,13 @@ export function getSpanScope(span: AbstractSpan): Scope | undefined {
}

/** Set the Sentry hub on an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function setSpanHub(span: AbstractSpan, hub: Hub): void {
SpanHub.set(span, hub);
}

/** Get the Sentry hub of an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function getSpanHub(span: AbstractSpan): Hub | undefined {
return SpanHub.get(span);
}
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { isValidSampleRate } from './utils';
export const MAX_PROFILE_DURATION_MS = 30 * 1000;

type StartTransaction = (
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand DownExpand Up@@ -142,6 +143,7 @@ export function stopTransactionProfile(
*/
export function __PRIVATE__wrapStartTransactionWithProfiling(startTransaction: StartTransaction): StartTransaction {
return function wrappedStartTransaction(
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ export class ProfilingIntegration implements Integration {
* @inheritDoc
*/
public readonly name: string;
// eslint-disable-next-line deprecation/deprecation
public getCurrentHub?: () => Hub;

public constructor() {
Expand All@@ -64,6 +65,7 @@ export class ProfilingIntegration implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
this.getCurrentHub = getCurrentHub;
// eslint-disable-next-line deprecation/deprecation
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/test/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ function makeHubMock({
}: {
profilesSampleRate: number | undefined;
client?: Partial<NodeClient>;
// eslint-disable-next-line deprecation/deprecation
}): Hub {
return {
getClient: jest.fn().mockImplementation(() => {
Expand All@@ -59,6 +60,7 @@ function makeHubMock({
...(client ?? {}),
};
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(v7/types): Deprecate Hub interface#11530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 5 commits into from
Apr 10, 2024
Merged

feat(v7/types): Deprecate Hub interface #11530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd82818
feat(v7/types): Deprecate `Hub` interface
Lms24 Apr 10, 2024
5396579
fix lint pls?
Lms24 Apr 10, 2024
547a8af
this is annoying...
Lms24 Apr 10, 2024
aa4b89f
painful :(
Lms24 Apr 10, 2024
bca19a1
.
Lms24 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,7 @@ export interface Carrier {
* themselves and will also be removed in version 8. More information:
* - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
*/
// eslint-disable-next-line deprecation/deprecation
export class Hub implements HubInterface {
/** Is a {@link Layer}[] containing the client and scope */
private readonly _stack: Layer[];
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils/isSentryRequestUrl.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import type { Client, DsnComponents, Hub } from '@sentry/types';
*
* TODO(v8): Remove Hub fallback type
*/
// eslint-disable-next-line deprecation/deprecation
export function isSentryRequestUrl(url: string, hubOrClient: Hub | Client | undefined): boolean {
const client =
hubOrClient && isHub(hubOrClient)
Expand DownExpand Up@@ -34,6 +35,7 @@ function removeTrailingSlash(str: string): string {
return str[str.length - 1] === '/' ? str.slice(0, -1) : str;
}

// eslint-disable-next-line deprecation/deprecation
function isHub(hubOrClient: Hub | Client | undefined): hubOrClient is Hub {
// eslint-disable-next-line deprecation/deprecation
return (hubOrClient as Hub).getClient !== undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/utils/isSentryRequestUrl.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ describe('isSentryRequestUrl', () => {
getClient: () => {
return client;
},
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

// Works with hub passed
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/test/reportingobserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ const withScope = jest.fn(callback => {

const captureMessage = jest.fn();

// eslint-disable-next-line deprecation/deprecation
const mockHub = {} as unknown as Hub;

const mockReportingObserverConstructor = jest.fn();
Expand Down
1 change: 1 addition & 0 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,7 @@ export class Http implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
// No need to instrument if we don't want to track anything
if (!this._breadcrumbs && this._spans === false) {
Expand Down
2 changes: 1 addition & 1 deletion packages/node-experimental/src/sdk/globals.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export function getGlobalCarrier(): SentryCarrier {
* Calls global extension method and binding current instance to the function call
*/
// @ts-expect-error Function lacks ending return statement and return type does not include 'undefined'. ts(2366)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// eslint-disable-next-line @typescript-eslint/no-explicit-any,deprecation/deprecation
export function callExtensionMethod<T>(hub: Hub, method: string, ...args: any[]): T {
const carrier = getGlobalCarrier();

Expand Down
3 changes: 3 additions & 0 deletions packages/node-experimental/src/sdk/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ export function setupGlobalHub(): void {
/**
* This is for legacy reasons, and returns a proxy object instead of a hub to be used.
*/
// eslint-disable-next-line deprecation/deprecation
export function getCurrentHub(): Hub {
return {
isOlderThan(_version: number): boolean {
Expand DownExpand Up@@ -88,6 +89,7 @@ export function getCurrentHub(): Hub {
// eslint-disable-next-line deprecation/deprecation
configureScope: configureScope,

// eslint-disable-next-line deprecation/deprecation
run(callback: (hub: Hub) => void): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return withScope(() => callback(this as any));
Expand DownExpand Up@@ -142,6 +144,7 @@ export function getCurrentHub(): Hub {
*
* @returns The old replaced hub
*/
// eslint-disable-next-line deprecation/deprecation
export function makeMain(hub: Hub): Hub {
// eslint-disable-next-line no-console
console.warn('makeMain is a noop in @sentry/node-experimental. Use `setCurrentClient` instead.');
Expand Down
2 changes: 2 additions & 0 deletions packages/node-experimental/src/sdk/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ export interface AsyncContextStrategy {
getScopes: () => CurrentScopes | undefined;

/** This is here for legacy reasons. */
// eslint-disable-next-line deprecation/deprecation
getCurrentHub: () => Hub;

/**
Expand All@@ -67,6 +68,7 @@ export interface SentryCarrier {
acs?: AsyncContextStrategy;

// hub is here for legacy reasons
// eslint-disable-next-line deprecation/deprecation
hub?: Hub;

extensions?: {
Expand Down
1 change: 1 addition & 0 deletions packages/node/test/eventbuilders.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ describe('eventFromUnknownInput', () => {
return { normalizeDepth: 6 };
},
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
});

Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry-node/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry-node/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/custom/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { uuid4 } from '@sentry/utils';
* This is a fork of core's tracing/hubextensions.ts _startTransaction,
* with some OTEL specifics.
*/
// eslint-disable-next-line deprecation/deprecation
export function startTransaction(hub: HubInterface, transactionContext: TransactionContext): Transaction {
// eslint-disable-next-line deprecation/deprecation
const client = hub.getClient();
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/contextData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,14 +23,17 @@ export function setPropagationContextOnContext(context: Context, propagationCont
* Try to get the Hub from the given OTEL context.
* This requires a Context Manager that was wrapped with getWrappedContextManager.
*/
// eslint-disable-next-line deprecation/deprecation
export function getHubFromContext(context: Context): Hub | undefined {
// eslint-disable-next-line deprecation/deprecation
return context.getValue(SENTRY_HUB_CONTEXT_KEY) as Hub | undefined;
}

/**
* Set a Hub on an OTEL context..
* This will return a forked context with the Propagation Context set.
*/
// eslint-disable-next-line deprecation/deprecation
export function setHubOnContext(context: Context, hub: Hub): Context {
return context.setValue(SENTRY_HUB_CONTEXT_KEY, hub);
}
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/spanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { AbstractSpan } from '../types';
// and since we are using weakmaps, we do not need to clean up after ourselves
const SpanScope = new WeakMap<AbstractSpan, Scope>();
const SpanFinishScope = new WeakMap<AbstractSpan, Scope>();
// eslint-disable-next-line deprecation/deprecation
const SpanHub = new WeakMap<AbstractSpan, Hub>();
const SpanParent = new WeakMap<AbstractSpan, Span>();
const SpanMetadata = new WeakMap<AbstractSpan, Partial<TransactionMetadata>>();
Expand All@@ -23,11 +24,13 @@ export function getSpanScope(span: AbstractSpan): Scope | undefined {
}

/** Set the Sentry hub on an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function setSpanHub(span: AbstractSpan, hub: Hub): void {
SpanHub.set(span, hub);
}

/** Get the Sentry hub of an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function getSpanHub(span: AbstractSpan): Hub | undefined {
return SpanHub.get(span);
}
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { isValidSampleRate } from './utils';
export const MAX_PROFILE_DURATION_MS = 30 * 1000;

type StartTransaction = (
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand DownExpand Up@@ -142,6 +143,7 @@ export function stopTransactionProfile(
*/
export function __PRIVATE__wrapStartTransactionWithProfiling(startTransaction: StartTransaction): StartTransaction {
return function wrappedStartTransaction(
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ export class ProfilingIntegration implements Integration {
* @inheritDoc
*/
public readonly name: string;
// eslint-disable-next-line deprecation/deprecation
public getCurrentHub?: () => Hub;

public constructor() {
Expand All@@ -64,6 +65,7 @@ export class ProfilingIntegration implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
this.getCurrentHub = getCurrentHub;
// eslint-disable-next-line deprecation/deprecation
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/test/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ function makeHubMock({
}: {
profilesSampleRate: number | undefined;
client?: Partial<NodeClient>;
// eslint-disable-next-line deprecation/deprecation
}): Hub {
return {
getClient: jest.fn().mockImplementation(() => {
Expand All@@ -59,6 +60,7 @@ function makeHubMock({
...(client ?? {}),
};
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(v7/types): Deprecate Hub interface#11530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 5 commits into from
Apr 10, 2024
Merged

feat(v7/types): Deprecate Hub interface #11530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd82818
feat(v7/types): Deprecate `Hub` interface
Lms24 Apr 10, 2024
5396579
fix lint pls?
Lms24 Apr 10, 2024
547a8af
this is annoying...
Lms24 Apr 10, 2024
aa4b89f
painful :(
Lms24 Apr 10, 2024
bca19a1
.
Lms24 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,7 @@ export interface Carrier {
* themselves and will also be removed in version 8. More information:
* - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
*/
// eslint-disable-next-line deprecation/deprecation
export class Hub implements HubInterface {
/** Is a {@link Layer}[] containing the client and scope */
private readonly _stack: Layer[];
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils/isSentryRequestUrl.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import type { Client, DsnComponents, Hub } from '@sentry/types';
*
* TODO(v8): Remove Hub fallback type
*/
// eslint-disable-next-line deprecation/deprecation
export function isSentryRequestUrl(url: string, hubOrClient: Hub | Client | undefined): boolean {
const client =
hubOrClient && isHub(hubOrClient)
Expand DownExpand Up@@ -34,6 +35,7 @@ function removeTrailingSlash(str: string): string {
return str[str.length - 1] === '/' ? str.slice(0, -1) : str;
}

// eslint-disable-next-line deprecation/deprecation
function isHub(hubOrClient: Hub | Client | undefined): hubOrClient is Hub {
// eslint-disable-next-line deprecation/deprecation
return (hubOrClient as Hub).getClient !== undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/utils/isSentryRequestUrl.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ describe('isSentryRequestUrl', () => {
getClient: () => {
return client;
},
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

// Works with hub passed
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/test/reportingobserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ const withScope = jest.fn(callback => {

const captureMessage = jest.fn();

// eslint-disable-next-line deprecation/deprecation
const mockHub = {} as unknown as Hub;

const mockReportingObserverConstructor = jest.fn();
Expand Down
1 change: 1 addition & 0 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,7 @@ export class Http implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
// No need to instrument if we don't want to track anything
if (!this._breadcrumbs && this._spans === false) {
Expand Down
2 changes: 1 addition & 1 deletion packages/node-experimental/src/sdk/globals.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export function getGlobalCarrier(): SentryCarrier {
* Calls global extension method and binding current instance to the function call
*/
// @ts-expect-error Function lacks ending return statement and return type does not include 'undefined'. ts(2366)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// eslint-disable-next-line @typescript-eslint/no-explicit-any,deprecation/deprecation
export function callExtensionMethod<T>(hub: Hub, method: string, ...args: any[]): T {
const carrier = getGlobalCarrier();

Expand Down
3 changes: 3 additions & 0 deletions packages/node-experimental/src/sdk/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ export function setupGlobalHub(): void {
/**
* This is for legacy reasons, and returns a proxy object instead of a hub to be used.
*/
// eslint-disable-next-line deprecation/deprecation
export function getCurrentHub(): Hub {
return {
isOlderThan(_version: number): boolean {
Expand DownExpand Up@@ -88,6 +89,7 @@ export function getCurrentHub(): Hub {
// eslint-disable-next-line deprecation/deprecation
configureScope: configureScope,

// eslint-disable-next-line deprecation/deprecation
run(callback: (hub: Hub) => void): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return withScope(() => callback(this as any));
Expand DownExpand Up@@ -142,6 +144,7 @@ export function getCurrentHub(): Hub {
*
* @returns The old replaced hub
*/
// eslint-disable-next-line deprecation/deprecation
export function makeMain(hub: Hub): Hub {
// eslint-disable-next-line no-console
console.warn('makeMain is a noop in @sentry/node-experimental. Use `setCurrentClient` instead.');
Expand Down
2 changes: 2 additions & 0 deletions packages/node-experimental/src/sdk/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ export interface AsyncContextStrategy {
getScopes: () => CurrentScopes | undefined;

/** This is here for legacy reasons. */
// eslint-disable-next-line deprecation/deprecation
getCurrentHub: () => Hub;

/**
Expand All@@ -67,6 +68,7 @@ export interface SentryCarrier {
acs?: AsyncContextStrategy;

// hub is here for legacy reasons
// eslint-disable-next-line deprecation/deprecation
hub?: Hub;

extensions?: {
Expand Down
1 change: 1 addition & 0 deletions packages/node/test/eventbuilders.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ describe('eventFromUnknownInput', () => {
return { normalizeDepth: 6 };
},
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
});

Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry-node/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry-node/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/custom/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { uuid4 } from '@sentry/utils';
* This is a fork of core's tracing/hubextensions.ts _startTransaction,
* with some OTEL specifics.
*/
// eslint-disable-next-line deprecation/deprecation
export function startTransaction(hub: HubInterface, transactionContext: TransactionContext): Transaction {
// eslint-disable-next-line deprecation/deprecation
const client = hub.getClient();
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/contextData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,14 +23,17 @@ export function setPropagationContextOnContext(context: Context, propagationCont
* Try to get the Hub from the given OTEL context.
* This requires a Context Manager that was wrapped with getWrappedContextManager.
*/
// eslint-disable-next-line deprecation/deprecation
export function getHubFromContext(context: Context): Hub | undefined {
// eslint-disable-next-line deprecation/deprecation
return context.getValue(SENTRY_HUB_CONTEXT_KEY) as Hub | undefined;
}

/**
* Set a Hub on an OTEL context..
* This will return a forked context with the Propagation Context set.
*/
// eslint-disable-next-line deprecation/deprecation
export function setHubOnContext(context: Context, hub: Hub): Context {
return context.setValue(SENTRY_HUB_CONTEXT_KEY, hub);
}
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/spanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { AbstractSpan } from '../types';
// and since we are using weakmaps, we do not need to clean up after ourselves
const SpanScope = new WeakMap<AbstractSpan, Scope>();
const SpanFinishScope = new WeakMap<AbstractSpan, Scope>();
// eslint-disable-next-line deprecation/deprecation
const SpanHub = new WeakMap<AbstractSpan, Hub>();
const SpanParent = new WeakMap<AbstractSpan, Span>();
const SpanMetadata = new WeakMap<AbstractSpan, Partial<TransactionMetadata>>();
Expand All@@ -23,11 +24,13 @@ export function getSpanScope(span: AbstractSpan): Scope | undefined {
}

/** Set the Sentry hub on an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function setSpanHub(span: AbstractSpan, hub: Hub): void {
SpanHub.set(span, hub);
}

/** Get the Sentry hub of an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function getSpanHub(span: AbstractSpan): Hub | undefined {
return SpanHub.get(span);
}
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { isValidSampleRate } from './utils';
export const MAX_PROFILE_DURATION_MS = 30 * 1000;

type StartTransaction = (
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand DownExpand Up@@ -142,6 +143,7 @@ export function stopTransactionProfile(
*/
export function __PRIVATE__wrapStartTransactionWithProfiling(startTransaction: StartTransaction): StartTransaction {
return function wrappedStartTransaction(
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ export class ProfilingIntegration implements Integration {
* @inheritDoc
*/
public readonly name: string;
// eslint-disable-next-line deprecation/deprecation
public getCurrentHub?: () => Hub;

public constructor() {
Expand All@@ -64,6 +65,7 @@ export class ProfilingIntegration implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
this.getCurrentHub = getCurrentHub;
// eslint-disable-next-line deprecation/deprecation
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/test/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ function makeHubMock({
}: {
profilesSampleRate: number | undefined;
client?: Partial<NodeClient>;
// eslint-disable-next-line deprecation/deprecation
}): Hub {
return {
getClient: jest.fn().mockImplementation(() => {
Expand All@@ -59,6 +60,7 @@ function makeHubMock({
...(client ?? {}),
};
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(v7/types): Deprecate Hub interface#11530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 5 commits into from
Apr 10, 2024
Merged

feat(v7/types): Deprecate Hub interface #11530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd82818
feat(v7/types): Deprecate `Hub` interface
Lms24 Apr 10, 2024
5396579
fix lint pls?
Lms24 Apr 10, 2024
547a8af
this is annoying...
Lms24 Apr 10, 2024
aa4b89f
painful :(
Lms24 Apr 10, 2024
bca19a1
.
Lms24 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,7 @@ export interface Carrier {
* themselves and will also be removed in version 8. More information:
* - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
*/
// eslint-disable-next-line deprecation/deprecation
export class Hub implements HubInterface {
/** Is a {@link Layer}[] containing the client and scope */
private readonly _stack: Layer[];
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils/isSentryRequestUrl.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import type { Client, DsnComponents, Hub } from '@sentry/types';
*
* TODO(v8): Remove Hub fallback type
*/
// eslint-disable-next-line deprecation/deprecation
export function isSentryRequestUrl(url: string, hubOrClient: Hub | Client | undefined): boolean {
const client =
hubOrClient && isHub(hubOrClient)
Expand DownExpand Up@@ -34,6 +35,7 @@ function removeTrailingSlash(str: string): string {
return str[str.length - 1] === '/' ? str.slice(0, -1) : str;
}

// eslint-disable-next-line deprecation/deprecation
function isHub(hubOrClient: Hub | Client | undefined): hubOrClient is Hub {
// eslint-disable-next-line deprecation/deprecation
return (hubOrClient as Hub).getClient !== undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/utils/isSentryRequestUrl.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ describe('isSentryRequestUrl', () => {
getClient: () => {
return client;
},
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

// Works with hub passed
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/test/reportingobserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ const withScope = jest.fn(callback => {

const captureMessage = jest.fn();

// eslint-disable-next-line deprecation/deprecation
const mockHub = {} as unknown as Hub;

const mockReportingObserverConstructor = jest.fn();
Expand Down
1 change: 1 addition & 0 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,7 @@ export class Http implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
// No need to instrument if we don't want to track anything
if (!this._breadcrumbs && this._spans === false) {
Expand Down
2 changes: 1 addition & 1 deletion packages/node-experimental/src/sdk/globals.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export function getGlobalCarrier(): SentryCarrier {
* Calls global extension method and binding current instance to the function call
*/
// @ts-expect-error Function lacks ending return statement and return type does not include 'undefined'. ts(2366)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// eslint-disable-next-line @typescript-eslint/no-explicit-any,deprecation/deprecation
export function callExtensionMethod<T>(hub: Hub, method: string, ...args: any[]): T {
const carrier = getGlobalCarrier();

Expand Down
3 changes: 3 additions & 0 deletions packages/node-experimental/src/sdk/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ export function setupGlobalHub(): void {
/**
* This is for legacy reasons, and returns a proxy object instead of a hub to be used.
*/
// eslint-disable-next-line deprecation/deprecation
export function getCurrentHub(): Hub {
return {
isOlderThan(_version: number): boolean {
Expand DownExpand Up@@ -88,6 +89,7 @@ export function getCurrentHub(): Hub {
// eslint-disable-next-line deprecation/deprecation
configureScope: configureScope,

// eslint-disable-next-line deprecation/deprecation
run(callback: (hub: Hub) => void): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return withScope(() => callback(this as any));
Expand DownExpand Up@@ -142,6 +144,7 @@ export function getCurrentHub(): Hub {
*
* @returns The old replaced hub
*/
// eslint-disable-next-line deprecation/deprecation
export function makeMain(hub: Hub): Hub {
// eslint-disable-next-line no-console
console.warn('makeMain is a noop in @sentry/node-experimental. Use `setCurrentClient` instead.');
Expand Down
2 changes: 2 additions & 0 deletions packages/node-experimental/src/sdk/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ export interface AsyncContextStrategy {
getScopes: () => CurrentScopes | undefined;

/** This is here for legacy reasons. */
// eslint-disable-next-line deprecation/deprecation
getCurrentHub: () => Hub;

/**
Expand All@@ -67,6 +68,7 @@ export interface SentryCarrier {
acs?: AsyncContextStrategy;

// hub is here for legacy reasons
// eslint-disable-next-line deprecation/deprecation
hub?: Hub;

extensions?: {
Expand Down
1 change: 1 addition & 0 deletions packages/node/test/eventbuilders.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ describe('eventFromUnknownInput', () => {
return { normalizeDepth: 6 };
},
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
});

Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry-node/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry-node/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/custom/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { uuid4 } from '@sentry/utils';
* This is a fork of core's tracing/hubextensions.ts _startTransaction,
* with some OTEL specifics.
*/
// eslint-disable-next-line deprecation/deprecation
export function startTransaction(hub: HubInterface, transactionContext: TransactionContext): Transaction {
// eslint-disable-next-line deprecation/deprecation
const client = hub.getClient();
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/contextData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,14 +23,17 @@ export function setPropagationContextOnContext(context: Context, propagationCont
* Try to get the Hub from the given OTEL context.
* This requires a Context Manager that was wrapped with getWrappedContextManager.
*/
// eslint-disable-next-line deprecation/deprecation
export function getHubFromContext(context: Context): Hub | undefined {
// eslint-disable-next-line deprecation/deprecation
return context.getValue(SENTRY_HUB_CONTEXT_KEY) as Hub | undefined;
}

/**
* Set a Hub on an OTEL context..
* This will return a forked context with the Propagation Context set.
*/
// eslint-disable-next-line deprecation/deprecation
export function setHubOnContext(context: Context, hub: Hub): Context {
return context.setValue(SENTRY_HUB_CONTEXT_KEY, hub);
}
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/spanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { AbstractSpan } from '../types';
// and since we are using weakmaps, we do not need to clean up after ourselves
const SpanScope = new WeakMap<AbstractSpan, Scope>();
const SpanFinishScope = new WeakMap<AbstractSpan, Scope>();
// eslint-disable-next-line deprecation/deprecation
const SpanHub = new WeakMap<AbstractSpan, Hub>();
const SpanParent = new WeakMap<AbstractSpan, Span>();
const SpanMetadata = new WeakMap<AbstractSpan, Partial<TransactionMetadata>>();
Expand All@@ -23,11 +24,13 @@ export function getSpanScope(span: AbstractSpan): Scope | undefined {
}

/** Set the Sentry hub on an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function setSpanHub(span: AbstractSpan, hub: Hub): void {
SpanHub.set(span, hub);
}

/** Get the Sentry hub of an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function getSpanHub(span: AbstractSpan): Hub | undefined {
return SpanHub.get(span);
}
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { isValidSampleRate } from './utils';
export const MAX_PROFILE_DURATION_MS = 30 * 1000;

type StartTransaction = (
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand DownExpand Up@@ -142,6 +143,7 @@ export function stopTransactionProfile(
*/
export function __PRIVATE__wrapStartTransactionWithProfiling(startTransaction: StartTransaction): StartTransaction {
return function wrappedStartTransaction(
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ export class ProfilingIntegration implements Integration {
* @inheritDoc
*/
public readonly name: string;
// eslint-disable-next-line deprecation/deprecation
public getCurrentHub?: () => Hub;

public constructor() {
Expand All@@ -64,6 +65,7 @@ export class ProfilingIntegration implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
this.getCurrentHub = getCurrentHub;
// eslint-disable-next-line deprecation/deprecation
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/test/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ function makeHubMock({
}: {
profilesSampleRate: number | undefined;
client?: Partial<NodeClient>;
// eslint-disable-next-line deprecation/deprecation
}): Hub {
return {
getClient: jest.fn().mockImplementation(() => {
Expand All@@ -59,6 +60,7 @@ function makeHubMock({
...(client ?? {}),
};
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(v7/types): Deprecate Hub interface#11530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 5 commits into from
Apr 10, 2024
Merged

feat(v7/types): Deprecate Hub interface #11530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd82818
feat(v7/types): Deprecate `Hub` interface
Lms24 Apr 10, 2024
5396579
fix lint pls?
Lms24 Apr 10, 2024
547a8af
this is annoying...
Lms24 Apr 10, 2024
aa4b89f
painful :(
Lms24 Apr 10, 2024
bca19a1
.
Lms24 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,7 @@ export interface Carrier {
* themselves and will also be removed in version 8. More information:
* - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
*/
// eslint-disable-next-line deprecation/deprecation
export class Hub implements HubInterface {
/** Is a {@link Layer}[] containing the client and scope */
private readonly _stack: Layer[];
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils/isSentryRequestUrl.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import type { Client, DsnComponents, Hub } from '@sentry/types';
*
* TODO(v8): Remove Hub fallback type
*/
// eslint-disable-next-line deprecation/deprecation
export function isSentryRequestUrl(url: string, hubOrClient: Hub | Client | undefined): boolean {
const client =
hubOrClient && isHub(hubOrClient)
Expand DownExpand Up@@ -34,6 +35,7 @@ function removeTrailingSlash(str: string): string {
return str[str.length - 1] === '/' ? str.slice(0, -1) : str;
}

// eslint-disable-next-line deprecation/deprecation
function isHub(hubOrClient: Hub | Client | undefined): hubOrClient is Hub {
// eslint-disable-next-line deprecation/deprecation
return (hubOrClient as Hub).getClient !== undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/utils/isSentryRequestUrl.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ describe('isSentryRequestUrl', () => {
getClient: () => {
return client;
},
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

// Works with hub passed
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/test/reportingobserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ const withScope = jest.fn(callback => {

const captureMessage = jest.fn();

// eslint-disable-next-line deprecation/deprecation
const mockHub = {} as unknown as Hub;

const mockReportingObserverConstructor = jest.fn();
Expand Down
1 change: 1 addition & 0 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,6 +173,7 @@ export class Http implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
// No need to instrument if we don't want to track anything
if (!this._breadcrumbs && this._spans === false) {
Expand Down
2 changes: 1 addition & 1 deletion packages/node-experimental/src/sdk/globals.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ export function getGlobalCarrier(): SentryCarrier {
* Calls global extension method and binding current instance to the function call
*/
// @ts-expect-error Function lacks ending return statement and return type does not include 'undefined'. ts(2366)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// eslint-disable-next-line @typescript-eslint/no-explicit-any,deprecation/deprecation
export function callExtensionMethod<T>(hub: Hub, method: string, ...args: any[]): T {
const carrier = getGlobalCarrier();

Expand Down
3 changes: 3 additions & 0 deletions packages/node-experimental/src/sdk/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ export function setupGlobalHub(): void {
/**
* This is for legacy reasons, and returns a proxy object instead of a hub to be used.
*/
// eslint-disable-next-line deprecation/deprecation
export function getCurrentHub(): Hub {
return {
isOlderThan(_version: number): boolean {
Expand DownExpand Up@@ -88,6 +89,7 @@ export function getCurrentHub(): Hub {
// eslint-disable-next-line deprecation/deprecation
configureScope: configureScope,

// eslint-disable-next-line deprecation/deprecation
run(callback: (hub: Hub) => void): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return withScope(() => callback(this as any));
Expand DownExpand Up@@ -142,6 +144,7 @@ export function getCurrentHub(): Hub {
*
* @returns The old replaced hub
*/
// eslint-disable-next-line deprecation/deprecation
export function makeMain(hub: Hub): Hub {
// eslint-disable-next-line no-console
console.warn('makeMain is a noop in @sentry/node-experimental. Use `setCurrentClient` instead.');
Expand Down
2 changes: 2 additions & 0 deletions packages/node-experimental/src/sdk/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ export interface AsyncContextStrategy {
getScopes: () => CurrentScopes | undefined;

/** This is here for legacy reasons. */
// eslint-disable-next-line deprecation/deprecation
getCurrentHub: () => Hub;

/**
Expand All@@ -67,6 +68,7 @@ export interface SentryCarrier {
acs?: AsyncContextStrategy;

// hub is here for legacy reasons
// eslint-disable-next-line deprecation/deprecation
hub?: Hub;

extensions?: {
Expand Down
1 change: 1 addition & 0 deletions packages/node/test/eventbuilders.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ describe('eventFromUnknownInput', () => {
return { normalizeDepth: 6 };
},
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
});

Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry-node/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry-node/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/custom/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { uuid4 } from '@sentry/utils';
* This is a fork of core's tracing/hubextensions.ts _startTransaction,
* with some OTEL specifics.
*/
// eslint-disable-next-line deprecation/deprecation
export function startTransaction(hub: HubInterface, transactionContext: TransactionContext): Transaction {
// eslint-disable-next-line deprecation/deprecation
const client = hub.getClient();
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/utils/captureExceptionForTimedEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { isString } from '@sentry/utils';
* Maybe capture a Sentry exception for an OTEL timed event.
* This will check if the event is exception-like and in that case capture it as an exception.
*/
// eslint-disable-next-line deprecation/deprecation
export function maybeCaptureExceptionForTimedEvent(hub: Hub, event: TimedEvent, otelSpan?: OtelSpan): void {
if (event.name !== 'exception') {
return;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/contextData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,14 +23,17 @@ export function setPropagationContextOnContext(context: Context, propagationCont
* Try to get the Hub from the given OTEL context.
* This requires a Context Manager that was wrapped with getWrappedContextManager.
*/
// eslint-disable-next-line deprecation/deprecation
export function getHubFromContext(context: Context): Hub | undefined {
// eslint-disable-next-line deprecation/deprecation
return context.getValue(SENTRY_HUB_CONTEXT_KEY) as Hub | undefined;
}

/**
* Set a Hub on an OTEL context..
* This will return a forked context with the Propagation Context set.
*/
// eslint-disable-next-line deprecation/deprecation
export function setHubOnContext(context: Context, hub: Hub): Context {
return context.setValue(SENTRY_HUB_CONTEXT_KEY, hub);
}
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/utils/spanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { AbstractSpan } from '../types';
// and since we are using weakmaps, we do not need to clean up after ourselves
const SpanScope = new WeakMap<AbstractSpan, Scope>();
const SpanFinishScope = new WeakMap<AbstractSpan, Scope>();
// eslint-disable-next-line deprecation/deprecation
const SpanHub = new WeakMap<AbstractSpan, Hub>();
const SpanParent = new WeakMap<AbstractSpan, Span>();
const SpanMetadata = new WeakMap<AbstractSpan, Partial<TransactionMetadata>>();
Expand All@@ -23,11 +24,13 @@ export function getSpanScope(span: AbstractSpan): Scope | undefined {
}

/** Set the Sentry hub on an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function setSpanHub(span: AbstractSpan, hub: Hub): void {
SpanHub.set(span, hub);
}

/** Get the Sentry hub of an OTEL span. */
// eslint-disable-next-line deprecation/deprecation
export function getSpanHub(span: AbstractSpan): Hub | undefined {
return SpanHub.get(span);
}
Expand Down
5 changes: 5 additions & 0 deletions packages/opentelemetry/test/utils/captureExceptionForTimedEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -30,6 +31,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand All@@ -49,6 +51,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -76,6 +79,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event);
Expand DownExpand Up@@ -119,6 +123,7 @@ describe('maybeCaptureExceptionForTimedEvent', () => {
const captureException = jest.fn();
const hub = {
captureException,
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;

maybeCaptureExceptionForTimedEvent(hub, event, span);
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { isValidSampleRate } from './utils';
export const MAX_PROFILE_DURATION_MS = 30 * 1000;

type StartTransaction = (
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand DownExpand Up@@ -142,6 +143,7 @@ export function stopTransactionProfile(
*/
export function __PRIVATE__wrapStartTransactionWithProfiling(startTransaction: StartTransaction): StartTransaction {
return function wrappedStartTransaction(
// eslint-disable-next-line deprecation/deprecation
this: Hub,
transactionContext: TransactionContext,
customSamplingContext?: CustomSamplingContext,
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ export class ProfilingIntegration implements Integration {
* @inheritDoc
*/
public readonly name: string;
// eslint-disable-next-line deprecation/deprecation
public getCurrentHub?: () => Hub;

public constructor() {
Expand All@@ -64,6 +65,7 @@ export class ProfilingIntegration implements Integration {
/**
* @inheritDoc
*/
// eslint-disable-next-line deprecation/deprecation
public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
this.getCurrentHub = getCurrentHub;
// eslint-disable-next-line deprecation/deprecation
Expand Down
2 changes: 2 additions & 0 deletions packages/profiling-node/test/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ function makeHubMock({
}: {
profilesSampleRate: number | undefined;
client?: Partial<NodeClient>;
// eslint-disable-next-line deprecation/deprecation
}): Hub {
return {
getClient: jest.fn().mockImplementation(() => {
Expand All@@ -59,6 +60,7 @@ function makeHubMock({
...(client ?? {}),
};
}),
// eslint-disable-next-line deprecation/deprecation
} as unknown as Hub;
}

Expand Down
Loading