Skip to content

feat: Add Snap export handler usage tracking #3281

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 2 commits into from
May 5, 2025
Merged

feat: Add Snap export handler usage tracking #3281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cdbd07
Add Snap export handler usage tracking
david0xd Mar 31, 2025
6848f81
Fix coverage after rebase
david0xd May 5, 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
8 changes: 4 additions & 4 deletions packages/snaps-controllers/coverage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"branches": 93.51,
"functions": 98.14,
"lines": 98.48,
"statements": 98.31
"branches": 93.61,
"functions": 98.16,
"lines": 98.5,
"statements": 98.33
}
260 changes: 190 additions & 70 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 @@ -4702,7 +4702,7 @@ describe('SnapController', () => {
},
});

expect(rootMessenger.call).toHaveBeenCalledTimes(4);
expect(rootMessenger.call).toHaveBeenCalledTimes(5);
expect(rootMessenger.call).toHaveBeenCalledWith(
'ExecutionService:handleRpcRequest',
MOCK_SNAP_ID,
Expand Down Expand Up @@ -9214,46 +9214,6 @@ describe('SnapController', () => {
});
});

describe('getRegistryMetadata', () => {
it('returns the metadata for a verified snap', async () => {
const registry = new MockSnapsRegistry();
const rootMessenger = getControllerMessenger(registry);
const messenger = getSnapControllerMessenger(rootMessenger);
registry.getMetadata.mockReturnValue({
name: 'Mock Snap',
});

const snapController = getSnapController(
getSnapControllerOptions({
messenger,
}),
);

expect(
await snapController.getRegistryMetadata(MOCK_SNAP_ID),
).toStrictEqual({
name: 'Mock Snap',
});

snapController.destroy();
});

it('returns null for a non-verified snap', async () => {
const registry = new MockSnapsRegistry();
const rootMessenger = getControllerMessenger(registry);
const messenger = getSnapControllerMessenger(rootMessenger);
const snapController = getSnapController(
getSnapControllerOptions({
messenger,
}),
);

expect(await snapController.getRegistryMetadata(MOCK_SNAP_ID)).toBeNull();

snapController.destroy();
});
});

