chore: log all bridge-api validation errors (#5913)

## Explanation

Improves response validation traces by logging all invalid fields.
Currently the logs only include the first detected failure. View test
snapshot updates to see how this changes the logged data

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

## Changelog

<!--
THIS SECTION IS NO LONGER NEEDED.

The process for updating changelogs has changed. Please consult the
"Updating changelogs" section of the Contributing doc for more.
-->

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] 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

Author: micaelae

packages/bridge-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Include all invalid quote properties in sentry logs ([#5913](https://github.com/MetaMask/core/pull/5913))
+
 ## [32.0.1]
 
 ### Fixed

packages/bridge-controller/src/utils/__snapshots__/fetch.test.ts.snap

@@ -0,0 +1,28 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`fetch fetchBridgeQuotes should filter out malformed bridge quotes 1`] = `
+Array [
+  Array [
+    "Quote validation failed",
+    Object {
+      "socket": Set {
+        "quote.requestId",
+        "quote.srcChainId",
+        "quote.srcAsset.decimals",
+        "quote.srcTokenAmount",
+        "quote.destChainId",
+        "quote.destAsset",
+        "quote.destTokenAmount",
+        "quote.feeData",
+        "quote.bridges",
+        "quote.steps",
+        "quote.srcAsset",
+        "quote.destAsset.address",
+      },
+      "undefined": Set {
+        "quote",
+      },
+    },
+  ],
+]
+`;

packages/bridge-controller/src/utils/fetch.test.ts

@@ -225,6 +225,9 @@ describe('fetch', () => {
     });
 
     it('should filter out malformed bridge quotes', async () => {
+      const mockConsoleError = jest
+        .spyOn(console, 'error')
+        .mockImplementation(jest.fn());
       mockFetchFn.mockResolvedValue([
         ...mockBridgeQuotesErc20Erc20,
         ...mockBridgeQuotesErc20Erc20.map(
@@ -233,6 +236,7 @@ describe('fetch', () => {
         {
           ...mockBridgeQuotesErc20Erc20[0],
           quote: {
+            bridgeId: 'socket',
             srcAsset: {
               ...mockBridgeQuotesErc20Erc20[0].quote.srcAsset,
               decimals: undefined,
@@ -242,7 +246,8 @@ describe('fetch', () => {
         {
           ...mockBridgeQuotesErc20Erc20[1],
           quote: {
-            srcAsset: {
+            bridgeId: 'socket',
+            destAsset: {
               ...mockBridgeQuotesErc20Erc20[1].quote.destAsset,
               address: undefined,
             },
@@ -280,6 +285,8 @@ describe('fetch', () => {
       );
 
       expect(result).toStrictEqual(mockBridgeQuotesErc20Erc20);
+      // eslint-disable-next-line jest/no-restricted-matchers
+      expect(mockConsoleError.mock.calls).toMatchSnapshot();
     });
   });
 

packages/bridge-controller/src/utils/fetch.ts

@@ -1,3 +1,4 @@
+import { StructError } from '@metamask/superstruct';
 import type { CaipAssetType, CaipChainId, Hex } from '@metamask/utils';
 import { Duration } from '@metamask/utils';
 
@@ -103,14 +104,30 @@ export async function fetchBridgeQuotes(
     functionName: 'fetchBridgeQuotes',
   });
 
+  const validationFailuresByAggregator: {
+    [aggregator: string]: Set<string>;
+  } = {};
   const filteredQuotes = quotes.filter((quoteResponse: unknown) => {
     try {
       return validateQuoteResponse(quoteResponse);
     } catch (error) {
-      console.error(error);
+      if (error instanceof StructError) {
+        error.failures().forEach(({ branch, path }) => {
+          const aggregatorId = branch?.[0]?.quote?.bridgeId;
+          if (!validationFailuresByAggregator[aggregatorId]) {
+            validationFailuresByAggregator[aggregatorId] = new Set([]);
+          }
+          const pathString = path?.join('.') || 'unknown';
+          validationFailuresByAggregator[aggregatorId].add(pathString);
+        });
+      }
       return false;
     }
   });
+
+  if (Object.keys(validationFailuresByAggregator).length > 0) {
+    console.error('Quote validation failed', validationFailuresByAggregator);
+  }
   return filteredQuotes as QuoteResponse[];
 }
 

packages/bridge-status-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Include all invalid status properties in sentry logs ([#5913](https://github.com/MetaMask/core/pull/5913))
+
 ## [29.0.0]
 
 ### Changed

packages/bridge-status-controller/src/utils/__snapshots__/validators.test.ts.snap

@@ -3,39 +3,55 @@
 exports[`validators bridgeStatusValidator should throw for invalid response for complete bridge status with missing fields 1`] = `
 Array [
   Array [
-    [StructError: At path: srcChain -- Expected an object, but received: undefined],
+    "Bridge status validation failed",
+    Object {
+      "srcChain": "[across] Expected an object, but received: undefined",
+    },
   ],
 ]
 `;
 
 exports[`validators bridgeStatusValidator should throw for invalid response for empty object 1`] = `
 Array [
   Array [
-    [StructError: At path: status -- Expected one of \`"UNKNOWN","FAILED","PENDING","COMPLETE"\`, but received: undefined],
+    "Bridge status validation failed",
+    Object {
+      "srcChain": "[unknown] Expected an object, but received: undefined",
+      "status": "[unknown] Expected one of \`\\"UNKNOWN\\",\\"FAILED\\",\\"PENDING\\",\\"COMPLETE\\"\`, but received: undefined",
+    },
   ],
 ]
 `;
 
 exports[`validators bridgeStatusValidator should throw for invalid response for null 1`] = `
 Array [
   Array [
-    [StructError: Expected an object, but received: null],
+    "Bridge status validation failed",
+    Object {
+      "unknown": "[unknown] Expected an object, but received: null",
+    },
   ],
 ]
 `;
 
 exports[`validators bridgeStatusValidator should throw for invalid response for pending bridge status with missing fields 1`] = `
 Array [
   Array [
-    [StructError: At path: destChain.chainId -- Expected the value to satisfy a union of \`number | string\`, but received: undefined],
+    "Bridge status validation failed",
+    Object {
+      "destChain.chainId": "[across] Expected a string, but received: undefined",
+    },
   ],
 ]
 `;
 
 exports[`validators bridgeStatusValidator should throw for invalid response for undefined 1`] = `
 Array [
   Array [
-    [StructError: Expected an object, but received: undefined],
+    "Bridge status validation failed",
+    Object {
+      "unknown": "[unknown] Expected an object, but received: undefined",
+    },
   ],
 ]
 `;

packages/bridge-status-controller/src/utils/validators.ts

@@ -10,6 +10,7 @@ import {
   type,
   nullable,
   assert,
+  StructError,
 } from '@metamask/superstruct';
 
 export const validateBridgeStatusResponse = (data: unknown) => {
@@ -52,10 +53,21 @@ export const validateBridgeStatusResponse = (data: unknown) => {
     refuel: optional(RefuelStatusResponseSchema),
   });
 
+  const validationFailures: { [path: string]: string } = {};
   try {
     assert(data, StatusResponseSchema);
   } catch (error) {
-    console.error(error);
+    if (error instanceof StructError) {
+      error.failures().forEach(({ branch, path, message }) => {
+        const pathString = path?.join('.') || 'unknown';
+        validationFailures[pathString] =
+          `[${branch?.[0]?.bridge || 'unknown'}] ${message}`;
+      });
+    }
     throw error;
+  } finally {
+    if (Object.keys(validationFailures).length > 0) {
+      console.error(`Bridge status validation failed`, validationFailures);
+    }
   }
 };