fix: Ensure all integration classes have correct types#10183

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 16, 2024
Merged

fix: Ensure all integration classes have correct types #10183

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
26 changes: 23 additions & 3 deletions packages/browser/src/integrations/breadcrumbs.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,8 @@ import type {
HandlerDataFetch,
HandlerDataHistory,
HandlerDataXhr,
Integration,
IntegrationClass,
IntegrationFn,
} from '@sentry/types';
import type {
Expand DownExpand Up@@ -55,7 +57,7 @@ const MAX_ALLOWED_STRING_LENGTH = 1024;

const INTEGRATION_NAME = 'Breadcrumbs';

const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptions> = {}) => {
const breadcrumbsIntegration = ((options: Partial<BreadcrumbsOptions> = {}) => {
const _options = {
console: true,
dom: true,
Expand DownExpand Up@@ -91,13 +93,31 @@ const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptio
}
},
};
};
}) satisfies IntegrationFn;

/**
* Default Breadcrumbs instrumentations
*/
// eslint-disable-next-line deprecation/deprecation
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration);
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration) as IntegrationClass<
Integration & { setup: (client: Client) => void }
> & {
new (
options?: Partial<{
console: boolean;
dom:
| boolean
| {
serializeAttribute?: string | string[];
maxStringLength?: number;
};
fetch: boolean;
history: boolean;
sentry: boolean;
xhr: boolean;
}>,
): Integration;
};

/**
* Adds a breadcrumb for Sentry events or transactions if this option is enabled.
Expand Down
10 changes: 6 additions & 4 deletions packages/browser/src/integrations/dedupe.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackFrame } from '@sentry/types';
import type { Event, Exception, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';

const INTEGRATION_NAME = 'Dedupe';

const dedupeIntegration: IntegrationFn = () => {
const dedupeIntegration = (() => {
let previousEvent: Event | undefined;

return {
Expand All@@ -31,11 +31,13 @@ const dedupeIntegration: IntegrationFn = () => {
return (previousEvent = currentEvent);
},
};
};
}) satisfies IntegrationFn;

/** Deduplication filter */
// eslint-disable-next-line deprecation/deprecation
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration);
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration) as IntegrationClass<
Integration & { processEvent: (event: Event) => Event }
>;

function _shouldDropEvent(currentEvent: Event, previousEvent?: Event): boolean {
if (!previousEvent) {
Expand Down
21 changes: 17 additions & 4 deletions packages/browser/src/integrations/globalhandlers.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { captureEvent, convertIntegrationFnToClass, getClient } from '@sentry/core';
import type { Client, Event, IntegrationFn, Primitive, StackParser } from '@sentry/types';
import type {
Client,
Event,
Integration,
IntegrationClass,
IntegrationFn,
Primitive,
StackParser,
} from '@sentry/types';
import {
addGlobalErrorInstrumentationHandler,
addGlobalUnhandledRejectionInstrumentationHandler,
Expand All@@ -22,7 +30,7 @@ type GlobalHandlersIntegrations = Record<GlobalHandlersIntegrationsOptionKeys, b

const INTEGRATION_NAME = 'GlobalHandlers';

const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandlersIntegrations> = {}) => {
const globalHandlersIntegration = ((options: Partial<GlobalHandlersIntegrations> = {}) => {
const _options = {
onerror: true,
onunhandledrejection: true,
Expand All@@ -45,11 +53,16 @@ const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandle
}
},
};
};
}) satisfies IntegrationFn;

/** Global handlers */
// eslint-disable-next-line deprecation/deprecation
export const GlobalHandlers = convertIntegrationFnToClass(INTEGRATION_NAME, globalHandlersIntegrations);
export const GlobalHandlers = convertIntegrationFnToClass(
INTEGRATION_NAME,
globalHandlersIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }> & {
new (options?: Partial<GlobalHandlersIntegrations>): Integration;
};

function _installGlobalOnErrorHandler(client: Client): void {
addGlobalErrorInstrumentationHandler(data => {
Expand Down
10 changes: 6 additions & 4 deletions packages/browser/src/integrations/httpcontext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Event, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';

import { WINDOW } from '../helpers';

const INTEGRATION_NAME = 'HttpContext';

const httpContextIntegration: IntegrationFn = () => {
const httpContextIntegration = (() => {
return {
name: INTEGRATION_NAME,
// TODO v8: Remove this
Expand All@@ -31,8 +31,10 @@ const httpContextIntegration: IntegrationFn = () => {
event.request = request;
},
};
};
}) satisfies IntegrationFn;

/** HttpContext integration collects information about HTTP request headers */
// eslint-disable-next-line deprecation/deprecation
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration);
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration) as IntegrationClass<
Integration & { preprocessEvent: (event: Event) => void }
>;
10 changes: 6 additions & 4 deletions packages/browser/src/integrations/linkederrors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
import { applyAggregateErrorsToEvent } from '@sentry/utils';
import { exceptionFromError } from '../eventbuilder';

Expand All@@ -13,7 +13,7 @@ const DEFAULT_LIMIT = 5;

const INTEGRATION_NAME = 'LinkedErrors';

const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {}) => {
const linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
const limit = options.limit || DEFAULT_LIMIT;
const key = options.key || DEFAULT_KEY;

Expand All@@ -36,8 +36,10 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
);
},
};
};
}) satisfies IntegrationFn;

/** Aggregrate linked errors in an event. */
// eslint-disable-next-line deprecation/deprecation
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration);
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration) as IntegrationClass<
Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }
> & { new (options?: { key?: string; limit?: number }): Integration };
19 changes: 15 additions & 4 deletions packages/browser/src/integrations/trycatch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { fill, getFunctionName, getOriginalFunction } from '@sentry/utils';

import { WINDOW, wrap } from '../helpers';
Expand DownExpand Up@@ -50,7 +50,7 @@ interface TryCatchOptions {
eventTarget: boolean | string[];
}

const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> = {}) => {
const browserApiErrorsIntegration = ((options: Partial<TryCatchOptions> = {}) => {
const _options = {
XMLHttpRequest: true,
eventTarget: true,
Expand DownExpand Up@@ -88,11 +88,22 @@ const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> =
}
},
};
};
}) satisfies IntegrationFn;

/** Wrap timer functions and event targets to catch errors and provide better meta data */
// eslint-disable-next-line deprecation/deprecation
export const TryCatch = convertIntegrationFnToClass(INTEGRATION_NAME, tryCatchIntegration);
export const TryCatch = convertIntegrationFnToClass(
INTEGRATION_NAME,
browserApiErrorsIntegration,
) as IntegrationClass<Integration> & {
new (options?: {
setTimeout: boolean;
setInterval: boolean;
requestAnimationFrame: boolean;
XMLHttpRequest: boolean;
eventTarget: boolean | string[];
}): Integration;
};

function _wrapTimeFunction(original: () => void): () => number {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down
11 changes: 7 additions & 4 deletions packages/browser/src/profiling/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass, getCurrentScope } from '@sentry/core';
import type { EventEnvelope, IntegrationFn, Transaction } from '@sentry/types';
import type { Client, EventEnvelope, Integration, IntegrationClass, IntegrationFn, Transaction } from '@sentry/types';
import type { Profile } from '@sentry/types/src/profiling';
import { logger } from '@sentry/utils';

Expand All@@ -18,7 +18,7 @@ import {

const INTEGRATION_NAME = 'BrowserProfiling';

const browserProfilingIntegration: IntegrationFn = () => {
const browserProfilingIntegration = (() => {
return {
name: INTEGRATION_NAME,
// TODO v8: Remove this
Expand DownExpand Up@@ -100,7 +100,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
});
},
};
};
}) satisfies IntegrationFn;

/**
* Browser profiling integration. Stores any event that has contexts["profile"]["profile_id"]
Expand All@@ -112,4 +112,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
* @experimental
*/
// eslint-disable-next-line deprecation/deprecation
export const BrowserProfilingIntegration = convertIntegrationFnToClass(INTEGRATION_NAME, browserProfilingIntegration);
export const BrowserProfilingIntegration = convertIntegrationFnToClass(
INTEGRATION_NAME,
browserProfilingIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }>;
1 change: 0 additions & 1 deletion packages/browser/test/unit/profiling/integration.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,6 @@ describe('BrowserProfilingIntegration', () => {
Sentry.init({
tracesSampleRate: 1,
profilesSampleRate: 1,
debug: true,
environment: 'test-environment',
dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
transport: _opts => {
Expand Down
4 changes: 2 additions & 2 deletions packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

const INTEGRATION_NAME = 'BunServer';

const bunServerIntegration: IntegrationFn = () => {
const bunServerIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
instrumentBunServe();
},
};
};
}) satisfies IntegrationFn;

/**
* Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand Down
17 changes: 5 additions & 12 deletions packages/core/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, Options } from '@sentry/types';
import { arrayify, logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
Expand DownExpand Up@@ -169,18 +169,11 @@ function findIndex<T>(arr: T[], callback: (item: T) => boolean): number {
export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
name: string,
fn: Fn,
): Integration & {
id: string;
new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
} {
): IntegrationClass<Integration> {
return Object.assign(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function ConvertedIntegration(...rest: Parameters<Fn>) {
return fn(...rest);
function ConvertedIntegration(...args: Parameters<Fn>): Integration {
return fn(...args);
},
{ id: name },
) as unknown as Integration & {
id: string;
new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
};
) as unknown as IntegrationClass<Integration>;
}
11 changes: 7 additions & 4 deletions packages/core/src/integrations/functiontostring.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { getOriginalFunction } from '@sentry/utils';
import { convertIntegrationFnToClass } from '../integration';

let originalFunctionToString: () => void;

const INTEGRATION_NAME = 'FunctionToString';

const functionToStringIntegration: IntegrationFn = () => {
const functionToStringIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
Expand All@@ -26,8 +26,11 @@ const functionToStringIntegration: IntegrationFn = () => {
}
},
};
};
}) satisfies IntegrationFn;

/** Patch toString calls to return proper name for wrapped functions */
// eslint-disable-next-line deprecation/deprecation
export const FunctionToString = convertIntegrationFnToClass(INTEGRATION_NAME, functionToStringIntegration);
export const FunctionToString = convertIntegrationFnToClass(
INTEGRATION_NAME,
functionToStringIntegration,
) as IntegrationClass<Integration & { setupOnce: () => void }>;
23 changes: 19 additions & 4 deletions packages/core/src/integrations/inboundfilters.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Event, IntegrationFn, StackFrame } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { getEventDescription, logger, stringMatchesSomePattern } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
Expand DownExpand Up@@ -30,7 +30,7 @@ export interface InboundFiltersOptions {
}

