feat: add duration and traceId to degraded events

packages/controller-utils/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** The `ServicePolicy` type's `onDegraded` event now emits `{ duration: number }` instead of `void` when the service succeeds but takes longer than the `degradedThreshold` ([#8455](https://github.com/MetaMask/core/pull/8455))
+  - `void` has been removed from the event's type union. Listeners that checked for `undefined` data should now check for the `duration` property instead.
+  - The event still emits a `FailureReason` when retries are exhausted.
+
 ## [11.20.0]
 
 ### Added

packages/controller-utils/src/create-service-policy.test.ts

@@ -1500,6 +1500,27 @@ describe('createServicePolicy', () => {
               expect(onDegradedListener).toHaveBeenCalledTimes(1);
             });
 
+            it('calls onDegraded listeners with duration when the request succeeds but is slow', async () => {
+              jest.useFakeTimers();
+              const policy = createServicePolicy({
+                degradedThreshold: 2000,
+              });
+              const onDegradedListener = jest.fn();
+
+              policy.onDegraded(onDegradedListener);
+              await policy.execute(async () => {
+                jest.advanceTimersByTime(2001);
+                return 'result';
+              });
+
+              expect(onDegradedListener).toHaveBeenCalledTimes(1);
+              expect(onDegradedListener).toHaveBeenCalledWith({
+                duration: expect.any(Number),
+              });
+              const { duration } = onDegradedListener.mock.calls[0][0];
+              expect(duration).toBeGreaterThan(2000);
+            });
+
             it('does not call onAvailable listeners', async () => {
               let invocationCounter = 0;
               const delay = DEFAULT_DEGRADED_THRESHOLD + 1;

packages/controller-utils/src/create-service-policy.ts

@@ -117,7 +117,7 @@ export type ServicePolicy = IPolicy & {
    * never succeeds before the retry policy gives up and before the maximum
    * number of consecutive failures has been reached.
    */
-  onDegraded: CockatielEvent<FailureReason<unknown> | void>;
+  onDegraded: CockatielEvent<FailureReason<unknown> | { duration: number }>;
   /**
    * A function which is called when the service succeeds for the first time,
    * or when the service fails enough times to cause the circuit to break and
@@ -321,8 +321,9 @@ export function createServicePolicy(
   });
   const onBreak = circuitBreakerPolicy.onBreak.bind(circuitBreakerPolicy);
 
-  const onDegradedEventEmitter =
-    new CockatielEventEmitter<FailureReason<unknown> | void>();
+  const onDegradedEventEmitter = new CockatielEventEmitter<
+    FailureReason<unknown> | { duration: number }
+  >();
   const onDegraded = onDegradedEventEmitter.addListener;
 
   const onAvailableEventEmitter = new CockatielEventEmitter<void>();
@@ -338,7 +339,7 @@ export function createServicePolicy(
     if (circuitBreakerPolicy.state === CircuitState.Closed) {
       if (duration > degradedThreshold) {
         availabilityStatus = AVAILABILITY_STATUSES.Degraded;
-        onDegradedEventEmitter.emit();
+        onDegradedEventEmitter.emit({ duration });
       } else if (availabilityStatus !== AVAILABILITY_STATUSES.Available) {
         availabilityStatus = AVAILABILITY_STATUSES.Available;
         onAvailableEventEmitter.emit();

packages/network-controller/CHANGELOG.md

@@ -24,6 +24,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - `NetworkController:loadBackup`
   - Corresponding action types are available as well.
 - Add `getEthQuery` method to `NetworkController` ([#8350](https://github.com/MetaMask/core/pull/8350))
+- Add `duration` and `traceId` to `NetworkController:rpcEndpointDegraded` and `NetworkController:rpcEndpointChainDegraded` event payloads ([#8455](https://github.com/MetaMask/core/pull/8455))
+  - `duration` contains the policy execution time in milliseconds when the request succeeded but was slow. It is `undefined` when retries were exhausted.
+  - `traceId` contains the value of the `x-trace-id` response header from the last request attempt, or `undefined` if the header was not present.
 
 ### Changed
 

packages/network-controller/src/NetworkController.ts

@@ -518,21 +518,28 @@ export type NetworkControllerRpcEndpointUnavailableEvent = {
  *
  * @param payload - The event payload.
  * @param payload.chainId - The target network's chain ID.
+ * @param payload.duration - The duration in milliseconds of the policy
+ * execution when the request succeeded but was slow. `undefined` when retries
+ * were exhausted.
  * @param payload.error - The last error produced by the endpoint (or
  * `undefined` if the request was slow).
  * @param payload.networkClientId - The target network's client ID.
  * @param payload.rpcMethodName - The JSON-RPC method that was being executed
  * when the chain became degraded.
+ * @param payload.traceId - The value of the `x-trace-id` response header from
+ * the last request attempt, or `undefined` if the header was not present.
  */
 export type NetworkControllerRpcEndpointChainDegradedEvent = {
   type: 'NetworkController:rpcEndpointChainDegraded';
   payload: [
     {
       chainId: Hex;
+      duration?: number;
       error: unknown;
       networkClientId: NetworkClientId;
       retryReason?: RetryReason;
       rpcMethodName: string;
+      traceId?: string;
       type: DegradedEventType;
     },
   ];
@@ -553,6 +560,9 @@ export type NetworkControllerRpcEndpointChainDegradedEvent = {
  *
  * @param payload - The event payload.
  * @param payload.chainId - The target network's chain ID.
+ * @param payload.duration - The duration in milliseconds of the policy
+ * execution when the request succeeded but was slow. `undefined` when retries
+ * were exhausted.
  * @param payload.endpointUrl - The URL of the endpoint for which requests
  * failed or were slow to complete. You can compare this to `primaryEndpointUrl`
  * to know whether it was a failover or a primary.
@@ -562,18 +572,22 @@ export type NetworkControllerRpcEndpointChainDegradedEvent = {
  * @param payload.primaryEndpointUrl - The endpoint chain's primary URL.
  * @param payload.rpcMethodName - The JSON-RPC method that was being executed
  * when the endpoint became degraded.
+ * @param payload.traceId - The value of the `x-trace-id` response header from
+ * the last request attempt, or `undefined` if the header was not present.
  */
 export type NetworkControllerRpcEndpointDegradedEvent = {
   type: 'NetworkController:rpcEndpointDegraded';
   payload: [
     {
       chainId: Hex;
+      duration?: number;
       endpointUrl: string;
       error: unknown;
       networkClientId: NetworkClientId;
       primaryEndpointUrl: string;
       retryReason?: RetryReason;
       rpcMethodName: string;
+      traceId?: string;
       type: DegradedEventType;
     },
   ];

packages/network-controller/src/create-network-client-tests/rpc-endpoint-events.test.ts

@@ -544,6 +544,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         networkClientId: 'AAAA-AAAA-AAAA-AAAA',
                         retryReason: 'non_successful_http_status',
                         rpcMethodName: 'eth_blockNumber',
+                        duration: undefined,
+                        traceId: undefined,
                       });
                     },
                   );
@@ -667,6 +669,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         networkClientId: 'AAAA-AAAA-AAAA-AAAA',
                         retryReason: 'non_successful_http_status',
                         rpcMethodName: 'eth_blockNumber',
+                        duration: undefined,
+                        traceId: undefined,
                       });
                     },
                   );
