Favorite folders (#7998)

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>

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

@@ -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}
     </>
   );

packages/twenty-front/src/modules/prefetch/components/PrefetchFavortiteFoldersRunQueriesEffect.tsx

@@ -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;
+};

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

@@ -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 <></>;
 };