Bump snaps packages and support dynamic interfaces #22828

FrederikBolding · 2024-02-06T14:50:12Z

Description

Bump snaps packages to latest and deals with breaking changes.

Summary of changes in the snaps deps:

BREAKING: Update permission format for name lookup Snaps
Add dynamic interfaces
- Can be created with snap_createInterface and updated with snap_updateInterface
- All existing UI is backwards compatible
Add support for Snap defined timeouts
- A Snap can now define maxRequestTime to extend or shorten its execution timeout
Loosen allowlist requirements
- Snaps with certain permissions can now be installed without being allowlisted
Reintroduced DecompressionStream for improved installation performance
Endowment permission specifications were moved requiring imports to be updated
Bump tar-stream letting us remove a patch

This PR also contains #22795 merged in, which contains the integration for dynamic interfaces.

Related issues

Closes https://github.com/MetaMask/MetaMask-planning/issues/1954

Manual testing steps

Fire up the interactive UI test snap https://metamask.github.io/snaps/test-snaps/latest/
Make sure it works as intended

socket-security · 2024-02-06T14:52:55Z

👍 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: npm/@metamask/post-message-stream@8.0.0, npm/@metamask/snaps-controllers@5.0.1, npm/@metamask/snaps-rpc-methods@6.0.0

View full report↗︎

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 ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

FrederikBolding · 2024-02-06T14:56:52Z

@SocketSecurity ignore npm/@metamask/post-message-stream@8.0.0
@SocketSecurity ignore npm/@metamask/snaps-utils@6.0.0
@SocketSecurity ignore npm/@metamask/snaps-controllers@5.0.0
@SocketSecurity ignore npm/@metamask/snaps-sdk@2.0.0
@SocketSecurity ignore npm/@metamask/snaps-rpc-methods@6.0.0

Trusted authors and these were just published.

app/scripts/lib/SnapsNameProvider.ts

github-actions · 2024-02-14T15:58:38Z

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 · 2024-02-15T09:44:19Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/permission-controller@8.0.0	Transitive: environment, filesystem, network	`+69`	14.8 MB	metamaskbot
npm/@metamask/post-message-stream@8.0.0	Transitive: environment, network	`+18`	4.07 MB	lgbot
npm/@metamask/snaps-controllers@5.0.1	Transitive: environment, filesystem, network, shell, unsafe	`+166`	42.2 MB	brad.decker, danfinlay, gudahtt, ...9 more
npm/@metamask/snaps-rpc-methods@6.0.0	Transitive: environment, filesystem, network, shell, unsafe	`+147`	38.7 MB	metamaskbot
npm/@metamask/snaps-sdk@2.1.0	Transitive: environment, network	`+39`	7.37 MB	brad.decker, danfinlay, gudahtt, ...9 more
npm/@metamask/snaps-utils@6.1.0	filesystem, network, shell Transitive: environment, unsafe	`+146`	37.8 MB	metamaskbot

🚮 Removed packages: npm/@types/ms@0.7.34, npm/cron-parser@4.9.0, npm/rfdc@1.3.1

View full report↗︎

FrederikBolding · 2024-02-19T09:22:41Z

ui/components/app/metamask-translation/metamask-translation.stories.js

With the blessing of @brad-decker, I've deleted this story as it is broken due to circular dependencies.

FrederikBolding · 2024-02-19T11:10:21Z

@SocketSecurity ignore npm/@metamask/snaps-controllers@5.0.1
just published.

metamaskbot · 2024-02-19T11:29:19Z

Builds ready [2405d1f]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5
- common: 0, 1, 2, 3, 4, 5, 6
- content-script: 0
- contentscript: contentscript
- disable-console: disable-console
- policy-load: policy-load
- sentry-install: sentry-install
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1062 ± 64 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	126	270	191	39	19
		domContentLoaded	9	124	41	38	18
		load	905	1365	1062	134	64
		domInteractive	9	124	41	38	18

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 405.31 KiB (11.94%)
ui: 19.67 KiB (0.28%)
common: -398.57 KiB (-7.92%)

codecov · 2024-02-19T11:29:27Z

Codecov Report

Attention: 36 lines in your changes are missing coverage. Please review.

Comparison is base (3687b18) 68.50% compared to head (751bc5b) 68.46%.

❗ Current head 751bc5b differs from pull request most recent head 0767d65. Consider uploading reports for the commit 0767d65 to get more accurate results

