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.

test(web): exercise real input and model configuration owners (#44734)

Stephen Zhouaa99e3e85b18
diff --git a/web/app/components/base/prompt-editor/plugins/hitl-input-block/__tests__/input-field.spec.tsx b/web/app/components/base/prompt-editor/plugins/hitl-input-block/__tests__/input-field.spec.tsx
index 1d26c61b75d..8d851794991 100644
--- a/web/app/components/base/prompt-editor/plugins/hitl-input-block/__tests__/input-field.spec.tsx
+++ b/web/app/components/base/prompt-editor/plugins/hitl-input-block/__tests__/input-field.spec.tsx
@@ -1,8 +1,18 @@
import type { ParagraphFormInput } from '@/app/components/workflow/nodes/human-input/types'
-import { fireEvent, render, screen } from '@testing-library/react'
+import { fireEvent, screen, within } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
-import { InputVarType, SupportUploadFileTypes, VarType } from '@/app/components/workflow/types'
-import { TransferMethod } from '@/types/app'
+import {
+ createEdge,
+ createNode,
+ createStartNode,
+} from '@/app/components/workflow/__tests__/fixtures'
+import { renderWorkflowFlowComponent } from '@/app/components/workflow/__tests__/workflow-test-env'
+import { BlockEnum, InputVarType, VarType } from '@/app/components/workflow/types'
+import { consoleQuery } from '@/service/console'
+import { seedModelProviderQueries } from '@/test/console/model-provider'
+import { createConsoleQueryWrapper } from '@/test/console/query-data'
+import { seedToolProviders } from '@/test/console/tool-providers'
+import { createFileUploadConfigFixture } from '@/test/fixtures/file-upload-config'
import InputField from '../input-field'
vi.mock('react-i18next', async (importOriginal) => {
@@ -34,59 +44,66 @@ vi.mock('react-i18next', async (importOriginal) => {
}
})
-type VarReferencePickerProps = {
- onChange: (value: string[]) => void
- filterVar?: (payload: { type: VarType }) => boolean
+const render = (ui: React.ReactElement) => {
+ const { queryClient } = createConsoleQueryWrapper({ appDslVersion: '0.6.0' })
+ seedModelProviderQueries(queryClient, [])
+ seedToolProviders(queryClient, {
+ builtInTools: [],
+ customTools: [],
+ workflowTools: [],
+ mcpTools: [],
+ })
+ queryClient.setQueryData(
+ consoleQuery.files.upload.get.queryKey(),
+ createFileUploadConfigFixture(),
+ )
+ queryClient.setQueryData(consoleQuery.spec.schemaDefinitions.get.queryKey(), [])
+ const start = createStartNode({ id: 'start', data: { variables: [] } })
+ const code = createNode({
+ id: 'code',
+ data: {
+ title: 'Available values',
+ type: BlockEnum.Code,
+ outputs: {
+ text: { type: VarType.string, children: null },
+ old_text: { type: VarType.string, children: null },
+ choices: { type: VarType.arrayString, children: null },
+ files: { type: VarType.arrayFile, children: null },
+ },
+ },
+ })
+ const current = createNode({
+ id: 'human',
+ data: { type: BlockEnum.HumanInput, title: 'Human input' },
+ })
+ return renderWorkflowFlowComponent(ui, {
+ queryClient,
+ nodes: [start, code, current],
+ edges: [
+ createEdge({
+ source: 'start',
+ target: 'code',
+ data: { sourceType: BlockEnum.Start, targetType: BlockEnum.Code },
+ }),
+ createEdge({
+ source: 'code',
+ target: 'human',
+ data: { sourceType: BlockEnum.Code, targetType: BlockEnum.HumanInput },
+ }),
+ ],
+ })
}
-let fileUploadSettingMaxLength: number | undefined = 4
-
-// Variable discovery is tested by the picker owner; expose only allowed choices here.
-vi.mock('@/app/components/workflow/nodes/_base/components/variable/var-reference-picker', () => ({
- default: ({ onChange, filterVar }: VarReferencePickerProps) => (
- <>
- {[
- { name: 'pick-variable', type: VarType.arrayString },
- { name: 'String variable', type: VarType.string },
- { name: 'File list variable', type: VarType.arrayFile },
- ]
- .filter((variable) => !filterVar || filterVar(variable))
- .map((variable) => (
- <button key={variable.name} type="button" onClick={() => onChange(['node-a', 'var-a'])}>
- {variable.name}
- </button>
- ))}
- </>
- ),
-}))
-
-vi.mock('@/app/components/workflow/nodes/_base/components/file-upload-setting', () => ({
- __esModule: true,
- default: ({
- onChange,
- }: {
- onChange: (payload: {
- allowed_file_extensions: string[]
- allowed_file_types: SupportUploadFileTypes[]
- allowed_file_upload_methods: TransferMethod[]
- max_length?: number
- }) => void
- }) => (
- <button
- type="button"
- onClick={() =>
- onChange({
- allowed_file_extensions: ['.pdf'],
- allowed_file_types: [SupportUploadFileTypes.document],
- allowed_file_upload_methods: [TransferMethod.local_file],
- max_length: fileUploadSettingMaxLength,
- })
- }
- >
- file-upload-setting
- </button>
- ),
-}))
+async function configureFile(user: ReturnType<typeof userEvent.setup>) {
+ await user.click(
+ screen.getByRole('checkbox', { name: 'appDebug.variableConfig.file.custom.name' }),
+ )
+ await user.type(
+ screen.getByRole('textbox', { name: 'appDebug.variableConfig.file.custom.name' }),
+ '.pdf{Enter}',
+ )
+ await user.click(screen.getByRole('radio', { name: 'appDebug.variableConfig.localUpload' }))
+}
const createPayload = (overrides?: Partial<ParagraphFormInput>): ParagraphFormInput => ({
type: InputVarType.paragraph,
@@ -102,14 +119,13 @@ const createPayload = (overrides?: Partial<ParagraphFormInput>): ParagraphFormIn
describe('InputField', () => {
beforeEach(() => {
vi.clearAllMocks()
- fileUploadSettingMaxLength = 4
})
it('saves only from the field surface and ignores composition', () => {
const onChange = vi.fn()
render(
<InputField
- nodeId="node-scope"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={onChange}
@@ -130,7 +146,7 @@ describe('InputField', () => {
const onChange = vi.fn()
render(
<InputField
- nodeId="node-type-label"
+ nodeId="human"
isEdit
payload={createPayload()}
onChange={onChange}
@@ -161,7 +177,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-1"
+ nodeId="human"
isEdit
payload={createPayload()}
onChange={onChange}
@@ -188,7 +204,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-duplicate-name"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
unavailableVariableNames={['existing_name']}
@@ -221,7 +237,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-3"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={vi.fn()}
@@ -238,14 +254,7 @@ describe('InputField', () => {
const user = userEvent.setup()
const onChange = vi.fn()
- render(
- <InputField
- nodeId="node-default-payload"
- isEdit={false}
- onChange={onChange}
- onCancel={vi.fn()}
- />,
- )
+ render(<InputField nodeId="human" isEdit={false} onChange={onChange} onCancel={vi.fn()} />)
const nameInput = screen.getAllByRole('textbox')[0]
await user.type(nameInput!, 'generated_name')
@@ -273,7 +282,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-4"
+ nodeId="human"
isEdit={false}
payload={createPayload({
default: {
@@ -306,12 +315,12 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-5-1"
+ nodeId="human"
isEdit={false}
payload={createPayload({
default: {
type: 'variable',
- selector: ['node-y', 'var-y'],
+ selector: ['code', 'text'],
value: '',
},
})}
@@ -334,7 +343,7 @@ describe('InputField', () => {
expect(onChange).toHaveBeenCalledTimes(1)
expect(onChange.mock.calls[0]![0].default).toEqual({
type: 'constant',
- selector: ['node-y', 'var-y'],
+ selector: ['code', 'text'],
value: '',
})
})
@@ -345,12 +354,12 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-5"
+ nodeId="human"
isEdit={false}
payload={createPayload({
default: {
type: 'variable',
- selector: ['node-x', 'old'],
+ selector: ['code', 'old_text'],
value: '',
},
})}
@@ -359,7 +368,8 @@ describe('InputField', () => {
/>,
)
- await user.click(screen.getByText('String variable'))
+ await user.click(screen.getByRole('button', { name: /Available values.*old_text/ }))
+ await user.click(within(await screen.findByRole('dialog')).getByText('text', { exact: true }))
await user.click(
screen.getByRole('button', {
name: /workflowHumanInput\.nodes\.humanInput\.insertInputField\.insert/i,
@@ -369,7 +379,7 @@ describe('InputField', () => {
expect(onChange).toHaveBeenCalledTimes(1)
expect(onChange.mock.calls[0]![0].default).toEqual({
type: 'variable',
- selector: ['node-a', 'var-a'],
+ selector: ['code', 'text'],
value: '',
})
})
@@ -380,7 +390,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-7"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={onChange}
@@ -425,7 +435,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-8"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={onChange}
@@ -480,7 +490,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-9"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={onChange}
@@ -530,7 +540,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-10"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={onChange}
@@ -559,7 +569,8 @@ describe('InputField', () => {
await user.click(
screen.getByText(/workflowHumanInput\.nodes\.humanInput\.insertInputField\.useVarInstead/i),
)
- await user.click(screen.getByText('pick-variable'))
+ await user.click(screen.getByRole('button', { name: /common.setVarValuePlaceholder/ }))
+ await user.click(await screen.findByText('choices'))
await user.click(
screen.getByText(
/workflowHumanInput\.nodes\.humanInput\.insertInputField\.useConstantInstead/i,
@@ -577,7 +588,7 @@ describe('InputField', () => {
output_variable_name: 'valid_name',
option_source: {
type: 'constant',
- selector: ['node-a', 'var-a'],
+ selector: ['code', 'choices'],
value: ['alpha', 'beta'],
},
})
@@ -588,7 +599,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-11"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={vi.fn()}
@@ -608,9 +619,10 @@ describe('InputField', () => {
screen.getByText(/workflowHumanInput\.nodes\.humanInput\.insertInputField\.useVarInstead/i),
)
- expect(screen.getByRole('button', { name: 'pick-variable' })).toBeInTheDocument()
- expect(screen.queryByRole('button', { name: 'String variable' })).not.toBeInTheDocument()
- expect(screen.queryByRole('button', { name: 'File list variable' })).not.toBeInTheDocument()
+ await user.click(screen.getByRole('button', { name: /common.setVarValuePlaceholder/ }))
+ expect(await screen.findByText('choices')).toBeInTheDocument()
+ expect(screen.queryByText('text', { exact: true })).not.toBeInTheDocument()
+ expect(screen.queryByText('files', { exact: true })).not.toBeInTheDocument()
})
it('should save single file upload settings', async () => {
@@ -619,7 +631,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-13"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={onChange}
@@ -635,7 +647,7 @@ describe('InputField', () => {
await user.click(
await screen.findByRole('option', { name: /appDebug\.variableConfig\.single-file\b/ }),
)
- await user.click(screen.getByRole('button', { name: 'file-upload-setting' }))
+ await configureFile(user)
await user.click(
screen.getByRole('button', {
name: /workflowHumanInput\.nodes\.humanInput\.insertInputField\.insert/i,
@@ -647,7 +659,7 @@ describe('InputField', () => {
type: InputVarType.singleFile,
output_variable_name: 'valid_name',
allowed_file_extensions: ['.pdf'],
- allowed_file_types: ['document'],
+ allowed_file_types: ['custom'],
allowed_file_upload_methods: ['local_file'],
})
})
@@ -658,7 +670,7 @@ describe('InputField', () => {
render(
<InputField
- nodeId="node-14"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={onChange}
@@ -674,7 +686,14 @@ describe('InputField', () => {
await user.click(
await screen.findByRole('option', { name: /appDebug\.variableConfig\.multi-files\b/ }),
)
- await user.click(screen.getByRole('button', { name: 'file-upload-setting' }))
+ await configureFile(user)
+ const limit = screen.getByRole('spinbutton', {
+ name: 'appDebug.variableConfig.maxNumberOfUploads',
+ })
+ await user.click(limit)
+ await user.tab()
+ expect(screen.getByRole('slider')).toHaveFocus()
+ await user.keyboard('{ArrowLeft}')
await user.click(
screen.getByRole('button', {
name: /workflowHumanInput\.nodes\.humanInput\.insertInputField\.insert/i,
@@ -686,7 +705,7 @@ describe('InputField', () => {
type: InputVarType.multiFiles,
output_variable_name: 'valid_name',
allowed_file_extensions: ['.pdf'],
- allowed_file_types: ['document'],
+ allowed_file_types: ['custom'],
allowed_file_upload_methods: ['local_file'],
number_limits: 4,
})
@@ -695,11 +714,10 @@ describe('InputField', () => {
it('should normalize empty file-list upload limit on save', async () => {
const user = userEvent.setup()
const onChange = vi.fn()
- fileUploadSettingMaxLength = Number.NaN
render(
<InputField
- nodeId="node-14-normalize"
+ nodeId="human"
isEdit={false}
payload={createPayload()}
onChange={onChange}
@@ -715,7 +733,11 @@ describe('InputField', () => {
await user.click(
await screen.findByRole('option', { name: /appDebug\.variableConfig\.multi-files\b/ }),
)
- await user.click(screen.getByRole('button', { name: 'file-upload-setting' }))
+ await user.clear(
+ screen.getByRole('spinbutton', {
+ name: 'appDebug.variableConfig.maxNumberOfUploads',
+ }),
+ )
await user.click(
screen.getByRole('button', {
name: /workflowHumanInput\.nodes\.humanInput\.insertInputField\.insert/i,
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 1a4a8024ee6..a886ebc64d5 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
@@ -1,16 +1,12 @@
import type { ProviderWithModelsResponse } from '@dify/contracts/api/console/workspaces/types.gen'
import type { RenderHookOptions } from '@testing-library/react'
import type { Mock } from 'vite-plus/test'
-import type {
- Credential,
- CustomConfigurationModelFixedFields,
- CustomModel,
- DefaultModelResponse,
- ModelProvider,
-} from '../declarations'
+import type { DefaultModelResponse, ModelProvider } from '../declarations'
import { zModelWithProviderEntityResponse } from '@dify/contracts/api/console/workspaces/zod.gen'
import { QueryObserver } from '@tanstack/react-query'
-import { act, waitFor } from '@testing-library/react'
+import { act, screen, waitFor } from '@testing-library/react'
+import userEvent from '@testing-library/user-event'
+import { createElement } from 'react'
import { useLocale } from '#i18n'
import { consoleQuery } from '@/service/console'
import { createConsoleQueryClient, renderHookWithConsoleQuery } from '@/test/console/query-data'
@@ -38,6 +34,7 @@ import {
useUpdateModelList,
useUpdateModelProviders,
} from '../hooks'
+import { createCredentialProvider, renderCredentialComponent } from './credential-test-env'
vi.mock('#i18n', async (importOriginal) => ({
...(await importOriginal<typeof import('#i18n')>()),
@@ -46,13 +43,6 @@ vi.mock('#i18n', async (importOriginal) => ({
// Mock dependencies
-vi.mock('@/context/modal-context', () => ({
- useModalContextSelector: vi.fn((selector) => {
- const state = { setShowModelModal: vi.fn() }
- return selector(state)
- }),
-}))
-
vi.mock('@/app/components/plugins/marketplace/hooks', () => ({
useMarketplacePlugins: vi.fn(() => ({
plugins: [],
@@ -66,16 +56,29 @@ vi.mock('@/app/components/plugins/marketplace/hooks', () => ({
})),
}))
-const { getDefaultModel, getModels } = vi.hoisted(() => ({
+const { getDefaultModel, getModels, saveProvider, saveModel, editModel } = vi.hoisted(() => ({
getDefaultModel: vi.fn(),
getModels: vi.fn(),
+ saveProvider: vi.fn(),
+ saveModel: vi.fn(),
+ editModel: vi.fn(),
}))
vi.mock('@/service/console', async (importOriginal) => {
const actual = await importOriginal<typeof import('@/service/console')>()
- const { withConsoleResponses } = await import('@/test/console/service-responses')
+ const { withConsoleResponses, withConsoleClientResponses } =
+ await import('@/test/console/service-responses')
return {
...actual,
+ consoleClient: withConsoleClientResponses(actual.consoleClient, {
+ 'workspaces.current.modelProviders.byProvider.credentials.post': saveProvider,
+ 'workspaces.current.modelProviders.byProvider.models.credentials.post': saveModel,
+ 'workspaces.current.modelProviders.byProvider.models.credentials.put': editModel,
+ }),
consoleQuery: withConsoleResponses(actual.consoleQuery, {
+ 'workspaces.current.modelProviders.byProvider.models.credentials.get': () => ({
+ credentials: { api_key: '[__HIDDEN__]' },
+ available_credentials: [],
+ }),
'workspaces.current.defaultModel.get': getDefaultModel,
'workspaces.current.models.modelTypes.byModelType.get': getModels,
}),
@@ -109,13 +112,15 @@ const seedDefaultModel = (data: DefaultModelResponse) =>
}),
{ data },
)
-const { useModalContextSelector } = await import('@/context/modal-context')
const { useMarketplacePlugins, useMarketplacePluginsByCollectionId } =
await import('@/app/components/plugins/marketplace/hooks')
describe('hooks', () => {
beforeEach(() => {
vi.clearAllMocks()
+ saveProvider.mockResolvedValue({ result: 'success' })
+ saveModel.mockResolvedValue({ result: 'success' })
+ editModel.mockResolvedValue({ result: 'success' })
vi.mocked(useLocale).mockReturnValue('en-US')
;(useMarketplacePlugins as Mock).mockReturnValue({
plugins: [],
@@ -793,134 +798,124 @@ describe('hooks', () => {
})
describe('useModelModalHandler', () => {
- const createMockProvider = (): ModelProvider => ({
- provider: 'openai',
- label: { en_US: 'OpenAI', zh_Hans: 'OpenAI' },
- icon_small: { en_US: 'icon', zh_Hans: 'icon' },
- supported_model_types: [ModelTypeEnum.textGeneration],
- configurate_methods: [ConfigurationMethodEnum.predefinedModel],
- provider_credential_schema: { credential_form_schemas: [] },
- model_credential_schema: {
- model: {
- label: { en_US: 'Model', zh_Hans: '模型' },
- placeholder: { en_US: 'Select model', zh_Hans: '选择模型' },
- },
- credential_form_schemas: [],
- },
- preferred_provider_type: PreferredProviderTypeEnum.system,
- custom_configuration: {
- status: CustomConfigurationStatusEnum.noConfigure,
- },
- system_configuration: {
- enabled: true,
- current_quota_type: CurrentSystemQuotaTypeEnum.trial,
- quota_configurations: [],
- },
- help: {
- title: {
- en_US: '',
- zh_Hans: '',
- },
- url: {
- en_US: '',
- zh_Hans: '',
- },
- },
- })
-
- it('should open model modal with basic configuration', () => {
- const setShowModelModal = vi.fn()
- ;(useModalContextSelector as Mock).mockReturnValue(setShowModelModal)
-
- const provider = createMockProvider()
- const { result } = renderHook(() => useModelModalHandler())
-
- act(() => {
- result.current(provider, ConfigurationMethodEnum.predefinedModel)
- })
-
- expect(setShowModelModal).toHaveBeenCalledWith({
- payload: {
- currentProvider: provider,
- currentConfigurationMethod: ConfigurationMethodEnum.predefinedModel,
- currentCustomConfigurationModelFixedFields: undefined,
- isModelCredential: undefined,
- credential: undefined,
- model: undefined,
- mode: undefined,
- },
- onSaveCallback: expect.any(Function),
- })
- })
-
- it('should open model modal with custom configuration', () => {
- const setShowModelModal = vi.fn()
- ;(useModalContextSelector as Mock).mockReturnValue(setShowModelModal)
-
- const provider = createMockProvider()
- const customFields: CustomConfigurationModelFixedFields = {
- __model_name: 'gpt-4',
- __model_type: ModelTypeEnum.textGeneration,
- }
-
- const { result } = renderHook(() => useModelModalHandler())
+ beforeAll(async () => {
+ // Load the real lazy dialog before measuring its user interactions.
+ await import('../model-modal')
+ })
+
+ function ModalLauncher({
+ args,
+ }: {
+ args: Parameters<ReturnType<typeof useModelModalHandler>>
+ }) {
+ const open = useModelModalHandler()
+ return createElement('button', { onClick: () => open(...args) }, 'Configure model')
+ }
+ async function fillAndSave(user: ReturnType<typeof userEvent.setup>) {
+ const key = await screen.findByLabelText(/API key/)
+ await user.clear(key)
+ await user.type(key, 'new-key')
+ const name = screen.getByRole('textbox', { name: /authorizationName/ })
+ await user.clear(name)
+ await user.type(name, 'My key')
+ await user.click(screen.getByRole('button', { name: 'common.operation.save' }))
+ await waitFor(() => expect(screen.queryByRole('dialog')).not.toBeInTheDocument())
+ }
- act(() => {
- result.current(provider, ConfigurationMethodEnum.customizableModel, customFields)
+ it('opens the provider form and saves its entered credential', async () => {
+ const user = userEvent.setup()
+ renderCredentialComponent(
+ createElement(ModalLauncher, {
+ args: [createCredentialProvider(), ConfigurationMethodEnum.predefinedModel],
+ }),
+ )
+ await user.click(screen.getByRole('button', { name: 'Configure model' }))
+ await fillAndSave(user)
+ expect(saveProvider).toHaveBeenCalledExactlyOnceWith({
+ params: { provider: 'openai' },
+ body: { credential_id: undefined, credentials: { api_key: 'new-key' }, name: 'My key' },
})
-
- expect(setShowModelModal).toHaveBeenCalledWith({
- payload: {
- currentProvider: provider,
- currentConfigurationMethod: ConfigurationMethodEnum.customizableModel,
- currentCustomConfigurationModelFixedFields: customFields,
- isModelCredential: undefined,
- credential: undefined,
- model: undefined,
- mode: undefined,
+ expect(saveModel).not.toHaveBeenCalled()
+ })
+
+ it('opens a custom model form with the fixed name and type', async () => {
+ const user = userEvent.setup()
+ renderCredentialComponent(
+ createElement(ModalLauncher, {
+ args: [
+ createCredentialProvider({
+ configurate_methods: [ConfigurationMethodEnum.customizableModel],
+ provider_credential_schema: { credential_form_schemas: [] },
+ }),
+ ConfigurationMethodEnum.customizableModel,
+ { __model_name: 'gpt-4', __model_type: ModelTypeEnum.textGeneration },
+ { isModelCredential: true, mode: ModelModalModeEnum.configModelCredential },
+ ],
+ }),
+ )
+ await user.click(screen.getByRole('button', { name: 'Configure model' }))
+ await fillAndSave(user)
+ expect(saveModel).toHaveBeenCalledExactlyOnceWith({
+ params: { provider: 'openai' },
+ body: {
+ credential_id: undefined,
+ credentials: { api_key: 'new-key' },
+ name: 'My key',
+ model: 'gpt-4',
+ model_type: 'llm',
},
- onSaveCallback: expect.any(Function),
})
})
- it('should open model modal with extra options', () => {
- const setShowModelModal = vi.fn()
- ;(useModalContextSelector as Mock).mockReturnValue(setShowModelModal)
-
- const provider = createMockProvider()
- const credential: Credential = { credential_id: 'cred-1' }
- const model: CustomModel = { model: 'gpt-4', model_type: ModelTypeEnum.textGeneration }
+ it('preserves the model credential identity and delivers actual saved form values to its caller', async () => {
+ const user = userEvent.setup()
+ const provider = createCredentialProvider()
+ const credential = { credential_id: 'cred-1', credential_name: 'Existing key' }
+ const model = { model: 'gpt-4', model_type: ModelTypeEnum.textGeneration }
const onUpdate = vi.fn()
-
- const { result } = renderHook(() => useModelModalHandler())
-
- act(() => {
- result.current(provider, ConfigurationMethodEnum.predefinedModel, undefined, {
- isModelCredential: true,
- credential,
- model,
- onUpdate,
- mode: ModelModalModeEnum.configProviderCredential,
- })
+ renderCredentialComponent(
+ createElement(ModalLauncher, {
+ args: [
+ provider,
+ ConfigurationMethodEnum.predefinedModel,
+ undefined,
+ {
+ isModelCredential: true,
+ credential,
+ model,
+ onUpdate,
+ mode: ModelModalModeEnum.configModelCredential,
+ },
+ ],
+ }),
+ )
+ await user.click(screen.getByRole('button', { name: 'Configure model' }))
+ expect(await screen.findByRole('textbox', { name: /authorizationName/ })).toHaveValue(
+ 'Existing key',
+ )
+ await fillAndSave(user)
+ expect(editModel).toHaveBeenCalledExactlyOnceWith({
+ params: { provider: 'openai' },
+ body: {
+ credential_id: 'cred-1',
+ credentials: { api_key: 'new-key', __model_name: 'gpt-4', __model_type: 'llm' },
+ name: 'My key',
+ ...model,
+ },
})
-
- expect(setShowModelModal).toHaveBeenCalledWith({
- payload: {
+ expect(onUpdate).toHaveBeenCalledExactlyOnceWith(
+ expect.objectContaining({
currentProvider: provider,
currentConfigurationMethod: ConfigurationMethodEnum.predefinedModel,
- currentCustomConfigurationModelFixedFields: undefined,
isModelCredential: true,
credential,
model,
- mode: ModelModalModeEnum.configProviderCredential,
- },
- onSaveCallback: expect.any(Function),
- })
- const savedPayload = setShowModelModal.mock.calls[0]![0].payload
- act(() =>
- setShowModelModal.mock.calls[0]![0].onSaveCallback(savedPayload, { api_key: 'new-key' }),
+ mode: ModelModalModeEnum.configModelCredential,
+ }),
+ expect.objectContaining({ api_key: 'new-key', __authorization_name__: 'My key' }),
)
- expect(onUpdate).toHaveBeenCalledExactlyOnceWith(savedPayload, { api_key: 'new-key' })
+ expect(saveProvider).not.toHaveBeenCalled()
+ expect(saveModel).not.toHaveBeenCalled()
})
})
})
diff --git a/web/app/components/header/account-setting/model-provider-page/provider-added-card/__tests__/credential-panel.spec.tsx b/web/app/components/header/account-setting/model-provider-page/provider-added-card/__tests__/credential-panel.spec.tsx
index 368a01d6749..49290892edc 100644
--- a/web/app/components/header/account-setting/model-provider-page/provider-added-card/__tests__/credential-panel.spec.tsx
+++ b/web/app/components/header/account-setting/model-provider-page/provider-added-card/__tests__/credential-panel.spec.tsx
@@ -1,7 +1,15 @@
import type { ModelProvider } from '../../declarations'
+import { zProviderWithModelsResponse } from '@dify/contracts/api/console/workspaces/zod.gen'
+import { useQuery } from '@tanstack/react-query'
import { act, screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
-import { renderWithConsoleQuery } from '@/test/console/query-data'
+import { consoleQuery } from '@/service/console'
+import {
+ createCatalogModelFixture,
+ createModelCatalogFixture,
+ createProviderSummaryFixture,
+} from '@/test/console/model-provider'
+import { createConsoleQueryClient, renderWithConsoleQuery } from '@/test/console/query-data'
import { createDeferred } from '@/test/deferred'
import {
ConfigurationMethodEnum,
@@ -11,25 +19,20 @@ import {
} from '../../declarations'
import CredentialPanel from '../credential-panel'
-const {
- mockToastNotify,
- mockUpdateModelList,
- mockUpdateModelProviders,
- mockTrialCredits,
- mockChangePriorityFn,
-} = vi.hoisted(() => ({
- mockToastNotify: vi.fn(),
- mockUpdateModelList: vi.fn(),
- mockUpdateModelProviders: vi.fn(),
- mockTrialCredits: {
- credits: 100,
- totalCredits: 10_000,
- isExhausted: false,
- isLoading: false,
- nextCreditResetDate: undefined,
- },
- mockChangePriorityFn: vi.fn().mockResolvedValue({ result: 'success' }),
-}))
+const { mockToastNotify, mockTrialCredits, getProviders, getModels, mockChangePriorityFn } =
+ vi.hoisted(() => ({
+ mockToastNotify: vi.fn(),
+ getProviders: vi.fn(),
+ getModels: vi.fn(),
+ mockTrialCredits: {
+ credits: 100,
+ totalCredits: 10_000,
+ isExhausted: false,
+ isLoading: false,
+ nextCreditResetDate: undefined,
+ },
+ mockChangePriorityFn: vi.fn().mockResolvedValue({ result: 'success' }),
+ }))
vi.mock('@/app/notifications', () => ({
default: { notify: mockToastNotify },
@@ -47,18 +50,14 @@ vi.mock('@/service/console', async (importOriginal) => {
return {
...actual,
consoleQuery: withConsoleResponses(actual.consoleQuery, {
+ 'workspaces.current.modelProviders.summary.get': getProviders,
+ 'workspaces.current.models.modelTypes.byModelType.get': getModels,
'workspaces.current.modelProviders.byProvider.preferredProviderType.post': (input) =>
mockChangePriorityFn(input),
}),
}
})
-vi.mock('../../hooks', async (importOriginal) => ({
- ...(await importOriginal<typeof import('../../hooks')>()),
- useUpdateModelList: () => mockUpdateModelList,
- useUpdateModelProviders: () => mockUpdateModelProviders,
-}))
-
vi.mock('../use-trial-credits', () => ({
useTrialCredits: () => mockTrialCredits,
}))
@@ -93,17 +92,73 @@ const createProvider = (overrides: Partial<ModelProvider> = {}): ModelProvider =
...overrides,
}) as unknown as ModelProvider
-const renderWithQueryClient = (provider: ModelProvider) => {
- return renderWithConsoleQuery(<CredentialPanel provider={provider} />, {
- systemFeatures: { deployment_edition: 'CLOUD' },
- trialModels: ['langgenius/openai/openai'],
- workspacePermissionKeys: ['credential.use'],
+const providerName = 'langgenius/openai/openai'
+const providerCatalog = (priority: 'system' | 'custom') => ({
+ data: [
+ createProviderSummaryFixture({ provider: providerName, preferred_provider_type: priority }),
+ ],
+ plugins: {},
+})
+const modelCatalog = (name: string) => ({
+ data: [
+ createModelCatalogFixture({
+ provider: providerName,
+ models: [createCatalogModelFixture({ model: name, label: { en_US: name } })],
+ }),
+ ],
+})
+const modelQueryOptions = () =>
+ consoleQuery.workspaces.current.models.modelTypes.byModelType.get.queryOptions({
+ input: { params: { model_type: 'llm' } },
})
+function CatalogConsumer() {
+ const { data: providers } = useQuery(
+ consoleQuery.workspaces.current.modelProviders.summary.get.queryOptions(),
+ )
+ const { data: models } = useQuery(modelQueryOptions())
+ return (
+ <>
+ <output aria-label="Provider priority">
+ {providers?.data.find((item) => item.provider === providerName)?.preferred_provider_type}
+ </output>
+ <output aria-label="Available models">
+ {models?.data
+ .flatMap((provider) => provider.models.map((model) => model.label.en_US))
+ .join(', ')}
+ </output>
+ </>
+ )
+}
+const renderWithQueryClient = (provider: ModelProvider, observeCatalog = false) => {
+ const queryClient = createConsoleQueryClient()
+ if (observeCatalog) {
+ queryClient.setQueryData(
+ consoleQuery.workspaces.current.modelProviders.summary.get.queryKey(),
+ providerCatalog('system'),
+ )
+ queryClient.setQueryData(modelQueryOptions().queryKey, {
+ data: modelCatalog('Trial model').data.map((item) => zProviderWithModelsResponse.parse(item)),
+ })
+ }
+ return renderWithConsoleQuery(
+ <>
+ <CredentialPanel provider={provider} />
+ {observeCatalog && <CatalogConsumer />}
+ </>,
+ {
+ queryClient,
+ systemFeatures: { deployment_edition: 'CLOUD' },
+ trialModels: [providerName],
+ workspacePermissionKeys: ['credential.use'],
+ },
+ )
}
describe('CredentialPanel', () => {
beforeEach(() => {
vi.clearAllMocks()
+ getProviders.mockResolvedValue(providerCatalog('custom'))
+ getModels.mockResolvedValue(modelCatalog('API key model'))
mockChangePriorityFn.mockReset().mockResolvedValue({ result: 'success' })
Object.assign(mockTrialCredits, {
credits: 100,
@@ -248,7 +303,7 @@ describe('CredentialPanel', () => {
const user = userEvent.setup()
const request = createDeferred<{ result: string }>()
mockChangePriorityFn.mockReturnValueOnce(request.promise)
- renderWithQueryClient(createProvider())
+ renderWithQueryClient(createProvider(), true)
await user.click(screen.getByRole('button', { name: 'common.operation.config' }))
const apiKey = screen.getByRole('button', { name: /apiKeyOption/ })
await user.click(apiKey)
@@ -257,17 +312,26 @@ describe('CredentialPanel', () => {
body: { preferred_provider_type: 'custom' },
})
expect(apiKey).toBeDisabled()
- expect(mockUpdateModelProviders).not.toHaveBeenCalled()
+ expect(screen.getByRole('status', { name: 'Provider priority' })).toHaveTextContent('system')
+ expect(screen.getByRole('status', { name: 'Available models' })).toHaveTextContent(
+ 'Trial model',
+ )
await act(async () => request.resolve({ result: 'success' }))
await waitFor(() => expect(apiKey).toBeEnabled())
- expect(mockUpdateModelProviders).toHaveBeenCalledTimes(1)
- expect(mockUpdateModelList).toHaveBeenCalledExactlyOnceWith('llm')
+ await waitFor(() =>
+ expect(screen.getByRole('status', { name: 'Provider priority' })).toHaveTextContent('custom'),
+ )
+ await waitFor(() =>
+ expect(screen.getByRole('status', { name: 'Available models' })).toHaveTextContent(
+ 'API key model',
+ ),
+ )
})
it('reports a failed priority change without refreshing and allows retry', async () => {
const user = userEvent.setup()
mockChangePriorityFn.mockRejectedValueOnce(new Error('Unavailable'))
- renderWithQueryClient(createProvider())
+ renderWithQueryClient(createProvider(), true)
await user.click(screen.getByRole('button', { name: 'common.operation.config' }))
const apiKey = screen.getByRole('button', { name: /apiKeyOption/ })
await user.click(apiKey)
@@ -278,10 +342,19 @@ describe('CredentialPanel', () => {
}),
)
expect(apiKey).toBeEnabled()
- expect(mockUpdateModelProviders).not.toHaveBeenCalled()
- expect(mockUpdateModelList).not.toHaveBeenCalled()
+ expect(screen.getByRole('status', { name: 'Provider priority' })).toHaveTextContent('system')
+ expect(screen.getByRole('status', { name: 'Available models' })).toHaveTextContent(
+ 'Trial model',
+ )
await user.click(apiKey)
- await waitFor(() => expect(mockUpdateModelProviders).toHaveBeenCalledTimes(1))
+ await waitFor(() =>
+ expect(screen.getByRole('status', { name: 'Provider priority' })).toHaveTextContent('custom'),
+ )
+ await waitFor(() =>
+ expect(screen.getByRole('status', { name: 'Available models' })).toHaveTextContent(
+ 'API key model',
+ ),
+ )
expect(mockChangePriorityFn).toHaveBeenCalledTimes(2)
})
})
diff --git a/web/app/components/share/text-generation/run-once/__tests__/index.spec.tsx b/web/app/components/share/text-generation/run-once/__tests__/index.spec.tsx
index 3592dae091f..ba4c64a3cff 100644
--- a/web/app/components/share/text-generation/run-once/__tests__/index.spec.tsx
+++ b/web/app/components/share/text-generation/run-once/__tests__/index.spec.tsx
@@ -1,11 +1,13 @@
import type { InputValueTypes } from '../../types'
+import type { fileUpload } from '@/app/components/base/file-uploader/utils'
import type { PromptConfig, PromptVariable } from '@/models/debug'
import type { SiteInfo } from '@/models/share'
import type { VisionSettings } from '@/types/app'
-import { render, screen, waitFor } from '@testing-library/react'
+import { screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import * as React from 'react'
import { useRef, useState } from 'react'
+import { renderWithConsoleQuery as render } from '@/test/console/query-data'
import { Resolution, TransferMethod } from '@/types/app'
import RunOnce from '../index'
@@ -22,51 +24,55 @@ vi.mock('@/hooks/use-breakpoints', () => {
}
})
-vi.mock('@/app/components/workflow/nodes/_base/components/editor/code-editor', () => ({
- default: ({ value, onChange }: { value?: string; onChange?: (val: string) => void }) => (
- <textarea
- data-testid="code-editor-mock"
- value={value}
- onChange={(e) => onChange?.(e.target.value)}
- />
- ),
+const upload = vi.hoisted(() => vi.fn<typeof fileUpload>())
+vi.mock('@/next/navigation', () => ({
+ useParams: () => ({}),
+ usePathname: () => '/completion/app',
}))
-
-vi.mock('@/app/components/base/image-uploader/text-generation-image-uploader', () => ({
- default: () => <div data-testid="vision-uploader-mock" />,
+vi.mock('@/app/components/base/file-uploader/utils', async (importOriginal) => ({
+ ...(await importOriginal<typeof import('@/app/components/base/file-uploader/utils')>()),
+ fileUpload: upload,
}))
-const uploadedFile = {
- id: 'test-file',
+beforeEach(() => {
+ upload.mockImplementation(({ onSuccessCallback }) =>
+ onSuccessCallback({
+ id: 'upload-1',
+ name: 'example.txt',
+ size: 7,
+ mime_type: 'text/plain',
+ extension: 'txt',
+ created_at: 1,
+ created_by: 'account-1',
+ preview_url: null,
+ source_url: '',
+ }),
+ )
+})
+
+const uploadedFile = expect.objectContaining({
name: 'example.txt',
- size: 128,
+ size: 7,
type: 'text/plain',
progress: 100,
transferMethod: TransferMethod.local_file,
supportFileType: 'document',
uploadedId: 'upload-1',
-}
-
-vi.mock('@/app/components/base/file-uploader', () => ({
- FileUploaderInAttachmentWrapper: ({
- value,
- onChange,
- }: {
- value: object[]
- onChange: (files: object[]) => void
- }) => (
- <div data-testid="file-uploader-mock">
- <button onClick={() => onChange([uploadedFile])}>Upload</button>
- <span>{value?.length || 0} files</span>
- </div>
- ),
-}))
+})
+const getInputs = () =>
+ JSON.parse(screen.getByRole('status', { name: 'Input values' }).textContent!)
const createPromptVariable = (overrides: Partial<PromptVariable>): PromptVariable => ({
key: 'input',
name: 'Input',
type: 'string',
required: true,
+ config: {
+ allowed_file_types: ['document'],
+ allowed_file_extensions: ['.txt'],
+ allowed_file_upload_methods: [TransferMethod.local_file],
+ number_limits: 2,
+ },
...overrides,
})
@@ -126,21 +132,24 @@ const setup = (
const [inputs, setInputs] = useState<Record<string, InputValueTypes>>({})
const inputsRef = useRef<Record<string, InputValueTypes>>({})
return (
- <RunOnce
- siteInfo={siteInfo}
- promptConfig={overrides.promptConfig || basePromptConfig}
- inputs={inputs}
- inputsRef={inputsRef}
- onInputsChange={(updated) => {
- inputsRef.current = updated
- setInputs(updated)
- onInputsChange(updated)
- }}
- onSend={onSend}
- visionConfig={overrides.visionConfig || baseVisionConfig}
- onVisionFilesChange={onVisionFilesChange}
- runControl={overrides.runControl ?? null}
- />
+ <>
+ <output aria-label="Input values">{JSON.stringify(inputs)}</output>
+ <RunOnce
+ siteInfo={siteInfo}
+ promptConfig={overrides.promptConfig || basePromptConfig}
+ inputs={inputs}
+ inputsRef={inputsRef}
+ onInputsChange={(updated) => {
+ inputsRef.current = updated
+ setInputs(updated)
+ onInputsChange(updated)
+ }}
+ onSend={() => onSend(inputsRef.current)}
+ visionConfig={overrides.visionConfig || baseVisionConfig}
+ onVisionFilesChange={onVisionFilesChange}
+ runControl={overrides.runControl ?? null}
+ />
+ </>
)
}
@@ -192,8 +201,7 @@ describe('RunOnce', () => {
await user.click(screen.getByRole('checkbox', { name: 'Checkbox Input' }))
- const latest = onInputsChange.mock.calls[onInputsChange.mock.calls.length - 1]![0]
- expect(latest).toEqual({
+ expect(getInputs()).toEqual({
textInput: 'new text',
paragraphInput: 'paragraph value',
numberInput: '99',
@@ -211,7 +219,7 @@ describe('RunOnce', () => {
await user.click(screen.getByRole('button', { name: 'common.operation.clear' }))
- expect(onInputsChange).toHaveBeenCalledWith({
+ expect(getInputs()).toEqual({
textInput: '',
paragraphInput: '',
numberInput: '',
@@ -226,7 +234,12 @@ describe('RunOnce', () => {
expect(onInputsChange).toHaveBeenCalled()
})
await user.click(screen.getByRole('button', { name: 'share.generation.run' }))
- expect(onSend).toHaveBeenCalledTimes(1)
+ expect(onSend).toHaveBeenCalledExactlyOnceWith({
+ textInput: 'default text',
+ paragraphInput: 'paragraph default',
+ numberInput: 42,
+ checkboxInput: false,
+ })
})
it('should display stop controls when runControl is provided', async () => {
@@ -288,7 +301,8 @@ describe('RunOnce', () => {
})
await user.click(screen.getByRole('combobox', { name: 'Select Input' }))
await user.click(screen.getByRole('option', { name: 'Option B' }))
- expect(onInputsChange).toHaveBeenLastCalledWith({ selectInput: 'Option B' })
+ expect(getInputs()).toEqual({ selectInput: 'Option B' })
+ expect(screen.getByRole('combobox', { name: 'Select Input' })).toHaveTextContent('Option B')
})
})
@@ -314,8 +328,12 @@ describe('RunOnce', () => {
fileInput: undefined,
})
})
- await user.click(screen.getByRole('button', { name: 'Upload' }))
- expect(onInputsChange).toHaveBeenLastCalledWith({ fileInput: uploadedFile })
+ await user.upload(
+ document.querySelector<HTMLInputElement>('input[type="file"]')!,
+ new File(['example'], 'example.txt', { type: 'text/plain' }),
+ )
+ expect(await screen.findByText('example.txt')).toBeInTheDocument()
+ await waitFor(() => expect(getInputs()).toEqual({ fileInput: uploadedFile }))
})
it('should render file uploader for file-list input', async () => {
@@ -339,8 +357,12 @@ describe('RunOnce', () => {
fileListInput: [],
})
})
- await user.click(screen.getByRole('button', { name: 'Upload' }))
- expect(onInputsChange).toHaveBeenLastCalledWith({ fileListInput: [uploadedFile] })
+ await user.upload(
+ document.querySelector<HTMLInputElement>('input[type="file"]')!,
+ new File(['example'], 'example.txt', { type: 'text/plain' }),
+ )
+ expect(await screen.findByText('example.txt')).toBeInTheDocument()
+ await waitFor(() => expect(getInputs()).toEqual({ fileListInput: [uploadedFile] }))
})
})
@@ -366,12 +388,12 @@ describe('RunOnce', () => {
})
onInputsChange.mockClear()
- const codeEditor = screen.getByTestId('code-editor-mock')
+ const codeEditor = screen.getByTestId('monaco-editor')
await user.click(codeEditor)
await user.paste('{"key": "value"}')
await waitFor(() => {
- expect(onInputsChange).toHaveBeenCalledWith({
+ expect(getInputs()).toEqual({
jsonInput: '{"key": "value"}',
})
})