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

Revert "Reapply "farrah/integrate buildship" (#399) (#403)" #404

Merged
merged 1 commit into from
Nov 14, 2024
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
16 changes: 12 additions & 4 deletions src/components/AppHeader/Notifications/Notifications.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { useMemo, useState } from 'react';
import { useEffect, useMemo, useState } from 'react';
import { useHistory } from 'react-router-dom';
import { getNotification, MY_PROFILE_URL } from '@/constants';
import { api } from '@/hooks';
Expand All @@ -10,8 +10,9 @@
const [isOpen, setIsOpen] = useState(false);
const { localize } = useTranslations();
const { isDesktop, isMobile } = useDevice();
const { data: notifications } = api.notification.useGetList();
const { readAllNotifications } = api.notification.useUpdate();
const { data: activeAccountData } = api.account.useActiveAccount();
const { data: notifications, subscribe } = api.notification.useGetList();
const { mutate: updateNotification } = api.notification.useUpdate();
const history = useHistory();

const modifiedNotifications = useMemo(() => {
Expand All @@ -35,8 +36,15 @@
title,
};
});
}, [notifications]);

Check warning on line 39 in src/components/AppHeader/Notifications/Notifications.tsx

View workflow job for this annotation

GitHub Actions / build_to_cloudflare_pages

React Hook useMemo has missing dependencies: 'history', 'isDesktop', and 'localize'. Either include them or remove the dependency array

