feat: adding metrics for signature decoding #28719
There are no files selected for viewing
This file contains 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 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 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 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 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 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 |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| import { DecodingData, DecodingDataChangeType } from '@metamask/signature-controller'; | ||
|
|
||
| import { getMockTypedSignConfirmStateForRequest } from '../../../../test/data/confirmations/helper'; | ||
| import { renderHookWithConfirmContextProvider } from '../../../../test/lib/confirmations/render-helpers'; | ||
| import { permitSignatureMsg } from '../../../../test/data/confirmations/typed_sign'; | ||
| import * as SignatureEventFragment from './useSignatureEventFragment'; | ||
| import { useDecodedSignatureMetrics } from './useDecodedSignatureMetrics'; | ||
|
|
||
| const decodingData: DecodingData = { | ||
| stateChanges: [ | ||
| { | ||
| assetType: 'ERC20', | ||
| changeType: DecodingDataChangeType.Approve, | ||
| address: '0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad', | ||
| amount: '1461501637330902918203684832716283019655932542975', | ||
| contractAddress: '0x6b175474e89094c44da98b954eedeac495271d0f', | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
| describe('useDecodedSignatureMetrics', () => { | ||
| process.env.ENABLE_SIGNATURE_DECODING = 'true'; | ||
| it('should not call updateSignatureEventFragment if decodingLoading is true', async () => { | ||
| const state = getMockTypedSignConfirmStateForRequest({ | ||
| ...permitSignatureMsg, | ||
| decodingLoading: true, | ||
| }); | ||
|
|
||
| const mockUpdateSignatureEventFragment = jest.fn(); | ||
| jest | ||
| .spyOn(SignatureEventFragment, 'useSignatureEventFragment') | ||
| .mockImplementation(() => ({ | ||
| updateSignatureEventFragment: mockUpdateSignatureEventFragment, | ||
| })); | ||
|
|
||
| renderHookWithConfirmContextProvider( | ||
| () => useDecodedSignatureMetrics(), | ||
| state, | ||
| ); | ||
|
|
||
| expect(mockUpdateSignatureEventFragment).toHaveBeenCalledTimes(0); | ||
| }); | ||
|
|
||
| it('should call updateSignatureEventFragment with correct parameters if there are no state changes', async () => { | ||
| const state = getMockTypedSignConfirmStateForRequest({ | ||
| ...permitSignatureMsg, | ||
| decodingLoading: false, | ||
| }); | ||
|
|
||
| const mockUpdateSignatureEventFragment = jest.fn(); | ||
| jest | ||
| .spyOn(SignatureEventFragment, 'useSignatureEventFragment') | ||
| .mockImplementation(() => ({ | ||
| updateSignatureEventFragment: mockUpdateSignatureEventFragment, | ||
| })); | ||
|
|
||
| renderHookWithConfirmContextProvider( | ||
| () => useDecodedSignatureMetrics(), | ||
| state, | ||
| ); | ||
|
|
||
| expect(mockUpdateSignatureEventFragment).toHaveBeenCalledTimes(1); | ||
| expect(mockUpdateSignatureEventFragment).toHaveBeenLastCalledWith({ | ||
| properties: { | ||
| decoding_change_types: [], | ||
| decoding_response: 'NO_CHANGE', | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| it('should call updateSignatureEventFragment with correct parameters if there are no state changes', async () => { | ||
|
There was a problem hiding this comment. Minor, same name as the other? |
||
| const state = getMockTypedSignConfirmStateForRequest({ | ||
| ...permitSignatureMsg, | ||
| decodingLoading: false, | ||
| decodingData | ||
| }); | ||
|
|
||
| const mockUpdateSignatureEventFragment = jest.fn(); | ||
| jest | ||
| .spyOn(SignatureEventFragment, 'useSignatureEventFragment') | ||
| .mockImplementation(() => ({ | ||
| updateSignatureEventFragment: mockUpdateSignatureEventFragment, | ||
| })); | ||
|
|
||
| renderHookWithConfirmContextProvider( | ||
| () => useDecodedSignatureMetrics(), | ||
| state, | ||
| ); | ||
|
|
||
| expect(mockUpdateSignatureEventFragment).toHaveBeenCalledTimes(1); | ||
| expect(mockUpdateSignatureEventFragment).toHaveBeenLastCalledWith({ | ||
| properties: { | ||
| decoding_change_types: ["APPROVE"], | ||
| decoding_response: 'CHANGE', | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| it('should call updateSignatureEventFragment with correct parameters if response has error', async () => { | ||
| const state = getMockTypedSignConfirmStateForRequest({ | ||
| ...permitSignatureMsg, | ||
| decodingLoading: false, | ||
| decodingData: { | ||
| stateChanges: [], | ||
| error: { | ||
| type: 'SOME_ERROR', | ||
| message: 'some message' | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| const mockUpdateSignatureEventFragment = jest.fn(); | ||
| jest | ||
| .spyOn(SignatureEventFragment, 'useSignatureEventFragment') | ||
| .mockImplementation(() => ({ | ||
| updateSignatureEventFragment: mockUpdateSignatureEventFragment, | ||
| })); | ||
|
|
||
| renderHookWithConfirmContextProvider( | ||
| () => useDecodedSignatureMetrics(), | ||
| state, | ||
| ); | ||
|
|
||
| expect(mockUpdateSignatureEventFragment).toHaveBeenCalledTimes(1); | ||
| expect(mockUpdateSignatureEventFragment).toHaveBeenLastCalledWith({ | ||
| properties: { | ||
| decoding_change_types: [], | ||
| decoding_response: 'SOME_ERROR', | ||
| }, | ||
| }); | ||
| }); | ||
| }); | ||
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| import { DecodingDataStateChange } from '@metamask/signature-controller'; | ||
| import { useEffect } from 'react'; | ||
|
|
||
| import { SignatureRequestType } from '../types/confirm'; | ||
| import { useConfirmContext } from '../context/confirm'; | ||
| import { useSignatureEventFragment } from './useSignatureEventFragment'; | ||
|
|
||
|
|
||
| enum DecodingResponseType { | ||
| Change = 'CHANGE', | ||
| NoChange = 'NO_CHANGE', | ||
| } | ||
|
|
||
| export function useDecodedSignatureMetrics() { | ||
| const { updateSignatureEventFragment } = useSignatureEventFragment(); | ||
| const { currentConfirmation } = useConfirmContext<SignatureRequestType>(); | ||
| const { decodingLoading, decodingData } = currentConfirmation; | ||
|
|
||
| const decodingChangeTypes = (decodingData?.stateChanges ?? []).map( | ||
| (change: DecodingDataStateChange) => change.changeType, | ||
| ); | ||
|
|
||
| const decodingResponse = | ||
| decodingData?.error?.type ?? | ||
| (decodingChangeTypes.length | ||
| ? DecodingResponseType.Change | ||
| : DecodingResponseType.NoChange); | ||
|
|
||
| useEffect(() => { | ||
| if (decodingLoading || !process.env.ENABLE_SIGNATURE_DECODING) { | ||
| return; | ||
| } | ||
|
|
||
| updateSignatureEventFragment({ | ||
| properties: { | ||
| decoding_response: decodingResponse, | ||
| decoding_change_types: decodingChangeTypes, | ||
| }, | ||
| }); | ||
| }, [ | ||
| decodingResponse, | ||
| decodingLoading, | ||
| decodingChangeTypes, | ||
| updateSignatureEventFragment, | ||
| ]); | ||
| } |
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.
Q: should we unset the ENV var after the tests are complete or is there another way to add ENV for builds?
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.
This is being removed in a following PR