fix: Prevent State Changes for ignoreTokens on Non-Current Network

[salimtb]

Explanation

This pull request addresses an issue in the ignoreTokens function where tokens' states were being updated even if the operation did not pertain to the currently selected network. This behavior could lead to unintended state changes and potential inconsistencies across networks.

Code Changes

1. Modified TokensController.ts to include conditional updates for ignoredTokens and tokens based on the currently selected network.
2. Adjusted unit tests in TokensController.test.ts to reflect the new behavior, ensuring state changes only occur for the active network.

References

Changelog

@metamask/assets-controllers

• FIXED: Prevented updates to tokens, ignoreTokens, delectedTokens state when we call ignoredTokens on networks other than the currently selected one.

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
• I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

[gambinish]

LGTM, but maybe we should also wait for Mark or Elliot's review as well

[cryptodev-2s]

LGTM!

[mcmire]

A couple of suggestions.

[mcmire]

Is this test name as accurate as it could be?

• It says that tokens should only be added to allIgnoredTokens state, but we are never checking that state. We are just checking that tokens and ignoredTokens are not affected, which is a slightly different thing to check.
• Who are "we" in this context?

Perhaps a better name would be:

Suggested change

	it('should add tokens to allIgnoredTokens state only if we are not using current network', async () => {
	it('should not update detectedTokens, tokens, and ignoredTokens state given a network that is different from the globally selected network', async () => {

[mcmire]

On top of this, do we have a test which ensures that detectedTokens, tokens, and ignoredTokens do get updated when passed the globally selected network? I'm not quite seeing that.

[salimtb]

suggestions implemented with two tests scenarios

• should not update detectedTokens, tokens, and ignoredTokens state given a network that is different from the globally selected network
• should update tokens, and ignoredTokens and detectedTokens state for the globally selected network

[salimtb]

for detected tokens, it's a bit complex to test them, so I've put some assertions to make sure they're not affected, but I'm open to suggestions.

[mcmire]

Thanks for adding those tests. It would be great to improve the test coverage for this controller in the future, but I think this helps in the meantime.