feat: snaps controllers integration (Flask Only) #7942

owencraston · 2023-11-29T03:04:48Z

Description

This pr enables snaps to be installed and executed on mobile. This change will be code fenced for flask only. We achieve this by doing the following..

integrating the @metamask/snaps-controllers
integrating @metamask/snaps-rpc-methods
adding handlers for the snaps rpc methods into the BackgroundBridge.js file
implementing the InstallSnapApproval flow
create a custom detectSnapLocation function
implementing a custom fetch function that we pass to the snaps controller
For npm hosted snaps, we will fetch them using the custom NPMLocation class. This classic fetches (using the custom fetch function mentioned above), downloads the compressed snap code and then decompresses and reads the snap code using the RNTar native module that was implemented/merged in this PR.

All of these changes have been implemented and tested in this PR. This PR updates that logic and brings it into main behind a code fence.

Guide for reviewers

All modified code should be wrapped inside a code fence ///: BEGIN:ONLY_INCLUDE_IF(snaps)...///: END:ONLY_INCLUDE_IF
all new files should be wrapped in a code fence ///: BEGIN:ONLY_INCLUDE_IF(snaps)...///: END:ONLY_INCLUDE_IF
The most important files for to review are...
1. Engine.ts
2. BackgroundBridge.js
3. useApprovalRequest.ts
4. EngineService.ts
5. npm.ts
6. location.ts
7. fetch.ts

Related issues

Progresses: https://github.com/MetaMask/accounts-planning/issues/143

Manual testing steps

checkout this branch
run yarn setup
open the .js.env
modify the METAMASK_BUILD_TYPE to export METAMASK_BUILD_TYPE="flask"
in your terminal run source .js.env and then run yarn watch:clean
in xcode select the flask variant and press play
open http://metamask.github.io/snaps/test-snaps/1.1.0 in the browser

create a wallet
navigate to the browser
open this url: https://metamask.github.io/snaps/test-snaps/1.1.0/
install a snap, I usually install the bip32/bip44 snap
the install flow should appear with 3 steps including the a success screen
click the Get Public key button on the snap site, you should get a result
navigate to settings/snaps
you should see a list of all your installed snaps

Checking code fencing

reset your .js.env file so that the METAMASK_BUILD_TYPE is set to main
restart your watchman server and refresh the app
the snaps section in the settings list should no longer exist
installing a snap should fail.

Screenshots/Recordings

After

Screen.Recording.2023-12-07.at.11.42.58.PM.mov

Pre-merge author checklist

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

github-actions · 2023-11-29T03:04:59Z

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.

socket-security · 2023-11-29T03:14:11Z

New and updated dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@metamask/snaps-rpc-methods	3.2.1	None	`+18`	12 MB	metamaskbot
@metamask/snaps-utils	3.2.0	filesystem, shell	`+17`	11.5 MB	metamaskbot
@metamask/snaps-controllers	3.2.0	shell	`+32`	14.4 MB	metamaskbot
@metamask/post-message-stream	7.0.0	None	`+0`	75.9 kB	gudahtt
@metamask/slip44	3.1.0	None	`+0`	128 kB	metamaskbot
@types/readable-stream	4.0.9	None	`+0`	31 kB	types
@metamask/key-tree	9.0.0	None	`+1`	655 kB	metamaskbot
@metamask/permission-controller	4.0.1...4.1.2	None	`+0/-0`	402 kB	metamaskbot
@types/react	17.0.14...17.0.59	None	`+0/-0`	169 kB	types

socket-security · 2023-11-29T03:14:14Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: [email protected], @metamask/[email protected], @metamask/[email protected], @metamask/[email protected]

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore [email protected] bar@* or ignore all packages with @SocketSecurity ignore-all

