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

fix: update notifications events (#26807) #26924

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
8 changes: 3 additions & 5 deletions app/scripts/metamask-controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -1451,9 +1451,9 @@ export default class MetamaskController extends EventEmitter {
(notification) => {
this.metaMetricsController.trackEvent({
category: MetaMetricsEventCategory.PushNotifications,
event: MetaMetricsEventName.NotificationReceived,
event: MetaMetricsEventName.PushNotificationReceived,
properties: {
notification_channel: 'push',
notification_id: notification.id,
notification_type: notification.type,
chain_id: notification?.chain_id,
},
Expand All @@ -1465,13 +1465,11 @@ export default class MetamaskController extends EventEmitter {
(notification) => {
this.metaMetricsController.trackEvent({
category: MetaMetricsEventCategory.PushNotifications,
event: MetaMetricsEventName.NotificationClicked,
event: MetaMetricsEventName.PushNotificationClicked,
properties: {
notification_id: notification.id,
notification_type: notification.type,
chain_id: notification?.chain_id,
notification_is_read: notification.isRead,
click_type: 'push_notification',
},
});
},
Expand Down
10 changes: 7 additions & 3 deletions shared/constants/metametrics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -703,10 +703,13 @@ export enum MetaMetricsEventName {
TurnOnMetaMetrics = 'MetaMetrics Turned On',
TurnOffMetaMetrics = 'MetaMetrics Turned Off',
// Notifications
NotificationReceived = 'Notification Received',
NotificationsSettingsUpdated = 'Notifications Settings Updated',
NotificationClicked = 'Notification Clicked',
NotificationMenuOpened = 'Notification Menu Opened',
NotificationDetailClicked = 'Notification Detail Clicked',
NotificationsMenuOpened = 'Notifications Menu Opened',
NotificationsSettingsUpdated = 'Notifications Settings Updated',
NotificationsActivated = 'Notifications Activated',
PushNotificationReceived = 'Push Notification Received',
PushNotificationClicked = 'Push Notification Clicked',

// Send
sendAssetSelected = 'Send Asset Selected',
Expand Down Expand Up @@ -749,6 +752,7 @@ export enum MetaMetricsEventCategory {
Network = 'Network',
Onboarding = 'Onboarding',
NotificationInteraction = 'Notification Interaction',
NotificationsActivationFlow = 'Notifications Activation Flow',
NotificationSettings = 'Notification Settings',
Petnames = 'Petnames',
Phishing = 'Phishing',
Expand Down
1 change: 0 additions & 1 deletion test/e2e/tests/metrics/wallet-created.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ describe('Wallet Created Events @no-mmi', function () {
chain_id: '0x539',
environment_type: 'fullscreen',
is_profile_syncing_enabled: null,
is_signed_in: false,
});
},
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,24 +61,22 @@ export default function TurnOnMetamaskNotifications() {
setButtonState(true);
await createNotifications();
trackEvent({
category: MetaMetricsEventCategory.NotificationInteraction,
event: MetaMetricsEventName.NotificationMenuOpened,
category: MetaMetricsEventCategory.NotificationsActivationFlow,
event: MetaMetricsEventName.NotificationsActivated,
properties: {
is_profile_syncing_enabled: isProfileSyncingEnabled,
is_notifications_enabled: isNotificationEnabled,
action_type: 'enabled',
is_profile_syncing_enabled: true,
action_type: 'activated',
},
});
};

const handleHideModal = () => {
hideModal();
trackEvent({
category: MetaMetricsEventCategory.NotificationInteraction,
event: MetaMetricsEventName.NotificationMenuOpened,
category: MetaMetricsEventCategory.NotificationsActivationFlow,
event: MetaMetricsEventName.NotificationsActivated,
properties: {
is_profile_syncing_enabled: isProfileSyncingEnabled,
is_notifications_enabled: isNotificationEnabled,
action_type: 'dismissed',
},
});
Expand Down
22 changes: 13 additions & 9 deletions ui/components/multichain/global-menu/global-menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ import React, { useContext } from 'react';
import PropTypes from 'prop-types';
import { useHistory } from 'react-router-dom';
import { useDispatch, useSelector } from 'react-redux';
import { useCounter } from '../../../hooks/metamask-notifications/useCounter';
import {
useUnreadNotificationsCounter,
useReadNotificationsCounter,
} from '../../../hooks/metamask-notifications/useCounter';
import { NotificationsTagCounter } from '../notifications-tag-counter';
import { NewFeatureTag } from '../../../pages/notifications/NewFeatureTag';
import {
Expand Down Expand Up @@ -80,7 +83,8 @@ export const GlobalMenu = ({ closeMenu, anchorElement, isOpen }) => {

const history = useHistory();

const { notificationsCount } = useCounter();
const { notificationsUnreadCount } = useUnreadNotificationsCounter();
const { notificationsReadCount } = useReadNotificationsCounter();

const account = useSelector(getSelectedInternalAccount);

Expand Down Expand Up @@ -144,11 +148,11 @@ export const GlobalMenu = ({ closeMenu, anchorElement, isOpen }) => {

if (shouldShowEnableModal) {
trackEvent({
category: MetaMetricsEventCategory.NotificationInteraction,
event: MetaMetricsEventName.NotificationMenuOpened,
category: MetaMetricsEventCategory.NotificationsActivationFlow,
event: MetaMetricsEventName.NotificationsActivated,
properties: {
action_type: 'started',
is_profile_syncing_enabled: isProfileSyncingEnabled,
is_notifications_enabled: isMetamaskNotificationsEnabled,
},
});
dispatch(showConfirmTurnOnMetamaskNotifications());
Expand All @@ -160,10 +164,10 @@ export const GlobalMenu = ({ closeMenu, anchorElement, isOpen }) => {
// Otherwise we can navigate to the notifications page
trackEvent({
category: MetaMetricsEventCategory.NotificationInteraction,
event: MetaMetricsEventName.NotificationMenuOpened,
event: MetaMetricsEventName.NotificationsMenuOpened,
properties: {
is_profile_syncing_enabled: isProfileSyncingEnabled,
is_notifications_enabled: isMetamaskNotificationsEnabled,
unread_count: notificationsUnreadCount,
read_count: notificationsReadCount,
},
});
history.push(NOTIFICATIONS_ROUTE);
Expand Down Expand Up @@ -198,7 +202,7 @@ export const GlobalMenu = ({ closeMenu, anchorElement, isOpen }) => {
justifyContent={JustifyContent.spaceBetween}
>
{t('notifications')}
{notificationsCount === 0 &&
{notificationsUnreadCount === 0 &&
!isMetamaskNotificationFeatureSeen && <NewFeatureTag />}
<NotificationsTagCounter />
</Box>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,14 @@ export const NotificationDetailButton = ({
const onClick = () => {
trackEvent({
category: MetaMetricsEventCategory.NotificationInteraction,
event: MetaMetricsEventName.NotificationClicked,
event: MetaMetricsEventName.NotificationDetailClicked,
properties: {
notification_id: notification.id,
notification_type: notification.type,
...(notification.type !== TRIGGER_TYPES.FEATURES_ANNOUNCEMENT && {
chain_id: notification?.chain_id,
}),
notification_is_read: notification.isRead,
click_type: 'detail',
clicked_item: 'block_explorer',
},
});
};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
import React from 'react';
import React, { useContext } from 'react';
import type { FC } from 'react';
import type { Notification } from '../../../../app/scripts/controllers/metamask-notifications/types/types';
import { TRIGGER_TYPES } from '../../../../app/scripts/controllers/metamask-notifications/constants/notification-schema';
import { MetaMetricsContext } from '../../../contexts/metametrics';
import {
MetaMetricsEventCategory,
MetaMetricsEventName,
} from '../../../../shared/constants/metametrics';
import {
ButtonBase,
IconName,
Expand All @@ -20,6 +27,7 @@ import { useI18nContext } from '../../../hooks/useI18nContext';
import { MINUTE } from '../../../../shared/constants/time';

export type NotificationDetailCopyButtonProps = {
notification?: Notification;
text: string;
displayText: string;
color?: TextColor;
Expand All @@ -30,25 +38,50 @@ export type NotificationDetailCopyButtonProps = {
* The button includes a tooltip that displays a message based on whether the text has been copied or not.
*
* @param props - The component props.
* @param props.notification - The notification object.
* @param props.text - The text to be copied when the button is clicked.
* @param props.displayText - The text to be displayed on the button.
* @param [props.color] - The color of the text.
* @returns The rendered component.
*/
export const NotificationDetailCopyButton: FC<
NotificationDetailCopyButtonProps
> = ({ text, displayText, color = TextColor.textAlternative }): JSX.Element => {
> = ({
notification,
text,
displayText,
color = TextColor.textAlternative,
}): JSX.Element => {
const [copied, handleCopy] = useCopyToClipboard(MINUTE);
const t = useI18nContext();
const trackEvent = useContext(MetaMetricsContext);

const tooltipText = copied ? t('copiedExclamation') : t('copyToClipboard');
const tooltipTitle = tooltipText;

const onClick = () => {
typeof handleCopy === 'function' && handleCopy(text);
if (notification) {
trackEvent({
category: MetaMetricsEventCategory.NotificationInteraction,
event: MetaMetricsEventName.NotificationDetailClicked,
properties: {
notification_id: notification.id,
notification_type: notification.type,
...(notification.type !== TRIGGER_TYPES.FEATURES_ANNOUNCEMENT && {
chain_id: notification?.chain_id,
}),
clicked_item: 'tx_id',
},
});
}
};

return (
<Tooltip position="bottom" title={tooltipTitle}>
<ButtonBase
backgroundColor={BackgroundColor.transparent}
onClick={() => typeof handleCopy === 'function' && handleCopy(text)}
onClick={onClick}
paddingRight={0}
paddingLeft={0}
variant={TextVariant.bodyMd}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
import React, { useState, useEffect } from 'react';
import React, { useContext, useState, useEffect } from 'react';
import type { FC } from 'react';
import type { OnChainRawNotificationsWithNetworkFields } from '../../../../app/scripts/controllers/metamask-notifications/types/on-chain-notification/on-chain-notification';

import { useI18nContext } from '../../../hooks/useI18nContext';
import { MetaMetricsContext } from '../../../contexts/metametrics';
import {
getNetworkFees,
getNetworkDetailsByChainId,
} from '../../../helpers/utils/notification.util';
import { decimalToHex } from '../../../../shared/modules/conversion.utils';
import { CHAIN_IDS } from '../../../../shared/constants/network';
import {
MetaMetricsEventCategory,
MetaMetricsEventName,
} from '../../../../shared/constants/metametrics';

import { NotificationDetail } from '../notification-detail';
import {
Expand Down Expand Up @@ -83,6 +88,7 @@ export const NotificationDetailNetworkFee: FC<
NotificationDetailNetworkFeeProps
> = ({ notification }) => {
const t = useI18nContext();
const trackEvent = useContext(MetaMetricsContext);
const [isOpen, setIsOpen] = useState<boolean>(false);
const [networkFees, setNetworkFees] = useState<NetworkFees>(null);
const [networkFeesError, setNetworkFeesError] = useState<boolean>(false);
Expand Down Expand Up @@ -119,6 +125,18 @@ export const NotificationDetailNetworkFee: FC<
}, []);

const handleClick = () => {
if (!isOpen) {
trackEvent({
category: MetaMetricsEventCategory.NotificationInteraction,
event: MetaMetricsEventName.NotificationDetailClicked,
properties: {
notification_id: notification.id,
notification_type: notification.type,
chain_id: notification.chain_id,
clicked_item: 'fee_details',
},
});
}
setIsOpen(!isOpen);
};

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import { useCounter } from '../../../hooks/metamask-notifications/useCounter';
import { useUnreadNotificationsCounter } from '../../../hooks/metamask-notifications/useCounter';
import { Box, Text } from '../../component-library';
import {
BackgroundColor,
Expand All @@ -18,9 +18,9 @@ type NotificationsTagCounterProps = {
export const NotificationsTagCounter = ({
noLabel = false,
}: NotificationsTagCounterProps) => {
const { notificationsCount } = useCounter();
const { notificationsUnreadCount } = useUnreadNotificationsCounter();

if (notificationsCount === 0) {
if (notificationsUnreadCount === 0) {
return null;
}

Expand Down Expand Up @@ -50,7 +50,7 @@ export const NotificationsTagCounter = ({
className="notifications-tag-counter__unread-dot"
textAlign={TextAlign.Center}
>
{notificationsCount > 10 ? '9+' : notificationsCount}
{notificationsUnreadCount > 10 ? '9+' : notificationsUnreadCount}
</Text>
</Box>
);
Expand All @@ -72,7 +72,7 @@ export const NotificationsTagCounter = ({
className="notifications-tag-counter__text"
textAlign={TextAlign.Center}
>
{notificationsCount > 10 ? '9+' : notificationsCount}
{notificationsUnreadCount > 10 ? '9+' : notificationsUnreadCount}
</Text>
</Box>
);
Expand Down
2 changes: 1 addition & 1 deletion ui/helpers/constants/routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,8 @@ const PATH_NAME_MAP = {
[CONFIRM_ADD_SUGGESTED_NFT_ROUTE]: 'Confirm Add Suggested NFT Page',
[CONNECT_HARDWARE_ROUTE]: 'Connect Hardware Wallet Page',
[NOTIFICATIONS_ROUTE]: 'Notifications Page',
[`${NOTIFICATIONS_ROUTE}/:uuid`]: 'Notification Detail Page',
[NOTIFICATIONS_SETTINGS_ROUTE]: 'Notifications Settings Page',
[`${NOTIFICATIONS_ROUTE}/:uuid`]: 'Notification Detail Page',
[`${CONNECT_ROUTE}/:id${CONNECT_SNAPS_CONNECT_ROUTE}`]: 'Snaps Connect Page',
[`${CONNECT_ROUTE}/:id${CONNECT_SNAP_INSTALL_ROUTE}`]: 'Snap Install Page',
[`${CONNECT_ROUTE}/:id${CONNECT_SNAP_UPDATE_ROUTE}`]: 'Snap Update Page',
Expand Down
Loading