const INTEGRATION_NAME = 'InboundFilters';
const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFiltersOptions>) => {
const inboundFiltersIntegration= ((options: Partial<InboundFiltersOptions> = {}) => {
return {
name: INTEGRATION_NAME,
// TODO v8: Remove this
Expand All@@ -41,11 +41,26 @@ const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFilter
return _shouldDropEvent(event, mergedOptions) ? null : event;
},
};
};
}) satisfies IntegrationFn;

/** Inbound filters configurable by the user */
// eslint-disable-next-line deprecation/deprecation
export const InboundFilters = convertIntegrationFnToClass(INTEGRATION_NAME, inboundFiltersIntegration);
export const InboundFilters = convertIntegrationFnToClass(
INTEGRATION_NAME,
inboundFiltersIntegration,
) as IntegrationClass<Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }> & {
new (
options?: Partial<{
allowUrls: Array<string | RegExp>;
denyUrls: Array<string | RegExp>;
ignoreErrors: Array<string | RegExp>;
ignoreTransactions: Array<string | RegExp>;
ignoreInternal: boolean;
disableErrorDefaults: boolean;
disableTransactionDefaults: boolean;
}>,
): Integration;
};

function _mergeOptions(
internalOptions: Partial<InboundFiltersOptions> = {},
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
fix: Ensure all integration classes have correct types#10183

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 16, 2024
 Merged


fix: Ensure all integration classes have correct types
#10183
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


26 changes: 23 additions & 3 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,8 @@ import type {
 HandlerDataFetch,
 HandlerDataHistory,
 HandlerDataXhr,
 Integration,
 IntegrationClass,
 IntegrationFn,
} from '@sentry/types';
import type {
Expand DownExpand Up@@ -55,7 +57,7 @@ const MAX_ALLOWED_STRING_LENGTH = 1024;

const INTEGRATION_NAME = 'Breadcrumbs';

const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptions> = {}) => {
const breadcrumbsIntegration = ((options: Partial<BreadcrumbsOptions> = {}) => {
 const _options = {
 console: true,
 dom: true,
Expand DownExpand Up@@ -91,13 +93,31 @@ const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptio
 }
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Default Breadcrumbs instrumentations
 */
// eslint-disable-next-line deprecation/deprecation
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration);
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration) as IntegrationClass<
 Integration & { setup: (client: Client) => void }
> & {
 new (
 options?: Partial<{
 console: boolean;
 dom:
 | boolean
 | {
 serializeAttribute?: string | string[];
 maxStringLength?: number;
 };
 fetch: boolean;
 history: boolean;
 sentry: boolean;
 xhr: boolean;
 }>,
 ): Integration;
};

/**
 * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/dedupe.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackFrame } from '@sentry/types';
import type { Event, Exception, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';

const INTEGRATION_NAME = 'Dedupe';

const dedupeIntegration: IntegrationFn = () => {
const dedupeIntegration = (() => {
 let previousEvent: Event | undefined;

 return {
Expand All@@ -31,11 +31,13 @@ const dedupeIntegration: IntegrationFn = () => {
 return (previousEvent = currentEvent);
 },
 };
};
}) satisfies IntegrationFn;

/** Deduplication filter */
// eslint-disable-next-line deprecation/deprecation
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration);
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration) as IntegrationClass<
 Integration & { processEvent: (event: Event) => Event }
>;

function _shouldDropEvent(currentEvent: Event, previousEvent?: Event): boolean {
 if (!previousEvent) {
Expand Down

21 changes: 17 additions & 4 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { captureEvent, convertIntegrationFnToClass, getClient } from '@sentry/core';
import type { Client, Event, IntegrationFn, Primitive, StackParser } from '@sentry/types';
import type {
 Client,
 Event,
 Integration,
 IntegrationClass,
 IntegrationFn,
 Primitive,
 StackParser,
} from '@sentry/types';
import {
 addGlobalErrorInstrumentationHandler,
 addGlobalUnhandledRejectionInstrumentationHandler,
Expand All@@ -22,7 +30,7 @@ type GlobalHandlersIntegrations = Record<GlobalHandlersIntegrationsOptionKeys, b

const INTEGRATION_NAME = 'GlobalHandlers';

const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandlersIntegrations> = {}) => {
const globalHandlersIntegration = ((options: Partial<GlobalHandlersIntegrations> = {}) => {
 const _options = {
 onerror: true,
 onunhandledrejection: true,
Expand All@@ -45,11 +53,16 @@ const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandle
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Global handlers */
// eslint-disable-next-line deprecation/deprecation
export const GlobalHandlers = convertIntegrationFnToClass(INTEGRATION_NAME, globalHandlersIntegrations);
export const GlobalHandlers = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 globalHandlersIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }> & {
 new (options?: Partial<GlobalHandlersIntegrations>): Integration;
};

function _installGlobalOnErrorHandler(client: Client): void {
 addGlobalErrorInstrumentationHandler(data => {
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Event, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';

import { WINDOW } from '../helpers';

const INTEGRATION_NAME = 'HttpContext';

const httpContextIntegration: IntegrationFn = () => {
const httpContextIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -31,8 +31,10 @@ const httpContextIntegration: IntegrationFn = () => {
 event.request = request;
 },
 };
};
}) satisfies IntegrationFn;

/** HttpContext integration collects information about HTTP request headers */
// eslint-disable-next-line deprecation/deprecation
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration);
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event) => void }
>;

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
import { applyAggregateErrorsToEvent } from '@sentry/utils';
import { exceptionFromError } from '../eventbuilder';

Expand All@@ -13,7 +13,7 @@ const DEFAULT_LIMIT = 5;

const INTEGRATION_NAME = 'LinkedErrors';

const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {}) => {
const linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
 const limit = options.limit || DEFAULT_LIMIT;
 const key = options.key || DEFAULT_KEY;

Expand All@@ -36,8 +36,10 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
 );
 },
 };
};
}) satisfies IntegrationFn;

/** Aggregrate linked errors in an event. */
// eslint-disable-next-line deprecation/deprecation
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration);
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }
> & { new (options?: { key?: string; limit?: number }): Integration };

19 changes: 15 additions & 4 deletions
packages/browser/src/integrations/trycatch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { fill, getFunctionName, getOriginalFunction } from '@sentry/utils';

import { WINDOW, wrap } from '../helpers';
Expand DownExpand Up@@ -50,7 +50,7 @@ interface TryCatchOptions {
 eventTarget: boolean | string[];
}

const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> = {}) => {
const browserApiErrorsIntegration = ((options: Partial<TryCatchOptions> = {}) => {
 const _options = {
 XMLHttpRequest: true,
 eventTarget: true,
Expand DownExpand Up@@ -88,11 +88,22 @@ const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> =
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Wrap timer functions and event targets to catch errors and provide better meta data */
// eslint-disable-next-line deprecation/deprecation
export const TryCatch = convertIntegrationFnToClass(INTEGRATION_NAME, tryCatchIntegration);
export const TryCatch = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserApiErrorsIntegration,
) as IntegrationClass<Integration> & {
 new (options?: {
 setTimeout: boolean;
 setInterval: boolean;
 requestAnimationFrame: boolean;
 XMLHttpRequest: boolean;
 eventTarget: boolean | string[];
 }): Integration;
};

function _wrapTimeFunction(original: () => void): () => number {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down

11 changes: 7 additions & 4 deletions
packages/browser/src/profiling/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass, getCurrentScope } from '@sentry/core';
import type { EventEnvelope, IntegrationFn, Transaction } from '@sentry/types';
import type { Client, EventEnvelope, Integration, IntegrationClass, IntegrationFn, Transaction } from '@sentry/types';
import type { Profile } from '@sentry/types/src/profiling';
import { logger } from '@sentry/utils';

Expand All@@ -18,7 +18,7 @@ import {

const INTEGRATION_NAME = 'BrowserProfiling';

const browserProfilingIntegration: IntegrationFn = () => {
const browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand DownExpand Up@@ -100,7 +100,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 });
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Browser profiling integration. Stores any event that has contexts["profile"]["profile_id"]
Expand All@@ -112,4 +112,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 * @experimental
 */
// eslint-disable-next-line deprecation/deprecation
export const BrowserProfilingIntegration = convertIntegrationFnToClass(INTEGRATION_NAME, browserProfilingIntegration);
export const BrowserProfilingIntegration = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserProfilingIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }>;

1 change: 0 additions & 1 deletion
packages/browser/test/unit/profiling/integration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,6 @@ describe('BrowserProfilingIntegration', () => {
 Sentry.init({
 tracesSampleRate: 1,
 profilesSampleRate: 1,
 debug: true,
 environment: 'test-environment',
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 transport: _opts => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

const INTEGRATION_NAME = 'BunServer';

const bunServerIntegration: IntegrationFn = () => {
const bunServerIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentBunServe();
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand Down

17 changes: 5 additions & 12 deletions
packages/core/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, Options } from '@sentry/types';
import { arrayify, logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
Expand DownExpand Up@@ -169,18 +169,11 @@ function findIndex<T>(arr: T[], callback: (item: T) => boolean): number {
export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
 name: string,
 fn: Fn,
): Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
} {
): IntegrationClass<Integration> {
 return Object.assign(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ConvertedIntegration(...rest: Parameters<Fn>) {
 return fn(...rest);
 function ConvertedIntegration(...args: Parameters<Fn>): Integration {
 return fn(...args);
 },
 { id: name },
 ) as unknown as Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
 };
 ) as unknown as IntegrationClass<Integration>;
}

11 changes: 7 additions & 4 deletions
packages/core/src/integrations/functiontostring.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { getOriginalFunction } from '@sentry/utils';
import { convertIntegrationFnToClass } from '../integration';

let originalFunctionToString: () => void;

const INTEGRATION_NAME = 'FunctionToString';

const functionToStringIntegration: IntegrationFn = () => {
const functionToStringIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
Expand All@@ -26,8 +26,11 @@ const functionToStringIntegration: IntegrationFn = () => {
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Patch toString calls to return proper name for wrapped functions */
// eslint-disable-next-line deprecation/deprecation
export const FunctionToString = convertIntegrationFnToClass(INTEGRATION_NAME, functionToStringIntegration);
export const FunctionToString = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 functionToStringIntegration,
) as IntegrationClass<Integration & { setupOnce: () => void }>;

23 changes: 19 additions & 4 deletions
packages/core/src/integrations/inboundfilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Event, IntegrationFn, StackFrame } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { getEventDescription, logger, stringMatchesSomePattern } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
Expand DownExpand Up@@ -30,7 +30,7 @@ export interface InboundFiltersOptions {
}

const INTEGRATION_NAME = 'InboundFilters';
const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFiltersOptions>) => {
const inboundFiltersIntegration= ((options: Partial<InboundFiltersOptions> = {}) => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -41,11 +41,26 @@ const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFilter
 return _shouldDropEvent(event, mergedOptions) ? null : event;
 },
 };
};
}) satisfies IntegrationFn;

/** Inbound filters configurable by the user */
// eslint-disable-next-line deprecation/deprecation
export const InboundFilters = convertIntegrationFnToClass(INTEGRATION_NAME, inboundFiltersIntegration);
export const InboundFilters = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 inboundFiltersIntegration,
) as IntegrationClass<Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }> & {
 new (
 options?: Partial<{
 allowUrls: Array<string | RegExp>;
 denyUrls: Array<string | RegExp>;
 ignoreErrors: Array<string | RegExp>;
 ignoreTransactions: Array<string | RegExp>;
 ignoreInternal: boolean;
 disableErrorDefaults: boolean;
 disableTransactionDefaults: boolean;
 }>,
 ): Integration;
};

