Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

fix(web): handle default model form submission feedback (#44345)

yyh67887de9e427
diff --git a/web/app/components/header/account-setting/model-provider-page/system-model-selector/__tests__/index.spec.tsx b/web/app/components/header/account-setting/model-provider-page/system-model-selector/__tests__/index.spec.tsx
index 26b4db364fe..46902c4cc2b 100644
--- a/web/app/components/header/account-setting/model-provider-page/system-model-selector/__tests__/index.spec.tsx
+++ b/web/app/components/header/account-setting/model-provider-page/system-model-selector/__tests__/index.spec.tsx
@@ -9,6 +9,7 @@ import {
seedModelProviderQueries,
} from '@/test/console/model-provider'
import { createConsoleQueryWrapper } from '@/test/console/query-data'
+import { createDeferred } from '@/test/deferred'
import { renderWithNuqs } from '@/test/nuqs-testing'
import { ModelTypeEnum } from '../../declarations'
import SystemModel from '../index'
@@ -104,14 +105,11 @@ vi.mock('../../hooks', async (importOriginal) => {
vi.mock('@/service/console', async (importOriginal) => {
const actual = await importOriginal<typeof import('@/service/console')>()
- const { withConsoleResponses, withConsoleClientResponses } =
- await import('@/test/console/service-responses')
+ const { withConsoleResponses } = await import('@/test/console/service-responses')
return {
...actual,
consoleQuery: withConsoleResponses(actual.consoleQuery, {
'workspaces.current.models.modelTypes.byModelType.get': getModelList,
- }),
- consoleClient: withConsoleClientResponses(actual.consoleClient, {
'workspaces.current.defaultModel.post': mockUpdateDefaultModel,
}),
}
@@ -142,6 +140,7 @@ const defaultProps = {
describe('SystemModel', () => {
beforeEach(() => {
vi.clearAllMocks()
+ mockUpdateDefaultModel.mockReset().mockResolvedValue({ result: 'success' })
getModelList.mockResolvedValue({ data: [] })
mockWorkspacePermissionKeys = ['plugin.model_config']
})
@@ -276,12 +275,68 @@ describe('SystemModel', () => {
].map((model_type) => ({ model_type, provider: 'test', model: 'test' })),
},
})
- expect(mockToastSuccess).toHaveBeenCalledWith('Modified successfully')
+ expect(mockToastSuccess).not.toHaveBeenCalled()
expect(mockInvalidateDefaultModel).toHaveBeenCalledTimes(5)
expect(mockUpdateModelList).toHaveBeenCalledTimes(5)
})
})
+ it('blocks repeated submission, editing and dismissal until saving completes', async () => {
+ const user = userEvent.setup()
+ const request = createDeferred<{ result: string }>()
+ mockUpdateDefaultModel.mockReturnValueOnce(request.promise)
+ render(<SystemModel {...defaultProps} />)
+
+ await user.click(screen.getByRole('button', { name: /system model settings/i }))
+ const save = screen.getByRole('button', { name: 'Save' })
+ await user.click(save)
+ await waitFor(() => expect(save).toHaveAttribute('aria-disabled', 'true'))
+ expect(save).toBeEnabled()
+ expect(save).toHaveFocus()
+ expect(screen.getByRole('button', { name: 'Cancel' })).toBeDisabled()
+ expect(screen.getByRole('button', { name: 'Reset System Reasoning Model' })).toBeDisabled()
+ expect(screen.getByRole('button', { name: /gpt-4/ })).toBeDisabled()
+
+ await user.click(save)
+ await user.keyboard('{Enter}{Escape}')
+ expect(mockUpdateDefaultModel).toHaveBeenCalledTimes(1)
+ expect(screen.getByRole('dialog', { name: 'Default Model Settings' })).toBeInTheDocument()
+
+ request.resolve({ result: 'success' })
+ await waitFor(() =>
+ expect(
+ screen.queryByRole('dialog', { name: 'Default Model Settings' }),
+ ).not.toBeInTheDocument(),
+ )
+ expect(mockToastSuccess).not.toHaveBeenCalled()
+ })
+
+ it('shows a save error inline, preserves the draft and allows retry', async () => {
+ const user = userEvent.setup()
+ mockUpdateDefaultModel.mockRejectedValueOnce(new Error('Unable to save model settings'))
+ render(<SystemModel {...defaultProps} />)
+
+ await user.click(screen.getByRole('button', { name: /system model settings/i }))
+ await user.click(screen.getByRole('button', { name: 'Reset System Reasoning Model' }))
+ await user.click(screen.getByRole('button', { name: 'Save' }))
+
+ expect(await screen.findByRole('alert')).toHaveTextContent('Unable to save model settings')
+ expect(
+ screen.queryByRole('button', { name: 'Reset System Reasoning Model' }),
+ ).not.toBeInTheDocument()
+ expect(screen.getByRole('button', { name: 'Cancel' })).toBeEnabled()
+ expect(mockInvalidateDefaultModel).not.toHaveBeenCalled()
+
+ await user.click(screen.getByRole('button', { name: 'Save' }))
+ await waitFor(() =>
+ expect(
+ screen.queryByRole('dialog', { name: 'Default Model Settings' }),
+ ).not.toBeInTheDocument(),
+ )
+ expect(mockUpdateDefaultModel).toHaveBeenCalledTimes(2)
+ expect(mockUpdateDefaultModel.mock.calls[1]).toEqual(mockUpdateDefaultModel.mock.calls[0])
+ })
+
it('should keep the dialog open when saving does not succeed', async () => {
const user = userEvent.setup()
mockUpdateDefaultModel.mockResolvedValueOnce({ result: 'failed' })
diff --git a/web/app/components/header/account-setting/model-provider-page/system-model-selector/index.tsx b/web/app/components/header/account-setting/model-provider-page/system-model-selector/index.tsx
index ea826f664eb..44184dfa1e7 100644
--- a/web/app/components/header/account-setting/model-provider-page/system-model-selector/index.tsx
+++ b/web/app/components/header/account-setting/model-provider-page/system-model-selector/index.tsx
@@ -14,14 +14,13 @@ import {
DialogTrigger,
} from '@langgenius/dify-ui/dialog'
import { Infotip, InfotipContent, InfotipTrigger } from '@langgenius/dify-ui/infotip'
-import { useQuery } from '@tanstack/react-query'
+import { useMutation, useQuery } from '@tanstack/react-query'
import { useAtomValue } from 'jotai'
import { parseAsStringLiteral, useQueryState } from 'nuqs'
import { useId, useState } from 'react'
import { useTranslation } from 'react-i18next'
-import { toast } from '@/app/notifications'
import { workspacePermissionKeysAtom } from '@/context/permission-state'
-import { consoleClient, consoleQuery } from '@/service/console'
+import { consoleQuery } from '@/service/console'
import { hasPermission } from '@/utils/permission'
import { ModelTypeEnum } from '../declarations'
import {
@@ -136,7 +135,35 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
] = useSystemDefaultModelAndModelList(speech2textDefaultModel, speech2textModelList)
const [currentTTSDefaultModel, changeCurrentTTSDefaultModel, resetTTSDefaultModel] =
useSystemDefaultModelAndModelList(ttsDefaultModel, ttsModelList)
+ const saveMutation = useMutation(
+ consoleQuery.workspaces.current.defaultModel.post.mutationOptions({
+ context: { silent: true },
+ onSuccess: (res) => {
+ if (res.result !== 'success') return
+
+ setManuallyOpen(false)
+ if (activeDialog === 'system-models') void setActiveDialog(null)
+ setChangedModelTypes([])
+ const allModelTypes = [
+ ModelTypeEnum.textGeneration,
+ ModelTypeEnum.textEmbedding,
+ ModelTypeEnum.rerank,
+ ModelTypeEnum.speech2text,
+ ModelTypeEnum.tts,
+ ]
+ allModelTypes.forEach((type) => invalidateDefaultModel(type))
+ changedModelTypes.forEach((type) => updateModelList(type))
+ },
+ }),
+ )
+ const saveError =
+ saveMutation.error?.message ||
+ (saveMutation.isError || (saveMutation.isSuccess && saveMutation.data.result !== 'success')
+ ? t(($) => $['actionMsg.modifiedUnsuccessfully'], { ns: 'common' })
+ : undefined)
const handleOpenChange = (nextOpen: boolean) => {
+ if (saveMutation.isPending) return
+ saveMutation.reset()
if (!nextOpen) {
resetTextGenerationDefaultModel()
resetEmbeddingsDefaultModel()
@@ -174,10 +201,10 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
if (!changedModelTypes.includes(modelType))
setChangedModelTypes([...changedModelTypes, modelType])
}
- const handleSave = async () => {
- if (!canManageSystemDefaultModel || isSystemModelListLoading) return
+ const handleSave = () => {
+ if (!canManageSystemDefaultModel || isSystemModelListLoading || saveMutation.isPending) return
- const res = await consoleClient.workspaces.current.defaultModel.post({
+ saveMutation.mutate({
body: {
model_settings: [
ModelTypeEnum.textGeneration,
@@ -194,22 +221,6 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
}),
},
})
- if (res.result === 'success') {
- toast.success(t(($) => $['actionMsg.modifiedSuccessfully'], { ns: 'common' }))
- setManuallyOpen(false)
- if (activeDialog === 'system-models') void setActiveDialog(null)
- setChangedModelTypes([])
-
- const allModelTypes = [
- ModelTypeEnum.textGeneration,
- ModelTypeEnum.textEmbedding,
- ModelTypeEnum.rerank,
- ModelTypeEnum.speech2text,
- ModelTypeEnum.tts,
- ]
- allModelTypes.forEach((type) => invalidateDefaultModel(type))
- changedModelTypes.forEach((type) => updateModelList(type))
- }
}
const getResetProps = (modelType: ModelTypeEnum, labelKey: SystemModelLabelKey) => ({
@@ -241,7 +252,16 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
}
return (
- <Dialog open={open} onOpenChange={handleOpenChange}>
+ <Dialog
+ open={open}
+ onOpenChange={(nextOpen, details) => {
+ if (saveMutation.isPending) {
+ details.cancel()
+ return
+ }
+ handleOpenChange(nextOpen)
+ }}
+ >
<DialogTrigger
render={<Button variant={notConfigured ? 'primary' : 'secondary'} size="small" />}
className={cn('relative', className)}
@@ -259,7 +279,7 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
<form
onSubmit={(event) => {
event.preventDefault()
- void handleSave()
+ handleSave()
}}
/>
}
@@ -273,7 +293,10 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
<DialogDescription>
{t(($) => $['modelProvider.systemModelSettingsDesc'], { ns: 'modelProvider' })}
</DialogDescription>
- <DialogHeaderCloseButton aria-label={t(($) => $['operation.close'], { ns: 'common' })} />
+ <DialogHeaderCloseButton
+ disabled={saveMutation.isPending}
+ aria-label={t(($) => $['operation.close'], { ns: 'common' })}
+ />
</DialogHeader>
<DialogBody>
{isSystemModelListLoading ? (
@@ -296,6 +319,7 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
)}
<div>
<ModelSelector
+ disabled={saveMutation.isPending}
{...getResetProps(
ModelTypeEnum.textGeneration,
'modelProvider.systemReasoningModel.key',
@@ -319,6 +343,7 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
)}
<div>
<ModelSelector
+ disabled={saveMutation.isPending}
{...getResetProps(
ModelTypeEnum.textEmbedding,
'modelProvider.embeddingModel.key',
@@ -339,6 +364,7 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
{renderModelLabel('modelProvider.rerankModel.key', 'modelProvider.rerankModel.tip')}
<div>
<ModelSelector
+ disabled={saveMutation.isPending}
{...getResetProps(ModelTypeEnum.rerank, 'modelProvider.rerankModel.key')}
value={currentRerankDefaultModel}
models={rerankModelList}
@@ -357,6 +383,7 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
)}
<div>
<ModelSelector
+ disabled={saveMutation.isPending}
{...getResetProps(
ModelTypeEnum.speech2text,
'modelProvider.speechToTextModel.key',
@@ -377,6 +404,7 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
{renderModelLabel('modelProvider.ttsModel.key', 'modelProvider.ttsModel.tip')}
<div>
<ModelSelector
+ disabled={saveMutation.isPending}
{...getResetProps(ModelTypeEnum.tts, 'modelProvider.ttsModel.key')}
value={currentTTSDefaultModel}
models={ttsModelList}
@@ -390,15 +418,25 @@ const SystemModel: FC<SystemModelSelectorProps> = ({
</div>
</div>
)}
+ {saveError && (
+ <p role="alert" className="mt-4 text-sm text-text-destructive">
+ {saveError}
+ </p>
+ )}
</DialogBody>
<DialogFooter>
- <Button className="min-w-18" onClick={() => handleOpenChange(false)}>
+ <Button
+ className="min-w-18"
+ disabled={saveMutation.isPending}
+ onClick={() => handleOpenChange(false)}
+ >
{t(($) => $['operation.cancel'], { ns: 'common' })}
</Button>
<Button
className="min-w-18"
variant="primary"
type="submit"
+ loading={saveMutation.isPending}
disabled={!canManageSystemDefaultModel || isSystemModelListLoading}
>
{t(($) => $['operation.save'], { ns: 'common' })}