Skip init if coverage id is available (#6792)

## Explanation

Currently the Shield Controller calls the `/init` endpoint every time a
coverage request is made.
This PR implements an optimization where the `/init` endpoint is skipped
if the coverage Id is already available.

<!--
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]
> Coverage checks now accept a request object with optional coverageId
to skip /init; controller, backend, types, tests, and changelog updated
accordingly.
> 
> - **Breaking API**:
> - Update `ShieldBackend` to accept request objects: `checkCoverage({
txMeta, coverageId? })`, `checkSignatureCoverage({ signatureRequest,
coverageId? })` with new types `CheckCoverageRequest` and
`CheckSignatureCoverageRequest`.
>   - `CHANGELOG.md`: note breaking change for `checkCoverage`.
> - **Backend** (`src/backend.ts`):
> - `ShieldRemoteBackend` skips `v1/*/coverage/init` when `coverageId`
is provided; otherwise performs init then polls result.
> - **Controller** (`src/ShieldController.ts`):
> - Pass latest stored `coverageId` via `#getLatestCoverageId` to
`checkCoverage` and `checkSignatureCoverage` to enable init-skip.
> - **Tests/Utils**:
> - Update expectations to new call shape and add
`setupCoverageResultReceived` helper; adjust simulation flow and mocks
(e.g., `MOCK_COVERAGE_ID`).
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
d24e5e6. 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

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Bump `@metamask/utils` from `^11.8.0` to `^11.8.1` ([#6708](https://github.com/MetaMask/core/pull/6708))
+- **Breaking:** Change `checkCoverage` API to accept `coverageId` and skip `/init` if `coverageId` is provided ([#6792](https://github.com/MetaMask/core/pull/6792))
 
 ## [0.2.0]
 

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

@@ -11,11 +11,12 @@ import {
 } from '@metamask/transaction-controller';
 
 import { ShieldController } from './ShieldController';
-import { createMockBackend } from '../tests/mocks/backend';
+import { createMockBackend, MOCK_COVERAGE_ID } from '../tests/mocks/backend';
 import { createMockMessenger } from '../tests/mocks/messenger';
 import {
   generateMockSignatureRequest,
   generateMockTxMeta,
+  setupCoverageResultReceived,
 } from '../tests/utils';
 
 /**
@@ -68,7 +69,7 @@ describe('ShieldController', () => {
         undefined as never,
       );
       expect(await coverageResultReceived).toBeUndefined();
-      expect(backend.checkCoverage).toHaveBeenCalledWith(txMeta);
+      expect(backend.checkCoverage).toHaveBeenCalledWith({ txMeta });
     });
 
     it('should no longer trigger checkCoverage when controller is stopped', async () => {
@@ -126,12 +127,7 @@ describe('ShieldController', () => {
     it('should check coverage when a transaction is simulated', async () => {
       const { baseMessenger, backend } = setup();
       const txMeta = generateMockTxMeta();
-      const coverageResultReceived = new Promise<void>((resolve) => {
-        baseMessenger.subscribe(
-          'ShieldController:coverageResultReceived',
-          (_coverageResult) => resolve(),
-        );
-      });
+      const coverageResultReceived = setupCoverageResultReceived(baseMessenger);
 
       // Add transaction.
       baseMessenger.publish(
@@ -140,19 +136,25 @@ describe('ShieldController', () => {
         undefined as never,
       );
       expect(await coverageResultReceived).toBeUndefined();
-      expect(backend.checkCoverage).toHaveBeenCalledWith(txMeta);
+      expect(backend.checkCoverage).toHaveBeenCalledWith({ txMeta });
 
       // Simulate transaction.
-      txMeta.simulationData = {
+      const txMeta2 = { ...txMeta };
+      txMeta2.simulationData = {
         tokenBalanceChanges: [],
       };
+      const coverageResultReceived2 =
+        setupCoverageResultReceived(baseMessenger);
       baseMessenger.publish(
         'TransactionController:stateChange',
-        { transactions: [txMeta] } as TransactionControllerState,
+        { transactions: [txMeta2] } as TransactionControllerState,
         undefined as never,
       );
-      expect(await coverageResultReceived).toBeUndefined();
-      expect(backend.checkCoverage).toHaveBeenCalledWith(txMeta);
+      expect(await coverageResultReceived2).toBeUndefined();
+      expect(backend.checkCoverage).toHaveBeenCalledWith({
+        coverageId: MOCK_COVERAGE_ID,
+        txMeta: txMeta2,
+      });
     });
 
     it('throws an error when the coverage ID has changed', async () => {
@@ -189,9 +191,9 @@ describe('ShieldController', () => {
         undefined as never,
       );
       expect(await coverageResultReceived).toBeUndefined();
-      expect(backend.checkSignatureCoverage).toHaveBeenCalledWith(
+      expect(backend.checkSignatureCoverage).toHaveBeenCalledWith({
         signatureRequest,
-      );
+      });
     });
   });
 
@@ -214,9 +216,9 @@ describe('ShieldController', () => {
       undefined as never,
     );
     expect(await coverageResultReceived1).toBeUndefined();
-    expect(backend.checkSignatureCoverage).toHaveBeenCalledWith(
-      signatureRequest1,
-    );
+    expect(backend.checkSignatureCoverage).toHaveBeenCalledWith({
+      signatureRequest: signatureRequest1,
+    });
 
     const signatureRequest2 = generateMockSignatureRequest();
     const coverageResultReceived2 = new Promise<void>((resolve) => {
@@ -236,9 +238,9 @@ describe('ShieldController', () => {
     );
 
     expect(await coverageResultReceived2).toBeUndefined();
-    expect(backend.checkSignatureCoverage).toHaveBeenCalledWith(
-      signatureRequest2,
-    );
+    expect(backend.checkSignatureCoverage).toHaveBeenCalledWith({
+      signatureRequest: signatureRequest2,
+    });
   });
 
   describe('logSignature', () => {

packages/shield-controller/src/ShieldController.ts

@@ -291,7 +291,11 @@ export class ShieldController extends BaseController<
    */
   async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {
     // Check coverage
-    const coverageResult = await this.#backend.checkCoverage(txMeta);
+    const coverageId = this.#getLatestCoverageId(txMeta.id);
+    const coverageResult = await this.#backend.checkCoverage({
+      txMeta,
+      coverageId,
+    });
 
     // Publish coverage result
     this.messagingSystem.publish(
@@ -315,8 +319,11 @@ export class ShieldController extends BaseController<
     signatureRequest: SignatureRequest,
   ): Promise<CoverageResult> {
     // Check coverage
-    const coverageResult =
-      await this.#backend.checkSignatureCoverage(signatureRequest);
+    const coverageId = this.#getLatestCoverageId(signatureRequest.id);
+    const coverageResult = await this.#backend.checkSignatureCoverage({
+      signatureRequest,
+      coverageId,
+    });
 
     // Publish coverage result
     this.messagingSystem.publish(

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

@@ -63,7 +63,7 @@ describe('ShieldRemoteBackend', () => {
     } as unknown as Response);
 
     const txMeta = generateMockTxMeta();
-    const coverageResult = await backend.checkCoverage(txMeta);
+    const coverageResult = await backend.checkCoverage({ txMeta });
     expect(coverageResult).toStrictEqual({ coverageId, status });
     expect(fetchMock).toHaveBeenCalledTimes(2);
     expect(getAccessToken).toHaveBeenCalledTimes(2);
@@ -95,7 +95,7 @@ describe('ShieldRemoteBackend', () => {
     } as unknown as Response);
 
     const txMeta = generateMockTxMeta();
-    const coverageResult = await backend.checkCoverage(txMeta);
+    const coverageResult = await backend.checkCoverage({ txMeta });
     expect(coverageResult).toStrictEqual({ coverageId, status });
     expect(fetchMock).toHaveBeenCalledTimes(3);
     expect(getAccessToken).toHaveBeenCalledTimes(2);
@@ -113,7 +113,7 @@ describe('ShieldRemoteBackend', () => {
     } as unknown as Response);
 
     const txMeta = generateMockTxMeta();
-    await expect(backend.checkCoverage(txMeta)).rejects.toThrow(
+    await expect(backend.checkCoverage({ txMeta })).rejects.toThrow(
       `Failed to init coverage check: ${status}`,
     );
     expect(fetchMock).toHaveBeenCalledTimes(1);
@@ -139,7 +139,7 @@ describe('ShieldRemoteBackend', () => {
     } as unknown as Response);
 
     const txMeta = generateMockTxMeta();
-    await expect(backend.checkCoverage(txMeta)).rejects.toThrow(
+    await expect(backend.checkCoverage({ txMeta })).rejects.toThrow(
       'Timeout waiting for coverage result',
     );
 
@@ -167,8 +167,9 @@ describe('ShieldRemoteBackend', () => {
       } as unknown as Response);
 
       const signatureRequest = generateMockSignatureRequest();
-      const coverageResult =
-        await backend.checkSignatureCoverage(signatureRequest);
+      const coverageResult = await backend.checkSignatureCoverage({
+        signatureRequest,
+      });
       expect(coverageResult).toStrictEqual({ coverageId, status });
       expect(fetchMock).toHaveBeenCalledTimes(2);
       expect(getAccessToken).toHaveBeenCalledTimes(2);
@@ -180,7 +181,7 @@ describe('ShieldRemoteBackend', () => {
       const signatureRequest = generateMockSignatureRequest();
       signatureRequest.messageParams.data = [];
       await expect(
-        backend.checkSignatureCoverage(signatureRequest),
+        backend.checkSignatureCoverage({ signatureRequest }),
       ).rejects.toThrow('Signature data must be a string');
     });
   });

packages/shield-controller/src/backend.ts

@@ -2,6 +2,8 @@ import type { SignatureRequest } from '@metamask/signature-controller';
 import type { TransactionMeta } from '@metamask/transaction-controller';
 
 import type {
+  CheckCoverageRequest,
+  CheckSignatureCoverageRequest,
   CoverageResult,
   CoverageStatus,
   LogSignatureRequest,
@@ -74,27 +76,31 @@ export class ShieldRemoteBackend implements ShieldBackend {
     this.#fetch = fetchFn;
   }
 
-  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {
-    const reqBody = makeInitCoverageCheckBody(txMeta);
-
-    const { coverageId } = await this.#initCoverageCheck(
-      'v1/transaction/coverage/init',
-      reqBody,
-    );
+  async checkCoverage(req: CheckCoverageRequest): Promise<CoverageResult> {
+    let { coverageId } = req;
+    if (!coverageId) {
+      const reqBody = makeInitCoverageCheckBody(req.txMeta);
+      ({ coverageId } = await this.#initCoverageCheck(
+        'v1/transaction/coverage/init',
+        reqBody,
+      ));
+    }
 
     const coverageResult = await this.#getCoverageResult(coverageId);
     return { coverageId, status: coverageResult.status };
   }
 
   async checkSignatureCoverage(
-    signatureRequest: SignatureRequest,
+    req: CheckSignatureCoverageRequest,
   ): Promise<CoverageResult> {
-    const reqBody = makeInitSignatureCoverageCheckBody(signatureRequest);
-
-    const { coverageId } = await this.#initCoverageCheck(
-      'v1/signature/coverage/init',
-      reqBody,
-    );
+    let { coverageId } = req;
+    if (!coverageId) {
+      const reqBody = makeInitSignatureCoverageCheckBody(req.signatureRequest);
+      ({ coverageId } = await this.#initCoverageCheck(
+        'v1/signature/coverage/init',
+        reqBody,
+      ));
+    }
 
     const coverageResult = await this.#getCoverageResult(coverageId);
     return { coverageId, status: coverageResult.status };

packages/shield-controller/src/types.ts

@@ -21,11 +21,21 @@ export type LogTransactionRequest = {
   status: string;
 };
 
+export type CheckCoverageRequest = {
+  coverageId?: string;
+  txMeta: TransactionMeta;
+};
+
+export type CheckSignatureCoverageRequest = {
+  coverageId?: string;
+  signatureRequest: SignatureRequest;
+};
+
 export type ShieldBackend = {
   logSignature: (req: LogSignatureRequest) => Promise<void>;
   logTransaction: (req: LogTransactionRequest) => Promise<void>;
-  checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult>;
+  checkCoverage: (req: CheckCoverageRequest) => Promise<CoverageResult>;
   checkSignatureCoverage: (
-    signatureRequest: SignatureRequest,
+    req: CheckSignatureCoverageRequest,
   ) => Promise<CoverageResult>;
 };

packages/shield-controller/tests/utils.ts

@@ -10,6 +10,7 @@ import {
 } from '@metamask/transaction-controller';
 import { v1 as random } from 'uuid';
 
+import type { createMockMessenger } from './mocks/messenger';
 import { coverageStatuses, type CoverageStatus } from '../src/types';
 
 /**
@@ -64,3 +65,24 @@ export function generateMockSignatureRequest(): SignatureRequest {
 export function getRandomCoverageStatus(): CoverageStatus {
   return coverageStatuses[Math.floor(Math.random() * coverageStatuses.length)];
 }
+
+/**
+ * Setup a coverage result received handler.
+ *
+ * @param baseMessenger - The base messenger.
+ * @returns A promise that resolves when the coverage result is received.
+ */
+export function setupCoverageResultReceived(
+  baseMessenger: ReturnType<typeof createMockMessenger>['baseMessenger'],
+): Promise<void> {
+  return new Promise<void>((resolve) => {
+    const handler = (_coverageResult: unknown) => {
+      baseMessenger.unsubscribe(
+        'ShieldController:coverageResultReceived',
+        handler,
+      );
+      resolve();
+    };
+    baseMessenger.subscribe('ShieldController:coverageResultReceived', handler);
+  });
+}