describe('clearState', () => {
it('clears the state and terminates running snaps', async () => {
const rootMessenger = getControllerMessenger();
Expand Down Expand Up @@ -9416,6 +9376,195 @@ describe('SnapController', () => {

snapController.destroy();
});

it('should track event for allowed handler', async () => {
const mockTrackEvent = jest.fn();
const rootMessenger = getControllerMessenger();
const executionEnvironmentStub = new ExecutionEnvironmentStub(
getNodeEESMessenger(rootMessenger),
) as unknown as NodeThreadExecutionService;

const [snapController] = getSnapControllerWithEES(
getSnapControllerWithEESOptions({
rootMessenger,
trackEvent: mockTrackEvent,
state: {
snaps: getPersistedSnapsState(),
},
}),
executionEnvironmentStub,
);

const snap = snapController.getExpect(MOCK_SNAP_ID);
await snapController.startSnap(snap.id);

await snapController.handleRequest({
snapId: snap.id,
origin: MOCK_ORIGIN,
handler: HandlerType.OnRpcRequest,
request: {
jsonrpc: '2.0',
method: 'test',
params: {},
id: 1,
},
});

expect(mockTrackEvent).toHaveBeenCalledTimes(1);
expect(mockTrackEvent).toHaveBeenCalledWith({
event: 'SnapExportUsed',
category: 'Snaps',
properties: {
export: 'onRpcRequest',
origin: 'https://example.com',
// eslint-disable-next-line @typescript-eslint/naming-convention
snap_category: null,
// eslint-disable-next-line @typescript-eslint/naming-convention
snap_id: 'npm:@metamask/example-snap',
success: true,
},
});
snapController.destroy();
});

it('should not track event for disallowed handler', async () => {
const mockTrackEvent = jest.fn();
const rootMessenger = getControllerMessenger();

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
() => ({
[SnapEndowments.Cronjob]: {
caveats: [
{ type: SnapCaveatType.SnapCronjob, value: '* * * * *' },
],
date: 1664187844588,
id: 'izn0WGUO8cvq_jqvLQuQP',
invoker: MOCK_SNAP_ID,
parentCapability: SnapEndowments.Cronjob,
},
}),
);

const executionEnvironmentStub = new ExecutionEnvironmentStub(
getNodeEESMessenger(rootMessenger),
) as unknown as NodeThreadExecutionService;

const [snapController] = getSnapControllerWithEES(
getSnapControllerWithEESOptions({
environmentEndowmentPermissions: ['endowment:cronjob'],
rootMessenger,
trackEvent: mockTrackEvent,
state: {
snaps: getPersistedSnapsState(),
},
}),
executionEnvironmentStub,
);

const snap = snapController.getExpect(MOCK_SNAP_ID);
await snapController.startSnap(snap.id);

await snapController.handleRequest({
snapId: snap.id,
origin: MOCK_ORIGIN,
handler: HandlerType.OnCronjob,
request: {
jsonrpc: '2.0',
method: 'test',
params: {},
id: 1,
},
});

expect(mockTrackEvent).not.toHaveBeenCalled();
snapController.destroy();
});

it('should properly handle error when MetaMetrics hook throws an error', async () => {
const log = jest.spyOn(console, 'error').mockImplementation();
const error = new Error('MetaMetrics hook error');
const mockTrackEvent = jest.fn().mockImplementation(() => {
throw error;
});
const rootMessenger = getControllerMessenger();
const executionEnvironmentStub = new ExecutionEnvironmentStub(
getNodeEESMessenger(rootMessenger),
) as unknown as NodeThreadExecutionService;

const [snapController] = getSnapControllerWithEES(
getSnapControllerWithEESOptions({
rootMessenger,
trackEvent: mockTrackEvent,
state: {
snaps: getPersistedSnapsState(),
},
}),
executionEnvironmentStub,
);

const snap = snapController.getExpect(MOCK_SNAP_ID);
await snapController.startSnap(snap.id);

await snapController.handleRequest({
snapId: snap.id,
origin: MOCK_ORIGIN,
handler: HandlerType.OnRpcRequest,
request: {
jsonrpc: '2.0',
method: 'test',
params: {},
id: 1,
},
});

expect(mockTrackEvent).toHaveBeenCalled();
expect(log).toHaveBeenCalledWith(
expect.stringContaining(
'Error when calling MetaMetrics hook for snap',
),
);
snapController.destroy();
});

it('should not track event for preinstalled snap', async () => {
const mockTrackEvent = jest.fn();
const rootMessenger = getControllerMessenger();
const executionEnvironmentStub = new ExecutionEnvironmentStub(
getNodeEESMessenger(rootMessenger),
) as unknown as NodeThreadExecutionService;

const [snapController] = getSnapControllerWithEES(
getSnapControllerWithEESOptions({
rootMessenger,
trackEvent: mockTrackEvent,
state: {
snaps: getPersistedSnapsState(
getPersistedSnapObject({ preinstalled: true }),
),
},
}),
executionEnvironmentStub,
);

const snap = snapController.getExpect(MOCK_SNAP_ID);
await snapController.startSnap(snap.id);

await snapController.handleRequest({
snapId: snap.id,
origin: MOCK_ORIGIN,
handler: HandlerType.OnRpcRequest,
request: {
jsonrpc: '2.0',
method: 'test',
params: {},
id: 1,
},
});

expect(mockTrackEvent).not.toHaveBeenCalled();
snapController.destroy();
});
});

it('handles a transaction insight request', async () => {
Expand Down Expand Up @@ -10388,35 +10537,6 @@ describe('SnapController', () => {
});
});

describe('SnapController:getRegistryMetadata', () => {
it('calls SnapController.getRegistryMetadata()', async () => {
const registry = new MockSnapsRegistry();
const rootMessenger = getControllerMessenger(registry);
const messenger = getSnapControllerMessenger(rootMessenger);

registry.getMetadata.mockReturnValue({
name: 'Mock Snap',
});

const snapController = getSnapController(
getSnapControllerOptions({
messenger,
}),
);

expect(
await messenger.call(
'SnapController:getRegistryMetadata',
MOCK_SNAP_ID,
),
).toStrictEqual({
name: 'Mock Snap',
});

snapController.destroy();
});
});

describe('SnapController:disconnectOrigin', () => {
it('calls SnapController.removeSnapFromSubject()', () => {
const messenger = getSnapControllerMessenger();
Expand Down
Loading
Loading