Skip to content

BREAKING: Remove :snapAdded event #2073

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
merged 1 commit into from
Jan 8, 2024
Merged

BREAKING: Remove :snapAdded event #2073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
59 changes: 15 additions & 44 deletions packages/snaps-controllers/src/snaps/SnapController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,26 +543,16 @@ describe('SnapController', () => {

jest.spyOn(messenger, 'publish');

const eventSubscriptionPromise = Promise.all([
new Promise<void>((resolve) => {
messenger.subscribe('SnapController:snapAdded', (snap) => {
expect(snap).toStrictEqual(
getSnapObject({ status: SnapStatus.Installing }),
);
const eventSubscriptionPromise = new Promise<void>((resolve) => {
messenger.subscribe(
'SnapController:snapInstalled',
(truncatedSnap, origin) => {
expect(truncatedSnap).toStrictEqual(getTruncatedSnap());
expect(origin).toStrictEqual(MOCK_ORIGIN);
resolve();
});
}),
new Promise<void>((resolve) => {
messenger.subscribe(
'SnapController:snapInstalled',
(truncatedSnap, origin) => {
expect(truncatedSnap).toStrictEqual(getTruncatedSnap());
expect(origin).toStrictEqual(MOCK_ORIGIN);
resolve();
},
);
}),
]);
},
);
});

const expectedSnapObject = getTruncatedSnap();
const permissions = {
Expand Down Expand Up @@ -973,22 +963,12 @@ describe('SnapController', () => {
throw new Error('foo');
});

const eventSubscriptionPromise = Promise.all([
new Promise<void>((resolve) => {
messenger.subscribe('SnapController:snapAdded', (snap) => {
expect(snap).toStrictEqual(
getSnapObject({ status: SnapStatus.Installing }),
);
resolve();
});
}),
new Promise<void>((resolve) => {
messenger.subscribe('SnapController:snapRemoved', (truncatedSnap) => {
expect(truncatedSnap).toStrictEqual(getTruncatedSnap());
resolve();
});
}),
]);
const eventSubscriptionPromise = new Promise<void>((resolve) => {
messenger.subscribe('SnapController:snapRemoved', (truncatedSnap) => {
expect(truncatedSnap).toStrictEqual(getTruncatedSnap());
resolve();
});
});

await expect(
snapController.installSnaps(MOCK_ORIGIN, {
Expand Down Expand Up @@ -4407,12 +4387,10 @@ describe('SnapController', () => {
}),
);
const onSnapUpdated = jest.fn();
const onSnapAdded = jest.fn();

const snap = controller.getExpect(MOCK_SNAP_ID);

messenger.subscribe('SnapController:snapUpdated', onSnapUpdated);
messenger.subscribe('SnapController:snapAdded', onSnapAdded);

const newSnap = controller.get(MOCK_SNAP_ID);

Expand All @@ -4429,7 +4407,6 @@ describe('SnapController', () => {
);
expect(newSnap?.version).toStrictEqual(snap.version);
expect(onSnapUpdated).not.toHaveBeenCalled();
expect(onSnapAdded).not.toHaveBeenCalled();

controller.destroy();
});
Expand Down Expand Up @@ -4487,12 +4464,10 @@ describe('SnapController', () => {
}),
);
const onSnapUpdated = jest.fn();
const onSnapAdded = jest.fn();

const snap = controller.getExpect(MOCK_SNAP_ID);

messenger.subscribe('SnapController:snapUpdated', onSnapUpdated);
messenger.subscribe('SnapController:snapAdded', onSnapAdded);

const newSnap = controller.get(MOCK_SNAP_ID);

Expand All @@ -4510,7 +4485,6 @@ describe('SnapController', () => {
);
expect(newSnap?.version).toStrictEqual(snap.version);
expect(onSnapUpdated).not.toHaveBeenCalled();
expect(onSnapAdded).not.toHaveBeenCalled();

controller.destroy();
});
Expand Down Expand Up @@ -4539,13 +4513,11 @@ describe('SnapController', () => {
);
const callActionSpy = jest.spyOn(messenger, 'call');
const onSnapUpdated = jest.fn();
const onSnapAdded = jest.fn();

await controller.installSnaps(MOCK_ORIGIN, { [MOCK_SNAP_ID]: {} });
await controller.stopSnap(MOCK_SNAP_ID);

messenger.subscribe('SnapController:snapUpdated', onSnapUpdated);
messenger.subscribe('SnapController:snapAdded', onSnapAdded);

const result = await controller.updateSnap(
MOCK_ORIGIN,
Expand Down Expand Up @@ -4659,7 +4631,6 @@ describe('SnapController', () => {
'1.0.0',
MOCK_ORIGIN,
);
expect(onSnapAdded).toHaveBeenCalledTimes(1);

controller.destroy();
});
Expand Down
20 changes: 1 addition & 19 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 @@ -387,14 +387,6 @@ export type SnapStateChange = {
payload: [SnapControllerState, Patch[]];
};

/**
* Emitted when a Snap has been added to state during installation.
*/
export type SnapAdded = {
type: `${typeof controllerName}:snapAdded`;
payload: [snap: Snap, svgIcon: string | undefined];
};

/**
* Emitted when an installed snap has been blocked.
*/
Expand Down Expand Up @@ -480,7 +472,6 @@ export type SnapDisabled = {
};

export type SnapControllerEvents =
| SnapAdded
| SnapBlocked
| SnapInstalled
| SnapUninstalled
Expand Down Expand Up @@ -2347,21 +2338,12 @@ export class SnapController extends BaseController<
}
}

const stringifiedIcon = svgIcon?.toString();

// TODO: Consider removing this as it is unused now
this.messagingSystem.publish(
`SnapController:snapAdded`,
snap,
stringifiedIcon,
);

this.messagingSystem.call('SubjectMetadataController:addSubjectMetadata', {
subjectType: SubjectType.Snap,
name: proposedName,
origin: snap.id,
version,
svgIcon: stringifiedIcon ?? null,
svgIcon: svgIcon?.toString() ?? null,
});

return { ...snap, sourceCode };
Expand Down