feat: captureException with claims messenger (#7553)

## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

This PR uses `captureException` function from the base-messenger to
capture the claims errors and report to sentry (from the extension).

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs)
- [x] I've introduced [breaking
changes](https://github.com/MetaMask/core/tree/main/docs/breaking-changes.md)
in this PR and have prepared draft pull requests for clients and
consumer packages to resolve them

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Add Sentry-backed error reporting and robust HTTP error handling to
claims service**
> 
> - Wrap `fetchClaimsConfigurations`, `getClaims`, `getClaimById`, and
`generateMessageForClaimSignature` in try/catch; on failures call
`messenger.captureException(createSentryError(...))` and rethrow
user-facing errors.
> - Use new `utils.getErrorFromResponse` to normalize non-OK HTTP
responses (JSON/text/unknown) and `createSentryError` to attach original
causes; add comprehensive unit tests for both utilities.
> - Update service tests to inject `captureException` via mocked
messenger, assert it’s called on failures, and verify error messages
(including status codes); add specific tests for rejected fetch and 500
responses.
> - Extend test messenger to support `captureException`; update
CHANGELOG with new behavior.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
cd6eae6. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: lwin-kyaw

packages/claims-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Capture claims error and report to sentry using `Messenger.captureException` method from `@metamask/messenger`. ([#7553](https://github.com/MetaMask/core/pull/7553))
+
 ### Changed
 
 - Upgrade `@metamask/utils` from `^11.8.1` to `^11.9.0` ([#7511](https://github.com/MetaMask/core/pull/7511))

packages/claims-controller/src/ClaimsService.test.ts

@@ -10,20 +10,22 @@ import type {
   ClaimsConfigurationsResponse,
   GenerateSignatureMessageResponse,
 } from './types';
+import { createSentryError } from './utils';
 import { createMockClaimsServiceMessenger } from '../tests/mocks/messenger';
 
 const mockAuthenticationControllerGetBearerToken = jest.fn();
 const mockFetchFunction = jest.fn();
-
+const mockCaptureException = jest.fn();
 /**
  * Create a mock claims service.
  *
  * @param env - The environment to use for the mock claims service. Defaults to Env.DEV.
- * @returns A mock claims service.
+ * @returns A mock claims service and its messenger.
  */
 function createMockClaimsService(env: Env = Env.DEV): ClaimsService {
   const { messenger } = createMockClaimsServiceMessenger(
     mockAuthenticationControllerGetBearerToken,
+    mockCaptureException,
   );
   return new ClaimsService({
     env,
@@ -68,7 +70,10 @@ describe('ClaimsService', () => {
     });
 
     it('should create instance with valid config', () => {
-      const { messenger } = createMockClaimsServiceMessenger(jest.fn());
+      const { messenger } = createMockClaimsServiceMessenger(
+        jest.fn(),
+        jest.fn(),
+      );
       const service = new ClaimsService({
         env: Env.DEV,
         messenger,
@@ -231,6 +236,25 @@ describe('ClaimsService', () => {
         ClaimsServiceErrorMessages.FAILED_TO_GET_CLAIM_BY_ID,
       );
     });
+
+    it('should handle fetch error and capture exception', async () => {
+      mockFetchFunction.mockRestore();
+
+      mockFetchFunction.mockRejectedValueOnce(new Error('Fetch error'));
+
+      const service = createMockClaimsService();
+
+      await expect(service.getClaimById('1')).rejects.toThrow(
+        ClaimsServiceErrorMessages.FAILED_TO_GET_CLAIM_BY_ID,
+      );
+
+      expect(mockCaptureException).toHaveBeenCalledWith(
+        createSentryError(
+          ClaimsServiceErrorMessages.FAILED_TO_GET_CLAIM_BY_ID,
+          new Error('Fetch error'),
+        ),
+      );
+    });
   });
 
   describe('generateMessageForClaimSignature', () => {
@@ -289,6 +313,7 @@ describe('ClaimsService', () => {
 
       mockFetchFunction.mockResolvedValueOnce({
         ok: false,
+        status: 500,
         json: jest.fn().mockResolvedValueOnce(null),
       });
 
@@ -299,6 +324,13 @@ describe('ClaimsService', () => {
       ).rejects.toThrow(
         ClaimsServiceErrorMessages.SIGNATURE_MESSAGE_GENERATION_FAILED,
       );
+
+      expect(mockCaptureException).toHaveBeenCalledWith(
+        createSentryError(
+          ClaimsServiceErrorMessages.SIGNATURE_MESSAGE_GENERATION_FAILED,
+          new Error('error: Unknown error, statusCode: 500'),
+        ),
+      );
     });
   });
 });

packages/claims-controller/src/ClaimsService.ts

@@ -13,6 +13,7 @@ import type {
   ClaimsConfigurationsResponse,
   GenerateSignatureMessageResponse,
 } from './types';
+import { createSentryError, getErrorFromResponse } from './utils';
 
 export type ClaimsServiceFetchClaimsConfigurationsAction = {
   type: `${typeof SERVICE_NAME}:fetchClaimsConfigurations`;
@@ -114,20 +115,32 @@ export class ClaimsService {
    * @returns The required configurations for the claims service.
    */
   async fetchClaimsConfigurations(): Promise<ClaimsConfigurationsResponse> {
-    const headers = await this.getRequestHeaders();
-    const url = `${this.getClaimsApiUrl()}/configurations`;
-    const response = await this.#fetch(url, {
-      headers,
-    });
-
-    if (!response.ok) {
+    try {
+      const headers = await this.getRequestHeaders();
+      const url = `${this.getClaimsApiUrl()}/configurations`;
+      const response = await this.#fetch(url, {
+        headers,
+      });
+
+      if (!response.ok) {
+        const error = await getErrorFromResponse(response);
+        throw error;
+      }
+
+      const configurations = await response.json();
+      return configurations;
+    } catch (error) {
+      console.error('fetchClaimsConfigurations', error);
+      this.#messenger.captureException?.(
+        createSentryError(
+          ClaimsServiceErrorMessages.FAILED_TO_FETCH_CONFIGURATIONS,
+          error as Error,
+        ),
+      );
       throw new Error(
         ClaimsServiceErrorMessages.FAILED_TO_FETCH_CONFIGURATIONS,
       );
     }
-
-    const configurations = await response.json();
-    return configurations;
   }
 
   /**
@@ -136,18 +149,30 @@ export class ClaimsService {
    * @returns The claims for the current user.
    */
   async getClaims(): Promise<Claim[]> {
-    const headers = await this.getRequestHeaders();
-    const url = `${this.getClaimsApiUrl()}/claims`;
-    const response = await this.#fetch(url, {
-      headers,
-    });
-
-    if (!response.ok) {
+    try {
+      const headers = await this.getRequestHeaders();
+      const url = `${this.getClaimsApiUrl()}/claims`;
+      const response = await this.#fetch(url, {
+        headers,
+      });
+
+      if (!response.ok) {
+        const error = await getErrorFromResponse(response);
+        throw error;
+      }
+
+      const claims = await response.json();
+      return claims;
+    } catch (error) {
+      console.error('getClaims', error);
+      this.#messenger.captureException?.(
+        createSentryError(
+          ClaimsServiceErrorMessages.FAILED_TO_GET_CLAIMS,
+          error as Error,
+        ),
+      );
       throw new Error(ClaimsServiceErrorMessages.FAILED_TO_GET_CLAIMS);
     }
-
-    const claims = await response.json();
-    return claims;
   }
 
   /**
@@ -157,18 +182,30 @@ export class ClaimsService {
    * @returns The claim by id.
    */
   async getClaimById(id: string): Promise<Claim> {
-    const headers = await this.getRequestHeaders();
-    const url = `${this.getClaimsApiUrl()}/claims/byId/${id}`;
-    const response = await this.#fetch(url, {
-      headers,
-    });
-
-    if (!response.ok) {
+    try {
+      const headers = await this.getRequestHeaders();
+      const url = `${this.getClaimsApiUrl()}/claims/byId/${id}`;
+      const response = await this.#fetch(url, {
+        headers,
+      });
+
+      if (!response.ok) {
+        const error = await getErrorFromResponse(response);
+        throw error;
+      }
+
+      const claim = await response.json();
+      return claim;
+    } catch (error) {
+      console.error('getClaimById', error);
+      this.#messenger.captureException?.(
+        createSentryError(
+          ClaimsServiceErrorMessages.FAILED_TO_GET_CLAIM_BY_ID,
+          error as Error,
+        ),
+      );
       throw new Error(ClaimsServiceErrorMessages.FAILED_TO_GET_CLAIM_BY_ID);
     }
