feat(core): Streamline integration function results to be compatible (#10135)

For the v7 cycle, in order to make this easier to handle. in v8, we need
to remove the unused `setupOnce()` calls again.

It would be nicer if we could do away with this, but it is pretty hard
as the options for a client currently are types as `Integration[]`, and
we use these both for setting & getting, making it hard to change this
without breaking anything. Now, this is much easier (it basically just
works), with the small downsides of shipping a few more bytes - but we
can simply remove this in v8 then.

Author: mydea

MIGRATION.md

@@ -10,6 +10,15 @@ npx @sentry/migr8@latest
 This will let you select which updates to run, and automatically update your code. Make sure to still review all code
 changes!
 
+## Changed integration interface
+
+In v8, integrations passed to a client will have an optional `setupOnce()` hook.
+Currently, this hook is always present, but in v8 you will not be able to rely on this always existing anymore -
+any integration _may_ have a `setup` and/or a `setupOnce` hook. Additionally, `setupOnce()` will not receive any arguments anymore.
+
+This should not affect most people, but in the case that you are manually calling `integration.setupOnce()` right now,
+make sure to guard it's existence properly.
+
 ## Deprecate `Hub`
 
 The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency"

packages/browser/src/integrations/breadcrumbs.ts

@@ -68,6 +68,8 @@ const breadcrumbsIntegration: IntegrationFn = (options: Partial<BreadcrumbsOptio
 
   return {
     name: INTEGRATION_NAME,
+    // TODO v8: Remove this
+    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       if (_options.console) {
         addConsoleInstrumentationHandler(_getConsoleBreadcrumbHandler(client));

packages/browser/src/integrations/dedupe.ts

@@ -11,6 +11,8 @@ const dedupeIntegration: IntegrationFn = () => {
 
   return {
     name: INTEGRATION_NAME,
+    // TODO v8: Remove this
+    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(currentEvent) {
       // We want to ignore any non-error type events, e.g. transactions or replays
       // These should never be deduped, and also not be compared against as _previousEvent.

packages/browser/src/integrations/httpcontext.ts

@@ -8,6 +8,8 @@ const INTEGRATION_NAME = 'HttpContext';
 const httpContextIntegration: IntegrationFn = () => {
   return {
     name: INTEGRATION_NAME,
+    // TODO v8: Remove this
+    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     preprocessEvent(event) {
       // if none of the information we want exists, don't bother
       if (!WINDOW.navigator && !WINDOW.location && !WINDOW.document) {

packages/browser/src/integrations/linkederrors.ts

@@ -19,6 +19,8 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
 
   return {
     name: INTEGRATION_NAME,
+    // TODO v8: Remove this
+    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     preprocessEvent(event, hint, client) {
       const options = client.getOptions();
 

packages/browser/src/profiling/integration.ts

@@ -21,6 +21,8 @@ const INTEGRATION_NAME = 'BrowserProfiling';
 const browserProfilingIntegration: IntegrationFn = () => {
   return {
     name: INTEGRATION_NAME,
+    // TODO v8: Remove this
+    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       const scope = getCurrentScope();
 

packages/core/src/integration.ts

@@ -1,4 +1,4 @@
-import type { Client, Event, EventHint, EventProcessor, Hub, Integration, IntegrationFn, Options } from '@sentry/types';
+import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
 import { arrayify, logger } from '@sentry/utils';
 
 import { DEBUG_BUILD } from './debug-build';
@@ -171,26 +171,16 @@ export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
   fn: Fn,
 ): Integration & {
   id: string;
-  new (...args: Parameters<Fn>): Integration &
-    ReturnType<Fn> & {
-      setupOnce: (addGlobalEventProcessor?: (callback: EventProcessor) => void, getCurrentHub?: () => Hub) => void;
-    };
+  new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
 } {
   return Object.assign(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     function ConvertedIntegration(...rest: Parameters<Fn>) {
-      return {
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
-        setupOnce: () => {},
-        ...fn(...rest),
-      };
+      return fn(...rest);
     },
     { id: name },
   ) as unknown as Integration & {
     id: string;
-    new (...args: Parameters<Fn>): Integration &
-      ReturnType<Fn> & {
-        setupOnce: (addGlobalEventProcessor?: (callback: EventProcessor) => void, getCurrentHub?: () => Hub) => void;
-      };
+    new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
   };
 }

packages/core/src/integrations/inboundfilters.ts

@@ -33,6 +33,8 @@ const INTEGRATION_NAME = 'InboundFilters';
 const inboundFiltersIntegration: IntegrationFn = (options: Partial<InboundFiltersOptions>) => {
   return {
     name: INTEGRATION_NAME,
+    // TODO v8: Remove this
+    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event, _hint, client) {
       const clientOptions = client.getOptions();
       const mergedOptions = _mergeOptions(options, clientOptions);

packages/core/src/integrations/linkederrors.ts

@@ -18,6 +18,8 @@ const linkedErrorsIntegration: IntegrationFn = (options: LinkedErrorsOptions = {
 
   return {
     name: INTEGRATION_NAME,
+    // TODO v8: Remove this
+    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     preprocessEvent(event, hint, client) {
       const options = client.getOptions();
 

packages/core/src/integrations/metadata.ts

@@ -9,6 +9,8 @@ const INTEGRATION_NAME = 'ModuleMetadata';
 const moduleMetadataIntegration: IntegrationFn = () => {
   return {
     name: INTEGRATION_NAME,
+    // TODO v8: Remove this
+    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       if (typeof client.on !== 'function') {
         return;