## **Description** This PR adds a custom native module RNTar. This module takes a file system path to a `.tgz` (tar gzip) file. The module reads this file, decompresses it and places it in the target directory. It then returns the new location of the decompressed data. This PR is needed for the mobile snaps implementation and will be used in this following [PR](#7942). - All of the javascript code is code fenced so non of it will appear in the main MetaMask app - the native modules cannot be code fenced so they will be included in the main app. They are never called from the UI so it should not interfere. Most of the native code (java and swift) was implemented and reviewed in previous prs. This change is bringing them into main. - [Original Android PR](#6300) - [Original iOS PR](#5926) ## **Related issues** Progresses: MetaMask/accounts-planning#143 ## **Manual testing steps** - clone this branch - run `yarn setup` - open `js.env` - change `export METAMASK_BUILD_TYPE` to `export METAMASK_BUILD_TYPE="flask"` - run `source .js.env` - run `yarn watch:clean` - run the app in ios or android - navigate to settings/Snaps - click the `Test RNTar` button - it should succeed and log the output directory - if you open the output directory (logged in the console) you should see the package folder with all of the code for the [filesnap](https://github.com/filecoin-project/filsnap) - once you have confirmed that the module is properly decompressed, go back to `.js.env` - change `METAMASK_BUILD_TYPE` back to `main` - run `source .js.env` - reload watchman (`yarn watch:clean`) - navigate back to settings - the `Snaps` section should no longer be present - repeat these steps with the opposite operating system ### Running android unit tests - open this branch in Android studio - open the `RNTarTest.java` - run the test suite - it should pass <img width="1728" alt="Screenshot 2023-11-29 at 11 45 27 PM" src="https://github.com/MetaMask/metamask-mobile/assets/22918444/982b899e-fc9c-46ed-9ffe-84af5e9c3f89"> ## **Screenshots/Recordings** ### **After** https://github.com/MetaMask/metamask-mobile/assets/22918444/2b95b1c1-54d7-4060-8f95-3d8d565b0203 https://github.com/MetaMask/metamask-mobile/assets/22918444/273be30e-c39d-4906-8828-04b8e93ca2af ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've clearly explained what problem this PR is solving and how it is solved. - [x] I've linked related issues - [x] I've included manual testing steps - [x] I've included screenshots/recordings if applicable - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. - [x] I’ve properly set the pull request status: - [x] In case it's not yet "ready for review", I've set it to "draft". - [ ] In case it's "ready for review", I've changed it from "draft" to "non-draft". ## **Pre-merge reviewer checklist** - [x] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [x] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

app/core/Snaps/WebviewExecutionService.ts

app/core/Snaps/location/npm.ts

app/util/snaps/checkSnapsBlockList.js

app/core/Snaps/location/http.ts

app/core/Engine.ts

app/core/Snaps/SnapsMethodMiddleware.ts

app/components/Views/Snaps/components/SnapPermissions/SnapPermissions.tsx

app/constants/permissions.ts

app/core/Permissions/constants.ts

app/core/RPCMethods/RPCMethodMiddleware.ts

app/core/Engine.ts

github-actions · 2023-12-08T08:32:29Z

E2E test started on Bitrise: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/077d55c7-03bd-4338-bff4-272f5cd151f2
You can also kick off another Bitrise E2E smoke test by removing and re-applying the (Run Smoke E2E) label

github-actions · 2023-12-08T08:32:44Z

E2E test started on Bitrise: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/48b3f443-236a-4d09-ba0d-a398f8029316
You can also kick off another Bitrise E2E smoke test by removing and re-applying the (Run Smoke E2E) label

Jonathansoufer

LGTM! Left some comments.

app/components/UI/SnapsExecutionWebView/styles.ts

app/constants/snaps.ts

app/core/Engine.ts

app/core/Snaps/WebviewExecutionService.ts

github-actions · 2023-12-12T19:57:09Z

E2E test started on Bitrise: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/dcaaa896-5313-4c87-9f6e-bff67a06f05e
You can also kick off another Bitrise E2E smoke test by removing and re-applying the (Run Smoke E2E) label

tommasini

Engine, RpcMethodMiddleware, EngineService, BackgroundBridge and Engine LGTM!

Cool thing that we use code fencing only for snaps and this way we can create easily other feature to include on the diferent featureSet!
Awesome work going on 🚀

we have decided to iteratively ship improvements to this implementation after it merges.

