feat!: Use `StorageService` to store source code #3777

GuillaumeRx · 2025-12-16T11:34:06Z

This PR adds the use of StorageService to store the Snap source codes.

Changes

SnapController:
- Remove sourceCode from controller's state
- Move sourceCode to StorageService
- Add utils functions to set/remove and clear the controller's storage in StorageService
- Add a new controllerSetup promise that resolves when the controller has finished initialization
- Make init() async and handle the pre-installed snaps setup inside
SnapController tests and test utils:
- Default the PermissionController:hasPermission to false in order to avoid trying to call lifecycle hooks and throwing an error when calling init. This is due to the fact that PermissionController:hasPermission would return true but PermissionController:getPermissions would not return the correct handler endowment.
- Refactor getSnapController to an asynchronous function that calls init() and wait for it to finish. That makes sure we don't have any race conditions or side effects when instantiating a controller in the tests.
- Initialize the StorageService inside getSnapController() to hydrate the storage service with the relevant snap source code
- Make getSnapControllerOptions() take the rootMessenger in its parameter to allow the creation of the StorageService. That means that in the tests we now retrieve the SnapController's messenger from getSnapControllerOptions()

Note

Adds the new dependency @metamask/storage-service to @metamask/snaps-controllers package.json.

^{Written by Cursor Bugbot for commit fbd6ae9. This will update automatically on new commits. Configure here.}

socket-security · 2025-12-16T11:34:49Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@metamask/storage-service@0.0.1

View full report

packages/snaps-controllers/src/snaps/SnapController.ts

codecov · 2026-01-19T13:29:34Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.39%. Comparing base (0278899) to head (fbd6ae9).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3777   +/-   ##
=======================================
  Coverage   98.39%   98.39%           
=======================================
  Files         430      430           
  Lines       12454    12476   +22     
  Branches     1935     1936    +1     
=======================================
+ Hits        12254    12276   +22     
  Misses        200      200

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

packages/snaps-controllers/src/snaps/SnapController.ts

packages/snaps-controllers/src/test-utils/controller.tsx

packages/snaps-controllers/src/snaps/SnapController.test.tsx

packages/snaps-utils/src/snaps.ts

Mrtenz · 2026-01-21T09:19:46Z

packages/snaps-controllers/package.json

    "@metamask/snaps-rpc-methods": "workspace:^",
    "@metamask/snaps-sdk": "workspace:^",
    "@metamask/snaps-utils": "workspace:^",
+    "@metamask/storage-service": "^0.0.1",


This should really be >=1.0.0 before we use this in production 😵

I know but I was never released as 1.0.0 😅

If Andre considers it stable, we could ask for a bump to v1

packages/snaps-controllers/src/snaps/SnapController.ts

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

packages/snaps-controllers/src/snaps/SnapController.ts

packages/snaps-utils/src/snaps.ts

FrederikBolding · 2026-01-23T11:51:19Z

packages/snaps-utils/src/snaps.ts

+
 export type PersistedSnap = Snap;

+export type StoredSnap = Snap & StorageServiceSnapData;


Suggested change

export type StoredSnap = Snap & StorageServiceSnapData;

export type StoredSnap = PersistedSnap & StorageServiceSnapData;

Nit

lol: #3777 (comment)

fight with @Mrtenz 😂

I meant that we can remove the StoredSnap type 😅

Suggested change

export type StoredSnap = Snap & StorageServiceSnapData;

export type PersistedSnap = Snap & StorageServiceSnapData;

Well, not entirely since that is used for typing out the persisted state of the controller itself

Having both PersistedSnap and StoredSnap seems confusing in my opinion, since they mean very similar things.

Yeah, I don't disagree. But unsure what to propose

Would it be really a problem ? I looked at the usage of PersistedSnap and it's not used anywhere outside of SnapController 🤔

FrederikBolding · 2026-01-23T11:52:28Z

packages/snaps-controllers/src/test-utils/controller.tsx

      return getSnapObject({ id: snapId as SnapId });
    });
