Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Temp/network syncing all changes #4849

Draft
wants to merge 30 commits into
base: main
Choose a base branch
from
Draft

Temp/network syncing all changes #4849

wants to merge 30 commits into from

Conversation

Prithpal-Sooriya
Copy link
Contributor

Explanation

temp branch to create a preview build for and test network syncing on extension.

References

Changelog

@metamask/package-a

  • : Your change here
  • : Your change here

@metamask/package-b

  • : Your change here
  • : Your change here

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

@Prithpal-Sooriya Prithpal-Sooriya added DO-NOT-MERGE team-notifications Notification Team changes. https://github.com/orgs/MetaMask/teams/notifications labels Oct 24, 2024
@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions. 
{
  "@metamask-previews/accounts-controller": "18.2.2-preview-e7f13cec",
  "@metamask-previews/address-book-controller": "6.0.1-preview-e7f13cec",
  "@metamask-previews/announcement-controller": "7.0.1-preview-e7f13cec",
  "@metamask-previews/approval-controller": "7.1.0-preview-e7f13cec",
  "@metamask-previews/assets-controllers": "39.0.0-preview-e7f13cec",
  "@metamask-previews/base-controller": "7.0.1-preview-e7f13cec",
  "@metamask-previews/build-utils": "3.0.1-preview-e7f13cec",
  "@metamask-previews/chain-controller": "0.1.3-preview-e7f13cec",
  "@metamask-previews/composable-controller": "9.0.1-preview-e7f13cec",
  "@metamask-previews/controller-utils": "11.4.0-preview-e7f13cec",
  "@metamask-previews/ens-controller": "14.0.1-preview-e7f13cec",
  "@metamask-previews/eth-json-rpc-provider": "4.1.5-preview-e7f13cec",
  "@metamask-previews/gas-fee-controller": "21.0.0-preview-e7f13cec",
  "@metamask-previews/json-rpc-engine": "10.0.0-preview-e7f13cec",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.4-preview-e7f13cec",
  "@metamask-previews/keyring-controller": "17.3.0-preview-e7f13cec",
  "@metamask-previews/logging-controller": "6.0.1-preview-e7f13cec",
  "@metamask-previews/message-manager": "11.0.0-preview-e7f13cec",
  "@metamask-previews/multichain": "0.0.0-preview-e7f13cec",
  "@metamask-previews/name-controller": "8.0.1-preview-e7f13cec",
  "@metamask-previews/network-controller": "22.0.0-preview-e7f13cec",
  "@metamask-previews/notification-controller": "7.0.0-preview-e7f13cec",
  "@metamask-previews/notification-services-controller": "0.12.0-preview-e7f13cec",
  "@metamask-previews/permission-controller": "11.0.2-preview-e7f13cec",
  "@metamask-previews/permission-log-controller": "3.0.1-preview-e7f13cec",
  "@metamask-previews/phishing-controller": "12.1.0-preview-e7f13cec",
  "@metamask-previews/polling-controller": "11.0.0-preview-e7f13cec",
  "@metamask-previews/preferences-controller": "13.1.0-preview-e7f13cec",
  "@metamask-previews/profile-sync-controller": "0.9.7-preview-e7f13cec",
  "@metamask-previews/queued-request-controller": "5.1.0-preview-e7f13cec",
  "@metamask-previews/rate-limit-controller": "6.0.1-preview-e7f13cec",
  "@metamask-previews/selected-network-controller": "18.0.2-preview-e7f13cec",
  "@metamask-previews/signature-controller": "20.1.0-preview-e7f13cec",
  "@metamask-previews/transaction-controller": "37.3.0-preview-e7f13cec",
  "@metamask-previews/user-operation-controller": "16.0.0-preview-e7f13cec"
}

