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: preserve default model display after plugin removal (#42498)

林玮 (Jade Lin)f495581a050b
diff --git a/api/services/model_provider_service.py b/api/services/model_provider_service.py
index 11ba3723751..4804af7e508 100644
--- a/api/services/model_provider_service.py
+++ b/api/services/model_provider_service.py
@@ -20,6 +20,7 @@ from core.plugin.plugin_service import PluginService
from core.provider_manager import ProviderManager
from enums import DeploymentEdition
from extensions import ext_hosting_provider
+from graphon.model_runtime.entities.common_entities import I18nObject
from graphon.model_runtime.entities.model_entities import ModelType, ParameterRule
from models.provider import (
Provider,
@@ -27,6 +28,7 @@ from models.provider import (
ProviderModel,
ProviderModelCredential,
ProviderType,
+ TenantDefaultModel,
TenantPreferredModelProvider,
)
from models.provider_ids import ModelProviderID
@@ -782,7 +784,7 @@ class ModelProviderService:
def get_default_model_of_model_type(self, tenant_id: str, model_type: str) -> DefaultModelResponse | None:
"""
- get default model of model type.
+ Get the default model, preserving saved configuration when provider resolution fails.
:param tenant_id: workspace id
:param model_type: model type
@@ -811,8 +813,30 @@ class ModelProviderService:
)
except Exception as e:
logger.debug("get_default_model_of_model_type error: %s", e)
+
+ # Provider metadata is optional for displaying the saved configuration.
+ with session_factory.create_session() as session:
+ saved_model = session.execute(
+ select(TenantDefaultModel.model_name, TenantDefaultModel.provider_name).where(
+ TenantDefaultModel.tenant_id == tenant_id,
+ TenantDefaultModel.model_type == model_type_enum,
+ )
+ ).one_or_none()
+
+ if saved_model is None:
return None
+ return DefaultModelResponse(
+ model=saved_model.model_name,
+ model_type=model_type_enum,
+ provider=SimpleProviderEntityResponse(
+ tenant_id=tenant_id,
+ provider=saved_model.provider_name,
+ label=I18nObject(en_US=saved_model.provider_name, zh_Hans=saved_model.provider_name),
+ supported_model_types=[],
+ ),
+ )
+
def update_default_model_of_model_type(self, tenant_id: str, model_type: str, provider: str, model: str):
"""
update default model of model type.
diff --git a/api/tests/unit_tests/services/test_model_provider_service.py b/api/tests/unit_tests/services/test_model_provider_service.py
index 2c2f86bbf40..fd2137de20a 100644
--- a/api/tests/unit_tests/services/test_model_provider_service.py
+++ b/api/tests/unit_tests/services/test_model_provider_service.py
@@ -20,6 +20,7 @@ from models.provider import (
ProviderCredential,
ProviderModel,
ProviderType,
+ TenantDefaultModel,
TenantPreferredModelProvider,
)
from services import model_provider_service as service_module
@@ -996,7 +997,7 @@ class TestModelProviderServiceListingsAndDefaults:
assert result is None
- def test_get_default_model_of_model_type_should_return_none_when_manager_raises_exception(self) -> None:
+ def test_get_default_model_of_model_type_should_return_none_when_no_configuration_is_saved(self) -> None:
service, manager = _create_service_with_mocked_manager()
manager.get_default_model.side_effect = RuntimeError("boom")
@@ -1004,6 +1005,63 @@ class TestModelProviderServiceListingsAndDefaults:
assert result is None
+ @pytest.mark.parametrize(
+ "error",
+ [ValueError("Invalid provider: langgenius/openai/openai"), RuntimeError("Plugin daemon unavailable")],
+ )
+ def test_get_default_model_of_model_type_should_preserve_saved_configuration_on_provider_failure(
+ self, sqlite_session: Session, error: Exception
+ ) -> None:
+ saved_model = TenantDefaultModel(
+ tenant_id="tenant-1",
+ model_type=ModelType.LLM,
+ provider_name="langgenius/openai/openai",
+ model_name="gpt-4o",
+ )
+ sqlite_session.add(saved_model)
+ sqlite_session.commit()
+ service, manager = _create_service_with_mocked_manager()
+ manager.get_default_model.side_effect = error
+
+ result = service.get_default_model_of_model_type(tenant_id="tenant-1", model_type=ModelType.LLM)
+
+ assert result is not None
+ assert result.model == "gpt-4o"
+ assert result.model_type == ModelType.LLM
+ assert result.provider.provider == "langgenius/openai/openai"
+ assert result.provider.tenant_id == "tenant-1"
+ assert result.provider.label.en_us == "langgenius/openai/openai"
+ assert result.provider.label.zh_hans == "langgenius/openai/openai"
+ assert result.provider.icon_small is None
+ assert result.provider.supported_model_types == []
+ assert result.model_dump(mode="json")["model_type"] == "llm"
+ sqlite_session.refresh(saved_model)
+ assert saved_model.model_name == "gpt-4o"
+ assert saved_model.provider_name == "langgenius/openai/openai"
+
+ @pytest.mark.parametrize(
+ ("tenant_id", "model_type"),
+ [("other-tenant", ModelType.LLM), ("tenant-1", ModelType.TEXT_EMBEDDING)],
+ )
+ def test_get_default_model_of_model_type_should_not_fall_back_to_another_tenant_or_model_type(
+ self, sqlite_session: Session, tenant_id: str, model_type: ModelType
+ ) -> None:
+ sqlite_session.add(
+ TenantDefaultModel(
+ tenant_id=tenant_id,
+ model_type=model_type,
+ provider_name="langgenius/openai/openai",
+ model_name="configured-model",
+ )
+ )
+ sqlite_session.commit()
+ service, manager = _create_service_with_mocked_manager()
+ manager.get_default_model.side_effect = ValueError("Invalid provider: langgenius/openai/openai")
+
+ result = service.get_default_model_of_model_type(tenant_id="tenant-1", model_type=ModelType.LLM)
+
+ assert result is None
+
def test_update_default_model_of_model_type_should_delegate_to_provider_manager(self) -> None:
service, manager = _create_service_with_mocked_manager()
diff --git a/web/app/components/header/account-setting/model-provider-page/__tests__/hooks.spec.ts b/web/app/components/header/account-setting/model-provider-page/__tests__/hooks.spec.ts
index c440fcd6d06..56eabeea9be 100644
--- a/web/app/components/header/account-setting/model-provider-page/__tests__/hooks.spec.ts
+++ b/web/app/components/header/account-setting/model-provider-page/__tests__/hooks.spec.ts
@@ -188,7 +188,7 @@ describe('hooks', () => {
expect(result.current[0]).toBeUndefined()
})
- it('should return undefined when provider not found in model list', () => {
+ it('should preserve the default model when its provider is missing from the model list', () => {
const defaultModel = {
provider: {
provider: 'anthropic',
@@ -202,17 +202,17 @@ describe('hooks', () => {
useSystemDefaultModelAndModelList(defaultModel, modelList),
)
- expect(result.current[0]).toBeUndefined()
+ expect(result.current[0]).toEqual({ model: 'claude-3', provider: 'anthropic' })
})
- it('should return undefined when model not found in provider', () => {
+ it('should preserve the default model when it is missing from its provider', () => {
const defaultModel = createMockDefaultModel('gpt-5')
const modelList = createMockModelList()
const { result } = renderHook(() =>
useSystemDefaultModelAndModelList(defaultModel, modelList),
)
- expect(result.current[0]).toBeUndefined()
+ expect(result.current[0]).toEqual({ model: 'gpt-5', provider: 'openai' })
})
it('should update default model state', () => {
@@ -246,11 +246,28 @@ describe('hooks', () => {
expect(result.current[0]).toEqual({ model: 'gpt-4', provider: 'openai' })
})
- it('should handle empty model list', () => {
+ it('should preserve the default model when the model list is empty', () => {
const defaultModel = createMockDefaultModel()
const { result } = renderHook(() => useSystemDefaultModelAndModelList(defaultModel, []))
- expect(result.current[0]).toBeUndefined()
+ expect(result.current[0]).toEqual({ model: 'gpt-3.5-turbo', provider: 'openai' })
+ })
+
+ it('should preserve the selected model when a refreshed model list removes it', () => {
+ const defaultModel = createMockDefaultModel()
+ const modelList = createMockModelList()
+ const { result, rerender } = renderHook(
+ ({ modelList }) => useSystemDefaultModelAndModelList(defaultModel, modelList),
+ { initialProps: { modelList } },
+ )
+ const selectedModel = { model: 'gpt-4', provider: 'openai' }
+ act(() => {
+ result.current[1](selectedModel)
+ })
+
+ rerender({ modelList: [] })
+
+ expect(result.current[0]).toEqual(selectedModel)
})
})
diff --git a/web/app/components/header/account-setting/model-provider-page/hooks.ts b/web/app/components/header/account-setting/model-provider-page/hooks.ts
index 041dfe1cffd..6729ba706db 100644
--- a/web/app/components/header/account-setting/model-provider-page/hooks.ts
+++ b/web/app/components/header/account-setting/model-provider-page/hooks.ts
@@ -50,7 +50,12 @@ export const useSystemDefaultModelAndModelList: UseDefaultModelAndModelList = (
provider: currentProvider.provider,
}
- return currentDefaultModel
+ return (
+ currentDefaultModel ??
+ (defaultModel
+ ? { model: defaultModel.model, provider: defaultModel.provider.provider }
+ : undefined)
+ )
}, [defaultModel, modelList])
const currentDefaultModelKey = currentDefaultModel
? `${currentDefaultModel.provider}:${currentDefaultModel.model}`
diff --git a/web/app/components/header/account-setting/model-provider-page/model-selector/__tests__/index.spec.tsx b/web/app/components/header/account-setting/model-provider-page/model-selector/__tests__/index.spec.tsx
index 45084128556..067ae6b76b7 100644
--- a/web/app/components/header/account-setting/model-provider-page/model-selector/__tests__/index.spec.tsx
+++ b/web/app/components/header/account-setting/model-provider-page/model-selector/__tests__/index.spec.tsx
@@ -4,12 +4,14 @@ import type {
ProviderWithModelsResponse,
} from '@dify/contracts/api/console/workspaces/types.gen'
import type { ReactNode } from 'react'
+import type { DefaultModelResponse } from '../../declarations'
import { QueryClientProvider } from '@tanstack/react-query'
import { fireEvent, render, screen } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { consoleQuery } from '@/service/console'
import { createConsoleQueryClient } from '@/test/console/query-data'
import { ConfigurationMethodEnum, ModelStatusEnum, ModelTypeEnum } from '../../declarations'
+import { useSystemDefaultModelAndModelList } from '../../hooks'
import { ModelSelector, SplitModelSelector } from '../index'
const makeModelItem = (
@@ -122,7 +124,11 @@ const renderWithQueryClient = (node: ReactNode) => {
plugins: {},
},
)
- return render(<QueryClientProvider client={queryClient}>{node}</QueryClientProvider>)
+ return render(node, {
+ wrapper: ({ children }) => (
+ <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
+ ),
+ })
}
describe('ModelSelector', () => {
@@ -217,16 +223,38 @@ describe('ModelSelector', () => {
expect(trigger).toHaveAttribute('data-shape', 'split')
})
- it('should render deprecated trigger when value is not in list', () => {
- renderWithQueryClient(
- <ModelSelector
- value={{ provider: 'openai', model: 'missing-model' }}
- models={[makeModel()]}
- />,
- )
-
- expect(screen.getByText('missing-model')).toBeInTheDocument()
- })
+ it.each(['openai', 'uninstalled-provider'])(
+ 'should display a loaded default model as incompatible when missing from the list (%s)',
+ (provider) => {
+ const models = [makeModel()]
+ function SystemDefaultSelector({ defaultModel }: { defaultModel?: DefaultModelResponse }) {
+ const [value] = useSystemDefaultModelAndModelList(defaultModel, models)
+ return <ModelSelector value={value} models={models} />
+ }
+ const { rerender } = renderWithQueryClient(<SystemDefaultSelector />)
+
+ expect(
+ screen.getByRole('button', { name: 'plugin.detailPanel.configureModel' }),
+ ).toBeInTheDocument()
+
+ rerender(
+ <SystemDefaultSelector
+ defaultModel={{
+ model: 'missing-model',
+ model_type: ModelTypeEnum.textGeneration,
+ provider: { provider, icon_small: { en_US: '', zh_Hans: '' } },
+ }}
+ />,
+ )
+
+ expect(
+ screen.getByRole('button', {
+ name: 'missing-model common.modelProvider.selector.incompatible',
+ }),
+ ).toBeEnabled()
+ expect(screen.queryByText('plugin.detailPanel.configureModel')).not.toBeInTheDocument()
+ },
+ )
it('should render model trigger when value matches', () => {
renderWithQueryClient(