Feat(MV3): Support Snaps in MV3 #22732
Merged
Conversation
This file contains hidden or 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
brad-decker
commented
Jan 30, 2024
offscreen/scripts/offscreen.ts
Outdated
| @@ -17,3 +18,5 @@ const parentStream = new BrowserRuntimePostMessageStream({ | |||
| parentStream.on('data', (data) => { | |||
| console.log('Offscreen Document received data from service worker', data); | |||
Contributor
Author
There was a problem hiding this comment.
This line should probably be removed in this PR because the stream now receives messages from snaps! However, its helpful to keep right up until we have validated the approach.
brad-decker
commented
Jan 30, 2024
offscreen/scripts/offscreen.ts
Outdated
| @@ -1,4 +1,5 @@ | |||
| import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream'; | |||
| import { ProxySnapExecutor } from '@metamask/snaps-execution-environments/dist/cjs/proxy/ProxySnapExecutor'; | |||
Contributor
Author
There was a problem hiding this comment.
I will need to write a .d.ts file to type this or somehow point the import to the types exported for this class from the package
|
New dependencies detected. Learn more about Socket for GitHub ↗︎
|
|
👍 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. |
app/scripts/metamask-controller.js
Outdated
|
|
||
| const snapExecutionServiceArgs = { | ||
| iframeUrl: new URL(process.env.IFRAME_EXECUTION_ENVIRONMENT_URL), | ||
| [shouldUseOffscreenExecutionService ? 'frameUrl' : 'iframeUrl']: new URL( |
Member
There was a problem hiding this comment.
frameUrl is no longer a constructor argument for OffscreenExecutionService. Instead the URL is hardcoded and tied to the version of the executor package.
Contributor
Author
There was a problem hiding this comment.
@FrederikBolding so i need to just conditionally add the 'iframeUrl' parameter for the IframeExecutionService?
Member
There was a problem hiding this comment.
What you did now looks fine to me! 👍
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #22732 +/- ##
===========================================
+ Coverage 68.60% 68.61% +0.01%
===========================================
Files 1096 1096
Lines 43253 43240 -13
Branches 11525 11531 +6
===========================================
- Hits 29672 29668 -4
+ Misses 13581 13572 -9 ☔ View full report in Codecov by Sentry. |
Collaborator
Builds ready [12db2c4]
Page Load Metrics (843 ± 32 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
Contributor
Author
|
@metamaskbot update-policies |
Collaborator
|
Policies updated |
Collaborator
Builds ready [05993e0]
Page Load Metrics (767 ± 38 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
8 tasks
Collaborator
Builds ready [ac6a733]
Page Load Metrics (713 ± 11 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
FrederikBolding
previously approved these changes
Feb 7, 2024
Contributor
Author
|
@metamaskbot update-policies |
Collaborator
|
Policies updated |
Collaborator
Builds ready [71825f6]
Page Load Metrics (806 ± 47 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
Collaborator
Builds ready [8bde090]
Page Load Metrics (834 ± 27 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
brad-decker
force-pushed
the
feat/snaps-mv3-support
branch
from
8bde090 to
8019c7b
Compare
Contributor
Author
|
@metamaskbot update-policies |
Collaborator
|
Policies updated |
Collaborator
Builds ready [1dd3b5a]
Page Load Metrics (1003 ± 49 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
Contributor
Author
|
@metamaskbot update-policies |
Collaborator
|
Policies updated |
Collaborator
Builds ready [7ac3c86]
Page Load Metrics (947 ± 45 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
Collaborator
Builds ready [da7cf87]
Page Load Metrics (1128 ± 55 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
Collaborator
Builds ready [7ab4230]
Page Load Metrics (1073 ± 48 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
Contributor
Author
|
@SocketSecurity ignore npm/@metamask/post-message-stream@8.0.0 |
FrederikBolding
previously approved these changes
Feb 22, 2024
brad-decker
dismissed stale reviews from FrederikBolding and weizman
via
4cff51e
brad-decker
force-pushed
the
feat/snaps-mv3-support
branch
from
7ab4230 to
4cff51e
Compare
Contributor
Author
|
@metamaskbot update-policies |
Collaborator
|
Policies updated |
Collaborator
Builds ready [a35f8cc]
Page Load Metrics (1781 ± 76 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
brad-decker
force-pushed
the
feat/snaps-mv3-support
branch
from
a35f8cc to
7fb66af
Compare
Contributor
Author
|
@metamaskbot update-policies |
Collaborator
|
Policies updated |
Collaborator
Builds ready [a6004dc]
Page Load Metrics (1215 ± 403 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
FrederikBolding
approved these changes
Feb 27, 2024
DDDDDanica
approved these changes
Feb 27, 2024
danjm
approved these changes
Feb 27, 2024
metamaskbot
added
the
release-11.13.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.
Description
The work done in the proceeding offscreen PRs was done explicitly to hopefully make adopting the snaps executor written for offscreen support without much additional effort. This PR is not complete because it has a type error but sharing the code changes now.
This PR pulls forward the ProxySnapsExecutor from the snaps-execution-environments repository and initializes it with a runtime message stream. This allows the snaps executor to communicate through the offscreen document and enable support for snaps in MV3
Related issues
MetaMask-planning#1998
Manual testing steps
yarnyarn start:mv3Screenshots/Recordings
Before
After
Pre-merge author checklist
Pre-merge reviewer checklist