@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 4, 2024

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions. 
{
  "@metamask-previews/accounts-controller": "18.2.3-preview-ec72890e",
  "@metamask-previews/address-book-controller": "6.0.1-preview-ec72890e",
  "@metamask-previews/announcement-controller": "7.0.1-preview-ec72890e",
  "@metamask-previews/approval-controller": "7.1.1-preview-ec72890e",
  "@metamask-previews/assets-controllers": "42.0.0-preview-ec72890e",
  "@metamask-previews/base-controller": "7.0.2-preview-ec72890e",
  "@metamask-previews/build-utils": "3.0.1-preview-ec72890e",
  "@metamask-previews/chain-controller": "0.1.3-preview-ec72890e",
  "@metamask-previews/composable-controller": "9.0.1-preview-ec72890e",
  "@metamask-previews/controller-utils": "11.4.2-preview-ec72890e",
  "@metamask-previews/ens-controller": "15.0.0-preview-ec72890e",
  "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-ec72890e",
  "@metamask-previews/gas-fee-controller": "22.0.0-preview-ec72890e",
  "@metamask-previews/json-rpc-engine": "10.0.1-preview-ec72890e",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-ec72890e",
  "@metamask-previews/keyring-controller": "17.3.1-preview-ec72890e",
  "@metamask-previews/logging-controller": "6.0.1-preview-ec72890e",
  "@metamask-previews/message-manager": "11.0.1-preview-ec72890e",
  "@metamask-previews/multichain": "0.0.0-preview-ec72890e",
  "@metamask-previews/name-controller": "8.0.1-preview-ec72890e",
  "@metamask-previews/network-controller": "22.0.1-preview-ec72890e",
  "@metamask-previews/notification-controller": "7.0.0-preview-ec72890e",
  "@metamask-previews/notification-services-controller": "0.12.1-preview-ec72890e",
  "@metamask-previews/permission-controller": "11.0.3-preview-ec72890e",
  "@metamask-previews/permission-log-controller": "3.0.1-preview-ec72890e",
  "@metamask-previews/phishing-controller": "12.3.0-preview-ec72890e",
  "@metamask-previews/polling-controller": "12.0.1-preview-ec72890e",
  "@metamask-previews/preferences-controller": "13.2.0-preview-ec72890e",
  "@metamask-previews/profile-sync-controller": "0.9.7-preview-ec72890e",
  "@metamask-previews/queued-request-controller": "7.0.0-preview-ec72890e",
  "@metamask-previews/rate-limit-controller": "6.0.1-preview-ec72890e",
  "@metamask-previews/selected-network-controller": "19.0.0-preview-ec72890e",
  "@metamask-previews/signature-controller": "21.0.0-preview-ec72890e",
  "@metamask-previews/transaction-controller": "38.2.0-preview-ec72890e",
  "@metamask-previews/user-operation-controller": "17.0.0-preview-ec72890e"
}

@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions. 
{
  "@metamask-previews/accounts-controller": "18.2.3-preview-c10c8117",
  "@metamask-previews/address-book-controller": "6.0.1-preview-c10c8117",
  "@metamask-previews/announcement-controller": "7.0.1-preview-c10c8117",
  "@metamask-previews/approval-controller": "7.1.1-preview-c10c8117",
  "@metamask-previews/assets-controllers": "42.0.0-preview-c10c8117",
  "@metamask-previews/base-controller": "7.0.2-preview-c10c8117",
  "@metamask-previews/build-utils": "3.0.1-preview-c10c8117",
  "@metamask-previews/chain-controller": "0.1.3-preview-c10c8117",
  "@metamask-previews/composable-controller": "9.0.1-preview-c10c8117",
  "@metamask-previews/controller-utils": "11.4.2-preview-c10c8117",
  "@metamask-previews/ens-controller": "15.0.0-preview-c10c8117",
  "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-c10c8117",
  "@metamask-previews/gas-fee-controller": "22.0.0-preview-c10c8117",
  "@metamask-previews/json-rpc-engine": "10.0.1-preview-c10c8117",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-c10c8117",
  "@metamask-previews/keyring-controller": "17.3.1-preview-c10c8117",
  "@metamask-previews/logging-controller": "6.0.1-preview-c10c8117",
  "@metamask-previews/message-manager": "11.0.1-preview-c10c8117",
  "@metamask-previews/multichain": "0.0.0-preview-c10c8117",
  "@metamask-previews/name-controller": "8.0.1-preview-c10c8117",
  "@metamask-previews/network-controller": "22.0.1-preview-c10c8117",
  "@metamask-previews/notification-controller": "7.0.0-preview-c10c8117",
  "@metamask-previews/notification-services-controller": "0.12.1-preview-c10c8117",
  "@metamask-previews/permission-controller": "11.0.3-preview-c10c8117",
  "@metamask-previews/permission-log-controller": "3.0.1-preview-c10c8117",
  "@metamask-previews/phishing-controller": "12.3.0-preview-c10c8117",
  "@metamask-previews/polling-controller": "12.0.1-preview-c10c8117",
  "@metamask-previews/preferences-controller": "13.2.0-preview-c10c8117",
  "@metamask-previews/profile-sync-controller": "0.9.8-preview-c10c8117",
  "@metamask-previews/queued-request-controller": "7.0.1-preview-c10c8117",
  "@metamask-previews/rate-limit-controller": "6.0.1-preview-c10c8117",
  "@metamask-previews/selected-network-controller": "19.0.0-preview-c10c8117",
  "@metamask-previews/signature-controller": "21.0.0-preview-c10c8117",
  "@metamask-previews/transaction-controller": "38.3.0-preview-c10c8117",
  "@metamask-previews/user-operation-controller": "17.0.0-preview-c10c8117"
}

