Fix SelectedNetworkController default metamask networkClientId

[jiexi]

Explanation

Currently, the SelectedNetworkController does not set a value for the default metamask domain on initial NetworkController:stateChange event because it does not count selectedNetworkId as actually changed in the patch yet. This manifests itself in extension with the SelectedNetworkMiddleware setting undefined for the req.networkClientId attribute. This PR adds one more check to the event listener to ensure that the first NetworkController:stateChange event is used to populate the networkClientId for the default metamask domain. See resolution in comments

References

• Fixes https://github.com/MetaMask/MetaMask-planning/issues/1370

Changelog

@metamask/selected-network-controller

• FIXED: setNetworkClientIdForDomain() will now ignore the passed in domain value and set the networkClientId for the metamask domain instead when the state.perDomainNetwork flag is false (default)

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 highlighted breaking changes using the "BREAKING" category above as appropriate

[jiexi]

Note that this requires SelectedNetworkController to be instantiated before NetworkController.

An alternative solution is to change setNetworkClientIdForDomain

from

  setNetworkClientIdForDomain(
    domain: Domain,
    networkClientId: NetworkClientId,
  ) {
    this.update((state) => {
      state.domains[domain] = networkClientId;
    });
  }

to

  setNetworkClientIdForDomain(
    domain: Domain,
    networkClientId: NetworkClientId,
  ) {
    this.update((state) => {
      if (!state.perDomainNetwork) {
        state.domains[METAMASK_DOMAIN] = networkClientId
        return
      }
      state.domains[domain] = networkClientId;
    });
  }

[jiexi]

Another alternative is to instantiate SelectedNetworkController after NetworkController and then to call selectedNetworkController.setNetworkClientIdForMetamask(networkController.state.selectedNetworkId) afterwards

[adonesky1]

setNetworkClientIdForDomain(
domain: Domain,
networkClientId: NetworkClientId,
) {
this.update((state) => {
if (state.perDomainNetwork) {
state.domains[METAMASK_DOMAIN] = networkClientId
return
}
state.domains[domain] = networkClientId;
});
}

Would this work? Wouldn't we be updating the the metamask domain every time then and skipping setting other domains? Did you mean if (!state.perDomainNetwork)? Maybe I'm missing something here?

[adonesky1]

LGTM

[jiexi]

Did you mean if (!state.perDomainNetwork)? Maybe I'm missing something here?

sorry, you're correct. The if statement should be negated like you suggested

@adonesky1 what approach do you think is preferable? The setNetworkClientIdForDomain approach would make it so controller instantiation order doesn't matter again

[adonesky1]

Hey @jiexi sorry for the delay but

The setNetworkClientIdForDomain approach would make it so controller instantiation order doesn't matter again

I think this ^ approach is probably better

[adonesky1]

Small nit otherwise LGTM