Build infinite scroll for email threads (#3666)

* Use recoil state for page info

* Remove memoization

* Remove right drawer fetch more loader

---------

Co-authored-by: Thomas Trompette <thomast@twenty.com>
This commit is contained in:
Thomas Trompette
2024-01-29 15:28:28 +01:00
committed by GitHub
parent a58b4cf437
commit 9da9d1e3bd
5 changed files with 89 additions and 52 deletions

View File

@ -1,11 +1,16 @@
import { useState } from 'react';
import { useQuery } from '@apollo/client'; import { useQuery } from '@apollo/client';
import styled from '@emotion/styled'; import styled from '@emotion/styled';
import { useRecoilState } from 'recoil';
import { EmailThreadPreview } from '@/activities/emails/components/EmailThreadPreview'; import { EmailThreadPreview } from '@/activities/emails/components/EmailThreadPreview';
import { TIMELINE_THREADS_DEFAULT_PAGE_SIZE } from '@/activities/emails/constants/messaging.constants';
import { useEmailThread } from '@/activities/emails/hooks/useEmailThread'; import { useEmailThread } from '@/activities/emails/hooks/useEmailThread';
import { getTimelineThreadsFromCompanyId } from '@/activities/emails/queries/getTimelineThreadsFromCompanyId'; import { getTimelineThreadsFromCompanyId } from '@/activities/emails/queries/getTimelineThreadsFromCompanyId';
import { getTimelineThreadsFromPersonId } from '@/activities/emails/queries/getTimelineThreadsFromPersonId'; import { getTimelineThreadsFromPersonId } from '@/activities/emails/queries/getTimelineThreadsFromPersonId';
import {
emailThreadsPageState,
EmailThreadsPageType,
} from '@/activities/emails/state/emailThreadsPageState';
import { ActivityTargetableObject } from '@/activities/types/ActivityTargetableEntity'; import { ActivityTargetableObject } from '@/activities/types/ActivityTargetableEntity';
import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular'; import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular';
import { import {
@ -15,13 +20,19 @@ import {
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar'; import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
import { Card } from '@/ui/layout/card/components/Card'; import { Card } from '@/ui/layout/card/components/Card';
import { Section } from '@/ui/layout/section/components/Section'; import { Section } from '@/ui/layout/section/components/Section';
import { TimelineThread } from '~/generated/graphql'; import { FetchMoreLoader } from '@/ui/utilities/loading-state/components/FetchMoreLoader';
import {
GetTimelineThreadsFromPersonIdQueryVariables,
TimelineThread,
} from '~/generated/graphql';
const StyledContainer = styled.div` const StyledContainer = styled.div`
display: flex; display: flex;
flex-direction: column; flex-direction: column;
gap: ${({ theme }) => theme.spacing(6)}; gap: ${({ theme }) => theme.spacing(6)};
padding: ${({ theme }) => theme.spacing(6, 6, 2)}; padding: ${({ theme }) => theme.spacing(6, 6, 2)};
height: 100%;
overflow: auto;
`; `;
const StyledH1Title = styled(H1Title)` const StyledH1Title = styled(H1Title)`
@ -39,42 +50,75 @@ export const EmailThreads = ({
entity: ActivityTargetableObject; entity: ActivityTargetableObject;
}) => { }) => {
const { openEmailThread } = useEmailThread(); const { openEmailThread } = useEmailThread();
const { enqueueSnackBar } = useSnackBar(); const { enqueueSnackBar } = useSnackBar();
const threadQuery = const [emailThreadsPage, setEmailThreadsPage] =
useRecoilState<EmailThreadsPageType>(emailThreadsPageState);
const [isFetchingMoreEmails, setIsFetchingMoreEmails] = useState(false);
const [threadQuery, queryName] =
entity.targetObjectNameSingular === CoreObjectNameSingular.Person entity.targetObjectNameSingular === CoreObjectNameSingular.Person
? getTimelineThreadsFromPersonId ? [getTimelineThreadsFromPersonId, 'getTimelineThreadsFromPersonId']
: getTimelineThreadsFromCompanyId; : [getTimelineThreadsFromCompanyId, 'getTimelineThreadsFromCompanyId'];
const threadQueryVariables = { const threadQueryVariables = {
...(entity.targetObjectNameSingular === CoreObjectNameSingular.Person ...(entity.targetObjectNameSingular === CoreObjectNameSingular.Person
? { personId: entity.id } ? { personId: entity.id }
: { companyId: entity.id }), : { companyId: entity.id }),
page: 1, page: 1,
pageSize: TIMELINE_THREADS_DEFAULT_PAGE_SIZE, pageSize: 10,
}; } as GetTimelineThreadsFromPersonIdQueryVariables;
const threads = useQuery(threadQuery, { const { data, loading, fetchMore, error } = useQuery(threadQuery, {
variables: threadQueryVariables, variables: threadQueryVariables,
}); });
if (threads.error) { const fetchMoreRecords = async () => {
enqueueSnackBar(threads.error.message || 'Error loading email threads', { if (emailThreadsPage.hasNextPage && !isFetchingMoreEmails) {
setIsFetchingMoreEmails(true);
await fetchMore({
variables: {
...threadQueryVariables,
page: emailThreadsPage.pageNumber + 1,
},
updateQuery: (prev, { fetchMoreResult }) => {
if (!fetchMoreResult || !fetchMoreResult?.[queryName].length) {
setEmailThreadsPage((emailThreadsPage) => ({
...emailThreadsPage,
hasNextPage: false,
}));
return prev;
}
return {
[queryName]: [
...(prev?.[queryName] ?? []),
...(fetchMoreResult?.[queryName] ?? []),
],
};
},
});
setEmailThreadsPage((emailThreadsPage) => ({
...emailThreadsPage,
pageNumber: emailThreadsPage.pageNumber + 1,
}));
setIsFetchingMoreEmails(false);
}
};
if (error) {
enqueueSnackBar(error.message || 'Error loading email threads', {
variant: 'error', variant: 'error',
}); });
} }
if (threads.loading) { if (loading) {
return; return;
} }
const timelineThreads: TimelineThread[] = const timelineThreads: TimelineThread[] = data?.[queryName] ?? [];
threads?.data?.[
entity.targetObjectNameSingular === CoreObjectNameSingular.Person
? 'getTimelineThreadsFromPersonId'
: 'getTimelineThreadsFromCompanyId'
] ?? [];
return ( return (
<StyledContainer> <StyledContainer>
@ -98,6 +142,10 @@ export const EmailThreads = ({
/> />
))} ))}
</Card> </Card>
<FetchMoreLoader
loading={isFetchingMoreEmails}
onLastRowVisible={fetchMoreRecords}
/>
</Section> </Section>
</StyledContainer> </StyledContainer>
); );