@@ -780,6 +784,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         primaryEndpointUrl: rpcUrl,
                         retryReason: 'non_successful_http_status',
                         rpcMethodName: 'eth_blockNumber',
+                        duration: undefined,
+                        traceId: undefined,
                       });
                       expect(
                         rpcEndpointDegradedEventHandler,
@@ -792,6 +798,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         primaryEndpointUrl: rpcUrl,
                         retryReason: 'non_successful_http_status',
                         rpcMethodName: 'eth_blockNumber',
+                        duration: undefined,
+                        traceId: undefined,
                       });
                       expect(
                         rpcEndpointDegradedEventHandler,
@@ -804,6 +812,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         primaryEndpointUrl: rpcUrl,
                         retryReason: 'non_successful_http_status',
                         rpcMethodName: 'eth_blockNumber',
+                        duration: undefined,
+                        traceId: undefined,
                       });
                     },
                   );
@@ -929,6 +939,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         primaryEndpointUrl: rpcUrl,
                         retryReason: 'non_successful_http_status',
                         rpcMethodName: 'eth_blockNumber',
+                        duration: undefined,
+                        traceId: undefined,
                       });
                       expect(
                         rpcEndpointDegradedEventHandler,
@@ -941,6 +953,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         primaryEndpointUrl: rpcUrl,
                         retryReason: 'non_successful_http_status',
                         rpcMethodName: 'eth_blockNumber',
+                        duration: undefined,
+                        traceId: undefined,
                       });
                       expect(
                         rpcEndpointDegradedEventHandler,
@@ -952,6 +966,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         networkClientId: 'AAAA-AAAA-AAAA-AAAA',
                         primaryEndpointUrl: rpcUrl,
                         rpcMethodName: 'eth_blockNumber',
+                        duration: expect.any(Number),
+                        traceId: undefined,
                       });
                       expect(
                         rpcEndpointDegradedEventHandler,
@@ -963,6 +979,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         networkClientId: 'AAAA-AAAA-AAAA-AAAA',
                         primaryEndpointUrl: rpcUrl,
                         rpcMethodName: 'eth_gasPrice',
+                        duration: expect.any(Number),
+                        traceId: undefined,
                       });
                     },
                   );