-
-    const claim = await response.json();
-    return claim;
   }
 
   /**
@@ -182,28 +219,40 @@ export class ClaimsService {
     chainId: number,
     walletAddress: Hex,
   ): Promise<GenerateSignatureMessageResponse> {
-    const headers = await this.getRequestHeaders();
-    const url = `${this.getClaimsApiUrl()}/signature/generateMessage`;
-    const response = await this.#fetch(url, {
-      method: 'POST',
-      headers: {
-        ...headers,
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify({
-        chainId,
-        walletAddress,
-      }),
-    });
-
-    if (!response.ok) {
+    try {
+      const headers = await this.getRequestHeaders();
+      const url = `${this.getClaimsApiUrl()}/signature/generateMessage`;
+      const response = await this.#fetch(url, {
+        method: 'POST',
+        headers: {
+          ...headers,
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+          chainId,
+          walletAddress,
+        }),
+      });
+
+      if (!response.ok) {
+        const error = await getErrorFromResponse(response);
+        throw error;
+      }
+
+      const message = await response.json();
+      return message;
+    } catch (error) {
+      console.error('generateMessageForClaimSignature', error);
+      this.#messenger.captureException?.(
+        createSentryError(
+          ClaimsServiceErrorMessages.SIGNATURE_MESSAGE_GENERATION_FAILED,
+          error as Error,
+        ),
+      );
       throw new Error(
         ClaimsServiceErrorMessages.SIGNATURE_MESSAGE_GENERATION_FAILED,
       );
     }
-
-    const message = await response.json();
-    return message;
   }
 
   /**