function _mergeOptions(
 internalOptions: Partial<InboundFiltersOptions> = {},
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
fix: Ensure all integration classes have correct types#10183

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 16, 2024
 Merged


fix: Ensure all integration classes have correct types
#10183
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


26 changes: 23 additions & 3 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,8 @@ import type {
 HandlerDataFetch,
 HandlerDataHistory,
 HandlerDataXhr,
 Integration,
 IntegrationClass,
 IntegrationFn,
} from '@sentry/types';
import type {
Expand DownExpand Up@@ -55,7 +57,7 @@ const MAX_ALLOWED_STRING_LENGTH = 1024;

const INTEGRATION_NAME = 'Breadcrumbs';

const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptions> = {}) => {
const breadcrumbsIntegration = ((options: Partial<BreadcrumbsOptions> = {}) => {
 const _options = {
 console: true,
 dom: true,
Expand DownExpand Up@@ -91,13 +93,31 @@ const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptio
 }
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Default Breadcrumbs instrumentations
 */
// eslint-disable-next-line deprecation/deprecation
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration);
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration) as IntegrationClass<
 Integration & { setup: (client: Client) => void }
> & {
 new (
 options?: Partial<{
 console: boolean;
 dom:
 | boolean
 | {
 serializeAttribute?: string | string[];
 maxStringLength?: number;
 };
 fetch: boolean;
 history: boolean;
 sentry: boolean;
 xhr: boolean;
 }>,
 ): Integration;
};

/**
 * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/dedupe.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackFrame } from '@sentry/types';
import type { Event, Exception, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';

const INTEGRATION_NAME = 'Dedupe';

const dedupeIntegration: IntegrationFn = () => {
const dedupeIntegration = (() => {
 let previousEvent: Event | undefined;

 return {
Expand All@@ -31,11 +31,13 @@ const dedupeIntegration: IntegrationFn = () => {
 return (previousEvent = currentEvent);
 },
 };
};
}) satisfies IntegrationFn;

/** Deduplication filter */
// eslint-disable-next-line deprecation/deprecation
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration);
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration) as IntegrationClass<
 Integration & { processEvent: (event: Event) => Event }
>;

function _shouldDropEvent(currentEvent: Event, previousEvent?: Event): boolean {
 if (!previousEvent) {
Expand Down

21 changes: 17 additions & 4 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { captureEvent, convertIntegrationFnToClass, getClient } from '@sentry/core';
import type { Client, Event, IntegrationFn, Primitive, StackParser } from '@sentry/types';
import type {
 Client,
 Event,
 Integration,
 IntegrationClass,
 IntegrationFn,
 Primitive,
 StackParser,
} from '@sentry/types';
import {
 addGlobalErrorInstrumentationHandler,
 addGlobalUnhandledRejectionInstrumentationHandler,
Expand All@@ -22,7 +30,7 @@ type GlobalHandlersIntegrations = Record<GlobalHandlersIntegrationsOptionKeys, b

const INTEGRATION_NAME = 'GlobalHandlers';

const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandlersIntegrations> = {}) => {
const globalHandlersIntegration = ((options: Partial<GlobalHandlersIntegrations> = {}) => {
 const _options = {
 onerror: true,
 onunhandledrejection: true,
Expand All@@ -45,11 +53,16 @@ const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandle
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Global handlers */
// eslint-disable-next-line deprecation/deprecation
export const GlobalHandlers = convertIntegrationFnToClass(INTEGRATION_NAME, globalHandlersIntegrations);
export const GlobalHandlers = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 globalHandlersIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }> & {
 new (options?: Partial<GlobalHandlersIntegrations>): Integration;
};

function _installGlobalOnErrorHandler(client: Client): void {
 addGlobalErrorInstrumentationHandler(data => {
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Event, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';

import { WINDOW } from '../helpers';

const INTEGRATION_NAME = 'HttpContext';

const httpContextIntegration: IntegrationFn = () => {
const httpContextIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -31,8 +31,10 @@ const httpContextIntegration: IntegrationFn = () => {
 event.request = request;
 },
 };
};
}) satisfies IntegrationFn;

/** HttpContext integration collects information about HTTP request headers */
// eslint-disable-next-line deprecation/deprecation
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration);
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event) => void }
>;

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
import { applyAggregateErrorsToEvent } from '@sentry/utils';
import { exceptionFromError } from '../eventbuilder';

Expand All@@ -13,7 +13,7 @@ const DEFAULT_LIMIT = 5;

const INTEGRATION_NAME = 'LinkedErrors';

const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {}) => {
const linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
 const limit = options.limit || DEFAULT_LIMIT;
 const key = options.key || DEFAULT_KEY;

Expand All@@ -36,8 +36,10 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
 );
 },
 };
};
}) satisfies IntegrationFn;

/** Aggregrate linked errors in an event. */
// eslint-disable-next-line deprecation/deprecation
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration);
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }
> & { new (options?: { key?: string; limit?: number }): Integration };

19 changes: 15 additions & 4 deletions
packages/browser/src/integrations/trycatch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { fill, getFunctionName, getOriginalFunction } from '@sentry/utils';

import { WINDOW, wrap } from '../helpers';
Expand DownExpand Up@@ -50,7 +50,7 @@ interface TryCatchOptions {
 eventTarget: boolean | string[];
}

const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> = {}) => {
const browserApiErrorsIntegration = ((options: Partial<TryCatchOptions> = {}) => {
 const _options = {
 XMLHttpRequest: true,
 eventTarget: true,
Expand DownExpand Up@@ -88,11 +88,22 @@ const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> =
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Wrap timer functions and event targets to catch errors and provide better meta data */
// eslint-disable-next-line deprecation/deprecation
export const TryCatch = convertIntegrationFnToClass(INTEGRATION_NAME, tryCatchIntegration);
export const TryCatch = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserApiErrorsIntegration,
) as IntegrationClass<Integration> & {
 new (options?: {
 setTimeout: boolean;
 setInterval: boolean;
 requestAnimationFrame: boolean;
 XMLHttpRequest: boolean;
 eventTarget: boolean | string[];
 }): Integration;
};

function _wrapTimeFunction(original: () => void): () => number {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down

11 changes: 7 additions & 4 deletions
packages/browser/src/profiling/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass, getCurrentScope } from '@sentry/core';
import type { EventEnvelope, IntegrationFn, Transaction } from '@sentry/types';
import type { Client, EventEnvelope, Integration, IntegrationClass, IntegrationFn, Transaction } from '@sentry/types';
import type { Profile } from '@sentry/types/src/profiling';
import { logger } from '@sentry/utils';

Expand All@@ -18,7 +18,7 @@ import {

const INTEGRATION_NAME = 'BrowserProfiling';

const browserProfilingIntegration: IntegrationFn = () => {
const browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand DownExpand Up@@ -100,7 +100,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 });
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Browser profiling integration. Stores any event that has contexts["profile"]["profile_id"]
Expand All@@ -112,4 +112,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 * @experimental
 */
// eslint-disable-next-line deprecation/deprecation
export const BrowserProfilingIntegration = convertIntegrationFnToClass(INTEGRATION_NAME, browserProfilingIntegration);
export const BrowserProfilingIntegration = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserProfilingIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }>;

1 change: 0 additions & 1 deletion
packages/browser/test/unit/profiling/integration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,6 @@ describe('BrowserProfilingIntegration', () => {
 Sentry.init({
 tracesSampleRate: 1,
 profilesSampleRate: 1,
 debug: true,
 environment: 'test-environment',
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 transport: _opts => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

const INTEGRATION_NAME = 'BunServer';

const bunServerIntegration: IntegrationFn = () => {
const bunServerIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentBunServe();
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand Down

17 changes: 5 additions & 12 deletions
packages/core/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, Options } from '@sentry/types';
import { arrayify, logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
Expand DownExpand Up@@ -169,18 +169,11 @@ function findIndex<T>(arr: T[], callback: (item: T) => boolean): number {
export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
 name: string,
 fn: Fn,
): Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
} {
): IntegrationClass<Integration> {
 return Object.assign(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ConvertedIntegration(...rest: Parameters<Fn>) {
 return fn(...rest);
 function ConvertedIntegration(...args: Parameters<Fn>): Integration {
 return fn(...args);
 },
 { id: name },
 ) as unknown as Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
 };
 ) as unknown as IntegrationClass<Integration>;
}

11 changes: 7 additions & 4 deletions
packages/core/src/integrations/functiontostring.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { getOriginalFunction } from '@sentry/utils';
import { convertIntegrationFnToClass } from '../integration';

let originalFunctionToString: () => void;

const INTEGRATION_NAME = 'FunctionToString';

const functionToStringIntegration: IntegrationFn = () => {
const functionToStringIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
Expand All@@ -26,8 +26,11 @@ const functionToStringIntegration: IntegrationFn = () => {
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Patch toString calls to return proper name for wrapped functions */
// eslint-disable-next-line deprecation/deprecation
export const FunctionToString = convertIntegrationFnToClass(INTEGRATION_NAME, functionToStringIntegration);
export const FunctionToString = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 functionToStringIntegration,
) as IntegrationClass<Integration & { setupOnce: () => void }>;

23 changes: 19 additions & 4 deletions
packages/core/src/integrations/inboundfilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Event, IntegrationFn, StackFrame } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { getEventDescription, logger, stringMatchesSomePattern } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
Expand DownExpand Up@@ -30,7 +30,7 @@ export interface InboundFiltersOptions {
}

const INTEGRATION_NAME = 'InboundFilters';
const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFiltersOptions>) => {
const inboundFiltersIntegration= ((options: Partial<InboundFiltersOptions> = {}) => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -41,11 +41,26 @@ const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFilter
 return _shouldDropEvent(event, mergedOptions) ? null : event;
 },
 };
};
}) satisfies IntegrationFn;

/** Inbound filters configurable by the user */
// eslint-disable-next-line deprecation/deprecation
export const InboundFilters = convertIntegrationFnToClass(INTEGRATION_NAME, inboundFiltersIntegration);
export const InboundFilters = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 inboundFiltersIntegration,
) as IntegrationClass<Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }> & {
 new (
 options?: Partial<{
 allowUrls: Array<string | RegExp>;
 denyUrls: Array<string | RegExp>;
 ignoreErrors: Array<string | RegExp>;
 ignoreTransactions: Array<string | RegExp>;
 ignoreInternal: boolean;
 disableErrorDefaults: boolean;
 disableTransactionDefaults: boolean;
 }>,
 ): Integration;
};