@Prithpal-Sooriya
feat: add NetworkController actions and events
de3b7f8 
actions and events for adding, updating, and removing a network configuration
@Prithpal-Sooriya
test: add tests to cover calls through the controller messenger
8844d55
@Prithpal-Sooriya
feat: add lastUpdatedAt for NetworkConfiguration
ef02bdf 
this allows tracking of when the network configuration was updated, which is used to enable accurate network syncing
@Prithpal-Sooriya
test: update test assertions that require lastUpdateAt property
69acd6f
@Prithpal-Sooriya
feat: use original networkClientId if provided when adding a network
aa490e8 
this is to support network syncing, where we add a new network to a synced device
@Prithpal-Sooriya
feat: add dangerouslySetNetworkConfiguration method to override netwo…
84301ae 
…rkConfiguration

this is used for network syncing to override local state with the remove state.
@Prithpal-Sooriya
refactor: make dangerouslySetNetworkConfiguration a private method
f5649fe 
This is now only accessible through the messaging systems
@Prithpal-Sooriya
feat: add main network sync controller integration
ccb17d2 
I need to add some integration tests to be a bit more confident in outcome
@Prithpal-Sooriya
feat: add main network sync controller integration
a933a55 
I need to add some integration tests to be a bit more confident in outcome
@Prithpal-Sooriya
feat: add network sync callbacks
d291144 
mostly to be used for analytics
@Prithpal-Sooriya
test: add controller-integration - performMainSync() tests
7d48db3
@Prithpal-Sooriya
test: add test coverage
08c76ec
@Prithpal-Sooriya
fix: fix syncing issues from manual integration testing
dfa83b8
@Prithpal-Sooriya
test: fix controller integration tests
c2531fb
@Prithpal-Sooriya
test: fix failing batch update network tests
d99306f
@Prithpal-Sooriya
refactor: reuse user storage messengers and mocks
f8237c4
@Prithpal-Sooriya
test: add test coverage for services and controller-integration
b54490a
@Prithpal-Sooriya
test: add controller syncNetwork tests
8cf7bea 
the main logic for syncing was done in another file
@Prithpal-Sooriya
feat: add hasNetworkSyncingSyncedAtLeastOnce check
49d7468 
ensures that mutation syncs only occur after we've at least synced once. It covers potential edge cases we've need when onboarding + account syncing
@Prithpal-Sooriya
refactor: use logging library instead of console
75fce4a
@Prithpal-Sooriya
feat: add max size bounds for networks to add
f774423 
this prevents users from adding thousands of networks, which could cause issues for the application
@Prithpal-Sooriya
fix: fix type issue
0b2a267
@Prithpal-Sooriya Prithpal-Sooriya force-pushed the temp/network-syncing-all-changes branch from c10c811 to 0b2a267 Compare November 21, 2024 14:58
@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

