Use v2 suggestions endpoint for Onboarding

environments/review-onboarding-7mbd0c/deployments/739
Justin 2 years ago
parent 9541bedc05
commit ae0fd07580

@ -1,49 +1,43 @@
import debounce from 'lodash/debounce';
import * as React from 'react';
import { FormattedMessage } from 'react-intl';
import { useDispatch } from 'react-redux';
import { fetchSuggestions } from 'soapbox/actions/suggestions';
import ScrollableList from 'soapbox/components/scrollable_list';
import { Button, Card, CardBody, Stack, Text } from 'soapbox/components/ui';
import AccountContainer from 'soapbox/containers/account_container';
import { useAppSelector } from 'soapbox/hooks';
import useOnboardingSuggestions from 'soapbox/queries/suggestions';
const SuggestedAccountsStep = ({ onNext }: { onNext: () => void }) => {
const dispatch = useDispatch();
const { data, fetchNextPage, hasNextPage, isFetching } = useOnboardingSuggestions();
const suggestions = useAppSelector((state) => state.suggestions.items);
const hasMore = useAppSelector((state) => !!state.suggestions.next);
const isLoading = useAppSelector((state) => state.suggestions.isLoading);
const handleLoadMore = debounce(() => {
if (isLoading) {
if (isFetching) {
return null;
}
return dispatch(fetchSuggestions());
return fetchNextPage();
}, 300);
React.useEffect(() => {
dispatch(fetchSuggestions({ limit: 20 }));
}, []);
const renderSuggestions = () => {
if (!data) {
return null;
}
return (
<div className='sm:pt-4 sm:pb-10 flex flex-col'>
<ScrollableList
isLoading={isLoading}
isLoading={isFetching}
scrollKey='suggestions'
onLoadMore={handleLoadMore}
hasMore={hasMore}
hasMore={hasNextPage}
useWindowScroll={false}
style={{ height: 320 }}
>
{suggestions.map((suggestion) => (
<div key={suggestion.account} className='py-2'>
{data.map((suggestion) => (
<div key={suggestion.account.id} className='py-2'>
<AccountContainer
// @ts-ignore: TS thinks `id` is passed to <Account>, but it isn't
id={suggestion.account}
id={suggestion.account.id}
showProfileHoverCard={false}
withLinkToProfile={false}
/>
@ -65,7 +59,7 @@ const SuggestedAccountsStep = ({ onNext }: { onNext: () => void }) => {
};
const renderBody = () => {
if (suggestions.isEmpty()) {
if (!data || data.length === 0) {
return renderEmpty();
} else {
return renderSuggestions();

@ -0,0 +1,45 @@
import { renderHook } from '@testing-library/react-hooks';
import { mock, queryWrapper, waitFor } from 'soapbox/jest/test-helpers';
import useOnboardingSuggestions from '../suggestions';
describe('useCarouselAvatars', () => {
describe('with a successul query', () => {
beforeEach(() => {
mock.onGet('/api/v2/suggestions')
.reply(200, [
{ source: 'staff', account: { id: '1', acct: 'a', account_avatar: 'https://example.com/some.jpg' } },
{ source: 'staff', account: { id: '2', acct: 'b', account_avatar: 'https://example.com/some.jpg' } },
], {
link: '<https://example.com/api/v2/suggestions?since_id=1>; rel=\'prev\'',
});
});
it('is successful', async() => {
const { result } = renderHook(() => useOnboardingSuggestions(), {
wrapper: queryWrapper,
});
await waitFor(() => expect(result.current.isFetching).toBe(false));
expect(result.current.data?.length).toBe(2);
});
});
describe('with an unsuccessul query', () => {
beforeEach(() => {
mock.onGet('/api/v2/suggestions').networkError();
});
it('is successful', async() => {
const { result } = renderHook(() => useOnboardingSuggestions(), {
wrapper: queryWrapper,
});
await waitFor(() => expect(result.current.isFetching).toBe(false));
expect(result.current.error).toBeDefined();
});
});
});

@ -0,0 +1,82 @@
import { useInfiniteQuery } from '@tanstack/react-query';
import { fetchRelationships } from 'soapbox/actions/accounts';
import { importFetchedAccounts } from 'soapbox/actions/importer';
import { getLinks } from 'soapbox/api';
import { useAppDispatch } from 'soapbox/hooks';
import API from 'soapbox/queries/client';
type Account = {
acct: string
avatar: string
avatar_static: string
bot: boolean
created_at: string
discoverable: boolean
display_name: string
followers_count: number
following_count: number
group: boolean
header: string
header_static: string
id: string
last_status_at: string
location: string
locked: boolean
note: string
statuses_count: number
url: string
username: string
verified: boolean
website: string
}
type Suggestion = {
source: 'staff'
account: Account
}
const getV2Suggestions = async(dispatch: any, pageParam: any): Promise<{ data: Suggestion[], link: string | null, hasMore: boolean }> => {
return dispatch(async() => {
const link = pageParam?.link || '/api/v2/suggestions';
const response = await API.get<Suggestion[]>(link);
const hasMore = !!response.headers.link;
const nextLink = getLinks(response).refs.find(link => link.rel === 'next')?.uri;
const accounts = response.data.map(({ account }) => account);
const accountIds = accounts.map((account) => account.id);
dispatch(importFetchedAccounts(accounts));
dispatch(fetchRelationships(accountIds));
return {
data: response.data,
link: nextLink,
hasMore,
};
});
};
export default function useOnboardingSuggestions() {
const dispatch = useAppDispatch();
const result = useInfiniteQuery(['suggestions', 'v2'], ({ pageParam }) => getV2Suggestions(dispatch, pageParam), {
keepPreviousData: true,
getNextPageParam: (config) => {
if (config.hasMore) {
return { link: config.link };
}
return undefined;
},
});
const data = result.data?.pages.reduce<Suggestion[]>(
(prev: Suggestion[], curr) => [...prev, ...curr.data],
[],
);
return {
...result,
data,
};
}
Loading…
Cancel
Save