refactor!: Standardise `SnapController` action/event names and types by Mrtenz · Pull Request #3907 · MetaMask/snaps

Mrtenz · 2026-03-20T11:43:07Z

This renames all SnapController action and event names and types to follow the Controller...Action pattern used in most other controllers. I've also added the generate-method-actions script used in MetaMask/core to automatically generate these types.

I found numerous unrelated type errors in test files that I fixed in this pull request as well, since it was a bit difficult to determine if a type error was caused by this refactor or not, in some cases.

Breaking changes

All SnapController action types were renamed from DoSomething to SnapControllerDoSomethingAction.
- GetSnap is now SnapControllerGetSnapAction.
  - Note: The method is now called getSnap instead of get.
- HandleSnapRequest is now SnapControllerHandleRequestAction.
- GetSnapState is now SnapControllerGetSnapStateAction.
- HasSnap is now SnapControllerHasSnapAction.
  - Note: The method is now called hasSnap instead of has.
- UpdateSnapState is now SnapControllerUpdateSnapStateAction.
- ClearSnapState is now SnapControllerClearSnapStateAction.
- UpdateRegistry is now SnapControllerUpdateRegistryAction.
- EnableSnap is now SnapControllerEnableSnapAction.
  - Note: The method is now called enableSnap instead of enable.
- DisableSnap is now SnapControllerDisableSnapAction.
  - Note: The method is now called disableSnap instead of disable.
- RemoveSnap is now SnapControllerRemoveSnapAction.
  - Note: The method is now called removeSnap instead of remove.
- GetPermittedSnaps is now SnapControllerGetPermittedSnapsAction.
  - Note: The method is now called getPermittedSnaps instead of getPermitted.
- GetAllSnaps is now SnapControllerGetAllSnapsAction.
  - Note: The method is now called getAllSnaps instead of getAll.
- GetRunnableSnaps is now SnapControllerGetRunnableSnapsAction.
- StopAllSnaps is now SnapControllerStopAllSnapsAction.
- IncrementActiveReferences is now SnapControllerIncrementActiveReferencesAction.
- DecrementActiveReferences is now SnapControllerDecrementActiveReferencesAction.
- InstallSnaps is now SnapControllerInstallSnapsAction.
  - Note: The method is now called installSnaps instead of install.
