feat(core): Deprecate debugIntegration and sessionTimingIntegration (#14363)

Luca Forstner · web-flow · commit acb56884773e · 2024-11-19T14:28:54.000+01:00
diff --git a/docs/migration/draft-v9-migration-guide.md b/docs/migration/draft-v9-migration-guide.md
@@ -11,6 +11,8 @@
 ## `@sentry/core`
 
 - Deprecated `transactionNamingScheme` option in `requestDataIntegration`.
+- Deprecated `debugIntegration`. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
+- Deprecated `sessionTimingIntegration`. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
 
 ## `@sentry/types`
 
diff --git a/package.json b/package.json
@@ -152,11 +152,13 @@
     "proseWrap": "always",
     "singleQuote": true,
     "trailingComma": "all",
-    "overrides": [{
-      "files": "CHANGELOG.md",
-      "options": {
-        "proseWrap": "preserve"
+    "overrides": [
+      {
+        "files": "*.md",
+        "options": {
+          "proseWrap": "preserve"
+        }
       }
-    }]
+    ]
   }
 }
diff --git a/packages/astro/src/index.server.ts b/packages/astro/src/index.server.ts
@@ -31,6 +31,7 @@ export {
   createTransport,
   cron,
   dataloaderIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   DEFAULT_USER_INCLUDES,
@@ -103,6 +104,7 @@ export {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
   setContext,
   setCurrentClient,
diff --git a/packages/aws-serverless/src/index.ts b/packages/aws-serverless/src/index.ts
@@ -124,10 +124,12 @@ export {
 
 export {
   captureConsoleIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   extraErrorDataIntegration,
   rewriteFramesIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
 } from '@sentry/core';
 
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -6,9 +6,11 @@ export { contextLinesIntegration } from './integrations/contextlines';
 
 export {
   captureConsoleIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   extraErrorDataIntegration,
   rewriteFramesIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
   captureFeedback,
 } from '@sentry/core';
diff --git a/packages/browser/src/integrations-bundle/index.debug.ts b/packages/browser/src/integrations-bundle/index.debug.ts
@@ -1,2 +1,3 @@
+// eslint-disable-next-line deprecation/deprecation
 export { debugIntegration } from '@sentry/core';
 export { spotlightBrowserIntegration } from '../integrations/spotlight';
diff --git a/packages/browser/src/integrations-bundle/index.sessiontiming.ts b/packages/browser/src/integrations-bundle/index.sessiontiming.ts
@@ -1 +1,2 @@
+// eslint-disable-next-line deprecation/deprecation
 export { sessionTimingIntegration } from '@sentry/core';
diff --git a/packages/bun/src/index.ts b/packages/bun/src/index.ts
@@ -144,10 +144,12 @@ export {
 
 export {
   captureConsoleIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   extraErrorDataIntegration,
   rewriteFramesIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
 } from '@sentry/core';
 
diff --git a/packages/cloudflare/src/index.ts b/packages/cloudflare/src/index.ts
@@ -74,6 +74,7 @@ export {
   linkedErrorsIntegration,
   requestDataIntegration,
   extraErrorDataIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   rewriteFramesIntegration,
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -92,10 +92,12 @@ export { linkedErrorsIntegration } from './integrations/linkederrors';
 export { moduleMetadataIntegration } from './integrations/metadata';
 export { requestDataIntegration } from './integrations/requestdata';
 export { captureConsoleIntegration } from './integrations/captureconsole';
+// eslint-disable-next-line deprecation/deprecation
 export { debugIntegration } from './integrations/debug';
 export { dedupeIntegration } from './integrations/dedupe';
 export { extraErrorDataIntegration } from './integrations/extraerrordata';
 export { rewriteFramesIntegration } from './integrations/rewriteframes';
+// eslint-disable-next-line deprecation/deprecation
 export { sessionTimingIntegration } from './integrations/sessiontiming';
 export { zodErrorsIntegration } from './integrations/zoderrors';
 export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
diff --git a/packages/core/src/integrations/debug.ts b/packages/core/src/integrations/debug.ts
@@ -11,10 +11,6 @@ interface DebugOptions {
   debugger?: boolean;
 }
 
-/**
- * Integration to debug sent Sentry events.
- * This integration should not be used in production.
- */
 const _debugIntegration = ((options: DebugOptions = {}) => {
   const _options = {
     debugger: false,
@@ -51,4 +47,11 @@ const _debugIntegration = ((options: DebugOptions = {}) => {
   };
 }) satisfies IntegrationFn;
 
+/**
+ * Integration to debug sent Sentry events.
+ * This integration should not be used in production.
+ *
+ * @deprecated This integration is deprecated and will be removed in the next major version of the SDK.
+ * To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
+ */
 export const debugIntegration = defineIntegration(_debugIntegration);
diff --git a/packages/core/src/integrations/sessiontiming.ts b/packages/core/src/integrations/sessiontiming.ts
@@ -28,5 +28,8 @@ const _sessionTimingIntegration = (() => {
 /**
  * This function adds duration since the sessionTimingIntegration was initialized
  * till the time event was sent.
+ *
+ * @deprecated This integration is deprecated and will be removed in the next major version of the SDK.
+ * To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
  */
 export const sessionTimingIntegration = defineIntegration(_sessionTimingIntegration);
diff --git a/packages/core/test/lib/integrations/debug.test.ts b/packages/core/test/lib/integrations/debug.test.ts
@@ -3,6 +3,7 @@ import type { Client, Event, EventHint } from '@sentry/types';
 import { debugIntegration } from '../../../src/integrations/debug';
 
 function testEventLogged(
+  // eslint-disable-next-line deprecation/deprecation
   integration: ReturnType<typeof debugIntegration>,
   testEvent?: Event,
   testEventHint?: EventHint,
@@ -42,6 +43,7 @@ describe('Debug integration setup should register an event processor that', () =
   });
 
   it('logs an event', () => {
+    // eslint-disable-next-line deprecation/deprecation
     const debug = debugIntegration();
     const testEvent = { event_id: 'some event' };
 
@@ -52,6 +54,7 @@ describe('Debug integration setup should register an event processor that', () =
   });
 
   it('logs an event hint if available', () => {
+    // eslint-disable-next-line deprecation/deprecation
     const debug = debugIntegration();
 
     const testEvent = { event_id: 'some event' };
@@ -65,6 +68,7 @@ describe('Debug integration setup should register an event processor that', () =
   });
 
   it('logs events in stringified format when `stringify` option was set', () => {
+    // eslint-disable-next-line deprecation/deprecation
     const debug = debugIntegration({ stringify: true });
     const testEvent = { event_id: 'some event' };
 
@@ -75,6 +79,7 @@ describe('Debug integration setup should register an event processor that', () =
   });
 
   it('logs event hints in stringified format when `stringify` option was set', () => {
+    // eslint-disable-next-line deprecation/deprecation
     const debug = debugIntegration({ stringify: true });
 
     const testEvent = { event_id: 'some event' };
diff --git a/packages/core/test/lib/integrations/sessiontiming.test.ts b/packages/core/test/lib/integrations/sessiontiming.test.ts
@@ -1,6 +1,7 @@
 import type { Event } from '@sentry/types';
 import { sessionTimingIntegration } from '../../../src/integrations/sessiontiming';
 
+// eslint-disable-next-line deprecation/deprecation
 const sessionTiming = sessionTimingIntegration();
 
 describe('SessionTiming', () => {
diff --git a/packages/deno/src/index.ts b/packages/deno/src/index.ts
@@ -71,10 +71,12 @@ export {
   functionToStringIntegration,
   requestDataIntegration,
   captureConsoleIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   extraErrorDataIntegration,
   rewriteFramesIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
   zodErrorsIntegration,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
diff --git a/packages/google-cloud-serverless/src/index.ts b/packages/google-cloud-serverless/src/index.ts
@@ -124,10 +124,12 @@ export {
 
 export {
   captureConsoleIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   extraErrorDataIntegration,
   rewriteFramesIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
 } from '@sentry/core';
 
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -114,10 +114,12 @@ export {
   captureMessage,
   captureFeedback,
   captureConsoleIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   extraErrorDataIntegration,
   rewriteFramesIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
   // eslint-disable-next-line deprecation/deprecation
   metricsDefault as metrics,
diff --git a/packages/remix/src/index.server.ts b/packages/remix/src/index.server.ts
@@ -35,6 +35,7 @@ export {
   createGetModuleFromFilename,
   createTransport,
   cron,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   DEFAULT_USER_INCLUDES,
@@ -100,6 +101,7 @@ export {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
   setContext,
   setCurrentClient,
diff --git a/packages/solidstart/src/server/index.ts b/packages/solidstart/src/server/index.ts
@@ -26,6 +26,7 @@ export {
   createGetModuleFromFilename,
   createTransport,
   cron,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   DEFAULT_USER_INCLUDES,
@@ -91,6 +92,7 @@ export {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
   setContext,
   setCurrentClient,
diff --git a/packages/sveltekit/src/server/index.ts b/packages/sveltekit/src/server/index.ts
@@ -26,6 +26,7 @@ export {
   createGetModuleFromFilename,
   createTransport,
   cron,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   DEFAULT_USER_INCLUDES,
@@ -93,6 +94,7 @@ export {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
+  // eslint-disable-next-line deprecation/deprecation
   sessionTimingIntegration,
   setContext,
   setCurrentClient,
diff --git a/packages/vercel-edge/src/index.ts b/packages/vercel-edge/src/index.ts
@@ -74,6 +74,7 @@ export {
   linkedErrorsIntegration,
   requestDataIntegration,
   extraErrorDataIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   debugIntegration,
   dedupeIntegration,
   rewriteFramesIntegration,

Original file line number	Diff line number	Diff line change
`@@ -152,11 +152,13 @@`
`152`	`152`	`"proseWrap": "always",`
`153`	`153`	`"singleQuote": true,`
`154`	`154`	`"trailingComma": "all",`
`155`		`- "overrides": [{`
`156`		`- "files": "CHANGELOG.md",`
`157`		`- "options": {`
`158`		`- "proseWrap": "preserve"`
	`155`	`+ "overrides": [`
	`156`	`+ {`
	`157`	`+ "files": "*.md",`
	`158`	`+ "options": {`
	`159`	`+ "proseWrap": "preserve"`
	`160`	`+ }`
`159`	`161`	`}`
`160`		`- }]`
	`162`	`+ ]`
`161`	`163`	`}`
`162`	`164`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+// eslint-disable-next-line deprecation/deprecation`
`1`	`2`	`export { debugIntegration } from '@sentry/core';`
`2`	`3`	`export { spotlightBrowserIntegration } from '../integrations/spotlight';`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+// eslint-disable-next-line deprecation/deprecation`
`1`	`2`	`export { sessionTimingIntegration } from '@sentry/core';`