Skip to content

The open alternative to Salesforce, designed for AI.

Reveal hidden fields targeted by a validation rule the server enforces (#27495)

Thomas Trompetteea9620c4a80f
diff --git a/packages/twenty-front/src/modules/object-record/record-form/components/RecordCreationFormProvider.tsx b/packages/twenty-front/src/modules/object-record/record-form/components/RecordCreationFormProvider.tsx
index a39a86f88ed..d8b8d5aaa0e 100644
--- a/packages/twenty-front/src/modules/object-record/record-form/components/RecordCreationFormProvider.tsx
+++ b/packages/twenty-front/src/modules/object-record/record-form/components/RecordCreationFormProvider.tsx
@@ -57,7 +57,7 @@ export const RecordCreationFormProvider = ({
!isDefined(pendingRecordCreation) ||
pendingRecordCreation.isSettling
) {
- return;
+ return {};
}
if (draftRecord === null) {
@@ -69,7 +69,7 @@ export const RecordCreationFormProvider = ({
),
);
- return;
+ return {};
}
setPendingRecordCreations((previousPendingRecordCreations) =>
@@ -95,7 +95,7 @@ export const RecordCreationFormProvider = ({
enqueueToast(getToastOptionsFromError({ error }));
- return;
+ return { error };
}
removePageFromSidePanelHistory(requestId);
@@ -107,6 +107,8 @@ export const RecordCreationFormProvider = ({
(candidate) => candidate.requestId !== requestId,
),
);
+
+ return {};
},
[enqueueToast, pendingRecordCreations, removePageFromSidePanelHistory],
);
diff --git a/packages/twenty-front/src/modules/object-record/record-form/components/__tests__/RecordCreationFormProvider.test.tsx b/packages/twenty-front/src/modules/object-record/record-form/components/__tests__/RecordCreationFormProvider.test.tsx
index 5bcfabe246d..8da31077f7a 100644
--- a/packages/twenty-front/src/modules/object-record/record-form/components/__tests__/RecordCreationFormProvider.test.tsx
+++ b/packages/twenty-front/src/modules/object-record/record-form/components/__tests__/RecordCreationFormProvider.test.tsx
@@ -6,6 +6,7 @@ import {
sidePanelNavigationStackState,
type SidePanelNavigationStackItem,
} from '@/side-panel/states/sidePanelNavigationStackState';
+import { CombinedGraphQLErrors } from '@apollo/client/errors';
import { act, renderHook } from '@testing-library/react';
import { createStore, Provider } from 'jotai';
import { type ReactNode } from 'react';
@@ -62,7 +63,7 @@ it('removes the form from deeper in the history when the user moved on before cr
});
});
const [formPage] = store.get(sidePanelNavigationStackState.atom);
- let submission: Promise<void> | undefined;
+ let submission: Promise<unknown> | undefined;
act(() => {
submission = result.current.settleRecordCreationDraft({
requestId: formPage.pageId,
@@ -89,3 +90,42 @@ it('removes the form from deeper in the history when the user moved on before cr
expect(mockCloseSidePanelMenu).not.toHaveBeenCalled();
expect(store.get(sidePanelNavigationStackState.atom)).toEqual([otherPage]);
});
+
+it('resolves with the error the server rejected the draft with and keeps the form open', async () => {
+ const { result, store } = setup();
+ const rejection = new CombinedGraphQLErrors({
+ data: null,
+ errors: [
+ {
+ message: 'A company needs an amount',
+ extensions: {
+ subCode: 'VALIDATION_RULE_VIOLATION',
+ validationRuleViolations: [
+ { ruleId: 'amount-rule', fieldMetadataId: 'field-amount' },
+ ],
+ },
+ },
+ ],
+ });
+ const createRecord = jest.fn(() => Promise.reject(rejection));
+ act(() => {
+ void result.current.requestRecordCreation({
+ objectMetadataItem: getMockObjectMetadataItemOrThrow('company'),
+ createRecord,
+ });
+ });
+ const [formPage] = store.get(sidePanelNavigationStackState.atom);
+
+ let settlement: unknown;
+ await act(async () => {
+ settlement = await result.current.settleRecordCreationDraft({
+ requestId: formPage.pageId,
+ draftRecord: { name: 'Test' },
+ });
+ });
+
+ expect(createRecord).toHaveBeenCalledTimes(1);
+ expect(createRecord).toHaveBeenCalledWith({ name: 'Test' });
+ expect(settlement).toEqual({ error: rejection });
+ expect(store.get(sidePanelNavigationStackState.atom)).toEqual([formPage]);
+});
diff --git a/packages/twenty-front/src/modules/object-record/record-form/contexts/RecordCreationFormContext.ts b/packages/twenty-front/src/modules/object-record/record-form/contexts/RecordCreationFormContext.ts
index d1000127cd9..370b86a7464 100644
--- a/packages/twenty-front/src/modules/object-record/record-form/contexts/RecordCreationFormContext.ts
+++ b/packages/twenty-front/src/modules/object-record/record-form/contexts/RecordCreationFormContext.ts
@@ -11,7 +11,7 @@ export type RecordCreationFormContextValue = {
settleRecordCreationDraft: (params: {
requestId: string;
draftRecord: Partial<ObjectRecord> | null;
- }) => Promise<void>;
+ }) => Promise<{ error?: unknown }>;
};
export const [
diff --git a/packages/twenty-front/src/modules/side-panel/pages/record-creation-form/components/SidePanelRecordCreationFormPage.tsx b/packages/twenty-front/src/modules/side-panel/pages/record-creation-form/components/SidePanelRecordCreationFormPage.tsx
index 9fb2a949dc6..c882ad7bfb3 100644
--- a/packages/twenty-front/src/modules/side-panel/pages/record-creation-form/components/SidePanelRecordCreationFormPage.tsx
+++ b/packages/twenty-front/src/modules/side-panel/pages/record-creation-form/components/SidePanelRecordCreationFormPage.tsx
@@ -22,6 +22,7 @@ import { useValidationRules } from '@/validation-rules/hooks/useValidationRules'
import { type DraftValidationRuleViolation } from '@/validation-rules/types/DraftValidationRuleViolation';
import { buildValidationRuleFieldDescriptors } from '@/validation-rules/utils/buildValidationRuleFieldDescriptors';
import { computeDraftValidationRuleViolations } from '@/validation-rules/utils/computeDraftValidationRuleViolations';
+import { getValidationRuleViolationFieldMetadataIdsFromError } from '@/validation-rules/utils/getValidationRuleViolationFieldMetadataIdsFromError';
import { useAtomComponentState } from '@/ui/utilities/state/jotai/hooks/useAtomComponentState';
import { useAtomComponentStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomComponentStateValue';
import { useState } from 'react';
@@ -185,6 +186,19 @@ const SidePanelRecordCreationForm = ({
updateDraftRecord(gqlFieldName, null);
};
+ const revealHiddenFieldsIfTargeted = (
+ targetedFieldMetadataIds: (string | null)[],
+ ) => {
+ const isAnyHiddenFieldTargeted = hiddenFieldMetadataItems.some(
+ (fieldMetadataItem) =>
+ targetedFieldMetadataIds.includes(fieldMetadataItem.id),
+ );
+
+ if (isAnyHiddenFieldTargeted) {
+ setRecordCreationFormAreHiddenFieldsShown(true);
+ }
+ };
+
const handleCreateClick = async () => {
if (isSubmitting) {
return;
@@ -195,17 +209,10 @@ const SidePanelRecordCreationForm = ({
setValidationRuleViolations(draftViolations);
- const isAnyViolationOnHiddenField = draftViolations.some((violation) =>
- hiddenFieldMetadataItems.some(
- (fieldMetadataItem) =>
- fieldMetadataItem.id === violation.fieldMetadataId,
- ),
+ revealHiddenFieldsIfTargeted(
+ draftViolations.map((violation) => violation.fieldMetadataId),
);
- if (isAnyViolationOnHiddenField) {
- setRecordCreationFormAreHiddenFieldsShown(true);
- }
-
if (draftViolations.length > 0) {
return;
}
@@ -213,7 +220,7 @@ const SidePanelRecordCreationForm = ({
setIsSubmitting(true);
try {
- await settleRecordCreationDraft({
+ const { error } = await settleRecordCreationDraft({
requestId,
draftRecord: computeRecordFormCreateRecordInput({
draftRecord,
@@ -221,6 +228,10 @@ const SidePanelRecordCreationForm = ({
objectMetadataItems,
}),
});
+
+ revealHiddenFieldsIfTargeted(
+ getValidationRuleViolationFieldMetadataIdsFromError(error),
+ );
} finally {
setIsSubmitting(false);
}
diff --git a/packages/twenty-front/src/modules/side-panel/pages/record-creation-form/components/__tests__/SidePanelRecordCreationFormPage.test.tsx b/packages/twenty-front/src/modules/side-panel/pages/record-creation-form/components/__tests__/SidePanelRecordCreationFormPage.test.tsx
index 0c2d016e542..d9e45ca7f40 100644
--- a/packages/twenty-front/src/modules/side-panel/pages/record-creation-form/components/__tests__/SidePanelRecordCreationFormPage.test.tsx
+++ b/packages/twenty-front/src/modules/side-panel/pages/record-creation-form/components/__tests__/SidePanelRecordCreationFormPage.test.tsx
@@ -1,3 +1,4 @@
+import { CombinedGraphQLErrors } from '@apollo/client/errors';
import { i18n } from '@lingui/core';
import { I18nProvider } from '@lingui/react';
import { render, screen } from '@testing-library/react';
@@ -76,6 +77,22 @@ const NICKNAME_RULE: ValidationRule = {
};
const settleRecordCreationDraft = jest.fn();
+
+const buildValidationRuleViolationError = (fieldMetadataId: string) =>
+ new CombinedGraphQLErrors({
+ data: null,
+ errors: [
+ {
+ message: 'A company needs a nickname',
+ extensions: {
+ subCode: 'VALIDATION_RULE_VIOLATION',
+ validationRuleViolations: [
+ { ruleId: 'nickname-rule', fieldMetadataId },
+ ],
+ },
+ },
+ ],
+ });
let mockValidationRules: ValidationRule[] = [];
jest.mock('@/object-metadata/hooks/useObjectMetadataItemById', () => ({
@@ -225,6 +242,7 @@ describe('SidePanelRecordCreationFormPage', () => {
jest.clearAllMocks();
resetJotaiStore();
mockValidationRules = [];
+ settleRecordCreationDraft.mockResolvedValue({});
seedRecordFormPageLayout();
jotaiStore.set(
recordCreationFormRequestComponentState.atomFamily({
@@ -335,4 +353,42 @@ describe('SidePanelRecordCreationFormPage', () => {
);
expect(screen.queryByLabelText('Nickname')).not.toBeInTheDocument();
});
+
+ it('reveals a hidden field the server rejected through a validation rule', async () => {
+ const user = userEvent.setup();
+
+ settleRecordCreationDraft.mockResolvedValue({
+ error: buildValidationRuleViolationError(NICKNAME_FIELD.id),
+ });
+
+ renderPage();
+
+ await user.click(screen.getByTestId('record-creation-form-create-button'));
+
+ expect(settleRecordCreationDraft).toHaveBeenCalledTimes(1);
+ expect(settleRecordCreationDraft).toHaveBeenCalledWith({
+ requestId: REQUEST_ID,
+ draftRecord: {},
+ });
+ expect(screen.getByLabelText('Nickname')).toBeInTheDocument();
+ });
+
+ it('keeps hidden fields collapsed when the server rejects a visible field', async () => {
+ const user = userEvent.setup();
+
+ settleRecordCreationDraft.mockResolvedValue({
+ error: buildValidationRuleViolationError(NAME_FIELD.id),
+ });
+
+ renderPage();
+
+ await user.click(screen.getByTestId('record-creation-form-create-button'));
+
+ expect(settleRecordCreationDraft).toHaveBeenCalledTimes(1);
+ expect(settleRecordCreationDraft).toHaveBeenCalledWith({
+ requestId: REQUEST_ID,
+ draftRecord: {},
+ });
+ expect(screen.queryByLabelText('Nickname')).not.toBeInTheDocument();
+ });
});
diff --git a/packages/twenty-front/src/modules/validation-rules/utils/__tests__/getValidationRuleViolationFieldMetadataIdsFromError.test.ts b/packages/twenty-front/src/modules/validation-rules/utils/__tests__/getValidationRuleViolationFieldMetadataIdsFromError.test.ts
new file mode 100644
index 00000000000..b08282f7687
--- /dev/null
+++ b/packages/twenty-front/src/modules/validation-rules/utils/__tests__/getValidationRuleViolationFieldMetadataIdsFromError.test.ts
@@ -0,0 +1,48 @@
+import { CombinedGraphQLErrors } from '@apollo/client/errors';
+
+import { getValidationRuleViolationFieldMetadataIdsFromError } from '@/validation-rules/utils/getValidationRuleViolationFieldMetadataIdsFromError';
+
+const buildError = (extensions: Record<string, unknown>) =>
+ new CombinedGraphQLErrors({
+ data: null,
+ errors: [{ message: 'refused', extensions }],
+ });
+
+describe('getValidationRuleViolationFieldMetadataIdsFromError', () => {
+ it('should return the fields targeted by the validation rule violations', () => {
+ expect(
+ getValidationRuleViolationFieldMetadataIdsFromError(
+ buildError({
+ subCode: 'VALIDATION_RULE_VIOLATION',
+ validationRuleViolations: [
+ { ruleId: 'amount-rule', fieldMetadataId: 'field-amount' },
+ { ruleId: 'record-rule', fieldMetadataId: null },
+ ],
+ }),
+ ),
+ ).toEqual(['field-amount']);
+ });
+
+ it('should return nothing for rules that could not be evaluated, and for other errors', () => {
+ expect(
+ getValidationRuleViolationFieldMetadataIdsFromError(
+ buildError({
+ subCode: 'VALIDATION_RULE_EVALUATION_FAILED',
+ validationRuleViolations: [
+ { ruleId: 'amount-rule', fieldMetadataId: 'field-amount' },
+ ],
+ }),
+ ),
+ ).toEqual([]);
+ expect(
+ getValidationRuleViolationFieldMetadataIdsFromError(
+ buildError({ subCode: 'RECORD_NOT_FOUND' }),
+ ),
+ ).toEqual([]);
+ expect(
+ getValidationRuleViolationFieldMetadataIdsFromError(
+ new Error('Network error'),
+ ),
+ ).toEqual([]);
+ });
+});
diff --git a/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleViolationFieldMetadataIdsFromError.ts b/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleViolationFieldMetadataIdsFromError.ts
new file mode 100644
index 00000000000..3f3931d6018
--- /dev/null
+++ b/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleViolationFieldMetadataIdsFromError.ts
@@ -0,0 +1,27 @@
+import { isNonEmptyString } from '@sniptt/guards';
+import { isPlainObject } from 'twenty-shared/utils';
+
+import { getGraphqlErrorExtensionsFromError } from '~/utils/get-graphql-error-extensions-from-error.util';
+import { isGraphqlErrorOfType } from '~/utils/is-graphql-error-of-type.util';
+
+export const getValidationRuleViolationFieldMetadataIdsFromError = (
+ error: unknown,
+): string[] => {
+ if (!isGraphqlErrorOfType(error, 'VALIDATION_RULE_VIOLATION')) {
+ return [];
+ }
+
+ const validationRuleViolations =
+ getGraphqlErrorExtensionsFromError(error)?.validationRuleViolations;
+
+ if (!Array.isArray(validationRuleViolations)) {
+ return [];
+ }
+
+ return validationRuleViolations.flatMap((validationRuleViolation) =>
+ isPlainObject(validationRuleViolation) &&
+ isNonEmptyString(validationRuleViolation.fieldMetadataId)
+ ? [validationRuleViolation.fieldMetadataId]
+ : [],
+ );
+};