feat(core): Add client.getIntegrationByName()#10130

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
mydea merged 1 commit into from
Jan 15, 2024
Merged

feat(core): Add client.getIntegrationByName()#10130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,16 @@ but in v8 you will not be able to rely on this always existing anymore - any int
This should not affect most people, but in the case that you are manually calling `integration.setupOnce()` right now,
make sure to guard it's existence properly.

## Deprecate `getIntegration()` and `getIntegrationById()`

This deprecates `getIntegration()` on both the hub & the client, as well as `getIntegrationById()` on the baseclient.
Instead, use `getIntegrationByName()`. You can optionally pass an integration generic to make it easier to work with
typescript:

```ts
const replay = getClient().getIntegrationByName<Replay>('Replay');
```

## Deprecate `Hub`

The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency"
Expand Down
2 changes: 1 addition & 1 deletion ...ckages/browser-integration-tests/loader-suites/loader/onLoad/customBrowserTracing/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added BrowserTracing integration', async ({ get
expect(eventData.transaction_info?.source).toEqual('url');

const tracePropagationTargets = await page.evaluate(() => {
const browserTracing = (window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
const browserTracing = (window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
return browserTracing.options.tracePropagationTargets;
});

Expand Down
6 changes: 3 additions & 3 deletions ...packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrations/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,14 +24,14 @@ sentryTest('should handle custom added integrations & default integrations', asy
});

const hasCustomIntegration = await page.evaluate(() => {
return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
});

const hasReplay = await page.evaluate(() => {
return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
});
const hasBrowserTracing = await page.evaluate(() => {
return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
});

expect(hasCustomIntegration).toEqual(true);
Expand Down
6 changes: 3 additions & 3 deletions .../browser-integration-tests/loader-suites/loader/onLoad/customIntegrationsFunction/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,14 @@ sentryTest(
});

const hasCustomIntegration = await page.evaluate(() => {
return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
});

const hasReplay = await page.evaluate(() => {
return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
});
const hasBrowserTracing = await page.evaluate(() => {
return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
});

expect(hasCustomIntegration).toEqual(true);
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customReplay/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added Replay integration', async ({ getLocalTes
expect(eventData.segment_id).toBe(0);

const useCompression = await page.evaluate(() => {
const replay = (window as any).Sentry.getClient().getIntegrationById('Replay');
const replay = (window as any).Sentry.getClient().getIntegrationByName('Replay');
return replay._replay.getOptions().useCompression;
});

Expand Down
8 changes: 4 additions & 4 deletions packages/astro/test/client/sdk.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ describe('Sentry client SDK', () => {
});

const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
expect(browserTracing).toBeDefined();
Expand All@@ -77,7 +77,7 @@ describe('Sentry client SDK', () => {
});

const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
expect(browserTracing).toBeUndefined();
Expand All@@ -92,7 +92,7 @@ describe('Sentry client SDK', () => {
});