Files	Patch %	Lines
app/scripts/metamask-controller.js	47.06%	9 Missing ⚠️
ui/store/actions.ts	0.00%	8 Missing ⚠️
ui/selectors/selectors.js	57.14%	6 Missing ⚠️
ui/ducks/domains.js	0.00%	5 Missing ⚠️
...i/pages/confirmations/confirmation/confirmation.js	50.00%	5 Missing ⚠️
ui/hooks/useTransactionInsights.js	66.67%	2 Missing ⚠️
...ages/confirmations/confirmation/templates/index.js	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #22828      +/-   ##
===========================================
- Coverage    68.50%   68.46%   -0.04%     
===========================================
  Files         1089     1089              
  Lines        43076    43107      +31     
  Branches     11480    11487       +7     
===========================================
+ Hits         29507    29511       +4     
- Misses       13569    13596      +27

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

app/scripts/lib/SnapsNameProvider.ts

package.json

ui/components/app/snaps/snap-insight/snap-insight.js

ui/components/app/snaps/snap-ui-renderer/components/form.ts

ui/components/app/snaps/snap-ui-renderer/components/panel.ts

ui/components/app/snaps/snap-ui-renderer/utils.ts

ui/selectors/selectors.js

Co-authored-by: Hassan Malik <41640681+hmalik88@users.noreply.github.com>

## **Description** This PR integrates the necessary changes for interactive Interfaces. - Setup and update the various controllers. - Update the `SnapUIRenderer` to handle an `interfaceId` rather than direct content. - Add the logic for interface state and event handling in a new `InterfaceContext` react context. - Update the different APIs to handle the newly returned values. - Move the UI components mapping out of the `SnapUIRenderer` file - Rework confirmations to take the `SnapUIRenderer`. ## **Related issues** ## **Manual testing steps** 1. Fire up the interactive UI test snap [coming soon] 2. Play with the snap ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist** - [ ] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [ ] I've clearly explained what problem this PR is solving and how it is solved. - [ ] I've linked related issues - [ ] I've included manual testing steps - [ ] I've included screenshots/recordings if applicable - [ ] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. - [ ] I’ve properly set the pull request status: - [ ] 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** - [ ] 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. --------- Co-authored-by: Frederik Bolding <frederik.bolding@gmail.com>

metamaskbot · 2024-02-22T10:12:51Z

Builds ready [0767d65]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5
- common: 0, 1, 2, 3, 4, 5, 6
- content-script: 0
- contentscript: contentscript
- disable-console: disable-console
- policy-load: policy-load
- sentry-install: sentry-install
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1995 ± 109 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	94	364	187	72	34
		domContentLoaded	10	85	28	19	9
		load	1557	2404	1995	227	109
		domInteractive	10	85	28	19	9

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 405.31 KiB (11.93%)
ui: 19.68 KiB (0.28%)
common: -398.57 KiB (-8.01%)

FrederikBolding added the team-snaps DEPRECATED: Use "team-snaps-platform" or "team-snaps-ecosystem" instead label Feb 6, 2024

metamaskbot added the INVALID-PR-TEMPLATE PR's body doesn't match template label Feb 6, 2024

FrederikBolding changed the title ~~Fb/snaps bump v31~~ Bump snaps packages Feb 6, 2024

hmalik88 reviewed Feb 7, 2024

View reviewed changes

app/scripts/lib/SnapsNameProvider.ts Outdated Show resolved Hide resolved

FrederikBolding force-pushed the fb/snaps-bump-v31 branch from 252d9e7 to 4b2b380 Compare February 14, 2024 09:57

FrederikBolding mentioned this pull request Feb 14, 2024

[Snaps E2E] Update enums.js to newest test-snaps version #22893

Closed

13 tasks

FrederikBolding changed the title ~~Bump snaps packages~~ Bump snaps packages and support dynamic interfaces Feb 14, 2024

FrederikBolding force-pushed the fb/snaps-bump-v31 branch from 9728d45 to 9118389 Compare February 14, 2024 14:58

GuillaumeRx force-pushed the fb/snaps-bump-v31 branch from ccbbe45 to be41c23 Compare February 14, 2024 17:34

FrederikBolding force-pushed the fb/snaps-bump-v31 branch from be41c23 to 086e3a4 Compare February 15, 2024 09:41

FrederikBolding force-pushed the fb/snaps-bump-v31 branch from cb99c32 to f9bfe8f Compare February 16, 2024 14:44

FrederikBolding commented Feb 19, 2024

View reviewed changes

FrederikBolding marked this pull request as ready for review February 19, 2024 09:24

FrederikBolding requested review from a team as code owners February 19, 2024 09:24

