Add support for pagination in Chat Search

This commit is contained in:
Chewbacca 2022-12-08 14:37:04 -05:00 committed by Alex Gleason
parent 5998400a75
commit 5a30509fa6
No known key found for this signature in database
GPG Key ID: 7211D1F99744FBB7
7 changed files with 210 additions and 141 deletions

View File

@ -1,11 +1,9 @@
import React from 'react'; import React from 'react';
import { FormattedMessage } from 'react-intl';
import { useHistory } from 'react-router-dom'; import { useHistory } from 'react-router-dom';
import AccountSearch from 'soapbox/components/account-search'; import { CardTitle, HStack, IconButton, Stack } from 'soapbox/components/ui';
import { CardTitle, HStack, IconButton, Stack, Text } from 'soapbox/components/ui';
import { ChatKeys, useChats } from 'soapbox/queries/chats'; import ChatSearch from '../../chat-search/chat-search';
import { queryClient } from 'soapbox/queries/client';
interface IChatPageNew { interface IChatPageNew {
} }
@ -13,17 +11,10 @@ interface IChatPageNew {
/** New message form to create a chat. */ /** New message form to create a chat. */
const ChatPageNew: React.FC<IChatPageNew> = () => { const ChatPageNew: React.FC<IChatPageNew> = () => {
const history = useHistory(); const history = useHistory();
const { getOrCreateChatByAccountId } = useChats();
const handleAccountSelected = async (accountId: string) => {
const { data } = await getOrCreateChatByAccountId(accountId);
history.push(`/chats/${data.id}`);
queryClient.invalidateQueries(ChatKeys.chatSearch());
};
return ( return (
<Stack className='h-full'> <Stack className='h-full space-y-4'>
<Stack className='flex-grow py-6 px-4 sm:p-6 space-y-4'> <Stack className='flex-grow pt-6 px-4 sm:px-6'>
<HStack alignItems='center'> <HStack alignItems='center'>
<IconButton <IconButton
src={require('@tabler/icons/arrow-left.svg')} src={require('@tabler/icons/arrow-left.svg')}
@ -33,26 +24,9 @@ const ChatPageNew: React.FC<IChatPageNew> = () => {
<CardTitle title='New Message' /> <CardTitle title='New Message' />
</HStack> </HStack>
<HStack space={2} alignItems='center'>
<Text>
<FormattedMessage
id='chats.new.to'
defaultMessage='To:'
/>
</Text>
<AccountSearch
onSelected={handleAccountSelected}
placeholder='Type a name'
theme='search'
showButtons={false}
autoFocus
className='mb-0.5'
followers
/>
</HStack>
</Stack> </Stack>
<ChatSearch isMainPage />
</Stack> </Stack>
); );
}; };

View File

@ -13,6 +13,7 @@ import ChatSearch from '../chat-search/chat-search';
import EmptyResultsBlankslate from '../chat-search/empty-results-blankslate'; import EmptyResultsBlankslate from '../chat-search/empty-results-blankslate';
import ChatPaneHeader from '../chat-widget/chat-pane-header'; import ChatPaneHeader from '../chat-widget/chat-pane-header';
import ChatWindow from '../chat-widget/chat-window'; import ChatWindow from '../chat-widget/chat-window';
import ChatSearchHeader from '../chat-widget/headers/chat-search-header';
import { Pane } from '../ui'; import { Pane } from '../ui';
import Blankslate from './blankslate'; import Blankslate from './blankslate';
@ -86,7 +87,13 @@ const ChatPane = () => {
} }
if (screen === ChatWidgetScreens.SEARCH) { if (screen === ChatWidgetScreens.SEARCH) {
return <ChatSearch />; return (
<Pane isOpen={isOpen} index={0} main>
<ChatSearchHeader />
{isOpen ? <ChatSearch /> : null}
</Pane>
);
} }
return ( return (

View File

@ -29,6 +29,7 @@ const ChatSearchInput: React.FC<IChatSearchInput> = ({ value, onChange, onClear
className='rounded-full' className='rounded-full'
value={value} value={value}
onChange={onChange} onChange={onChange}
outerClassName='mt-0'
theme='search' theme='search'
append={ append={
<button onClick={onClear}> <button onClick={onClear}>

View File

@ -1,10 +1,10 @@
import { useMutation } from '@tanstack/react-query'; import { useMutation } from '@tanstack/react-query';
import { AxiosError } from 'axios'; import { AxiosError } from 'axios';
import React, { useState } from 'react'; import React, { useState } from 'react';
import { defineMessages, useIntl } from 'react-intl'; import { useHistory } from 'react-router-dom';
import snackbar from 'soapbox/actions/snackbar'; import snackbar from 'soapbox/actions/snackbar';
import { HStack, Icon, Input, Stack, Text } from 'soapbox/components/ui'; import { Icon, Input, Stack } from 'soapbox/components/ui';
import { ChatWidgetScreens, useChatContext } from 'soapbox/contexts/chat-context'; import { ChatWidgetScreens, useChatContext } from 'soapbox/contexts/chat-context';
import { useAppDispatch, useDebounce } from 'soapbox/hooks'; import { useAppDispatch, useDebounce } from 'soapbox/hooks';
import { useChats } from 'soapbox/queries/chats'; import { useChats } from 'soapbox/queries/chats';
@ -12,29 +12,30 @@ import { queryClient } from 'soapbox/queries/client';
import useAccountSearch from 'soapbox/queries/search'; import useAccountSearch from 'soapbox/queries/search';
import { ChatKeys } from '../../../../queries/chats'; import { ChatKeys } from '../../../../queries/chats';
import ChatPaneHeader from '../chat-widget/chat-pane-header';
import { Pane } from '../ui';
import Blankslate from './blankslate'; import Blankslate from './blankslate';
import EmptyResultsBlankslate from './empty-results-blankslate'; import EmptyResultsBlankslate from './empty-results-blankslate';
import Results from './results'; import Results from './results';
const messages = defineMessages({ interface IChatSearch {
title: { id: 'chat_search.title', defaultMessage: 'Messages' }, isMainPage?: boolean
}); }
const ChatSearch = (props: IChatSearch) => {
const { isMainPage = false } = props;
const ChatSearch = () => {
const debounce = useDebounce; const debounce = useDebounce;
const dispatch = useAppDispatch(); const dispatch = useAppDispatch();
const intl = useIntl(); const history = useHistory();
const { isOpen, changeScreen, toggleChatPane } = useChatContext(); const { changeScreen } = useChatContext();
const { getOrCreateChatByAccountId } = useChats(); const { getOrCreateChatByAccountId } = useChats();
const [value, setValue] = useState<string>(''); const [value, setValue] = useState<string>('');
const debouncedValue = debounce(value as string, 300); const debouncedValue = debounce(value as string, 300);
const { data: accounts, isFetching } = useAccountSearch(debouncedValue); const accountSearchResult = useAccountSearch(debouncedValue);
const { data: accounts, isFetching } = accountSearchResult;
const hasSearchValue = debouncedValue && debouncedValue.length > 0; const hasSearchValue = debouncedValue && debouncedValue.length > 0;
const hasSearchResults = (accounts || []).length > 0; const hasSearchResults = (accounts || []).length > 0;
@ -47,7 +48,12 @@ const ChatSearch = () => {
dispatch(snackbar.error(data?.error)); dispatch(snackbar.error(data?.error));
}, },
onSuccess: (response) => { onSuccess: (response) => {
if (isMainPage) {
history.push(`/chats/${response.data.id}`);
} else {
changeScreen(ChatWidgetScreens.CHAT, response.data.id); changeScreen(ChatWidgetScreens.CHAT, response.data.id);
}
queryClient.invalidateQueries(ChatKeys.chatSearch()); queryClient.invalidateQueries(ChatKeys.chatSearch());
}, },
}); });
@ -56,7 +62,7 @@ const ChatSearch = () => {
if (hasSearchResults) { if (hasSearchResults) {
return ( return (
<Results <Results
accounts={accounts} accountSearchResult={accountSearchResult}
onSelect={(id) => { onSelect={(id) => {
handleClickOnSearchResult.mutate(id); handleClickOnSearchResult.mutate(id);
clearValue(); clearValue();
@ -77,33 +83,6 @@ const ChatSearch = () => {
}; };
return ( return (
<Pane isOpen={isOpen} index={0} main>
<ChatPaneHeader
data-testid='pane-header'
title={
<HStack alignItems='center' space={2}>
<button
onClick={() => {
changeScreen(ChatWidgetScreens.INBOX);
}}
>
<Icon
src={require('@tabler/icons/arrow-left.svg')}
className='h-6 w-6 text-gray-600 dark:text-gray-400'
/>
</button>
<Text size='sm' weight='bold' truncate>
{intl.formatMessage(messages.title)}
</Text>
</HStack>
}
isOpen={isOpen}
isToggleable={false}
onToggle={toggleChatPane}
/>
{isOpen ? (
<Stack space={4} className='flex-grow h-full'> <Stack space={4} className='flex-grow h-full'>
<div className='px-4'> <div className='px-4'>
<Input <Input
@ -111,9 +90,9 @@ const ChatSearch = () => {
type='text' type='text'
autoFocus autoFocus
placeholder='Type a name' placeholder='Type a name'
className='rounded-full'
value={value || ''} value={value || ''}
onChange={(event) => setValue(event.target.value)} onChange={(event) => setValue(event.target.value)}
outerClassName='mt-0'
theme='search' theme='search'
append={ append={
<button onClick={clearValue}> <button onClick={clearValue}>
@ -127,12 +106,10 @@ const ChatSearch = () => {
/> />
</div> </div>
<Stack className='overflow-y-scroll flex-grow h-full' space={2}> <Stack className='flex-grow'>
{renderBody()} {renderBody()}
</Stack> </Stack>
</Stack> </Stack>
) : null}
</Pane>
); );
}; };

View File

@ -1,26 +1,33 @@
import React from 'react'; import classNames from 'clsx';
import React, { useCallback, useState } from 'react';
import { Virtuoso } from 'react-virtuoso';
import { Avatar, HStack, Stack, Text } from 'soapbox/components/ui'; import { Avatar, HStack, Stack, Text } from 'soapbox/components/ui';
import VerificationBadge from 'soapbox/components/verification-badge'; import VerificationBadge from 'soapbox/components/verification-badge';
import useAccountSearch from 'soapbox/queries/search';
interface IResults { interface IResults {
accounts: { accountSearchResult: ReturnType<typeof useAccountSearch>
display_name: string
acct: string
id: string
avatar: string
verified: boolean
}[]
onSelect(id: string): void onSelect(id: string): void
} }
const Results = ({ accounts, onSelect }: IResults) => ( const Results = ({ accountSearchResult, onSelect }: IResults) => {
<> const { data: accounts, isFetching, hasNextPage, fetchNextPage } = accountSearchResult;
{(accounts || []).map((account: any) => (
const [isNearBottom, setNearBottom] = useState<boolean>(false);
const [isNearTop, setNearTop] = useState<boolean>(true);
const handleLoadMore = () => {
if (hasNextPage && !isFetching) {
fetchNextPage();
}
};
const renderAccount = useCallback((_index, account) => (
<button <button
key={account.id} key={account.id}
type='button' type='button'
className='px-4 py-2 w-full flex flex-col hover:bg-gray-100 dark:hover:bg-gray-800' className='px-2 py-3 w-full rounded-lg flex flex-col hover:bg-gray-100 dark:hover:bg-gray-800'
onClick={() => onSelect(account.id)} onClick={() => onSelect(account.id)}
data-testid='account' data-testid='account'
> >
@ -36,8 +43,38 @@ const Results = ({ accounts, onSelect }: IResults) => (
</Stack> </Stack>
</HStack> </HStack>
</button> </button>
))} ), []);
return (
<div className='relative flex-grow'>
<Virtuoso
data={accounts}
itemContent={(index, chat) => (
<div className='px-2'>
{renderAccount(index, chat)}
</div>
)}
endReached={handleLoadMore}
atTopStateChange={(atTop) => setNearTop(atTop)}
atBottomStateChange={(atBottom) => setNearBottom(atBottom)}
/>
<>
<div
className={classNames('inset-x-0 top-0 flex rounded-t-lg justify-center bg-gradient-to-b from-white to-transparent pb-12 pt-8 pointer-events-none dark:from-gray-900 absolute transition-opacity duration-500', {
'opacity-0': isNearTop,
'opacity-100': !isNearTop,
})}
/>
<div
className={classNames('inset-x-0 bottom-0 flex rounded-b-lg justify-center bg-gradient-to-t from-white to-transparent pt-12 pb-8 pointer-events-none dark:from-gray-900 absolute transition-opacity duration-500', {
'opacity-0': isNearBottom,
'opacity-100': !isNearBottom,
})}
/>
</> </>
</div>
); );
};
export default Results; export default Results;

View File

@ -0,0 +1,46 @@
import React from 'react';
import { defineMessages, useIntl } from 'react-intl';
import { HStack, Icon, Text } from 'soapbox/components/ui';
import { ChatWidgetScreens, useChatContext } from 'soapbox/contexts/chat-context';
import ChatPaneHeader from '../chat-pane-header';
const messages = defineMessages({
title: { id: 'chat_search.title', defaultMessage: 'Messages' },
});
const ChatSearchHeader = () => {
const intl = useIntl();
const { changeScreen, isOpen, toggleChatPane } = useChatContext();
return (
<ChatPaneHeader
data-testid='pane-header'
title={
<HStack alignItems='center' space={2}>
<button
onClick={() => {
changeScreen(ChatWidgetScreens.INBOX);
}}
>
<Icon
src={require('@tabler/icons/arrow-left.svg')}
className='h-6 w-6 text-gray-600 dark:text-gray-400'
/>
</button>
<Text size='sm' weight='bold' truncate>
{intl.formatMessage(messages.title)}
</Text>
</HStack>
}
isOpen={isOpen}
isToggleable={false}
onToggle={toggleChatPane}
/>
);
};
export default ChatSearchHeader;

View File

@ -1,27 +1,54 @@
import { useQuery } from '@tanstack/react-query'; import { useInfiniteQuery } from '@tanstack/react-query';
import { getNextLink } from 'soapbox/api';
import { useApi } from 'soapbox/hooks'; import { useApi } from 'soapbox/hooks';
import { Account } from 'soapbox/types/entities';
import { PaginatedResult } from 'soapbox/utils/queries';
export default function useAccountSearch(q: string) { export default function useAccountSearch(q: string) {
const api = useApi(); const api = useApi();
const getAccountSearch = async(q: string) => { const getAccountSearch = async(q: string, pageParam: { link?: string }): Promise<PaginatedResult<Account>> => {
if (typeof q === 'undefined') { const nextPageLink = pageParam?.link;
return null; const uri = nextPageLink || '/api/v1/accounts/search';
}
const { data } = await api.get('/api/v1/accounts/search', { const response = await api.get(uri, {
params: { params: {
q, q,
limit: 10,
followers: true, followers: true,
}, },
}); });
const { data } = response;
return data; const link = getNextLink(response);
const hasMore = !!link;
return {
result: data,
link,
hasMore,
};
}; };
return useQuery(['search', 'accounts', q], () => getAccountSearch(q), { const queryInfo = useInfiniteQuery(['search', 'accounts', q], ({ pageParam }) => getAccountSearch(q, pageParam), {
keepPreviousData: true, keepPreviousData: true,
placeholderData: [], getNextPageParam: (config) => {
}); if (config.hasMore) {
return { link: config.link };
}
return undefined;
},
});
const data = queryInfo.data?.pages.reduce<Account[]>(
(prev: Account[], curr) => [...prev, ...curr.result],
[],
);
return {
...queryInfo,
data,
};
} }