refactor: remove primaryEndpointUrl from chain-level RPC events

Remove primaryEndpointUrl field from NetworkController chain-level events:
- NetworkController:rpcEndpointChainUnavailable
- NetworkController:rpcEndpointChainDegraded
- NetworkController:rpcEndpointChainAvailable

Chain-level events are designed to represent the overall status of an
endpoint chain, not individual endpoints. The primaryEndpointUrl field
is redundant since consumers can derive endpoint information from the
networkClientId using getNetworkClientById() or
getNetworkConfigurationByNetworkClientId().

Individual endpoint events (rpcEndpointUnavailable, rpcEndpointDegraded,
rpcEndpointRetried) retain the primaryEndpointUrl field, as it's useful
for comparing endpointUrl to primaryEndpointUrl to determine whether the
affected endpoint is a primary or a failover.

Updated event type definitions, event publishing logic, test assertions,
and changelog to reflect these changes.

Author: cryptodev-2s

packages/network-controller/CHANGELOG.md

@@ -16,8 +16,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **BREAKING:** Split up and update payload data for `NetworkController:rpcEndpointDegraded` and `NetworkController:rpcEndpointUnavailable` ([#7166](https://github.com/MetaMask/core/pull/7166))
   - `NetworkController:rpcEndpointDegraded` and `NetworkController:rpcEndpointUnavailable` still exist and retain the same behavior as before.
-  - New events are `NetworkController:rpcEndpointChainDegraded` and `NetworkController:rpcEndpointChainUnavailable`, and are designed to represent an entire chain of endpoints. They are also guaranteed to not be published multiple times in a row. In particular, `NetworkController:rpcEndpointUnavailable` is published only after trying all of the endpoints for a chain and when the underlying circuit for the last endpoint breaks, not as each primary's or failover's circuit breaks.
-  - The event payloads for all events have been changed as well: `failoverEndpointUrl` has been renamed to `endpointUrl`, and `endpointUrl` has been renamed to `primaryEndpointUrl`. In addition, `networkClientId` has been added to the payload.
+  - New events are `NetworkController:rpcEndpointChainDegraded` and `NetworkController:rpcEndpointChainUnavailable`, and are designed to represent an entire chain of endpoints. They are also guaranteed to not be published multiple times in a row. In particular, `NetworkController:rpcEndpointChainUnavailable` is published only after trying all of the endpoints for a chain and when the underlying circuit for the last endpoint breaks, not as each primary's or failover's circuit breaks.
+  - The event payloads have been changed:
+    - For individual endpoint events (`NetworkController:rpcEndpointUnavailable`, `NetworkController:rpcEndpointDegraded`): `failoverEndpointUrl` has been renamed to `endpointUrl`, and `endpointUrl` has been renamed to `primaryEndpointUrl`. In addition, `networkClientId` has been added to the payload.
+    - For chain-level events (`NetworkController:rpcEndpointChainUnavailable`, `NetworkController:rpcEndpointChainDegraded`, `NetworkController:rpcEndpointChainAvailable`): These include `chainId`, `networkClientId`, and event-specific fields (e.g., `error`, `endpointUrl`) but do not include `primaryEndpointUrl`. Consumers can derive endpoint information from the `networkClientId` using `NetworkController:getNetworkClientById` or `NetworkController:getNetworkConfigurationByNetworkClientId`.
 - **BREAKING:** Rename and update payload data for `NetworkController:rpcEndpointRequestRetried` ([#7166](https://github.com/MetaMask/core/pull/7166))
   - This event is now called `NetworkController:rpcEndpointRetried`.
   - The event payload has been changed as well: `failoverEndpointUrl` has been removed, and `primaryEndpointUrl` has been added. In addition, `networkClientId` and `attempt` have been added to the payload.

packages/network-controller/src/NetworkController.ts

@@ -455,7 +455,6 @@ export type NetworkControllerNetworkRemovedEvent = {
  * @param payload.error - The last error produced by the last failover in the
  * endpoint chain.
  * @param payload.networkClientId - The target network's client ID.
- * @param payload.primaryEndpointUrl - The endpoint chain's primary URL.
  */
 export type NetworkControllerRpcEndpointChainUnavailableEvent = {
   type: 'NetworkController:rpcEndpointChainUnavailable';
@@ -464,7 +463,6 @@ export type NetworkControllerRpcEndpointChainUnavailableEvent = {
       chainId: Hex;
       error: unknown;
       networkClientId: NetworkClientId;
-      primaryEndpointUrl: string;
     },
   ];
 };
@@ -519,7 +517,6 @@ export type NetworkControllerRpcEndpointUnavailableEvent = {
  * @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.primaryEndpointUrl - The endpoint chain's primary URL.
  */
 export type NetworkControllerRpcEndpointChainDegradedEvent = {
   type: 'NetworkController:rpcEndpointChainDegraded';
@@ -529,7 +526,6 @@ export type NetworkControllerRpcEndpointChainDegradedEvent = {
       endpointUrl: string;
       error: unknown;
       networkClientId: NetworkClientId;
-      primaryEndpointUrl: string;
     },
   ];
 };
@@ -584,7 +580,6 @@ export type NetworkControllerRpcEndpointDegradedEvent = {
  * @param payload.endpointUrl - The URL of the endpoint which meets either of
  * the above conditions.
  * @param payload.networkClientId - The target network's client ID.
- * @param payload.primaryEndpointUrl - The endpoint chain's primary URL.
  */
 export type NetworkControllerRpcEndpointChainAvailableEvent = {
   type: 'NetworkController:rpcEndpointChainAvailable';
@@ -593,7 +588,6 @@ export type NetworkControllerRpcEndpointChainAvailableEvent = {
       chainId: Hex;
       endpointUrl: string;
       networkClientId: NetworkClientId;
-      primaryEndpointUrl: string;
     },
   ];
 };

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

@@ -84,7 +84,7 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         },
                       }),
                     },