useEffect(() => {
if (activeAccountData) {
subscribe({});
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [activeAccountData]);

return (
<>
<Tooltip
Expand Down Expand Up @@ -67,7 +75,7 @@
<UINotifications
className={isMobile ? '' : 'absolute top-20 right-80 z-10 w-[26.4rem]'}
clearNotificationsCallback={() => {
readAllNotifications();
updateNotification({ ids: [], notifications_update_status: 'remove' });
}}
componentConfig={{
clearButtonText: localize('Clear all'),
Expand Down
4 changes: 2 additions & 2 deletions src/components/Modals/DailyLimitModal/DailyLimitModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ type TDailyLimitModalProps = {

const DailyLimitModal = ({ currency, isModalOpen, onRequestClose }: TDailyLimitModalProps) => {
const { data, error, isPending: isLoading, isSuccess, mutate } = api.advertiser.useUpdate();
const { readAllNotifications } = api.notification.useUpdate();
const { mutate: updateNotification } = api.notification.useUpdate();
const { daily_buy_limit: dailyBuyLimit, daily_sell_limit: dailySellLimit } = data ?? {};
const { isDesktop } = useDevice();
const textSize = isDesktop ? 'sm' : 'md';
Expand Down Expand Up @@ -40,7 +40,7 @@ const DailyLimitModal = ({ currency, isModalOpen, onRequestClose }: TDailyLimitM
mutate({ upgrade_limits: 1 });

//TODO: Remove this once implemented in BE
readAllNotifications();
updateNotification({ ids: [], notifications_update_status: 'remove' });
}}
size='lg'
textSize={textSize}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jest.mock('@/hooks', () => ({
useUpdate: jest.fn(() => mockUseAdvertiserUpdate),
},
notification: {
useUpdate: jest.fn(() => ({ readAllNotifications: jest.fn() })),
useUpdate: jest.fn(() => ({ mutate: jest.fn() })),
},
},
}));
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { renderHook } from '@testing-library/react';
import useNotificationList from '../useNotificationList';

const mockNotificationListData = {
data: {
notifications_list: {
messages: [
{
category: 'see',
id: 1,
message_key: 'p2p-limit-upgrade-available',
},
{
category: 'see',
id: 2,
message_key: 'poi-verified',
},
],
},
},
};

jest.mock('@deriv-com/api-hooks', () => ({
useSubscribe: jest.fn(() => mockNotificationListData),
}));

describe('useNotificationList', () => {
it('should return the list of p2p-related notifications', () => {
const { result } = renderHook(() => useNotificationList());

expect(result.current.data).toEqual([
{
category: 'see',
id: 1,
message_key: 'p2p-limit-upgrade-available',
},
]);
});
});
84 changes: 50 additions & 34 deletions src/hooks/api/notification/useNotificationList.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { useEffect, useState } from 'react';
import { useEffect, useMemo, useState } from 'react';
import { useSubscribe } from '@deriv-com/api-hooks';

type TNotificationLinks = {
href: string;
Expand All @@ -7,54 +8,69 @@ type TNotificationLinks = {
type TNotification = {
category: string;
id: number;
links?: TNotificationLinks[];
links: TNotificationLinks[];
message_key: string;
payload: string;
read: boolean;
removed: boolean;
};

const handleData = (incomingMessages: TNotification[], prevMessages: TNotification[]) => {
if (!incomingMessages) return prevMessages;

let notifications = prevMessages;
for (let updateIdx = 0; updateIdx < incomingMessages.length; updateIdx++) {
const update = incomingMessages[updateIdx];

const existingMessageIndex = notifications.findIndex((message: TNotification) => message.id === update.id);
const existingMessage = notifications[existingMessageIndex];

if (existingMessage) {
if (update.removed)
notifications = notifications.filter((message: TNotification) => message.id !== update.id);
else notifications[existingMessageIndex] = { ...existingMessage, ...update };
} else notifications.unshift(update);
}

notifications.sort((a: TNotification, b: TNotification) => b.id - a.id);

return [...notifications];
};

/**
* Hook that returns the list of notifications.
*
* @example const { data: notifications } = useNotificationList();
*/
const useNotificationList = () => {
const [notifications, setNotifications] = useState<TNotification[]>([]);
// @ts-expect-error Type undefined. This endpoint will be added to api-hooks.
const { data, ...rest } = useSubscribe('notifications_list');
const [messages, setMessages] = useState<TNotification[]>([]);

const modified_data = useMemo(() => {
if (!messages) return undefined;

// TODO: Remove this filter once all the notifications are implemented
const notifications = messages.filter((notification: { message_key: string }) =>
['p2p-limit-upgrade-available'].includes(notification.message_key)
);

return notifications;
}, [messages]);

useEffect(() => {
const fetchNotifications = async () => {
try {
const response = await fetch('https://fs191x.buildship.run/v4/notification/list', {
headers: {
'Content-Type': 'application/json',
token: localStorage.getItem('authToken') || '',
},
method: 'GET',
});

if (response.ok) {
const data = await response.json();

// TODO: Remove this filter once all the notifications are implemented
const messages = data.filter((notification: { message_key: string }) =>
['p2p-limit-upgrade-available'].includes(notification.message_key)
);
setNotifications(messages);
} else {
// eslint-disable-next-line no-console
console.error('Failed to fetch notifications');
}
} catch (error) {
// eslint-disable-next-line no-console
console.error(error);
}
};

fetchNotifications();
}, []);
// @ts-expect-error Type undefined.
if (data?.notifications_list) {
setMessages(prevMessages => {
// @ts-expect-error Type undefined.
return handleData(data.notifications_list.messages, prevMessages);
});
}
}, [data]);

return {
data: notifications || [],
data: modified_data || [],
...rest,
};
};

Expand Down
32 changes: 15 additions & 17 deletions src/hooks/api/notification/useNotificationUpdate.ts
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
import { useMutation } from '@deriv-com/api-hooks';

/**
* Hook that updates the status of a notification. The notification can be removed or marked as read or unread.
*
* @example
* const { data, mutate } = useNotificationUpdate();
* mutate({ notifications_update_status: 'read', ids: [notification_id]});
* mutate({ notifications_update_status: 'unread', ids: [notification_id]});
* mutate({ notifications_update_status: 'remove', ids: []});
*/
const useNotificationUpdate = () => {
const readAllNotifications = async () => {
try {
await fetch('https://fs191x.buildship.run/v4/notification/read', {
body: JSON.stringify({
authorize: localStorage.getItem('authToken'),
}),
headers: {
'Content-Type': 'application/json',
},
method: 'POST',
});
} catch (error) {
// eslint-disable-next-line no-console
console.error(error);
}
};
const { data, ...rest } = useMutation({
// @ts-expect-error Type undefined. This endpoint will be added to api-hooks.
name: 'notifications_update_status',
});

return {
readAllNotifications,
// @ts-expect-error Type undefined.
data: data?.notifications_update_status,
...rest,
};
};

Expand Down
Loading