@@ -1164,6 +1182,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                     networkClientId: 'AAAA-AAAA-AAAA-AAAA',
                     retryReason: 'non_successful_http_status',
                     rpcMethodName: 'eth_blockNumber',
+                    duration: undefined,
+                    traceId: undefined,
                   });
                 },
               );
@@ -1242,6 +1262,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                     error: undefined,
                     networkClientId: 'AAAA-AAAA-AAAA-AAAA',
                     rpcMethodName: 'eth_blockNumber',
+                    duration: expect.any(Number),
+                    traceId: undefined,
                   });
                 },
               );
@@ -1331,6 +1353,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                     primaryEndpointUrl: rpcUrl,
                     retryReason: 'non_successful_http_status',
                     rpcMethodName: 'eth_blockNumber',
+                    duration: undefined,
+                    traceId: undefined,
                   });
                   expect(rpcEndpointDegradedEventHandler).toHaveBeenCalledWith({
                     chainId,
@@ -1341,6 +1365,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                     primaryEndpointUrl: rpcUrl,
                     retryReason: 'non_successful_http_status',
                     rpcMethodName: 'eth_blockNumber',
+                    duration: undefined,
+                    traceId: undefined,
                   });
                 },
               );
@@ -1572,6 +1598,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                     networkClientId: 'AAAA-AAAA-AAAA-AAAA',
                     primaryEndpointUrl: rpcUrl,
                     rpcMethodName: 'eth_blockNumber',
+                    duration: expect.any(Number),
+                    traceId: undefined,
                   });
                   expect(rpcEndpointDegradedEventHandler).toHaveBeenCalledWith({
                     chainId,
@@ -1581,6 +1609,8 @@ describe('createNetworkClient - RPC endpoint events', () => {
                     networkClientId: 'AAAA-AAAA-AAAA-AAAA',
                     primaryEndpointUrl: rpcUrl,
                     rpcMethodName: 'eth_gasPrice',
+                    duration: expect.any(Number),
+                    traceId: undefined,
                   });
                 },
               );

packages/network-controller/src/create-network-client.ts

@@ -350,25 +350,32 @@ function createRpcServiceChain({
     },
   );
 
-  rpcServiceChain.onDegraded(({ rpcMethodName, ...rest }) => {
-    const error = getError(rest);
-    const type: DegradedEventType =
-      error === undefined ? 'slow_success' : 'retries_exhausted';
-    messenger.publish('NetworkController:rpcEndpointChainDegraded', {
-      chainId: configuration.chainId,
-      networkClientId: id,
-      error,
-      rpcMethodName,
-      type,
-      retryReason: error === undefined ? undefined : classifyRetryReason(error),
-    });
-  });
+  rpcServiceChain.onDegraded(
+    ({ rpcMethodName, duration, traceId, ...rest }) => {
+      const error = getError(rest);
+      const type: DegradedEventType =
+        error === undefined ? 'slow_success' : 'retries_exhausted';
+      messenger.publish('NetworkController:rpcEndpointChainDegraded', {
+        chainId: configuration.chainId,
+        networkClientId: id,
+        error,
+        rpcMethodName,
+        duration,
+        traceId,
+        type,
+        retryReason:
+          error === undefined ? undefined : classifyRetryReason(error),
+      });
+    },
+  );
 
   rpcServiceChain.onServiceDegraded(
     ({
       endpointUrl,
       primaryEndpointUrl: primaryEndpointUrlFromEvent,
       rpcMethodName,
+      duration,
+      traceId,
       ...rest
     }) => {
       const error = getError(rest);
@@ -382,6 +389,8 @@ function createRpcServiceChain({
         endpointUrl,
         error,
         rpcMethodName,
+        duration,
+        traceId,
         type,
         retryReason:
           error === undefined ? undefined : classifyRetryReason(error),