-
-    messenger.registerActionHandler(


I don't follow why we are changing the default mocks for permissions 🤔

We're changing this to avoid throwing a lot of errors due to the fact that now, because we init the controller in the tests, we call callLifecycleHooks. In this path we call hasPermission and getPermissions, if hasPermission returns true but getPermissions doesn't return the correct handler permissions we throw an error and that was happening for each test.

That makes a lot of sense. Can we document that in the PR description?

FrederikBolding · 2026-01-23T11:52:45Z

packages/snaps-controllers/src/test-utils/controller.tsx

-  messenger.registerActionHandler('PermissionController:hasPermission', () => {
-    return true;
-  });
+  messenger.registerActionHandler(


https://github.com/MetaMask/snaps/pull/3777/files#r2720900517

packages/snaps-controllers/src/test-utils/controller.tsx

FrederikBolding · 2026-01-23T11:57:21Z

packages/snaps-controllers/src/snaps/SnapController.test.tsx

    fetchMock.mockImplementation(async () => {
      throw new AssertionError({ message: 'Unmocked access to internet.' });
    });
+
+    // Hydrate the storage service with the default snap data.
+    await hydrateStorageService();


Shouldn't this be dependent on the test? Not all tests need the default Snap to be in the storage service

#3777 (comment)

FrederikBolding · 2026-01-23T11:57:59Z

packages/snaps-controllers/src/snaps/SnapController.test.tsx

@@ -10216,7 +10381,12 @@ describe('SnapController', () => {
        origin: 'bar.io',
      });

-      const snapController = getSnapController(
+      await hydrateStorageService({


I don't fully understand when we need to do this and when we don't. Could getSnapController handle this instead? 🤔

we hydrate the defaults in beforeEach so if the test only uses the default values there's no need to call hydrateStorageService. However if the test uses different values in the snaps state we need to set the corresponding source codes in the StorageService

Couldn't each call to getSnapController set it up instead? So we avoid the beforeEach

…apController

FrederikBolding · 2026-01-27T14:03:12Z

packages/snaps-controllers/src/test-utils/controller.tsx

-    rootMessenger: ReturnType<typeof getControllerMessenger>;
-  };
+export const getStorageService = (
+  messenger: ReturnType<typeof getControllerMessenger>,


Is it possible to pass in the initial state for the service or storage so that we can delete hydrateStorageService?

Unfortunately no there's no way to pass in an initial storage

I guess if we want to bump to 1.0.0 anyway we could consider adding that?

At least to the in-memory adapter

for sure 😎

Mrtenz reviewed Dec 16, 2025

View reviewed changes

packages/snaps-controllers/src/snaps/SnapController.ts Outdated Show resolved Hide resolved

FrederikBolding reviewed Dec 16, 2025

View reviewed changes

packages/snaps-controllers/src/snaps/SnapController.ts Outdated Show resolved Hide resolved

GuillaumeRx force-pushed the gr/storage-service branch from 57095fe to 6a20e47 Compare December 18, 2025 10:37

GuillaumeRx force-pushed the gr/storage-service branch from 202b635 to 801cc12 Compare January 6, 2026 11:10

GuillaumeRx force-pushed the gr/storage-service branch from 655f32e to 85b792f Compare January 19, 2026 13:22

GuillaumeRx force-pushed the gr/storage-service branch from 85b792f to e3515be Compare January 21, 2026 09:05

Mrtenz requested changes Jan 21, 2026

View reviewed changes

GuillaumeRx requested a review from Mrtenz January 21, 2026 10:38

GuillaumeRx marked this pull request as ready for review January 21, 2026 11:16

GuillaumeRx requested a review from a team as a code owner January 21, 2026 11:16

GuillaumeRx force-pushed the gr/storage-service branch from b5235de to 31b6881 Compare January 21, 2026 11:16

This comment was marked as outdated.

Sign in to view

FrederikBolding reviewed Jan 21, 2026

View reviewed changes

packages/snaps-controllers/src/snaps/SnapController.ts Show resolved Hide resolved

FrederikBolding reviewed Jan 21, 2026

View reviewed changes

packages/snaps-controllers/src/snaps/SnapController.ts Show resolved Hide resolved

FrederikBolding reviewed Jan 21, 2026

View reviewed changes

packages/snaps-controllers/src/snaps/SnapController.ts Outdated Show resolved Hide resolved

FrederikBolding reviewed Jan 21, 2026

View reviewed changes

packages/snaps-controllers/src/snaps/SnapController.ts Show resolved Hide resolved

GuillaumeRx requested a review from FrederikBolding January 22, 2026 10:14

This comment was marked as outdated.

Sign in to view

cursor bot reviewed Jan 22, 2026

View reviewed changes

packages/snaps-controllers/src/snaps/SnapController.ts Outdated Show resolved Hide resolved

packages/snaps-controllers/src/snaps/SnapController.ts Show resolved Hide resolved

GuillaumeRx force-pushed the gr/storage-service branch from df10375 to 197f300 Compare January 22, 2026 13:55

FrederikBolding reviewed Jan 23, 2026

View reviewed changes

packages/snaps-controllers/src/snaps/SnapController.ts Outdated Show resolved Hide resolved

FrederikBolding reviewed Jan 23, 2026

View reviewed changes

packages/snaps-utils/src/snaps.ts Show resolved Hide resolved

FrederikBolding reviewed Jan 23, 2026

View reviewed changes

packages/snaps-controllers/src/test-utils/controller.tsx Outdated Show resolved Hide resolved

FrederikBolding reviewed Jan 23, 2026

View reviewed changes

GuillaumeRx added 16 commits January 27, 2026 14:14

Add StorageService and handle preinstalled snap setup in init

3b2c912

WIP

088bbc3

WIP

bda553e

rework is ready

1000179

fix SnapController tests

8cbd1dc

fix yarn.lock

1091dc9

fix simulation test

c5489c7

fix interface controller test

8b0ef8c

address requested changes

81d49eb

address more changes

da2862e

fix tests

04dd33b

make init async

5ac5175

save state patches before any async op that could fail

6805f68

fix test

0fde015

refactor test utils to init storage and hydrate it when we get the Sn…

3b56c4a

…apController

add missing files

fbd6ae9

GuillaumeRx force-pushed the gr/storage-service branch from d320826 to fbd6ae9 Compare January 27, 2026 13:17

FrederikBolding reviewed Jan 27, 2026

View reviewed changes


		export type PersistedSnap = Snap;

		export type StoredSnap = Snap & StorageServiceSnapData;

	export type StoredSnap = Snap & StorageServiceSnapData;
	export type StoredSnap = PersistedSnap & StorageServiceSnapData;

	export type StoredSnap = Snap & StorageServiceSnapData;
	export type PersistedSnap = Snap & StorageServiceSnapData;

feat!: Use StorageService to store source code #3777

Are you sure you want to change the base?

feat!: Use StorageService to store source code #3777

Conversation

GuillaumeRx commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

socket-security bot commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mrtenz Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

feat!: Use `StorageService` to store source code #3777

feat!: Use `StorageService` to store source code #3777

GuillaumeRx commented Dec 16, 2025 •

edited

Loading

socket-security bot commented Dec 16, 2025 •

edited

Loading

codecov bot commented Jan 19, 2026 •

edited

Loading

Mrtenz Jan 23, 2026 •

edited

Loading