From bd9679ed3ceee91d8e3d764ca41128ad24461a13 Mon Sep 17 00:00:00 2001 From: Tim Fish Date: Mon, 6 Feb 2023 13:40:23 +0100 Subject: [PATCH 1/3] deprecate offline integration --- packages/integrations/src/index.ts | 1 + packages/integrations/src/offline.ts | 11 +++++++++++ 2 files changed, 12 insertions(+) diff --git a/packages/integrations/src/index.ts b/packages/integrations/src/index.ts index 2f3708075ac1..372a730e3a5c 100644 --- a/packages/integrations/src/index.ts +++ b/packages/integrations/src/index.ts @@ -2,6 +2,7 @@ export { CaptureConsole } from './captureconsole'; export { Debug } from './debug'; export { Dedupe } from './dedupe'; export { ExtraErrorData } from './extraerrordata'; +// eslint-disable-next-line deprecation/deprecation export { Offline } from './offline'; export { ReportingObserver } from './reportingobserver'; export { RewriteFrames } from './rewriteframes'; diff --git a/packages/integrations/src/offline.ts b/packages/integrations/src/offline.ts index e20ea96d8e14..8731f4e04201 100644 --- a/packages/integrations/src/offline.ts +++ b/packages/integrations/src/offline.ts @@ -1,5 +1,6 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ /* eslint-disable @typescript-eslint/no-unsafe-member-access */ +/* eslint-disable deprecation/deprecation */ import type { Event, EventProcessor, Hub, Integration } from '@sentry/types'; import { GLOBAL_OBJ, logger, normalize, uuid4 } from '@sentry/utils'; import localForage from 'localforage'; @@ -20,6 +21,16 @@ export type Item = { key: string; value: Event }; /** * cache offline errors and send when connected + * @deprecated The offline integration has been deprecated in favor of the offline transport wrapper. + * + * ``` + * import { init, makeBrowserOfflineTransport, makeFetchTransport } from '@sentry/browser'; + * + * init({ + * dsn: '__DSN__', + * transport: makeBrowserOfflineTransport(makeFetchTransport), + * }); + * ``` */ export class Offline implements Integration { /** From 41951ec7d4bb64ea651046a2349b8ed985a57bfa Mon Sep 17 00:00:00 2001 From: Tim Fish Date: Mon, 6 Feb 2023 15:03:54 +0100 Subject: [PATCH 2/3] Lint --- packages/integrations/test/offline.test.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/integrations/test/offline.test.ts b/packages/integrations/test/offline.test.ts index d7ca8099be31..624c166763b8 100644 --- a/packages/integrations/test/offline.test.ts +++ b/packages/integrations/test/offline.test.ts @@ -1,3 +1,4 @@ +/* eslint-disable deprecation/deprecation */ import { WINDOW } from '@sentry/browser'; import type { Event, EventProcessor, Hub, Integration, IntegrationClass } from '@sentry/types'; From 692588b22b1f040fcbe1884568a204932815e87d Mon Sep 17 00:00:00 2001 From: Tim Fish Date: Mon, 13 Feb 2023 17:38:41 +0100 Subject: [PATCH 3/3] Add URL to new docs --- packages/integrations/src/offline.ts | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/packages/integrations/src/offline.ts b/packages/integrations/src/offline.ts index 8731f4e04201..f48856023848 100644 --- a/packages/integrations/src/offline.ts +++ b/packages/integrations/src/offline.ts @@ -23,14 +23,7 @@ export type Item = { key: string; value: Event }; * cache offline errors and send when connected * @deprecated The offline integration has been deprecated in favor of the offline transport wrapper. * - * ``` - * import { init, makeBrowserOfflineTransport, makeFetchTransport } from '@sentry/browser'; - * - * init({ - * dsn: '__DSN__', - * transport: makeBrowserOfflineTransport(makeFetchTransport), - * }); - * ``` + * http://docs.sentry.io/platforms/javascript/configuration/transports/#offline-caching */ export class Offline implements Integration { /**