owencraston · 2023-12-12T23:29:52Z

e2e smoke test passed

gantunesr

The overall code looks good to me, there are a lot of improvements to be done but we need to take into consideration that this is the first iteration of the code working and this is a great step into opening the snaps platform in the mobile app to the dev community. Since it is behind code fencing I don't have any reason to not merge it as it is and start working on smaller refactors that can be shipped faster and stop dedicating time into constant rebases.

The comments I left in the PR are suggestion I'd like to see done but I don't mind it being addressed in a follow up PR.

To do in a follow up PR:

Address pending comments
Add unit tests to all files in core/Snaps
The Engine is getting too big, this code would be a good candidate to break it down to another file

Great work @owencraston 🎉 🚢

app/core/Snaps/location/npm.ts

patches/@metamask+post-message-stream+7.0.0.patch

app/core/Snaps/location/fetch.ts

app/core/Snaps/WebviewPostMessageStream.ts

app/core/Snaps/WebviewExecutionService.ts

app/core/Snaps/SnapWebviewPostMessageStream.ts

app/components/Approvals/InstallSnapApproval/InstallSnapApproval.tsx

app/components/Views/Snaps/SnapsSettingsList/SnapsSettingsList.tsx

app/components/Views/Snaps/components/SnapPermissions/SnapPermissions.tsx

app/core/Snaps/SnapBridge.ts

Jonathansoufer

Excellent work putting all this together @owencraston ! Minor comments of mine, but approved since they can be addressed in a follow up PR.

sonarcloud · 2023-12-13T02:04:59Z

Quality Gate failed

Failed conditions

4.9% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

owencraston · 2023-12-13T02:05:16Z

e2e regression test passed

github-actions · 2023-12-13T02:07:17Z

E2E test started on Bitrise: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/908dbf9e-632e-4d36-8059-ecbd4f3212bc
You can also kick off another Bitrise E2E smoke test by removing and re-applying the (Run Smoke E2E) label

owencraston mentioned this pull request Nov 30, 2023

feat: RNTar native modules (Android and iOS) #7955

Merged

13 tasks

owencraston force-pushed the feat/snaps-controllers-integration branch 2 times, most recently from b20703d to 111f7dd Compare November 30, 2023 23:31

owencraston changed the base branch from main to rntar-native-modules November 30, 2023 23:32

owencraston changed the title ~~Feat/snaps controllers integration~~ Feat: snaps controllers integration (Flask Only) Dec 1, 2023

owencraston force-pushed the rntar-native-modules branch from 6f9ddff to 204c565 Compare December 1, 2023 04:02

Base automatically changed from rntar-native-modules to main December 1, 2023 05:15

owencraston force-pushed the feat/snaps-controllers-integration branch 2 times, most recently from e2b8774 to 8e46e4a Compare December 5, 2023 00:27

FrederikBolding previously requested changes Dec 6, 2023

View reviewed changes

owencraston force-pushed the feat/snaps-controllers-integration branch 2 times, most recently from a6499c5 to eb97784 Compare December 7, 2023 03:01

owencraston added the team-accounts label Dec 7, 2023

FrederikBolding reviewed Dec 7, 2023

View reviewed changes

app/core/Engine.ts Outdated Show resolved Hide resolved

owencraston requested a review from FrederikBolding December 7, 2023 18:32

owencraston force-pushed the feat/snaps-controllers-integration branch from fd75952 to d354a18 Compare December 7, 2023 20:48

owencraston changed the title ~~Feat: snaps controllers integration (Flask Only)~~ feat: snaps controllers integration (Flask Only) Dec 8, 2023

owencraston requested review from andrepimenta, gantunesr and Jonathansoufer December 8, 2023 08:30

owencraston added the Run Smoke E2E label Dec 8, 2023

owencraston marked this pull request as ready for review December 8, 2023 08:31

owencraston requested a review from a team as a code owner December 8, 2023 08:31

Jonathansoufer previously approved these changes Dec 8, 2023

View reviewed changes

owencraston added 2 commits December 12, 2023 10:30

yarn dedupe

