Add opened section (twentyhq#7265)

When object is not part of the workspace favorite list, we want to show it in the "opened section" while its record page is accessed. This PR: - adds a new component `NavigationDrawerOpenedSection` - makes workflow versions and runs not system object + creates a prefilled view index for these - do not create workspace favorites for these so these do not appear in the workspace section <img width="1129" alt="Capture d’écran 2024-09-26 à 11 45 25" src="https://github.com/user-attachments/assets/c84d773c-0bef-4dce-b66a-55d7d00b0fb6">
harshit078 · Oct 14, 2024 · 22f0fb3 · 22f0fb3
1 parent 4171cbe
commit 22f0fb3
Show file tree

Hide file tree

Showing 25 changed files with 310 additions and 94 deletions.
diff --git a/packages/twenty-front/src/modules/favorites/components/WorkspaceFavorites.tsx b/packages/twenty-front/src/modules/favorites/components/WorkspaceFavorites.tsx
@@ -1,42 +1,25 @@
-import { useFavorites } from '@/favorites/hooks/useFavorites';
+import { useFilteredObjectMetadataItemsForWorkspaceFavorites } from '@/navigation/hooks/useObjectMetadataItemsInWorkspaceFavorites';
 import { NavigationDrawerSectionForObjectMetadataItems } from '@/object-metadata/components/NavigationDrawerSectionForObjectMetadataItems';
 import { NavigationDrawerSectionForObjectMetadataItemsSkeletonLoader } from '@/object-metadata/components/NavigationDrawerSectionForObjectMetadataItemsSkeletonLoader';
-import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilteredObjectMetadataItems';
 import { useIsPrefetchLoading } from '@/prefetch/hooks/useIsPrefetchLoading';
 import { usePrefetchedData } from '@/prefetch/hooks/usePrefetchedData';
 import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
 import { View } from '@/views/types/View';
 
 export const WorkspaceFavorites = () => {
   const { records: views } = usePrefetchedData<View>(PrefetchKey.AllViews);
-  const loading = useIsPrefetchLoading();
-
-  const { workspaceFavorites } = useFavorites();
-
-  const workspaceFavoriteIds = new Set(
-    workspaceFavorites.map((favorite) => favorite.recordId),
-  );
 
-  const favoriteViewObjectMetadataIds = views.reduce<string[]>((acc, view) => {
-    if (workspaceFavoriteIds.has(view.id)) {
-      acc.push(view.objectMetadataId);
-    }
-    return acc;
-  }, []);
-
-  const { objectMetadataItems } = useFilteredObjectMetadataItems();
-
-  const objectMetadataItemsToDisplay = objectMetadataItems.filter((item) =>
-    favoriteViewObjectMetadataIds.includes(item.id),
-  );
+  const { activeObjectMetadataItems: objectMetadataItemsToDisplay } =
+    useFilteredObjectMetadataItemsForWorkspaceFavorites();
 
+  const loading = useIsPrefetchLoading();
   if (loading) {
     return <NavigationDrawerSectionForObjectMetadataItemsSkeletonLoader />;
   }
 
   return (
     <NavigationDrawerSectionForObjectMetadataItems
-      sectionTitle={'Workspace Favorites'}
+      sectionTitle={'Workspace'}
       objectMetadataItems={objectMetadataItemsToDisplay}
       views={views}
       isRemote={false}

diff --git a/packages/twenty-front/src/modules/navigation/components/MainNavigationDrawerItems.tsx b/packages/twenty-front/src/modules/navigation/components/MainNavigationDrawerItems.tsx
@@ -5,6 +5,7 @@ import { IconSearch, IconSettings } from 'twenty-ui';
 import { useCommandMenu } from '@/command-menu/hooks/useCommandMenu';
 import { CurrentWorkspaceMemberFavorites } from '@/favorites/components/CurrentWorkspaceMemberFavorites';
 import { WorkspaceFavorites } from '@/favorites/components/WorkspaceFavorites';
+import { NavigationDrawerOpenedSection } from '@/object-metadata/components/NavigationDrawerOpenedSection';
 import { NavigationDrawerSectionForObjectMetadataItemsWrapper } from '@/object-metadata/components/NavigationDrawerSectionForObjectMetadataItemsWrapper';
 import { NavigationDrawerItem } from '@/ui/navigation/navigation-drawer/components/NavigationDrawerItem';
 import { NavigationDrawerSection } from '@/ui/navigation/navigation-drawer/components/NavigationDrawerSection';
@@ -44,6 +45,8 @@ export const MainNavigationDrawerItems = () => {
         </NavigationDrawerSection>
       )}
 
+      {isWorkspaceFavoriteEnabled && <NavigationDrawerOpenedSection />}
+
       <CurrentWorkspaceMemberFavorites />
 
       {isWorkspaceFavoriteEnabled ? (

diff --git a/...s/twenty-front/src/modules/navigation/hooks/useObjectMetadataItemsInWorkspaceFavorites.ts b/...s/twenty-front/src/modules/navigation/hooks/useObjectMetadataItemsInWorkspaceFavorites.ts
@@ -0,0 +1,35 @@
+import { useFavorites } from '@/favorites/hooks/useFavorites';
+import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilteredObjectMetadataItems';
+import { usePrefetchedData } from '@/prefetch/hooks/usePrefetchedData';
+import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
+import { View } from '@/views/types/View';
+
+export const useFilteredObjectMetadataItemsForWorkspaceFavorites = () => {
+  const { records: views } = usePrefetchedData<View>(PrefetchKey.AllViews);
+
+  const { workspaceFavorites } = useFavorites();
+
+  const workspaceFavoriteIds = new Set(
+    workspaceFavorites.map((favorite) => favorite.recordId),
+  );
+
+  const favoriteViewObjectMetadataIds = new Set(
+    views.reduce<string[]>((acc, view) => {
+      if (workspaceFavoriteIds.has(view.id)) {
+        acc.push(view.objectMetadataId);
+      }
+      return acc;
+    }, []),
+  );
+
+  const { activeObjectMetadataItems } = useFilteredObjectMetadataItems();
+
+  const activeObjectMetadataItemsInWorkspaceFavorites =
+    activeObjectMetadataItems.filter((item) =>
+      favoriteViewObjectMetadataIds.has(item.id),
+    );
+
+  return {
+    activeObjectMetadataItems: activeObjectMetadataItemsInWorkspaceFavorites,
+  };
+};
diff --git a/...ges/twenty-front/src/modules/object-metadata/components/NavigationDrawerOpenedSection.tsx b/...ges/twenty-front/src/modules/object-metadata/components/NavigationDrawerOpenedSection.tsx
@@ -0,0 +1,57 @@
+import { useParams } from 'react-router-dom';
+
+import { useFilteredObjectMetadataItemsForWorkspaceFavorites } from '@/navigation/hooks/useObjectMetadataItemsInWorkspaceFavorites';
+import { NavigationDrawerSectionForObjectMetadataItems } from '@/object-metadata/components/NavigationDrawerSectionForObjectMetadataItems';
+import { NavigationDrawerSectionForObjectMetadataItemsSkeletonLoader } from '@/object-metadata/components/NavigationDrawerSectionForObjectMetadataItemsSkeletonLoader';
+import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilteredObjectMetadataItems';
+import { useIsPrefetchLoading } from '@/prefetch/hooks/useIsPrefetchLoading';
+import { usePrefetchedData } from '@/prefetch/hooks/usePrefetchedData';
+import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
+import { View } from '@/views/types/View';
+
+export const NavigationDrawerOpenedSection = () => {
+  const { activeObjectMetadataItems } = useFilteredObjectMetadataItems();
+  const filteredActiveObjectMetadataItems = activeObjectMetadataItems.filter(
+    (item) => !item.isRemote,
+  );
+
+  const { records: views } = usePrefetchedData<View>(PrefetchKey.AllViews);
+  const loading = useIsPrefetchLoading();
+
+  const currentObjectNamePlural = useParams().objectNamePlural;
+
+  const { activeObjectMetadataItems: workspaceFavoritesObjectMetadataItems } =
+    useFilteredObjectMetadataItemsForWorkspaceFavorites();
+
+  if (!currentObjectNamePlural) {
+    return;
+  }
+
+  const objectMetadataItem = filteredActiveObjectMetadataItems.find(
+    (item) => item.namePlural === currentObjectNamePlural,
+  );
+
+  if (!objectMetadataItem) {
+    return;
+  }
+
+  const shouldDisplayObjectInOpenedSection =
+    !workspaceFavoritesObjectMetadataItems
+      .map((item) => item.id)
+      .includes(objectMetadataItem.id);
+
+  if (loading) {
+    return <NavigationDrawerSectionForObjectMetadataItemsSkeletonLoader />;
+  }
+
+  return (
+    shouldDisplayObjectInOpenedSection && (
+      <NavigationDrawerSectionForObjectMetadataItems
+        sectionTitle={'Opened'}
+        objectMetadataItems={[objectMetadataItem]}
+        views={views}
+        isRemote={false}
+      />
+    )
+  );
+};
diff --git a/...ages/twenty-front/src/modules/ui/layout/hooks/__tests__/useIsMenuNavbarDisplayed.test.tsx b/...ages/twenty-front/src/modules/ui/layout/hooks/__tests__/useIsMenuNavbarDisplayed.test.tsx
diff --git a/packages/twenty-front/src/modules/ui/layout/hooks/useIsMenuNavbarDisplayed.ts b/packages/twenty-front/src/modules/ui/layout/hooks/useIsMenuNavbarDisplayed.ts
diff --git a/packages/twenty-server/src/database/commands/data-seed-dev-workspace.command.ts b/packages/twenty-server/src/database/commands/data-seed-dev-workspace.command.ts
@@ -40,6 +40,7 @@ import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-
 import { FieldMetadataService } from 'src/engine/metadata-modules/field-metadata/field-metadata.service';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { ObjectMetadataService } from 'src/engine/metadata-modules/object-metadata/object-metadata.service';
+import { shouldSeedWorkspaceFavorite } from 'src/engine/utils/should-seed-workspace-favorite';
 import { WorkspaceDataSourceService } from 'src/engine/workspace-datasource/workspace-datasource.service';
 import { viewPrefillData } from 'src/engine/workspace-manager/standard-objects-prefill-data/view';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
@@ -219,7 +220,14 @@ export class DataSeedWorkspaceCommand extends CommandRunner {
 
             await seedWorkspaceFavorites(
               viewDefinitionsWithId
-                .filter((view) => view.key === 'INDEX')
+                .filter(
+                  (view) =>
+                    view.key === 'INDEX' &&
+                    shouldSeedWorkspaceFavorite(
+                      view.objectMetadataId,
+                      objectMetadataMap,
+                    ),
+                )
                 .map((view) => view.id),
               entityManager,
               dataSourceMetadata.schema,

diff --git a/packages/twenty-server/src/engine/utils/should-seed-workspace-favorite.ts b/packages/twenty-server/src/engine/utils/should-seed-workspace-favorite.ts
@@ -0,0 +1,9 @@
+import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
+
+export const shouldSeedWorkspaceFavorite = (
+  objectMetadataId,
+  objectMetadataMap,
+): boolean =>
+  objectMetadataId !==
+    objectMetadataMap[STANDARD_OBJECT_IDS.workflowVersion].id &&
+  objectMetadataId !== objectMetadataMap[STANDARD_OBJECT_IDS.workflowRun].id;
diff --git a/...erver/src/engine/workspace-manager/demo-objects-prefill-data/demo-objects-prefill-data.ts b/...erver/src/engine/workspace-manager/demo-objects-prefill-data/demo-objects-prefill-data.ts
@@ -2,6 +2,7 @@ import { DataSource, EntityManager } from 'typeorm';
 
 import { seedWorkspaceFavorites } from 'src/database/typeorm-seeds/workspace/favorites';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { shouldSeedWorkspaceFavorite } from 'src/engine/utils/should-seed-workspace-favorite';
 import { companyPrefillDemoData } from 'src/engine/workspace-manager/demo-objects-prefill-data/company';
 import { opportunityPrefillDemoData } from 'src/engine/workspace-manager/demo-objects-prefill-data/opportunity';
 import { personPrefillDemoData } from 'src/engine/workspace-manager/demo-objects-prefill-data/person';
@@ -42,7 +43,7 @@ export const demoObjectsPrefillData = async (
 
       await seedWorkspaceFavorites(
         viewDefinitionsWithId
-          .filter((view) => view.key === 'INDEX')
+          .filter((view) => view.key === 'INDEX' && shouldSeedWorkspaceFavorite(view.objectMetadataId, objectMetadataMap))
           .map((view) => view.id),
         entityManager,
         schemaName,

diff --git a/...c/engine/workspace-manager/standard-objects-prefill-data/standard-objects-prefill-data.ts b/...c/engine/workspace-manager/standard-objects-prefill-data/standard-objects-prefill-data.ts
@@ -2,6 +2,7 @@ import { DataSource, EntityManager } from 'typeorm';
 
 import { seedWorkspaceFavorites } from 'src/database/typeorm-seeds/workspace/favorites';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { shouldSeedWorkspaceFavorite } from 'src/engine/utils/should-seed-workspace-favorite';
 import { companyPrefillData } from 'src/engine/workspace-manager/standard-objects-prefill-data/company';
 import { personPrefillData } from 'src/engine/workspace-manager/standard-objects-prefill-data/person';
 import { viewPrefillData } from 'src/engine/workspace-manager/standard-objects-prefill-data/view';
@@ -45,7 +46,14 @@ export const standardObjectsPrefillData = async (
 
     await seedWorkspaceFavorites(
       viewDefinitionsWithId
-        .filter((view) => view.key === 'INDEX')
+        .filter(
+          (view) =>
+            view.key === 'INDEX' &&
+            shouldSeedWorkspaceFavorite(
+              view.objectMetadataId,
+              objectMetadataMap,
+            ),
+        )
         .map((view) => view.id),
       entityManager,
       schemaName,

diff --git a/packages/twenty-server/src/engine/workspace-manager/standard-objects-prefill-data/view.ts b/packages/twenty-server/src/engine/workspace-manager/standard-objects-prefill-data/view.ts
@@ -9,6 +9,8 @@ import { opportunitiesByStageView } from 'src/engine/workspace-manager/standard-
 import { peopleAllView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/people-all.view';
 import { tasksAllView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/tasks-all.view';
 import { tasksByStatusView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/tasks-by-status.view';
+import { workflowRunsAllView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/workflow-runs-all.view';
+import { workflowVersionsAllView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/workflow-versions-all.view';
 import { workflowsAllView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/workflows-all.view';
 
 export const viewPrefillData = async (
@@ -18,14 +20,20 @@ export const viewPrefillData = async (
   isWorkflowEnabled: boolean,
 ) => {
   const viewDefinitions = [
-    await companiesAllView(objectMetadataMap),
-    await peopleAllView(objectMetadataMap),
-    await opportunitiesAllView(objectMetadataMap),
-    await opportunitiesByStageView(objectMetadataMap),
-    await notesAllView(objectMetadataMap),
-    await tasksAllView(objectMetadataMap),
-    await tasksByStatusView(objectMetadataMap),
-    ...(isWorkflowEnabled ? [await workflowsAllView(objectMetadataMap)] : []),
+    companiesAllView(objectMetadataMap),
+    peopleAllView(objectMetadataMap),
+    opportunitiesAllView(objectMetadataMap),
+    opportunitiesByStageView(objectMetadataMap),
+    notesAllView(objectMetadataMap),
+    tasksAllView(objectMetadataMap),
+    tasksByStatusView(objectMetadataMap),
+    ...(isWorkflowEnabled
+      ? [
+          workflowsAllView(objectMetadataMap),
+          workflowVersionsAllView(objectMetadataMap),
+          workflowRunsAllView(objectMetadataMap),
+        ]
+      : []),
   ];
 
   const viewDefinitionsWithId = viewDefinitions.map((viewDefinition) => ({

diff --git a/...er/src/engine/workspace-manager/standard-objects-prefill-data/views/companies-all.view.ts b/...er/src/engine/workspace-manager/standard-objects-prefill-data/views/companies-all.view.ts
@@ -5,7 +5,7 @@ import {
 } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
 
-export const companiesAllView = async (
+export const companiesAllView = (
   objectMetadataMap: Record<string, ObjectMetadataEntity>,
 ) => {
   return {

diff --git a/...server/src/engine/workspace-manager/standard-objects-prefill-data/views/notes-all.view.ts b/...server/src/engine/workspace-manager/standard-objects-prefill-data/views/notes-all.view.ts
@@ -5,7 +5,7 @@ import {
 } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
 
-export const notesAllView = async (
+export const notesAllView = (
   objectMetadataMap: Record<string, ObjectMetadataEntity>,
 ) => {
   return {

diff --git a/...rc/engine/workspace-manager/standard-objects-prefill-data/views/opportunities-all.view.ts b/...rc/engine/workspace-manager/standard-objects-prefill-data/views/opportunities-all.view.ts
@@ -2,7 +2,7 @@ import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadat
 import { OPPORTUNITY_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
 
-export const opportunitiesAllView = async (
+export const opportunitiesAllView = (
   objectMetadataMap: Record<string, ObjectMetadataEntity>,
 ) => {
   return {

diff --git a/...engine/workspace-manager/standard-objects-prefill-data/views/opportunity-by-stage.view.ts b/...engine/workspace-manager/standard-objects-prefill-data/views/opportunity-by-stage.view.ts
@@ -2,7 +2,7 @@ import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadat
 import { OPPORTUNITY_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
 
-export const opportunitiesByStageView = async (
+export const opportunitiesByStageView = (
   objectMetadataMap: Record<string, ObjectMetadataEntity>,
 ) => {
   return {

diff --git a/...erver/src/engine/workspace-manager/standard-objects-prefill-data/views/people-all.view.ts b/...erver/src/engine/workspace-manager/standard-objects-prefill-data/views/people-all.view.ts
@@ -5,7 +5,7 @@ import {
 } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
 
-export const peopleAllView = async (
+export const peopleAllView = (
   objectMetadataMap: Record<string, ObjectMetadataEntity>,
 ) => {
   return {

diff --git a/...server/src/engine/workspace-manager/standard-objects-prefill-data/views/tasks-all.view.ts b/...server/src/engine/workspace-manager/standard-objects-prefill-data/views/tasks-all.view.ts
@@ -5,7 +5,7 @@ import {
 } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
 
-export const tasksAllView = async (
+export const tasksAllView = (
   objectMetadataMap: Record<string, ObjectMetadataEntity>,
 ) => {
   return {

diff --git a/.../src/engine/workspace-manager/standard-objects-prefill-data/views/tasks-by-status.view.ts b/.../src/engine/workspace-manager/standard-objects-prefill-data/views/tasks-by-status.view.ts
@@ -5,7 +5,7 @@ import {
 } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
 
-export const tasksByStatusView = async (
+export const tasksByStatusView = (
   objectMetadataMap: Record<string, ObjectMetadataEntity>,
 ) => {
   return {