function _mergeOptions(
 internalOptions: Partial<InboundFiltersOptions> = {},
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
fix: Ensure all integration classes have correct types#10183

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 16, 2024
 Merged


fix: Ensure all integration classes have correct types
#10183
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


26 changes: 23 additions & 3 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,8 @@ import type {
 HandlerDataFetch,
 HandlerDataHistory,
 HandlerDataXhr,
 Integration,
 IntegrationClass,
 IntegrationFn,
} from '@sentry/types';
import type {
Expand DownExpand Up@@ -55,7 +57,7 @@ const MAX_ALLOWED_STRING_LENGTH = 1024;

const INTEGRATION_NAME = 'Breadcrumbs';

const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptions> = {}) => {
const breadcrumbsIntegration = ((options: Partial<BreadcrumbsOptions> = {}) => {
 const _options = {
 console: true,
 dom: true,
Expand DownExpand Up@@ -91,13 +93,31 @@ const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptio
 }
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Default Breadcrumbs instrumentations
 */
// eslint-disable-next-line deprecation/deprecation
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration);
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration) as IntegrationClass<
 Integration & { setup: (client: Client) => void }
> & {
 new (
 options?: Partial<{
 console: boolean;
 dom:
 | boolean
 | {
 serializeAttribute?: string | string[];
 maxStringLength?: number;
 };
 fetch: boolean;
 history: boolean;
 sentry: boolean;
 xhr: boolean;
 }>,
 ): Integration;
};

/**
 * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/dedupe.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackFrame } from '@sentry/types';
import type { Event, Exception, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';

const INTEGRATION_NAME = 'Dedupe';

const dedupeIntegration: IntegrationFn = () => {
const dedupeIntegration = (() => {
 let previousEvent: Event | undefined;

 return {
Expand All@@ -31,11 +31,13 @@ const dedupeIntegration: IntegrationFn = () => {
 return (previousEvent = currentEvent);
 },
 };
};
}) satisfies IntegrationFn;

/** Deduplication filter */
// eslint-disable-next-line deprecation/deprecation
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration);
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration) as IntegrationClass<
 Integration & { processEvent: (event: Event) => Event }
>;

function _shouldDropEvent(currentEvent: Event, previousEvent?: Event): boolean {
 if (!previousEvent) {
Expand Down

21 changes: 17 additions & 4 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { captureEvent, convertIntegrationFnToClass, getClient } from '@sentry/core';
import type { Client, Event, IntegrationFn, Primitive, StackParser } from '@sentry/types';
import type {
 Client,
 Event,
 Integration,
 IntegrationClass,
 IntegrationFn,
 Primitive,
 StackParser,
} from '@sentry/types';
import {
 addGlobalErrorInstrumentationHandler,
 addGlobalUnhandledRejectionInstrumentationHandler,
Expand All@@ -22,7 +30,7 @@ type GlobalHandlersIntegrations = Record<GlobalHandlersIntegrationsOptionKeys, b

const INTEGRATION_NAME = 'GlobalHandlers';

const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandlersIntegrations> = {}) => {
const globalHandlersIntegration = ((options: Partial<GlobalHandlersIntegrations> = {}) => {
 const _options = {
 onerror: true,
 onunhandledrejection: true,
Expand All@@ -45,11 +53,16 @@ const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandle
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Global handlers */
// eslint-disable-next-line deprecation/deprecation
export const GlobalHandlers = convertIntegrationFnToClass(INTEGRATION_NAME, globalHandlersIntegrations);
export const GlobalHandlers = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 globalHandlersIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }> & {
 new (options?: Partial<GlobalHandlersIntegrations>): Integration;
};

function _installGlobalOnErrorHandler(client: Client): void {
 addGlobalErrorInstrumentationHandler(data => {
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Event, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';

import { WINDOW } from '../helpers';

const INTEGRATION_NAME = 'HttpContext';

const httpContextIntegration: IntegrationFn = () => {
const httpContextIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -31,8 +31,10 @@ const httpContextIntegration: IntegrationFn = () => {
 event.request = request;
 },
 };
};
}) satisfies IntegrationFn;

/** HttpContext integration collects information about HTTP request headers */
// eslint-disable-next-line deprecation/deprecation
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration);
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event) => void }
>;

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
import { applyAggregateErrorsToEvent } from '@sentry/utils';
import { exceptionFromError } from '../eventbuilder';

Expand All@@ -13,7 +13,7 @@ const DEFAULT_LIMIT = 5;

const INTEGRATION_NAME = 'LinkedErrors';

const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {}) => {
const linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
 const limit = options.limit || DEFAULT_LIMIT;
 const key = options.key || DEFAULT_KEY;

Expand All@@ -36,8 +36,10 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
 );
 },
 };
};
}) satisfies IntegrationFn;

/** Aggregrate linked errors in an event. */
// eslint-disable-next-line deprecation/deprecation
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration);
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }
> & { new (options?: { key?: string; limit?: number }): Integration };

19 changes: 15 additions & 4 deletions
packages/browser/src/integrations/trycatch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { fill, getFunctionName, getOriginalFunction } from '@sentry/utils';

import { WINDOW, wrap } from '../helpers';
Expand DownExpand Up@@ -50,7 +50,7 @@ interface TryCatchOptions {
 eventTarget: boolean | string[];
}

const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> = {}) => {
const browserApiErrorsIntegration = ((options: Partial<TryCatchOptions> = {}) => {
 const _options = {
 XMLHttpRequest: true,
 eventTarget: true,
Expand DownExpand Up@@ -88,11 +88,22 @@ const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> =
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Wrap timer functions and event targets to catch errors and provide better meta data */
// eslint-disable-next-line deprecation/deprecation
export const TryCatch = convertIntegrationFnToClass(INTEGRATION_NAME, tryCatchIntegration);
export const TryCatch = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserApiErrorsIntegration,
) as IntegrationClass<Integration> & {
 new (options?: {
 setTimeout: boolean;
 setInterval: boolean;
 requestAnimationFrame: boolean;
 XMLHttpRequest: boolean;
 eventTarget: boolean | string[];
 }): Integration;
};

function _wrapTimeFunction(original: () => void): () => number {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down

11 changes: 7 additions & 4 deletions
packages/browser/src/profiling/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass, getCurrentScope } from '@sentry/core';
import type { EventEnvelope, IntegrationFn, Transaction } from '@sentry/types';
import type { Client, EventEnvelope, Integration, IntegrationClass, IntegrationFn, Transaction } from '@sentry/types';
import type { Profile } from '@sentry/types/src/profiling';
import { logger } from '@sentry/utils';

Expand All@@ -18,7 +18,7 @@ import {

const INTEGRATION_NAME = 'BrowserProfiling';

const browserProfilingIntegration: IntegrationFn = () => {
const browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand DownExpand Up@@ -100,7 +100,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 });
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Browser profiling integration. Stores any event that has contexts["profile"]["profile_id"]
Expand All@@ -112,4 +112,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 * @experimental
 */
// eslint-disable-next-line deprecation/deprecation
export const BrowserProfilingIntegration = convertIntegrationFnToClass(INTEGRATION_NAME, browserProfilingIntegration);
export const BrowserProfilingIntegration = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserProfilingIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }>;

1 change: 0 additions & 1 deletion
packages/browser/test/unit/profiling/integration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,6 @@ describe('BrowserProfilingIntegration', () => {
 Sentry.init({
 tracesSampleRate: 1,
 profilesSampleRate: 1,
 debug: true,
 environment: 'test-environment',
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 transport: _opts => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

const INTEGRATION_NAME = 'BunServer';

const bunServerIntegration: IntegrationFn = () => {
const bunServerIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentBunServe();
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand Down

17 changes: 5 additions & 12 deletions
packages/core/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, Options } from '@sentry/types';
import { arrayify, logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
Expand DownExpand Up@@ -169,18 +169,11 @@ function findIndex<T>(arr: T[], callback: (item: T) => boolean): number {
export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
 name: string,
 fn: Fn,
): Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
} {
): IntegrationClass<Integration> {
 return Object.assign(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ConvertedIntegration(...rest: Parameters<Fn>) {
 return fn(...rest);
 function ConvertedIntegration(...args: Parameters<Fn>): Integration {
 return fn(...args);
 },
 { id: name },
 ) as unknown as Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
 };
 ) as unknown as IntegrationClass<Integration>;
}

11 changes: 7 additions & 4 deletions
packages/core/src/integrations/functiontostring.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { getOriginalFunction } from '@sentry/utils';
import { convertIntegrationFnToClass } from '../integration';

let originalFunctionToString: () => void;

const INTEGRATION_NAME = 'FunctionToString';

const functionToStringIntegration: IntegrationFn = () => {
const functionToStringIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
Expand All@@ -26,8 +26,11 @@ const functionToStringIntegration: IntegrationFn = () => {
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Patch toString calls to return proper name for wrapped functions */
// eslint-disable-next-line deprecation/deprecation
export const FunctionToString = convertIntegrationFnToClass(INTEGRATION_NAME, functionToStringIntegration);
export const FunctionToString = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 functionToStringIntegration,
) as IntegrationClass<Integration & { setupOnce: () => void }>;

23 changes: 19 additions & 4 deletions
packages/core/src/integrations/inboundfilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Event, IntegrationFn, StackFrame } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { getEventDescription, logger, stringMatchesSomePattern } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
Expand DownExpand Up@@ -30,7 +30,7 @@ export interface InboundFiltersOptions {
}

const INTEGRATION_NAME = 'InboundFilters';
const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFiltersOptions>) => {
const inboundFiltersIntegration= ((options: Partial<InboundFiltersOptions> = {}) => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -41,11 +41,26 @@ const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFilter
 return _shouldDropEvent(event, mergedOptions) ? null : event;
 },
 };
};
}) satisfies IntegrationFn;

/** Inbound filters configurable by the user */
// eslint-disable-next-line deprecation/deprecation
export const InboundFilters = convertIntegrationFnToClass(INTEGRATION_NAME, inboundFiltersIntegration);
export const InboundFilters = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 inboundFiltersIntegration,
) as IntegrationClass<Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }> & {
 new (
 options?: Partial<{
 allowUrls: Array<string | RegExp>;
 denyUrls: Array<string | RegExp>;
 ignoreErrors: Array<string | RegExp>;
 ignoreTransactions: Array<string | RegExp>;
 ignoreInternal: boolean;
 disableErrorDefaults: boolean;
 disableTransactionDefaults: boolean;
 }>,
 ): Integration;
};

