refactor: Rename ambiguous network variables #7089
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gudahtt
force-pushed
the
rename-ambiguous-network-variables
branch
from
932f977
to
6fcda0a
Compare
Gudahtt
added
the
needs-dev-review
|
E2E test run started here: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/17fabd69-cc08-41f1-a820-0f1e6f3ba127 |
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #7089 +/- ##
==========================================
+ Coverage 32.78% 32.83% +0.04%
==========================================
Files 1001 1001
Lines 26710 26709 -1
Branches 2096 2096
==========================================
+ Hits 8758 8769 +11
+ Misses 17534 17524 -10
+ Partials 418 416 -2
☔ View full report in Codecov by Sentry. |
The variable name `network` is used to refer to a network ID, network configuration, network type, network name, and various other things (sometimes even in the same file!). This can make it very difficult to understand what is happening, and it's a major obstacle to refactors of the network state. Most `network` variables have been renamed to make it more clear what they refer to. Any instances of `network` that were part of data structures shared externally (e.g. metrics, provider state) were left alone, as were any cases that seemed too complicated to rename. This relates to MetaMask/mobile-planning#1015
Gudahtt
force-pushed
the
rename-ambiguous-network-variables
branch
from
a2b5481
to
105c8db
Compare
Gudahtt
commented
Aug 31, 2023
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
Cal-L
added
No QA Needed/E2E Only
|
Kudos, SonarCloud Quality Gate passed!
|
metamaskbot
added
the
release-7.7.0
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Development & PR Process
release-xxlabel to identify the PR slated for a upcoming release (will be used in release discussion)needs-dev-reviewlabel when work is completedneeds-qa: PR requires manual QA.No QA/E2E only: PR does not require any manual QA effort. Prior to merging, ensure that you have successful end-to-end test runs in Bitrise.Spot check on release build: PR does not require feature QA but needs non-automated verification. In the description section, provide test scenarios. Add screenshots, and or recordings of what was tested.QA Passedlabel when QA has signed off (Only required if the PR was labeled withneeds-qa)team-(orexternal-contributorlabel if your not a MetaMask employee)Description
The variable name
networkis used to refer to a network ID, network configuration, network type, network name, and various other things (sometimes even in the same file!). This can make it very difficult to understand what is happening, and it's a major obstacle to refactors of the network state.Most
networkvariables have been renamed to make it more clear what they refer to. Any instances ofnetworkthat were part of data structures shared externally (e.g. metrics, provider state) were left alone, as were any cases that seemed too complicated to rename.Issue
This relates to https://github.com/MetaMask/mobile-planning/issues/1015
Checklist