Expose message and reason code (#6797)

## Explanation

The Shield backend returns `message` and `reasonCode` from the `/result`
endpoint, but we currently don't expose it.
This PR exposes these.

<!--
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?
-->

## 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
- [ ] 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),
highlighting breaking changes as necessary
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Expose backend `message` and `reasonCode` in `CoverageResult` and
propagate through coverage checks, with tests/utilities updated.
> 
> - **Shield Controller**:
>   - **API/Types**:
> - Extend `CoverageResult` and `GetCoverageResultResponse` to include
optional `message` and `reasonCode`.
> - `ShieldRemoteBackend.checkCoverage` and `checkSignatureCoverage` now
return `{ coverageId, message, reasonCode, status }`.
>   - **Tests/Utils**:
> - Update `backend.test.ts` to assert returned `message`/`reasonCode`;
switch to `getRandomCoverageResult()`.
> - Add `tests/utils#getRandomCoverageResult` to generate mock results
with `message` and `reasonCode`.
>   - **Docs**:
> - Update `CHANGELOG.md` to note added `message` and `reasonCode` in
coverage result type.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
192dd4a. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: matthiasgeihs

packages/shield-controller/CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Log `not_shown` if result is not available ([#6667](https://github.com/MetaMask/core/pull/6667))
+- Add `message` and `reasonCode` to coverage result type ([#6797](https://github.com/MetaMask/core/pull/6797))
 
 ### Changed
 

packages/shield-controller/src/backend.test.ts

@@ -2,7 +2,7 @@ import { ShieldRemoteBackend } from './backend';
 import {
   generateMockSignatureRequest,
   generateMockTxMeta,
-  getRandomCoverageStatus,
+  getRandomCoverageResult,
 } from '../tests/utils';
 
 /**
@@ -52,19 +52,19 @@ describe('ShieldRemoteBackend', () => {
     const coverageId = 'coverageId';
     fetchMock.mockResolvedValueOnce({
       status: 200,
-      json: jest.fn().mockResolvedValue({ coverageId: 'coverageId' }),
+      json: jest.fn().mockResolvedValue({ coverageId }),
     } as unknown as Response);
 
     // Mock get coverage result.
-    const status = getRandomCoverageStatus();
+    const result = getRandomCoverageResult();
     fetchMock.mockResolvedValueOnce({
       status: 200,
-      json: jest.fn().mockResolvedValue({ status }),
+      json: jest.fn().mockResolvedValue(result),
     } as unknown as Response);
 
     const txMeta = generateMockTxMeta();
     const coverageResult = await backend.checkCoverage({ txMeta });
-    expect(coverageResult).toStrictEqual({ coverageId, status });
+    expect(coverageResult).toStrictEqual({ coverageId, ...result });
     expect(fetchMock).toHaveBeenCalledTimes(2);
     expect(getAccessToken).toHaveBeenCalledTimes(2);
   });
@@ -88,15 +88,18 @@ describe('ShieldRemoteBackend', () => {
     } as unknown as Response);
 
     // Mock get coverage result: result available.
-    const status = getRandomCoverageStatus();
+    const result = getRandomCoverageResult();
     fetchMock.mockResolvedValueOnce({
       status: 200,
-      json: jest.fn().mockResolvedValue({ status }),
+      json: jest.fn().mockResolvedValue(result),
     } as unknown as Response);
 
     const txMeta = generateMockTxMeta();
     const coverageResult = await backend.checkCoverage({ txMeta });
-    expect(coverageResult).toStrictEqual({ coverageId, status });
+    expect(coverageResult).toStrictEqual({
+      coverageId,
+      ...result,
+    });
     expect(fetchMock).toHaveBeenCalledTimes(3);
     expect(getAccessToken).toHaveBeenCalledTimes(2);
   });
@@ -160,17 +163,20 @@ describe('ShieldRemoteBackend', () => {
       } as unknown as Response);
 
       // Mock get coverage result.
-      const status = getRandomCoverageStatus();
+      const result = getRandomCoverageResult();
       fetchMock.mockResolvedValueOnce({
         status: 200,
-        json: jest.fn().mockResolvedValue({ status }),
+        json: jest.fn().mockResolvedValue(result),
       } as unknown as Response);
 
       const signatureRequest = generateMockSignatureRequest();
       const coverageResult = await backend.checkSignatureCoverage({
         signatureRequest,
       });
-      expect(coverageResult).toStrictEqual({ coverageId, status });
+      expect(coverageResult).toStrictEqual({
+        coverageId,
+        ...result,
+      });
       expect(fetchMock).toHaveBeenCalledTimes(2);
       expect(getAccessToken).toHaveBeenCalledTimes(2);
     });

packages/shield-controller/src/backend.ts

@@ -42,6 +42,8 @@ export type GetCoverageResultRequest = {
 };
 
 export type GetCoverageResultResponse = {
+  message?: string;
+  reasonCode?: string;
   status: CoverageStatus;
 };
 
@@ -87,7 +89,12 @@ export class ShieldRemoteBackend implements ShieldBackend {
     }
 
     const coverageResult = await this.#getCoverageResult(coverageId);
-    return { coverageId, status: coverageResult.status };
+    return {
+      coverageId,
+      message: coverageResult.message,
+      reasonCode: coverageResult.reasonCode,
+      status: coverageResult.status,
+    };
   }
 
   async checkSignatureCoverage(
@@ -103,7 +110,12 @@ export class ShieldRemoteBackend implements ShieldBackend {
     }
 
     const coverageResult = await this.#getCoverageResult(coverageId);
-    return { coverageId, status: coverageResult.status };
+    return {
+      coverageId,
+      message: coverageResult.message,
+      reasonCode: coverageResult.reasonCode,
+      status: coverageResult.status,
+    };
   }
 
   async logSignature(req: LogSignatureRequest): Promise<void> {

packages/shield-controller/src/types.ts

@@ -3,6 +3,8 @@ import type { TransactionMeta } from '@metamask/transaction-controller';
 
 export type CoverageResult = {
   coverageId: string;
+  message?: string;
+  reasonCode?: string;
   status: CoverageStatus;
 };
 

packages/shield-controller/tests/utils.ts

@@ -66,6 +66,19 @@ export function getRandomCoverageStatus(): CoverageStatus {
   return coverageStatuses[Math.floor(Math.random() * coverageStatuses.length)];
 }
 
+/**
+ * Get a random coverage result.
+ *
+ * @returns A random coverage result.
+ */
+export function getRandomCoverageResult() {
+  return {
+    status: getRandomCoverageStatus(),
+    message: 'message',
+    reasonCode: 'reasonCode',
+  };
+}
+
 /**
  * Setup a coverage result received handler.
  *