function _mergeOptions(
 internalOptions: Partial<InboundFiltersOptions> = {},
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
fix: Ensure all integration classes have correct types#10183

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 16, 2024
 Merged


fix: Ensure all integration classes have correct types
#10183
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


26 changes: 23 additions & 3 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,8 @@ import type {
 HandlerDataFetch,
 HandlerDataHistory,
 HandlerDataXhr,
 Integration,
 IntegrationClass,
 IntegrationFn,
} from '@sentry/types';
import type {
Expand DownExpand Up@@ -55,7 +57,7 @@ const MAX_ALLOWED_STRING_LENGTH = 1024;

const INTEGRATION_NAME = 'Breadcrumbs';

const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptions> = {}) => {
const breadcrumbsIntegration = ((options: Partial<BreadcrumbsOptions> = {}) => {
 const _options = {
 console: true,
 dom: true,
Expand DownExpand Up@@ -91,13 +93,31 @@ const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptio
 }
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Default Breadcrumbs instrumentations
 */
// eslint-disable-next-line deprecation/deprecation
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration);
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration) as IntegrationClass<
 Integration & { setup: (client: Client) => void }
> & {
 new (
 options?: Partial<{
 console: boolean;
 dom:
 | boolean
 | {
 serializeAttribute?: string | string[];
 maxStringLength?: number;
 };
 fetch: boolean;
 history: boolean;
 sentry: boolean;
 xhr: boolean;
 }>,
 ): Integration;
};

/**
 * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/dedupe.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackFrame } from '@sentry/types';
import type { Event, Exception, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';

const INTEGRATION_NAME = 'Dedupe';

const dedupeIntegration: IntegrationFn = () => {
const dedupeIntegration = (() => {
 let previousEvent: Event | undefined;

 return {
Expand All@@ -31,11 +31,13 @@ const dedupeIntegration: IntegrationFn = () => {
 return (previousEvent = currentEvent);
 },
 };
};
}) satisfies IntegrationFn;

/** Deduplication filter */
// eslint-disable-next-line deprecation/deprecation
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration);
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration) as IntegrationClass<
 Integration & { processEvent: (event: Event) => Event }
>;

function _shouldDropEvent(currentEvent: Event, previousEvent?: Event): boolean {
 if (!previousEvent) {
Expand Down

21 changes: 17 additions & 4 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { captureEvent, convertIntegrationFnToClass, getClient } from '@sentry/core';
import type { Client, Event, IntegrationFn, Primitive, StackParser } from '@sentry/types';
import type {
 Client,
 Event,
 Integration,
 IntegrationClass,
 IntegrationFn,
 Primitive,
 StackParser,
} from '@sentry/types';
import {
 addGlobalErrorInstrumentationHandler,
 addGlobalUnhandledRejectionInstrumentationHandler,
Expand All@@ -22,7 +30,7 @@ type GlobalHandlersIntegrations = Record<GlobalHandlersIntegrationsOptionKeys, b

const INTEGRATION_NAME = 'GlobalHandlers';

const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandlersIntegrations> = {}) => {
const globalHandlersIntegration = ((options: Partial<GlobalHandlersIntegrations> = {}) => {
 const _options = {
 onerror: true,
 onunhandledrejection: true,
Expand All@@ -45,11 +53,16 @@ const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandle
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Global handlers */
// eslint-disable-next-line deprecation/deprecation
export const GlobalHandlers = convertIntegrationFnToClass(INTEGRATION_NAME, globalHandlersIntegrations);
export const GlobalHandlers = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 globalHandlersIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }> & {
 new (options?: Partial<GlobalHandlersIntegrations>): Integration;
};

function _installGlobalOnErrorHandler(client: Client): void {
 addGlobalErrorInstrumentationHandler(data => {
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Event, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';

import { WINDOW } from '../helpers';

const INTEGRATION_NAME = 'HttpContext';

const httpContextIntegration: IntegrationFn = () => {
const httpContextIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -31,8 +31,10 @@ const httpContextIntegration: IntegrationFn = () => {
 event.request = request;
 },
 };
};
}) satisfies IntegrationFn;

/** HttpContext integration collects information about HTTP request headers */
// eslint-disable-next-line deprecation/deprecation
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration);
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event) => void }
>;

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
import { applyAggregateErrorsToEvent } from '@sentry/utils';
import { exceptionFromError } from '../eventbuilder';

Expand All@@ -13,7 +13,7 @@ const DEFAULT_LIMIT = 5;

const INTEGRATION_NAME = 'LinkedErrors';

const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {}) => {
const linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
 const limit = options.limit || DEFAULT_LIMIT;
 const key = options.key || DEFAULT_KEY;

Expand All@@ -36,8 +36,10 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
 );
 },
 };
};
}) satisfies IntegrationFn;

/** Aggregrate linked errors in an event. */
// eslint-disable-next-line deprecation/deprecation
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration);
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }
> & { new (options?: { key?: string; limit?: number }): Integration };

19 changes: 15 additions & 4 deletions
packages/browser/src/integrations/trycatch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { fill, getFunctionName, getOriginalFunction } from '@sentry/utils';

import { WINDOW, wrap } from '../helpers';
Expand DownExpand Up@@ -50,7 +50,7 @@ interface TryCatchOptions {
 eventTarget: boolean | string[];
}

const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> = {}) => {
const browserApiErrorsIntegration = ((options: Partial<TryCatchOptions> = {}) => {
 const _options = {
 XMLHttpRequest: true,
 eventTarget: true,
Expand DownExpand Up@@ -88,11 +88,22 @@ const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> =
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Wrap timer functions and event targets to catch errors and provide better meta data */
// eslint-disable-next-line deprecation/deprecation
export const TryCatch = convertIntegrationFnToClass(INTEGRATION_NAME, tryCatchIntegration);
export const TryCatch = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserApiErrorsIntegration,
) as IntegrationClass<Integration> & {
 new (options?: {
 setTimeout: boolean;
 setInterval: boolean;
 requestAnimationFrame: boolean;
 XMLHttpRequest: boolean;
 eventTarget: boolean | string[];
 }): Integration;
};

function _wrapTimeFunction(original: () => void): () => number {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down

11 changes: 7 additions & 4 deletions
packages/browser/src/profiling/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass, getCurrentScope } from '@sentry/core';
import type { EventEnvelope, IntegrationFn, Transaction } from '@sentry/types';
import type { Client, EventEnvelope, Integration, IntegrationClass, IntegrationFn, Transaction } from '@sentry/types';
import type { Profile } from '@sentry/types/src/profiling';
import { logger } from '@sentry/utils';

Expand All@@ -18,7 +18,7 @@ import {

const INTEGRATION_NAME = 'BrowserProfiling';

const browserProfilingIntegration: IntegrationFn = () => {
const browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand DownExpand Up@@ -100,7 +100,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 });
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Browser profiling integration. Stores any event that has contexts["profile"]["profile_id"]
Expand All@@ -112,4 +112,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 * @experimental
 */
// eslint-disable-next-line deprecation/deprecation
export const BrowserProfilingIntegration = convertIntegrationFnToClass(INTEGRATION_NAME, browserProfilingIntegration);
export const BrowserProfilingIntegration = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserProfilingIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }>;

1 change: 0 additions & 1 deletion
packages/browser/test/unit/profiling/integration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,6 @@ describe('BrowserProfilingIntegration', () => {
 Sentry.init({
 tracesSampleRate: 1,
 profilesSampleRate: 1,
 debug: true,
 environment: 'test-environment',
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 transport: _opts => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

const INTEGRATION_NAME = 'BunServer';

const bunServerIntegration: IntegrationFn = () => {
const bunServerIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentBunServe();
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand Down

17 changes: 5 additions & 12 deletions
packages/core/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, Options } from '@sentry/types';
import { arrayify, logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
Expand DownExpand Up@@ -169,18 +169,11 @@ function findIndex<T>(arr: T[], callback: (item: T) => boolean): number {
export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
 name: string,
 fn: Fn,
): Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
} {
): IntegrationClass<Integration> {
 return Object.assign(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ConvertedIntegration(...rest: Parameters<Fn>) {
 return fn(...rest);
 function ConvertedIntegration(...args: Parameters<Fn>): Integration {
 return fn(...args);
 },
 { id: name },
 ) as unknown as Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
 };
 ) as unknown as IntegrationClass<Integration>;
}

11 changes: 7 additions & 4 deletions
packages/core/src/integrations/functiontostring.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { getOriginalFunction } from '@sentry/utils';
import { convertIntegrationFnToClass } from '../integration';

let originalFunctionToString: () => void;

const INTEGRATION_NAME = 'FunctionToString';

const functionToStringIntegration: IntegrationFn = () => {
const functionToStringIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
Expand All@@ -26,8 +26,11 @@ const functionToStringIntegration: IntegrationFn = () => {
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Patch toString calls to return proper name for wrapped functions */
// eslint-disable-next-line deprecation/deprecation
export const FunctionToString = convertIntegrationFnToClass(INTEGRATION_NAME, functionToStringIntegration);
export const FunctionToString = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 functionToStringIntegration,
) as IntegrationClass<Integration & { setupOnce: () => void }>;

23 changes: 19 additions & 4 deletions
packages/core/src/integrations/inboundfilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Event, IntegrationFn, StackFrame } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { getEventDescription, logger, stringMatchesSomePattern } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
Expand DownExpand Up@@ -30,7 +30,7 @@ export interface InboundFiltersOptions {
}

const INTEGRATION_NAME = 'InboundFilters';
const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFiltersOptions>) => {
const inboundFiltersIntegration= ((options: Partial<InboundFiltersOptions> = {}) => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -41,11 +41,26 @@ const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFilter
 return _shouldDropEvent(event, mergedOptions) ? null : event;
 },
 };
};
}) satisfies IntegrationFn;

/** Inbound filters configurable by the user */
// eslint-disable-next-line deprecation/deprecation
export const InboundFilters = convertIntegrationFnToClass(INTEGRATION_NAME, inboundFiltersIntegration);
export const InboundFilters = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 inboundFiltersIntegration,
) as IntegrationClass<Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }> & {
 new (
 options?: Partial<{
 allowUrls: Array<string | RegExp>;
 denyUrls: Array<string | RegExp>;
 ignoreErrors: Array<string | RegExp>;
 ignoreTransactions: Array<string | RegExp>;
 ignoreInternal: boolean;
 disableErrorDefaults: boolean;
 disableTransactionDefaults: boolean;
 }>,
 ): Integration;
};