View File

@ -1,14 +1,14 @@
import React from 'react'; import React, { useCallback } from 'react';
import styled from '@emotion/styled'; import styled from '@emotion/styled';
import { useRecoilValue } from 'recoil'; import { useRecoilValue } from 'recoil';
import { EmailThreadHeader } from '@/activities/emails/components/EmailThreadHeader'; import { EmailThreadHeader } from '@/activities/emails/components/EmailThreadHeader';
import { EmailThreadMessage } from '@/activities/emails/components/EmailThreadMessage'; import { EmailThreadMessage } from '@/activities/emails/components/EmailThreadMessage';
import { RightDrawerEmailThreadFetchMoreLoader } from '@/activities/emails/right-drawer/components/RightDrawerEmailThreadFetchMoreLoader';
import { viewableEmailThreadState } from '@/activities/emails/state/viewableEmailThreadState'; import { viewableEmailThreadState } from '@/activities/emails/state/viewableEmailThreadState';
import { EmailThreadMessage as EmailThreadMessageType } from '@/activities/emails/types/EmailThreadMessage'; import { EmailThreadMessage as EmailThreadMessageType } from '@/activities/emails/types/EmailThreadMessage';
import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular'; import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular';
import { useFindManyRecords } from '@/object-record/hooks/useFindManyRecords'; import { useFindManyRecords } from '@/object-record/hooks/useFindManyRecords';
import { FetchMoreLoader } from '@/ui/utilities/loading-state/components/FetchMoreLoader';
const StyledContainer = styled.div` const StyledContainer = styled.div`
box-sizing: border-box; box-sizing: border-box;
@ -26,9 +26,10 @@ export const RightDrawerEmailThread = () => {
const { const {
records: messages, records: messages,
loading, loading,
fetchMoreRecords: fetchMoreMessages, fetchMoreRecords,
} = useFindManyRecords<EmailThreadMessageType>({ } = useFindManyRecords<EmailThreadMessageType>({
depth: 3, depth: 3,
limit: 10,
filter: { filter: {
messageThreadId: { messageThreadId: {
eq: viewableEmailThread?.id, eq: viewableEmailThread?.id,
@ -42,6 +43,12 @@ export const RightDrawerEmailThread = () => {
useRecordsWithoutConnection: true, useRecordsWithoutConnection: true,
}); });
const fetchMoreMessages = useCallback(() => {
if (!loading) {
fetchMoreRecords();
}
}, [fetchMoreRecords, loading]);
if (!viewableEmailThread) { if (!viewableEmailThread) {
return null; return null;
} }
@ -60,10 +67,7 @@ export const RightDrawerEmailThread = () => {
sentAt={message.receivedAt} sentAt={message.receivedAt}
/> />
))} ))}
<RightDrawerEmailThreadFetchMoreLoader <FetchMoreLoader loading={loading} onLastRowVisible={fetchMoreMessages} />
loading={loading}
fetchMoreMessages={fetchMoreMessages}
/>
</StyledContainer> </StyledContainer>
); );
}; };

View File

@ -1,26 +0,0 @@
import { useRecoilCallback } from 'recoil';
import { FetchMoreLoader } from '@/ui/utilities/loading-state/components/FetchMoreLoader';
type RightDrawerEmailThreadFetchMoreLoaderProps = {
loading: boolean;
fetchMoreMessages: () => void;
};
export const RightDrawerEmailThreadFetchMoreLoader = ({
loading,
fetchMoreMessages,
}: RightDrawerEmailThreadFetchMoreLoaderProps) => {
const onLastRowVisible = useRecoilCallback(
() => async () => {
if (!loading) {
fetchMoreMessages();
}
},
[fetchMoreMessages, loading],
);
return (
<FetchMoreLoader loading={loading} onLastRowVisible={onLastRowVisible} />
);
};

View File

@ -0,0 +1,11 @@
import { atom } from 'recoil';
export type EmailThreadsPageType = {
pageNumber: number;
hasNextPage: boolean;
};
export const emailThreadsPageState = atom<EmailThreadsPageType>({
key: 'EmailThreadsPageState',
default: { pageNumber: 1, hasNextPage: true },
});