1bedcde

disable default export in fenced file

ad1fa63

owencraston force-pushed the feat/snaps-controllers-integration branch from c2726a0 to ad1fa63 Compare December 12, 2023 19:53

owencraston added Run Smoke E2E and removed Run Smoke E2E labels Dec 12, 2023

tommasini reviewed Dec 12, 2023

View reviewed changes

gantunesr previously approved these changes Dec 12, 2023

View reviewed changes

Jonathansoufer reviewed Dec 12, 2023

View reviewed changes

app/components/Approvals/InstallSnapApproval/InstallSnapApproval.tsx Outdated Show resolved Hide resolved

Jonathansoufer reviewed Dec 13, 2023

View reviewed changes

app/components/Views/Snaps/SnapsSettingsList/SnapsSettingsList.tsx Outdated Show resolved Hide resolved

Jonathansoufer reviewed Dec 13, 2023

View reviewed changes

app/components/Views/Snaps/components/SnapPermissions/SnapPermissions.tsx Show resolved Hide resolved

Jonathansoufer reviewed Dec 13, 2023

View reviewed changes

app/core/Snaps/SnapBridge.ts Show resolved Hide resolved

Jonathansoufer previously approved these changes Dec 13, 2023

View reviewed changes

Address most of Gutos comments

f3903d1

owencraston dismissed stale reviews from Jonathansoufer and gantunesr via f3903d1 December 13, 2023 01:13

owencraston added 2 commits December 12, 2023 17:37

migrate to map in WebviewExecutionService

cf01a73

remove debug code and better approval types

3a52b57

owencraston added Run Smoke E2E and removed Run Smoke E2E labels Dec 13, 2023

gantunesr approved these changes Dec 13, 2023

View reviewed changes

sethkfman merged commit d7869a6 into main Dec 13, 2023
28 of 29 checks passed

sethkfman deleted the feat/snaps-controllers-integration branch December 13, 2023 02:31

github-actions bot locked and limited conversation to collaborators Dec 13, 2023

metamaskbot added the release-7.15.0 Issue or pull request that will be included in release 7.15.0 label Dec 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: snaps controllers integration (Flask Only) #7942

feat: snaps controllers integration (Flask Only) #7942

owencraston commented Nov 29, 2023 •

edited

Loading

github-actions bot commented Nov 29, 2023

socket-security bot commented Nov 29, 2023 •

edited

Loading

socket-security bot commented Nov 29, 2023 •

edited

Loading

github-actions bot commented Dec 8, 2023

github-actions bot commented Dec 8, 2023

Jonathansoufer left a comment

github-actions bot commented Dec 12, 2023

tommasini left a comment

owencraston commented Dec 12, 2023

gantunesr left a comment •

edited

Loading

Jonathansoufer left a comment

sonarcloud bot commented Dec 13, 2023

owencraston commented Dec 13, 2023

github-actions bot commented Dec 13, 2023

feat: snaps controllers integration (Flask Only) #7942

feat: snaps controllers integration (Flask Only) #7942

Conversation

owencraston commented Nov 29, 2023 • edited Loading

Description

Guide for reviewers

Related issues

Manual testing steps

Checking code fencing

Screenshots/Recordings

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Nov 29, 2023

socket-security bot commented Nov 29, 2023 • edited Loading

socket-security bot commented Nov 29, 2023 • edited Loading

Next steps

github-actions bot commented Dec 8, 2023

github-actions bot commented Dec 8, 2023

Jonathansoufer left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 12, 2023

tommasini left a comment

Choose a reason for hiding this comment

owencraston commented Dec 12, 2023

gantunesr left a comment • edited Loading

Choose a reason for hiding this comment

Jonathansoufer left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Dec 13, 2023

Quality Gate failed

owencraston commented Dec 13, 2023

github-actions bot commented Dec 13, 2023

owencraston commented Nov 29, 2023 •

edited

Loading

socket-security bot commented Nov 29, 2023 •

edited

Loading

socket-security bot commented Nov 29, 2023 •

edited

Loading

gantunesr left a comment •

edited

Loading