-                    async ({ makeRpcCall, clock, chainId, rpcUrl }) => {
+                    async ({ makeRpcCall, clock, chainId }) => {
                       messenger.subscribe(
                         'NetworkController:rpcEndpointRetried',
                         () => {
@@ -127,7 +127,6 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         chainId,
                         error: expectedUnavailableError,
                         networkClientId: 'AAAA-AAAA-AAAA-AAAA',
-                        primaryEndpointUrl: rpcUrl,
                       });
                     },
                   );
@@ -363,7 +362,6 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         endpointUrl: rpcUrl,
                         error: expectedDegradedError,
                         networkClientId: 'AAAA-AAAA-AAAA-AAAA',
-                        primaryEndpointUrl: rpcUrl,
                       });
                     },
                   );
@@ -480,7 +478,6 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         endpointUrl: rpcUrl,
                         error: expectedDegradedError,
                         networkClientId: 'AAAA-AAAA-AAAA-AAAA',
-                        primaryEndpointUrl: rpcUrl,
                       });
                     },
                   );
@@ -829,7 +826,7 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         },
                       }),
                     },
-                    async ({ makeRpcCall, clock, chainId, rpcUrl }) => {
+                    async ({ makeRpcCall, clock, chainId }) => {
                       messenger.subscribe(
                         'NetworkController:rpcEndpointRetried',
                         () => {
@@ -860,7 +857,6 @@ describe('createNetworkClient - RPC endpoint events', () => {
                         chainId,
                         endpointUrl: failoverEndpointUrl,
                         networkClientId: 'AAAA-AAAA-AAAA-AAAA',
-                        primaryEndpointUrl: rpcUrl,
                       });
                     },
                   );
@@ -951,7 +947,6 @@ describe('createNetworkClient - RPC endpoint events', () => {
                     endpointUrl: rpcUrl,
                     error: expectedDegradedError,
                     networkClientId: 'AAAA-AAAA-AAAA-AAAA',
-                    primaryEndpointUrl: rpcUrl,
                   });
                 },
               );
@@ -1028,7 +1023,6 @@ describe('createNetworkClient - RPC endpoint events', () => {
                     endpointUrl: rpcUrl,
                     error: undefined,
                     networkClientId: 'AAAA-AAAA-AAAA-AAAA',
-                    primaryEndpointUrl: rpcUrl,
                   });
                 },
               );
@@ -1265,7 +1259,6 @@ describe('createNetworkClient - RPC endpoint events', () => {
                     chainId,
                     endpointUrl: rpcUrl,
                     networkClientId: 'AAAA-AAAA-AAAA-AAAA',
-                    primaryEndpointUrl: rpcUrl,
                   });
                 },
               );

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

@@ -261,7 +261,6 @@ function createRpcServiceChain({
       messenger.publish('NetworkController:rpcEndpointChainUnavailable', {
         chainId: configuration.chainId,
         networkClientId: id,
-        primaryEndpointUrl: primaryEndpointUrlFromEvent,
         error,
       });
     },
@@ -294,7 +293,6 @@ function createRpcServiceChain({
       messenger.publish('NetworkController:rpcEndpointChainDegraded', {
         chainId: configuration.chainId,
         networkClientId: id,
-        primaryEndpointUrl: primaryEndpointUrlFromEvent,
         endpointUrl,
         error,
       });
@@ -323,7 +321,6 @@ function createRpcServiceChain({
       messenger.publish('NetworkController:rpcEndpointChainAvailable', {
         chainId: configuration.chainId,
         networkClientId: id,
-        primaryEndpointUrl: primaryEndpointUrlFromEvent,
         endpointUrl,
       });
     },