chore: remove @metamask/sdk-analytics and migrate SDKv1 events to MetaMetrics #28322
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,6 @@ import { NetworkController } from '@metamask/network-controller'; | |
| import { | ||
| CommunicationLayerMessage, | ||
| MessageType, | ||
| OriginatorInfo, | ||
| } from '@metamask/sdk-communication-layer'; | ||
| import Engine from '../../Engine'; | ||
|
|
@@ -23,18 +22,16 @@ import { AccountsController } from '@metamask/accounts-controller'; | |
| import { toChecksumHexAddress } from '@metamask/controller-utils'; | ||
| import { NETWORKS_CHAIN_ID } from '../../../../app/constants/network'; | ||
| import { mockNetworkState } from '../../../util/test/network'; | ||
| import { analytics } from '../../../util/analytics/analytics'; | ||
|
|
||
| jest.mock('../../../util/analytics/analytics', () => ({ | ||
| analytics: { | ||
| trackEvent: jest.fn(), | ||
| }, | ||
| })); | ||
|
|
||
| jest.mock('@metamask/sdk-communication-layer', () => ({ | ||
| ...jest.requireActual('@metamask/sdk-communication-layer'), | ||
| })); | ||
|
|
||
| jest.mock('../../Engine'); | ||
|
|
@@ -153,13 +150,9 @@ describe('handleConnectionMessage', () => { | |
| mockHandleSendMessage.mockResolvedValue(); | ||
| }); | ||
|
|
||
| describe('Analytics tracking for Remote Connection RPC Request Received', () => { | ||
| beforeEach(() => { | ||
| (analytics.trackEvent as jest.Mock).mockClear(); | ||
|
|
||
| connection.originatorInfo = { | ||
| url: 'https://test-dapp.com', | ||
|
|
@@ -173,47 +166,46 @@ describe('handleConnectionMessage', () => { | |
| connector: 'metamask', | ||
| anonId: 'test-anon-id', | ||
| } as OriginatorInfo; | ||
| message.method = 'eth_sendTransaction'; | ||
| message.id = 'rpc-123'; | ||
| message.type = MessageType.JSONRPC; | ||
| }); | ||
|
|
||
| it('should track Remote Connection RPC Request Received when anonId is present and method is tracked', async () => { | ||
| await handleConnectionMessage({ message, engine: Engine, connection }); | ||
|
|
||
| expect(analytics.trackEvent).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| name: 'Remote Connection RPC Request Received', | ||
| properties: expect.objectContaining({ | ||
| transport_type: 'socket_relay', | ||
| rpc_method: 'eth_sendTransaction', | ||
| remote_session_id: 'test-anon-id', | ||
| }), | ||
| }), | ||
| ); | ||
| expect(analytics.trackEvent).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it('should not track Remote Connection RPC Request Received if anonId is missing', async () => { | ||
| if (connection.originatorInfo) { | ||
| connection.originatorInfo.anonId = undefined; | ||
| } | ||
|
|
||
| await handleConnectionMessage({ message, engine: Engine, connection }); | ||
|
|
||
| expect(analytics.trackEvent).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('should not track Remote Connection RPC Request Received if method is not analytics tracked', async () => { | ||
| message.method = 'eth_chainId'; | ||
|
|
||
| await handleConnectionMessage({ message, engine: Engine, connection }); | ||
|
|
||
| expect(analytics.trackEvent).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('should not track Remote Connection RPC Request Received if message.method is undefined', async () => { | ||
| // Create a new message object for this specific test case to avoid type issues | ||
| const messageWithUndefinedMethod: CommunicationLayerMessage = { | ||
| // Explicitly define all required fields of CommunicationLayerMessage | ||
|
|
@@ -231,7 +223,7 @@ describe('handleConnectionMessage', () => { | |
| connection, | ||
| }); | ||
|
|
||
| expect(analytics.trackEvent).not.toHaveBeenCalled(); | ||
| // The DevLogger for invalid message should be hit earlier in this case | ||
| expect(mockDevLoggerLog).toHaveBeenCalledWith( | ||
| `Connection::onMessage invalid message`, | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DevLogger logs
[object Object]instead of event nameLow Severity
MetaMetricsEvents.REMOTE_CONNECTION_REQUEST_RECEIVED(and theRPC_REQUEST_RECEIVEDvariant) is anIMetaMetricsEventobject{ category: 'Remote Connection Request Received' }returned bygenerateOpt. Interpolating it directly in a template literal produces[object Object]instead of the event name.handleSendMessage.tscorrectly usesevent.categoryfor the same purpose—these two call sites need the same.categoryaccessor.Additional Locations (1)
app/core/SDKConnect/handlers/handleConnectionMessage.ts#L72-L73Reviewed by Cursor Bugbot for commit f236a8f. Configure here.