Skip to content

chore: Deprecate error reporting service #7427

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
Mrtenz merged 2 commits into from
Dec 12, 2025
Merged

chore: Deprecate error reporting service #7427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10f08f1
Deprecate error reporting service
Mrtenz Dec 10, 2025
f3fedc9
Update changelog
Mrtenz Dec 10, 2025
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
6 changes: 6 additions & 0 deletions packages/error-reporting-service/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions packages/error-reporting-service/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 8 additions & 0 deletions packages/error-reporting-service/src/error-reporting-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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);
Expand Down
Loading