function _mergeOptions(
 internalOptions: Partial<InboundFiltersOptions> = {},
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
fix: Ensure all integration classes have correct types#10183

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 16, 2024
 Merged


fix: Ensure all integration classes have correct types
#10183
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


26 changes: 23 additions & 3 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,8 @@ import type {
 HandlerDataFetch,
 HandlerDataHistory,
 HandlerDataXhr,
 Integration,
 IntegrationClass,
 IntegrationFn,
} from '@sentry/types';
import type {
Expand DownExpand Up@@ -55,7 +57,7 @@ const MAX_ALLOWED_STRING_LENGTH = 1024;

const INTEGRATION_NAME = 'Breadcrumbs';

const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptions> = {}) => {
const breadcrumbsIntegration = ((options: Partial<BreadcrumbsOptions> = {}) => {
 const _options = {
 console: true,
 dom: true,
Expand DownExpand Up@@ -91,13 +93,31 @@ const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptio
 }
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Default Breadcrumbs instrumentations
 */
// eslint-disable-next-line deprecation/deprecation
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration);
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration) as IntegrationClass<
 Integration & { setup: (client: Client) => void }
> & {
 new (
 options?: Partial<{
 console: boolean;
 dom:
 | boolean
 | {
 serializeAttribute?: string | string[];
 maxStringLength?: number;
 };
 fetch: boolean;
 history: boolean;
 sentry: boolean;
 xhr: boolean;
 }>,
 ): Integration;
};

/**
 * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/dedupe.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackFrame } from '@sentry/types';
import type { Event, Exception, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';

const INTEGRATION_NAME = 'Dedupe';

const dedupeIntegration: IntegrationFn = () => {
const dedupeIntegration = (() => {
 let previousEvent: Event | undefined;

 return {
Expand All@@ -31,11 +31,13 @@ const dedupeIntegration: IntegrationFn = () => {
 return (previousEvent = currentEvent);
 },
 };
};
}) satisfies IntegrationFn;

/** Deduplication filter */
// eslint-disable-next-line deprecation/deprecation
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration);
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration) as IntegrationClass<
 Integration & { processEvent: (event: Event) => Event }
>;

function _shouldDropEvent(currentEvent: Event, previousEvent?: Event): boolean {
 if (!previousEvent) {
Expand Down

21 changes: 17 additions & 4 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { captureEvent, convertIntegrationFnToClass, getClient } from '@sentry/core';
import type { Client, Event, IntegrationFn, Primitive, StackParser } from '@sentry/types';
import type {
 Client,
 Event,
 Integration,
 IntegrationClass,
 IntegrationFn,
 Primitive,
 StackParser,
} from '@sentry/types';
import {
 addGlobalErrorInstrumentationHandler,
 addGlobalUnhandledRejectionInstrumentationHandler,
Expand All@@ -22,7 +30,7 @@ type GlobalHandlersIntegrations = Record<GlobalHandlersIntegrationsOptionKeys, b

const INTEGRATION_NAME = 'GlobalHandlers';

const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandlersIntegrations> = {}) => {
const globalHandlersIntegration = ((options: Partial<GlobalHandlersIntegrations> = {}) => {
 const _options = {
 onerror: true,
 onunhandledrejection: true,
Expand All@@ -45,11 +53,16 @@ const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandle
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Global handlers */
// eslint-disable-next-line deprecation/deprecation
export const GlobalHandlers = convertIntegrationFnToClass(INTEGRATION_NAME, globalHandlersIntegrations);
export const GlobalHandlers = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 globalHandlersIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }> & {
 new (options?: Partial<GlobalHandlersIntegrations>): Integration;
};

function _installGlobalOnErrorHandler(client: Client): void {
 addGlobalErrorInstrumentationHandler(data => {
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Event, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';

import { WINDOW } from '../helpers';

const INTEGRATION_NAME = 'HttpContext';

const httpContextIntegration: IntegrationFn = () => {
const httpContextIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -31,8 +31,10 @@ const httpContextIntegration: IntegrationFn = () => {
 event.request = request;
 },
 };
};
}) satisfies IntegrationFn;

/** HttpContext integration collects information about HTTP request headers */
// eslint-disable-next-line deprecation/deprecation
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration);
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event) => void }
>;

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
import { applyAggregateErrorsToEvent } from '@sentry/utils';
import { exceptionFromError } from '../eventbuilder';

Expand All@@ -13,7 +13,7 @@ const DEFAULT_LIMIT = 5;

const INTEGRATION_NAME = 'LinkedErrors';

const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {}) => {
const linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
 const limit = options.limit || DEFAULT_LIMIT;
 const key = options.key || DEFAULT_KEY;

Expand All@@ -36,8 +36,10 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
 );
 },
 };
};
}) satisfies IntegrationFn;

/** Aggregrate linked errors in an event. */
// eslint-disable-next-line deprecation/deprecation
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration);
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }
> & { new (options?: { key?: string; limit?: number }): Integration };

19 changes: 15 additions & 4 deletions
packages/browser/src/integrations/trycatch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { fill, getFunctionName, getOriginalFunction } from '@sentry/utils';

import { WINDOW, wrap } from '../helpers';
Expand DownExpand Up@@ -50,7 +50,7 @@ interface TryCatchOptions {
 eventTarget: boolean | string[];
}

const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> = {}) => {
const browserApiErrorsIntegration = ((options: Partial<TryCatchOptions> = {}) => {
 const _options = {
 XMLHttpRequest: true,
 eventTarget: true,
Expand DownExpand Up@@ -88,11 +88,22 @@ const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> =
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Wrap timer functions and event targets to catch errors and provide better meta data */
// eslint-disable-next-line deprecation/deprecation
export const TryCatch = convertIntegrationFnToClass(INTEGRATION_NAME, tryCatchIntegration);
export const TryCatch = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserApiErrorsIntegration,
) as IntegrationClass<Integration> & {
 new (options?: {
 setTimeout: boolean;
 setInterval: boolean;
 requestAnimationFrame: boolean;
 XMLHttpRequest: boolean;
 eventTarget: boolean | string[];
 }): Integration;
};

function _wrapTimeFunction(original: () => void): () => number {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down

11 changes: 7 additions & 4 deletions
packages/browser/src/profiling/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass, getCurrentScope } from '@sentry/core';
import type { EventEnvelope, IntegrationFn, Transaction } from '@sentry/types';
import type { Client, EventEnvelope, Integration, IntegrationClass, IntegrationFn, Transaction } from '@sentry/types';
import type { Profile } from '@sentry/types/src/profiling';
import { logger } from '@sentry/utils';

Expand All@@ -18,7 +18,7 @@ import {

const INTEGRATION_NAME = 'BrowserProfiling';

const browserProfilingIntegration: IntegrationFn = () => {
const browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand DownExpand Up@@ -100,7 +100,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 });
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Browser profiling integration. Stores any event that has contexts["profile"]["profile_id"]
Expand All@@ -112,4 +112,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 * @experimental
 */
// eslint-disable-next-line deprecation/deprecation
export const BrowserProfilingIntegration = convertIntegrationFnToClass(INTEGRATION_NAME, browserProfilingIntegration);
export const BrowserProfilingIntegration = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserProfilingIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }>;

1 change: 0 additions & 1 deletion
packages/browser/test/unit/profiling/integration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,6 @@ describe('BrowserProfilingIntegration', () => {
 Sentry.init({
 tracesSampleRate: 1,
 profilesSampleRate: 1,
 debug: true,
 environment: 'test-environment',
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 transport: _opts => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

const INTEGRATION_NAME = 'BunServer';

const bunServerIntegration: IntegrationFn = () => {
const bunServerIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentBunServe();
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand Down

17 changes: 5 additions & 12 deletions
packages/core/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, Options } from '@sentry/types';
import { arrayify, logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
Expand DownExpand Up@@ -169,18 +169,11 @@ function findIndex<T>(arr: T[], callback: (item: T) => boolean): number {
export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
 name: string,
 fn: Fn,
): Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
} {
): IntegrationClass<Integration> {
 return Object.assign(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ConvertedIntegration(...rest: Parameters<Fn>) {
 return fn(...rest);
 function ConvertedIntegration(...args: Parameters<Fn>): Integration {
 return fn(...args);
 },
 { id: name },
 ) as unknown as Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
 };
 ) as unknown as IntegrationClass<Integration>;
}

11 changes: 7 additions & 4 deletions
packages/core/src/integrations/functiontostring.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { getOriginalFunction } from '@sentry/utils';
import { convertIntegrationFnToClass } from '../integration';

let originalFunctionToString: () => void;

const INTEGRATION_NAME = 'FunctionToString';

const functionToStringIntegration: IntegrationFn = () => {
const functionToStringIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
Expand All@@ -26,8 +26,11 @@ const functionToStringIntegration: IntegrationFn = () => {
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Patch toString calls to return proper name for wrapped functions */
// eslint-disable-next-line deprecation/deprecation
export const FunctionToString = convertIntegrationFnToClass(INTEGRATION_NAME, functionToStringIntegration);
export const FunctionToString = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 functionToStringIntegration,
) as IntegrationClass<Integration & { setupOnce: () => void }>;

23 changes: 19 additions & 4 deletions
packages/core/src/integrations/inboundfilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Event, IntegrationFn, StackFrame } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { getEventDescription, logger, stringMatchesSomePattern } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
Expand DownExpand Up@@ -30,7 +30,7 @@ export interface InboundFiltersOptions {
}

const INTEGRATION_NAME = 'InboundFilters';
const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFiltersOptions>) => {
const inboundFiltersIntegration= ((options: Partial<InboundFiltersOptions> = {}) => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -41,11 +41,26 @@ const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFilter
 return _shouldDropEvent(event, mergedOptions) ? null : event;
 },
 };
};
}) satisfies IntegrationFn;

/** Inbound filters configurable by the user */
// eslint-disable-next-line deprecation/deprecation
export const InboundFilters = convertIntegrationFnToClass(INTEGRATION_NAME, inboundFiltersIntegration);
export const InboundFilters = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 inboundFiltersIntegration,
) as IntegrationClass<Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }> & {
 new (
 options?: Partial<{
 allowUrls: Array<string | RegExp>;
 denyUrls: Array<string | RegExp>;
 ignoreErrors: Array<string | RegExp>;
 ignoreTransactions: Array<string | RegExp>;
 ignoreInternal: boolean;
 disableErrorDefaults: boolean;
 disableTransactionDefaults: boolean;
 }>,
 ): Integration;
};

