admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Favorite folders (#7998)

Browse Source 
closes - #5755

---------

Co-authored-by: martmull <martmull@hotmail.fr>
Co-authored-by: Lucas Bordeau <bordeau.lucas@gmail.com>
Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
nitin
2024-11-18 19:52:19 +05:30
committed by GitHub
parent 5115022355
commit 0125d58ba8
100 changed files with 24033 additions and 21488 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/twenty-front/src/modules/prefetch/components/PrefetchDataProvider.tsx
View File

@ -1,11 +1,17 @@
import React from 'react';
import { PrefetchFavoriteFoldersRunQueriesEffect } from '@/prefetch/components/PrefetchFavortiteFoldersRunQueriesEffect';
import { PrefetchRunQueriesEffect } from '@/prefetch/components/PrefetchRunQueriesEffect';
import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
export const PrefetchDataProvider = ({ children }: React.PropsWithChildren) => {
const isFavoriteFolderEnabled = useIsFeatureEnabled(
'IS_FAVORITE_FOLDER_ENABLED',
);
return (
<>
<PrefetchRunQueriesEffect />
{isFavoriteFolderEnabled && <PrefetchFavoriteFoldersRunQueriesEffect />}
{children}
</>
);

45
packages/twenty-front/src/modules/prefetch/components/PrefetchFavortiteFoldersRunQueriesEffect.tsx Normal file
View File

@ -0,0 +1,45 @@
import { currentUserState } from '@/auth/states/currentUserState';
import { FavoriteFolder } from '@/favorites/types/FavoriteFolder';
import { useObjectMetadataItems } from '@/object-metadata/hooks/useObjectMetadataItems';
import { useCombinedFindManyRecords } from '@/object-record/multiple-objects/hooks/useCombinedFindManyRecords';
import { PREFETCH_CONFIG } from '@/prefetch/constants/PrefetchConfig';
import { usePrefetchRunQuery } from '@/prefetch/hooks/internal/usePrefetchRunQuery';
import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
import { useEffect } from 'react';
import { useRecoilValue } from 'recoil';
import { isDefined } from '~/utils/isDefined';
export const PrefetchFavoriteFoldersRunQueriesEffect = () => {
const currentUser = useRecoilValue(currentUserState);
const { upsertRecordsInCache: upsertFavoritesFoldersInCache } =
usePrefetchRunQuery<FavoriteFolder>({
prefetchKey: PrefetchKey.AllFavoritesFolders,
});
const { objectMetadataItems } = useObjectMetadataItems();
// Only include favorite folders operation
const operationSignatures = Object.values(PREFETCH_CONFIG)
.filter(({ objectNameSingular }) => objectNameSingular === 'favoriteFolder')
.map(({ objectNameSingular, operationSignatureFactory }) => {
const objectMetadataItem = objectMetadataItems.find(
(item) => item.nameSingular === objectNameSingular,
);
return operationSignatureFactory({ objectMetadataItem });
});
const { result } = useCombinedFindManyRecords({
operationSignatures,
skip: !currentUser,
});
useEffect(() => {
if (isDefined(result.favoriteFolders)) {
upsertFavoritesFoldersInCache(result.favoriteFolders as FavoriteFolder[]);
}
}, [result, upsertFavoritesFoldersInCache]);
return null;
};

23
packages/twenty-front/src/modules/prefetch/components/PrefetchRunQueriesEffect.tsx
View File

@ -9,10 +9,14 @@ import { PREFETCH_CONFIG } from '@/prefetch/constants/PrefetchConfig';
import { usePrefetchRunQuery } from '@/prefetch/hooks/internal/usePrefetchRunQuery';
import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
import { View } from '@/views/types/View';
import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
import { isDefined } from '~/utils/isDefined';
export const PrefetchRunQueriesEffect = () => {
const currentUser = useRecoilValue(currentUserState);
const isFavoriteFolderEnabled = useIsFeatureEnabled(
'IS_FAVORITE_FOLDER_ENABLED',
);
const { upsertRecordsInCache: upsertViewsInCache } =
usePrefetchRunQuery<View>({
@ -26,15 +30,19 @@ export const PrefetchRunQueriesEffect = () => {
const { objectMetadataItems } = useObjectMetadataItems();
const operationSignatures = Object.values(PREFETCH_CONFIG).map(
({ objectNameSingular, operationSignatureFactory }) => {
const operationSignatures = Object.values(PREFETCH_CONFIG)
.filter(
({ objectNameSingular }) =>
// Exclude favorite folders as they're handled separately
objectNameSingular !== 'favoriteFolder',
)
.map(({ objectNameSingular, operationSignatureFactory }) => {
const objectMetadataItem = objectMetadataItems.find(
(item) => item.nameSingular === objectNameSingular,
);
return operationSignatureFactory({ objectMetadataItem });
},
);
});
const { result } = useCombinedFindManyRecords({
operationSignatures,
@ -49,7 +57,12 @@ export const PrefetchRunQueriesEffect = () => {
if (isDefined(result.favorites)) {
upsertFavoritesInCache(result.favorites as Favorite[]);
}
}, [result, upsertViewsInCache, upsertFavoritesInCache]);
}, [
result,
upsertViewsInCache,
upsertFavoritesInCache,
isFavoriteFolderEnabled,
]);
return <></>;
};

5
packages/twenty-front/src/modules/prefetch/constants/PrefetchConfig.ts
View File

@ -1,5 +1,6 @@
import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular';
import { RecordGqlOperationSignatureFactory } from '@/object-record/graphql/types/RecordGqlOperationSignatureFactory';
import { findAllFavoritesFolderOperationSignatureFactory } from '@/prefetch/graphql/operation-signatures/factories/findAllFavoritesFolderOperationSignatureFactory';
import { findAllFavoritesOperationSignatureFactory } from '@/prefetch/graphql/operation-signatures/factories/findAllFavoritesOperationSignatureFactory';
import { findAllViewsOperationSignatureFactory } from '@/prefetch/graphql/operation-signatures/factories/findAllViewsOperationSignatureFactory';
import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
@ -19,4 +20,8 @@ export const PREFETCH_CONFIG: Record<
objectNameSingular: CoreObjectNameSingular.Favorite,
operationSignatureFactory: findAllFavoritesOperationSignatureFactory,
},
ALL_FAVORITES_FOLDERS: {
objectNameSingular: CoreObjectNameSingular.FavoriteFolder,
operationSignatureFactory: findAllFavoritesFolderOperationSignatureFactory,
},
};

17
packages/twenty-front/src/modules/prefetch/graphql/operation-signatures/factories/findAllFavoritesFolderOperationSignatureFactory.ts Normal file
View File

@ -0,0 +1,17 @@
import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular';
import { RecordGqlOperationSignatureFactory } from '@/object-record/graphql/types/RecordGqlOperationSignatureFactory';
export const findAllFavoritesFolderOperationSignatureFactory: RecordGqlOperationSignatureFactory =
() => ({
objectNameSingular: CoreObjectNameSingular.FavoriteFolder,
variables: {},
fields: {
id: true,
position: true,
createdAt: true,
updatedAt: true,
deletedAt: true,
name: true,
icon: true,
},
});

11
packages/twenty-front/src/modules/prefetch/hooks/useIsFavoriteFoldersPrefetchLoading.ts Normal file
View File

@ -0,0 +1,11 @@
import { prefetchIsLoadedFamilyState } from '@/prefetch/states/prefetchIsLoadedFamilyState';
import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
import { useRecoilValue } from 'recoil';
export const useIsFavoriteFoldersPrefetchLoading = () => {
const areFavoritesFolderPrefetched = useRecoilValue(
prefetchIsLoadedFamilyState(PrefetchKey.AllFavoritesFolders),
);
return !areFavoritesFolderPrefetched;
};

17
packages/twenty-front/src/modules/prefetch/hooks/useIsPrefetchLoading.ts
View File

@ -1,14 +1,25 @@
import { useRecoilValue } from 'recoil';
import { prefetchIsLoadedFamilyState } from '@/prefetch/states/prefetchIsLoadedFamilyState';
import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
import { useRecoilValue } from 'recoil';
import { useIsFavoriteFoldersPrefetchLoading } from './useIsFavoriteFoldersPrefetchLoading';
export const useIsPrefetchLoading = () => {
const isFavoriteFolderEnabled = useIsFeatureEnabled(
'IS_FAVORITE_FOLDER_ENABLED',
);
const isFavoriteFoldersLoading = useIsFavoriteFoldersPrefetchLoading();
const areViewsPrefetched = useRecoilValue(
prefetchIsLoadedFamilyState(PrefetchKey.AllViews),
);
const areFavoritesPrefetched = useRecoilValue(
prefetchIsLoadedFamilyState(PrefetchKey.AllFavorites),
);
return !areViewsPrefetched || !areFavoritesPrefetched;
return (
!areViewsPrefetched ||
!areFavoritesPrefetched ||
(isFavoriteFolderEnabled && isFavoriteFoldersLoading)
);
};

1
packages/twenty-front/src/modules/prefetch/types/PrefetchKey.ts
View File

@ -1,4 +1,5 @@
export enum PrefetchKey {
AllViews = 'ALL_VIEWS',
AllFavorites = 'ALL_FAVORITES',
AllFavoritesFolders = 'ALL_FAVORITES_FOLDERS',
}