Skip to content

The open alternative to Salesforce, designed for AI.

Show validation rules the server refused a record with in the creation form (#27630)

Thomas Trompetted951b09880b4
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 d8b8d5aaa0e..fcadbd2597c 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
@@ -1,6 +1,4 @@
-import { getToastOptionsFromError } from '@/error-handler/utils/getToastOptionsFromError';
import { useSidePanelHistory } from '@/side-panel/hooks/useSidePanelHistory';
-import { useToast } from 'twenty-ui/components/feedback';
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
import { RecordCreationFormCancellationEffect } from '@/object-record/record-form/components/RecordCreationFormCancellationEffect';
import {
@@ -33,7 +31,6 @@ export const RecordCreationFormProvider = ({
children,
}: RecordCreationFormProviderProps) => {
const store = useStore();
- const { enqueueToast } = useToast();
const { removePageFromSidePanelHistory } = useSidePanelHistory();
const { navigateSidePanelMenu } = useSidePanelMenu();
@@ -93,8 +90,6 @@ export const RecordCreationFormProvider = ({
),
);
- enqueueToast(getToastOptionsFromError({ error }));
-
return { error };
}
@@ -110,7 +105,7 @@ export const RecordCreationFormProvider = ({
return {};
},
- [enqueueToast, pendingRecordCreations, removePageFromSidePanelHistory],
+ [pendingRecordCreations, removePageFromSidePanelHistory],
);
const requestRecordCreation = useCallback(
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 8da31077f7a..c5729a52165 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
@@ -21,10 +21,6 @@ jest.mock('@/side-panel/hooks/useSidePanelMenu', () => ({
closeSidePanelMenu: mockCloseSidePanelMenu,
}),
}));
-jest.mock('twenty-ui/components/feedback', () => ({
- ...jest.requireActual('twenty-ui/components/feedback'),
- useToast: () => ({ enqueueToast: jest.fn() }),
-}));
const setup = () => {
const store = createStore();
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 6e57ce25027..8dbda8acd71 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
@@ -1,3 +1,4 @@
+import { getToastOptionsFromError } from '@/error-handler/utils/getToastOptionsFromError';
import { ObjectMetadataIcon } from '@/object-metadata/components/ObjectMetadataIcon';
import { HeaderIdentifier } from '@/ui/layout/page/components/HeaderIdentifier';
import { PageCardHeader } from '@/ui/layout/page/components/PageCardHeader';
@@ -21,10 +22,10 @@ import { recordCreationFormDraftComponentState } from '@/side-panel/pages/record
import { recordCreationFormRequestComponentState } from '@/side-panel/pages/record-creation-form/states/recordCreationFormRequestComponentState';
import { SidePanelFooter } from '@/ui/layout/side-panel/components/SidePanelFooter';
import { useValidationRules } from '@/validation-rules/hooks/useValidationRules';
-import { type DraftValidationRuleViolation } from '@/validation-rules/types/DraftValidationRuleViolation';
+import { type ValidationRuleViolation } from '@/validation-rules/types/ValidationRuleViolation';
import { buildValidationRuleFieldDescriptors } from '@/validation-rules/utils/buildValidationRuleFieldDescriptors';
import { computeDraftValidationRuleViolations } from '@/validation-rules/utils/computeDraftValidationRuleViolations';
-import { getValidationRuleViolationFieldMetadataIdsFromError } from '@/validation-rules/utils/getValidationRuleViolationFieldMetadataIdsFromError';
+import { getValidationRuleViolationsFromError } from '@/validation-rules/utils/getValidationRuleViolationsFromError';
import { useAtomComponentState } from '@/ui/utilities/state/jotai/hooks/useAtomComponentState';
import { useAtomComponentStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomComponentStateValue';
import { useState } from 'react';
@@ -34,6 +35,7 @@ import { Key } from 'ts-key-enum';
import { type JsonValue } from 'type-fest';
import { PermissionFlagType } from 'twenty-shared/constants';
import { isDefined } from 'twenty-shared/utils';
+import { useToast } from 'twenty-ui/components/feedback';
import { LightButton } from 'twenty-ui/components/input';
import { IconChevronDown, IconChevronUp, IconPlus } from 'twenty-ui/icon';
import { Button } from 'twenty-ui/primitives/input';
@@ -112,6 +114,7 @@ const SidePanelRecordCreationForm = ({
const theme = useTheme();
const { settleRecordCreationDraft } = useRecordCreationFormSettle();
+ const { enqueueToast } = useToast();
const [recordCreationFormDraft, setRecordCreationFormDraft] =
useAtomComponentState(recordCreationFormDraftComponentState);
@@ -124,9 +127,10 @@ const SidePanelRecordCreationForm = ({
);
const [isSubmitting, setIsSubmitting] = useState(false);
- const [validationRuleViolations, setValidationRuleViolations] = useState<
- DraftValidationRuleViolation[]
- >([]);
+ const [draftValidationRuleViolations, setDraftValidationRuleViolations] =
+ useState<ValidationRuleViolation[]>([]);
+ const [serverValidationRuleViolations, setServerValidationRuleViolations] =
+ useState<ValidationRuleViolation[]>([]);
const { validationRules } = useValidationRules({ objectMetadataId });
const currentFocusId = useAtomStateValue(currentFocusIdSelector);
@@ -161,6 +165,11 @@ const SidePanelRecordCreationForm = ({
const hiddenFieldsCount = hiddenFieldMetadataItems.length;
+ const validationRuleViolations = [
+ ...draftValidationRuleViolations,
+ ...serverValidationRuleViolations,
+ ];
+
const computeViolations = (draftRecordToCheck: Partial<ObjectRecord>) =>
computeDraftValidationRuleViolations({
validationRules,
@@ -179,8 +188,8 @@ const SidePanelRecordCreationForm = ({
[gqlFieldName]: value,
}));
- if (validationRuleViolations.length > 0) {
- setValidationRuleViolations(
+ if (draftValidationRuleViolations.length > 0) {
+ setDraftValidationRuleViolations(
computeViolations({ ...draftRecord, [gqlFieldName]: value }),
);
}
@@ -212,10 +221,12 @@ const SidePanelRecordCreationForm = ({
return;
}
+ setServerValidationRuleViolations([]);
+
if (validationRules.length > 0) {
const draftViolations = computeViolations(draftRecord);
- setValidationRuleViolations(draftViolations);
+ setDraftValidationRuleViolations(draftViolations);
revealHiddenFieldsIfTargeted(
draftViolations.map((violation) => violation.fieldMetadataId),
@@ -237,8 +248,21 @@ const SidePanelRecordCreationForm = ({
}),
});
+ if (!isDefined(error)) {
+ return;
+ }
+
+ const serverViolations = getValidationRuleViolationsFromError(error);
+
+ setServerValidationRuleViolations(serverViolations);
+
+ if (serverViolations.length === 0) {
+ enqueueToast(getToastOptionsFromError({ error }));
+ return;
+ }
+
revealHiddenFieldsIfTargeted(
- getValidationRuleViolationFieldMetadataIdsFromError(error),
+ serverViolations.map((violation) => violation.fieldMetadataId),
);
} 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 c9aa38d2761..02510eaf797 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
@@ -87,7 +87,11 @@ const buildValidationRuleViolationError = (fieldMetadataId: string) =>
extensions: {
subCode: 'VALIDATION_RULE_VIOLATION',
validationRuleViolations: [
- { ruleId: 'nickname-rule', fieldMetadataId },
+ {
+ ruleId: 'nickname-rule',
+ message: 'A company needs a nickname',
+ fieldMetadataId,
+ },
],
},
},
@@ -96,6 +100,12 @@ const buildValidationRuleViolationError = (fieldMetadataId: string) =>
let mockValidationRules: ValidationRule[] = [];
const openRecordCreationFormSettingsInSidePanel = jest.fn();
const mockHasPermissionFlag = jest.fn();
+const mockEnqueueToast = jest.fn();
+
+jest.mock('twenty-ui/components/feedback', () => ({
+ ...jest.requireActual('twenty-ui/components/feedback'),
+ useToast: () => ({ enqueueToast: mockEnqueueToast }),
+}));
jest.mock('@/object-metadata/hooks/useObjectMetadataItemById', () => ({
useObjectMetadataItemById: () => ({ objectMetadataItem: COMPANY_OBJECT }),
@@ -370,7 +380,7 @@ describe('SidePanelRecordCreationFormPage', () => {
expect(screen.queryByLabelText('Nickname')).not.toBeInTheDocument();
});
- it('reveals a hidden field the server rejected through a validation rule', async () => {
+ it('reveals a hidden field the server rejected through a validation rule and shows the message in the form', async () => {
const user = userEvent.setup();
settleRecordCreationDraft.mockResolvedValue({
@@ -387,6 +397,49 @@ describe('SidePanelRecordCreationFormPage', () => {
draftRecord: {},
});
expect(screen.getByLabelText('Nickname')).toBeInTheDocument();
+ expect(screen.getByRole('alert')).toHaveTextContent(
+ 'A company needs a nickname',
+ );
+ expect(mockEnqueueToast).not.toHaveBeenCalled();
+ });
+
+ it('keeps a message from the server while the user edits, until the next create', async () => {
+ const user = userEvent.setup();
+
+ settleRecordCreationDraft.mockResolvedValueOnce({
+ error: buildValidationRuleViolationError(NAME_FIELD.id),
+ });
+
+ renderPage();
+
+ await user.click(screen.getByTestId('record-creation-form-create-button'));
+ await user.type(screen.getByLabelText('Domain'), 'apple.com');
+
+ expect(screen.getByRole('alert')).toHaveTextContent(
+ 'A company needs a nickname',
+ );
+
+ await user.click(screen.getByTestId('record-creation-form-create-button'));
+
+ expect(screen.queryByRole('alert')).not.toBeInTheDocument();
+ });
+
+ it('shows a server error that is not a validation rule violation as a toast', async () => {
+ const user = userEvent.setup();
+
+ settleRecordCreationDraft.mockResolvedValue({
+ error: new Error('Network error'),
+ });
+
+ renderPage();
+
+ await user.click(screen.getByTestId('record-creation-form-create-button'));
+
+ expect(mockEnqueueToast).toHaveBeenCalledTimes(1);
+ expect(mockEnqueueToast).toHaveBeenCalledWith(
+ expect.objectContaining({ variant: 'error', children: 'Network error' }),
+ );
+ expect(screen.queryByRole('alert')).not.toBeInTheDocument();
});
it('keeps hidden fields collapsed when the server rejects a visible field', async () => {
diff --git a/packages/twenty-front/src/modules/validation-rules/types/DraftValidationRuleViolation.ts b/packages/twenty-front/src/modules/validation-rules/types/ValidationRuleViolation.ts
similarity index 62%
rename from packages/twenty-front/src/modules/validation-rules/types/DraftValidationRuleViolation.ts
rename to packages/twenty-front/src/modules/validation-rules/types/ValidationRuleViolation.ts
index 03deec281d4..57a3381c7c0 100644
--- a/packages/twenty-front/src/modules/validation-rules/types/DraftValidationRuleViolation.ts
+++ b/packages/twenty-front/src/modules/validation-rules/types/ValidationRuleViolation.ts
@@ -1,4 +1,4 @@
-export type DraftValidationRuleViolation = {
+export type ValidationRuleViolation = {
ruleId: string;
message: string;
fieldMetadataId: string | null;
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
deleted file mode 100644
index b08282f7687..00000000000
--- a/packages/twenty-front/src/modules/validation-rules/utils/__tests__/getValidationRuleViolationFieldMetadataIdsFromError.test.ts
+++ /dev/null
@@ -1,48 +0,0 @@
-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/__tests__/getValidationRuleViolationsFromError.test.ts b/packages/twenty-front/src/modules/validation-rules/utils/__tests__/getValidationRuleViolationsFromError.test.ts
new file mode 100644
index 00000000000..f502bcb5f4a
--- /dev/null
+++ b/packages/twenty-front/src/modules/validation-rules/utils/__tests__/getValidationRuleViolationsFromError.test.ts
@@ -0,0 +1,69 @@
+import { CombinedGraphQLErrors } from '@apollo/client/errors';
+
+import { getValidationRuleViolationsFromError } from '@/validation-rules/utils/getValidationRuleViolationsFromError';
+
+const buildError = (extensions: Record<string, unknown>) =>
+ new CombinedGraphQLErrors({
+ data: null,
+ errors: [{ message: 'refused', extensions }],
+ });
+
+describe('getValidationRuleViolationsFromError', () => {
+ it('should return the validation rule violations the server refused the record with', () => {
+ expect(
+ getValidationRuleViolationsFromError(
+ buildError({
+ subCode: 'VALIDATION_RULE_VIOLATION',
+ validationRuleViolations: [
+ {
+ ruleId: 'amount-rule',
+ message: 'A deal needs an amount',
+ fieldMetadataId: 'field-amount',
+ },
+ {
+ ruleId: 'record-rule',
+ message: 'A deal needs a company or a person',
+ fieldMetadataId: null,
+ },
+ ],
+ }),
+ ),
+ ).toEqual([
+ {
+ ruleId: 'amount-rule',
+ message: 'A deal needs an amount',
+ fieldMetadataId: 'field-amount',
+ },
+ {
+ ruleId: 'record-rule',
+ message: 'A deal needs a company or a person',
+ fieldMetadataId: null,
+ },
+ ]);
+ });
+
+ it('should return nothing for rules that could not be evaluated, and for other errors', () => {
+ expect(
+ getValidationRuleViolationsFromError(
+ buildError({
+ subCode: 'VALIDATION_RULE_EVALUATION_FAILED',
+ validationRuleViolations: [
+ {
+ ruleId: 'amount-rule',
+ message: 'A deal needs an amount',
+ fieldMetadataId: 'field-amount',
+ },
+ ],
+ }),
+ ),
+ ).toEqual([]);
+ expect(
+ getValidationRuleViolationsFromError(
+ buildError({ subCode: 'RECORD_NOT_FOUND' }),
+ ),
+ ).toEqual([]);
+ expect(
+ getValidationRuleViolationsFromError(new Error('Network error')),
+ ).toEqual([]);
+ });
+});
diff --git a/packages/twenty-front/src/modules/validation-rules/utils/computeDraftValidationRuleViolations.ts b/packages/twenty-front/src/modules/validation-rules/utils/computeDraftValidationRuleViolations.ts
index 79f1069b6de..20491c294d6 100644
--- a/packages/twenty-front/src/modules/validation-rules/utils/computeDraftValidationRuleViolations.ts
+++ b/packages/twenty-front/src/modules/validation-rules/utils/computeDraftValidationRuleViolations.ts
@@ -1,5 +1,5 @@
import { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
-import { type DraftValidationRuleViolation } from '@/validation-rules/types/DraftValidationRuleViolation';
+import { type ValidationRuleViolation } from '@/validation-rules/types/ValidationRuleViolation';
import { type ValidationRule } from '@/validation-rules/types/ValidationRule';
import { isNonEmptyString, isUndefined } from '@sniptt/guards';
import {
@@ -166,7 +166,7 @@ export const computeDraftValidationRuleViolations = ({
fields: ValidationRuleFieldDescriptor[];
fieldMetadataItems: DraftFieldMetadataItem[];
now: string;
-}): DraftValidationRuleViolation[] => {
+}): ValidationRuleViolation[] => {
const draftRecordWithDefaultValues = withStaticDefaultValues({
draftRecord,
fieldMetadataItems,
diff --git a/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleViolationFieldMetadataIdsFromError.ts b/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleViolationsFromError.ts
similarity index 52%
rename from packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleViolationFieldMetadataIdsFromError.ts
rename to packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleViolationsFromError.ts
index 3f3931d6018..df0bef07608 100644
--- a/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleViolationFieldMetadataIdsFromError.ts
+++ b/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleViolationsFromError.ts
@@ -1,12 +1,13 @@
import { isNonEmptyString } from '@sniptt/guards';
import { isPlainObject } from 'twenty-shared/utils';
+import { type ValidationRuleViolation } from '@/validation-rules/types/ValidationRuleViolation';
import { getGraphqlErrorExtensionsFromError } from '~/utils/get-graphql-error-extensions-from-error.util';
import { isGraphqlErrorOfType } from '~/utils/is-graphql-error-of-type.util';
-export const getValidationRuleViolationFieldMetadataIdsFromError = (
+export const getValidationRuleViolationsFromError = (
error: unknown,
-): string[] => {
+): ValidationRuleViolation[] => {
if (!isGraphqlErrorOfType(error, 'VALIDATION_RULE_VIOLATION')) {
return [];
}
@@ -20,8 +21,19 @@ export const getValidationRuleViolationFieldMetadataIdsFromError = (
return validationRuleViolations.flatMap((validationRuleViolation) =>
isPlainObject(validationRuleViolation) &&
- isNonEmptyString(validationRuleViolation.fieldMetadataId)
- ? [validationRuleViolation.fieldMetadataId]
+ isNonEmptyString(validationRuleViolation.ruleId) &&
+ isNonEmptyString(validationRuleViolation.message)
+ ? [
+ {
+ ruleId: validationRuleViolation.ruleId,
+ message: validationRuleViolation.message,
+ fieldMetadataId: isNonEmptyString(
+ validationRuleViolation.fieldMetadataId,
+ )
+ ? validationRuleViolation.fieldMetadataId
+ : null,
+ },
+ ]
: [],
);
};