Migrate to new controller packages #5270

mcmire · 2022-11-18T00:32:01Z

Development & PR Process

Follow MetaMask Mobile Coding Standards
Add release-xx label to identify the PR slated for a upcoming release (will be used in release discussion)
Add needs-dev-review label when work is completed
Add needs-qa label when dev review is completed
Add QA Passed label when QA has signed off

Description

@metamask/controllers is deprecated, and most of the controllers that lived here are now located in their own package. This commit replaces @metamask/controllers in package.json with references to these packages and updates import lines to match.

Issue

Progresses [Epic] Convert to monorepo core#322
Companion PR on extension: Migrate to new controller packages metamask-extension#16547

Testing notes

This is a behind-the-scenes change, and there should be no changes to existing functionality — everything should work as it does currently. I'm not sure what the best protocol to test these sorts of changes is (maybe run through the most common scenarios?)

Custom registry setup (skip these steps, these were only relevant before we published these packages)

Note that before this PR gets merged, preview versions of the new packages, which live on GitHub Packages, will be used. Without specially configuring NPM, these packages will not be accessible locally, and therefore you will not be able to run yarn setup. To get this working:

Go into the token settings for your GitHub account and, if you have not already done so, create a classic personal access token. Make sure to store your token somewhere apart from GitHub as you won't be able to see it there.
Back in extension, create a file .npmrc in the root directory with the following content (note: this file is gitignored, so don't worry about it ending up in the repo):
```
@metamask:registry=https://npm.pkg.github.com

//npm.pkg.github.com/:_authToken=<insert your personal access token here>
```

Now you should be able to run yarn setup, then load the app as you normally would.

Checklist

There is a related GitHub issue
Tests are included if applicable
Any added code is fully documented

github-actions · 2022-11-18T00:32:14Z

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.

mcmire · 2022-11-18T00:32:41Z

I have read the CLA Document and I hereby sign the CLA

.gitignore

mcmire · 2022-11-18T00:35:30Z

Marking as DONOTMERGE as we need to release 1.0.0 versions of the new packages, but before we can do that we need to ensure that extension also works with these changes. Open for review though, do your worst :)

Gudahtt · 2022-11-18T15:46:27Z

I have added the token as PACKAGE_READ_TOKEN. I will look at updated CI to use it next

mcmire · 2022-11-18T18:45:26Z

I'm going to keep this PR in draft mode so that if we need to make updates we can continue to access the preview versions of the aforementioned packages via the GitHub Package Registry, but feel free to leave your comments on this PR.

package.json

.github/workflows/ci.yml

app/components/UI/NetworkInfo/index.tsx

`@metamask/controllers` is deprecated, and most of the controllers that lived here are now located in their own package ([1]). This commit replaces `@metamask/controllers` in `package.json` with references to these packages and updates `import` lines to match. [1]: MetaMask/core#831

CI now supports fetching packages from the GitHub Packages registry on draft PRs. This is meant to support the use of "preview" builds of controller packages, to more easily test controller changes before they are released.

Co-authored-by: Mark Stacey <[email protected]>

gantunesr

LGTM. The changes are straightforward 👍

…ller-packages * origin/main: [IMPROVEMENT] Remove deeplink warning for SDK and SDK as dependency (#5449) On-Ramp: Settings and Activation Keys (#5455) [FIX] Screenshot deterrent analytics (#5468) On-ramp: Remove unused constants (#5462) On-ramp: Refactor Regions view to componentization (#5413) Approval error when insufficient balance (#5440) remove extra zero balance account potentially created from seeking ahead (#5459) [IMPROVEMENT] Refactor Analytics Events (#5454)

chrisleewilcox

Pass automation. LGTM.

mcmire added the DO-NOT-MERGE Pull requests that should not be merged label Nov 18, 2022

mcmire commented Nov 18, 2022

View reviewed changes

.gitignore Show resolved Hide resolved

mcmire commented Nov 18, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

mcmire added needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) release-5.12.0 Issue or pull request that will be included in release 5.12.0 labels Nov 18, 2022

Gudahtt reviewed Nov 21, 2022

View reviewed changes

.github/workflows/ci.yml Outdated Show resolved Hide resolved

Gudahtt force-pushed the migrate-to-new-controller-packages branch from d874a30 to a53a1e4 Compare November 22, 2022 16:16