1 similar comment
@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions. 
{
  "@metamask-previews/accounts-controller": "20.0.0-preview-50bb1e2c",
  "@metamask-previews/address-book-controller": "6.0.1-preview-50bb1e2c",
  "@metamask-previews/announcement-controller": "7.0.1-preview-50bb1e2c",
  "@metamask-previews/approval-controller": "7.1.1-preview-50bb1e2c",
  "@metamask-previews/assets-controllers": "45.1.0-preview-50bb1e2c",
  "@metamask-previews/base-controller": "7.0.2-preview-50bb1e2c",
  "@metamask-previews/build-utils": "3.0.1-preview-50bb1e2c",
  "@metamask-previews/chain-controller": "0.2.0-preview-50bb1e2c",
  "@metamask-previews/composable-controller": "9.0.1-preview-50bb1e2c",
  "@metamask-previews/controller-utils": "11.4.3-preview-50bb1e2c",
  "@metamask-previews/ens-controller": "15.0.0-preview-50bb1e2c",
  "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-50bb1e2c",
  "@metamask-previews/gas-fee-controller": "22.0.1-preview-50bb1e2c",
  "@metamask-previews/json-rpc-engine": "10.0.1-preview-50bb1e2c",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-50bb1e2c",
  "@metamask-previews/keyring-controller": "19.0.0-preview-50bb1e2c",
  "@metamask-previews/logging-controller": "6.0.2-preview-50bb1e2c",
  "@metamask-previews/message-manager": "11.0.1-preview-50bb1e2c",
  "@metamask-previews/multichain": "1.0.0-preview-50bb1e2c",
  "@metamask-previews/name-controller": "8.0.1-preview-50bb1e2c",
  "@metamask-previews/network-controller": "22.0.2-preview-50bb1e2c",
  "@metamask-previews/notification-controller": "7.0.0-preview-50bb1e2c",
  "@metamask-previews/notification-services-controller": "0.14.0-preview-50bb1e2c",
  "@metamask-previews/permission-controller": "11.0.3-preview-50bb1e2c",
  "@metamask-previews/permission-log-controller": "3.0.1-preview-50bb1e2c",
  "@metamask-previews/phishing-controller": "12.3.0-preview-50bb1e2c",
  "@metamask-previews/polling-controller": "12.0.1-preview-50bb1e2c",
  "@metamask-previews/preferences-controller": "15.0.0-preview-50bb1e2c",
  "@metamask-previews/profile-sync-controller": "2.0.0-preview-50bb1e2c",
  "@metamask-previews/queued-request-controller": "7.0.1-preview-50bb1e2c",
  "@metamask-previews/rate-limit-controller": "6.0.1-preview-50bb1e2c",
  "@metamask-previews/selected-network-controller": "19.0.0-preview-50bb1e2c",
  "@metamask-previews/signature-controller": "23.0.0-preview-50bb1e2c",
  "@metamask-previews/transaction-controller": "40.1.0-preview-50bb1e2c",
  "@metamask-previews/user-operation-controller": "19.0.0-preview-50bb1e2c"
}

@Prithpal-Sooriya Prithpal-Sooriya force-pushed the temp/network-syncing-all-changes branch 5 times, most recently from 239f977 to e0ac0ec Compare November 26, 2024 19:11
@Prithpal-Sooriya Prithpal-Sooriya force-pushed the temp/network-syncing-all-changes branch from e0ac0ec to d1104b6 Compare November 26, 2024 19:16
@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions. 
{
  "@metamask-previews/accounts-controller": "20.0.0-preview-d1104b69",
  "@metamask-previews/address-book-controller": "6.0.1-preview-d1104b69",
  "@metamask-previews/announcement-controller": "7.0.1-preview-d1104b69",
  "@metamask-previews/approval-controller": "7.1.1-preview-d1104b69",
  "@metamask-previews/assets-controllers": "45.1.0-preview-d1104b69",
  "@metamask-previews/base-controller": "7.0.2-preview-d1104b69",
  "@metamask-previews/build-utils": "3.0.1-preview-d1104b69",
  "@metamask-previews/chain-controller": "0.2.0-preview-d1104b69",
  "@metamask-previews/composable-controller": "9.0.1-preview-d1104b69",
  "@metamask-previews/controller-utils": "11.4.3-preview-d1104b69",
  "@metamask-previews/ens-controller": "15.0.0-preview-d1104b69",
  "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-d1104b69",
  "@metamask-previews/gas-fee-controller": "22.0.1-preview-d1104b69",
  "@metamask-previews/json-rpc-engine": "10.0.1-preview-d1104b69",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-d1104b69",
  "@metamask-previews/keyring-controller": "19.0.0-preview-d1104b69",
  "@metamask-previews/logging-controller": "6.0.2-preview-d1104b69",
  "@metamask-previews/message-manager": "11.0.1-preview-d1104b69",
  "@metamask-previews/multichain": "1.0.0-preview-d1104b69",
  "@metamask-previews/name-controller": "8.0.1-preview-d1104b69",
  "@metamask-previews/network-controller": "22.0.2-preview-d1104b69",
  "@metamask-previews/notification-controller": "7.0.0-preview-d1104b69",
  "@metamask-previews/notification-services-controller": "0.14.0-preview-d1104b69",
  "@metamask-previews/permission-controller": "11.0.3-preview-d1104b69",
  "@metamask-previews/permission-log-controller": "3.0.1-preview-d1104b69",
  "@metamask-previews/phishing-controller": "12.3.0-preview-d1104b69",
  "@metamask-previews/polling-controller": "12.0.1-preview-d1104b69",
  "@metamask-previews/preferences-controller": "15.0.0-preview-d1104b69",
  "@metamask-previews/profile-sync-controller": "2.0.0-preview-d1104b69",
  "@metamask-previews/queued-request-controller": "7.0.1-preview-d1104b69",
  "@metamask-previews/rate-limit-controller": "6.0.1-preview-d1104b69",
  "@metamask-previews/selected-network-controller": "19.0.0-preview-d1104b69",
  "@metamask-previews/signature-controller": "23.0.0-preview-d1104b69",
  "@metamask-previews/transaction-controller": "40.1.0-preview-d1104b69",
  "@metamask-previews/user-operation-controller": "19.0.0-preview-d1104b69"
}