Mrtenz reviewed Feb 19, 2024

View reviewed changes

app/scripts/lib/SnapsNameProvider.ts Show resolved Hide resolved

Mrtenz reviewed Feb 19, 2024

View reviewed changes

package.json Show resolved Hide resolved

Mrtenz requested changes Feb 19, 2024

View reviewed changes

ui/components/app/snaps/snap-insight/snap-insight.js Outdated Show resolved Hide resolved

david0xd reviewed Feb 20, 2024

View reviewed changes

ui/components/app/snaps/snap-ui-renderer/components/form.ts Show resolved Hide resolved

david0xd reviewed Feb 20, 2024

View reviewed changes

ui/components/app/snaps/snap-ui-renderer/components/panel.ts Show resolved Hide resolved

david0xd reviewed Feb 20, 2024

View reviewed changes

ui/components/app/snaps/snap-ui-renderer/utils.ts Show resolved Hide resolved

david0xd reviewed Feb 20, 2024

View reviewed changes

ui/selectors/selectors.js Show resolved Hide resolved

FrederikBolding and others added 17 commits February 22, 2024 10:50

Fix tests

6006a66

Use latest snaps-sdk everywhere

d588ed9

Update app/scripts/lib/SnapsNameProvider.ts

6784a72

Co-authored-by: Hassan Malik <41640681+hmalik88@users.noreply.github.com>

Fix import after rebase

cafab3f

fix insights warning UI

0ef0e87

Bump deps again

4fa3d4d

Update yarn.lock

a9b548f

Fix lint

53b4f44

Fix lint and E2E

81e34b1

Fix type issues

b327129

Delete broken story

6f7ac27

Bump snaps-controllers again

4f4de90

add missing deps to various useEffect and fix wrong prop type

2dde336

add missing doc stings to selectors

820872c

fix typo

987fc87

Update ui/selectors/selectors.js

0767d65

FrederikBolding dismissed stale reviews from hmalik88 and david0xd via 0767d65 February 22, 2024 09:50

FrederikBolding force-pushed the fb/snaps-bump-v31 branch from 751bc5b to 0767d65 Compare February 22, 2024 09:50

Mrtenz approved these changes Feb 22, 2024

View reviewed changes

GuillaumeRx approved these changes Feb 22, 2024

View reviewed changes

david0xd approved these changes Feb 22, 2024

View reviewed changes

FrederikBolding merged commit ae291c1 into develop Feb 22, 2024
64 of 66 checks passed

FrederikBolding deleted the fb/snaps-bump-v31 branch February 22, 2024 10:07

github-actions bot locked and limited conversation to collaborators Feb 22, 2024

metamaskbot added the release-11.12.0 Issue or pull request that will be included in release 11.12.0 label Feb 22, 2024

ziedbrini added team-snaps-platform Snaps Platform team and removed team-snaps DEPRECATED: Use "team-snaps-platform" or "team-snaps-ecosystem" instead labels Mar 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump snaps packages and support dynamic interfaces #22828

Bump snaps packages and support dynamic interfaces #22828

FrederikBolding commented Feb 6, 2024 •

edited

socket-security bot commented Feb 6, 2024 •

edited

FrederikBolding commented Feb 6, 2024

github-actions bot commented Feb 14, 2024

socket-security bot commented Feb 15, 2024 •

edited

FrederikBolding Feb 19, 2024

FrederikBolding commented Feb 19, 2024

metamaskbot commented Feb 19, 2024

codecov bot commented Feb 19, 2024 •

edited

metamaskbot commented Feb 22, 2024

Bump snaps packages and support dynamic interfaces #22828

Bump snaps packages and support dynamic interfaces #22828

Conversation

FrederikBolding commented Feb 6, 2024 • edited

Description

Related issues

Manual testing steps

socket-security bot commented Feb 6, 2024 • edited

Next steps

FrederikBolding commented Feb 6, 2024

github-actions bot commented Feb 14, 2024

socket-security bot commented Feb 15, 2024 • edited

FrederikBolding Feb 19, 2024

Choose a reason for hiding this comment

FrederikBolding commented Feb 19, 2024

metamaskbot commented Feb 19, 2024

codecov bot commented Feb 19, 2024 • edited

Codecov Report

metamaskbot commented Feb 22, 2024

FrederikBolding commented Feb 6, 2024 •

edited

socket-security bot commented Feb 6, 2024 •

edited

socket-security bot commented Feb 15, 2024 •

edited

codecov bot commented Feb 19, 2024 •

edited