const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
expect(browserTracing).toBeUndefined();
Expand All@@ -109,7 +109,7 @@ describe('Sentry client SDK', () => {

const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;

const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing') as BrowserTracing;
const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
const options = browserTracing.options;

expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
Expand Down
15 changes: 13 additions & 2 deletions packages/core/src/baseclient.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -334,13 +334,24 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
* Gets an installed integration by its `id`.
*
* @returns The installed integration or `undefined` if no integration with that `id` was installed.
* @deprecated Use `getIntegrationByName()` instead.
*/
public getIntegrationById(integrationId: string): Integration | undefined {
return this._integrations[integrationId];
return this.getIntegrationByName(integrationId);
}

/**
* @inheritDoc
* Gets an installed integration by its name.
*
* @returns The installed integration or `undefined` if no integration with that `name` was installed.
*/
public getIntegrationByName<T extends Integration = Integration>(integrationName: string): T | undefined {
return this._integrations[integrationName] as T | undefined;
}

/**
* Returns the client's instance of the given integration class, it any.
* @deprecated Use `getIntegrationByName()` instead.
*/
public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
try {
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -472,13 +472,14 @@ export class Hub implements HubInterface {

/**
* @inheritDoc
* @deprecated Use `Sentry.getClient().getIntegration()` instead.
* @deprecated Use `Sentry.getClient().getIntegrationByName()` instead.
*/
public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
// eslint-disable-next-line deprecation/deprecation
const client = this.getClient();
if (!client) return null;
try {
// eslint-disable-next-line deprecation/deprecation
return client.getIntegration(integration);
} catch (_oO) {
DEBUG_BUILD && logger.warn(`Cannot retrieve integration ${integration.id} from the current Hub`);
Expand Down
16 changes: 8 additions & 8 deletions packages/core/test/lib/base.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1496,7 +1496,7 @@ describe('BaseClient', () => {
client.setupIntegrations();

expect(Object.keys((client as any)._integrations).length).toEqual(1);
expect(client.getIntegration(TestIntegration)).toBeTruthy();
expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
});

test('sets up each integration on `init` call', () => {
Expand All@@ -1507,7 +1507,7 @@ describe('BaseClient', () => {
client.init();

expect(Object.keys((client as any)._integrations).length).toEqual(1);
expect(client.getIntegration(TestIntegration)).toBeTruthy();
expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
});

test('skips installation for `setupIntegrations()` if DSN is not provided', () => {
Expand All@@ -1519,7 +1519,7 @@ describe('BaseClient', () => {
client.setupIntegrations();

expect(Object.keys((client as any)._integrations).length).toEqual(0);
expect(client.getIntegration(TestIntegration)).toBeFalsy();
expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
});

test('skips installation for `init()` if DSN is not provided', () => {
Expand All@@ -1530,7 +1530,7 @@ describe('BaseClient', () => {
client.init();

expect(Object.keys((client as any)._integrations).length).toEqual(0);
expect(client.getIntegration(TestIntegration)).toBeFalsy();
expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
});

test('skips installation for `setupIntegrations()` if `enabled` is set to `false`', () => {
Expand All@@ -1546,7 +1546,7 @@ describe('BaseClient', () => {
client.setupIntegrations();

expect(Object.keys((client as any)._integrations).length).toEqual(0);
expect(client.getIntegration(TestIntegration)).toBeFalsy();
expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
});

test('skips installation for `init()` if `enabled` is set to `false`', () => {
Expand All@@ -1561,7 +1561,7 @@ describe('BaseClient', () => {
client.init();

expect(Object.keys((client as any)._integrations).length).toEqual(0);
expect(client.getIntegration(TestIntegration)).toBeFalsy();
expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
});

test('skips installation if integrations are already installed', () => {
Expand All@@ -1577,7 +1577,7 @@ describe('BaseClient', () => {
client.setupIntegrations();

expect(Object.keys((client as any)._integrations).length).toEqual(1);
expect(client.getIntegration(TestIntegration)).toBeTruthy();
expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

// ...but it shouldn't try to install a second time
Expand All@@ -1597,7 +1597,7 @@ describe('BaseClient', () => {
client.init();

expect(Object.keys((client as any)._integrations).length).toEqual(1);
expect(client.getIntegration(TestIntegration)).toBeTruthy();
expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

client.init();
Expand Down
2 changes: 1 addition & 1 deletion packages/core/test/mocks/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export class TestIntegration implements Integration {

public setupOnce(): void {
const eventProcessor: EventProcessor = (event: Event) => {
if (!getClient()?.getIntegration(TestIntegration)) {
if (!getClient()?.getIntegrationByName?.('TestIntegration')) {
return event;
}

Expand Down
4 changes: 2 additions & 2 deletions packages/ember/addon/instance-initializers/sentry-performance.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -441,8 +441,8 @@ export async function instrumentForPerformance(appInstance: ApplicationInstance)

if (
client &&
(client as BrowserClient).getIntegrationById &&
(client as BrowserClient).getIntegrationById('BrowserTracing')
(client as BrowserClient).getIntegrationByName &&
(client as BrowserClient).getIntegrationByName('BrowserTracing')
) {
// Initializers are called more than once in tests, causing the integrations to not be setup correctly.
return;
Expand Down
6 changes: 3 additions & 3 deletions packages/ember/tests/acceptance/sentry-replay-test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { visit } from '@ember/test-helpers';
import * as Sentry from '@sentry/ember';
import type { ReplayContainer } from '@sentry/replay/build/npm/types/types';
import type { BrowserClient, Replay } from '@sentry/ember';
import { setupApplicationTest } from 'ember-qunit';
import { module, test } from 'qunit';

Expand All@@ -13,10 +13,10 @@ module('Acceptance | Sentry Session Replay', function (hooks) {
test('Test replay', async function (assert) {
await visit('/replay');

const integration = Sentry.getClient()?.getIntegration(Sentry.Replay);
const integration = Sentry.getClient<BrowserClient>()?.getIntegrationByName('Replay');
assert.ok(integration);

const replay = (integration as Sentry.Replay)['_replay'] as ReplayContainer;
const replay = (integration as Sentry.Replay)['_replay'] as Replay['_replay'];

assert.true(replay.isEnabled());
assert.false(replay.isPaused());
Expand Down
5 changes: 2 additions & 3 deletions packages/ember/tests/dummy/app/routes/replay.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,8 @@ import * as Sentry from '@sentry/ember';
export default class ReplayRoute extends Route {
public async beforeModel(): Promise<void> {
const { Replay } = Sentry;

if (!Sentry.getClient()!.getIntegration(Replay)) {
const client = Sentry.getClient() as BrowserClient;
const client = Sentry.getClient<BrowserClient>();
if (client && !client.getIntegrationByName('Replay')) {
client.addIntegration(new Replay());
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/feedback/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,7 @@ import {Feedback} from '@sentry-internal/feedback';

function MyFeedbackButton() {
const client = getCurrentHub().getClient<BrowserClient>();
const feedback = client?.getIntegration(Feedback);
const feedback = client?.getIntegrationByName('Feedback');

// Don't render custom feedback button if Feedback integration not installed
if (!feedback) {
Expand DownExpand Up@@ -258,7 +258,7 @@ import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

document.getElementById('my-feedback-form').addEventListener('submit', (event) => {
const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegration(Feedback);
const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegrationByName('Feedback');
const formData = new FormData(event.currentTarget);
feedback.sendFeedback(formData);
event.preventDefault();
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/src/offline.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ export class Offline implements Integration {
}

const eventProcessor: EventProcessor = event => {
// eslint-disable-next-line deprecation/deprecation
if (this.hub && this.hub.getIntegration(Offline)) {
// cache if we are positively offline
if ('navigator' in WINDOW && 'onLine' in WINDOW.navigator && !WINDOW.navigator.onLine) {
Expand Down
1 change: 1 addition & 0 deletions packages/node-experimental/src/sdk/hub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export function getCurrentHub(): Hub {
},

getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
// eslint-disable-next-line deprecation/deprecation
return getClient().getIntegration(integration);
},

Expand Down
8 changes: 4 additions & 4 deletions packages/node-experimental/src/sdk/spanProcessor.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { Span } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { SentrySpanProcessor, getClient, getSpanFinishScope } from '@sentry/opentelemetry';

import { Http } from '../integrations/http';
import { NodeFetch } from '../integrations/node-fetch';
import type { Http } from '../integrations/http';
import type { NodeFetch } from '../integrations/node-fetch';
import type { NodeExperimentalClient } from '../types';
import { getIsolationScope } from './api';
import { Scope } from './scope';
Expand DownExpand Up@@ -33,8 +33,8 @@ export class NodeExperimentalSentrySpanProcessor extends SentrySpanProcessor {
/** @inheritDoc */
protected _shouldSendSpanToSentry(span: Span): boolean {
const client = getClient<NodeExperimentalClient>();
const httpIntegration = client ? client.getIntegration(Http) : undefined;
const fetchIntegration = client ? client.getIntegration(NodeFetch) : undefined;
const httpIntegration = client ? client.getIntegrationByName<Http>('Http') : undefined;
const fetchIntegration = client ? client.getIntegrationByName<NodeFetch>('NodeFetch') : undefined;

// If we encounter a client or server span with url & method, we assume this comes from the http instrumentation
// In this case, if `shouldCreateSpansForRequests` is false, we want to _record_ the span but not _sample_ it,
Expand Down
8 changes: 4 additions & 4 deletions packages/node-experimental/test/integration/transactions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -512,8 +512,8 @@ describe('Integration | Transactions', () => {

const client = getClient() as NodeExperimentalClient;

jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
if (integrationClass.name === 'Http') {
jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
if (name === 'Http') {
return {
shouldCreateSpansForRequests: false,
} as Http;
Expand DownExpand Up@@ -576,8 +576,8 @@ describe('Integration | Transactions', () => {

const client = getClient() as NodeExperimentalClient;

jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
if (integrationClass.name === 'NodeFetch') {
jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
if (name === 'NodeFetch') {
return {
shouldCreateSpansForRequests: false,
} as NodeFetch;
Expand Down
3 changes: 3 additions & 0 deletions packages/node/src/integrations/undici/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,7 @@ export class Undici implements Integration {
}

private _onRequestCreate = (message: unknown): void => {
// eslint-disable-next-line deprecation/deprecation
if (!getClient()?.getIntegration(Undici)) {
return;
}
Expand DownExpand Up@@ -195,6 +196,7 @@ export class Undici implements Integration {
};

private _onRequestEnd = (message: unknown): void => {
// eslint-disable-next-line deprecation/deprecation
if (!getClient()?.getIntegration(Undici)) {
return;
}
Expand DownExpand Up@@ -234,6 +236,7 @@ export class Undici implements Integration {
};

private _onRequestError = (message: unknown): void => {
// eslint-disable-next-line deprecation/deprecation
if (!getClient()?.getIntegration(Undici)) {
return;
}
Expand Down
4 changes: 2 additions & 2 deletions packages/node/test/integrations/undici.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -417,7 +417,7 @@ function setupTestServer() {

function patchUndici(userOptions: Partial<UndiciOptions>): () => void {
try {
const undici = getClient()!.getIntegration(Undici);
const undici = getClient()!.getIntegrationByName!('Undici');
// @ts-expect-error need to access private property
options = { ...undici._options };
// @ts-expect-error need to access private property
Expand All@@ -428,7 +428,7 @@ function patchUndici(userOptions: Partial<UndiciOptions>): () => void {

return () => {
try {
const undici = getClient()!.getIntegration(Undici);
const undici = getClient()!.getIntegrationByName!('Undici');
// @ts-expect-error Need to override readonly property
undici!['_options'] = { ...options };
} catch (_) {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 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(core): Add client.getIntegrationByName()#10130

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

mydea
merged 1 commit into

from

Jan 15, 2024
 Merged


feat(core): Add client.getIntegrationByName()#10130
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,16 @@ but in v8 you will not be able to rely on this always existing anymore - any int
This should not affect most people, but in the case that you are manually calling `integration.setupOnce()` right now,
make sure to guard it's existence properly.

## Deprecate `getIntegration()` and `getIntegrationById()`

This deprecates `getIntegration()` on both the hub & the client, as well as `getIntegrationById()` on the baseclient.
Instead, use `getIntegrationByName()`. You can optionally pass an integration generic to make it easier to work with
typescript:

```ts
const replay = getClient().getIntegrationByName<Replay>('Replay');
```

## Deprecate `Hub`

The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency"
Expand Down

2 changes: 1 addition & 1 deletion
...ckages/browser-integration-tests/loader-suites/loader/onLoad/customBrowserTracing/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added BrowserTracing integration', async ({ get
 expect(eventData.transaction_info?.source).toEqual('url');

 const tracePropagationTargets = await page.evaluate(() => {
 const browserTracing = (window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 const browserTracing = (window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 return browserTracing.options.tracePropagationTargets;
 });

Expand Down

6 changes: 3 additions & 3 deletions
...packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrations/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,14 +24,14 @@ sentryTest('should handle custom added integrations & default integrations', asy
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

6 changes: 3 additions & 3 deletions
.../browser-integration-tests/loader-suites/loader/onLoad/customIntegrationsFunction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,14 @@ sentryTest(
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added Replay integration', async ({ getLocalTes
 expect(eventData.segment_id).toBe(0);

 const useCompression = await page.evaluate(() => {
 const replay = (window as any).Sentry.getClient().getIntegrationById('Replay');
 const replay = (window as any).Sentry.getClient().getIntegrationByName('Replay');
 return replay._replay.getOptions().useCompression;
 });

Expand Down

8 changes: 4 additions & 4 deletions
packages/astro/test/client/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeDefined();
Expand All@@ -77,7 +77,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -92,7 +92,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -109,7 +109,7 @@ describe('Sentry client SDK', () => {

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;

 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing') as BrowserTracing;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
 const options = browserTracing.options;

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
Expand Down

15 changes: 13 additions & 2 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -334,13 +334,24 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 * Gets an installed integration by its `id`.
 *
 * @returns The installed integration or `undefined` if no integration with that `id` was installed.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegrationById(integrationId: string): Integration | undefined {
 return this._integrations[integrationId];
 return this.getIntegrationByName(integrationId);
 }

 /**
 * @inheritDoc
 * Gets an installed integration by its name.
 *
 * @returns The installed integration or `undefined` if no integration with that `name` was installed.
 */
 public getIntegrationByName<T extends Integration = Integration>(integrationName: string): T | undefined {
 return this._integrations[integrationName] as T | undefined;
 }

 /**
 * Returns the client's instance of the given integration class, it any.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 try {
Expand Down

3 changes: 2 additions & 1 deletion
packages/core/src/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -472,13 +472,14 @@ export class Hub implements HubInterface {

 /**
 * @inheritDoc
 * @deprecated Use `Sentry.getClient().getIntegration()` instead.
 * @deprecated Use `Sentry.getClient().getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 const client = this.getClient();
 if (!client) return null;
 try {
 // eslint-disable-next-line deprecation/deprecation
 return client.getIntegration(integration);
 } catch (_oO) {
 DEBUG_BUILD && logger.warn(`Cannot retrieve integration ${integration.id} from the current Hub`);
Expand Down

16 changes: 8 additions & 8 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1496,7 +1496,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('sets up each integration on `init` call', () => {
Expand All@@ -1507,7 +1507,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('skips installation for `setupIntegrations()` if DSN is not provided', () => {
Expand All@@ -1519,7 +1519,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if DSN is not provided', () => {
Expand All@@ -1530,7 +1530,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `setupIntegrations()` if `enabled` is set to `false`', () => {
Expand All@@ -1546,7 +1546,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if `enabled` is set to `false`', () => {
Expand All@@ -1561,7 +1561,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation if integrations are already installed', () => {
Expand All@@ -1577,7 +1577,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 // ...but it shouldn't try to install a second time
Expand All@@ -1597,7 +1597,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 client.init();
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/test/mocks/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export class TestIntegration implements Integration {

 public setupOnce(): void {
 const eventProcessor: EventProcessor = (event: Event) => {
 if (!getClient()?.getIntegration(TestIntegration)) {
 if (!getClient()?.getIntegrationByName?.('TestIntegration')) {
 return event;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/ember/addon/instance-initializers/sentry-performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,8 +441,8 @@ export async function instrumentForPerformance(appInstance: ApplicationInstance)

 if (
 client &&
 (client as BrowserClient).getIntegrationById &&
 (client as BrowserClient).getIntegrationById('BrowserTracing')
 (client as BrowserClient).getIntegrationByName &&
 (client as BrowserClient).getIntegrationByName('BrowserTracing')
 ) {
 // Initializers are called more than once in tests, causing the integrations to not be setup correctly.
 return;
Expand Down

6 changes: 3 additions & 3 deletions
packages/ember/tests/acceptance/sentry-replay-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { visit } from '@ember/test-helpers';
import * as Sentry from '@sentry/ember';
import type { ReplayContainer } from '@sentry/replay/build/npm/types/types';
import type { BrowserClient, Replay } from '@sentry/ember';
import { setupApplicationTest } from 'ember-qunit';
import { module, test } from 'qunit';

Expand All@@ -13,10 +13,10 @@ module('Acceptance | Sentry Session Replay', function (hooks) {
 test('Test replay', async function (assert) {
 await visit('/replay');

 const integration = Sentry.getClient()?.getIntegration(Sentry.Replay);
 const integration = Sentry.getClient<BrowserClient>()?.getIntegrationByName('Replay');
 assert.ok(integration);

 const replay = (integration as Sentry.Replay)['_replay'] as ReplayContainer;
 const replay = (integration as Sentry.Replay)['_replay'] as Replay['_replay'];

 assert.true(replay.isEnabled());
 assert.false(replay.isPaused());
Expand Down

5 changes: 2 additions & 3 deletions
packages/ember/tests/dummy/app/routes/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,8 @@ import * as Sentry from '@sentry/ember';
export default class ReplayRoute extends Route {
 public async beforeModel(): Promise<void> {
 const { Replay } = Sentry;

 if (!Sentry.getClient()!.getIntegration(Replay)) {
 const client = Sentry.getClient() as BrowserClient;
 const client = Sentry.getClient<BrowserClient>();
 if (client && !client.getIntegrationByName('Replay')) {
 client.addIntegration(new Replay());
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/feedback/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,7 @@ import {Feedback} from '@sentry-internal/feedback';

function MyFeedbackButton() {
 const client = getCurrentHub().getClient<BrowserClient>();
 const feedback = client?.getIntegration(Feedback);
 const feedback = client?.getIntegrationByName('Feedback');

 // Don't render custom feedback button if Feedback integration not installed
 if (!feedback) {
Expand DownExpand Up@@ -258,7 +258,7 @@ import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

document.getElementById('my-feedback-form').addEventListener('submit', (event) => {
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegration(Feedback);
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegrationByName('Feedback');
 const formData = new FormData(event.currentTarget);
 feedback.sendFeedback(formData);
 event.preventDefault();
Expand Down

1 change: 1 addition & 0 deletions
packages/integrations/src/offline.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ export class Offline implements Integration {
 }

 const eventProcessor: EventProcessor = event => {
 // eslint-disable-next-line deprecation/deprecation
 if (this.hub && this.hub.getIntegration(Offline)) {
 // cache if we are positively offline
 if ('navigator' in WINDOW && 'onLine' in WINDOW.navigator && !WINDOW.navigator.onLine) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node-experimental/src/sdk/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export function getCurrentHub(): Hub {
 },

 getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 return getClient().getIntegration(integration);
 },

Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/src/sdk/spanProcessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { Span } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { SentrySpanProcessor, getClient, getSpanFinishScope } from '@sentry/opentelemetry';

import { Http } from '../integrations/http';
import { NodeFetch } from '../integrations/node-fetch';
import type { Http } from '../integrations/http';
import type { NodeFetch } from '../integrations/node-fetch';
import type { NodeExperimentalClient } from '../types';
import { getIsolationScope } from './api';
import { Scope } from './scope';
Expand DownExpand Up@@ -33,8 +33,8 @@ export class NodeExperimentalSentrySpanProcessor extends SentrySpanProcessor {
 /** @inheritDoc */
 protected _shouldSendSpanToSentry(span: Span): boolean {
 const client = getClient<NodeExperimentalClient>();
 const httpIntegration = client ? client.getIntegration(Http) : undefined;
 const fetchIntegration = client ? client.getIntegration(NodeFetch) : undefined;
 const httpIntegration = client ? client.getIntegrationByName<Http>('Http') : undefined;
 const fetchIntegration = client ? client.getIntegrationByName<NodeFetch>('NodeFetch') : undefined;

 // If we encounter a client or server span with url & method, we assume this comes from the http instrumentation
 // In this case, if `shouldCreateSpansForRequests` is false, we want to _record_ the span but not _sample_ it,
Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/test/integration/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -512,8 +512,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'Http') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'Http') {
 return {
 shouldCreateSpansForRequests: false,
 } as Http;
Expand DownExpand Up@@ -576,8 +576,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'NodeFetch') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'NodeFetch') {
 return {
 shouldCreateSpansForRequests: false,
 } as NodeFetch;
Expand Down

3 changes: 3 additions & 0 deletions
packages/node/src/integrations/undici/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,7 @@ export class Undici implements Integration {
 }

 private _onRequestCreate = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -195,6 +196,7 @@ export class Undici implements Integration {
 };

 private _onRequestEnd = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -234,6 +236,7 @@ export class Undici implements Integration {
 };

 private _onRequestError = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/node/test/integrations/undici.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -417,7 +417,7 @@ function setupTestServer() {

function patchUndici(userOptions: Partial<UndiciOptions>): () => void {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error need to access private property
 options = { ...undici._options };
 // @ts-expect-error need to access private property
Expand All@@ -428,7 +428,7 @@ function patchUndici(userOptions: Partial<UndiciOptions>): () => void {

 return () => {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error Need to override readonly property
 undici!['_options'] = { ...options };
 } catch (_) {
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(core): Add client.getIntegrationByName()#10130

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

mydea
merged 1 commit into

from

Jan 15, 2024
 Merged


feat(core): Add client.getIntegrationByName()#10130
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,16 @@ but in v8 you will not be able to rely on this always existing anymore - any int
This should not affect most people, but in the case that you are manually calling `integration.setupOnce()` right now,
make sure to guard it's existence properly.

## Deprecate `getIntegration()` and `getIntegrationById()`

This deprecates `getIntegration()` on both the hub & the client, as well as `getIntegrationById()` on the baseclient.
Instead, use `getIntegrationByName()`. You can optionally pass an integration generic to make it easier to work with
typescript:

```ts
const replay = getClient().getIntegrationByName<Replay>('Replay');
```

## Deprecate `Hub`

The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency"
Expand Down

2 changes: 1 addition & 1 deletion
...ckages/browser-integration-tests/loader-suites/loader/onLoad/customBrowserTracing/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added BrowserTracing integration', async ({ get
 expect(eventData.transaction_info?.source).toEqual('url');

 const tracePropagationTargets = await page.evaluate(() => {
 const browserTracing = (window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 const browserTracing = (window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 return browserTracing.options.tracePropagationTargets;
 });

Expand Down

6 changes: 3 additions & 3 deletions
...packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrations/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,14 +24,14 @@ sentryTest('should handle custom added integrations & default integrations', asy
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

6 changes: 3 additions & 3 deletions
.../browser-integration-tests/loader-suites/loader/onLoad/customIntegrationsFunction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,14 @@ sentryTest(
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added Replay integration', async ({ getLocalTes
 expect(eventData.segment_id).toBe(0);

 const useCompression = await page.evaluate(() => {
 const replay = (window as any).Sentry.getClient().getIntegrationById('Replay');
 const replay = (window as any).Sentry.getClient().getIntegrationByName('Replay');
 return replay._replay.getOptions().useCompression;
 });

Expand Down

8 changes: 4 additions & 4 deletions
packages/astro/test/client/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeDefined();
Expand All@@ -77,7 +77,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -92,7 +92,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -109,7 +109,7 @@ describe('Sentry client SDK', () => {

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;

 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing') as BrowserTracing;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
 const options = browserTracing.options;

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
Expand Down

15 changes: 13 additions & 2 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -334,13 +334,24 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 * Gets an installed integration by its `id`.
 *
 * @returns The installed integration or `undefined` if no integration with that `id` was installed.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegrationById(integrationId: string): Integration | undefined {
 return this._integrations[integrationId];
 return this.getIntegrationByName(integrationId);
 }

 /**
 * @inheritDoc
 * Gets an installed integration by its name.
 *
 * @returns The installed integration or `undefined` if no integration with that `name` was installed.
 */
 public getIntegrationByName<T extends Integration = Integration>(integrationName: string): T | undefined {
 return this._integrations[integrationName] as T | undefined;
 }

 /**
 * Returns the client's instance of the given integration class, it any.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 try {
Expand Down

3 changes: 2 additions & 1 deletion
packages/core/src/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -472,13 +472,14 @@ export class Hub implements HubInterface {

 /**
 * @inheritDoc
 * @deprecated Use `Sentry.getClient().getIntegration()` instead.
 * @deprecated Use `Sentry.getClient().getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 const client = this.getClient();
 if (!client) return null;
 try {
 // eslint-disable-next-line deprecation/deprecation
 return client.getIntegration(integration);
 } catch (_oO) {
 DEBUG_BUILD && logger.warn(`Cannot retrieve integration ${integration.id} from the current Hub`);
Expand Down

16 changes: 8 additions & 8 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1496,7 +1496,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('sets up each integration on `init` call', () => {
Expand All@@ -1507,7 +1507,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('skips installation for `setupIntegrations()` if DSN is not provided', () => {
Expand All@@ -1519,7 +1519,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if DSN is not provided', () => {
Expand All@@ -1530,7 +1530,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `setupIntegrations()` if `enabled` is set to `false`', () => {
Expand All@@ -1546,7 +1546,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if `enabled` is set to `false`', () => {
Expand All@@ -1561,7 +1561,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation if integrations are already installed', () => {
Expand All@@ -1577,7 +1577,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 // ...but it shouldn't try to install a second time
Expand All@@ -1597,7 +1597,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 client.init();
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/test/mocks/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export class TestIntegration implements Integration {

 public setupOnce(): void {
 const eventProcessor: EventProcessor = (event: Event) => {
 if (!getClient()?.getIntegration(TestIntegration)) {
 if (!getClient()?.getIntegrationByName?.('TestIntegration')) {
 return event;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/ember/addon/instance-initializers/sentry-performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,8 +441,8 @@ export async function instrumentForPerformance(appInstance: ApplicationInstance)

 if (
 client &&
 (client as BrowserClient).getIntegrationById &&
 (client as BrowserClient).getIntegrationById('BrowserTracing')
 (client as BrowserClient).getIntegrationByName &&
 (client as BrowserClient).getIntegrationByName('BrowserTracing')
 ) {
 // Initializers are called more than once in tests, causing the integrations to not be setup correctly.
 return;
Expand Down

6 changes: 3 additions & 3 deletions
packages/ember/tests/acceptance/sentry-replay-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { visit } from '@ember/test-helpers';
import * as Sentry from '@sentry/ember';
import type { ReplayContainer } from '@sentry/replay/build/npm/types/types';
import type { BrowserClient, Replay } from '@sentry/ember';
import { setupApplicationTest } from 'ember-qunit';
import { module, test } from 'qunit';

Expand All@@ -13,10 +13,10 @@ module('Acceptance | Sentry Session Replay', function (hooks) {
 test('Test replay', async function (assert) {
 await visit('/replay');

 const integration = Sentry.getClient()?.getIntegration(Sentry.Replay);
 const integration = Sentry.getClient<BrowserClient>()?.getIntegrationByName('Replay');
 assert.ok(integration);

 const replay = (integration as Sentry.Replay)['_replay'] as ReplayContainer;
 const replay = (integration as Sentry.Replay)['_replay'] as Replay['_replay'];

 assert.true(replay.isEnabled());
 assert.false(replay.isPaused());
Expand Down

5 changes: 2 additions & 3 deletions
packages/ember/tests/dummy/app/routes/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,8 @@ import * as Sentry from '@sentry/ember';
export default class ReplayRoute extends Route {
 public async beforeModel(): Promise<void> {
 const { Replay } = Sentry;

 if (!Sentry.getClient()!.getIntegration(Replay)) {
 const client = Sentry.getClient() as BrowserClient;
 const client = Sentry.getClient<BrowserClient>();
 if (client && !client.getIntegrationByName('Replay')) {
 client.addIntegration(new Replay());
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/feedback/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,7 @@ import {Feedback} from '@sentry-internal/feedback';

function MyFeedbackButton() {
 const client = getCurrentHub().getClient<BrowserClient>();
 const feedback = client?.getIntegration(Feedback);
 const feedback = client?.getIntegrationByName('Feedback');

 // Don't render custom feedback button if Feedback integration not installed
 if (!feedback) {
Expand DownExpand Up@@ -258,7 +258,7 @@ import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

document.getElementById('my-feedback-form').addEventListener('submit', (event) => {
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegration(Feedback);
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegrationByName('Feedback');
 const formData = new FormData(event.currentTarget);
 feedback.sendFeedback(formData);
 event.preventDefault();
Expand Down

1 change: 1 addition & 0 deletions
packages/integrations/src/offline.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ export class Offline implements Integration {
 }

 const eventProcessor: EventProcessor = event => {
 // eslint-disable-next-line deprecation/deprecation
 if (this.hub && this.hub.getIntegration(Offline)) {
 // cache if we are positively offline
 if ('navigator' in WINDOW && 'onLine' in WINDOW.navigator && !WINDOW.navigator.onLine) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node-experimental/src/sdk/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export function getCurrentHub(): Hub {
 },

 getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 return getClient().getIntegration(integration);
 },

Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/src/sdk/spanProcessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { Span } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { SentrySpanProcessor, getClient, getSpanFinishScope } from '@sentry/opentelemetry';

import { Http } from '../integrations/http';
import { NodeFetch } from '../integrations/node-fetch';
import type { Http } from '../integrations/http';
import type { NodeFetch } from '../integrations/node-fetch';
import type { NodeExperimentalClient } from '../types';
import { getIsolationScope } from './api';
import { Scope } from './scope';
Expand DownExpand Up@@ -33,8 +33,8 @@ export class NodeExperimentalSentrySpanProcessor extends SentrySpanProcessor {
 /** @inheritDoc */
 protected _shouldSendSpanToSentry(span: Span): boolean {
 const client = getClient<NodeExperimentalClient>();
 const httpIntegration = client ? client.getIntegration(Http) : undefined;
 const fetchIntegration = client ? client.getIntegration(NodeFetch) : undefined;
 const httpIntegration = client ? client.getIntegrationByName<Http>('Http') : undefined;
 const fetchIntegration = client ? client.getIntegrationByName<NodeFetch>('NodeFetch') : undefined;

 // If we encounter a client or server span with url & method, we assume this comes from the http instrumentation
 // In this case, if `shouldCreateSpansForRequests` is false, we want to _record_ the span but not _sample_ it,
Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/test/integration/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -512,8 +512,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'Http') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'Http') {
 return {
 shouldCreateSpansForRequests: false,
 } as Http;
Expand DownExpand Up@@ -576,8 +576,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'NodeFetch') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'NodeFetch') {
 return {
 shouldCreateSpansForRequests: false,
 } as NodeFetch;
Expand Down

3 changes: 3 additions & 0 deletions
packages/node/src/integrations/undici/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,7 @@ export class Undici implements Integration {
 }

 private _onRequestCreate = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -195,6 +196,7 @@ export class Undici implements Integration {
 };

 private _onRequestEnd = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -234,6 +236,7 @@ export class Undici implements Integration {
 };

 private _onRequestError = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/node/test/integrations/undici.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -417,7 +417,7 @@ function setupTestServer() {

function patchUndici(userOptions: Partial<UndiciOptions>): () => void {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error need to access private property
 options = { ...undici._options };
 // @ts-expect-error need to access private property
Expand All@@ -428,7 +428,7 @@ function patchUndici(userOptions: Partial<UndiciOptions>): () => void {

 return () => {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error Need to override readonly property
 undici!['_options'] = { ...options };
 } catch (_) {
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 > 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(core): Add client.getIntegrationByName()#10130

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

mydea
merged 1 commit into

from

Jan 15, 2024
 Merged


feat(core): Add client.getIntegrationByName()#10130
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,16 @@ but in v8 you will not be able to rely on this always existing anymore - any int
This should not affect most people, but in the case that you are manually calling `integration.setupOnce()` right now,
make sure to guard it's existence properly.

## Deprecate `getIntegration()` and `getIntegrationById()`

This deprecates `getIntegration()` on both the hub & the client, as well as `getIntegrationById()` on the baseclient.
Instead, use `getIntegrationByName()`. You can optionally pass an integration generic to make it easier to work with
typescript:

```ts
const replay = getClient().getIntegrationByName<Replay>('Replay');
```

## Deprecate `Hub`

The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency"
Expand Down

2 changes: 1 addition & 1 deletion
...ckages/browser-integration-tests/loader-suites/loader/onLoad/customBrowserTracing/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added BrowserTracing integration', async ({ get
 expect(eventData.transaction_info?.source).toEqual('url');

 const tracePropagationTargets = await page.evaluate(() => {
 const browserTracing = (window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 const browserTracing = (window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 return browserTracing.options.tracePropagationTargets;
 });

Expand Down

6 changes: 3 additions & 3 deletions
...packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrations/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,14 +24,14 @@ sentryTest('should handle custom added integrations & default integrations', asy
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

6 changes: 3 additions & 3 deletions
.../browser-integration-tests/loader-suites/loader/onLoad/customIntegrationsFunction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,14 @@ sentryTest(
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added Replay integration', async ({ getLocalTes
 expect(eventData.segment_id).toBe(0);

 const useCompression = await page.evaluate(() => {
 const replay = (window as any).Sentry.getClient().getIntegrationById('Replay');
 const replay = (window as any).Sentry.getClient().getIntegrationByName('Replay');
 return replay._replay.getOptions().useCompression;
 });

Expand Down

8 changes: 4 additions & 4 deletions
packages/astro/test/client/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeDefined();
Expand All@@ -77,7 +77,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -92,7 +92,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -109,7 +109,7 @@ describe('Sentry client SDK', () => {

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;

 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing') as BrowserTracing;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
 const options = browserTracing.options;

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
Expand Down

15 changes: 13 additions & 2 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -334,13 +334,24 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 * Gets an installed integration by its `id`.
 *
 * @returns The installed integration or `undefined` if no integration with that `id` was installed.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegrationById(integrationId: string): Integration | undefined {
 return this._integrations[integrationId];
 return this.getIntegrationByName(integrationId);
 }

 /**
 * @inheritDoc
 * Gets an installed integration by its name.
 *
 * @returns The installed integration or `undefined` if no integration with that `name` was installed.
 */
 public getIntegrationByName<T extends Integration = Integration>(integrationName: string): T | undefined {
 return this._integrations[integrationName] as T | undefined;
 }

 /**
 * Returns the client's instance of the given integration class, it any.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 try {
Expand Down

3 changes: 2 additions & 1 deletion
packages/core/src/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -472,13 +472,14 @@ export class Hub implements HubInterface {

 /**
 * @inheritDoc
 * @deprecated Use `Sentry.getClient().getIntegration()` instead.
 * @deprecated Use `Sentry.getClient().getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 const client = this.getClient();
 if (!client) return null;
 try {
 // eslint-disable-next-line deprecation/deprecation
 return client.getIntegration(integration);
 } catch (_oO) {
 DEBUG_BUILD && logger.warn(`Cannot retrieve integration ${integration.id} from the current Hub`);
Expand Down

16 changes: 8 additions & 8 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1496,7 +1496,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('sets up each integration on `init` call', () => {
Expand All@@ -1507,7 +1507,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('skips installation for `setupIntegrations()` if DSN is not provided', () => {
Expand All@@ -1519,7 +1519,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if DSN is not provided', () => {
Expand All@@ -1530,7 +1530,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `setupIntegrations()` if `enabled` is set to `false`', () => {
Expand All@@ -1546,7 +1546,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if `enabled` is set to `false`', () => {
Expand All@@ -1561,7 +1561,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation if integrations are already installed', () => {
Expand All@@ -1577,7 +1577,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 // ...but it shouldn't try to install a second time
Expand All@@ -1597,7 +1597,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 client.init();
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/test/mocks/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export class TestIntegration implements Integration {

 public setupOnce(): void {
 const eventProcessor: EventProcessor = (event: Event) => {
 if (!getClient()?.getIntegration(TestIntegration)) {
 if (!getClient()?.getIntegrationByName?.('TestIntegration')) {
 return event;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/ember/addon/instance-initializers/sentry-performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,8 +441,8 @@ export async function instrumentForPerformance(appInstance: ApplicationInstance)

 if (
 client &&
 (client as BrowserClient).getIntegrationById &&
 (client as BrowserClient).getIntegrationById('BrowserTracing')
 (client as BrowserClient).getIntegrationByName &&
 (client as BrowserClient).getIntegrationByName('BrowserTracing')
 ) {
 // Initializers are called more than once in tests, causing the integrations to not be setup correctly.
 return;
Expand Down

6 changes: 3 additions & 3 deletions
packages/ember/tests/acceptance/sentry-replay-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { visit } from '@ember/test-helpers';
import * as Sentry from '@sentry/ember';
import type { ReplayContainer } from '@sentry/replay/build/npm/types/types';
import type { BrowserClient, Replay } from '@sentry/ember';
import { setupApplicationTest } from 'ember-qunit';
import { module, test } from 'qunit';

Expand All@@ -13,10 +13,10 @@ module('Acceptance | Sentry Session Replay', function (hooks) {
 test('Test replay', async function (assert) {
 await visit('/replay');

 const integration = Sentry.getClient()?.getIntegration(Sentry.Replay);
 const integration = Sentry.getClient<BrowserClient>()?.getIntegrationByName('Replay');
 assert.ok(integration);

 const replay = (integration as Sentry.Replay)['_replay'] as ReplayContainer;
 const replay = (integration as Sentry.Replay)['_replay'] as Replay['_replay'];

 assert.true(replay.isEnabled());
 assert.false(replay.isPaused());
Expand Down

5 changes: 2 additions & 3 deletions
packages/ember/tests/dummy/app/routes/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,8 @@ import * as Sentry from '@sentry/ember';
export default class ReplayRoute extends Route {
 public async beforeModel(): Promise<void> {
 const { Replay } = Sentry;

 if (!Sentry.getClient()!.getIntegration(Replay)) {
 const client = Sentry.getClient() as BrowserClient;
 const client = Sentry.getClient<BrowserClient>();
 if (client && !client.getIntegrationByName('Replay')) {
 client.addIntegration(new Replay());
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/feedback/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,7 @@ import {Feedback} from '@sentry-internal/feedback';

function MyFeedbackButton() {
 const client = getCurrentHub().getClient<BrowserClient>();
 const feedback = client?.getIntegration(Feedback);
 const feedback = client?.getIntegrationByName('Feedback');

 // Don't render custom feedback button if Feedback integration not installed
 if (!feedback) {
Expand DownExpand Up@@ -258,7 +258,7 @@ import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

document.getElementById('my-feedback-form').addEventListener('submit', (event) => {
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegration(Feedback);
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegrationByName('Feedback');
 const formData = new FormData(event.currentTarget);
 feedback.sendFeedback(formData);
 event.preventDefault();
Expand Down

1 change: 1 addition & 0 deletions
packages/integrations/src/offline.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ export class Offline implements Integration {
 }

 const eventProcessor: EventProcessor = event => {
 // eslint-disable-next-line deprecation/deprecation
 if (this.hub && this.hub.getIntegration(Offline)) {
 // cache if we are positively offline
 if ('navigator' in WINDOW && 'onLine' in WINDOW.navigator && !WINDOW.navigator.onLine) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node-experimental/src/sdk/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export function getCurrentHub(): Hub {
 },

 getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 return getClient().getIntegration(integration);
 },

Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/src/sdk/spanProcessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { Span } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { SentrySpanProcessor, getClient, getSpanFinishScope } from '@sentry/opentelemetry';

import { Http } from '../integrations/http';
import { NodeFetch } from '../integrations/node-fetch';
import type { Http } from '../integrations/http';
import type { NodeFetch } from '../integrations/node-fetch';
import type { NodeExperimentalClient } from '../types';
import { getIsolationScope } from './api';
import { Scope } from './scope';
Expand DownExpand Up@@ -33,8 +33,8 @@ export class NodeExperimentalSentrySpanProcessor extends SentrySpanProcessor {
 /** @inheritDoc */
 protected _shouldSendSpanToSentry(span: Span): boolean {
 const client = getClient<NodeExperimentalClient>();
 const httpIntegration = client ? client.getIntegration(Http) : undefined;
 const fetchIntegration = client ? client.getIntegration(NodeFetch) : undefined;
 const httpIntegration = client ? client.getIntegrationByName<Http>('Http') : undefined;
 const fetchIntegration = client ? client.getIntegrationByName<NodeFetch>('NodeFetch') : undefined;

 // If we encounter a client or server span with url & method, we assume this comes from the http instrumentation
 // In this case, if `shouldCreateSpansForRequests` is false, we want to _record_ the span but not _sample_ it,
Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/test/integration/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -512,8 +512,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'Http') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'Http') {
 return {
 shouldCreateSpansForRequests: false,
 } as Http;
Expand DownExpand Up@@ -576,8 +576,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'NodeFetch') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'NodeFetch') {
 return {
 shouldCreateSpansForRequests: false,
 } as NodeFetch;
Expand Down

3 changes: 3 additions & 0 deletions
packages/node/src/integrations/undici/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,7 @@ export class Undici implements Integration {
 }

 private _onRequestCreate = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -195,6 +196,7 @@ export class Undici implements Integration {
 };

 private _onRequestEnd = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -234,6 +236,7 @@ export class Undici implements Integration {
 };

 private _onRequestError = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/node/test/integrations/undici.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -417,7 +417,7 @@ function setupTestServer() {

function patchUndici(userOptions: Partial<UndiciOptions>): () => void {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error need to access private property
 options = { ...undici._options };
 // @ts-expect-error need to access private property
Expand All@@ -428,7 +428,7 @@ function patchUndici(userOptions: Partial<UndiciOptions>): () => void {

 return () => {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error Need to override readonly property
 undici!['_options'] = { ...options };
 } catch (_) {
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(core): Add client.getIntegrationByName()#10130

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

mydea
merged 1 commit into

from

Jan 15, 2024
 Merged


feat(core): Add client.getIntegrationByName()#10130
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,16 @@ but in v8 you will not be able to rely on this always existing anymore - any int
This should not affect most people, but in the case that you are manually calling `integration.setupOnce()` right now,
make sure to guard it's existence properly.

## Deprecate `getIntegration()` and `getIntegrationById()`

This deprecates `getIntegration()` on both the hub & the client, as well as `getIntegrationById()` on the baseclient.
Instead, use `getIntegrationByName()`. You can optionally pass an integration generic to make it easier to work with
typescript:

```ts
const replay = getClient().getIntegrationByName<Replay>('Replay');
```

## Deprecate `Hub`

The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency"
Expand Down

2 changes: 1 addition & 1 deletion
...ckages/browser-integration-tests/loader-suites/loader/onLoad/customBrowserTracing/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added BrowserTracing integration', async ({ get
 expect(eventData.transaction_info?.source).toEqual('url');

 const tracePropagationTargets = await page.evaluate(() => {
 const browserTracing = (window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 const browserTracing = (window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 return browserTracing.options.tracePropagationTargets;
 });

Expand Down

6 changes: 3 additions & 3 deletions
...packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrations/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,14 +24,14 @@ sentryTest('should handle custom added integrations & default integrations', asy
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

6 changes: 3 additions & 3 deletions
.../browser-integration-tests/loader-suites/loader/onLoad/customIntegrationsFunction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,14 @@ sentryTest(
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added Replay integration', async ({ getLocalTes
 expect(eventData.segment_id).toBe(0);

 const useCompression = await page.evaluate(() => {
 const replay = (window as any).Sentry.getClient().getIntegrationById('Replay');
 const replay = (window as any).Sentry.getClient().getIntegrationByName('Replay');
 return replay._replay.getOptions().useCompression;
 });

Expand Down

8 changes: 4 additions & 4 deletions
packages/astro/test/client/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeDefined();
Expand All@@ -77,7 +77,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -92,7 +92,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -109,7 +109,7 @@ describe('Sentry client SDK', () => {

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;

 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing') as BrowserTracing;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
 const options = browserTracing.options;

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
Expand Down

15 changes: 13 additions & 2 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -334,13 +334,24 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 * Gets an installed integration by its `id`.
 *
 * @returns The installed integration or `undefined` if no integration with that `id` was installed.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegrationById(integrationId: string): Integration | undefined {
 return this._integrations[integrationId];
 return this.getIntegrationByName(integrationId);
 }

 /**
 * @inheritDoc
 * Gets an installed integration by its name.
 *
 * @returns The installed integration or `undefined` if no integration with that `name` was installed.
 */
 public getIntegrationByName<T extends Integration = Integration>(integrationName: string): T | undefined {
 return this._integrations[integrationName] as T | undefined;
 }

 /**
 * Returns the client's instance of the given integration class, it any.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 try {
Expand Down

3 changes: 2 additions & 1 deletion
packages/core/src/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -472,13 +472,14 @@ export class Hub implements HubInterface {

 /**
 * @inheritDoc
 * @deprecated Use `Sentry.getClient().getIntegration()` instead.
 * @deprecated Use `Sentry.getClient().getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 const client = this.getClient();
 if (!client) return null;
 try {
 // eslint-disable-next-line deprecation/deprecation
 return client.getIntegration(integration);
 } catch (_oO) {
 DEBUG_BUILD && logger.warn(`Cannot retrieve integration ${integration.id} from the current Hub`);
Expand Down

16 changes: 8 additions & 8 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1496,7 +1496,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('sets up each integration on `init` call', () => {
Expand All@@ -1507,7 +1507,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('skips installation for `setupIntegrations()` if DSN is not provided', () => {
Expand All@@ -1519,7 +1519,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if DSN is not provided', () => {
Expand All@@ -1530,7 +1530,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `setupIntegrations()` if `enabled` is set to `false`', () => {
Expand All@@ -1546,7 +1546,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if `enabled` is set to `false`', () => {
Expand All@@ -1561,7 +1561,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation if integrations are already installed', () => {
Expand All@@ -1577,7 +1577,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 // ...but it shouldn't try to install a second time
Expand All@@ -1597,7 +1597,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 client.init();
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/test/mocks/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export class TestIntegration implements Integration {

 public setupOnce(): void {
 const eventProcessor: EventProcessor = (event: Event) => {
 if (!getClient()?.getIntegration(TestIntegration)) {
 if (!getClient()?.getIntegrationByName?.('TestIntegration')) {
 return event;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/ember/addon/instance-initializers/sentry-performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,8 +441,8 @@ export async function instrumentForPerformance(appInstance: ApplicationInstance)

 if (
 client &&
 (client as BrowserClient).getIntegrationById &&
 (client as BrowserClient).getIntegrationById('BrowserTracing')
 (client as BrowserClient).getIntegrationByName &&
 (client as BrowserClient).getIntegrationByName('BrowserTracing')
 ) {
 // Initializers are called more than once in tests, causing the integrations to not be setup correctly.
 return;
Expand Down

6 changes: 3 additions & 3 deletions
packages/ember/tests/acceptance/sentry-replay-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { visit } from '@ember/test-helpers';
import * as Sentry from '@sentry/ember';
import type { ReplayContainer } from '@sentry/replay/build/npm/types/types';
import type { BrowserClient, Replay } from '@sentry/ember';
import { setupApplicationTest } from 'ember-qunit';
import { module, test } from 'qunit';

Expand All@@ -13,10 +13,10 @@ module('Acceptance | Sentry Session Replay', function (hooks) {
 test('Test replay', async function (assert) {
 await visit('/replay');

 const integration = Sentry.getClient()?.getIntegration(Sentry.Replay);
 const integration = Sentry.getClient<BrowserClient>()?.getIntegrationByName('Replay');
 assert.ok(integration);

 const replay = (integration as Sentry.Replay)['_replay'] as ReplayContainer;
 const replay = (integration as Sentry.Replay)['_replay'] as Replay['_replay'];

 assert.true(replay.isEnabled());
 assert.false(replay.isPaused());
Expand Down

5 changes: 2 additions & 3 deletions
packages/ember/tests/dummy/app/routes/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,8 @@ import * as Sentry from '@sentry/ember';
export default class ReplayRoute extends Route {
 public async beforeModel(): Promise<void> {
 const { Replay } = Sentry;

 if (!Sentry.getClient()!.getIntegration(Replay)) {
 const client = Sentry.getClient() as BrowserClient;
 const client = Sentry.getClient<BrowserClient>();
 if (client && !client.getIntegrationByName('Replay')) {
 client.addIntegration(new Replay());
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/feedback/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,7 @@ import {Feedback} from '@sentry-internal/feedback';

function MyFeedbackButton() {
 const client = getCurrentHub().getClient<BrowserClient>();
 const feedback = client?.getIntegration(Feedback);
 const feedback = client?.getIntegrationByName('Feedback');

 // Don't render custom feedback button if Feedback integration not installed
 if (!feedback) {
Expand DownExpand Up@@ -258,7 +258,7 @@ import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

document.getElementById('my-feedback-form').addEventListener('submit', (event) => {
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegration(Feedback);
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegrationByName('Feedback');
 const formData = new FormData(event.currentTarget);
 feedback.sendFeedback(formData);
 event.preventDefault();
Expand Down

1 change: 1 addition & 0 deletions
packages/integrations/src/offline.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ export class Offline implements Integration {
 }

 const eventProcessor: EventProcessor = event => {
 // eslint-disable-next-line deprecation/deprecation
 if (this.hub && this.hub.getIntegration(Offline)) {
 // cache if we are positively offline
 if ('navigator' in WINDOW && 'onLine' in WINDOW.navigator && !WINDOW.navigator.onLine) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node-experimental/src/sdk/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export function getCurrentHub(): Hub {
 },

 getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 return getClient().getIntegration(integration);
 },

Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/src/sdk/spanProcessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { Span } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { SentrySpanProcessor, getClient, getSpanFinishScope } from '@sentry/opentelemetry';

import { Http } from '../integrations/http';
import { NodeFetch } from '../integrations/node-fetch';
import type { Http } from '../integrations/http';
import type { NodeFetch } from '../integrations/node-fetch';
import type { NodeExperimentalClient } from '../types';
import { getIsolationScope } from './api';
import { Scope } from './scope';
Expand DownExpand Up@@ -33,8 +33,8 @@ export class NodeExperimentalSentrySpanProcessor extends SentrySpanProcessor {
 /** @inheritDoc */
 protected _shouldSendSpanToSentry(span: Span): boolean {
 const client = getClient<NodeExperimentalClient>();
 const httpIntegration = client ? client.getIntegration(Http) : undefined;
 const fetchIntegration = client ? client.getIntegration(NodeFetch) : undefined;
 const httpIntegration = client ? client.getIntegrationByName<Http>('Http') : undefined;
 const fetchIntegration = client ? client.getIntegrationByName<NodeFetch>('NodeFetch') : undefined;

 // If we encounter a client or server span with url & method, we assume this comes from the http instrumentation
 // In this case, if `shouldCreateSpansForRequests` is false, we want to _record_ the span but not _sample_ it,
Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/test/integration/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -512,8 +512,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'Http') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'Http') {
 return {
 shouldCreateSpansForRequests: false,
 } as Http;
Expand DownExpand Up@@ -576,8 +576,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'NodeFetch') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'NodeFetch') {
 return {
 shouldCreateSpansForRequests: false,
 } as NodeFetch;
Expand Down

3 changes: 3 additions & 0 deletions
packages/node/src/integrations/undici/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,7 @@ export class Undici implements Integration {
 }

 private _onRequestCreate = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -195,6 +196,7 @@ export class Undici implements Integration {
 };

 private _onRequestEnd = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -234,6 +236,7 @@ export class Undici implements Integration {
 };

 private _onRequestError = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/node/test/integrations/undici.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -417,7 +417,7 @@ function setupTestServer() {

function patchUndici(userOptions: Partial<UndiciOptions>): () => void {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error need to access private property
 options = { ...undici._options };
 // @ts-expect-error need to access private property
Expand All@@ -428,7 +428,7 @@ function patchUndici(userOptions: Partial<UndiciOptions>): () => void {

 return () => {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error Need to override readonly property
 undici!['_options'] = { ...options };
 } catch (_) {
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(core): Add client.getIntegrationByName()#10130

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

mydea
merged 1 commit into

from

Jan 15, 2024
 Merged


feat(core): Add client.getIntegrationByName()#10130
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,16 @@ but in v8 you will not be able to rely on this always existing anymore - any int
This should not affect most people, but in the case that you are manually calling `integration.setupOnce()` right now,
make sure to guard it's existence properly.

## Deprecate `getIntegration()` and `getIntegrationById()`

This deprecates `getIntegration()` on both the hub & the client, as well as `getIntegrationById()` on the baseclient.
Instead, use `getIntegrationByName()`. You can optionally pass an integration generic to make it easier to work with
typescript:

```ts
const replay = getClient().getIntegrationByName<Replay>('Replay');
```

## Deprecate `Hub`

The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency"
Expand Down

2 changes: 1 addition & 1 deletion
...ckages/browser-integration-tests/loader-suites/loader/onLoad/customBrowserTracing/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added BrowserTracing integration', async ({ get
 expect(eventData.transaction_info?.source).toEqual('url');

 const tracePropagationTargets = await page.evaluate(() => {
 const browserTracing = (window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 const browserTracing = (window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 return browserTracing.options.tracePropagationTargets;
 });

Expand Down

6 changes: 3 additions & 3 deletions
...packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrations/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,14 +24,14 @@ sentryTest('should handle custom added integrations & default integrations', asy
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

6 changes: 3 additions & 3 deletions
.../browser-integration-tests/loader-suites/loader/onLoad/customIntegrationsFunction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,14 @@ sentryTest(
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added Replay integration', async ({ getLocalTes
 expect(eventData.segment_id).toBe(0);

 const useCompression = await page.evaluate(() => {
 const replay = (window as any).Sentry.getClient().getIntegrationById('Replay');
 const replay = (window as any).Sentry.getClient().getIntegrationByName('Replay');
 return replay._replay.getOptions().useCompression;
 });

Expand Down

8 changes: 4 additions & 4 deletions
packages/astro/test/client/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeDefined();
Expand All@@ -77,7 +77,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -92,7 +92,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -109,7 +109,7 @@ describe('Sentry client SDK', () => {

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;

 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing') as BrowserTracing;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
 const options = browserTracing.options;

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
Expand Down

15 changes: 13 additions & 2 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -334,13 +334,24 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 * Gets an installed integration by its `id`.
 *
 * @returns The installed integration or `undefined` if no integration with that `id` was installed.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegrationById(integrationId: string): Integration | undefined {
 return this._integrations[integrationId];
 return this.getIntegrationByName(integrationId);
 }

 /**
 * @inheritDoc
 * Gets an installed integration by its name.
 *
 * @returns The installed integration or `undefined` if no integration with that `name` was installed.
 */
 public getIntegrationByName<T extends Integration = Integration>(integrationName: string): T | undefined {
 return this._integrations[integrationName] as T | undefined;
 }

 /**
 * Returns the client's instance of the given integration class, it any.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 try {
Expand Down

3 changes: 2 additions & 1 deletion
packages/core/src/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -472,13 +472,14 @@ export class Hub implements HubInterface {

 /**
 * @inheritDoc
 * @deprecated Use `Sentry.getClient().getIntegration()` instead.
 * @deprecated Use `Sentry.getClient().getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 const client = this.getClient();
 if (!client) return null;
 try {
 // eslint-disable-next-line deprecation/deprecation
 return client.getIntegration(integration);
 } catch (_oO) {
 DEBUG_BUILD && logger.warn(`Cannot retrieve integration ${integration.id} from the current Hub`);
Expand Down

16 changes: 8 additions & 8 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1496,7 +1496,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('sets up each integration on `init` call', () => {
Expand All@@ -1507,7 +1507,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('skips installation for `setupIntegrations()` if DSN is not provided', () => {
Expand All@@ -1519,7 +1519,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if DSN is not provided', () => {
Expand All@@ -1530,7 +1530,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `setupIntegrations()` if `enabled` is set to `false`', () => {
Expand All@@ -1546,7 +1546,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if `enabled` is set to `false`', () => {
Expand All@@ -1561,7 +1561,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation if integrations are already installed', () => {
Expand All@@ -1577,7 +1577,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 // ...but it shouldn't try to install a second time
Expand All@@ -1597,7 +1597,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 client.init();
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/test/mocks/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export class TestIntegration implements Integration {

 public setupOnce(): void {
 const eventProcessor: EventProcessor = (event: Event) => {
 if (!getClient()?.getIntegration(TestIntegration)) {
 if (!getClient()?.getIntegrationByName?.('TestIntegration')) {
 return event;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/ember/addon/instance-initializers/sentry-performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,8 +441,8 @@ export async function instrumentForPerformance(appInstance: ApplicationInstance)

 if (
 client &&
 (client as BrowserClient).getIntegrationById &&
 (client as BrowserClient).getIntegrationById('BrowserTracing')
 (client as BrowserClient).getIntegrationByName &&
 (client as BrowserClient).getIntegrationByName('BrowserTracing')
 ) {
 // Initializers are called more than once in tests, causing the integrations to not be setup correctly.
 return;
Expand Down

6 changes: 3 additions & 3 deletions
packages/ember/tests/acceptance/sentry-replay-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { visit } from '@ember/test-helpers';
import * as Sentry from '@sentry/ember';
import type { ReplayContainer } from '@sentry/replay/build/npm/types/types';
import type { BrowserClient, Replay } from '@sentry/ember';
import { setupApplicationTest } from 'ember-qunit';
import { module, test } from 'qunit';

Expand All@@ -13,10 +13,10 @@ module('Acceptance | Sentry Session Replay', function (hooks) {
 test('Test replay', async function (assert) {
 await visit('/replay');

 const integration = Sentry.getClient()?.getIntegration(Sentry.Replay);
 const integration = Sentry.getClient<BrowserClient>()?.getIntegrationByName('Replay');
 assert.ok(integration);

 const replay = (integration as Sentry.Replay)['_replay'] as ReplayContainer;
 const replay = (integration as Sentry.Replay)['_replay'] as Replay['_replay'];

 assert.true(replay.isEnabled());
 assert.false(replay.isPaused());
Expand Down

5 changes: 2 additions & 3 deletions
packages/ember/tests/dummy/app/routes/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,8 @@ import * as Sentry from '@sentry/ember';
export default class ReplayRoute extends Route {
 public async beforeModel(): Promise<void> {
 const { Replay } = Sentry;

 if (!Sentry.getClient()!.getIntegration(Replay)) {
 const client = Sentry.getClient() as BrowserClient;
 const client = Sentry.getClient<BrowserClient>();
 if (client && !client.getIntegrationByName('Replay')) {
 client.addIntegration(new Replay());
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/feedback/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,7 @@ import {Feedback} from '@sentry-internal/feedback';

function MyFeedbackButton() {
 const client = getCurrentHub().getClient<BrowserClient>();
 const feedback = client?.getIntegration(Feedback);
 const feedback = client?.getIntegrationByName('Feedback');

 // Don't render custom feedback button if Feedback integration not installed
 if (!feedback) {
Expand DownExpand Up@@ -258,7 +258,7 @@ import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

document.getElementById('my-feedback-form').addEventListener('submit', (event) => {
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegration(Feedback);
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegrationByName('Feedback');
 const formData = new FormData(event.currentTarget);
 feedback.sendFeedback(formData);
 event.preventDefault();
Expand Down

1 change: 1 addition & 0 deletions
packages/integrations/src/offline.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ export class Offline implements Integration {
 }

 const eventProcessor: EventProcessor = event => {
 // eslint-disable-next-line deprecation/deprecation
 if (this.hub && this.hub.getIntegration(Offline)) {
 // cache if we are positively offline
 if ('navigator' in WINDOW && 'onLine' in WINDOW.navigator && !WINDOW.navigator.onLine) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node-experimental/src/sdk/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export function getCurrentHub(): Hub {
 },

 getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 return getClient().getIntegration(integration);
 },

Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/src/sdk/spanProcessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { Span } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { SentrySpanProcessor, getClient, getSpanFinishScope } from '@sentry/opentelemetry';

import { Http } from '../integrations/http';
import { NodeFetch } from '../integrations/node-fetch';
import type { Http } from '../integrations/http';
import type { NodeFetch } from '../integrations/node-fetch';
import type { NodeExperimentalClient } from '../types';
import { getIsolationScope } from './api';
import { Scope } from './scope';
Expand DownExpand Up@@ -33,8 +33,8 @@ export class NodeExperimentalSentrySpanProcessor extends SentrySpanProcessor {
 /** @inheritDoc */
 protected _shouldSendSpanToSentry(span: Span): boolean {
 const client = getClient<NodeExperimentalClient>();
 const httpIntegration = client ? client.getIntegration(Http) : undefined;
 const fetchIntegration = client ? client.getIntegration(NodeFetch) : undefined;
 const httpIntegration = client ? client.getIntegrationByName<Http>('Http') : undefined;
 const fetchIntegration = client ? client.getIntegrationByName<NodeFetch>('NodeFetch') : undefined;

 // If we encounter a client or server span with url & method, we assume this comes from the http instrumentation
 // In this case, if `shouldCreateSpansForRequests` is false, we want to _record_ the span but not _sample_ it,
Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/test/integration/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -512,8 +512,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'Http') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'Http') {
 return {
 shouldCreateSpansForRequests: false,
 } as Http;
Expand DownExpand Up@@ -576,8 +576,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'NodeFetch') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'NodeFetch') {
 return {
 shouldCreateSpansForRequests: false,
 } as NodeFetch;
Expand Down

3 changes: 3 additions & 0 deletions
packages/node/src/integrations/undici/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,7 @@ export class Undici implements Integration {
 }

 private _onRequestCreate = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -195,6 +196,7 @@ export class Undici implements Integration {
 };

 private _onRequestEnd = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -234,6 +236,7 @@ export class Undici implements Integration {
 };

 private _onRequestError = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/node/test/integrations/undici.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -417,7 +417,7 @@ function setupTestServer() {

function patchUndici(userOptions: Partial<UndiciOptions>): () => void {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error need to access private property
 options = { ...undici._options };
 // @ts-expect-error need to access private property
Expand All@@ -428,7 +428,7 @@ function patchUndici(userOptions: Partial<UndiciOptions>): () => void {

 return () => {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error Need to override readonly property
 undici!['_options'] = { ...options };
 } catch (_) {
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(core): Add client.getIntegrationByName()#10130

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

mydea
merged 1 commit into

from

Jan 15, 2024
 Merged


feat(core): Add client.getIntegrationByName()#10130
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,16 @@ but in v8 you will not be able to rely on this always existing anymore - any int
This should not affect most people, but in the case that you are manually calling `integration.setupOnce()` right now,
make sure to guard it's existence properly.

## Deprecate `getIntegration()` and `getIntegrationById()`

This deprecates `getIntegration()` on both the hub & the client, as well as `getIntegrationById()` on the baseclient.
Instead, use `getIntegrationByName()`. You can optionally pass an integration generic to make it easier to work with
typescript:

```ts
const replay = getClient().getIntegrationByName<Replay>('Replay');
```

## Deprecate `Hub`

The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency"
Expand Down

2 changes: 1 addition & 1 deletion
...ckages/browser-integration-tests/loader-suites/loader/onLoad/customBrowserTracing/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added BrowserTracing integration', async ({ get
 expect(eventData.transaction_info?.source).toEqual('url');

 const tracePropagationTargets = await page.evaluate(() => {
 const browserTracing = (window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 const browserTracing = (window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 return browserTracing.options.tracePropagationTargets;
 });

Expand Down

6 changes: 3 additions & 3 deletions
...packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrations/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,14 +24,14 @@ sentryTest('should handle custom added integrations & default integrations', asy
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

6 changes: 3 additions & 3 deletions
.../browser-integration-tests/loader-suites/loader/onLoad/customIntegrationsFunction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,14 @@ sentryTest(
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added Replay integration', async ({ getLocalTes
 expect(eventData.segment_id).toBe(0);

 const useCompression = await page.evaluate(() => {
 const replay = (window as any).Sentry.getClient().getIntegrationById('Replay');
 const replay = (window as any).Sentry.getClient().getIntegrationByName('Replay');
 return replay._replay.getOptions().useCompression;
 });

Expand Down

8 changes: 4 additions & 4 deletions
packages/astro/test/client/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeDefined();
Expand All@@ -77,7 +77,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -92,7 +92,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -109,7 +109,7 @@ describe('Sentry client SDK', () => {

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;

 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing') as BrowserTracing;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
 const options = browserTracing.options;

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
Expand Down

15 changes: 13 additions & 2 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -334,13 +334,24 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 * Gets an installed integration by its `id`.
 *
 * @returns The installed integration or `undefined` if no integration with that `id` was installed.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegrationById(integrationId: string): Integration | undefined {
 return this._integrations[integrationId];
 return this.getIntegrationByName(integrationId);
 }

 /**
 * @inheritDoc
 * Gets an installed integration by its name.
 *
 * @returns The installed integration or `undefined` if no integration with that `name` was installed.
 */
 public getIntegrationByName<T extends Integration = Integration>(integrationName: string): T | undefined {
 return this._integrations[integrationName] as T | undefined;
 }

 /**
 * Returns the client's instance of the given integration class, it any.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 try {
Expand Down

3 changes: 2 additions & 1 deletion
packages/core/src/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -472,13 +472,14 @@ export class Hub implements HubInterface {

 /**
 * @inheritDoc
 * @deprecated Use `Sentry.getClient().getIntegration()` instead.
 * @deprecated Use `Sentry.getClient().getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 const client = this.getClient();
 if (!client) return null;
 try {
 // eslint-disable-next-line deprecation/deprecation
 return client.getIntegration(integration);
 } catch (_oO) {
 DEBUG_BUILD && logger.warn(`Cannot retrieve integration ${integration.id} from the current Hub`);
Expand Down

16 changes: 8 additions & 8 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1496,7 +1496,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('sets up each integration on `init` call', () => {
Expand All@@ -1507,7 +1507,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('skips installation for `setupIntegrations()` if DSN is not provided', () => {
Expand All@@ -1519,7 +1519,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if DSN is not provided', () => {
Expand All@@ -1530,7 +1530,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `setupIntegrations()` if `enabled` is set to `false`', () => {
Expand All@@ -1546,7 +1546,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if `enabled` is set to `false`', () => {
Expand All@@ -1561,7 +1561,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation if integrations are already installed', () => {
Expand All@@ -1577,7 +1577,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 // ...but it shouldn't try to install a second time
Expand All@@ -1597,7 +1597,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 client.init();
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/test/mocks/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export class TestIntegration implements Integration {

 public setupOnce(): void {
 const eventProcessor: EventProcessor = (event: Event) => {
 if (!getClient()?.getIntegration(TestIntegration)) {
 if (!getClient()?.getIntegrationByName?.('TestIntegration')) {
 return event;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/ember/addon/instance-initializers/sentry-performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,8 +441,8 @@ export async function instrumentForPerformance(appInstance: ApplicationInstance)

 if (
 client &&
 (client as BrowserClient).getIntegrationById &&
 (client as BrowserClient).getIntegrationById('BrowserTracing')
 (client as BrowserClient).getIntegrationByName &&
 (client as BrowserClient).getIntegrationByName('BrowserTracing')
 ) {
 // Initializers are called more than once in tests, causing the integrations to not be setup correctly.
 return;
Expand Down

6 changes: 3 additions & 3 deletions
packages/ember/tests/acceptance/sentry-replay-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { visit } from '@ember/test-helpers';
import * as Sentry from '@sentry/ember';
import type { ReplayContainer } from '@sentry/replay/build/npm/types/types';
import type { BrowserClient, Replay } from '@sentry/ember';
import { setupApplicationTest } from 'ember-qunit';
import { module, test } from 'qunit';

Expand All@@ -13,10 +13,10 @@ module('Acceptance | Sentry Session Replay', function (hooks) {
 test('Test replay', async function (assert) {
 await visit('/replay');

 const integration = Sentry.getClient()?.getIntegration(Sentry.Replay);
 const integration = Sentry.getClient<BrowserClient>()?.getIntegrationByName('Replay');
 assert.ok(integration);

 const replay = (integration as Sentry.Replay)['_replay'] as ReplayContainer;
 const replay = (integration as Sentry.Replay)['_replay'] as Replay['_replay'];

 assert.true(replay.isEnabled());
 assert.false(replay.isPaused());
Expand Down

5 changes: 2 additions & 3 deletions
packages/ember/tests/dummy/app/routes/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,8 @@ import * as Sentry from '@sentry/ember';
export default class ReplayRoute extends Route {
 public async beforeModel(): Promise<void> {
 const { Replay } = Sentry;

 if (!Sentry.getClient()!.getIntegration(Replay)) {
 const client = Sentry.getClient() as BrowserClient;
 const client = Sentry.getClient<BrowserClient>();
 if (client && !client.getIntegrationByName('Replay')) {
 client.addIntegration(new Replay());
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/feedback/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,7 @@ import {Feedback} from '@sentry-internal/feedback';

function MyFeedbackButton() {
 const client = getCurrentHub().getClient<BrowserClient>();
 const feedback = client?.getIntegration(Feedback);
 const feedback = client?.getIntegrationByName('Feedback');

 // Don't render custom feedback button if Feedback integration not installed
 if (!feedback) {
Expand DownExpand Up@@ -258,7 +258,7 @@ import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

document.getElementById('my-feedback-form').addEventListener('submit', (event) => {
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegration(Feedback);
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegrationByName('Feedback');
 const formData = new FormData(event.currentTarget);
 feedback.sendFeedback(formData);
 event.preventDefault();
Expand Down

1 change: 1 addition & 0 deletions
packages/integrations/src/offline.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ export class Offline implements Integration {
 }

 const eventProcessor: EventProcessor = event => {
 // eslint-disable-next-line deprecation/deprecation
 if (this.hub && this.hub.getIntegration(Offline)) {
 // cache if we are positively offline
 if ('navigator' in WINDOW && 'onLine' in WINDOW.navigator && !WINDOW.navigator.onLine) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node-experimental/src/sdk/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export function getCurrentHub(): Hub {
 },

 getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 return getClient().getIntegration(integration);
 },

Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/src/sdk/spanProcessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { Span } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { SentrySpanProcessor, getClient, getSpanFinishScope } from '@sentry/opentelemetry';

import { Http } from '../integrations/http';
import { NodeFetch } from '../integrations/node-fetch';
import type { Http } from '../integrations/http';
import type { NodeFetch } from '../integrations/node-fetch';
import type { NodeExperimentalClient } from '../types';
import { getIsolationScope } from './api';
import { Scope } from './scope';
Expand DownExpand Up@@ -33,8 +33,8 @@ export class NodeExperimentalSentrySpanProcessor extends SentrySpanProcessor {
 /** @inheritDoc */
 protected _shouldSendSpanToSentry(span: Span): boolean {
 const client = getClient<NodeExperimentalClient>();
 const httpIntegration = client ? client.getIntegration(Http) : undefined;
 const fetchIntegration = client ? client.getIntegration(NodeFetch) : undefined;
 const httpIntegration = client ? client.getIntegrationByName<Http>('Http') : undefined;
 const fetchIntegration = client ? client.getIntegrationByName<NodeFetch>('NodeFetch') : undefined;

 // If we encounter a client or server span with url & method, we assume this comes from the http instrumentation
 // In this case, if `shouldCreateSpansForRequests` is false, we want to _record_ the span but not _sample_ it,
Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/test/integration/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -512,8 +512,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'Http') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'Http') {
 return {
 shouldCreateSpansForRequests: false,
 } as Http;
Expand DownExpand Up@@ -576,8 +576,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'NodeFetch') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'NodeFetch') {
 return {
 shouldCreateSpansForRequests: false,
 } as NodeFetch;
Expand Down

3 changes: 3 additions & 0 deletions
packages/node/src/integrations/undici/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,7 @@ export class Undici implements Integration {
 }

 private _onRequestCreate = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -195,6 +196,7 @@ export class Undici implements Integration {
 };

 private _onRequestEnd = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -234,6 +236,7 @@ export class Undici implements Integration {
 };

 private _onRequestError = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/node/test/integrations/undici.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -417,7 +417,7 @@ function setupTestServer() {

function patchUndici(userOptions: Partial<UndiciOptions>): () => void {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error need to access private property
 options = { ...undici._options };
 // @ts-expect-error need to access private property
Expand All@@ -428,7 +428,7 @@ function patchUndici(userOptions: Partial<UndiciOptions>): () => void {

 return () => {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error Need to override readonly property
 undici!['_options'] = { ...options };
 } catch (_) {
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(core): Add client.getIntegrationByName()#10130

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

mydea
merged 1 commit into

from

Jan 15, 2024
 Merged


feat(core): Add client.getIntegrationByName()#10130
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,16 @@ but in v8 you will not be able to rely on this always existing anymore - any int
This should not affect most people, but in the case that you are manually calling `integration.setupOnce()` right now,
make sure to guard it's existence properly.

## Deprecate `getIntegration()` and `getIntegrationById()`

This deprecates `getIntegration()` on both the hub & the client, as well as `getIntegrationById()` on the baseclient.
Instead, use `getIntegrationByName()`. You can optionally pass an integration generic to make it easier to work with
typescript:

```ts
const replay = getClient().getIntegrationByName<Replay>('Replay');
```

## Deprecate `Hub`

The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency"
Expand Down

2 changes: 1 addition & 1 deletion
...ckages/browser-integration-tests/loader-suites/loader/onLoad/customBrowserTracing/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added BrowserTracing integration', async ({ get
 expect(eventData.transaction_info?.source).toEqual('url');

 const tracePropagationTargets = await page.evaluate(() => {
 const browserTracing = (window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 const browserTracing = (window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 return browserTracing.options.tracePropagationTargets;
 });

Expand Down

6 changes: 3 additions & 3 deletions
...packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrations/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,14 +24,14 @@ sentryTest('should handle custom added integrations & default integrations', asy
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

6 changes: 3 additions & 3 deletions
.../browser-integration-tests/loader-suites/loader/onLoad/customIntegrationsFunction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,14 @@ sentryTest(
 });

 const hasCustomIntegration = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
 return !!(window as any).Sentry.getClient().getIntegrationByName('CustomIntegration');
 });

 const hasReplay = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
 return !!(window as any).Sentry.getClient().getIntegrationByName('Replay');
 });
 const hasBrowserTracing = await page.evaluate(() => {
 return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
 return !!(window as any).Sentry.getClient().getIntegrationByName('BrowserTracing');
 });

 expect(hasCustomIntegration).toEqual(true);
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ sentryTest('should handle custom added Replay integration', async ({ getLocalTes
 expect(eventData.segment_id).toBe(0);

 const useCompression = await page.evaluate(() => {
 const replay = (window as any).Sentry.getClient().getIntegrationById('Replay');
 const replay = (window as any).Sentry.getClient().getIntegrationByName('Replay');
 return replay._replay.getOptions().useCompression;
 });

Expand Down

8 changes: 4 additions & 4 deletions
packages/astro/test/client/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeDefined();
Expand All@@ -77,7 +77,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -92,7 +92,7 @@ describe('Sentry client SDK', () => {
 });

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');

 expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
 expect(browserTracing).toBeUndefined();
Expand All@@ -109,7 +109,7 @@ describe('Sentry client SDK', () => {

 const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;

 const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing') as BrowserTracing;
 const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
 const options = browserTracing.options;

 expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
Expand Down

15 changes: 13 additions & 2 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -334,13 +334,24 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 * Gets an installed integration by its `id`.
 *
 * @returns The installed integration or `undefined` if no integration with that `id` was installed.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegrationById(integrationId: string): Integration | undefined {
 return this._integrations[integrationId];
 return this.getIntegrationByName(integrationId);
 }

 /**
 * @inheritDoc
 * Gets an installed integration by its name.
 *
 * @returns The installed integration or `undefined` if no integration with that `name` was installed.
 */
 public getIntegrationByName<T extends Integration = Integration>(integrationName: string): T | undefined {
 return this._integrations[integrationName] as T | undefined;
 }

 /**
 * Returns the client's instance of the given integration class, it any.
 * @deprecated Use `getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 try {
Expand Down

3 changes: 2 additions & 1 deletion
packages/core/src/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -472,13 +472,14 @@ export class Hub implements HubInterface {

 /**
 * @inheritDoc
 * @deprecated Use `Sentry.getClient().getIntegration()` instead.
 * @deprecated Use `Sentry.getClient().getIntegrationByName()` instead.
 */
 public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 const client = this.getClient();
 if (!client) return null;
 try {
 // eslint-disable-next-line deprecation/deprecation
 return client.getIntegration(integration);
 } catch (_oO) {
 DEBUG_BUILD && logger.warn(`Cannot retrieve integration ${integration.id} from the current Hub`);
Expand Down

16 changes: 8 additions & 8 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1496,7 +1496,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('sets up each integration on `init` call', () => {
Expand All@@ -1507,7 +1507,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 });

 test('skips installation for `setupIntegrations()` if DSN is not provided', () => {
Expand All@@ -1519,7 +1519,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if DSN is not provided', () => {
Expand All@@ -1530,7 +1530,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `setupIntegrations()` if `enabled` is set to `false`', () => {
Expand All@@ -1546,7 +1546,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation for `init()` if `enabled` is set to `false`', () => {
Expand All@@ -1561,7 +1561,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(0);
 expect(client.getIntegration(TestIntegration)).toBeFalsy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeFalsy();
 });

 test('skips installation if integrations are already installed', () => {
Expand All@@ -1577,7 +1577,7 @@ describe('BaseClient', () => {
 client.setupIntegrations();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 // ...but it shouldn't try to install a second time
Expand All@@ -1597,7 +1597,7 @@ describe('BaseClient', () => {
 client.init();

 expect(Object.keys((client as any)._integrations).length).toEqual(1);
 expect(client.getIntegration(TestIntegration)).toBeTruthy();
 expect(client.getIntegrationByName(TestIntegration.id)).toBeTruthy();
 expect(setupIntegrationsHelper).toHaveBeenCalledTimes(1);

 client.init();
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/test/mocks/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export class TestIntegration implements Integration {

 public setupOnce(): void {
 const eventProcessor: EventProcessor = (event: Event) => {
 if (!getClient()?.getIntegration(TestIntegration)) {
 if (!getClient()?.getIntegrationByName?.('TestIntegration')) {
 return event;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/ember/addon/instance-initializers/sentry-performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,8 +441,8 @@ export async function instrumentForPerformance(appInstance: ApplicationInstance)

 if (
 client &&
 (client as BrowserClient).getIntegrationById &&
 (client as BrowserClient).getIntegrationById('BrowserTracing')
 (client as BrowserClient).getIntegrationByName &&
 (client as BrowserClient).getIntegrationByName('BrowserTracing')
 ) {
 // Initializers are called more than once in tests, causing the integrations to not be setup correctly.
 return;
Expand Down

6 changes: 3 additions & 3 deletions
packages/ember/tests/acceptance/sentry-replay-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { visit } from '@ember/test-helpers';
import * as Sentry from '@sentry/ember';
import type { ReplayContainer } from '@sentry/replay/build/npm/types/types';
import type { BrowserClient, Replay } from '@sentry/ember';
import { setupApplicationTest } from 'ember-qunit';
import { module, test } from 'qunit';

Expand All@@ -13,10 +13,10 @@ module('Acceptance | Sentry Session Replay', function (hooks) {
 test('Test replay', async function (assert) {
 await visit('/replay');

 const integration = Sentry.getClient()?.getIntegration(Sentry.Replay);
 const integration = Sentry.getClient<BrowserClient>()?.getIntegrationByName('Replay');
 assert.ok(integration);

 const replay = (integration as Sentry.Replay)['_replay'] as ReplayContainer;
 const replay = (integration as Sentry.Replay)['_replay'] as Replay['_replay'];

 assert.true(replay.isEnabled());
 assert.false(replay.isPaused());
Expand Down

5 changes: 2 additions & 3 deletions
packages/ember/tests/dummy/app/routes/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,8 @@ import * as Sentry from '@sentry/ember';
export default class ReplayRoute extends Route {
 public async beforeModel(): Promise<void> {
 const { Replay } = Sentry;

 if (!Sentry.getClient()!.getIntegration(Replay)) {
 const client = Sentry.getClient() as BrowserClient;
 const client = Sentry.getClient<BrowserClient>();
 if (client && !client.getIntegrationByName('Replay')) {
 client.addIntegration(new Replay());
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/feedback/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,7 @@ import {Feedback} from '@sentry-internal/feedback';

function MyFeedbackButton() {
 const client = getCurrentHub().getClient<BrowserClient>();
 const feedback = client?.getIntegration(Feedback);
 const feedback = client?.getIntegrationByName('Feedback');

 // Don't render custom feedback button if Feedback integration not installed
 if (!feedback) {
Expand DownExpand Up@@ -258,7 +258,7 @@ import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

document.getElementById('my-feedback-form').addEventListener('submit', (event) => {
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegration(Feedback);
 const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegrationByName('Feedback');
 const formData = new FormData(event.currentTarget);
 feedback.sendFeedback(formData);
 event.preventDefault();
Expand Down

1 change: 1 addition & 0 deletions
packages/integrations/src/offline.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ export class Offline implements Integration {
 }

 const eventProcessor: EventProcessor = event => {
 // eslint-disable-next-line deprecation/deprecation
 if (this.hub && this.hub.getIntegration(Offline)) {
 // cache if we are positively offline
 if ('navigator' in WINDOW && 'onLine' in WINDOW.navigator && !WINDOW.navigator.onLine) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node-experimental/src/sdk/hub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export function getCurrentHub(): Hub {
 },

 getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
 // eslint-disable-next-line deprecation/deprecation
 return getClient().getIntegration(integration);
 },

Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/src/sdk/spanProcessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { Span } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { SentrySpanProcessor, getClient, getSpanFinishScope } from '@sentry/opentelemetry';

import { Http } from '../integrations/http';
import { NodeFetch } from '../integrations/node-fetch';
import type { Http } from '../integrations/http';
import type { NodeFetch } from '../integrations/node-fetch';
import type { NodeExperimentalClient } from '../types';
import { getIsolationScope } from './api';
import { Scope } from './scope';
Expand DownExpand Up@@ -33,8 +33,8 @@ export class NodeExperimentalSentrySpanProcessor extends SentrySpanProcessor {
 /** @inheritDoc */
 protected _shouldSendSpanToSentry(span: Span): boolean {
 const client = getClient<NodeExperimentalClient>();
 const httpIntegration = client ? client.getIntegration(Http) : undefined;
 const fetchIntegration = client ? client.getIntegration(NodeFetch) : undefined;
 const httpIntegration = client ? client.getIntegrationByName<Http>('Http') : undefined;
 const fetchIntegration = client ? client.getIntegrationByName<NodeFetch>('NodeFetch') : undefined;

 // If we encounter a client or server span with url & method, we assume this comes from the http instrumentation
 // In this case, if `shouldCreateSpansForRequests` is false, we want to _record_ the span but not _sample_ it,
Expand Down

8 changes: 4 additions & 4 deletions
packages/node-experimental/test/integration/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -512,8 +512,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'Http') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'Http') {
 return {
 shouldCreateSpansForRequests: false,
 } as Http;
Expand DownExpand Up@@ -576,8 +576,8 @@ describe('Integration | Transactions', () => {

 const client = getClient() as NodeExperimentalClient;

 jest.spyOn(client, 'getIntegration').mockImplementation(integrationClass => {
 if (integrationClass.name === 'NodeFetch') {
 jest.spyOn(client, 'getIntegrationByName').mockImplementation(name => {
 if (name === 'NodeFetch') {
 return {
 shouldCreateSpansForRequests: false,
 } as NodeFetch;
Expand Down

3 changes: 3 additions & 0 deletions
packages/node/src/integrations/undici/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,7 @@ export class Undici implements Integration {
 }

 private _onRequestCreate = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -195,6 +196,7 @@ export class Undici implements Integration {
 };

 private _onRequestEnd = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand DownExpand Up@@ -234,6 +236,7 @@ export class Undici implements Integration {
 };

 private _onRequestError = (message: unknown): void => {
 // eslint-disable-next-line deprecation/deprecation
 if (!getClient()?.getIntegration(Undici)) {
 return;
 }
Expand Down

4 changes: 2 additions & 2 deletions
packages/node/test/integrations/undici.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -417,7 +417,7 @@ function setupTestServer() {

function patchUndici(userOptions: Partial<UndiciOptions>): () => void {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error need to access private property
 options = { ...undici._options };
 // @ts-expect-error need to access private property
Expand All@@ -428,7 +428,7 @@ function patchUndici(userOptions: Partial<UndiciOptions>): () => void {

 return () => {
 try {
 const undici = getClient()!.getIntegration(Undici);
 const undici = getClient()!.getIntegrationByName!('Undici');
 // @ts-expect-error Need to override readonly property
 undici!['_options'] = { ...options };
 } catch (_) {
Expand Down
Loading