@Prithpal-Sooriya
Copy link
Contributor Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions. 
{
  "@metamask-previews/accounts-controller": "20.0.0-preview-5544fdb2",
  "@metamask-previews/address-book-controller": "6.0.1-preview-5544fdb2",
  "@metamask-previews/announcement-controller": "7.0.1-preview-5544fdb2",
  "@metamask-previews/approval-controller": "7.1.1-preview-5544fdb2",
  "@metamask-previews/assets-controllers": "45.1.0-preview-5544fdb2",
  "@metamask-previews/base-controller": "7.0.2-preview-5544fdb2",
  "@metamask-previews/build-utils": "3.0.1-preview-5544fdb2",
  "@metamask-previews/chain-controller": "0.2.0-preview-5544fdb2",
  "@metamask-previews/composable-controller": "9.0.1-preview-5544fdb2",
  "@metamask-previews/controller-utils": "11.4.3-preview-5544fdb2",
  "@metamask-previews/ens-controller": "15.0.0-preview-5544fdb2",
  "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-5544fdb2",
  "@metamask-previews/gas-fee-controller": "22.0.1-preview-5544fdb2",
  "@metamask-previews/json-rpc-engine": "10.0.1-preview-5544fdb2",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-5544fdb2",
  "@metamask-previews/keyring-controller": "19.0.0-preview-5544fdb2",
  "@metamask-previews/logging-controller": "6.0.2-preview-5544fdb2",
  "@metamask-previews/message-manager": "11.0.1-preview-5544fdb2",
  "@metamask-previews/multichain": "1.0.0-preview-5544fdb2",
  "@metamask-previews/name-controller": "8.0.1-preview-5544fdb2",
  "@metamask-previews/network-controller": "22.0.2-preview-5544fdb2",
  "@metamask-previews/notification-controller": "7.0.0-preview-5544fdb2",
  "@metamask-previews/notification-services-controller": "0.14.0-preview-5544fdb2",
  "@metamask-previews/permission-controller": "11.0.3-preview-5544fdb2",
  "@metamask-previews/permission-log-controller": "3.0.1-preview-5544fdb2",
  "@metamask-previews/phishing-controller": "12.3.0-preview-5544fdb2",
  "@metamask-previews/polling-controller": "12.0.1-preview-5544fdb2",
  "@metamask-previews/preferences-controller": "15.0.0-preview-5544fdb2",
  "@metamask-previews/profile-sync-controller": "2.0.0-preview-5544fdb2",
  "@metamask-previews/queued-request-controller": "7.0.1-preview-5544fdb2",
  "@metamask-previews/rate-limit-controller": "6.0.1-preview-5544fdb2",
  "@metamask-previews/selected-network-controller": "19.0.0-preview-5544fdb2",
  "@metamask-previews/signature-controller": "23.0.0-preview-5544fdb2",
  "@metamask-previews/transaction-controller": "40.1.0-preview-5544fdb2",
  "@metamask-previews/user-operation-controller": "19.0.0-preview-5544fdb2"
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
DO-NOT-MERGE team-notifications Notification Team changes. https://github.com/orgs/MetaMask/teams/notifications
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Prithpal-Sooriya