function _mergeOptions(
 internalOptions: Partial<InboundFiltersOptions> = {},
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
fix: Ensure all integration classes have correct types#10183

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 16, 2024
 Merged


fix: Ensure all integration classes have correct types
#10183
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


26 changes: 23 additions & 3 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,8 @@ import type {
 HandlerDataFetch,
 HandlerDataHistory,
 HandlerDataXhr,
 Integration,
 IntegrationClass,
 IntegrationFn,
} from '@sentry/types';
import type {
Expand DownExpand Up@@ -55,7 +57,7 @@ const MAX_ALLOWED_STRING_LENGTH = 1024;

const INTEGRATION_NAME = 'Breadcrumbs';

const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptions> = {}) => {
const breadcrumbsIntegration = ((options: Partial<BreadcrumbsOptions> = {}) => {
 const _options = {
 console: true,
 dom: true,
Expand DownExpand Up@@ -91,13 +93,31 @@ const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptio
 }
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Default Breadcrumbs instrumentations
 */
// eslint-disable-next-line deprecation/deprecation
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration);
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration) as IntegrationClass<
 Integration & { setup: (client: Client) => void }
> & {
 new (
 options?: Partial<{
 console: boolean;
 dom:
 | boolean
 | {
 serializeAttribute?: string | string[];
 maxStringLength?: number;
 };
 fetch: boolean;
 history: boolean;
 sentry: boolean;
 xhr: boolean;
 }>,
 ): Integration;
};

/**
 * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/dedupe.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackFrame } from '@sentry/types';
import type { Event, Exception, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';

const INTEGRATION_NAME = 'Dedupe';

const dedupeIntegration: IntegrationFn = () => {
const dedupeIntegration = (() => {
 let previousEvent: Event | undefined;

 return {
Expand All@@ -31,11 +31,13 @@ const dedupeIntegration: IntegrationFn = () => {
 return (previousEvent = currentEvent);
 },
 };
};
}) satisfies IntegrationFn;

/** Deduplication filter */
// eslint-disable-next-line deprecation/deprecation
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration);
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration) as IntegrationClass<
 Integration & { processEvent: (event: Event) => Event }
>;

function _shouldDropEvent(currentEvent: Event, previousEvent?: Event): boolean {
 if (!previousEvent) {
Expand Down

21 changes: 17 additions & 4 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { captureEvent, convertIntegrationFnToClass, getClient } from '@sentry/core';
import type { Client, Event, IntegrationFn, Primitive, StackParser } from '@sentry/types';
import type {
 Client,
 Event,
 Integration,
 IntegrationClass,
 IntegrationFn,
 Primitive,
 StackParser,
} from '@sentry/types';
import {
 addGlobalErrorInstrumentationHandler,
 addGlobalUnhandledRejectionInstrumentationHandler,
Expand All@@ -22,7 +30,7 @@ type GlobalHandlersIntegrations = Record<GlobalHandlersIntegrationsOptionKeys, b

const INTEGRATION_NAME = 'GlobalHandlers';

const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandlersIntegrations> = {}) => {
const globalHandlersIntegration = ((options: Partial<GlobalHandlersIntegrations> = {}) => {
 const _options = {
 onerror: true,
 onunhandledrejection: true,
Expand All@@ -45,11 +53,16 @@ const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandle
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Global handlers */
// eslint-disable-next-line deprecation/deprecation
export const GlobalHandlers = convertIntegrationFnToClass(INTEGRATION_NAME, globalHandlersIntegrations);
export const GlobalHandlers = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 globalHandlersIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }> & {
 new (options?: Partial<GlobalHandlersIntegrations>): Integration;
};

function _installGlobalOnErrorHandler(client: Client): void {
 addGlobalErrorInstrumentationHandler(data => {
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Event, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';

import { WINDOW } from '../helpers';

const INTEGRATION_NAME = 'HttpContext';

const httpContextIntegration: IntegrationFn = () => {
const httpContextIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -31,8 +31,10 @@ const httpContextIntegration: IntegrationFn = () => {
 event.request = request;
 },
 };
};
}) satisfies IntegrationFn;

/** HttpContext integration collects information about HTTP request headers */
// eslint-disable-next-line deprecation/deprecation
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration);
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event) => void }
>;

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
import { applyAggregateErrorsToEvent } from '@sentry/utils';
import { exceptionFromError } from '../eventbuilder';

Expand All@@ -13,7 +13,7 @@ const DEFAULT_LIMIT = 5;

const INTEGRATION_NAME = 'LinkedErrors';

const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {}) => {
const linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
 const limit = options.limit || DEFAULT_LIMIT;
 const key = options.key || DEFAULT_KEY;

Expand All@@ -36,8 +36,10 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
 );
 },
 };
};
}) satisfies IntegrationFn;

/** Aggregrate linked errors in an event. */
// eslint-disable-next-line deprecation/deprecation
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration);
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }
> & { new (options?: { key?: string; limit?: number }): Integration };

19 changes: 15 additions & 4 deletions
packages/browser/src/integrations/trycatch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { fill, getFunctionName, getOriginalFunction } from '@sentry/utils';

import { WINDOW, wrap } from '../helpers';
Expand DownExpand Up@@ -50,7 +50,7 @@ interface TryCatchOptions {
 eventTarget: boolean | string[];
}

const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> = {}) => {
const browserApiErrorsIntegration = ((options: Partial<TryCatchOptions> = {}) => {
 const _options = {
 XMLHttpRequest: true,
 eventTarget: true,
Expand DownExpand Up@@ -88,11 +88,22 @@ const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> =
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Wrap timer functions and event targets to catch errors and provide better meta data */
// eslint-disable-next-line deprecation/deprecation
export const TryCatch = convertIntegrationFnToClass(INTEGRATION_NAME, tryCatchIntegration);
export const TryCatch = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserApiErrorsIntegration,
) as IntegrationClass<Integration> & {
 new (options?: {
 setTimeout: boolean;
 setInterval: boolean;
 requestAnimationFrame: boolean;
 XMLHttpRequest: boolean;
 eventTarget: boolean | string[];
 }): Integration;
};

function _wrapTimeFunction(original: () => void): () => number {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down

11 changes: 7 additions & 4 deletions
packages/browser/src/profiling/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass, getCurrentScope } from '@sentry/core';
import type { EventEnvelope, IntegrationFn, Transaction } from '@sentry/types';
import type { Client, EventEnvelope, Integration, IntegrationClass, IntegrationFn, Transaction } from '@sentry/types';
import type { Profile } from '@sentry/types/src/profiling';
import { logger } from '@sentry/utils';

Expand All@@ -18,7 +18,7 @@ import {

const INTEGRATION_NAME = 'BrowserProfiling';

const browserProfilingIntegration: IntegrationFn = () => {
const browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand DownExpand Up@@ -100,7 +100,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 });
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Browser profiling integration. Stores any event that has contexts["profile"]["profile_id"]
Expand All@@ -112,4 +112,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 * @experimental
 */
// eslint-disable-next-line deprecation/deprecation
export const BrowserProfilingIntegration = convertIntegrationFnToClass(INTEGRATION_NAME, browserProfilingIntegration);
export const BrowserProfilingIntegration = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserProfilingIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }>;

1 change: 0 additions & 1 deletion
packages/browser/test/unit/profiling/integration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,6 @@ describe('BrowserProfilingIntegration', () => {
 Sentry.init({
 tracesSampleRate: 1,
 profilesSampleRate: 1,
 debug: true,
 environment: 'test-environment',
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 transport: _opts => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

const INTEGRATION_NAME = 'BunServer';

const bunServerIntegration: IntegrationFn = () => {
const bunServerIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentBunServe();
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand Down

17 changes: 5 additions & 12 deletions
packages/core/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, Options } from '@sentry/types';
import { arrayify, logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
Expand DownExpand Up@@ -169,18 +169,11 @@ function findIndex<T>(arr: T[], callback: (item: T) => boolean): number {
export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
 name: string,
 fn: Fn,
): Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
} {
): IntegrationClass<Integration> {
 return Object.assign(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ConvertedIntegration(...rest: Parameters<Fn>) {
 return fn(...rest);
 function ConvertedIntegration(...args: Parameters<Fn>): Integration {
 return fn(...args);
 },
 { id: name },
 ) as unknown as Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
 };
 ) as unknown as IntegrationClass<Integration>;
}

11 changes: 7 additions & 4 deletions
packages/core/src/integrations/functiontostring.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { getOriginalFunction } from '@sentry/utils';
import { convertIntegrationFnToClass } from '../integration';

let originalFunctionToString: () => void;

const INTEGRATION_NAME = 'FunctionToString';

const functionToStringIntegration: IntegrationFn = () => {
const functionToStringIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
Expand All@@ -26,8 +26,11 @@ const functionToStringIntegration: IntegrationFn = () => {
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Patch toString calls to return proper name for wrapped functions */
// eslint-disable-next-line deprecation/deprecation
export const FunctionToString = convertIntegrationFnToClass(INTEGRATION_NAME, functionToStringIntegration);
export const FunctionToString = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 functionToStringIntegration,
) as IntegrationClass<Integration & { setupOnce: () => void }>;

23 changes: 19 additions & 4 deletions
packages/core/src/integrations/inboundfilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Event, IntegrationFn, StackFrame } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { getEventDescription, logger, stringMatchesSomePattern } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
Expand DownExpand Up@@ -30,7 +30,7 @@ export interface InboundFiltersOptions {
}

const INTEGRATION_NAME = 'InboundFilters';
const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFiltersOptions>) => {
const inboundFiltersIntegration= ((options: Partial<InboundFiltersOptions> = {}) => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -41,11 +41,26 @@ const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFilter
 return _shouldDropEvent(event, mergedOptions) ? null : event;
 },
 };
};
}) satisfies IntegrationFn;

/** Inbound filters configurable by the user */
// eslint-disable-next-line deprecation/deprecation
export const InboundFilters = convertIntegrationFnToClass(INTEGRATION_NAME, inboundFiltersIntegration);
export const InboundFilters = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 inboundFiltersIntegration,
) as IntegrationClass<Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }> & {
 new (
 options?: Partial<{
 allowUrls: Array<string | RegExp>;
 denyUrls: Array<string | RegExp>;
 ignoreErrors: Array<string | RegExp>;
 ignoreTransactions: Array<string | RegExp>;
 ignoreInternal: boolean;
 disableErrorDefaults: boolean;
 disableTransactionDefaults: boolean;
 }>,
 ): Integration;
};

