Support orderBy as array (#5681)

closes: #4301 --------- Co-authored-by: Félix Malfait <[email protected]>
twentyhq · Jun 14, 2024 · 4603999 · 4603999
1 parent 85fd801
commit 4603999
Show file tree

Hide file tree

Showing 35 changed files with 249 additions and 157 deletions.
diff --git a/...graphql/operation-signatures/factories/fetchAllThreadMessagesOperationSignatureFactory.ts b/...graphql/operation-signatures/factories/fetchAllThreadMessagesOperationSignatureFactory.ts
@@ -10,9 +10,11 @@ export const fetchAllThreadMessagesOperationSignatureFactory: RecordGqlOperation
           eq: messageThreadId || '',
         },
       },
-      orderBy: {
-        receivedAt: 'AscNullsLast',
-      },
+      orderBy: [
+        {
+          receivedAt: 'AscNullsLast',
+        },
+      ],
       limit: 10,
     },
     fields: {

diff --git a/packages/twenty-front/src/modules/activities/files/hooks/useAttachments.tsx b/packages/twenty-front/src/modules/activities/files/hooks/useAttachments.tsx
@@ -17,9 +17,11 @@ export const useAttachments = (targetableObject: ActivityTargetableObject) => {
         eq: targetableObject.id,
       },
     },
