Skip to content

refactor!: Update SnapInsightsController to use SnapController:getRunnableSnaps #3915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mrtenz merged 3 commits into from
Mar 24, 2026
Merged

refactor!: Update SnapInsightsController to use SnapController:getRunnableSnaps #3915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d952f0
Update `SnapInsightsController` to use `SnapController:getRunnableSnaps`
Mrtenz Mar 24, 2026
333d9a0
Update changelog
Mrtenz Mar 24, 2026
6678cea
Update exports
Mrtenz Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/snaps-controllers/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- **BREAKING:**: Rename `MultichainRouter` to `MultichainRoutingService` and update action types accordingly ([#3913](https://github.com/MetaMask/snaps/pull/3913))
- This is consistent with the naming of other services.
- **BREAKING:** `MultichainRoutingService` now requires `SnapController:getRunnableSnaps` instead of `SnapController:getAllSnaps` ([#3913](https://github.com/MetaMask/snaps/pull/3913))
- **BREAKING:** `SnapInsightsController` now requires `SnapController:getRunnableSnaps` instead of `SnapController:getAllSnaps` ([#3915](https://github.com/MetaMask/snaps/pull/3915))

### Removed

Expand Down
72 changes: 54 additions & 18 deletions packages/snaps-controllers/src/insights/SnapInsightsController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,15 @@ describe('SnapInsightsController', () => {
},
);

rootMessenger.registerActionHandler('SnapController:getAllSnaps', () => {
return [getTruncatedSnap(), getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID })];
});
rootMessenger.registerActionHandler(
'SnapController:getRunnableSnaps',
() => {
return [
getTruncatedSnap(),
getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID }),
];
},
);

rootMessenger.registerActionHandler(
'SnapController:handleRequest',
Expand Down Expand Up @@ -157,9 +163,15 @@ describe('SnapInsightsController', () => {
},
);

rootMessenger.registerActionHandler('SnapController:getAllSnaps', () => {
return [getTruncatedSnap(), getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID })];
});
rootMessenger.registerActionHandler(
'SnapController:getRunnableSnaps',
() => {
return [
getTruncatedSnap(),
getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID }),
];
},
);

rootMessenger.registerActionHandler(
'SnapController:handleRequest',
Expand Down Expand Up @@ -285,9 +297,15 @@ describe('SnapInsightsController', () => {
messenger: controllerMessenger,
});

rootMessenger.registerActionHandler('SnapController:getAllSnaps', () => {
return [getTruncatedSnap(), getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID })];
});
rootMessenger.registerActionHandler(
'SnapController:getRunnableSnaps',
() => {
return [
getTruncatedSnap(),
getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID }),
];
},
);

rootMessenger.registerActionHandler(
'SnapController:handleRequest',
Expand Down Expand Up @@ -388,9 +406,15 @@ describe('SnapInsightsController', () => {
messenger: controllerMessenger,
});

rootMessenger.registerActionHandler('SnapController:getAllSnaps', () => {
return [getTruncatedSnap(), getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID })];
});
rootMessenger.registerActionHandler(
'SnapController:getRunnableSnaps',
() => {
return [
getTruncatedSnap(),
getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID }),
];
},
);

rootMessenger.registerActionHandler(
'SnapController:handleRequest',
Expand Down Expand Up @@ -456,9 +480,15 @@ describe('SnapInsightsController', () => {
it('ignores insight if transaction has already been signed', async () => {
const rootMessenger = getRootSnapInsightsControllerMessenger();

rootMessenger.registerActionHandler('SnapController:getAllSnaps', () => {
return [getTruncatedSnap(), getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID })];
});
rootMessenger.registerActionHandler(
'SnapController:getRunnableSnaps',
() => {
return [
getTruncatedSnap(),
getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID }),
];
},
);

const { resolve, promise } = createDeferredPromise();

Expand Down Expand Up @@ -556,9 +586,15 @@ describe('SnapInsightsController', () => {
messenger: controllerMessenger,
});

rootMessenger.registerActionHandler('SnapController:getAllSnaps', () => {
return [getTruncatedSnap(), getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID })];
});
rootMessenger.registerActionHandler(
'SnapController:getRunnableSnaps',
() => {
return [
getTruncatedSnap(),
getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID }),
];
},
);

