Skip to content
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.

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

feat: Add WalletAdvanced Telemetry #1963

Merged
merged 7 commits into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
140 changes: 133 additions & 7 deletions src/wallet/components/WalletAdvancedTransactionActions.test.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { useAnalytics } from '@/core/analytics/hooks/useAnalytics';
import { WalletEvent, WalletOption } from '@/core/analytics/types';
import { useOnchainKit } from '@/useOnchainKit';
import { fireEvent, render, screen } from '@testing-library/react';
import { beforeEach, describe, expect, it, vi } from 'vitest';
Expand All @@ -20,6 +22,12 @@ vi.mock('./WalletProvider', () => ({
useWalletContext: vi.fn(),
}));

vi.mock('@/core/analytics/hooks/useAnalytics', () => ({
useAnalytics: vi.fn(() => ({
sendAnalytics: vi.fn(),
})),
}));

describe('WalletAdvancedTransactionActons', () => {
const mockUseWalletAdvancedContext = useWalletAdvancedContext as ReturnType<
typeof vi.fn
Expand All @@ -40,6 +48,8 @@ describe('WalletAdvancedTransactionActons', () => {
const mockAddress = '0x123';
const mockChain = { name: 'Base' };

const mockSendAnalytics = vi.fn();

beforeEach(() => {
vi.clearAllMocks();
vi.spyOn(window, 'open').mockImplementation(() => null);
Expand All @@ -54,6 +64,10 @@ describe('WalletAdvancedTransactionActons', () => {
address: mockAddress,
chain: mockChain,
});

(useAnalytics as ReturnType<typeof vi.fn>).mockReturnValue({
sendAnalytics: mockSendAnalytics,
});
});

it('renders the WalletAdvancedTransactionActions component', () => {
Expand Down Expand Up @@ -100,7 +114,6 @@ describe('WalletAdvancedTransactionActons', () => {
});

it('opens the buy page when the buy button is clicked and projectId, address or chain.name are not defined', () => {
// projectId is not defined
mockUseOnchainKit.mockReturnValue({
projectId: null,
});
Expand All @@ -109,7 +122,6 @@ describe('WalletAdvancedTransactionActons', () => {
fireEvent.click(buyButton);
expect(window.open).not.toHaveBeenCalled();

// address is not defined
mockUseOnchainKit.mockReturnValue({
projectId: mockProjectId,
});
Expand All @@ -121,7 +133,6 @@ describe('WalletAdvancedTransactionActons', () => {
fireEvent.click(buyButton);
expect(window.open).not.toHaveBeenCalled();

// chain.name is not defined
mockUseWalletContext.mockReturnValue({
address: mockAddress,
chain: null,
Expand Down Expand Up @@ -195,13 +206,11 @@ describe('WalletAdvancedTransactionActons', () => {

render(<WalletAdvancedTransactionActions classNames={customClassNames} />);

// Check main container
const container = screen.getByTestId(
'ockWalletAdvanced_TransactionActions',
);
expect(container.className).toContain('custom-container');

// Check Buy button (left action)
const buyButton = screen.getByRole('button', { name: 'Buy' });
expect(buyButton.className).toContain('custom-left-button');
expect(buyButton.querySelector('span:first-child')?.className).toContain(
Expand All @@ -211,7 +220,6 @@ describe('WalletAdvancedTransactionActons', () => {
'custom-left-label',
);

// Check Send button (middle action)
const sendButton = screen.getByRole('button', { name: 'Send' });
expect(sendButton.className).toContain('custom-middle-button');
expect(sendButton.querySelector('span:first-child')?.className).toContain(
Expand All @@ -221,7 +229,6 @@ describe('WalletAdvancedTransactionActons', () => {
'custom-middle-label',
);

// Check Swap button (right action)
const swapButton = screen.getByRole('button', { name: 'Swap' });
expect(swapButton.className).toContain('custom-right-button');
expect(swapButton.querySelector('span:first-child')?.className).toContain(
Expand All @@ -231,4 +238,123 @@ describe('WalletAdvancedTransactionActons', () => {
'custom-right-label',
);
});

describe('analytics', () => {
it('sends analytics when buy button is clicked', () => {
render(<WalletAdvancedTransactionActions />);

const buyButton = screen.getByRole('button', { name: 'Buy' });
fireEvent.click(buyButton);

expect(mockSendAnalytics).toHaveBeenCalledWith(
WalletEvent.OptionSelected,
{
option: WalletOption.Buy,
},
);
});

it('sends analytics when send button is clicked', () => {
render(<WalletAdvancedTransactionActions />);

const sendButton = screen.getByRole('button', { name: 'Send' });
fireEvent.click(sendButton);

expect(mockSendAnalytics).toHaveBeenCalledWith(
WalletEvent.OptionSelected,
{
option: WalletOption.Send,
},
);
});

it('sends analytics when swap button is clicked', () => {
render(<WalletAdvancedTransactionActions />);

const swapButton = screen.getByRole('button', { name: 'Swap' });
fireEvent.click(swapButton);

expect(mockSendAnalytics).toHaveBeenCalledWith(
WalletEvent.OptionSelected,
{
option: WalletOption.Swap,
},
);
});

it('sends analytics for buy action only when required parameters are present', () => {
mockUseOnchainKit.mockReturnValue({
projectId: null,
});

const { rerender } = render(<WalletAdvancedTransactionActions />);
const buyButton = screen.getByRole('button', { name: 'Buy' });

fireEvent.click(buyButton);
expect(mockSendAnalytics).toHaveBeenCalledTimes(1);
expect(window.open).not.toHaveBeenCalled();

mockUseOnchainKit.mockReturnValue({
projectId: mockProjectId,
});
mockUseWalletContext.mockReturnValue({
address: mockAddress,
chain: mockChain,
});

rerender(<WalletAdvancedTransactionActions />);
fireEvent.click(buyButton);

expect(mockSendAnalytics).toHaveBeenCalledTimes(2);
expect(window.open).toHaveBeenCalled();
});

it('does not send duplicate analytics events on multiple clicks', () => {
render(<WalletAdvancedTransactionActions />);

const buyButton = screen.getByRole('button', { name: 'Buy' });
fireEvent.click(buyButton);
fireEvent.click(buyButton);

const sendButton = screen.getByRole('button', { name: 'Send' });
fireEvent.click(sendButton);
fireEvent.click(sendButton);

const swapButton = screen.getByRole('button', { name: 'Swap' });
fireEvent.click(swapButton);
fireEvent.click(swapButton);

expect(mockSendAnalytics).toHaveBeenCalledTimes(6);
expect(mockSendAnalytics).toHaveBeenNthCalledWith(
1,
WalletEvent.OptionSelected,
{ option: WalletOption.Buy },
);
expect(mockSendAnalytics).toHaveBeenNthCalledWith(
2,
WalletEvent.OptionSelected,
{ option: WalletOption.Buy },
);
expect(mockSendAnalytics).toHaveBeenNthCalledWith(
3,
WalletEvent.OptionSelected,
{ option: WalletOption.Send },
);
expect(mockSendAnalytics).toHaveBeenNthCalledWith(
4,
WalletEvent.OptionSelected,
{ option: WalletOption.Send },
);
expect(mockSendAnalytics).toHaveBeenNthCalledWith(
5,
WalletEvent.OptionSelected,
{ option: WalletOption.Swap },
);
expect(mockSendAnalytics).toHaveBeenNthCalledWith(
6,
WalletEvent.OptionSelected,
{ option: WalletOption.Swap },
);
});
});
});
22 changes: 19 additions & 3 deletions src/wallet/components/WalletAdvancedTransactionActions.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
'use client';

import { useAnalytics } from '@/core/analytics/hooks/useAnalytics';
import { WalletEvent, WalletOption } from '@/core/analytics/types';
import { addSvgForeground } from '@/internal/svg/addForegroundSvg';
import { arrowUpRightSvg } from '@/internal/svg/arrowUpRightSvg';
import { toggleSvg } from '@/internal/svg/toggleSvg';
Expand Down Expand Up @@ -36,8 +38,20 @@ export function WalletAdvancedTransactionActions({
const { projectId } = useOnchainKit();
const { isFetchingPortfolioData, setShowSwap, animations } =
useWalletAdvancedContext();
const { sendAnalytics } = useAnalytics();

const handleAnalyticsOptionSelected = useCallback(
(option: WalletOption) => {
sendAnalytics(WalletEvent.OptionSelected, {
option,
});
},
[sendAnalytics],
);

const handleBuy = useCallback(() => {
handleAnalyticsOptionSelected(WalletOption.Buy);

if (!projectId || !address || !chain?.name) {
return;
}
Expand All @@ -61,15 +75,17 @@ export function WalletAdvancedTransactionActions({
'popup',
'width=400,height=600,scrollbars=yes',
);
}, [address, chain?.name, projectId]);
}, [address, chain?.name, projectId, handleAnalyticsOptionSelected]);

const handleSend = useCallback(() => {
handleAnalyticsOptionSelected(WalletOption.Send);
window.open('https://wallet.coinbase.com', '_blank');
}, []);
}, [handleAnalyticsOptionSelected]);

const handleSwap = useCallback(() => {
handleAnalyticsOptionSelected(WalletOption.Swap);
setShowSwap(true);
}, [setShowSwap]);
}, [setShowSwap, handleAnalyticsOptionSelected]);

if (isFetchingPortfolioData) {
return (
Expand Down
Loading
Loading