Skip to content

fix: Properly roll back initialConnections #3618

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
FrederikBolding merged 3 commits into from
Sep 1, 2025
Merged

fix: Properly roll back initialConnections #3618

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
5c384e6
fix: Properly roll back initialConnections
FrederikBolding Aug 28, 2025
1302545
Add comment
FrederikBolding Aug 28, 2025
ce4e5ff
Add test
FrederikBolding Aug 29, 2025
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
84 changes: 81 additions & 3 deletions packages/snaps-controllers/src/snaps/SnapController.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8092,7 +8092,17 @@ describe('SnapController', () => {
})
).manifest.result;

const manifest2 = (
const manifest2Old = (
await getMockSnapFilesWithUpdatedChecksum({
manifest: getSnapManifest({
initialConnections: {
[MOCK_ORIGIN]: {},
},
}),
})
).manifest.result;

const manifest2New = (
await getMockSnapFilesWithUpdatedChecksum({
manifest: getSnapManifest({
version: newVersion,
Expand All @@ -8105,7 +8115,9 @@ describe('SnapController', () => {
const detect = jest
.fn()
.mockImplementationOnce(() => new LoopbackLocation())
.mockImplementationOnce(() => new LoopbackLocation())
.mockImplementationOnce(
() => new LoopbackLocation({ manifest: manifest2Old }),
)
.mockImplementationOnce(() => new LoopbackLocation())
.mockImplementationOnce(
() =>
Expand All @@ -8116,7 +8128,7 @@ describe('SnapController', () => {
.mockImplementationOnce(
() =>
new LoopbackLocation({
manifest: manifest2,
manifest: manifest2New,
files: [
new VirtualFile({
value: 'foo',
Expand All @@ -8130,8 +8142,46 @@ describe('SnapController', () => {
}),
);

const rootMessenger = getControllerMessenger();

let revokedConnection = false;

rootMessenger.registerActionHandler(
'PermissionController:revokePermissions',
() => {
revokedConnection = true;
return {};
},
);

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
(origin) => {
if (origin === MOCK_ORIGIN && !revokedConnection) {
return {
[WALLET_SNAP_PERMISSION_KEY]: {
caveats: [
{
type: SnapCaveatType.SnapIds,
value: {
[snapId2]: {},
},
},
],
date: 1664187844588,
id: 'izn0WGUO8cvq_jqvLQuQP',
invoker: MOCK_ORIGIN,
parentCapability: WALLET_SNAP_PERMISSION_KEY,
},
};
}
return MOCK_SNAP_PERMISSIONS;
},
);

const options = getSnapControllerWithEESOptions({
detectSnapLocation: detect,
rootMessenger,
});

const { messenger } = options;
Expand Down Expand Up @@ -8176,6 +8226,34 @@ describe('SnapController', () => {
expect.anything(),
);

expect(messenger.call).toHaveBeenNthCalledWith(
48,
'PermissionController:revokePermissions',
{
[MOCK_ORIGIN]: [WALLET_SNAP_PERMISSION_KEY],
},
);

expect(messenger.call).toHaveBeenNthCalledWith(
59,
'PermissionController:grantPermissions',
{
approvedPermissions: {
[WALLET_SNAP_PERMISSION_KEY]: {
caveats: [
{
type: SnapCaveatType.SnapIds,
value: {
[snapId2]: {},
},
},
],
},
},
subject: { origin: MOCK_ORIGIN },
},
);

controller.destroy();
await service.terminateAllSnaps();
});
Expand Down
34 changes: 26 additions & 8 deletions packages/snaps-controllers/src/snaps/SnapController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ import type {
OnAssetsMarketDataResponse,
AssetMarketData,
AssetMetadata,
EmptyObject,
} from '@metamask/snaps-sdk';
import {
AuxiliaryFileEncoding,
Expand Down Expand Up @@ -333,6 +334,8 @@ type RollbackSnapshot = {
granted?: RequestedPermissions;
requestData?: Record<string, unknown>;
};
previousInitialConnections?: Record<string, EmptyObject> | null;
newInitialConnections?: Record<string, EmptyObject>;
newVersion: string;
};

Expand Down Expand Up @@ -2994,19 +2997,22 @@ export class SnapController extends BaseController<
requestData,
});

if (manifest.initialConnections) {
this.#handleInitialConnections(
snapId,
oldManifest.initialConnections ?? null,
manifest.initialConnections,
);
}
const previousInitialConnections = oldManifest.initialConnections ?? null;
const newInitialConnections = manifest.initialConnections ?? {};
this.#handleInitialConnections(
snapId,
previousInitialConnections,
newInitialConnections,
);

const rollbackSnapshot = this.#getRollbackSnapshot(snapId);
if (rollbackSnapshot !== undefined) {
rollbackSnapshot.permissions.revoked = unusedPermissions;
rollbackSnapshot.permissions.granted = approvedNewPermissions;
rollbackSnapshot.permissions.requestData = requestData;
rollbackSnapshot.previousInitialConnections =
previousInitialConnections;
rollbackSnapshot.newInitialConnections = newInitialConnections;
}

const sourceCode = sourceCodeFile.toString();
Expand Down Expand Up @@ -4139,7 +4145,12 @@ export class SnapController extends BaseController<
this.#transition(snapId, SnapStatusEvents.Stop);
}

const { statePatches, permissions } = rollbackSnapshot;
const {
statePatches,
permissions,
previousInitialConnections,
newInitialConnections,
} = rollbackSnapshot;

if (statePatches?.length) {
this.applyPatches(statePatches);
Expand All @@ -4160,6 +4171,13 @@ export class SnapController extends BaseController<
requestData: permissions.requestData,
});

// Calling this in reverse order to undo the changes
this.#handleInitialConnections(
snapId,
newInitialConnections ?? null,
previousInitialConnections ?? {},
);

const truncatedSnap = this.getTruncatedExpect(snapId);

this.messagingSystem.publish(
Expand Down
Loading