feat: add atomic upsertFieldsWidget mutation to replace multiple view field group/field API calls
#18137
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { VIEW_FIELD_GROUP_FRAGMENT } from '@/views/graphql/fragments/viewFieldGroupFragment'; | ||
| import { gql } from '@apollo/client'; | ||
|
|
||
| export const UPSERT_FIELDS_WIDGET = gql` | ||
| ${VIEW_FIELD_GROUP_FRAGMENT} | ||
| mutation UpsertFieldsWidget($input: UpsertFieldsWidgetInput!) { | ||
| upsertFieldsWidget(input: $input) { | ||
| ...ViewFieldGroupFragment | ||
| } | ||
| } | ||
| `; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,31 @@ | ||
| import { fieldsWidgetGroupsDraftComponentState } from '@/page-layout/states/fieldsWidgetGroupsDraftComponentState'; | ||
| import { fieldsWidgetGroupsPersistedComponentState } from '@/page-layout/states/fieldsWidgetGroupsPersistedComponentState'; | ||
| import { UPSERT_FIELDS_WIDGET } from '@/page-layout/graphql/mutations/upsertFieldsWidget'; | ||
| import { useRecoilComponentCallbackState } from '@/ui/utilities/state/component-state/hooks/useRecoilComponentCallbackState'; | ||
| import { useRefreshAllCoreViews } from '@/views/hooks/useRefreshAllCoreViews'; | ||
| import { useMutation } from '@apollo/client'; | ||
| import { useRecoilCallback } from 'recoil'; | ||
| import { isDefined } from 'twenty-shared/utils'; | ||
| import { type CoreViewFieldGroup } from '~/generated-metadata/graphql'; | ||
|
|
||
| type UpsertFieldsWidgetInput = { | ||
| widgetId: string; | ||
| groups: { | ||
| id: string; | ||
| name: string; | ||
| position: number; | ||
| isVisible: boolean; | ||
| fields: { | ||
| viewFieldId: string; | ||
| isVisible: boolean; | ||
| position: number; | ||
| }[]; | ||
| }[]; | ||
| }; | ||
|
|
||
| type UpsertFieldsWidgetResult = { | ||
| upsertFieldsWidget: CoreViewFieldGroup[]; | ||
| }; | ||
|
|
||
| type UseSaveFieldsWidgetGroupsParams = { | ||
| pageLayoutId: string; | ||
|
|
@@ -31,52 +44,13 @@ export const useSaveFieldsWidgetGroups = ({ | |
| pageLayoutId, | ||
| ); | ||
|
|
||
| const [upsertFieldsWidgetMutation] = useMutation< | ||
| UpsertFieldsWidgetResult, | ||
| { input: UpsertFieldsWidgetInput } | ||
| >(UPSERT_FIELDS_WIDGET); | ||
|
|
||
| const { refreshAllCoreViews } = useRefreshAllCoreViews(); | ||
|
|
||
| const saveFieldsWidgetGroups = useRecoilCallback( | ||
| ({ set, snapshot }) => | ||
| async () => { | ||
|
|
@@ -94,73 +68,33 @@ export const useSaveFieldsWidgetGroups = ({ | |
|
|
||
| for (const widgetId of widgetIds) { | ||
| const draftGroups = allDraftGroups[widgetId] ?? []; | ||
|
|
||
| await upsertFieldsWidgetMutation({ | ||
| variables: { | ||
| input: { | ||
| widgetId, | ||
| groups: draftGroups.map((group) => ({ | ||
| id: group.id, | ||
| name: group.name, | ||
| position: group.position, | ||
| isVisible: group.isVisible, | ||
| fields: group.fields.flatMap((field) => { | ||
| if (!isDefined(field.viewFieldId)) { | ||
| return []; | ||
| } | ||
|
|
||
| return [ | ||
| { | ||
| viewFieldId: field.viewFieldId, | ||
| isVisible: field.isVisible, | ||
| position: field.position, | ||
| }, | ||
| ]; | ||
| }), | ||
|
Comment on lines
+86
to
+98
Contributor
There was a problem hiding this comment. Using |
||
| })), | ||
| }, | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| set(fieldsWidgetGroupsPersistedState, allDraftGroups); | ||
|
Comment on lines
74
to
105
There was a problem hiding this comment. The mutation loop lacks error handling. If a mutation fails partway through, the persisted state is still updated on line 100, potentially causing inconsistency between frontend state and backend state. Consider wrapping the loop in try-catch and only updating persisted state if all mutations succeed, or handle partial failures appropriately. |
||
|
|
@@ -172,11 +106,7 @@ export const useSaveFieldsWidgetGroups = ({ | |
| [ | ||
| fieldsWidgetGroupsDraftState, | ||
| fieldsWidgetGroupsPersistedState, | ||
| upsertFieldsWidgetMutation, | ||
| refreshAllCoreViews, | ||
| ], | ||
| ); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| import { Field, InputType } from '@nestjs/graphql'; | ||
|
|
||
| import { IsBoolean, IsNotEmpty, IsNumber, IsUUID } from 'class-validator'; | ||
|
|
||
| import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars'; | ||
|
|
||
| @InputType() | ||
| export class UpsertFieldsWidgetFieldInput { | ||
| @IsUUID() | ||
| @IsNotEmpty() | ||
| @Field(() => UUIDScalarType, { description: 'The id of the view field' }) | ||
| viewFieldId: string; | ||
|
|
||
| @IsBoolean() | ||
| @Field() | ||
| isVisible: boolean; | ||
|
|
||
| @IsNumber() | ||
| @Field() | ||
| position: number; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| import { Field, InputType } from '@nestjs/graphql'; | ||
|
|
||
| import { Type } from 'class-transformer'; | ||
| import { | ||
| IsBoolean, | ||
| IsNotEmpty, | ||
| IsNumber, | ||
| IsString, | ||
| IsUUID, | ||
| ValidateNested, | ||
| } from 'class-validator'; | ||
|
|
||
| import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars'; | ||
| import { UpsertFieldsWidgetFieldInput } from 'src/engine/metadata-modules/view-field-group/dtos/inputs/upsert-fields-widget-field.input'; | ||
|
|
||
| @InputType() | ||
| export class UpsertFieldsWidgetGroupInput { | ||
| @IsUUID() | ||
| @IsNotEmpty() | ||
| @Field(() => UUIDScalarType) | ||
| id: string; | ||
|
|
||
| @IsString() | ||
| @IsNotEmpty() | ||
| @Field() | ||
| name: string; | ||
|
|
||
| @IsNumber() | ||
| @Field() | ||
| position: number; | ||
|
|
||
| @IsBoolean() | ||
| @Field() | ||
| isVisible: boolean; | ||
|
|
||
| @ValidateNested({ each: true }) | ||
| @Type(() => UpsertFieldsWidgetFieldInput) | ||
| @Field(() => [UpsertFieldsWidgetFieldInput]) | ||
| fields: UpsertFieldsWidgetFieldInput[]; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import { Field, InputType } from '@nestjs/graphql'; | ||
|
|
||
| import { Type } from 'class-transformer'; | ||
| import { IsNotEmpty, IsUUID, ValidateNested } from 'class-validator'; | ||
|
|
||
| import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars'; | ||
| import { UpsertFieldsWidgetGroupInput } from 'src/engine/metadata-modules/view-field-group/dtos/inputs/upsert-fields-widget-group.input'; | ||
|
|
||
| @InputType() | ||
| export class UpsertFieldsWidgetInput { | ||
| @IsUUID() | ||
| @IsNotEmpty() | ||
| @Field(() => UUIDScalarType, { | ||
| description: | ||
| 'The id of the fields widget whose groups and fields to upsert', | ||
| }) | ||
| widgetId: string; | ||
|
|
||
| @ValidateNested({ each: true }) | ||
| @Type(() => UpsertFieldsWidgetGroupInput) | ||
| @Field(() => [UpsertFieldsWidgetGroupInput]) | ||
| groups: UpsertFieldsWidgetGroupInput[]; | ||
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't find this logic anymore. Just want to make sure that we are not calling mutations for unchanged groups 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you click on the Save button of a dashboard, it triggers a mutation even if you changed nothing. The behavior is similar for record page layouts. I think we can go this way.