- DisconnectOrigin is now SnapControllerRemoveSnapFromSubjectAction.
- RevokeDynamicPermissions is now SnapControllerRevokeDynamicSnapPermissionsAction.
- GetSnapFile is now SnapControllerGetSnapFileAction.
- IsMinimumPlatformVersion is now SnapControllerIsMinimumPlatformVersionAction.
- SetClientActive is now SnapControllerSetClientActiveAction.
All SnapController event types were renamed from OnSomething to SnapControllerOnSomethingEvent.
- SnapStateChange was removed in favour of SnapControllerStateChangeEvent.
- SnapBlocked is now SnapControllerSnapBlockedEvent.
- SnapInstallStarted is now SnapControllerSnapInstallStartedEvent.
- SnapInstallFailed is now SnapControllerSnapInstallFailedEvent.
- SnapInstalled is now SnapControllerSnapInstalledEvent.
- SnapUninstalled is now SnapControllerSnapUninstalledEvent.
- SnapUnblocked is now `SnapControllerSnapUnblockedEvent.
- SnapUpdated is now SnapControllerSnapUpdatedEvent.
- SnapRolledback is now SnapControllerSnapRolledbackEvent.
- SnapTerminated is now SnapControllerSnapTerminatedEvent.
- SnapEnabled is now SnapControllerSnapEnabledEvent.
- SnapDisabled is now SnapControllerSnapDisabledEvent.

Note

Medium Risk
Medium risk due to breaking renames of SnapController messenger action/event types and action string IDs (e.g., get→getSnap, getAll→getAllSnaps), which can cause widespread compile/runtime call-site breakage if any consumers aren’t updated.

Overview
BREAKING: Renames SnapController messenger action/event types to the SnapController...Action / SnapController...Event pattern and updates several action IDs/method names (notably SnapController:get→SnapController:getSnap and SnapController:getAll→SnapController:getAllSnaps).

Adds an auto-generated SnapController-method-action-types.ts and introduces a repo/workspace generate-method-action-types script, wiring it into root lint (with --check) and adding yargs as a dev dependency.

Updates affected controllers/tests (CronjobController, SnapInsightsController, SnapInterfaceController, MultichainRouter) to use the new SnapController action types/IDs, plus minor test util renames and removal of now-unnecessary lint-disable comments in execution services.

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

codecov · 2026-03-20T13:06:47Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.55%. Comparing base (17136ba) to head (3b51590).

Additional details and impacted files

@@                  Coverage Diff                  @@
##           controller-refactors    #3907   +/-   ##
=====================================================
  Coverage                 98.55%   98.55%           
=====================================================
  Files                       425      425           
  Lines                     12358    12360    +2     
  Branches                   1935     1935           
=====================================================
+ Hits                      12180    12182    +2     
  Misses                      178      178

☔ 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.

FrederikBolding · 2026-03-20T13:23:48Z

scripts/generate-method-action-types.mts

@@ -0,0 +1,773 @@
+#!yarn tsx


Not ideal to be duplicating this file between repos

Agreed, we can consider extracting it into a publishable package at some point.

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

FrederikBolding · 2026-03-20T13:27:07Z

scripts/generate-method-action-types.mts

@@ -0,0 +1,773 @@
+#!yarn tsx


Can you explain the diff between this version and the one in core? Are we intending to sync back these changes?

The only difference is support for nested directories. The core script assumes all controllers are in the top-level src directory, which is not the case for Snaps controllers. We can sync this with core if we decide to create a package for the script.

Definitely don't want them to diverge.

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

FrederikBolding · 2026-03-20T13:29:51Z

packages/snaps-controllers/src/multichain/MultichainRouter.ts

+    const allSnaps = this.#messenger.call('SnapController:getAllSnaps');
    const filteredSnaps = getRunnableSnaps(allSnaps);


Since we are making a breaking change here we could consider swapping to use SnapController: getRunnableSnaps

Can do it in the follow up PR for MultichainRouter.

FrederikBolding · 2026-03-20T13:33:20Z

packages/snaps-controllers/src/insights/SnapInsightsController.ts

  #getSnapsWithPermission(permissionName: string) {
-    const allSnaps = this.messenger.call('SnapController:getAll');
+    const allSnaps = this.messenger.call('SnapController:getAllSnaps');
    const filteredSnaps = getRunnableSnaps(allSnaps);


Same as MultichainRouter

Same reply 😄

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

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

packages/snaps-controllers/src/snaps/SnapController-method-action-types.ts

FrederikBolding · 2026-03-20T13:41:36Z

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

+export const MESSENGER_EXPOSED_METHODS = [
+  'init',
+  'updateRegistry',
+  'startSnap',


Suggested change

'startSnap',

TBH probably does not need to be publicly accessible

FrederikBolding · 2026-03-20T13:42:29Z

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

+  'incrementActiveReferences',
+  'decrementActiveReferences',


I wonder if we should just remove this 😄

FrederikBolding · 2026-03-20T13:43:46Z

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

+  'getSnapExpect',
+  'getTruncatedSnap',
+  'getTruncatedSnapExpect',


Unsure if these need to be publicly accessible

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

FrederikBolding · 2026-03-20T13:52:47Z

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


  messenger.delegate({
    actions: [
-      'PermissionController:hasPermission',


Was this not used?

Apparently not 😅

FrederikBolding · 2026-03-20T13:58:42Z

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

    const originalTerminateFunction = service.terminateJob.bind(service);

-    let promise: Promise<unknown>;
+    let promise: Promise<unknown> = Promise.resolve();


Without this, TypeScript complains about promise not being assigned.

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

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

Mrtenz added 5 commits March 20, 2026 12:23

Standardise SnapController action names and types

74aa200

Fix Yargs version

4a12998

Replace ts default import with named imports

2b7e41c

Revert some changes

67aab04

Fix reference to SnapController:get

3dd5333

Mrtenz marked this pull request as ready for review March 20, 2026 13:07

Mrtenz requested a review from a team as a code owner March 20, 2026 13:07

FrederikBolding reviewed Mar 20, 2026

View reviewed changes

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

FrederikBolding reviewed Mar 20, 2026

View reviewed changes

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

FrederikBolding reviewed Mar 20, 2026

View reviewed changes

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

Remove comment

0c3fddd

FrederikBolding reviewed Mar 20, 2026

View reviewed changes

Mrtenz added 2 commits March 20, 2026 14:31

Add changelog entry

2f7e862

Remove extra whitespace

56d9bed

FrederikBolding reviewed Mar 20, 2026

View reviewed changes

Mrtenz changed the base branch from main to controller-refactors March 20, 2026 13:33

cursor bot reviewed Mar 20, 2026

View reviewed changes

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

Remove destroy action

95f516b

cursor bot reviewed Mar 20, 2026

View reviewed changes

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

FrederikBolding reviewed Mar 20, 2026

View reviewed changes

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

Fix invokeSnap

ca2f5c9

FrederikBolding reviewed Mar 20, 2026

View reviewed changes

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

FrederikBolding reviewed Mar 20, 2026

View reviewed changes

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

FrederikBolding reviewed Mar 20, 2026

View reviewed changes

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

Mrtenz added 2 commits March 20, 2026 15:12

Remove some exports

bfc276d

Rename removeSnapFromSubject to disconnectOrigin

3b51590

		const allSnaps = this.#messenger.call('SnapController:getAllSnaps');
		const filteredSnaps = getRunnableSnaps(allSnaps);

Conversation

Mrtenz commented Mar 20, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking changes

Uh oh!

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

Uh oh!

Codecov Report

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!

Choose a reason for hiding this comment

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!

Uh oh!

cursor bot left a comment

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Mrtenz commented Mar 20, 2026 •

edited by cursor bot

Loading

codecov bot commented Mar 20, 2026 •

edited

Loading