function _mergeOptions(
 internalOptions: Partial<InboundFiltersOptions> = {},
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
fix: Ensure all integration classes have correct types#10183

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 16, 2024
 Merged


fix: Ensure all integration classes have correct types
#10183
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


26 changes: 23 additions & 3 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,8 @@ import type {
 HandlerDataFetch,
 HandlerDataHistory,
 HandlerDataXhr,
 Integration,
 IntegrationClass,
 IntegrationFn,
} from '@sentry/types';
import type {
Expand DownExpand Up@@ -55,7 +57,7 @@ const MAX_ALLOWED_STRING_LENGTH = 1024;

const INTEGRATION_NAME = 'Breadcrumbs';

const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptions> = {}) => {
const breadcrumbsIntegration = ((options: Partial<BreadcrumbsOptions> = {}) => {
 const _options = {
 console: true,
 dom: true,
Expand DownExpand Up@@ -91,13 +93,31 @@ const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptio
 }
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Default Breadcrumbs instrumentations
 */
// eslint-disable-next-line deprecation/deprecation
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration);
export const Breadcrumbs = convertIntegrationFnToClass(INTEGRATION_NAME, breadcrumbsIntegration) as IntegrationClass<
 Integration & { setup: (client: Client) => void }
> & {
 new (
 options?: Partial<{
 console: boolean;
 dom:
 | boolean
 | {
 serializeAttribute?: string | string[];
 maxStringLength?: number;
 };
 fetch: boolean;
 history: boolean;
 sentry: boolean;
 xhr: boolean;
 }>,
 ): Integration;
};

/**
 * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/dedupe.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackFrame } from '@sentry/types';
import type { Event, Exception, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';

const INTEGRATION_NAME = 'Dedupe';

const dedupeIntegration: IntegrationFn = () => {
const dedupeIntegration = (() => {
 let previousEvent: Event | undefined;

 return {
Expand All@@ -31,11 +31,13 @@ const dedupeIntegration: IntegrationFn = () => {
 return (previousEvent = currentEvent);
 },
 };
};
}) satisfies IntegrationFn;

/** Deduplication filter */
// eslint-disable-next-line deprecation/deprecation
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration);
export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration) as IntegrationClass<
 Integration & { processEvent: (event: Event) => Event }
>;

function _shouldDropEvent(currentEvent: Event, previousEvent?: Event): boolean {
 if (!previousEvent) {
Expand Down

21 changes: 17 additions & 4 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { captureEvent, convertIntegrationFnToClass, getClient } from '@sentry/core';
import type { Client, Event, IntegrationFn, Primitive, StackParser } from '@sentry/types';
import type {
 Client,
 Event,
 Integration,
 IntegrationClass,
 IntegrationFn,
 Primitive,
 StackParser,
} from '@sentry/types';
import {
 addGlobalErrorInstrumentationHandler,
 addGlobalUnhandledRejectionInstrumentationHandler,
Expand All@@ -22,7 +30,7 @@ type GlobalHandlersIntegrations = Record<GlobalHandlersIntegrationsOptionKeys, b

const INTEGRATION_NAME = 'GlobalHandlers';

const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandlersIntegrations> = {}) => {
const globalHandlersIntegration = ((options: Partial<GlobalHandlersIntegrations> = {}) => {
 const _options = {
 onerror: true,
 onunhandledrejection: true,
Expand All@@ -45,11 +53,16 @@ const globalHandlersIntegrations: IntegrationFn = (options: Partial<GlobalHandle
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Global handlers */
// eslint-disable-next-line deprecation/deprecation
export const GlobalHandlers = convertIntegrationFnToClass(INTEGRATION_NAME, globalHandlersIntegrations);
export const GlobalHandlers = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 globalHandlersIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }> & {
 new (options?: Partial<GlobalHandlersIntegrations>): Integration;
};

function _installGlobalOnErrorHandler(client: Client): void {
 addGlobalErrorInstrumentationHandler(data => {
Expand Down

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Event, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';

import { WINDOW } from '../helpers';

const INTEGRATION_NAME = 'HttpContext';

const httpContextIntegration: IntegrationFn = () => {
const httpContextIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -31,8 +31,10 @@ const httpContextIntegration: IntegrationFn = () => {
 event.request = request;
 },
 };
};
}) satisfies IntegrationFn;

/** HttpContext integration collects information about HTTP request headers */
// eslint-disable-next-line deprecation/deprecation
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration);
export const HttpContext = convertIntegrationFnToClass(INTEGRATION_NAME, httpContextIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event) => void }
>;

10 changes: 6 additions & 4 deletions
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
import { applyAggregateErrorsToEvent } from '@sentry/utils';
import { exceptionFromError } from '../eventbuilder';

Expand All@@ -13,7 +13,7 @@ const DEFAULT_LIMIT = 5;

const INTEGRATION_NAME = 'LinkedErrors';

const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {}) => {
const linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
 const limit = options.limit || DEFAULT_LIMIT;
 const key = options.key || DEFAULT_KEY;

Expand All@@ -36,8 +36,10 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
 );
 },
 };
};
}) satisfies IntegrationFn;

/** Aggregrate linked errors in an event. */
// eslint-disable-next-line deprecation/deprecation
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration);
export const LinkedErrors = convertIntegrationFnToClass(INTEGRATION_NAME, linkedErrorsIntegration) as IntegrationClass<
 Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }
> & { new (options?: { key?: string; limit?: number }): Integration };

19 changes: 15 additions & 4 deletions
packages/browser/src/integrations/trycatch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass } from '@sentry/core';
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { fill, getFunctionName, getOriginalFunction } from '@sentry/utils';

import { WINDOW, wrap } from '../helpers';
Expand DownExpand Up@@ -50,7 +50,7 @@ interface TryCatchOptions {
 eventTarget: boolean | string[];
}

const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> = {}) => {
const browserApiErrorsIntegration = ((options: Partial<TryCatchOptions> = {}) => {
 const _options = {
 XMLHttpRequest: true,
 eventTarget: true,
Expand DownExpand Up@@ -88,11 +88,22 @@ const tryCatchIntegration: IntegrationFn = (options: Partial<TryCatchOptions> =
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Wrap timer functions and event targets to catch errors and provide better meta data */
// eslint-disable-next-line deprecation/deprecation
export const TryCatch = convertIntegrationFnToClass(INTEGRATION_NAME, tryCatchIntegration);
export const TryCatch = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserApiErrorsIntegration,
) as IntegrationClass<Integration> & {
 new (options?: {
 setTimeout: boolean;
 setInterval: boolean;
 requestAnimationFrame: boolean;
 XMLHttpRequest: boolean;
 eventTarget: boolean | string[];
 }): Integration;
};

function _wrapTimeFunction(original: () => void): () => number {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down

11 changes: 7 additions & 4 deletions
packages/browser/src/profiling/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { convertIntegrationFnToClass, getCurrentScope } from '@sentry/core';
import type { EventEnvelope, IntegrationFn, Transaction } from '@sentry/types';
import type { Client, EventEnvelope, Integration, IntegrationClass, IntegrationFn, Transaction } from '@sentry/types';
import type { Profile } from '@sentry/types/src/profiling';
import { logger } from '@sentry/utils';

Expand All@@ -18,7 +18,7 @@ import {

const INTEGRATION_NAME = 'BrowserProfiling';

const browserProfilingIntegration: IntegrationFn = () => {
const browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand DownExpand Up@@ -100,7 +100,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 });
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Browser profiling integration. Stores any event that has contexts["profile"]["profile_id"]
Expand All@@ -112,4 +112,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
 * @experimental
 */
// eslint-disable-next-line deprecation/deprecation
export const BrowserProfilingIntegration = convertIntegrationFnToClass(INTEGRATION_NAME, browserProfilingIntegration);
export const BrowserProfilingIntegration = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 browserProfilingIntegration,
) as IntegrationClass<Integration & { setup: (client: Client) => void }>;

1 change: 0 additions & 1 deletion
packages/browser/test/unit/profiling/integration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,6 @@ describe('BrowserProfilingIntegration', () => {
 Sentry.init({
 tracesSampleRate: 1,
 profilesSampleRate: 1,
 debug: true,
 environment: 'test-environment',
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 transport: _opts => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

const INTEGRATION_NAME = 'BunServer';

const bunServerIntegration: IntegrationFn = () => {
const bunServerIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentBunServe();
 },
 };
};
}) satisfies IntegrationFn;

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand Down

17 changes: 5 additions & 12 deletions
packages/core/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, Options } from '@sentry/types';
import { arrayify, logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
Expand DownExpand Up@@ -169,18 +169,11 @@ function findIndex<T>(arr: T[], callback: (item: T) => boolean): number {
export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
 name: string,
 fn: Fn,
): Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
} {
): IntegrationClass<Integration> {
 return Object.assign(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ConvertedIntegration(...rest: Parameters<Fn>) {
 return fn(...rest);
 function ConvertedIntegration(...args: Parameters<Fn>): Integration {
 return fn(...args);
 },
 { id: name },
 ) as unknown as Integration & {
 id: string;
 new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
 };
 ) as unknown as IntegrationClass<Integration>;
}

11 changes: 7 additions & 4 deletions
packages/core/src/integrations/functiontostring.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import type { IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { getOriginalFunction } from '@sentry/utils';
import { convertIntegrationFnToClass } from '../integration';

let originalFunctionToString: () => void;

const INTEGRATION_NAME = 'FunctionToString';

const functionToStringIntegration: IntegrationFn = () => {
const functionToStringIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
Expand All@@ -26,8 +26,11 @@ const functionToStringIntegration: IntegrationFn = () => {
 }
 },
 };
};
}) satisfies IntegrationFn;

/** Patch toString calls to return proper name for wrapped functions */
// eslint-disable-next-line deprecation/deprecation
export const FunctionToString = convertIntegrationFnToClass(INTEGRATION_NAME, functionToStringIntegration);
export const FunctionToString = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 functionToStringIntegration,
) as IntegrationClass<Integration & { setupOnce: () => void }>;

23 changes: 19 additions & 4 deletions
packages/core/src/integrations/inboundfilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Event, IntegrationFn, StackFrame } from '@sentry/types';
import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
import { getEventDescription, logger, stringMatchesSomePattern } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
Expand DownExpand Up@@ -30,7 +30,7 @@ export interface InboundFiltersOptions {
}

const INTEGRATION_NAME = 'InboundFilters';
const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFiltersOptions>) => {
const inboundFiltersIntegration= ((options: Partial<InboundFiltersOptions> = {}) => {
 return {
 name: INTEGRATION_NAME,
 // TODO v8: Remove this
Expand All@@ -41,11 +41,26 @@ const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFilter
 return _shouldDropEvent(event, mergedOptions) ? null : event;
 },
 };
};
}) satisfies IntegrationFn;

/** Inbound filters configurable by the user */
// eslint-disable-next-line deprecation/deprecation
export const InboundFilters = convertIntegrationFnToClass(INTEGRATION_NAME, inboundFiltersIntegration);
export const InboundFilters = convertIntegrationFnToClass(
 INTEGRATION_NAME,
 inboundFiltersIntegration,
) as IntegrationClass<Integration & { preprocessEvent: (event: Event, hint: EventHint, client: Client) => void }> & {
 new (
 options?: Partial<{
 allowUrls: Array<string | RegExp>;
 denyUrls: Array<string | RegExp>;
 ignoreErrors: Array<string | RegExp>;
 ignoreTransactions: Array<string | RegExp>;
 ignoreInternal: boolean;
 disableErrorDefaults: boolean;
 disableTransactionDefaults: boolean;
 }>,
 ): Integration;
};

function _mergeOptions(
 internalOptions: Partial<InboundFiltersOptions> = {},
Expand Down
Loading