diff --git a/packages/error-reporting-service/CHANGELOG.md b/packages/error-reporting-service/CHANGELOG.md index 3aa9c0609b3..0335853c167 100644 --- a/packages/error-reporting-service/CHANGELOG.md +++ b/packages/error-reporting-service/CHANGELOG.md @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Changed + +- Add deprecation notice ([#7427](https://github.com/MetaMask/core/pull/7427)) + - This package is deprecated, and can be replaced with the + `Messenger.captureException` method from `@metamask/messenger`. + ## [3.0.0] ### Changed diff --git a/packages/error-reporting-service/README.md b/packages/error-reporting-service/README.md index 4e21c415969..500326f9cff 100644 --- a/packages/error-reporting-service/README.md +++ b/packages/error-reporting-service/README.md @@ -1,5 +1,10 @@ # `@metamask/error-reporting-service` +> [!WARNING] +> This package is deprecated. To report errors, please use +> [`Messenger.captureException`](https://github.com/MetaMask/core/blob/8b3ad82c35d9d75c9a5096d847e7e8651e29cc5e/packages/messenger/src/Messenger.ts#L258-L263) +> instead. + Reports errors to an external app such as Sentry but in an agnostic fashion. ## Installation diff --git a/packages/error-reporting-service/src/error-reporting-service.ts b/packages/error-reporting-service/src/error-reporting-service.ts index 675583f3719..14974cda908 100644 --- a/packages/error-reporting-service/src/error-reporting-service.ts +++ b/packages/error-reporting-service/src/error-reporting-service.ts @@ -2,6 +2,9 @@ import type { Messenger } from '@metamask/messenger'; /** * The action which can be used to report an error. + * + * @deprecated This action is deprecated and will be removed in a future + * release. Please use `Messenger.captureException` directly instead. */ export type ErrorReportingServiceCaptureExceptionAction = { type: 'ErrorReportingService:captureException'; @@ -142,6 +145,9 @@ type ErrorReportingServiceOptions = { * // Now this will report an error without throwing it. * exampleController.doSomething(); * ``` + * + * @deprecated This service is deprecated and will be removed in a future + * release. Please use `Messenger.captureException` directly instead. */ export class ErrorReportingService { name: 'ErrorReportingService' = 'ErrorReportingService' as const; @@ -175,6 +181,8 @@ export class ErrorReportingService { * Reports the given error to an external location. * * @param error - The error to report. + * @deprecated This function is deprecated and will be removed in a future + * release. Please use `Messenger.captureException` directly instead. */ captureException(error: Error): void { this.#captureException(error);