Skip to content

The open alternative to Salesforce, designed for AI.

Let the AI agent build validation rules from the side panel (#27635)

Thomas Trompettecff0cee1deb4
diff --git a/packages/twenty-front/src/modules/ai/hooks/__tests__/useGetBrowsingContext.test.tsx b/packages/twenty-front/src/modules/ai/hooks/__tests__/useGetBrowsingContext.test.tsx
new file mode 100644
index 00000000000..1e75124aba5
--- /dev/null
+++ b/packages/twenty-front/src/modules/ai/hooks/__tests__/useGetBrowsingContext.test.tsx
@@ -0,0 +1,31 @@
+import { renderHook } from '@testing-library/react';
+import { createStore, Provider as JotaiProvider } from 'jotai';
+import { type ReactNode } from 'react';
+
+import { useGetBrowsingContext } from '@/ai/hooks/useGetBrowsingContext';
+
+describe('useGetBrowsingContext', () => {
+ afterEach(() => {
+ window.history.pushState({}, '', '/');
+ });
+
+ it('describes a settings page by its path', () => {
+ window.history.pushState(
+ {},
+ '',
+ '/settings/objects/opportunities/validation-rules/rule-1',
+ );
+ const store = createStore();
+
+ const { result } = renderHook(() => useGetBrowsingContext(), {
+ wrapper: ({ children }: { children: ReactNode }) => (
+ <JotaiProvider store={store}>{children}</JotaiProvider>
+ ),
+ });
+
+ expect(result.current.getBrowsingContext()).toEqual({
+ type: 'settingsPage',
+ path: '/settings/objects/opportunities/validation-rules/rule-1',
+ });
+ });
+});
diff --git a/packages/twenty-front/src/modules/ai/hooks/useGetBrowsingContext.ts b/packages/twenty-front/src/modules/ai/hooks/useGetBrowsingContext.ts
index 28b822b6c99..7dfcbe5c068 100644
--- a/packages/twenty-front/src/modules/ai/hooks/useGetBrowsingContext.ts
+++ b/packages/twenty-front/src/modules/ai/hooks/useGetBrowsingContext.ts
@@ -9,6 +9,7 @@ import { getAiChatContextStoreInstanceId } from '@/ai/utils/getAiChatContextStor
import { isSidePanelOpenedState } from '@/side-panel/states/isSidePanelOpenedState';
import { sidePanelNavigationStackState } from '@/side-panel/states/sidePanelNavigationStackState';
import { isCurrentPathAiChatPage } from '~/utils/isCurrentPathAiChatPage';
+import { isSettingsPath } from '~/utils/isSettingsPath';
import { contextStoreCurrentObjectMetadataItemIdComponentState } from '@/context-store/states/contextStoreCurrentObjectMetadataItemIdComponentState';
import { contextStoreCurrentViewIdComponentState } from '@/context-store/states/contextStoreCurrentViewIdComponentState';
import { contextStoreCurrentPageTypeComponentState } from '@/context-store/states/contextStoreCurrentPageTypeComponentState';
@@ -26,6 +27,12 @@ export const useGetBrowsingContext = () => {
const store = useStore();
const getBrowsingContext = useCallback((): BrowsingContext | null => {
+ const { pathname } = window.location;
+
+ if (isSettingsPath(pathname)) {
+ return { type: 'settingsPage', path: pathname };
+ }
+
const isSidePanelOpened = store.get(isSidePanelOpenedState.atom);
const currentSidePanelPage = store
.get(sidePanelNavigationStackState.atom)
diff --git a/packages/twenty-front/src/modules/ai/types/BrowsingContext.ts b/packages/twenty-front/src/modules/ai/types/BrowsingContext.ts
index edb69ff7bd7..3e83d5e70a1 100644
--- a/packages/twenty-front/src/modules/ai/types/BrowsingContext.ts
+++ b/packages/twenty-front/src/modules/ai/types/BrowsingContext.ts
@@ -12,4 +12,8 @@ export type BrowsingContext =
viewId: string;
viewName: string;
filterDescriptions: string[];
+ }
+ | {
+ type: 'settingsPage';
+ path: string;
};
diff --git a/packages/twenty-front/src/modules/app/components/SettingsRoutes.tsx b/packages/twenty-front/src/modules/app/components/SettingsRoutes.tsx
index 5f70355c5b3..c6f24f7471e 100644
--- a/packages/twenty-front/src/modules/app/components/SettingsRoutes.tsx
+++ b/packages/twenty-front/src/modules/app/components/SettingsRoutes.tsx
@@ -531,14 +531,6 @@ const SettingsObjectNewIndex = lazy(() =>
),
);
-const SettingsObjectNewValidationRule = lazy(() =>
- import('~/pages/settings/data-model/validation-rules/SettingsObjectNewValidationRule').then(
- (module) => ({
- default: module.SettingsObjectNewValidationRule,
- }),
- ),
-);
-
const SettingsObjectValidationRuleEdit = lazy(() =>
import('~/pages/settings/data-model/validation-rules/SettingsObjectValidationRuleEdit').then(
(module) => ({
@@ -972,11 +964,6 @@ const createSettingsRouteElements = ({
element={<SettingsObjectNewIndex />}
handle={MAIN_AND_SIDE_PANEL_SETTINGS_ROUTE_HANDLE}
/>
- <Route
- path={SettingsPath.ObjectNewValidationRule}
- element={<SettingsObjectNewValidationRule />}
- handle={MAIN_AND_SIDE_PANEL_SETTINGS_ROUTE_HANDLE}
- />
<Route
path={SettingsPath.ObjectValidationRuleEdit}
element={<SettingsObjectValidationRuleEdit />}
diff --git a/packages/twenty-front/src/modules/settings/data-model/object-details/components/tabs/SettingsObjectValidationRulesSection.tsx b/packages/twenty-front/src/modules/settings/data-model/object-details/components/tabs/SettingsObjectValidationRulesSection.tsx
index 185c0b873fe..08b59df4238 100644
--- a/packages/twenty-front/src/modules/settings/data-model/object-details/components/tabs/SettingsObjectValidationRulesSection.tsx
+++ b/packages/twenty-front/src/modules/settings/data-model/object-details/components/tabs/SettingsObjectValidationRulesSection.tsx
@@ -1,20 +1,24 @@
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
import { SettingsPath } from 'twenty-shared/types';
-import { getSettingsPath } from 'twenty-shared/utils';
+import { getSettingsPath, isDefined } from 'twenty-shared/utils';
+import { useToast } from 'twenty-ui/components/feedback';
import { IconChevronRight, IconPlus, useIcons } from 'twenty-ui/icon';
+import { Button } from 'twenty-ui/primitives/input';
import { Status } from 'twenty-ui/primitives/data-display';
import { themeCssVariables, useTheme } from 'twenty-ui/theme';
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
-import { NavigationButton } from '@/ui/input/components/NavigationButton';
import { Table } from '@/ui/layout/table/components/Table';
import { TableBody } from '@/ui/layout/table/components/TableBody';
import { TableCell } from '@/ui/layout/table/components/TableCell';
import { TableHeader } from '@/ui/layout/table/components/TableHeader';
import { TableRow } from '@/ui/layout/table/components/TableRow';
import { VALIDATION_RULE_DEFAULT_ICON } from '@/validation-rules/constants/ValidationRuleDefaultIcon';
+import { useValidationRuleMutations } from '@/validation-rules/hooks/useValidationRuleMutations';
import { useValidationRules } from '@/validation-rules/hooks/useValidationRules';
+import { getValidationRuleSaveErrorMessage } from '@/validation-rules/utils/getValidationRuleSaveErrorMessage';
+import { useNavigateSettings } from '~/hooks/useNavigateSettings';
const VALIDATION_RULE_TABLE_GRID_TEMPLATE_COLUMNS = '1fr 1fr 28px';
@@ -76,6 +80,42 @@ export const SettingsObjectValidationRulesSection = ({
});
const objectNamePlural = objectMetadataItem.namePlural;
+ const navigateSettings = useNavigateSettings();
+ const { enqueueToast } = useToast();
+ const { createValidationRule, isSaving } = useValidationRuleMutations({
+ objectMetadataId: objectMetadataItem.id,
+ });
+
+ const handleAddRule = async () => {
+ try {
+ const { data } = await createValidationRule({
+ variables: {
+ input: {
+ objectMetadataId: objectMetadataItem.id,
+ name: t`New rule`,
+ expression: '',
+ message: '',
+ isActive: false,
+ },
+ },
+ });
+ const validationRuleId = data?.createValidationRule.id;
+
+ if (isDefined(validationRuleId)) {
+ navigateSettings(SettingsPath.ObjectValidationRuleEdit, {
+ objectNamePlural,
+ validationRuleId,
+ });
+ }
+ } catch (error) {
+ enqueueToast({
+ variant: 'error',
+ children:
+ getValidationRuleSaveErrorMessage(error) ??
+ t`Failed to create the rule.`,
+ });
+ }
+ };
return (
<StyledContent>
@@ -145,14 +185,13 @@ export const SettingsObjectValidationRulesSection = ({
</StyledTableContainer>
{!isReadOnly && (
<StyledButtonContainer>
- <NavigationButton
- to={getSettingsPath(SettingsPath.ObjectNewValidationRule, {
- objectNamePlural,
- })}
+ <Button
startIcon={<IconPlus />}
size="sm"
variant="outline"
- >{t`Add rule`}</NavigationButton>
+ disabled={isSaving}
+ onClick={handleAddRule}
+ >{t`Add rule`}</Button>
</StyledButtonContainer>
)}
</StyledContent>
diff --git a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleAskAiButton.tsx b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleAskAiButton.tsx
new file mode 100644
index 00000000000..a0353a6d048
--- /dev/null
+++ b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleAskAiButton.tsx
@@ -0,0 +1,28 @@
+import { useLingui } from '@lingui/react/macro';
+import { PermissionFlagType } from 'twenty-shared/constants';
+import { LightIconButton } from 'twenty-ui/components/input';
+import { IconSparkles } from 'twenty-ui/icon';
+
+import { useHasPermissionFlag } from '@/settings/roles/hooks/useHasPermissionFlag';
+import { useOpenAskAiPageInSidePanel } from '@/side-panel/hooks/useOpenAskAiPageInSidePanel';
+import { useWorkspaceSurface } from '@/ui/layout/hooks/useWorkspaceSurface';
+
+export const SettingsValidationRuleAskAiButton = () => {
+ const { t } = useLingui();
+ const hasAiPermission = useHasPermissionFlag(PermissionFlagType.AI);
+ const { openAskAiPage } = useOpenAskAiPageInSidePanel();
+ const workspaceSurface = useWorkspaceSurface();
+
+ if (!hasAiPermission || workspaceSurface.type === 'side-panel') {
+ return null;
+ }
+
+ return (
+ <LightIconButton
+ aria-label={t`Ask AI`}
+ onClick={() => openAskAiPage({ resetNavigationStack: true })}
+ >
+ <IconSparkles />
+ </LightIconButton>
+ );
+};
diff --git a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleEditForm.tsx b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleEditForm.tsx
index ae00923253e..811af92b50c 100644
--- a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleEditForm.tsx
+++ b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleEditForm.tsx
@@ -1,6 +1,7 @@
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
import { useState } from 'react';
+import { isDefined } from 'twenty-shared/utils';
import { useToast } from 'twenty-ui/components/feedback';
import { Section } from 'twenty-ui/components/layout';
import { IconArchive, IconArchiveOff, IconTrash } from 'twenty-ui/icon';
@@ -19,6 +20,7 @@ import { type ValidationRule } from '@/validation-rules/types/ValidationRule';
import { type ValidationRuleFormValues } from '@/validation-rules/types/ValidationRuleFormValues';
import { buildValidationRuleEditorFields } from '@/validation-rules/utils/buildValidationRuleEditorFields';
import { buildValidationRuleFieldDescriptors } from '@/validation-rules/utils/buildValidationRuleFieldDescriptors';
+import { getValidationRuleFormEdits } from '@/validation-rules/utils/getValidationRuleFormEdits';
import { getValidationRuleFormValues } from '@/validation-rules/utils/getValidationRuleFormValues';
import { getValidationRuleSaveErrorMessage } from '@/validation-rules/utils/getValidationRuleSaveErrorMessage';
import { isValidationRuleFormSubmittable } from '@/validation-rules/utils/isValidationRuleFormSubmittable';
@@ -49,9 +51,31 @@ export const SettingsValidationRuleEditForm = ({
const { updateValidationRule, deleteValidationRule, isSaving, isDeleting } =
useValidationRuleMutations({ objectMetadataId: objectMetadataItem.id });
- const [values, setValues] = useState<ValidationRuleFormValues>(() =>
- getValidationRuleFormValues(validationRule),
- );
+ const [editedValues, setEditedValues] = useState<
+ Partial<ValidationRuleFormValues>
+ >({});
+ const [formKey, setFormKey] = useState(validationRule.expression);
+
+ const serverFormValues = getValidationRuleFormValues(validationRule);
+ const values: ValidationRuleFormValues = {
+ ...serverFormValues,
+ ...editedValues,
+ };
+
+ if (
+ !isDefined(editedValues.expression) &&
+ formKey !== validationRule.expression
+ ) {
+ setFormKey(validationRule.expression);
+ }
+
+ const handleChange = (nextValues: ValidationRuleFormValues) =>
+ setEditedValues(
+ getValidationRuleFormEdits({
+ formValues: nextValues,
+ serverFormValues,
+ }),
+ );
const fields = buildValidationRuleFieldDescriptors({
objectMetadataItem,
@@ -65,9 +89,19 @@ export const SettingsValidationRuleEditForm = ({
const handleSave = async () => {
try {
await updateValidationRule({
- variables: { input: { id: validationRule.id, update: values } },
+ variables: {
+ input: {
+ id: validationRule.id,
+ update: { ...values, isActive: true },
+ },
+ },
+ });
+ enqueueToast({
+ variant: 'success',
+ children: validationRule.isActive
+ ? t`Rule updated.`
+ : t`Rule activated.`,
});
- enqueueToast({ variant: 'success', children: t`Rule updated.` });
navigateToObjectValidationRules();
} catch (error) {
enqueueToast({
@@ -121,17 +155,19 @@ export const SettingsValidationRuleEditForm = ({
objectMetadataItem={objectMetadataItem}
breadcrumbLabel={validationRule.name}
stepLabel={t`Edit rule`}
+ saveLabel={validationRule.isActive ? t`Save` : t`Activate`}
isSaveDisabled={
isSaving || !isValidationRuleFormSubmittable({ values, fields })
}
onSave={handleSave}
>
<SettingsValidationRuleForm
+ key={formKey}
objectMetadataItem={objectMetadataItem}
fields={fields}
editorFields={editorFields}
values={values}
- onChange={setValues}
+ onChange={handleChange}
/>
<Section.Root>
<Section.Header
diff --git a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleExpressionEditor.tsx b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleExpressionEditor.tsx
index d98ecebc6e8..e37deb8fe50 100644
--- a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleExpressionEditor.tsx
+++ b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleExpressionEditor.tsx
@@ -17,6 +17,7 @@ import { Card } from 'twenty-ui/primitives/surfaces';
import { themeCssVariables } from 'twenty-ui/theme';
import { FORM_FIELD_PLACEHOLDER_STYLES } from '@/ui/input/constants/FormFieldPlaceholderStyles';
+import { SettingsValidationRuleAskAiButton } from '@/validation-rules/components/SettingsValidationRuleAskAiButton';
import { SettingsValidationRuleHelperPanel } from '@/validation-rules/components/SettingsValidationRuleHelperPanel';
import { VALIDATION_RULE_HIGHLIGHT_COLORS } from '@/validation-rules/constants/ValidationRuleHighlightColors';
import { ValidationRuleExpressionExtension } from '@/validation-rules/extensions/ValidationRuleExpressionExtension';
@@ -36,6 +37,12 @@ import { insertValidationRuleHelperItem } from '@/validation-rules/utils/insertV
const SingleParagraphDocument = Document.extend({ content: 'paragraph' });
+const StyledAskAiButtonContainer = styled.div`
+ position: absolute;
+ right: ${themeCssVariables.spacing[1]};
+ top: ${themeCssVariables.spacing[1]};
+`;
+
const StyledEditorContent = styled.div`
display: flex;
flex-direction: column;
@@ -53,6 +60,7 @@ const StyledEditor = styled.div<{ hasError: boolean }>`
color: ${themeCssVariables.font.color.primary};
font-family: ${themeCssVariables.code.font.family};
font-size: ${themeCssVariables.font.size.md};
+ position: relative;
&:focus-within {
border-color: ${themeCssVariables.color.blue};
@@ -62,7 +70,8 @@ const StyledEditor = styled.div<{ hasError: boolean }>`
line-height: 24px;
min-height: 56px;
outline: none;
- padding: ${themeCssVariables.spacing[2]} ${themeCssVariables.spacing[3]};
+ padding: ${themeCssVariables.spacing[2]} ${themeCssVariables.spacing[8]}
+ ${themeCssVariables.spacing[2]} ${themeCssVariables.spacing[3]};
white-space: pre-wrap;
word-break: break-word;
@@ -273,6 +282,9 @@ export const SettingsValidationRuleExpressionEditor = ({
<StyledEditorContent>
<StyledEditor hasError={isDefined(errorMessage)}>
<EditorContent editor={editor} />
+ <StyledAskAiButtonContainer>
+ <SettingsValidationRuleAskAiButton />
+ </StyledAskAiButtonContainer>
</StyledEditor>
{isDefined(errorMessage) && (
<StyledError role="alert">{errorMessage}</StyledError>
diff --git a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRulePageLayout.tsx b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRulePageLayout.tsx
index 7ac82096027..a06e320b29e 100644
--- a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRulePageLayout.tsx
+++ b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRulePageLayout.tsx
@@ -17,6 +17,7 @@ type SettingsValidationRulePageLayoutProps = {
objectMetadataItem: EnrichedObjectMetadataItem;
breadcrumbLabel: string;
stepLabel: string;
+ saveLabel: string;
isSaveDisabled: boolean;
onSave: () => void;
children: ReactNode;
@@ -26,6 +27,7 @@ export const SettingsValidationRulePageLayout = ({
objectMetadataItem,
breadcrumbLabel,
stepLabel,
+ saveLabel,
isSaveDisabled,
onSave,
children,
@@ -71,7 +73,9 @@ export const SettingsValidationRulePageLayout = ({
color="accent"
disabled={isSaveDisabled}
onClick={onSave}
- >{t`Save`}</Button>
+ >
+ {saveLabel}
+ </Button>
}
/>
}
diff --git a/packages/twenty-front/src/modules/validation-rules/components/__stories__/SettingsValidationRuleAskAiButton.stories.tsx b/packages/twenty-front/src/modules/validation-rules/components/__stories__/SettingsValidationRuleAskAiButton.stories.tsx
new file mode 100644
index 00000000000..e6ddcff6b71
--- /dev/null
+++ b/packages/twenty-front/src/modules/validation-rules/components/__stories__/SettingsValidationRuleAskAiButton.stories.tsx
@@ -0,0 +1,87 @@
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import { useEffect } from 'react';
+import { expect, waitFor, within } from 'storybook/test';
+import { ComponentDecorator } from 'twenty-ui/testing';
+
+import { currentUserWorkspaceState } from '@/auth/states/currentUserWorkspaceState';
+import { WorkspaceSurfaceContext } from '@/ui/layout/contexts/WorkspaceSurfaceContext';
+import { jotaiStore } from '@/ui/utilities/state/jotai/jotaiStore';
+import { SettingsValidationRuleAskAiButton } from '@/validation-rules/components/SettingsValidationRuleAskAiButton';
+import { PermissionFlagType } from '~/generated-metadata/graphql';
+import { RootDecorator } from '~/testing/decorators/RootDecorator';
+
+const AskAiButtonStory = ({
+ hasAiPermission,
+ isInSidePanel,
+}: {
+ hasAiPermission: boolean;
+ isInSidePanel: boolean;
+}) => {
+ useEffect(() => {
+ jotaiStore.set(currentUserWorkspaceState.atom, {
+ permissionFlags: hasAiPermission ? [PermissionFlagType.AI] : [],
+ objectsPermissions: [],
+ isImpersonating: false,
+ twoFactorAuthenticationMethodSummary: null,
+ });
+ }, [hasAiPermission]);
+
+ return (
+ <WorkspaceSurfaceContext.Provider
+ value={{
+ type: isInSidePanel ? 'side-panel' : 'main',
+ instanceId: 'ask-ai-button-story',
+ ownsRouteLocation: !isInSidePanel,
+ }}
+ >
+ <SettingsValidationRuleAskAiButton />
+ </WorkspaceSurfaceContext.Provider>
+ );
+};
+
+const meta: Meta<typeof AskAiButtonStory> = {
+ title: 'Modules/ValidationRules/SettingsValidationRuleAskAiButton',
+ component: AskAiButtonStory,
+ decorators: [RootDecorator, ComponentDecorator],
+ args: { hasAiPermission: true, isInSidePanel: false },
+};
+
+export default meta;
+
+type Story = StoryObj<typeof AskAiButtonStory>;
+
+export const WithAiPermission: Story = {
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ await expect(
+ await canvas.findByRole('button', { name: 'Ask AI' }),
+ ).toBeVisible();
+ },
+};
+
+export const WithoutAiPermission: Story = {
+ args: { hasAiPermission: false },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ await waitFor(() =>
+ expect(
+ canvas.queryByRole('button', { name: 'Ask AI' }),
+ ).not.toBeInTheDocument(),
+ );
+ },
+};
+
+export const InSidePanel: Story = {
+ args: { isInSidePanel: true },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ await waitFor(() =>
+ expect(
+ canvas.queryByRole('button', { name: 'Ask AI' }),
+ ).not.toBeInTheDocument(),
+ );
+ },
+};
diff --git a/packages/twenty-front/src/modules/validation-rules/constants/EmptyValidationRuleFormValues.ts b/packages/twenty-front/src/modules/validation-rules/constants/EmptyValidationRuleFormValues.ts
deleted file mode 100644
index 17df7e7cae4..00000000000
--- a/packages/twenty-front/src/modules/validation-rules/constants/EmptyValidationRuleFormValues.ts
+++ /dev/null
@@ -1,11 +0,0 @@
-import { VALIDATION_RULE_DEFAULT_ICON } from '@/validation-rules/constants/ValidationRuleDefaultIcon';
-import { type ValidationRuleFormValues } from '@/validation-rules/types/ValidationRuleFormValues';
-
-export const EMPTY_VALIDATION_RULE_FORM_VALUES: ValidationRuleFormValues = {
- name: '',
- description: null,
- icon: VALIDATION_RULE_DEFAULT_ICON,
- expression: '',
- message: '',
- errorFieldMetadataId: null,
-};
diff --git a/packages/twenty-front/src/modules/validation-rules/utils/__tests__/getValidationRuleFormEdits.test.ts b/packages/twenty-front/src/modules/validation-rules/utils/__tests__/getValidationRuleFormEdits.test.ts
new file mode 100644
index 00000000000..712e7d70d13
--- /dev/null
+++ b/packages/twenty-front/src/modules/validation-rules/utils/__tests__/getValidationRuleFormEdits.test.ts
@@ -0,0 +1,31 @@
+import { type ValidationRuleFormValues } from '@/validation-rules/types/ValidationRuleFormValues';
+import { getValidationRuleFormEdits } from '@/validation-rules/utils/getValidationRuleFormEdits';
+
+const SERVER_FORM_VALUES: ValidationRuleFormValues = {
+ name: 'Positive revenue',
+ description: null,
+ icon: 'IconShieldCheck',
+ expression: 'annualRecurringRevenue > 0',
+ message: 'Revenue must be positive',
+ errorFieldMetadataId: null,
+};
+
+describe('getValidationRuleFormEdits', () => {
+ it('should keep only the fields that differ from the server', () => {
+ expect(
+ getValidationRuleFormEdits({
+ formValues: { ...SERVER_FORM_VALUES, name: 'Revenue above zero' },
+ serverFormValues: SERVER_FORM_VALUES,
+ }),
+ ).toEqual({ name: 'Revenue above zero' });
+ });
+
+ it('should drop a field changed back to its server value', () => {
+ expect(
+ getValidationRuleFormEdits({
+ formValues: SERVER_FORM_VALUES,
+ serverFormValues: SERVER_FORM_VALUES,
+ }),
+ ).toEqual({});
+ });
+});
diff --git a/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleFormEdits.ts b/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleFormEdits.ts
new file mode 100644
index 00000000000..8b8375afa1a
--- /dev/null
+++ b/packages/twenty-front/src/modules/validation-rules/utils/getValidationRuleFormEdits.ts
@@ -0,0 +1,18 @@
+import { typedObjectEntries } from 'twenty-shared/utils';
+
+import { type ValidationRuleFormValues } from '@/validation-rules/types/ValidationRuleFormValues';
+
+export const getValidationRuleFormEdits = ({
+ formValues,
+ serverFormValues,
+}: {
+ formValues: ValidationRuleFormValues;
+ serverFormValues: ValidationRuleFormValues;
+}): Partial<ValidationRuleFormValues> =>
+ typedObjectEntries(formValues).reduce<Partial<ValidationRuleFormValues>>(
+ (formEdits, [fieldName, value]) =>
+ value === serverFormValues[fieldName]
+ ? formEdits
+ : { ...formEdits, [fieldName]: value },
+ {},
+ );
diff --git a/packages/twenty-front/src/pages/settings/data-model/validation-rules/SettingsObjectNewValidationRule.tsx b/packages/twenty-front/src/pages/settings/data-model/validation-rules/SettingsObjectNewValidationRule.tsx
deleted file mode 100644
index d57c52b5962..00000000000
--- a/packages/twenty-front/src/pages/settings/data-model/validation-rules/SettingsObjectNewValidationRule.tsx
+++ /dev/null
@@ -1,118 +0,0 @@
-import { useLingui } from '@lingui/react/macro';
-import { useState } from 'react';
-import { useParams } from 'react-router-dom';
-import { isDefined } from 'twenty-shared/utils';
-import { useToast } from 'twenty-ui/components/feedback';
-
-import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilteredObjectMetadataItems';
-import { useObjectMetadataItems } from '@/object-metadata/hooks/useObjectMetadataItems';
-import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
-import { SettingsValidationRuleForm } from '@/validation-rules/components/SettingsValidationRuleForm';
-import { SettingsValidationRulePageLayout } from '@/validation-rules/components/SettingsValidationRulePageLayout';
-import { EMPTY_VALIDATION_RULE_FORM_VALUES } from '@/validation-rules/constants/EmptyValidationRuleFormValues';
-import { useHasValidationRulesEntitlement } from '@/validation-rules/hooks/useHasValidationRulesEntitlement';
-import { useNavigateToObjectValidationRules } from '@/validation-rules/hooks/useNavigateToObjectValidationRules';
-import { useValidationRuleMutations } from '@/validation-rules/hooks/useValidationRuleMutations';
-import { type ValidationRuleFormValues } from '@/validation-rules/types/ValidationRuleFormValues';
-import { buildValidationRuleEditorFields } from '@/validation-rules/utils/buildValidationRuleEditorFields';
-import { buildValidationRuleFieldDescriptors } from '@/validation-rules/utils/buildValidationRuleFieldDescriptors';
-import { getValidationRuleSaveErrorMessage } from '@/validation-rules/utils/getValidationRuleSaveErrorMessage';
-import { isValidationRuleFormSubmittable } from '@/validation-rules/utils/isValidationRuleFormSubmittable';
-import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
-import { FeatureFlagKey } from '~/generated-metadata/graphql';
-import { NotFound } from '~/pages/not-found/NotFound';
-
-const SettingsObjectNewValidationRuleForm = ({
- objectMetadataItem,
-}: {
- objectMetadataItem: EnrichedObjectMetadataItem;
-}) => {
- const { t } = useLingui();
- const { enqueueToast } = useToast();
- const { objectMetadataItems } = useObjectMetadataItems();
- const navigateToObjectValidationRules = useNavigateToObjectValidationRules({
- objectNamePlural: objectMetadataItem.namePlural,
- });
- const { createValidationRule, isSaving } = useValidationRuleMutations({
- objectMetadataId: objectMetadataItem.id,
- });
-
- const [values, setValues] = useState<ValidationRuleFormValues>(
- EMPTY_VALIDATION_RULE_FORM_VALUES,
- );
-
- const fields = buildValidationRuleFieldDescriptors({
- objectMetadataItem,
- objectMetadataItems,
- });
- const editorFields = buildValidationRuleEditorFields({
- objectMetadataItem,
- objectMetadataItems,
- });
-
- const handleSave = async () => {
- try {
- await createValidationRule({
- variables: {
- input: { objectMetadataId: objectMetadataItem.id, ...values },
- },
- });
- enqueueToast({ variant: 'success', children: t`Rule created.` });
- navigateToObjectValidationRules();
- } catch (error) {
- enqueueToast({
- variant: 'error',
- children:
- getValidationRuleSaveErrorMessage(error) ??
- t`Failed to create the rule.`,
- });
- }
- };
-
- return (
- <SettingsValidationRulePageLayout
- objectMetadataItem={objectMetadataItem}
- breadcrumbLabel={t`New rule`}
- stepLabel={t`Configure rule`}
- isSaveDisabled={
- isSaving || !isValidationRuleFormSubmittable({ values, fields })
- }
- onSave={handleSave}
- >
- <SettingsValidationRuleForm
- objectMetadataItem={objectMetadataItem}
- fields={fields}
- editorFields={editorFields}
- values={values}
- onChange={setValues}
- />
- </SettingsValidationRulePageLayout>
- );
-};
-
-export const SettingsObjectNewValidationRule = () => {
- const isValidationRulesEnabled = useIsFeatureEnabled(
- FeatureFlagKey.IS_VALIDATION_RULES_ENABLED,
- );
- const hasValidationRulesEntitlement = useHasValidationRulesEntitlement();
- const { objectNamePlural = '' } = useParams();
- const { findObjectMetadataItemByNamePlural } =
- useFilteredObjectMetadataItems();
-
- const objectMetadataItem =
- findObjectMetadataItemByNamePlural(objectNamePlural);
-
- if (
- !isValidationRulesEnabled ||
- !hasValidationRulesEntitlement ||
- !isDefined(objectMetadataItem)
- ) {
- return <NotFound />;
- }
-
- return (
- <SettingsObjectNewValidationRuleForm
- objectMetadataItem={objectMetadataItem}
- />
- );
-};
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/metadata-tool.provider.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/metadata-tool.provider.ts
index 9b61018b8e9..5d6adb4746e 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/metadata-tool.provider.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/metadata-tool.provider.ts
@@ -2,7 +2,9 @@ import { Injectable } from '@nestjs/common';
import { type ToolSet } from 'ai';
import { PermissionFlagType } from 'twenty-shared/constants';
+import { FeatureFlagKey } from 'twenty-shared/types';
+import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
import { type GenerateDescriptorOptions } from 'src/engine/core-modules/tool-provider/interfaces/generate-descriptor-options.type';
import { type ToolProvider } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider.interface';
import { type ToolProviderContext } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider-context.type';
@@ -16,6 +18,7 @@ import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.
import { FieldMetadataToolsFactory } from 'src/engine/metadata-modules/field-metadata/tools/field-metadata-tools.factory';
import { ObjectMetadataToolsFactory } from 'src/engine/metadata-modules/object-metadata/tools/object-metadata-tools.factory';
import { PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';
+import { ValidationRuleToolsFactory } from 'src/engine/metadata-modules/validation-rule/tools/validation-rule-tools.factory';
@Injectable()
export class MetadataToolProvider implements ToolProvider {
@@ -24,7 +27,9 @@ export class MetadataToolProvider implements ToolProvider {
constructor(
private readonly objectMetadataToolsFactory: ObjectMetadataToolsFactory,
private readonly fieldMetadataToolsFactory: FieldMetadataToolsFactory,
+ private readonly validationRuleToolsFactory: ValidationRuleToolsFactory,
private readonly permissionsService: PermissionsService,
+ private readonly featureFlagService: FeatureFlagService,
) {}
async isAvailable(context: ToolProviderContext): Promise<boolean> {
@@ -39,7 +44,7 @@ export class MetadataToolProvider implements ToolProvider {
context: ToolProviderContext,
options?: GenerateDescriptorOptions,
): Promise<(ToolIndexEntry | ToolDescriptor)[]> {
- const toolSet = this.buildToolSet(context);
+ const toolSet = await this.buildToolSet(context);
return toolSetToDescriptors(toolSet, ToolCategory.METADATA, {
includeSchemas: options?.includeSchemas ?? true,
@@ -52,7 +57,7 @@ export class MetadataToolProvider implements ToolProvider {
args: Record<string, unknown>,
context: ToolProviderContext,
): Promise<ToolOutput> {
- const toolSet = this.buildToolSet(context);
+ const toolSet = await this.buildToolSet(context);
return executeToolFromToolSet(
toolSet,
@@ -62,10 +67,19 @@ export class MetadataToolProvider implements ToolProvider {
);
}
- private buildToolSet(context: ToolProviderContext): ToolSet {
+ private async buildToolSet(context: ToolProviderContext): Promise<ToolSet> {
+ const isValidationRulesEnabled =
+ await this.featureFlagService.isFeatureEnabled(
+ FeatureFlagKey.IS_VALIDATION_RULES_ENABLED,
+ context.workspaceId,
+ );
+
return {
...this.objectMetadataToolsFactory.generateTools(context.workspaceId),
...this.fieldMetadataToolsFactory.generateTools(context.workspaceId),
+ ...(isValidationRulesEnabled
+ ? this.validationRuleToolsFactory.generateTools(context.workspaceId)
+ : {}),
};
}
}
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/tool-provider.module.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/tool-provider.module.ts
index c66b78f403f..18b59ce5fe0 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/tool-provider.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/tool-provider.module.ts
@@ -2,6 +2,7 @@ import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { FileEntity } from 'src/engine/core-modules/file/entities/file.entity';
+import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
import { FilesFieldModule } from 'src/engine/core-modules/file/files-field/files-field.module';
import { RecordCrudModule } from 'src/engine/core-modules/record-crud/record-crud.module';
import { TOOL_PROVIDERS } from 'src/engine/core-modules/tool-provider/constants/tool-providers.token';
@@ -27,6 +28,7 @@ import { ObjectMetadataModule } from 'src/engine/metadata-modules/object-metadat
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
import { RoleModule } from 'src/engine/metadata-modules/role/role.module';
import { UserRoleModule } from 'src/engine/metadata-modules/user-role/user-role.module';
+import { ValidationRuleModule } from 'src/engine/metadata-modules/validation-rule/validation-rule.module';
import { ViewFieldModule } from 'src/engine/metadata-modules/view-field/view-field.module';
import { ViewFilterModule } from 'src/engine/metadata-modules/view-filter/view-filter.module';
import { ViewSortModule } from 'src/engine/metadata-modules/view-sort/view-sort.module';
@@ -47,6 +49,7 @@ import { ToolRegistryService } from './services/tool-registry.service';
ApplicationTranslationCatalogModule,
ToolModule,
RecordCrudModule,
+ FeatureFlagModule,
FilesFieldModule,
ObjectMetadataModule,
FieldMetadataModule,
@@ -61,6 +64,7 @@ import { ToolRegistryService } from './services/tool-registry.service';
WebhookModule,
RoleModule,
UserRoleModule,
+ ValidationRuleModule,
EmailingModule,
TypeOrmModule.forFeature([UserEntity, FileEntity]),
],
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent/types/browsing-context.type.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent/types/browsing-context.type.ts
index d43aa731668..fd136083208 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent/types/browsing-context.type.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent/types/browsing-context.type.ts
@@ -12,4 +12,8 @@ export type BrowsingContextType =
viewId: string;
viewName: string;
filterDescriptions: string[];
+ }
+ | {
+ type: 'settingsPage';
+ path: string;
};
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-chat/services/chat-execution.service.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-chat/services/chat-execution.service.ts
index b0d538c318c..a8e2e6039bc 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-chat/services/chat-execution.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-chat/services/chat-execution.service.ts
@@ -794,6 +794,8 @@ export class ChatExecutionService {
);
case 'listView':
return this.buildListViewContext(browsingContext);
+ case 'settingsPage':
+ return this.buildSettingsPageContext(workspace, browsingContext.path);
default:
// browsing context comes from unvalidated client JSON
return '';
@@ -848,4 +850,16 @@ export class ChatExecutionService {
return context;
}
+
+ private buildSettingsPageContext(
+ workspace: WorkspaceEntity,
+ path: string,
+ ): string {
+ const resourceUrl = this.workspaceDomainsService.buildWorkspaceURL({
+ workspace,
+ pathname: path,
+ });
+
+ return `The user is on the settings page ${resourceUrl}. When they talk about what this page shows (for example "this rule" or "my rule"), they mean the item at this path.`;
+ }
}
diff --git a/packages/twenty-server/src/engine/metadata-modules/validation-rule/dtos/create-validation-rule.input.ts b/packages/twenty-server/src/engine/metadata-modules/validation-rule/dtos/create-validation-rule.input.ts
index 4bfdd35c3bc..056248199b1 100644
--- a/packages/twenty-server/src/engine/metadata-modules/validation-rule/dtos/create-validation-rule.input.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/validation-rule/dtos/create-validation-rule.input.ts
@@ -40,12 +40,10 @@ export class CreateValidationRuleInput {
icon?: string | null;
@IsString()
- @IsNotEmpty()
@Field()
expression: string;
@IsString()
- @IsNotEmpty()
@Field()
message: string;
diff --git a/packages/twenty-server/src/engine/metadata-modules/validation-rule/tools/validation-rule-tools.factory.ts b/packages/twenty-server/src/engine/metadata-modules/validation-rule/tools/validation-rule-tools.factory.ts
new file mode 100644
index 00000000000..cb86d64ea53
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/validation-rule/tools/validation-rule-tools.factory.ts
@@ -0,0 +1,219 @@
+/* @license Enterprise */
+
+import { Injectable } from '@nestjs/common';
+
+import { type ToolSet } from 'ai';
+import { VALIDATION_RULE_EXPRESSION_SYNTAX_DESCRIPTION } from 'twenty-shared/constants';
+import { isDefined } from 'twenty-shared/utils';
+import { z } from 'zod';
+
+import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';
+import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
+import { getObjectMetadataIdByName } from 'src/engine/metadata-modules/flat-object-metadata/utils/get-object-metadata-id-by-name.util';
+import {
+ ObjectMetadataException,
+ ObjectMetadataExceptionCode,
+} from 'src/engine/metadata-modules/object-metadata/object-metadata.exception';
+import { type ValidationRuleDTO } from 'src/engine/metadata-modules/validation-rule/dtos/validation-rule.dto';
+import { ValidationRuleService } from 'src/engine/metadata-modules/validation-rule/validation-rule.service';
+
+const OBJECT_NAME_DESCRIPTION =
+ 'Object name, singular or plural (e.g. "company" or "companies").';
+
+const MESSAGE_DESCRIPTION =
+ 'Message shown to the person saving the record when the expression is false.';
+
+const GetValidationRulesInputSchema = z.object({
+ objectName: z.string().describe(OBJECT_NAME_DESCRIPTION),
+});
+
+const ValidateValidationRuleExpressionInputSchema = z.object({
+ objectName: z.string().describe(OBJECT_NAME_DESCRIPTION),
+ expression: z
+ .string()
+ .describe(VALIDATION_RULE_EXPRESSION_SYNTAX_DESCRIPTION),
+});
+
+const CreateValidationRuleInputSchema = z.object({
+ objectName: z.string().describe(OBJECT_NAME_DESCRIPTION),
+ name: z.string().describe('Short rule name'),
+ expression: z
+ .string()
+ .describe(VALIDATION_RULE_EXPRESSION_SYNTAX_DESCRIPTION),
+ message: z.string().describe(MESSAGE_DESCRIPTION),
+ errorFieldMetadataId: z
+ .uuid()
+ .optional()
+ .describe(
+ 'ID of the field the message is shown on. Omit to show it on the whole record.',
+ ),
+});
+
+const UpdateValidationRuleInputSchema = z.object({
+ id: z.uuid().describe('Validation rule ID'),
+ name: z.string().optional().describe('Short rule name'),
+ expression: z
+ .string()
+ .optional()
+ .describe(VALIDATION_RULE_EXPRESSION_SYNTAX_DESCRIPTION),
+ message: z.string().optional().describe(MESSAGE_DESCRIPTION),
+ errorFieldMetadataId: z
+ .uuid()
+ .nullable()
+ .optional()
+ .describe(
+ 'ID of the field the message is shown on, or null to show it on the whole record.',
+ ),
+ isActive: z
+ .boolean()
+ .optional()
+ .describe('Set false to turn the rule off without deleting it.'),
+});
+
+@Injectable()
+export class ValidationRuleToolsFactory {
+ constructor(
+ private readonly validationRuleService: ValidationRuleService,
+ private readonly flatEntityMapsCacheService: WorkspaceManyOrAllFlatEntityMapsCacheService,
+ ) {}
+
+ private async getObjectMetadataIdOrThrow({
+ workspaceId,
+ objectName,
+ }: {
+ workspaceId: string;
+ objectName: string;
+ }): Promise<string> {
+ const { flatObjectMetadataMaps } =
+ await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
+ {
+ workspaceId,
+ flatMapsKeys: ['flatObjectMetadataMaps'],
+ },
+ );
+
+ const objectMetadataId = getObjectMetadataIdByName({
+ flatObjectMetadataMaps,
+ objectName,
+ });
+
+ if (!isDefined(objectMetadataId)) {
+ throw new ObjectMetadataException(
+ `Object "${objectName}" not found. Use get_object_metadata to list available objects.`,
+ ObjectMetadataExceptionCode.OBJECT_METADATA_NOT_FOUND,
+ );
+ }
+
+ return objectMetadataId;
+ }
+
+ generateTools(workspaceId: string): ToolSet {
+ return {
+ get_validation_rules: {
+ description:
+ 'List the validation rules of an object: conditions a record must meet to be saved.',
+ inputSchema: GetValidationRulesInputSchema,
+ execute: async (parameters: {
+ objectName: string;
+ }): Promise<ToolOutput<ValidationRuleDTO[]>> => {
+ const validationRules =
+ await this.validationRuleService.findByObjectMetadataId({
+ objectMetadataId: await this.getObjectMetadataIdOrThrow({
+ workspaceId,
+ objectName: parameters.objectName,
+ }),
+ workspaceId,
+ });
+
+ return {
+ success: true,
+ message: `Found ${validationRules.length} validation rule(s).`,
+ result: validationRules,
+ };
+ },
+ },
+ validate_validation_rule_expression: {
+ description:
+ 'Check a validation rule expression against an object without saving anything. An invalid expression is rejected with the reason.',
+ inputSchema: ValidateValidationRuleExpressionInputSchema,
+ execute: async ({
+ objectName,
+ expression,
+ }: {
+ objectName: string;
+ expression: string;
+ }): Promise<ToolOutput> => {
+ await this.validationRuleService.validateExpressionOrThrow({
+ objectMetadataId: await this.getObjectMetadataIdOrThrow({
+ workspaceId,
+ objectName,
+ }),
+ expression,
+ workspaceId,
+ });
+
+ return { success: true, message: 'The expression is valid.' };
+ },
+ },
+ create_validation_rule: {
+ description:
+ 'Create a validation rule on an object. An invalid expression is rejected with the reason. When the user is on a validation rule page (a settings path ending in /validation-rules/<id>), they mean that rule: update it with update_validation_rule instead of creating another one.',
+ inputSchema: CreateValidationRuleInputSchema,
+ execute: async ({
+ objectName,
+ ...input
+ }: {
+ objectName: string;
+ name: string;
+ expression: string;
+ message: string;
+ errorFieldMetadataId?: string;
+ }): Promise<ToolOutput<ValidationRuleDTO>> => {
+ const validationRule = await this.validationRuleService.create({
+ input: {
+ ...input,
+ objectMetadataId: await this.getObjectMetadataIdOrThrow({
+ workspaceId,
+ objectName,
+ }),
+ },
+ workspaceId,
+ });
+
+ return {
+ success: true,
+ message: `Created the validation rule "${validationRule.name}".`,
+ result: validationRule,
+ };
+ },
+ },
+ update_validation_rule: {
+ description:
+ 'Update a validation rule. Only the provided properties change. When the user is on a validation rule page (a settings path ending in /validation-rules/<id>), requests about a rule are about that one. An active rule rejects an invalid expression with the reason; an inactive rule only checks it when activated, so check it first with validate_validation_rule_expression. Keep the rule inactive unless the user asks to activate it.',
+ inputSchema: UpdateValidationRuleInputSchema,
+ execute: async ({
+ id,
+ ...update
+ }: {
+ id: string;
+ name?: string;
+ expression?: string;
+ message?: string;
+ errorFieldMetadataId?: string | null;
+ isActive?: boolean;
+ }): Promise<ToolOutput<ValidationRuleDTO>> => {
+ const validationRule = await this.validationRuleService.update({
+ input: { id, update },
+ workspaceId,
+ });
+
+ return {
+ success: true,
+ message: `Updated the validation rule "${validationRule.name}".`,
+ result: validationRule,
+ };
+ },
+ },
+ };
+ }
+}
diff --git a/packages/twenty-server/src/engine/metadata-modules/validation-rule/utils/__tests__/compute-validation-rule-bindings.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/validation-rule/utils/__tests__/compute-validation-rule-bindings.util.spec.ts
new file mode 100644
index 00000000000..15e6ed8953d
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/validation-rule/utils/__tests__/compute-validation-rule-bindings.util.spec.ts
@@ -0,0 +1,128 @@
+/* @license Enterprise */
+
+import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
+import { compileValidationRuleExpressionOrThrow } from 'src/engine/metadata-modules/validation-rule/utils/compile-validation-rule-expression-or-throw.util';
+import { computeValidationRuleBindings } from 'src/engine/metadata-modules/validation-rule/utils/compute-validation-rule-bindings.util';
+
+jest.mock(
+ 'src/engine/metadata-modules/validation-rule/utils/compile-validation-rule-expression-or-throw.util',
+ () => ({
+ compileValidationRuleExpressionOrThrow: jest.fn(() => ({
+ amount: 'compiled-amount-field-id',
+ })),
+ }),
+);
+
+const COMPILE_INPUT = {
+ objectMetadataId: 'object-metadata-id',
+ flatObjectMetadataMaps: createEmptyFlatEntityMaps(),
+ flatFieldMetadataMaps: createEmptyFlatEntityMaps(),
+};
+
+const EXISTING_BINDINGS = { amount: 'existing-amount-field-id' };
+
+const COMPILED_BINDINGS = { amount: 'compiled-amount-field-id' };
+
+describe('computeValidationRuleBindings', () => {
+ beforeEach(() => {
+ jest.mocked(compileValidationRuleExpressionOrThrow).mockClear();
+ });
+
+ it('should compile a new active rule', () => {
+ expect(
+ computeValidationRuleBindings({
+ ...COMPILE_INPUT,
+ expression: 'amount > 0',
+ isActive: true,
+ }),
+ ).toEqual(COMPILED_BINDINGS);
+ expect(compileValidationRuleExpressionOrThrow).toHaveBeenCalledTimes(1);
+ expect(compileValidationRuleExpressionOrThrow).toHaveBeenCalledWith({
+ ...COMPILE_INPUT,
+ expression: 'amount > 0',
+ });
+ });
+
+ it('should leave a new inactive rule without bindings', () => {
+ expect(
+ computeValidationRuleBindings({
+ ...COMPILE_INPUT,
+ expression: '',
+ isActive: false,
+ }),
+ ).toEqual({});
+ expect(compileValidationRuleExpressionOrThrow).not.toHaveBeenCalled();
+ });
+
+ it('should compile when an active rule gets a new expression', () => {
+ expect(
+ computeValidationRuleBindings({
+ ...COMPILE_INPUT,
+ expression: 'amount > 10',
+ isActive: true,
+ existingFlatValidationRule: {
+ expression: 'amount > 0',
+ isActive: true,
+ bindings: EXISTING_BINDINGS,
+ },
+ }),
+ ).toEqual(COMPILED_BINDINGS);
+ expect(compileValidationRuleExpressionOrThrow).toHaveBeenCalledTimes(1);
+ expect(compileValidationRuleExpressionOrThrow).toHaveBeenCalledWith({
+ ...COMPILE_INPUT,
+ expression: 'amount > 10',
+ });
+ });
+
+ it('should compile when an inactive rule is activated', () => {
+ expect(
+ computeValidationRuleBindings({
+ ...COMPILE_INPUT,
+ expression: 'amount > 0',
+ isActive: true,
+ existingFlatValidationRule: {
+ expression: 'amount > 0',
+ isActive: false,
+ bindings: {},
+ },
+ }),
+ ).toEqual(COMPILED_BINDINGS);
+ expect(compileValidationRuleExpressionOrThrow).toHaveBeenCalledTimes(1);
+ expect(compileValidationRuleExpressionOrThrow).toHaveBeenCalledWith({
+ ...COMPILE_INPUT,
+ expression: 'amount > 0',
+ });
+ });
+
+ it('should keep the bindings when the expression does not change', () => {
+ expect(
+ computeValidationRuleBindings({
+ ...COMPILE_INPUT,
+ expression: 'amount > 0',
+ isActive: true,
+ existingFlatValidationRule: {
+ expression: 'amount > 0',
+ isActive: true,
+ bindings: EXISTING_BINDINGS,
+ },
+ }),
+ ).toEqual(EXISTING_BINDINGS);
+ expect(compileValidationRuleExpressionOrThrow).not.toHaveBeenCalled();
+ });
+
+ it('should clear the bindings when an inactive rule gets a new expression', () => {
+ expect(
+ computeValidationRuleBindings({
+ ...COMPILE_INPUT,
+ expression: 'amount >',
+ isActive: false,
+ existingFlatValidationRule: {
+ expression: 'amount > 0',
+ isActive: false,
+ bindings: EXISTING_BINDINGS,
+ },
+ }),
+ ).toEqual({});
+ expect(compileValidationRuleExpressionOrThrow).not.toHaveBeenCalled();
+ });
+});
diff --git a/packages/twenty-server/src/engine/metadata-modules/validation-rule/utils/compute-validation-rule-bindings.util.ts b/packages/twenty-server/src/engine/metadata-modules/validation-rule/utils/compute-validation-rule-bindings.util.ts
new file mode 100644
index 00000000000..0505f007909
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/validation-rule/utils/compute-validation-rule-bindings.util.ts
@@ -0,0 +1,49 @@
+/* @license Enterprise */
+
+import { isDefined } from 'twenty-shared/utils';
+
+import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
+import { type OrmFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/orm-flat-field-metadata.type';
+import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
+import { type FlatValidationRule } from 'src/engine/metadata-modules/flat-validation-rule/types/flat-validation-rule.type';
+import { compileValidationRuleExpressionOrThrow } from 'src/engine/metadata-modules/validation-rule/utils/compile-validation-rule-expression-or-throw.util';
+
+export const computeValidationRuleBindings = ({
+ expression,
+ isActive,
+ objectMetadataId,
+ existingFlatValidationRule,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+}: {
+ expression: string;
+ isActive: boolean;
+ objectMetadataId: string;
+ existingFlatValidationRule?: Pick<
+ FlatValidationRule,
+ 'expression' | 'isActive' | 'bindings'
+ >;
+ flatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata>;
+ flatFieldMetadataMaps: FlatEntityMaps<OrmFlatFieldMetadata>;
+}): FlatValidationRule['bindings'] => {
+ const isExpressionChanged =
+ expression !== existingFlatValidationRule?.expression;
+
+ if (
+ isActive &&
+ (isExpressionChanged || !existingFlatValidationRule?.isActive)
+ ) {
+ return compileValidationRuleExpressionOrThrow({
+ expression,
+ objectMetadataId,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ });
+ }
+
+ if (!isDefined(existingFlatValidationRule) || isExpressionChanged) {
+ return {};
+ }
+
+ return existingFlatValidationRule.bindings;
+};
diff --git a/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.module.ts b/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.module.ts
index d910566cacd..cbdd4b739b7 100644
--- a/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.module.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.module.ts
@@ -7,6 +7,7 @@ import { BillingModule } from 'src/engine/core-modules/billing/billing.module';
import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
+import { ValidationRuleToolsFactory } from 'src/engine/metadata-modules/validation-rule/tools/validation-rule-tools.factory';
import { ValidationRuleResolver } from 'src/engine/metadata-modules/validation-rule/validation-rule.resolver';
import { ValidationRuleService } from 'src/engine/metadata-modules/validation-rule/validation-rule.service';
import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace-migration/workspace-migration.module';
@@ -20,6 +21,11 @@ import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace
PermissionsModule,
WorkspaceMigrationModule,
],
- providers: [ValidationRuleService, ValidationRuleResolver],
+ providers: [
+ ValidationRuleService,
+ ValidationRuleResolver,
+ ValidationRuleToolsFactory,
+ ],
+ exports: [ValidationRuleToolsFactory],
})
export class ValidationRuleModule {}
diff --git a/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.service.ts b/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.service.ts
index 6102602e936..be54907d439 100644
--- a/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.service.ts
@@ -18,6 +18,7 @@ import { type CreateValidationRuleInput } from 'src/engine/metadata-modules/vali
import { type UpdateValidationRuleInput } from 'src/engine/metadata-modules/validation-rule/dtos/update-validation-rule.input';
import { type ValidationRuleDTO } from 'src/engine/metadata-modules/validation-rule/dtos/validation-rule.dto';
import { compileValidationRuleExpressionOrThrow } from 'src/engine/metadata-modules/validation-rule/utils/compile-validation-rule-expression-or-throw.util';
+import { computeValidationRuleBindings } from 'src/engine/metadata-modules/validation-rule/utils/compute-validation-rule-bindings.util';
import {
ValidationRuleException,
ValidationRuleExceptionCode,
@@ -171,6 +172,28 @@ export class ValidationRuleService {
.map(fromFlatValidationRuleToValidationRuleDto);
}
+ async validateExpressionOrThrow({
+ expression,
+ objectMetadataId,
+ workspaceId,
+ }: {
+ expression: string;
+ objectMetadataId: string;
+ workspaceId: string;
+ }): Promise<void> {
+ await this.assertHasValidationRulesEntitlement(workspaceId);
+
+ const { flatObjectMetadataMaps, flatFieldMetadataMaps } =
+ await this.getFlatMaps(workspaceId);
+
+ compileValidationRuleExpressionOrThrow({
+ expression,
+ objectMetadataId,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ });
+ }
+
async create({
input,
workspaceId,
@@ -188,8 +211,9 @@ export class ValidationRuleService {
{ workspaceId },
);
- const bindings = compileValidationRuleExpressionOrThrow({
+ const bindings = computeValidationRuleBindings({
expression: input.expression,
+ isActive: input.isActive ?? true,
objectMetadataId: input.objectMetadataId,
flatObjectMetadataMaps,
flatFieldMetadataMaps,
@@ -239,22 +263,15 @@ export class ValidationRuleService {
workspaceId,
});
- const expression =
- input.update.expression ?? existingFlatValidationRule.expression;
- const isActive =
- input.update.isActive ?? existingFlatValidationRule.isActive;
- const shouldCompile =
- expression !== existingFlatValidationRule.expression ||
- (isActive && !existingFlatValidationRule.isActive);
-
- const bindings = shouldCompile
- ? compileValidationRuleExpressionOrThrow({
- expression,
- objectMetadataId: existingFlatValidationRule.objectMetadataId,
- flatObjectMetadataMaps,
- flatFieldMetadataMaps,
- })
- : existingFlatValidationRule.bindings;
+ const bindings = computeValidationRuleBindings({
+ expression:
+ input.update.expression ?? existingFlatValidationRule.expression,
+ isActive: input.update.isActive ?? existingFlatValidationRule.isActive,
+ objectMetadataId: existingFlatValidationRule.objectMetadataId,
+ existingFlatValidationRule,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ });
const flatValidationRuleToUpdate =
fromUpdateValidationRuleInputToFlatValidationRuleToUpdate({
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-validation-rule-validator.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-validation-rule-validator.service.ts
index 5c0c034e9a6..45b561a9b41 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-validation-rule-validator.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-validation-rule-validator.service.ts
@@ -86,6 +86,10 @@ export class FlatValidationRuleValidatorService {
});
}
+ if (!universalFlatValidationRule.isActive) {
+ return errors;
+ }
+
if (!isNonEmptyString(universalFlatValidationRule.message.trim())) {
errors.push({
code: ValidationRuleExceptionCode.INVALID_VALIDATION_RULE_INPUT,
diff --git a/packages/twenty-shared/src/constants/ValidationRuleExpressionSyntaxDescription.ts b/packages/twenty-shared/src/constants/ValidationRuleExpressionSyntaxDescription.ts
new file mode 100644
index 00000000000..f231388c724
--- /dev/null
+++ b/packages/twenty-shared/src/constants/ValidationRuleExpressionSyntaxDescription.ts
@@ -0,0 +1,8 @@
+export const VALIDATION_RULE_EXPRESSION_SYNTAX_DESCRIPTION = [
+ 'Condition that must be true for a record to be saved. When it is false, the write is rejected and the message is shown.',
+ 'Reference fields by name, as returned by get_field_metadata. Use dot access for a composite field part (amount.amountMicros, name.firstName) and for a field of a many-to-one related record (company.name), never brackets.',
+ "Compare select and multi-select fields with option values, e.g. stage == 'CUSTOMER'. Currency amounts are in micros: amount.amountMicros > 1000000000 means more than 1000.",
+ 'Write text in single quotes. Operators: == != < <= > >= + - * / and or not, and value in [a, b]. now is the date and time of the write; true and false are booleans.',
+ 'Functions: isDefined(value) is true when the value is set, even to an empty text; isEmpty(value) is true when the value is not set, an empty text, an empty list, or a composite field with every part empty; isNonEmptyString(value); includes(listOrText, value) is true when a multi-select or array contains the value, or a text contains a text, case-sensitive; arrayLength(list).',
+ 'To require a field, use not isEmpty(field).',
+].join(' ');
diff --git a/packages/twenty-shared/src/constants/index.ts b/packages/twenty-shared/src/constants/index.ts
index 5073eabac02..335f340c0a2 100644
--- a/packages/twenty-shared/src/constants/index.ts
+++ b/packages/twenty-shared/src/constants/index.ts
@@ -84,6 +84,7 @@ export { TWENTY_ICONS_BASE_URL } from './TwentyIconsBaseUrl';
export { UI_SCALE_VALUES } from './UiScaleValues';
export { VALIDATION_RULE_EMPTINESS_SUBFIELDS_BY_COMPOSITE_TYPE } from './ValidationRuleEmptinessSubfieldsByCompositeType';
export { VALIDATION_RULE_EXPRESSION_MAX_LENGTH } from './ValidationRuleExpressionMaxLength';
+export { VALIDATION_RULE_EXPRESSION_SYNTAX_DESCRIPTION } from './ValidationRuleExpressionSyntaxDescription';
export { VALIDATION_RULE_FUNCTIONS } from './ValidationRuleFunctions';
export { VALIDATION_RULE_NOW_VARIABLE_NAME } from './ValidationRuleNowVariableName';
export { VIEW_GROUP_LOAD_LIMIT_OPTIONS } from './ViewGroupLoadLimitOptions';
diff --git a/packages/twenty-shared/src/types/SettingsPath.ts b/packages/twenty-shared/src/types/SettingsPath.ts
index dcb1614a9a5..f150b7a5a12 100644
--- a/packages/twenty-shared/src/types/SettingsPath.ts
+++ b/packages/twenty-shared/src/types/SettingsPath.ts
@@ -25,7 +25,6 @@ export enum SettingsPath {
ObjectNewFieldSelect = 'objects/:objectNamePlural/new-field/select',
ObjectNewFieldConfigure = 'objects/:objectNamePlural/new-field/configure',
ObjectNewIndex = 'objects/:objectNamePlural/new-index',
- ObjectNewValidationRule = 'objects/:objectNamePlural/new-validation-rule',
ObjectValidationRuleEdit = 'objects/:objectNamePlural/validation-rules/:validationRuleId',
ObjectFieldEdit = 'objects/:objectNamePlural/:fieldName',
ObjectTranslations = 'objects/:objectNamePlural/object-translations',