const { resolve, promise } = createDeferredPromise();

Expand Down
16 changes: 8 additions & 8 deletions packages/snaps-controllers/src/insights/SnapInsightsController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,13 @@ import { hasProperty, hexToBigInt } from '@metamask/utils';

import type { SnapInterfaceControllerDeleteInterfaceAction } from '../interface';
import type {
SnapControllerGetAllSnapsAction,
SnapControllerGetRunnableSnapsAction,
SnapControllerHandleRequestAction,
} from '../snaps';
import { getRunnableSnaps } from '../snaps';
import type {
TransactionControllerUnapprovedTransactionAddedEvent,
TransactionMeta,
SignatureStateChange,
SignatureControllerStateChangeEvent,
SignatureControllerState,
StateSignature,
TransactionControllerTransactionStatusUpdatedEvent,
Expand All @@ -36,9 +35,9 @@ import type {
const controllerName = 'SnapInsightsController';

export type SnapInsightsControllerAllowedActions =
| SnapControllerHandleRequestAction
| SnapControllerGetAllSnapsAction
| GetPermissions
| SnapControllerGetRunnableSnapsAction
| SnapControllerHandleRequestAction
| SnapInterfaceControllerDeleteInterfaceAction;

export type SnapInsightsControllerGetStateAction = ControllerGetStateAction<
Expand All @@ -59,7 +58,7 @@ export type SnapInsightControllerEvents = SnapInsightControllerStateChangeEvent;
export type SnapInsightsControllerAllowedEvents =
| TransactionControllerUnapprovedTransactionAddedEvent
| TransactionControllerTransactionStatusUpdatedEvent
| SignatureStateChange;
| SignatureControllerStateChangeEvent;

export type SnapInsightsControllerMessenger = Messenger<
typeof controllerName,
Expand Down Expand Up @@ -146,8 +145,9 @@ export class SnapInsightsController extends BaseController<
* @returns A list of objects containing Snap IDs and the permission object.
*/
#getSnapsWithPermission(permissionName: string) {
const allSnaps = this.messenger.call('SnapController:getAllSnaps');
const filteredSnaps = getRunnableSnaps(allSnaps);
const filteredSnaps = this.messenger.call(
'SnapController:getRunnableSnaps',
);

return filteredSnaps.reduce<SnapWithPermission[]>((accumulator, snap) => {
const permissions = this.messenger.call(
Expand Down
7 changes: 6 additions & 1 deletion packages/snaps-controllers/src/insights/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
export * from './SnapInsightsController';
export type {
SnapInsight,
Copy link
Member

@FrederikBolding FrederikBolding Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this type used anywhere?

Copy link
Member Author

@Mrtenz Mrtenz Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part of state, so makes sense to me to export it.

SnapInsightsControllerMessenger,
SnapInsightsControllerState,
} from './SnapInsightsController';
export { SnapInsightsController } from './SnapInsightsController';
2 changes: 1 addition & 1 deletion packages/snaps-controllers/src/test-utils/controller.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,7 +953,7 @@ export const getRestrictedSnapInsightsControllerMessenger = (
messenger.delegate({
actions: [
'PermissionController:getPermissions',
'SnapController:getAllSnaps',
'SnapController:getRunnableSnaps',
'SnapController:handleRequest',
'SnapInterfaceController:deleteInterface',
],
Expand Down
2 changes: 1 addition & 1 deletion packages/snaps-controllers/src/types/controllers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ export type SignatureControllerState = {
unapprovedTypedMessagesCount: number;
};

export type SignatureStateChange = ControllerStateChangeEvent<
export type SignatureControllerStateChangeEvent = ControllerStateChangeEvent<
'SignatureController',
SignatureControllerState
>;
Loading