-    orderBy: {
-      createdAt: 'DescNullsFirst',
-    },
+    orderBy: [
+      {
+        createdAt: 'DescNullsFirst',
+      },
+    ],
   });
 
   return {

diff --git a/packages/twenty-front/src/modules/activities/hooks/__tests__/useActivities.test.tsx b/packages/twenty-front/src/modules/activities/hooks/__tests__/useActivities.test.tsx
@@ -49,7 +49,7 @@ const mocks: MockedResponse[] = [
       query: gql`
         query FindManyActivityTargets(
           $filter: ActivityTargetFilterInput
-          $orderBy: ActivityTargetOrderByInput
+          $orderBy: [ActivityTargetOrderByInput]
           $lastCursor: String
           $limit: Int
         ) {
@@ -103,7 +103,7 @@ const mocks: MockedResponse[] = [
       query: gql`
         query FindManyActivities(
           $filter: ActivityFilterInput
-          $orderBy: ActivityOrderByInput
+          $orderBy: [ActivityOrderByInput]
           $lastCursor: String
           $limit: Int
         ) {
@@ -142,7 +142,7 @@ const mocks: MockedResponse[] = [
       variables: {
         filter: { id: { in: ['234'] } },
         limit: undefined,
-        orderBy: {},
+        orderBy: [{}],
       },
     },
     result: jest.fn(() => ({
@@ -178,7 +178,7 @@ describe('useActivities', () => {
         useActivities({
           targetableObjects: [],
           activitiesFilters: {},
-          activitiesOrderByVariables: {},
+          activitiesOrderByVariables: [{}],
           skip: false,
         }),
       { wrapper: Wrapper },
@@ -202,7 +202,7 @@ describe('useActivities', () => {
             { targetObjectNameSingular: 'company', id: '123' },
           ],
           activitiesFilters: {},
-          activitiesOrderByVariables: {},
+          activitiesOrderByVariables: [{}],
           skip: false,
         });
         return { activities, setCurrentWorkspaceMember };

diff --git a/...ont/src/modules/activities/hooks/__tests__/useActivityTargetsForTargetableObject.test.tsx b/...ont/src/modules/activities/hooks/__tests__/useActivityTargetsForTargetableObject.test.tsx
@@ -34,7 +34,7 @@ const mocks: MockedResponse[] = [
       query: gql`
         query FindManyActivityTargets(
           $filter: ActivityTargetFilterInput
-          $orderBy: ActivityTargetOrderByInput
+          $orderBy: [ActivityTargetOrderByInput]
           $lastCursor: String
           $limit: Int
         ) {

diff --git a/packages/twenty-front/src/modules/activities/hooks/usePrepareFindManyActivitiesQuery.ts b/packages/twenty-front/src/modules/activities/hooks/usePrepareFindManyActivitiesQuery.ts
@@ -109,7 +109,7 @@ export const usePrepareFindManyActivitiesQuery = () => {
       objectRecordsToOverwrite: filteredActivities,
       queryVariables: {
         ...nextFindManyActivitiesQueryFilter,
-        orderBy: { createdAt: 'DescNullsFirst' },
+        orderBy: [{ createdAt: 'DescNullsFirst' }],
       },
       recordGqlFields: FIND_ACTIVITIES_OPERATION_SIGNATURE.fields,
       computeReferences: true,

diff --git a/packages/twenty-front/src/modules/activities/notes/hooks/useNotes.ts b/packages/twenty-front/src/modules/activities/notes/hooks/useNotes.ts
@@ -24,7 +24,7 @@ export const useNotes = (targetableObject: ActivityTargetableObject) => {
 
   const { activities, loading } = useActivities({
     activitiesFilters: notesQueryVariables.filter ?? {},
-    activitiesOrderByVariables: notesQueryVariables.orderBy ?? {},
+    activitiesOrderByVariables: notesQueryVariables.orderBy ?? [{}],
     targetableObjects: [targetableObject],
   });
 

diff --git a/packages/twenty-front/src/modules/activities/tasks/hooks/useTasks.ts b/packages/twenty-front/src/modules/activities/tasks/hooks/useTasks.ts
@@ -110,13 +110,13 @@ export const useTasks = ({
   const { activities: completeTasksData } = useActivities({
     targetableObjects,
     activitiesFilters: completedQueryVariables.filter ?? {},
-    activitiesOrderByVariables: completedQueryVariables.orderBy ?? {},
+    activitiesOrderByVariables: completedQueryVariables.orderBy ?? [{}],
   });
 
   const { activities: incompleteTaskData } = useActivities({
     targetableObjects,
     activitiesFilters: incompleteQueryVariables.filter ?? {},
-    activitiesOrderByVariables: incompleteQueryVariables.orderBy ?? {},
+    activitiesOrderByVariables: incompleteQueryVariables.orderBy ?? [{}],
   });
 
   const todayOrPreviousTasks = incompleteTaskData?.filter((task) => {

diff --git a/...enty-front/src/modules/activities/timeline/constants/FindManyTimelineActivitiesOrderBy.ts b/...enty-front/src/modules/activities/timeline/constants/FindManyTimelineActivitiesOrderBy.ts
@@ -1,6 +1,8 @@
 import { RecordGqlOperationOrderBy } from '@/object-record/graphql/types/RecordGqlOperationOrderBy';
 
 export const FIND_MANY_TIMELINE_ACTIVITIES_ORDER_BY: RecordGqlOperationOrderBy =
-  {
-    createdAt: 'DescNullsFirst',
-  };
+  [
+    {
+      createdAt: 'DescNullsFirst',
+    },
+  ];
diff --git a/...wenty-front/src/modules/activities/timeline/utils/makeTimelineActivitiesQueryVariables.ts b/...wenty-front/src/modules/activities/timeline/utils/makeTimelineActivitiesQueryVariables.ts
@@ -13,8 +13,10 @@ export const makeTimelineActivitiesQueryVariables = ({
         in: [...activityIds].sort(sortByAscString),
       },
     },
-    orderBy: {
-      createdAt: 'DescNullsFirst',
-    },
+    orderBy: [
+      {
+        createdAt: 'DescNullsFirst',
+      },
+    ],
   };
 };
diff --git a/...es/twenty-front/src/modules/activities/timelineActivities/hooks/useTimelineActivities.tsx b/...es/twenty-front/src/modules/activities/timelineActivities/hooks/useTimelineActivities.tsx
@@ -23,9 +23,11 @@ export const useTimelineActivities = (
         eq: targetableObject.id,
       },
     },
-    orderBy: {
-      createdAt: 'DescNullsFirst',
-    },
+    orderBy: [
+      {
+        createdAt: 'DescNullsFirst',
+      },
+    ],
     recordGqlFields: {
       id: true,
       createdAt: true,

diff --git a/packages/twenty-front/src/modules/apollo/optimistic-effect/utils/sortCachedObjectEdges.ts b/packages/twenty-front/src/modules/apollo/optimistic-effect/utils/sortCachedObjectEdges.ts
@@ -16,7 +16,7 @@ export const sortCachedObjectEdges = ({
   orderBy: RecordGqlOperationOrderBy;
   readCacheField: ReadFieldFunction;
 }) => {
-  const [orderByFieldName, orderByFieldValue] = Object.entries(orderBy)[0];
+  const [orderByFieldName, orderByFieldValue] = Object.entries(orderBy[0])[0];
   const [orderBySubFieldName, orderBySubFieldValue] =
     typeof orderByFieldValue === 'string'
       ? []

diff --git a/...wenty-front/src/modules/object-metadata/hooks/__mocks__/useCreateOneObjectMetadataItem.ts b/...wenty-front/src/modules/object-metadata/hooks/__mocks__/useCreateOneObjectMetadataItem.ts
@@ -24,7 +24,7 @@ export const query = gql`
 export const findManyViewsQuery = gql`
   query FindManyViews(
     $filter: ViewFilterInput
-    $orderBy: ViewOrderByInput
+    $orderBy: [ViewOrderByInput]
     $lastCursor: String
     $limit: Int
   ) {

diff --git a/...wenty-front/src/modules/object-metadata/hooks/__tests__/useGetObjectOrderByField.test.tsx b/...wenty-front/src/modules/object-metadata/hooks/__tests__/useGetObjectOrderByField.test.tsx
@@ -26,8 +26,8 @@ describe('useGetObjectOrderByField', () => {
       },
     );
 
-    expect(result.current).toEqual({
-      name: { firstName: 'AscNullsLast', lastName: 'AscNullsLast' },
-    });
+    expect(result.current).toEqual([
+      { name: { firstName: 'AscNullsLast', lastName: 'AscNullsLast' } },
+    ]);
   });
 });
diff --git a/...es/twenty-front/src/modules/object-metadata/utils/__tests__/getObjectOrderByField.test.ts b/...es/twenty-front/src/modules/object-metadata/utils/__tests__/getObjectOrderByField.test.ts
@@ -9,8 +9,8 @@ describe('getObjectOrderByField', () => {
       (item) => item.nameSingular === 'person',
     )!;
     const res = getOrderByFieldForObjectMetadataItem(objectMetadataItem);
-    expect(res).toEqual({
-      name: { firstName: 'AscNullsLast', lastName: 'AscNullsLast' },
-    });
+    expect(res).toEqual([
+      { name: { firstName: 'AscNullsLast', lastName: 'AscNullsLast' } },
+    ]);
   });
 });
diff --git a/packages/twenty-front/src/modules/object-metadata/utils/getObjectOrderByField.ts b/packages/twenty-front/src/modules/object-metadata/utils/getObjectOrderByField.ts
@@ -15,20 +15,26 @@ export const getOrderByFieldForObjectMetadataItem = (
   if (isDefined(labelIdentifierFieldMetadata)) {
     switch (labelIdentifierFieldMetadata.type) {
       case FieldMetadataType.FullName:
-        return {
-          [labelIdentifierFieldMetadata.name]: {
-            firstName: orderBy ?? 'AscNullsLast',
-            lastName: orderBy ?? 'AscNullsLast',
+        return [
+          {
+            [labelIdentifierFieldMetadata.name]: {
+              firstName: orderBy ?? 'AscNullsLast',
+              lastName: orderBy ?? 'AscNullsLast',
+            },
           },
-        };
+        ];
       default:
-        return {
-          [labelIdentifierFieldMetadata.name]: orderBy ?? 'AscNullsLast',
-        };
+        return [
+          {
+            [labelIdentifierFieldMetadata.name]: orderBy ?? 'AscNullsLast',
+          },
+        ];
     }
   } else {
-    return {
-      createdAt: orderBy ?? 'DescNullsLast',
-    };
+    return [
+      {
+        createdAt: orderBy ?? 'DescNullsLast',
+      },
+    ];
   }
 };
diff --git a/packages/twenty-front/src/modules/object-record/graphql/types/RecordGqlOperationOrderBy.ts b/packages/twenty-front/src/modules/object-record/graphql/types/RecordGqlOperationOrderBy.ts
@@ -1,5 +1,5 @@
 import { OrderBy } from '@/object-metadata/types/OrderBy';
 
-export type RecordGqlOperationOrderBy = {
+export type RecordGqlOperationOrderBy = Array<{
   [fieldName: string]: OrderBy | { [subFieldName: string]: OrderBy };
-};
+}>;
diff --git a/...s/twenty-front/src/modules/object-record/hooks/__tests__/useFindManyRecordsQuery.test.tsx b/...s/twenty-front/src/modules/object-record/hooks/__tests__/useFindManyRecordsQuery.test.tsx
@@ -5,7 +5,7 @@ import { RecoilRoot } from 'recoil';
 import { useFindManyRecordsQuery } from '@/object-record/hooks/useFindManyRecordsQuery';
 
 const expectedQueryTemplate = `
-  query FindManyPeople($filter: PersonFilterInput, $orderBy: PersonOrderByInput, $lastCursor: String, $limit: Int) {
+  query FindManyPeople($filter: PersonFilterInput, $orderBy: [PersonOrderByInput], $lastCursor: String, $limit: Int) {
     people(filter: $filter, orderBy: $orderBy, first: $limit, after: $lastCursor) {
       edges {
         node {

diff --git a/...c/modules/object-record/multiple-objects/hooks/useGenerateCombinedFindManyRecordsQuery.ts b/...c/modules/object-record/multiple-objects/hooks/useGenerateCombinedFindManyRecordsQuery.ts
@@ -32,9 +32,9 @@ export const useGenerateCombinedFindManyRecordsQuery = ({
   const orderByPerMetadataItemArray = operationSignatures
     .map(
       ({ objectNameSingular }) =>
-        `$orderBy${capitalize(objectNameSingular)}: ${capitalize(
+        `$orderBy${capitalize(objectNameSingular)}: [${capitalize(
           objectNameSingular,
-        )}OrderByInput`,
+        )}OrderByInput]`,
     )
     .join(', ');
 

diff --git a/.../modules/object-record/object-sort-dropdown/utils/__tests__/turnSortsIntoOrderBy.test.tsx b/.../modules/object-record/object-sort-dropdown/utils/__tests__/turnSortsIntoOrderBy.test.tsx
@@ -30,9 +30,11 @@ describe('turnSortsIntoOrderBy', () => {
   it('should sort by recordPosition if no sorts', () => {
     const fields = [{ id: 'field1', name: 'createdAt' }] as FieldMetadataItem[];
     expect(turnSortsIntoOrderBy({ ...objectMetadataItem, fields }, [])).toEqual(
-      {
-        position: 'AscNullsFirst',
-      },
+      [
+        {
+          position: 'AscNullsFirst',
+        },
+      ],
     );
   });
 
@@ -47,10 +49,7 @@ describe('turnSortsIntoOrderBy', () => {
     const fields = [{ id: 'field1', name: 'field1' }] as FieldMetadataItem[];
     expect(
       turnSortsIntoOrderBy({ ...objectMetadataItem, fields }, sorts),
-    ).toEqual({
-      field1: 'AscNullsFirst',
-      position: 'AscNullsFirst',
-    });
+    ).toEqual([{ field1: 'AscNullsFirst' }, { position: 'AscNullsFirst' }]);
   });
 
   it('should create OrderByField with multiple sorts', () => {
@@ -72,11 +71,11 @@ describe('turnSortsIntoOrderBy', () => {
     ] as FieldMetadataItem[];
     expect(
       turnSortsIntoOrderBy({ ...objectMetadataItem, fields }, sorts),
-    ).toEqual({
-      field1: 'AscNullsFirst',
-      field2: 'DescNullsLast',
-      position: 'AscNullsFirst',
-    });
+    ).toEqual([
+      { field1: 'AscNullsFirst' },
+      { field2: 'DescNullsLast' },
+      { position: 'AscNullsFirst' },
+    ]);
   });
 
   it('should ignore if field not found', () => {
@@ -87,9 +86,9 @@ describe('turnSortsIntoOrderBy', () => {
         definition: sortDefinition,
       },
     ];
-    expect(turnSortsIntoOrderBy(objectMetadataItem, sorts)).toEqual({
-      position: 'AscNullsFirst',
-    });
+    expect(turnSortsIntoOrderBy(objectMetadataItem, sorts)).toEqual([
+      { position: 'AscNullsFirst' },
+    ]);
   });
 
   it('should not return position for remotes', () => {
@@ -102,6 +101,6 @@ describe('turnSortsIntoOrderBy', () => {
     ];
     expect(
       turnSortsIntoOrderBy({ ...objectMetadataItem, isRemote: true }, sorts),
-    ).toEqual({});
+    ).toEqual([]);
   });
 });
diff --git a/...twenty-front/src/modules/object-record/object-sort-dropdown/utils/turnSortsIntoOrderBy.ts b/...twenty-front/src/modules/object-record/object-sort-dropdown/utils/turnSortsIntoOrderBy.ts
@@ -15,28 +15,23 @@ export const turnSortsIntoOrderBy = (
 ): RecordGqlOperationOrderBy => {
   const fields: Pick<Field, 'id' | 'name'>[] = objectMetadataItem?.fields ?? [];
   const fieldsById = mapArrayToObject(fields, ({ id }) => id);
-  const sortsOrderBy = Object.fromEntries(
-    sorts
-      .map((sort) => {
-        const correspondingField = fieldsById[sort.fieldMetadataId];
+  const sortsOrderBy = sorts
+    .map((sort) => {
+      const correspondingField = fieldsById[sort.fieldMetadataId];
 
-        if (isUndefinedOrNull(correspondingField)) {
-          return undefined;
-        }
+      if (isUndefinedOrNull(correspondingField)) {
+        return undefined;
+      }
 
-        const direction: OrderBy =
-          sort.direction === 'asc' ? 'AscNullsFirst' : 'DescNullsLast';
+      const direction: OrderBy =
+        sort.direction === 'asc' ? 'AscNullsFirst' : 'DescNullsLast';
 
-        return [correspondingField.name, direction];
-      })
-      .filter(isDefined),
-  );
+      return { [correspondingField.name]: direction };
+    })
+    .filter(isDefined);
 
   if (hasPositionField(objectMetadataItem)) {
-    return {
-      ...sortsOrderBy,
-      position: 'AscNullsFirst',
-    };
+    return [...sortsOrderBy, { position: 'AscNullsFirst' }];
   }
 
   return sortsOrderBy;