Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

Feat: When there are errors in the chat settings form, clicking the "Save" button automatically scrolls to the location of the error. (#18811)

balibabu043232ebe2bf
diff --git a/web/src/components/__tests__/collapse.test.tsx b/web/src/components/__tests__/collapse.test.tsx
new file mode 100644
index 0000000000..ee932d5b51
--- /dev/null
+++ b/web/src/components/__tests__/collapse.test.tsx
@@ -0,0 +1,70 @@
+import { fireEvent, render, screen } from '@testing-library/react';
+import { Collapse } from '../collapse';
+
+describe('Collapse', () => {
+ it('mounts and unmounts content at render time when open is controlled', () => {
+ const { rerender } = render(
+ <Collapse title="Section" open={false}>
+ <div>inner content</div>
+ </Collapse>,
+ );
+ expect(screen.queryByText('inner content')).not.toBeInTheDocument();
+
+ rerender(
+ <Collapse title="Section" open={true}>
+ <div>inner content</div>
+ </Collapse>,
+ );
+ expect(screen.getByText('inner content')).toBeInTheDocument();
+
+ rerender(
+ <Collapse title="Section" open={false}>
+ <div>inner content</div>
+ </Collapse>,
+ );
+ expect(screen.queryByText('inner content')).not.toBeInTheDocument();
+ });
+
+ it('notifies onOpenChange when the trigger is clicked in controlled mode', () => {
+ const handleOpenChange = jest.fn();
+ render(
+ <Collapse title="Section" open={false} onOpenChange={handleOpenChange}>
+ <div>inner content</div>
+ </Collapse>,
+ );
+
+ fireEvent.click(screen.getByText('Section'));
+
+ expect(handleOpenChange).toHaveBeenCalledWith(true);
+ });
+
+ it('toggles by itself when open is not provided', () => {
+ render(
+ <Collapse title="Section" defaultOpen>
+ <div>inner content</div>
+ </Collapse>,
+ );
+ expect(screen.getByText('inner content')).toBeInTheDocument();
+
+ fireEvent.click(screen.getByText('Section'));
+
+ expect(screen.queryByText('inner content')).not.toBeInTheDocument();
+ });
+
+ it('follows a changing defaultOpen when uncontrolled', () => {
+ const { rerender } = render(
+ <Collapse title="Section" defaultOpen={false}>
+ <div>inner content</div>
+ </Collapse>,
+ );
+ expect(screen.queryByText('inner content')).not.toBeInTheDocument();
+
+ rerender(
+ <Collapse title="Section" defaultOpen={true}>
+ <div>inner content</div>
+ </Collapse>,
+ );
+
+ expect(screen.getByText('inner content')).toBeInTheDocument();
+ });
+});
diff --git a/web/src/components/__tests__/switch-fom-field.test.tsx b/web/src/components/__tests__/switch-fom-field.test.tsx
index 47655e0965..90ee0f8f28 100644
--- a/web/src/components/__tests__/switch-fom-field.test.tsx
+++ b/web/src/components/__tests__/switch-fom-field.test.tsx
@@ -1,6 +1,7 @@
import { Form } from '@/components/ui/form';
import { TooltipProvider } from '@/components/ui/tooltip';
import { fireEvent, render, screen } from '@testing-library/react';
+import { useEffect } from 'react';
import { useForm } from 'react-hook-form';
import { SwitchFormField } from '../switch-fom-field';
@@ -19,6 +20,20 @@ function Harness() {
);
}
+function ErrorHarness() {
+ const form = useForm({ defaultValues: { flag: false } });
+ useEffect(() => {
+ form.setError('flag', { type: 'required', message: 'Flag is required' });
+ }, [form]);
+ return (
+ <TooltipProvider>
+ <Form {...form}>
+ <SwitchFormField name="flag" label="Enable feature" />
+ </Form>
+ </TooltipProvider>
+ );
+}
+
describe('SwitchFormField', () => {
it('toggles the switch when the label text is clicked', () => {
render(<Harness />);
@@ -41,4 +56,10 @@ describe('SwitchFormField', () => {
expect(switchEl).toHaveAttribute('data-state', 'unchecked');
});
+
+ it('renders the field error message', () => {
+ render(<ErrorHarness />);
+
+ expect(screen.getByText('Flag is required')).toBeInTheDocument();
+ });
});
diff --git a/web/src/components/collapse.tsx b/web/src/components/collapse.tsx
index a2cdee097d..047060518f 100644
--- a/web/src/components/collapse.tsx
+++ b/web/src/components/collapse.tsx
@@ -50,19 +50,21 @@ export function Collapse({
onOpenChange,
disabled,
}: CollapseProps) {
- const [currentOpen, setCurrentOpen] = useState(open);
+ const [internalOpen, setInternalOpen] = useState(open ?? defaultOpen);
useEffect(() => {
- if (typeof open === 'boolean') {
- setCurrentOpen(open);
- } else {
- setCurrentOpen(defaultOpen);
+ if (typeof open !== 'boolean') {
+ setInternalOpen(defaultOpen);
}
}, [defaultOpen, open]);
+ // A boolean `open` prop takes effect at render time so callers can rely on
+ // the content being mounted right after they update it.
+ const currentOpen = typeof open === 'boolean' ? open : internalOpen;
+
const handleOpenChange = useCallback(
(open: boolean) => {
- setCurrentOpen(open);
+ setInternalOpen(open);
onOpenChange?.(open);
},
[onOpenChange],
diff --git a/web/src/components/llm-setting-items/next.tsx b/web/src/components/llm-setting-items/next.tsx
index 95448511aa..6eddf6c824 100644
--- a/web/src/components/llm-setting-items/next.tsx
+++ b/web/src/components/llm-setting-items/next.tsx
@@ -57,6 +57,8 @@ interface LlmSettingFieldItemsProps {
| 'thinking'
>;
showCollapse?: boolean;
+ collapseOpen?: boolean;
+ onCollapseOpenChange?: (open: boolean) => void;
ownerTenantId?: string;
}
@@ -103,6 +105,8 @@ export function LlmSettingFieldItems({
],
llmId,
showCollapse = false,
+ collapseOpen,
+ onCollapseOpenChange,
ownerTenantId,
}: LlmSettingFieldItemsProps) {
const form = useFormContext();
@@ -303,7 +307,13 @@ export function LlmSettingFieldItems({
ownerTenantId={ownerTenantId}
></LLMFormField>
{showCollapse ? (
- <Collapse title={t('modelSetting')}>{settingFields}</Collapse>
+ <Collapse
+ title={t('modelSetting')}
+ open={collapseOpen}
+ onOpenChange={onCollapseOpenChange}
+ >
+ {settingFields}
+ </Collapse>
) : (
settingFields
)}
diff --git a/web/src/components/switch-fom-field.tsx b/web/src/components/switch-fom-field.tsx
index b6539ee445..ada22d87d7 100644
--- a/web/src/components/switch-fom-field.tsx
+++ b/web/src/components/switch-fom-field.tsx
@@ -19,6 +19,7 @@ import {
FormField,
FormItem,
FormLabel,
+ FormMessage,
} from '@/components/ui/form';
import { Switch } from '@/components/ui/switch';
import { cn } from '@/lib/utils';
@@ -63,6 +64,7 @@ export function SwitchFormField({
className="!m-0"
/>
</FormControl>
+ <FormMessage />
</FormItem>
)}
/>
diff --git a/web/src/pages/next-chats/chat/app-settings/chat-basic-settings.tsx b/web/src/pages/next-chats/chat/app-settings/chat-basic-settings.tsx
index 8a41ed53e9..5de48ca2a8 100644
--- a/web/src/pages/next-chats/chat/app-settings/chat-basic-settings.tsx
+++ b/web/src/pages/next-chats/chat/app-settings/chat-basic-settings.tsx
@@ -20,11 +20,15 @@ interface ChatBasicSettingProps {
prefix?: string;
option?: Record<string, any>;
hideName?: boolean;
+ collapseOpen?: boolean;
+ onCollapseOpenChange?: (open: boolean) => void;
}
export default function ChatBasicSetting({
prefix = '',
hideName = false,
+ collapseOpen,
+ onCollapseOpenChange,
}: ChatBasicSettingProps) {
const { t } = useTranslate('chat');
const form = useFormContext();
@@ -49,6 +53,8 @@ export default function ChatBasicSetting({
prefix={llmSettingPrefix}
llmId={prefixName(prefix, 'llm_id')}
showCollapse
+ collapseOpen={collapseOpen}
+ onCollapseOpenChange={onCollapseOpenChange}
></LlmSettingFieldItems>
<FormField
diff --git a/web/src/pages/next-chats/chat/app-settings/chat-prompt-engine.tsx b/web/src/pages/next-chats/chat/app-settings/chat-prompt-engine.tsx
index f827236b06..571a995b81 100644
--- a/web/src/pages/next-chats/chat/app-settings/chat-prompt-engine.tsx
+++ b/web/src/pages/next-chats/chat/app-settings/chat-prompt-engine.tsx
@@ -29,9 +29,15 @@ import { DynamicVariableForm } from './dynamic-variable';
interface ChatPromptEngineProps {
prefix?: string;
+ collapseOpen?: boolean;
+ onCollapseOpenChange?: (open: boolean) => void;
}
-export function ChatPromptEngine({ prefix = '' }: ChatPromptEngineProps) {
+export function ChatPromptEngine({
+ prefix = '',
+ collapseOpen,
+ onCollapseOpenChange,
+}: ChatPromptEngineProps) {
const { t } = useTranslation();
const form = useFormContext();
const systemPromptValue = form.watch(
@@ -90,7 +96,11 @@ export function ChatPromptEngine({ prefix = '' }: ChatPromptEngineProps) {
}, [kbIds, metadataKeys, metadataKeysLoading, metadataInclude, form, prefix]);
return (
- <Collapse title={t('flow.advancedSettings')}>
+ <Collapse
+ title={t('flow.advancedSettings')}
+ open={collapseOpen}
+ onOpenChange={onCollapseOpenChange}
+ >
<div className="space-y-8">
<FormField
control={form.control}
diff --git a/web/src/pages/next-chats/chat/app-settings/chat-settings.tsx b/web/src/pages/next-chats/chat/app-settings/chat-settings.tsx
index 30f6c3284a..fa2207ebcb 100644
--- a/web/src/pages/next-chats/chat/app-settings/chat-settings.tsx
+++ b/web/src/pages/next-chats/chat/app-settings/chat-settings.tsx
@@ -26,6 +26,7 @@ import ChatBasicSetting from './chat-basic-settings';
import { ChatPromptEngine } from './chat-prompt-engine';
import { SavingButton } from './saving-button';
import { useChatSettingSchema } from './use-chat-setting-schema';
+import { useRevealSubmitErrors } from './use-reveal-submit-errors';
import { getWebSearchProvider } from '../web-search-api-key';
type ChatSettingsProps = { hasSingleChatBox: boolean };
@@ -46,6 +47,15 @@ export function ChatSettings({ hasSingleChatBox }: ChatSettingsProps) {
const { visible: settingVisible, switchVisible: switchSettingVisible } =
useSetModalState(false);
+ const {
+ formContainerRef,
+ handleInvalidSubmit,
+ modelSettingOpen,
+ onModelSettingOpenChange,
+ advancedSettingOpen,
+ onAdvancedSettingOpenChange,
+ } = useRevealSubmitErrors();
+
type FormSchemaType = z.infer<typeof formSchema>;
const form = useForm<FormSchemaType>({
@@ -125,10 +135,6 @@ export function ChatSettings({ hasSingleChatBox }: ChatSettingsProps) {
});
}
- function onInvalid(errors: any) {
- void errors;
- }
-
useEffect(() => {
const llmSettingEnabledValues = setLLMSettingEnabledValues(
data.llm_setting,
@@ -203,13 +209,20 @@ export function ChatSettings({ hasSingleChatBox }: ChatSettingsProps) {
<Form {...form}>
<form
- onSubmit={form.handleSubmit(onSubmit, onInvalid)}
+ ref={formContainerRef}
+ onSubmit={form.handleSubmit(onSubmit, handleInvalidSubmit)}
className="flex-1 flex flex-col min-h-0"
>
<ScrollArea viewportClassName="[&>div]:!block">
<section className="p-5 space-y-6 overflow-auto flex-1 min-h-0">
- <ChatBasicSetting></ChatBasicSetting>
- <ChatPromptEngine></ChatPromptEngine>
+ <ChatBasicSetting
+ collapseOpen={modelSettingOpen}
+ onCollapseOpenChange={onModelSettingOpenChange}
+ ></ChatBasicSetting>
+ <ChatPromptEngine
+ collapseOpen={advancedSettingOpen}
+ onCollapseOpenChange={onAdvancedSettingOpenChange}
+ ></ChatPromptEngine>
</section>
</ScrollArea>
diff --git a/web/src/pages/next-chats/chat/app-settings/use-reveal-submit-errors.test.tsx b/web/src/pages/next-chats/chat/app-settings/use-reveal-submit-errors.test.tsx
new file mode 100644
index 0000000000..29b8a491b1
--- /dev/null
+++ b/web/src/pages/next-chats/chat/app-settings/use-reveal-submit-errors.test.tsx
@@ -0,0 +1,67 @@
+import { fireEvent, render, screen } from '@testing-library/react';
+import { useRevealSubmitErrors } from './use-reveal-submit-errors';
+
+const scrollIntoViewMock = jest.fn();
+
+beforeAll(() => {
+ Element.prototype.scrollIntoView = scrollIntoViewMock;
+});
+
+beforeEach(() => {
+ scrollIntoViewMock.mockClear();
+});
+
+function Harness() {
+ const {
+ formContainerRef,
+ handleInvalidSubmit,
+ modelSettingOpen,
+ advancedSettingOpen,
+ } = useRevealSubmitErrors();
+
+ return (
+ <form ref={formContainerRef}>
+ <span data-testid="model-open">{String(modelSettingOpen)}</span>
+ <span data-testid="advanced-open">{String(advancedSettingOpen)}</span>
+ <button type="button" onClick={handleInvalidSubmit}>
+ save
+ </button>
+ <p id="name-form-item-message">Name is required</p>
+ </form>
+ );
+}
+
+describe('useRevealSubmitErrors', () => {
+ it('keeps both sections collapsed initially', () => {
+ render(<Harness />);
+
+ expect(screen.getByTestId('model-open')).toHaveTextContent('false');
+ expect(screen.getByTestId('advanced-open')).toHaveTextContent('false');
+ });
+
+ it('expands both sections and scrolls to the first error on invalid submit', () => {
+ render(<Harness />);
+
+ fireEvent.click(screen.getByText('save'));
+
+ expect(screen.getByTestId('model-open')).toHaveTextContent('true');
+ expect(screen.getByTestId('advanced-open')).toHaveTextContent('true');
+ expect(scrollIntoViewMock).toHaveBeenCalledTimes(1);
+ expect(scrollIntoViewMock).toHaveBeenCalledWith({
+ behavior: 'smooth',
+ block: 'center',
+ });
+ expect(scrollIntoViewMock.mock.instances[0]).toBe(
+ screen.getByText('Name is required'),
+ );
+ });
+
+ it('scrolls again on every repeated invalid submit', () => {
+ render(<Harness />);
+
+ fireEvent.click(screen.getByText('save'));
+ fireEvent.click(screen.getByText('save'));
+
+ expect(scrollIntoViewMock).toHaveBeenCalledTimes(2);
+ });
+});
diff --git a/web/src/pages/next-chats/chat/app-settings/use-reveal-submit-errors.ts b/web/src/pages/next-chats/chat/app-settings/use-reveal-submit-errors.ts
new file mode 100644
index 0000000000..a78f6d4c22
--- /dev/null
+++ b/web/src/pages/next-chats/chat/app-settings/use-reveal-submit-errors.ts
@@ -0,0 +1,48 @@
+import { useCallback, useLayoutEffect, useRef, useState } from 'react';
+
+// Elements that flag a validation error: the control marked by FormControl or
+// the message paragraph rendered by FormMessage.
+const ErrorIndicatorSelector =
+ '[aria-invalid="true"], [id$="-form-item-message"]';
+
+/**
+ * Reveals validation errors after an invalid submit: expands every collapsed
+ * settings section and scrolls the first error into view. The signal counter
+ * re-triggers the layout effect on every invalid submit, even when the
+ * sections are already open.
+ */
+export function useRevealSubmitErrors() {
+ const [modelSettingOpen, setModelSettingOpen] = useState(false);
+ const [advancedSettingOpen, setAdvancedSettingOpen] = useState(false);
+ const [invalidSubmitSignal, setInvalidSubmitSignal] = useState(0);
+ const formContainerRef = useRef<HTMLFormElement>(null);
+
+ const handleInvalidSubmit = useCallback(() => {
+ setModelSettingOpen(true);
+ setAdvancedSettingOpen(true);
+ setInvalidSubmitSignal((signal) => signal + 1);
+ }, []);
+
+ useLayoutEffect(() => {
+ if (invalidSubmitSignal === 0) {
+ return;
+ }
+ const firstErrorIndicator =
+ formContainerRef.current?.querySelector<HTMLElement>(
+ ErrorIndicatorSelector,
+ );
+ firstErrorIndicator?.scrollIntoView({
+ behavior: 'smooth',
+ block: 'center',
+ });
+ }, [invalidSubmitSignal]);
+
+ return {
+ formContainerRef,
+ handleInvalidSubmit,
+ modelSettingOpen,
+ onModelSettingOpenChange: setModelSettingOpen,
+ advancedSettingOpen,
+ onAdvancedSettingOpenChange: setAdvancedSettingOpen,
+ };
+}