This comment was marked as resolved.

Sign in to view

Gudahtt force-pushed the migrate-to-new-controller-packages branch from f565e97 to 39f804e Compare November 23, 2022 13:38

This comment was marked as resolved.

Sign in to view

sethkfman added release-5.13.0 Issue or pull request that will be included in release 5.13.0 and removed release-5.12.0 Issue or pull request that will be included in release 5.12.0 labels Nov 29, 2022

Gudahtt force-pushed the migrate-to-new-controller-packages branch from 39f804e to bb172c3 Compare December 8, 2022 22:52

Base automatically changed from update/network-contoller to main December 14, 2022 01:28

Gudahtt force-pushed the migrate-to-new-controller-packages branch from bb172c3 to faa0eee Compare December 14, 2022 01:39

Gudahtt reviewed Dec 14, 2022

View reviewed changes

app/components/UI/NetworkInfo/index.tsx Outdated Show resolved Hide resolved

Gudahtt removed the DO-NOT-MERGE Pull requests that should not be merged label Dec 14, 2022

Gudahtt force-pushed the migrate-to-new-controller-packages branch 3 times, most recently from 668be34 to e1675d1 Compare December 21, 2022 01:13

Gudahtt marked this pull request as ready for review December 21, 2022 12:40

Gudahtt requested a review from a team as a code owner December 21, 2022 12:40

Gudahtt force-pushed the migrate-to-new-controller-packages branch from e1675d1 to 4cb3033 Compare December 21, 2022 21:19

sethkfman added release-5.14.0 Issue or pull request that will be included in release 5.14.0 and removed release-5.13.0 Issue or pull request that will be included in release 5.13.0 labels Dec 22, 2022

mcmire and others added 9 commits January 5, 2023 17:09

Setup CI to download from GitHub Packages registry (#5274)

b8cd06d

CI now supports fetching packages from the GitHub Packages registry on draft PRs. This is meant to support the use of "preview" builds of controller packages, to more easily test controller changes before they are released.

Bump controller packages

e3ad578

Fix shellcheck violation

11e5f39

Co-authored-by: Mark Stacey <[email protected]>

Update controller packages to v1.0.0

e98c268

Migrate keyring controller patch to new package

f85290a

Update packages

a689405

Import function from internal module

6421669

Fix lint error

1e59d83

Gudahtt force-pushed the migrate-to-new-controller-packages branch from 4cb3033 to 1e59d83 Compare January 5, 2023 20:46

gantunesr approved these changes Jan 10, 2023

View reviewed changes

gantunesr removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Jan 10, 2023

Gudahtt added the needs-qa Any New Features that needs a full manual QA prior to being added to a release. label Jan 10, 2023

chrisleewilcox approved these changes Jan 10, 2023

View reviewed changes

Gudahtt merged commit 5b62796 into main Jan 10, 2023

Gudahtt deleted the migrate-to-new-controller-packages branch January 10, 2023 18:34

github-actions bot locked and limited conversation to collaborators Jan 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate to new controller packages #5270

Migrate to new controller packages #5270

mcmire commented Nov 18, 2022 •

edited by Gudahtt

Loading

github-actions bot commented Nov 18, 2022 •

edited

Loading

mcmire commented Nov 18, 2022

mcmire commented Nov 18, 2022 •

edited

Loading

Gudahtt commented Nov 18, 2022

mcmire commented Nov 18, 2022

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

gantunesr left a comment

chrisleewilcox left a comment

Migrate to new controller packages #5270

Migrate to new controller packages #5270

Conversation

mcmire commented Nov 18, 2022 • edited by Gudahtt Loading

github-actions bot commented Nov 18, 2022 • edited Loading

mcmire commented Nov 18, 2022

mcmire commented Nov 18, 2022 • edited Loading

Gudahtt commented Nov 18, 2022

mcmire commented Nov 18, 2022

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

gantunesr left a comment

Choose a reason for hiding this comment

chrisleewilcox left a comment

Choose a reason for hiding this comment

mcmire commented Nov 18, 2022 •

edited by Gudahtt

Loading

github-actions bot commented Nov 18, 2022 •

edited

Loading

mcmire commented Nov 18, 2022 •

edited

Loading