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

breaking (soft) - Migrate viewGroup.fieldMetadataId -> view.mainGroupByFieldMetadataId (2/3) (#16277)

Browse Source 
Should be merged once https://github.com/twentyhq/twenty/pull/16206 has
been released + command run to prod

In this PR
- Remove usage of viewGroup.fieldMetadataId, both in BE and FE states. 
- But we still need to properly populate it until we fully remove
viewGroup.fieldMetadataId from db and ORM entity (upcoming 3rd PR out of
3). fieldMetadataId was removed from CoreViewGroup type and
CreateViewGroupInput and is determined BE-side based on the associated
view's mainGroupByFieldMetadataId. **I expect this means a downtime on
viewGroup creation, until both FE and BE are deployed and cache is
flushed.** This seems acceptable to me as it only regards viewGroup
creation.
    - this information is replaced by view.mainGroupByFieldMetadataID
- Handle view group creation, update and deletion in the BE as a
side-effect of a view creation, update or deletion. Optimistic effects
are still used
- Add validation at view creation or update regarding
mainGroupByFieldMetadata

Left to do in 3rd PR
- Remove viewGroup.fieldMetadataId from db and ORM entity
- Restore feature allowing to update an existing grouped view's group by
field (already OK on BE side but need to rebuild FE optimistic)
This commit is contained in:
Marie
2025-12-05 15:00:03 +01:00
committed by GitHub
parent 17d88a074b
commit 7ce22d5c7e
87 changed files with 1338 additions and 1067 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-front/src/modules/views/graphql/fragments/viewFragment.ts
+1 -1
View File
@@ -24,7 +24,7 @@ export const VIEW_FRAGMENT = gql`
openRecordIn
kanbanAggregateOperation
kanbanAggregateOperationFieldMetadataId
# mainGroupByFieldMetadataId
mainGroupByFieldMetadataId
anyFieldFilterValue
calendarFieldMetadataId
calendarLayout
packages/twenty-front/src/modules/views/graphql/fragments/viewGroupFragment.ts
-1
View File
@@ -3,7 +3,6 @@ import { gql } from '@apollo/client';
export const VIEW_GROUP_FRAGMENT = gql`
fragment ViewGroupFragment on CoreViewGroup {
id
fieldMetadataId
isVisible
fieldValue
position
packages/twenty-front/src/modules/views/hooks/internal/usePersistViewGroup.ts
+5 -3
View File
@@ -32,9 +32,11 @@ export const usePersistViewGroupRecords = () => {
const { enqueueErrorSnackBar } = useSnackBar();
const createViewGroups = useCallback(
async (
createCoreViewGroupInputs: CreateManyCoreViewGroupsMutationVariables,
): Promise<
async ({
createCoreViewGroupInputs,
}: {
createCoreViewGroupInputs: CreateManyCoreViewGroupsMutationVariables;
}): Promise<
MetadataRequestResult<Awaited<
ReturnType<typeof createManyCoreViewGroupsMutation>
> | null>
packages/twenty-front/src/modules/views/hooks/useCreateViewFromCurrentView.ts
+37 -25
View File
@@ -11,9 +11,9 @@ import { usePersistView } from '@/views/hooks/internal/usePersistView';
import { usePersistViewField } from '@/views/hooks/internal/usePersistViewField';
import { usePersistViewFilterRecords } from '@/views/hooks/internal/usePersistViewFilter';
import { usePersistViewFilterGroupRecords } from '@/views/hooks/internal/usePersistViewFilterGroup';
import { usePersistViewGroupRecords } from '@/views/hooks/internal/usePersistViewGroup';
import { usePersistViewSortRecords } from '@/views/hooks/internal/usePersistViewSort';
import { useRefreshCoreViewsByObjectMetadataId } from '@/views/hooks/useRefreshCoreViewsByObjectMetadataId';
import { useTriggerViewGroupOptimisticEffect } from '@/views/optimistic-effects/hooks/useTriggerViewGroupOptimisticEffect';
import { isPersistingViewFieldsState } from '@/views/states/isPersistingViewFieldsState';
import { coreViewFromViewIdFamilySelector } from '@/views/states/selectors/coreViewFromViewIdFamilySelector';
import { type GraphQLView } from '@/views/types/GraphQLView';
@@ -28,7 +28,10 @@ import { mapRecordSortToViewSort } from '@/views/utils/mapRecordSortToViewSort';
import { useRecoilCallback } from 'recoil';
import { isDefined } from 'twenty-shared/utils';
import { v4 } from 'uuid';
import { ViewCalendarLayout } from '~/generated-metadata/graphql';
import {
type CoreViewGroup,
ViewCalendarLayout,
} from '~/generated-metadata/graphql';
import { isUndefinedOrNull } from '~/utils/isUndefinedOrNull';
export const useCreateViewFromCurrentView = (viewBarComponentId?: string) => {
@@ -47,7 +50,8 @@ export const useCreateViewFromCurrentView = (viewBarComponentId?: string) => {
const { createViewSorts } = usePersistViewSortRecords();
const { createViewGroups } = usePersistViewGroupRecords();
const { triggerViewGroupOptimisticEffect } =
useTriggerViewGroupOptimisticEffect();
const { createViewFilters } = usePersistViewFilterRecords();
@@ -182,7 +186,10 @@ export const useCreateViewFromCurrentView = (viewBarComponentId?: string) => {
}
if (type === ViewType.Kanban) {
if (!isDefined(mainGroupByFieldMetadataId)) {
if (
!isDefined(mainGroupByFieldMetadataId) ||
mainGroupByFieldMetadataId === ''
) {
throw new Error('Kanban view must have a kanban field');
}
@@ -194,33 +201,38 @@ export const useCreateViewFromCurrentView = (viewBarComponentId?: string) => {
({
id: v4(),
__typename: 'ViewGroup',
fieldMetadataId: mainGroupByFieldMetadataId,
fieldValue: option.value,
isVisible: true,
position: index,
}) satisfies ViewGroup,
) ?? [];
viewGroupsToCreate.push({
__typename: 'ViewGroup',
id: v4(),
fieldValue: '',
position: viewGroupsToCreate.length,
isVisible: true,
fieldMetadataId: mainGroupByFieldMetadataId,
} satisfies ViewGroup);
const groupResult = await createViewGroups({
inputs: viewGroupsToCreate.map(({ __typename, ...viewGroup }) => ({
...viewGroup,
viewId: newViewId,
})),
});
if (groupResult.status === 'failed') {
set(isPersistingViewFieldsState, false);
return undefined;
if (
objectMetadataItem.fields.find(
(field) => field.id === mainGroupByFieldMetadataId,
)?.isNullable === true
) {
viewGroupsToCreate.push({
__typename: 'ViewGroup',
id: v4(),
fieldValue: '',
position: viewGroupsToCreate.length,
isVisible: true,
} satisfies ViewGroup);
}
triggerViewGroupOptimisticEffect({
createdViewGroups: viewGroupsToCreate.map(
({ __typename, ...viewGroup }) =>
({
...viewGroup,
viewId: newViewId,
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
deletedAt: null,
}) as Omit<CoreViewGroup, 'workspaceId'>,
),
});
}
if (shouldCopyFiltersAndSortsAndAggregate === true) {
@@ -292,7 +304,6 @@ export const useCreateViewFromCurrentView = (viewBarComponentId?: string) => {
anyFieldFilterValue,
objectMetadataItem.fields,
objectMetadataItem.id,
createViewGroups,
currentRecordFilterGroups,
currentRecordFilters,
currentRecordSorts,
@@ -300,6 +311,7 @@ export const useCreateViewFromCurrentView = (viewBarComponentId?: string) => {
createViewFilters,
createViewSorts,
refreshCoreViewsByObjectMetadataId,
triggerViewGroupOptimisticEffect,
],
);
packages/twenty-front/src/modules/views/hooks/useGetViewGroupsFilters.ts
+5 -1
View File
@@ -10,9 +10,13 @@ export const useGetViewGroupsFilters = (): RecordFilter[] => {
currentView?.viewGroups
.filter((recordGroup) => !recordGroup.isVisible)
.map((recordGroup) => {
if (!isDefined(currentView.mainGroupByFieldMetadataId)) {
throw new Error('mainGroupByFieldMetadataId is required');
}
return {
id: recordGroup.id,
fieldMetadataId: recordGroup.fieldMetadataId,
fieldMetadataId: currentView.mainGroupByFieldMetadataId,
value: JSON.stringify([recordGroup.fieldValue]),
operand: ViewFilterOperand.IS_NOT,
displayValue: '',
packages/twenty-front/src/modules/views/hooks/useRefreshAllCoreViews.ts
+4 -2
View File
@@ -24,11 +24,13 @@ export const useRefreshAllCoreViews = (
.getLoadable(coreViewsState)
.getValue();
const coreViewsFromResult = result.data.getCoreViews;
if (
isDefined(result.data?.getCoreViews) &&
!isDeeplyEqual(currentCoreViews, result.data.getCoreViews)
!isDeeplyEqual(currentCoreViews, coreViewsFromResult)
) {
set(coreViewsState, result.data.getCoreViews);
set(coreViewsState, coreViewsFromResult);
}
return result.data?.getCoreViews;
packages/twenty-front/src/modules/views/hooks/useRefreshCoreViewsByObjectMetadataId.ts
+5 -5
View File
@@ -49,18 +49,18 @@ export const useRefreshCoreViewsByObjectMetadataId = () => {
)
.getValue();
if (
isDeeplyEqual(coreViewsForObjectMetadataId, result.data.getCoreViews)
) {
const coreViewsFromResult = result.data.getCoreViews;
if (isDeeplyEqual(coreViewsForObjectMetadataId, coreViewsFromResult)) {
return;
}
set(
coreViewsByObjectMetadataIdFamilySelector(objectMetadataId),
result.data.getCoreViews,
coreViewsFromResult,
);
for (const coreView of result.data.getCoreViews) {
for (const coreView of coreViewsFromResult) {
const existingView = coreViewsForObjectMetadataId.find(
(coreViewForObjectMetadata) =>
coreViewForObjectMetadata.id === coreView.id,
packages/twenty-front/src/modules/views/hooks/useSaveCurrentViewGroups.ts
+13 -15
View File
@@ -45,9 +45,7 @@ export const useSaveCurrentViewGroups = () => {
const existingField = currentViewGroups.find(
(currentViewGroup) =>
currentViewGroup.fieldValue === viewGroupToSave.fieldValue &&
currentViewGroup.fieldMetadataId ===
viewGroupToSave.fieldMetadataId,
currentViewGroup.fieldValue === viewGroupToSave.fieldValue,
);
if (isUndefinedOrNull(existingField)) {
@@ -76,7 +74,6 @@ export const useSaveCurrentViewGroups = () => {
update: {
isVisible: viewGroupToSave.isVisible,
position: viewGroupToSave.position,
fieldMetadataId: viewGroupToSave.fieldMetadataId,
fieldValue: viewGroupToSave.fieldValue,
},
},
@@ -118,9 +115,7 @@ export const useSaveCurrentViewGroups = () => {
.map((viewGroupToSave) => {
const existingField = currentViewGroups.find(
(currentViewGroup) =>
currentViewGroup.fieldValue === viewGroupToSave.fieldValue &&
currentViewGroup.fieldMetadataId ===
viewGroupToSave.fieldMetadataId,
currentViewGroup.fieldValue === viewGroupToSave.fieldValue,
);
if (isUndefinedOrNull(existingField)) {
@@ -148,7 +143,6 @@ export const useSaveCurrentViewGroups = () => {
update: {
isVisible: viewGroupToSave.isVisible,
position: viewGroupToSave.position,
fieldMetadataId: viewGroupToSave.fieldMetadataId,
fieldValue: viewGroupToSave.fieldValue,
},
},
@@ -160,18 +154,22 @@ export const useSaveCurrentViewGroups = () => {
(viewFieldToSave) =>
!currentViewGroups.some(
(currentViewGroup) =>
currentViewGroup.fieldValue === viewFieldToSave.fieldValue &&
currentViewGroup.fieldMetadataId ===
viewFieldToSave.fieldMetadataId,
currentViewGroup.fieldValue === viewFieldToSave.fieldValue,
),
);
if (!isDefined(view.mainGroupByFieldMetadataId)) {
throw new Error('mainGroupByFieldMetadataId is required');
}
await Promise.all([
createViewGroups({
inputs: viewGroupsToCreate.map(({ __typename, ...viewGroup }) => ({
...viewGroup,
viewId: view.id,
})),
createCoreViewGroupInputs: {
inputs: viewGroupsToCreate.map((viewGroupToCreate) => ({
...viewGroupToCreate,
viewId: view.id,
})),
},
}),
updateViewGroups(viewGroupsToUpdate),
]);
packages/twenty-front/src/modules/views/optimistic-effects/hooks/useTriggerViewGroupOptimisticEffect.ts
+1
View File
@@ -6,6 +6,7 @@ import { useRecoilCallback } from 'recoil';
import { isDefined } from 'twenty-shared/utils';
import { type CoreViewGroup } from '~/generated/graphql';
import { isDeeplyEqual } from '~/utils/isDeeplyEqual';
type UpdatedDeletedCoreViewGroup = {
createdViewGroups?: Omit<CoreViewGroup, 'workspaceId'>[];
updatedViewGroups?: Omit<CoreViewGroup, 'workspaceId'>[];
packages/twenty-front/src/modules/views/types/ViewGroup.ts
-1
View File
@@ -1,7 +1,6 @@
export type ViewGroup = {
__typename: 'ViewGroup';
id: string;
fieldMetadataId: string;
isVisible: boolean;
fieldValue: string;
position: number;
packages/twenty-front/src/modules/views/utils/convertCoreViewGroupToViewGroup.ts
+1 -2
View File
@@ -4,13 +4,12 @@ import { type CoreViewGroup } from '~/generated/graphql';
export const convertCoreViewGroupToViewGroup = (
coreViewGroup: Pick<
CoreViewGroup,
'id' | 'fieldMetadataId' | 'isVisible' | 'fieldValue' | 'position'
'id' | 'isVisible' | 'fieldValue' | 'position'
>,
): ViewGroup => {
return {
__typename: 'ViewGroup',
id: coreViewGroup.id,
fieldMetadataId: coreViewGroup.fieldMetadataId,
isVisible: coreViewGroup.isVisible,
fieldValue: coreViewGroup.fieldValue,
position: coreViewGroup.position,
packages/twenty-front/src/modules/views/utils/mapViewGroupsToRecordGroupDefinitions.ts
+4 -7
View File
@@ -8,9 +8,11 @@ import { isDefined } from 'twenty-shared/utils';
import { FieldMetadataType } from '~/generated-metadata/graphql';
export const mapViewGroupsToRecordGroupDefinitions = ({
mainGroupByFieldMetadataId,
objectMetadataItem,
viewGroups,
}: {
mainGroupByFieldMetadataId: string;
objectMetadataItem: ObjectMetadataItem;
viewGroups: ViewGroup[];
}): RecordGroupDefinition[] => {
@@ -18,10 +20,10 @@ export const mapViewGroupsToRecordGroupDefinitions = ({
return [];
}
const fieldMetadataId = viewGroups?.[0]?.fieldMetadataId;
const selectFieldMetadataItem = objectMetadataItem.fields.find(
(field) =>
field.id === fieldMetadataId && field.type === FieldMetadataType.SELECT,
field.id === mainGroupByFieldMetadataId &&
field.type === FieldMetadataType.SELECT,
);
if (!selectFieldMetadataItem) {
@@ -36,10 +38,6 @@ export const mapViewGroupsToRecordGroupDefinitions = ({
const recordGroupDefinitionsFromViewGroups = viewGroups
.map((viewGroup) => {
if (viewGroup.fieldMetadataId !== selectFieldMetadataItem.id) {
return null;
}
const selectedOption = selectFieldMetadataItem.options?.find(
(option) => option.value === viewGroup.fieldValue,
);
@@ -50,7 +48,6 @@ export const mapViewGroupsToRecordGroupDefinitions = ({
return {
id: viewGroup.id,
fieldMetadataId: viewGroup.fieldMetadataId,
type: !isDefined(selectedOption)
? RecordGroupDefinitionType.NoValue
: RecordGroupDefinitionType.Value,
packages/twenty-front/src/modules/views/utils/recordGroupDefinitionToViewGroup.ts
-1
View File
@@ -7,7 +7,6 @@ export const recordGroupDefinitionToViewGroup = (
return {
__typename: 'ViewGroup',
id: recordGroup.id,
fieldMetadataId: recordGroup.fieldMetadataId,
position: recordGroup.position,
isVisible: recordGroup.isVisible ?? true,
fieldValue: recordGroup.value ?? '',