From 90df30cce93e10557646b76124752a3b967f53ef Mon Sep 17 00:00:00 2001 From: Stephen Zhou Date: Sun, 20 Sep 2026 08:18:18 +0000 Subject: [PATCH 01/37] ci: run API integration tests without sharding (#42573) --- .github/workflows/api-tests.yml | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/.github/workflows/api-tests.yml b/.github/workflows/api-tests.yml index 4cb4a806ede..a1f29fd6529 100644 --- a/.github/workflows/api-tests.yml +++ b/.github/workflows/api-tests.yml @@ -86,10 +86,10 @@ jobs: retention-days: 1 api-integration: - name: API Integration Tests (${{ matrix.python-version }}, shard ${{ matrix.shardIndex }}/${{ matrix.shardTotal }}) + name: API Integration Tests (${{ matrix.python-version }}) runs-on: depot-ubuntu-24.04-4 env: - COVERAGE_FILE: coverage-integration-${{ matrix.python-version }}-${{ matrix.shardIndex }} + COVERAGE_FILE: coverage-integration-${{ matrix.python-version }} STORAGE_TYPE: opendal OPENDAL_SCHEME: fs OPENDAL_FS_ROOT: /tmp/dify-storage @@ -101,13 +101,6 @@ jobs: matrix: python-version: - '3.12' - shardIndex: - - 1 - - 2 - - 3 - - 4 - shardTotal: - - 4 steps: - name: Checkout code @@ -134,8 +127,6 @@ jobs: -p no:benchmark \ --start-middleware \ -n auto \ - --shard-index "${{ matrix.shardIndex }}" \ - --shard-total "${{ matrix.shardTotal }}" \ -o 'addopts=--cov=./api --cov-branch --import-mode=importlib' \ --cov-report= \ --timeout "${PYTEST_TIMEOUT:-180}" \ @@ -146,7 +137,7 @@ jobs: - name: Upload integration coverage data uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: - name: api-coverage-integration-${{ matrix.python-version }}-${{ matrix.shardIndex }} + name: api-coverage-integration-${{ matrix.python-version }} path: ${{ env.COVERAGE_FILE }} if-no-files-found: error retention-days: 1 @@ -200,8 +191,8 @@ jobs: echo "expected 3 unit coverage artifacts, found ${#unit_coverage[@]}" >&2 exit 1 fi - if [[ "${#integration_coverage[@]}" -ne 4 ]]; then - echo "expected 4 integration coverage artifacts, found ${#integration_coverage[@]}" >&2 + if [[ "${#integration_coverage[@]}" -ne 1 ]]; then + echo "expected 1 integration coverage artifact, found ${#integration_coverage[@]}" >&2 exit 1 fi From ecadd45886f10935d80b4649c5f267fb589928c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9D=9E=E6=B3=95=E6=93=8D=E4=BD=9C?= Date: Sun, 20 Sep 2026 08:25:01 +0000 Subject: [PATCH 02/37] fix(workflow): preserve LLM prompts and model changes in collaboration (#42124) --- .../__tests__/collaboration-manager.test.ts | 67 ++++++++---- .../core/collaboration-manager.ts | 5 +- .../__tests__/config-prompt.spec.tsx | 102 ++++++++++++++++-- .../nodes/llm/components/config-prompt.tsx | 33 +++--- 4 files changed, 162 insertions(+), 45 deletions(-) diff --git a/web/app/components/workflow/collaboration/core/__tests__/collaboration-manager.test.ts b/web/app/components/workflow/collaboration/core/__tests__/collaboration-manager.test.ts index 4a957c9d1a6..49151ca556e 100644 --- a/web/app/components/workflow/collaboration/core/__tests__/collaboration-manager.test.ts +++ b/web/app/components/workflow/collaboration/core/__tests__/collaboration-manager.test.ts @@ -3,11 +3,11 @@ import type { NodePanelPresenceMap, NodePanelPresenceUser, } from '@/app/components/workflow/collaboration/types/collaboration' -import type { CommonNodeType, Edge, Node } from '@/app/components/workflow/types' +import type { CommonNodeType, Edge, Node, PromptItem } from '@/app/components/workflow/types' import { LoroDoc } from 'loro-crdt/base64' import { Position } from 'reactflow' import { CollaborationManager } from '@/app/components/workflow/collaboration/core/collaboration-manager' -import { BlockEnum } from '@/app/components/workflow/types' +import { BlockEnum, EditionType } from '@/app/components/workflow/types' import { attachCrdtRuntime } from './test-crdt-runtime' const NODE_ID = '1760342909316' @@ -85,10 +85,6 @@ type ParameterExtractorNodeData = { } } -type LLMNodeDataWithUnknownTemplate = Omit & { - prompt_template: unknown -} - type ManagerDoc = LoroDoc | { commit: () => void } type CollaborationManagerInternals = { @@ -566,22 +562,57 @@ describe('CollaborationManager syncNodes', () => { expect(storedData.variables).toBeUndefined() }) - it('treats non-array list inputs as empty lists during synchronization', () => { - const { manager: promptManager, internals: promptInternals } = setupManager() + it('preserves completion prompt objects when adding, editing, and reloading nodes', () => { + const { manager: promptManager } = setupManager() + const prompt: PromptItem = { text: '测试指令', edition_type: EditionType.basic } + const baseNode = createLLMNodeSnapshot([]) + const completionNode = { + ...baseNode, + data: { + ...baseNode.data, + model: { ...baseNode.data.model, mode: 'completion' }, + prompt_template: prompt, + }, + } - const nodeWithInvalidTemplate = createLLMNodeSnapshot([]) - promptInternals.syncNodes([], [deepClone(nodeWithInvalidTemplate)]) + promptManager.setNodes([], [completionNode]) + expect(promptManager.getNodes()[0]).toHaveProperty('data.prompt_template', prompt) - const mutated = deepClone(nodeWithInvalidTemplate) as Node - mutated.data.prompt_template = 'not-an-array' + const updatedPrompt: PromptItem = { ...prompt, text: '修改后的测试指令' } + const updatedNode = { + ...completionNode, + data: { ...completionNode.data, prompt_template: updatedPrompt }, + } + promptManager.setNodes([completionNode], [updatedNode]) + expect(promptManager.getNodes()[0]).toHaveProperty('data.prompt_template', updatedPrompt) - promptInternals.syncNodes([deepClone(nodeWithInvalidTemplate)], [mutated]) + const { manager: reloadedManager } = setupManager() + reloadedManager.setNodes([], deepClone(promptManager.getNodes())) + expect(reloadedManager.getNodes()[0]).toHaveProperty('data.prompt_template', updatedPrompt) + }) - const stored = promptManager - .getNodes() - .find((node) => node.id === LLM_NODE_ID) as Node - expect(Array.isArray(stored.data.prompt_template)).toBe(true) - expect(stored.data.prompt_template).toHaveLength(0) + it('preserves prompt shape when switching between chat and completion models', () => { + const { manager: promptManager } = setupManager() + const chatNode = createLLMNodeSnapshot([{ id: 'system', role: 'system', text: 'Chat prompt' }]) + promptManager.setNodes([], [chatNode]) + + const completionPrompt: PromptItem = { text: '测试指令', edition_type: EditionType.basic } + const completionNode = { + ...chatNode, + data: { + ...chatNode.data, + model: { ...chatNode.data.model, mode: 'completion' }, + prompt_template: completionPrompt, + }, + } + promptManager.setNodes([chatNode], [completionNode]) + expect(promptManager.getNodes()[0]).toHaveProperty('data.prompt_template', completionPrompt) + + promptManager.setNodes([completionNode], [chatNode]) + expect(promptManager.getNodes()[0]).toHaveProperty( + 'data.prompt_template', + chatNode.data.prompt_template, + ) }) it('updates edges map when edges are added, modified, and removed', () => { diff --git a/web/app/components/workflow/collaboration/core/collaboration-manager.ts b/web/app/components/workflow/collaboration/core/collaboration-manager.ts index 016741b4962..dc8c7f6854d 100644 --- a/web/app/components/workflow/collaboration/core/collaboration-manager.ts +++ b/web/app/components/workflow/collaboration/core/collaboration-manager.ts @@ -343,7 +343,7 @@ export class CollaborationManager { } private populateNodeContainer(container: LoroMap>, node: Node): void { - const listFields = new Set(['variables', 'prompt_template', 'parameters']) + const listFields = new Set(['variables', 'parameters']) container.set('id', node.id) container.set('type', node.type) container.set('position', toLoroValue(node.position)) @@ -392,7 +392,8 @@ export class CollaborationManager { if (!this.shouldSyncDataKey(key)) return handledKeys.add(key) - if (listFields.has(key)) this.syncList(container, key, Array.isArray(value) ? value : []) + if (listFields.has(key) || (key === 'prompt_template' && Array.isArray(value))) + this.syncList(container, key, Array.isArray(value) ? value : []) else dataContainer.set(key, toLoroValue(value)) }) diff --git a/web/app/components/workflow/nodes/llm/components/__tests__/config-prompt.spec.tsx b/web/app/components/workflow/nodes/llm/components/__tests__/config-prompt.spec.tsx index ae68df2dba4..16532c96e5d 100644 --- a/web/app/components/workflow/nodes/llm/components/__tests__/config-prompt.spec.tsx +++ b/web/app/components/workflow/nodes/llm/components/__tests__/config-prompt.spec.tsx @@ -1,9 +1,12 @@ import type { PromptItem } from '../../../../types' +import type { LLMNodeType } from '../../types' import { screen } from '@testing-library/react' import userEvent from '@testing-library/user-event' import { useState } from 'react' import { renderWorkflowComponent } from '@/app/components/workflow/__tests__/workflow-test-env' -import { PromptRole } from '../../../../types' +import { BlockEnum, EditionType, PromptRole } from '../../../../types' +import useLLMInputManager from '../../hooks/use-llm-input-manager' +import useLLMPromptConfig from '../../hooks/use-llm-prompt-config' import ConfigPrompt from '../config-prompt' vi.mock('../../../_base/hooks/use-available-var-list', () => ({ @@ -62,6 +65,83 @@ function Fixture({ ) } +function RemoteModelChangeFixture({ onChange }: { onChange: (inputs: LLMNodeType) => void }) { + const [inputs, setInputs] = useState({ + type: BlockEnum.LLM, + title: 'LLM', + desc: '', + model: { + provider: 'openai', + name: 'completion-model', + mode: 'completion', + completion_params: {}, + }, + prompt_template: { text: 'Completion instruction', edition_type: EditionType.basic }, + context: { enabled: false, variable_selector: [] }, + vision: { enabled: false }, + }) + const isChatModel = inputs.model.mode === 'chat' + const inputManager = useLLMInputManager({ + inputs, + isChatModel, + doSetInputs: (nextInputs) => { + onChange(nextInputs) + setInputs(nextInputs) + }, + }) + const promptConfig = useLLMPromptConfig({ + inputs, + inputRef: inputManager.inputRef, + setInputs: inputManager.setInputs, + isChatModel, + isChatMode: true, + }) + + return ( + <> + + {inputs.model.mode} + + + ) +} + +it('retains a remote model change without writing back its default prompts', async () => { + const user = userEvent.setup() + const onChange = vi.fn<(inputs: LLMNodeType) => void>() + renderWorkflowComponent() + + await user.click(screen.getByRole('button', { name: 'Receive remote Chat model' })) + + expect(screen.getByRole('status', { name: 'Model mode' })).toHaveTextContent('chat') + expect(onChange).not.toHaveBeenCalled() + expect( + screen.getAllByRole('textbox').map((editor) => (editor as HTMLTextAreaElement).value), + ).toEqual(initialPrompts.map((prompt) => prompt.text)) +}) + it('reorders messages without moving past the leading system prompt', async () => { const user = userEvent.setup() const onChange = vi.fn() @@ -89,22 +169,28 @@ it('reorders messages without moving past the leading system prompt', async () = expect(screen.getAllByRole('button', { pressed: false })[1]).toHaveFocus() }) -it('persists unique IDs for default prompts once and retains them when sorting', async () => { +it('only writes default prompts without IDs after completing a reorder', async () => { const user = userEvent.setup() const onChange = vi.fn<(items: PromptItem | PromptItem[]) => void>() const initial = initialPrompts.map((item) => ({ role: item.role, text: item.text })) renderWorkflowComponent() - expect(onChange).toHaveBeenCalledTimes(1) - const initialized = onChange.mock.calls[0]![0] as PromptItem[] - expect(initialized).toEqual(initial.map((item) => ({ ...item, id: expect.any(String) }))) - expect(new Set(initialized.map((item) => item.id)).size).toBe(initial.length) + expect(onChange).not.toHaveBeenCalled() const handle = screen.getAllByRole('button', { pressed: false })[0]! for (let index = 0; index < 10 && document.activeElement !== handle; index++) await user.tab() expect(handle).toHaveFocus() await user.keyboard('{Enter}{ArrowDown}{Escape}') - expect(onChange).toHaveBeenCalledTimes(1) + expect(onChange).not.toHaveBeenCalled() await user.keyboard('{Enter}{ArrowDown}{Enter}') + expect(onChange).toHaveBeenCalledExactlyOnceWith( + [initial[0], initial[2], initial[1]].map((prompt) => ({ ...prompt, id: expect.any(String) })), + ) + const reordered = onChange.mock.lastCall![0] as PromptItem[] + expect(new Set(reordered.map((prompt) => prompt.id)).size).toBe(initial.length) + expect( + screen.getAllByRole('textbox').map((editor) => (editor as HTMLTextAreaElement).value), + ).toEqual(['System instruction', 'Assistant answer', 'User question']) + await user.keyboard('{Enter}{ArrowUp}{Enter}') expect(onChange).toHaveBeenCalledTimes(2) - expect(onChange).toHaveBeenLastCalledWith([initialized[0], initialized[2], initialized[1]]) + expect(onChange).toHaveBeenLastCalledWith([reordered[0], reordered[2], reordered[1]]) }) diff --git a/web/app/components/workflow/nodes/llm/components/config-prompt.tsx b/web/app/components/workflow/nodes/llm/components/config-prompt.tsx index 4ed7dff1e5d..d9553a02528 100644 --- a/web/app/components/workflow/nodes/llm/components/config-prompt.tsx +++ b/web/app/components/workflow/nodes/llm/components/config-prompt.tsx @@ -56,7 +56,10 @@ const ConfigPrompt: FC = ({ const workflowStore = useWorkflowStore() const { setControlPromptEditorRerenderKey } = workflowStore.getState() const prompts = useMemo( - () => (isChatModel && Array.isArray(payload) ? payload : []), + () => + isChatModel && Array.isArray(payload) + ? payload.map((item) => ({ ...item, id: item.id || uuid4() })) + : [], [isChatModel, payload], ) const keyboardSort = useKeyboardSortable({ @@ -67,11 +70,7 @@ const ConfigPrompt: FC = ({ getItemLabel: (item) => item.role || '', }) const payloadWithIds = useMemo( - () => - keyboardSort.items.map((item) => { - const id = item.id || uuid4() - return { id, p: { ...item, id } } - }), + () => keyboardSort.items.map((item) => ({ id: item.id, p: item })), [keyboardSort.items], ) const { availableVars, availableNodesWithParent } = useAvailableVarList(nodeId, { @@ -82,7 +81,7 @@ const ConfigPrompt: FC = ({ const handleChatModePromptChange = useCallback( (index: number) => { return (prompt: string) => { - const newPrompt = produce(payload as PromptItem[], (draft) => { + const newPrompt = produce(prompts, (draft) => { draft[index]![ draft[index]!.edition_type === EditionType.jinja2 ? 'jinja2_text' : 'text' ] = prompt @@ -90,35 +89,35 @@ const ConfigPrompt: FC = ({ onChange(newPrompt) } }, - [onChange, payload], + [onChange, prompts], ) const handleChatModeEditionTypeChange = useCallback( (index: number) => { return (editionType: EditionType) => { - const newPrompt = produce(payload as PromptItem[], (draft) => { + const newPrompt = produce(prompts, (draft) => { draft[index]!.edition_type = editionType }) onChange(newPrompt) } }, - [onChange, payload], + [onChange, prompts], ) const handleChatModeMessageRoleChange = useCallback( (index: number) => { return (role: PromptRole) => { - const newPrompt = produce(payload as PromptItem[], (draft) => { + const newPrompt = produce(prompts, (draft) => { draft[index]!.role = role }) onChange(newPrompt) } }, - [onChange, payload], + [onChange, prompts], ) const handleAddPrompt = useCallback(() => { - const newPrompt = produce(payload as PromptItem[], (draft) => { + const newPrompt = produce(prompts, (draft) => { if (draft.length === 0) { draft.push({ role: PromptRole.system, text: '', id: uuid4() }) @@ -132,18 +131,18 @@ const ConfigPrompt: FC = ({ }) }) onChange(newPrompt) - }, [onChange, payload]) + }, [onChange, prompts]) const handleRemove = useCallback( (index: number) => { return () => { - const newPrompt = produce(payload as PromptItem[], (draft) => { + const newPrompt = produce(prompts, (draft) => { draft.splice(index, 1) }) onChange(newPrompt) } }, - [onChange, payload], + [onChange, prompts], ) const handleCompletionPromptChange = useCallback( @@ -193,7 +192,7 @@ const ConfigPrompt: FC = ({ setList={(list) => { if ( keyboardSort.isSorting || - (prompts.every((item) => !!item.id) && + (list.length === payloadWithIds.length && list.every((item, index) => item.id === payloadWithIds[index]?.id)) ) return From 2a3cf7edf5689893941112f799727860ad5f74ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E7=8E=AE=20=28Jade=20Lin=29?= Date: Sun, 20 Sep 2026 08:36:40 +0000 Subject: [PATCH 03/37] feat(app): default exports to ifpkg across app types (#42552) --- api/controllers/console/app/app.py | 30 ++-- api/controllers/console/app/app_import.py | 40 +++-- api/openapi/markdown/console-openapi.md | 6 +- api/services/agent/roster_package_reader.py | 47 +++--- api/services/app_dsl_service.py | 24 +++ api/services/app_package_service.py | 103 ++++++++++++ .../commands/test_generate_swagger_specs.py | 3 +- .../console/app/test_roster_package_routes.py | 150 ++++++++++++++++-- .../services/test_app_dsl_service.py | 35 ++++ .../services/test_app_package_service.py | 112 +++++++++++++ e2e/features/apps/export-app.feature | 6 +- .../step-definitions/apps/export-app.steps.ts | 8 +- .../generated/api/console/apps/types.gen.ts | 6 + .../generated/api/console/apps/zod.gen.ts | 6 + web/app/components/app/use-export-app-dsl.ts | 5 +- .../hooks/__tests__/use-DSL.spec.ts | 47 ++++-- .../components/workflow-app/hooks/use-DSL.ts | 14 +- .../__tests__/update-dsl-modal.spec.tsx | 24 ++- .../workflow/update-dsl-modal.helpers.ts | 5 +- .../components/workflow/update-dsl-modal.tsx | 35 ++-- web/models/app.ts | 23 +-- web/service/apps.ts | 62 -------- web/service/console/client.spec.ts | 56 ++++--- 23 files changed, 635 insertions(+), 212 deletions(-) create mode 100644 api/services/app_package_service.py create mode 100644 api/tests/unit_tests/services/test_app_package_service.py diff --git a/api/controllers/console/app/app.py b/api/controllers/console/app/app.py index d24e34317f9..676bb426226 100644 --- a/api/controllers/console/app/app.py +++ b/api/controllers/console/app/app.py @@ -56,6 +56,7 @@ from models import Account, App, DatasetPermissionEnum, Workflow from models.model import AppMode, IconType from services.agent.roster_package_exporter import RosterAgentPackageExporter from services.app_dsl_service import AppDslService +from services.app_package_service import AppPackageService from services.app_service import ( AppListParams, AppListSortBy, @@ -186,7 +187,7 @@ class CopyAppPayload(BaseModel): class AppExportQuery(BaseModel): format: Literal["yaml", "ifpkg"] | None = Field( - default=None, description="Export format; defaults to ifpkg for Agent Apps and yaml for other Apps" + default=None, description="Export format; defaults to ifpkg for all Apps" ) include_secret: bool = Field(default=False, description="Include secrets in export") workflow_id: str | None = Field(default=None, description="Specific workflow ID to export") @@ -1076,15 +1077,24 @@ class AppExportApi(Resource): ): raise Forbidden("This feature requires a paid plan.") - if req_data.format == "ifpkg" or (req_data.format is None and app_model.mode == AppMode.AGENT): - if app_model.mode != AppMode.AGENT: - raise BadRequest("The ifpkg format is only available for Agent Apps") - agent_id = app_model.bound_agent_id_with_session(session=db.session()) - if agent_id is None: - raise NotFound("Agent not found") - exported = RosterAgentPackageExporter().export( - tenant_id=app_model.tenant_id, agent_id=agent_id, version_id=req_data.version_id - ) + if req_data.format != "yaml": + if app_model.mode == AppMode.AGENT: + agent_id = app_model.bound_agent_id_with_session(session=db.session()) + if agent_id is None: + raise NotFound("Agent not found") + exported = RosterAgentPackageExporter().export( + tenant_id=app_model.tenant_id, agent_id=agent_id, version_id=req_data.version_id + ) + else: + exported = AppPackageService().export( + dsl=AppDslService.export_dsl( + app_model=app_model, + session=db.session(), + include_secret=req_data.include_secret, + workflow_id=req_data.workflow_id, + ), + name=app_model.name, + ) try: archive_response = send_file( exported.archive, mimetype="application/zip", as_attachment=True, download_name=exported.filename diff --git a/api/controllers/console/app/app_import.py b/api/controllers/console/app/app_import.py index a2592c81300..b0b98dff464 100644 --- a/api/controllers/console/app/app_import.py +++ b/api/controllers/console/app/app_import.py @@ -37,6 +37,7 @@ from services.app_dsl_service import ( PendingData, ) from services.app_import_source import download_app_import_source, try_read_yaml +from services.app_package_service import AppPackageService from services.enterprise.enterprise_service import EnterpriseService from services.entities.dsl_entities import CheckDependenciesResult, ImportStatus from services.errors.account import NoPermissionError @@ -103,8 +104,14 @@ class AppImportApi(Resource): "file": { "type": "string", "format": "binary", - "description": "Roster Agent .ifpkg archive", - } + "description": "App .ifpkg archive", + }, + "app_id": {"type": "string", "description": "App to overwrite"}, + "name": {"type": "string"}, + "description": {"type": "string"}, + "icon_type": {"type": "string"}, + "icon": {"type": "string"}, + "icon_background": {"type": "string"}, }, "required": ["file"], } @@ -148,11 +155,29 @@ class AppImportApi(Resource): ) return self._import_package(current_user, payload, source) - @rbac_permission_required(RBACCheck(RBACPermission.AGENT_CREATE, Workspace())) - @rbac_permission_required(RBACCheck(RBACPermission.AGENT_IMPORT_EXPORT_DSL, Workspace())) def _import_package( self, current_user: Account, payload: AppImportPayload | None = None, source: BinaryIO | None = None ): + if source is None: + uploaded = request.files.get("file") + if uploaded is None or not uploaded.filename: + raise InvalidRosterAgentPackageError("App package file is required") + if not uploaded.filename.lower().endswith(".ifpkg"): + raise InvalidRosterAgentPackageError("App package file must use the .ifpkg extension") + source = cast(BinaryIO, uploaded.stream) + dsl = AppPackageService().read_dsl(source) + if dsl is not None: + if payload is None: + payload = AppImportPayload.model_validate({**request.form.to_dict(), "mode": "yaml-content"}) + return self._import_dsl( + payload.model_copy(update={"mode": "yaml-content", "yaml_content": dsl, "yaml_url": None}), + current_user, + ) + return self._import_agent_package(current_user, source, payload) + + @rbac_permission_required(RBACCheck(RBACPermission.AGENT_CREATE, Workspace())) + @rbac_permission_required(RBACCheck(RBACPermission.AGENT_IMPORT_EXPORT_DSL, Workspace())) + def _import_agent_package(self, current_user: Account, source: BinaryIO, payload: AppImportPayload | None = None): app_id = payload.app_id if payload is not None else request.form.get("app_id") if app_id: raise InvalidRosterAgentPackageError("Roster Agent package import does not support overwriting an App") @@ -160,13 +185,6 @@ class AppImportApi(Resource): if tenant_id is None: raise Forbidden("Current workspace is required") importer = RosterAgentPackageImporter() - if source is None: - uploaded = request.files.get("file") - if uploaded is None or not uploaded.filename: - raise InvalidRosterAgentPackageError("Roster Agent package file is required") - if not uploaded.filename.lower().endswith(".ifpkg"): - raise InvalidRosterAgentPackageError("Roster Agent package file must use the .ifpkg extension") - source = cast(BinaryIO, uploaded.stream) result = importer.import_package(source=source, tenant_id=tenant_id, account=account) return Import( id=str(uuid4()), diff --git a/api/openapi/markdown/console-openapi.md b/api/openapi/markdown/console-openapi.md index e872f44fa76..21f8ce97dce 100644 --- a/api/openapi/markdown/console-openapi.md +++ b/api/openapi/markdown/console-openapi.md @@ -1502,7 +1502,7 @@ Create a new application | Required | Schema | | -------- | ------ | -| Yes | **application/json**: [AppImportPayload](#appimportpayload)
**multipart/form-data**: { **"file"**: binary }
| **application/json**: [AppImportPayload](#appimportpayload)
**multipart/form-data**: { **"file"**: binary }
| +| Yes | **application/json**: [AppImportPayload](#appimportpayload)
**multipart/form-data**: { **"app_id"**: string, **"description"**: string, **"file"**: binary, **"icon"**: string, **"icon_background"**: string, **"icon_type"**: string, **"name"**: string }
| **application/json**: [AppImportPayload](#appimportpayload)
**multipart/form-data**: { **"app_id"**: string, **"description"**: string, **"file"**: binary, **"icon"**: string, **"icon_background"**: string, **"icon_type"**: string, **"name"**: string }
| #### Responses @@ -2673,7 +2673,7 @@ Export application configuration as DSL | Name | Located in | Description | Required | Schema | | ---- | ---------- | ----------- | -------- | ------ | | app_id | path | Application ID to export | Yes | string (uuid) | -| format | query | Export format; defaults to ifpkg for Agent Apps and yaml for other Apps | No | string,
**Available values:** "ifpkg", "yaml" | +| format | query | Export format; defaults to ifpkg for all Apps | No | string,
**Available values:** "ifpkg", "yaml" | | include_secret | query | Include secrets in export | No | boolean | | version_id | query | Published Agent version ID to export; requires a paid plan on Cloud. If omitted, exports the shared draft, falling back to the active snapshot when no draft exists. | No | string (uuid) | | workflow_id | query | Specific workflow ID to export | No | string | @@ -15779,7 +15779,7 @@ This class is used to store the schema information of an api based tool. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | -| format | string,
**Available values:** "ifpkg", "yaml" | Export format; defaults to ifpkg for Agent Apps and yaml for other Apps | No | +| format | string,
**Available values:** "ifpkg", "yaml" | Export format; defaults to ifpkg for all Apps | No | | include_secret | boolean | Include secrets in export | No | | version_id | string | Published Agent version ID to export; requires a paid plan on Cloud. If omitted, exports the shared draft, falling back to the active snapshot when no draft exists. | No | | workflow_id | string | Specific workflow ID to export | No | diff --git a/api/services/agent/roster_package_reader.py b/api/services/agent/roster_package_reader.py index 2ef00ce3572..7fb01f22971 100644 --- a/api/services/agent/roster_package_reader.py +++ b/api/services/agent/roster_package_reader.py @@ -89,24 +89,7 @@ class RosterAgentPackageReader: ) -> tuple[RosterAgentPackageManifest, dict[str, AgentAppDsl], dict[str, RosterAgentPackageMember]]: try: with zipfile.ZipFile(archive_file) as archive: - infos = archive.infolist() - if not infos: - raise InvalidRosterAgentPackageError("Roster Agent package is empty") - if len(infos) > dify_config.AGENT_PACKAGE_MAX_ENTRIES: - raise InvalidRosterAgentPackageError("Roster Agent package has too many members") - - info_by_path: dict[str, zipfile.ZipInfo] = {} - casefold_paths: set[str] = set() - total_uncompressed = 0 - for info in infos: - path = self._validate_member_info(info) - if path in info_by_path or path.casefold() in casefold_paths: - raise InvalidRosterAgentPackageError("Roster Agent package contains duplicate member paths") - info_by_path[path] = info - casefold_paths.add(path.casefold()) - total_uncompressed += info.file_size - if total_uncompressed > dify_config.AGENT_PACKAGE_MAX_BYTES: - raise RosterAgentPackageTooLargeError("Roster Agent package uncompressed size exceeds the limit") + info_by_path = self._index_archive(archive) manifest_data, manifest_size = self._read_yaml_document(archive, info_by_path, "manifest.yaml") try: @@ -230,6 +213,27 @@ class RosterAgentPackageReader: except (OSError, zipfile.BadZipFile, EOFError, RuntimeError, ValueError, zlib.error) as exc: raise InvalidRosterAgentPackageError("Roster Agent package is not a valid ZIP") from exc + def _index_archive(self, archive: zipfile.ZipFile) -> dict[str, zipfile.ZipInfo]: + infos = archive.infolist() + if not infos: + raise InvalidRosterAgentPackageError("Roster Agent package is empty") + if len(infos) > dify_config.AGENT_PACKAGE_MAX_ENTRIES: + raise InvalidRosterAgentPackageError("Roster Agent package has too many members") + + info_by_path: dict[str, zipfile.ZipInfo] = {} + casefold_paths: set[str] = set() + total_uncompressed = 0 + for info in infos: + path = self._validate_member_info(info) + if path in info_by_path or path.casefold() in casefold_paths: + raise InvalidRosterAgentPackageError("Roster Agent package contains duplicate member paths") + info_by_path[path] = info + casefold_paths.add(path.casefold()) + total_uncompressed += info.file_size + if total_uncompressed > dify_config.AGENT_PACKAGE_MAX_BYTES: + raise RosterAgentPackageTooLargeError("Roster Agent package uncompressed size exceeds the limit") + return info_by_path + @staticmethod def _copy_bounded(source: BinaryIO, target: BinaryIO) -> None: size = 0 @@ -297,17 +301,20 @@ class RosterAgentPackageReader: path: str, *, resource: RosterAgentPackageApp | None = None, + max_bytes: int | None = None, ) -> tuple[Any, int]: + if max_bytes is None: + max_bytes = dify_config.AGENT_PACKAGE_MAX_MANIFEST_BYTES info = infos.get(path) if info is None: raise InvalidRosterAgentPackageError(f"Roster Agent package is missing {path}") - if info.file_size > dify_config.AGENT_PACKAGE_MAX_MANIFEST_BYTES: + if info.file_size > max_bytes: raise RosterAgentPackageTooLargeError(f"Roster Agent package {path} exceeds the size limit") payload, digest, size = self._read_member( archive, info, collect=True, - max_bytes=dify_config.AGENT_PACKAGE_MAX_MANIFEST_BYTES, + max_bytes=max_bytes, expected_size=resource.size if resource is not None else info.file_size, ) if resource is not None and digest != resource.sha256: diff --git a/api/services/app_dsl_service.py b/api/services/app_dsl_service.py index 146b74b3d12..c7abd5fd354 100644 --- a/api/services/app_dsl_service.py +++ b/api/services/app_dsl_service.py @@ -300,6 +300,8 @@ class AppDslService: error="Only workflow or advanced chat apps can be overwritten", ) + self._validate_workflow_overwrite(app, data) + # If major version mismatch, store import info in Redis if status == ImportStatus.PENDING: tenant_id = account.current_tenant_id @@ -434,6 +436,9 @@ class AppDslService: error="App not found", ) + if app is not None: + self._validate_workflow_overwrite(app, data) + # Create or update app app = self._create_or_update_app( app=app, @@ -540,6 +545,25 @@ class AppDslService: if not allowed: raise NoPermissionError("Agent DSL import permission is required to import an Agent App") + @staticmethod + def _validate_workflow_overwrite(app: App, data: dict[str, Any]) -> None: + """Apply editor compatibility checks to both YAML and package imports.""" + app_mode = data.get("app", {}).get("mode") + if app.mode not in {AppMode.WORKFLOW, AppMode.ADVANCED_CHAT} or app_mode not in { + AppMode.WORKFLOW, + AppMode.ADVANCED_CHAT, + }: + raise ValueError("Only workflow or advanced chat DSLs can overwrite workflow Apps") + # Package uploads cannot run the editor's YAML node checks before import. + invalid_types = ( + {BuiltinNodeTypes.END, "trigger-webhook", "trigger-schedule", "trigger-plugin"} + if app.mode == AppMode.ADVANCED_CHAT + else {BuiltinNodeTypes.ANSWER} + ) + nodes = data.get("workflow", {}).get("graph", {}).get("nodes", []) + if any(node.get("data", {}).get("type") in invalid_types for node in nodes): + raise ValueError("Workflow contains node types incompatible with the target App") + def _create_or_update_app( self, *, diff --git a/api/services/app_package_service.py b/api/services/app_package_service.py new file mode 100644 index 00000000000..aae6870ef47 --- /dev/null +++ b/api/services/app_package_service.py @@ -0,0 +1,103 @@ +"""Package ordinary App DSLs while retaining the existing Roster Agent format.""" + +from __future__ import annotations + +import hashlib +import io +import re +import tempfile +import zipfile +import zlib +from typing import BinaryIO, Literal, cast + +import yaml +from pydantic import BaseModel, ConfigDict, Field, ValidationError + +from services.agent.errors import InvalidRosterAgentPackageError, RosterAgentPackageTooLargeError +from services.agent.roster_package_entities import RosterAgentPackageApp, RosterAgentPackageExport +from services.agent.roster_package_reader import RosterAgentPackageReader +from services.dsl_content import DSL_MAX_SIZE + + +class AppPackageManifest(BaseModel): + model_config = ConfigDict(extra="forbid") + + format: Literal["dify.app"] + format_version: Literal[1] + apps: list[RosterAgentPackageApp] = Field(min_length=1, max_length=1) + + +class AppPackageService(RosterAgentPackageReader): + """Reuse the bounded ZIP reader; ordinary Apps retain DSL import semantics.""" + + def read_dsl(self, source: BinaryIO) -> str | None: + """Return an ordinary DSL, or rewind a Roster package for its importer.""" + try: + with tempfile.SpooledTemporaryFile(max_size=16 * 1024 * 1024, mode="w+b") as spool: + self._copy_bounded(source, cast(BinaryIO, spool)) + spool.seek(0) + with zipfile.ZipFile(spool) as archive: + infos = self._index_archive(archive) + data, _ = self._read_yaml_document(archive, infos, "manifest.yaml") + if isinstance(data, dict) and data.get("format") == "dify.roster-agent": + return None + try: + manifest = AppPackageManifest.model_validate(data) + except ValidationError as exc: + raise InvalidRosterAgentPackageError("App package manifest is invalid") from exc + resource = manifest.apps[0] + if set(infos) != {"manifest.yaml", resource.path}: + raise InvalidRosterAgentPackageError("App package members do not match the manifest") + app_data, _ = self._read_yaml_document( + archive, infos, resource.path, resource=resource, max_bytes=DSL_MAX_SIZE + ) + if ( + not isinstance(app_data, dict) + or app_data.get("kind") != "app" + or not isinstance(app_data.get("app"), dict) + or app_data["app"].get("mode") + not in { + "workflow", + "advanced-chat", + "chat", + "completion", + "agent-chat", + "channel", + "rag-pipeline", + } + ): + raise InvalidRosterAgentPackageError("App package DSL is invalid") + # Preserve the original text for version confirmation and legacy DSL handling. + return archive.read(resource.path).decode("utf-8") + except (InvalidRosterAgentPackageError, RosterAgentPackageTooLargeError): + raise + except (OSError, zipfile.BadZipFile, EOFError, RuntimeError, ValueError, zlib.error) as exc: + raise InvalidRosterAgentPackageError("App package is not a valid ZIP") from exc + finally: + source.seek(0) + + def export(self, *, dsl: str, name: str) -> RosterAgentPackageExport: + payload = dsl.encode("utf-8") + if len(payload) > DSL_MAX_SIZE: + raise RosterAgentPackageTooLargeError("App package DSL exceeds the size limit") + manifest = AppPackageManifest( + format="dify.app", + format_version=1, + apps=[ + RosterAgentPackageApp(path="app.yaml", size=len(payload), sha256=hashlib.sha256(payload).hexdigest()) + ], + ) + archive = io.BytesIO() + try: + with zipfile.ZipFile(archive, "w", compression=zipfile.ZIP_DEFLATED) as package: + package.writestr("manifest.yaml", yaml.safe_dump(manifest.model_dump(mode="json"))) + package.writestr("app.yaml", payload) + size = archive.tell() + archive.seek(0) + # Validate exported containers against the same limits as imports. + self.read_dsl(archive) + slug = re.sub(r"[^a-z0-9]+", "-", name.lower()).strip("-")[:80] or "app" + return RosterAgentPackageExport(archive=archive, filename=f"{slug}.ifpkg", size=size) + except Exception: + archive.close() + raise diff --git a/api/tests/unit_tests/commands/test_generate_swagger_specs.py b/api/tests/unit_tests/commands/test_generate_swagger_specs.py index 04c94a468f5..abbaa1be7ec 100644 --- a/api/tests/unit_tests/commands/test_generate_swagger_specs.py +++ b/api/tests/unit_tests/commands/test_generate_swagger_specs.py @@ -689,6 +689,7 @@ def test_generate_specs_include_console_contract_shapes_for_schema_migration(tmp package_import = paths["/apps/imports"]["post"] assert _request_schema(package_import, "multipart/form-data")["required"] == ["file"] + assert _request_schema(package_import, "multipart/form-data")["properties"]["app_id"]["type"] == "string" assert _request_schema(package_import, "application/json")["$ref"] == "#/components/schemas/AppImportPayload" assert "mode" in schemas["AppImportPayload"]["required"] conflict = package_import["responses"]["409"]["content"]["application/json"]["schema"] @@ -703,7 +704,7 @@ def test_generate_specs_include_console_contract_shapes_for_schema_migration(tmp export_format = next(param for param in export["parameters"] if param["name"] == "format") assert set(export_format["schema"]["enum"]) == {"yaml", "ifpkg"} assert export_format["schema"].get("default") is None - assert "defaults to ifpkg for Agent Apps and yaml for other Apps" in export_format["description"] + assert "defaults to ifpkg for all Apps" in export_format["description"] api_key_auth_binding_schema = _request_schema(paths["/api-key-auth/data-source/binding"]["post"]) assert api_key_auth_binding_schema["$ref"] == "#/components/schemas/ApiKeyAuthBindingPayload" diff --git a/api/tests/unit_tests/controllers/console/app/test_roster_package_routes.py b/api/tests/unit_tests/controllers/console/app/test_roster_package_routes.py index af3e60885e9..69961b0e4c8 100644 --- a/api/tests/unit_tests/controllers/console/app/test_roster_package_routes.py +++ b/api/tests/unit_tests/controllers/console/app/test_roster_package_routes.py @@ -1,4 +1,5 @@ import io +import zipfile from collections.abc import Callable from inspect import unwrap from types import SimpleNamespace @@ -20,17 +21,30 @@ from models.model import App, AppMode from services import app_import_source from services.agent.errors import InvalidRosterAgentPackageError from services.agent.roster_package_importer import RosterAgentPackageImportResult +from services.app_package_service import AppPackageService from services.entities.dsl_entities import DslImportWarning -def _mock_download(monkeypatch: pytest.MonkeyPatch, content: bytes = b"PK\x00\xff") -> Mock: +def _mock_download(monkeypatch: pytest.MonkeyPatch, content: bytes | None = None) -> Mock: fetch = Mock( - return_value=httpx.Response(200, content=content, request=httpx.Request("GET", "https://example.com/download")) + return_value=httpx.Response( + 200, + content=content if content is not None else _roster_archive().getvalue(), + request=httpx.Request("GET", "https://example.com/download"), + ) ) monkeypatch.setattr(app_import_source.remote_fetcher, "make_request", fetch) return fetch +def _roster_archive() -> io.BytesIO: + source = io.BytesIO() + with zipfile.ZipFile(source, "w") as archive: + archive.writestr("manifest.yaml", "format: dify.roster-agent") + source.seek(0) + return source + + def _account() -> Account: account = Account(name="Importer", email="importer@example.com") account._current_tenant = Tenant(name="Workspace") @@ -148,7 +162,7 @@ def test_url_quota_is_enforced_after_content_detection( features = Mock() features.apps = SimpleNamespace(size=1, limit=1) monkeypatch.setattr("controllers.console.wraps.FeatureService.get_features", lambda *_args, **_kwargs: features) - _mock_download(monkeypatch, b"app: {}" if is_yaml else b"PK\x00\xff") + _mock_download(monkeypatch, b"app: {}" if is_yaml else _roster_archive().getvalue()) importer = Mock() importer.import_package.return_value = RosterAgentPackageImportResult( app_id="app-1", agent_id="agent-1", warnings=[] @@ -205,10 +219,10 @@ def test_existing_import_route_accepts_package_and_preserves_import_response( ) api = import_module.AppImportApi() with app.test_request_context( - "/console/api/apps/imports", method="POST", data={"file": (io.BytesIO(b"package"), "agent.ifpkg")} + "/console/api/apps/imports", method="POST", data={"file": (_roster_archive(), "agent.ifpkg")} ): data, status = unwrap(api.post)(api, account) - assert import_package.call_args.kwargs["source"].read() == b"package" + assert import_package.call_args.kwargs["source"].read() == _roster_archive().getvalue() assert status == 200 assert data["app_id"] == "app-1" assert data["app_mode"] == "agent" @@ -220,7 +234,7 @@ def test_existing_import_route_accepts_package_and_preserves_import_response( @pytest.mark.parametrize("from_url", [False, True]) @pytest.mark.parametrize("denied", [RBACPermission.AGENT_CREATE, RBACPermission.AGENT_IMPORT_EXPORT_DSL]) -def test_package_import_checks_agent_permissions_before_reading_payload( +def test_package_import_checks_agent_permissions_before_materializing_resources( app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None], @@ -244,7 +258,7 @@ def test_package_import_checks_agent_permissions_before_reading_payload( request_kwargs = ( {"json": {"mode": "yaml-url", "yaml_url": "https://example.com/agent.ifpkg"}} if from_url - else {"data": {"file": (io.BytesIO(b"package"), "agent.ifpkg")}} + else {"data": {"file": (_roster_archive(), "agent.ifpkg")}} ) with app.test_request_context("/console/api/apps/imports", method="POST", **request_kwargs): with pytest.raises(Forbidden): @@ -265,7 +279,7 @@ def test_package_import_rejects_overwrite( request_kwargs = ( {"json": {"mode": "yaml-url", "yaml_url": "https://example.com/agent.ifpkg", "app_id": "existing"}} if from_url - else {"data": {"app_id": "existing", "file": (io.BytesIO(b"package"), "agent.ifpkg")}} + else {"data": {"app_id": "existing", "file": (_roster_archive(), "agent.ifpkg")}} ) with app.test_request_context("/console/api/apps/imports", method="POST", **request_kwargs): with pytest.raises(InvalidRosterAgentPackageError, match="overwriting"): @@ -300,10 +314,75 @@ def test_existing_export_route_returns_ifpkg_for_agent( close.assert_called_once_with() -def test_ifpkg_export_rejects_non_agent_apps() -> None: - model = App(id="app-1", tenant_id="tenant-1", mode=AppMode.WORKFLOW) - with pytest.raises(BadRequest): - unwrap(app_module.AppExportApi.get)(app_module.AppExportApi(), app_module.AppExportQuery(format="ifpkg"), model) +@pytest.mark.parametrize( + "mode", [AppMode.WORKFLOW, AppMode.ADVANCED_CHAT, AppMode.CHAT, AppMode.COMPLETION, AppMode.AGENT_CHAT] +) +@pytest.mark.parametrize("query", [{}, {"format": "ifpkg"}]) +def test_default_export_packages_ordinary_app_dsl( + app: Flask, monkeypatch: pytest.MonkeyPatch, mode: AppMode, query: dict[str, str] +) -> None: + model = App(id="app-1", tenant_id="tenant-1", mode=mode, name="My App") + dsl = f"kind: app\nversion: 0.7.0\napp:\n mode: {mode}\n" + export = Mock(return_value=dsl) + session = object() + monkeypatch.setattr(app_module, "db", SimpleNamespace(session=lambda: session)) + monkeypatch.setattr(app_module.AppDslService, "export_dsl", export) + with app.test_request_context(): + response = unwrap(app_module.AppExportApi.get)( + app_module.AppExportApi(), + app_module.AppExportQuery.model_validate({**query, "include_secret": True, "workflow_id": "revision-1"}), + model, + ) + response.direct_passthrough = False + assert response.mimetype == "application/zip" + assert "my-app.ifpkg" in response.headers["Content-Disposition"] + assert AppPackageService().read_dsl(io.BytesIO(response.get_data())) == dsl + response.close() + export.assert_called_once_with(app_model=model, session=session, include_secret=True, workflow_id="revision-1") + + +@pytest.mark.parametrize("from_url", [False, True]) +@pytest.mark.parametrize("app_id", [None, "existing"]) +@pytest.mark.parametrize("status", [200, 202, 400]) +def test_ordinary_package_import_uses_dsl_permissions_and_confirmation( + app: Flask, + monkeypatch: pytest.MonkeyPatch, + config_overrides: Callable[..., None], + app_id: str | None, + status: int, + from_url: bool, +) -> None: + config_overrides(RBAC_ENABLED=False) + account = _account() + api = import_module.AppImportApi() + dsl = "kind: app\nversion: 99.0.0\napp:\n mode: workflow\n" + import_dsl = Mock(return_value=({"status": "pending"}, status)) + monkeypatch.setattr(api, "_import_dsl", import_dsl) + agent_import = Mock() + monkeypatch.setattr(api, "_import_agent_package", agent_import) + with AppPackageService().export(dsl=dsl, name="Workflow") as package: + form = {"file": (package.archive, "workflow.ifpkg"), "name": "Renamed"} + if app_id: + form["app_id"] = app_id + if from_url: + _mock_download(monkeypatch, package.archive.read()) + with app.test_request_context( + method="POST", + json={ + "mode": "yaml-url", + "yaml_url": "https://example.com/workflow.ifpkg", + "name": "Renamed", + "app_id": app_id, + }, + ): + assert unwrap(api.post)(api, account) == ({"status": "pending"}, status) + else: + with app.test_request_context(method="POST", data=form): + assert unwrap(api.post)(api, account) == ({"status": "pending"}, status) + import_dsl.assert_called_once_with( + import_module.AppImportPayload(mode="yaml-content", yaml_content=dsl, name="Renamed", app_id=app_id), account + ) + agent_import.assert_not_called() @pytest.mark.parametrize("export_format", [None, "ifpkg", "yaml"]) @@ -375,7 +454,7 @@ def test_version_export_rejects_non_agent_apps() -> None: @pytest.mark.parametrize( ("mode", "query"), - [(AppMode.AGENT, {"format": "yaml"}), (AppMode.WORKFLOW, {}), (AppMode.WORKFLOW, {"format": "yaml"})], + [(AppMode.AGENT, {"format": "yaml"}), (AppMode.WORKFLOW, {"format": "yaml"})], ) def test_yaml_export_remains_available(monkeypatch: pytest.MonkeyPatch, mode: AppMode, query: dict[str, str]) -> None: model = App(id="app-1", tenant_id="tenant-1", mode=mode) @@ -384,3 +463,48 @@ def test_yaml_export_remains_available(monkeypatch: pytest.MonkeyPatch, mode: Ap assert unwrap(app_module.AppExportApi.get)( app_module.AppExportApi(), app_module.AppExportQuery.model_validate(query), model ) == {"data": "app: {}"} + + +def test_ordinary_package_import_checks_app_permission( + app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None] +) -> None: + config_overrides(RBAC_ENABLED=True) + account = _account() + monkeypatch.setattr("controllers.console.wraps.current_account_with_tenant", lambda: (account, "tenant-1")) + monkeypatch.setattr("controllers.common.wraps.current_account_with_tenant", lambda: (account, "tenant-1")) + check = Mock(return_value=False) + monkeypatch.setattr("controllers.common.rbac.checks.RBACService.CheckAccess.check", check) + service = Mock() + monkeypatch.setattr(import_module, "AppDslService", service) + with AppPackageService().export(dsl="kind: app\napp: {mode: workflow}\n", name="Workflow") as package: + with app.test_request_context(method="POST", data={"file": (package.archive, "workflow.ifpkg")}): + api = import_module.AppImportApi() + with pytest.raises(Forbidden): + unwrap(api.post)(api, account) + assert check.call_args.kwargs["scene"] == RBACPermission.APP_IMPORT_EXPORT_DSL + service.assert_not_called() + + +def test_ordinary_package_import_cannot_bypass_app_quota( + app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None] +) -> None: + config_overrides(DEPLOYMENT_EDITION="CLOUD", RBAC_ENABLED=False) + account = _account() + monkeypatch.setattr("controllers.console.wraps.current_account_with_tenant", lambda: (account, "tenant-1")) + monkeypatch.setattr( + "controllers.console.wraps.FeatureService.get_features", + lambda *_args, **_kwargs: SimpleNamespace( + members=None, + apps=SimpleNamespace(limit=1, size=1), + documents_upload_quota=None, + annotation_quota_limit=None, + ), + ) + service = Mock() + monkeypatch.setattr(import_module, "AppDslService", service) + with AppPackageService().export(dsl="kind: app\napp: {mode: workflow}\n", name="Workflow") as package: + with app.test_request_context(method="POST", data={"file": (package.archive, "workflow.ifpkg")}): + api = import_module.AppImportApi() + with pytest.raises(Forbidden): + unwrap(api.post)(api, account) + service.assert_not_called() diff --git a/api/tests/unit_tests/services/test_app_dsl_service.py b/api/tests/unit_tests/services/test_app_dsl_service.py index e4c1554f62c..87ec22a7b06 100644 --- a/api/tests/unit_tests/services/test_app_dsl_service.py +++ b/api/tests/unit_tests/services/test_app_dsl_service.py @@ -832,3 +832,38 @@ def test_export_dsl_preserves_envelope_and_mode_specific_content( assert data["model_config"] == {"fixture": "model"} assert "agent" not in data assert "workflow" not in data + + +@pytest.mark.parametrize( + ("mode", "node_type"), + [ + (AppMode.WORKFLOW, "answer"), + (AppMode.ADVANCED_CHAT, "end"), + (AppMode.ADVANCED_CHAT, "trigger-webhook"), + (AppMode.ADVANCED_CHAT, "trigger-schedule"), + (AppMode.ADVANCED_CHAT, "trigger-plugin"), + ], +) +def test_overwrite_rejects_incompatible_nodes_before_mutation(mode: AppMode, node_type: str) -> None: + session = Mock() + target = App(id="target", tenant_id="tenant", mode=mode, name="Original") + service = AppDslService(session) + service._load_app_for_overwrite = Mock(return_value=target) + result = service.import_app( + account=_account(), + import_mode="yaml-content", + app_id=target.id, + yaml_content=yaml.safe_dump( + { + "version": CURRENT_APP_DSL_VERSION, + "kind": "app", + "app": {"mode": mode.value, "name": "Changed"}, + "workflow": {"graph": {"nodes": [{"data": {"type": node_type}}]}}, + } + ), + ) + assert result.status == ImportStatus.FAILED + assert result.error is not None + assert "incompatible" in result.error + assert target.name == "Original" + session.add.assert_not_called() diff --git a/api/tests/unit_tests/services/test_app_package_service.py b/api/tests/unit_tests/services/test_app_package_service.py new file mode 100644 index 00000000000..a4299f902c3 --- /dev/null +++ b/api/tests/unit_tests/services/test_app_package_service.py @@ -0,0 +1,112 @@ +"""Ordinary App packages preserve DSLs and enforce container integrity.""" + +import hashlib +import io +import zipfile +from collections.abc import Callable + +import pytest +import yaml + +from services.agent.errors import InvalidRosterAgentPackageError, RosterAgentPackageTooLargeError +from services.app_package_service import AppPackageService +from services.dsl_content import DSL_MAX_SIZE + + +def _archive(dsl: str, **manifest_overrides: object) -> io.BytesIO: + payload = dsl.encode() + manifest = { + "format": "dify.app", + "format_version": 1, + "apps": [{"path": "app.yaml", "size": len(payload), "sha256": hashlib.sha256(payload).hexdigest()}], + **manifest_overrides, + } + source = io.BytesIO() + with zipfile.ZipFile(source, "w", compression=zipfile.ZIP_DEFLATED) as archive: + archive.writestr("manifest.yaml", yaml.safe_dump(manifest)) + archive.writestr("app.yaml", payload) + source.seek(0) + return source + + +@pytest.mark.parametrize("mode", ["workflow", "advanced-chat", "chat", "completion", "agent-chat"]) +@pytest.mark.parametrize("version", ["0.1.0", "99.0.0"]) +def test_round_trip_retains_exact_dsl_and_defers_version_handling(mode: str, version: str) -> None: + dsl = f"kind: app\nversion: {version}\napp:\n mode: {mode}\n# Preserve the DSL verbatim.\n" + service = AppPackageService() + with service.export(dsl=dsl, name="Example App") as package: + assert package.filename == "example-app.ifpkg" + assert service.read_dsl(package.archive) == dsl + assert package.archive.tell() == 0 + assert package.archive.closed + + +@pytest.mark.parametrize("overrides", [{"format": "unknown"}, {"format_version": 2}, {"apps": []}, {"files": []}]) +def test_rejects_unsupported_manifests(overrides: dict[str, object]) -> None: + with pytest.raises(InvalidRosterAgentPackageError, match="manifest"): + AppPackageService().read_dsl(_archive("kind: app\napp: {mode: workflow}\n", **overrides)) + + +@pytest.mark.parametrize( + "dsl", + [ + "[]", + "kind: app\napp: {mode: agent}", + "kind: app\napp: {mode: unknown}", + "kind: app\napp: {mode: workflow, mode: chat}", + ], +) +def test_rejects_invalid_or_agent_dsl_in_ordinary_container(dsl: str) -> None: + with pytest.raises(InvalidRosterAgentPackageError): + AppPackageService().read_dsl(_archive(dsl)) + + +def test_rejects_checksum_mismatch() -> None: + dsl = "kind: app\napp: {mode: workflow}\n" + source = _archive(dsl, apps=[{"path": "app.yaml", "size": len(dsl), "sha256": "0" * 64}]) + with pytest.raises(InvalidRosterAgentPackageError, match="integrity"): + AppPackageService().read_dsl(source) + + +@pytest.mark.parametrize("path", ["extra.txt", "../escape", "APP.YAML"]) +def test_rejects_unlisted_unsafe_and_duplicate_members(path: str) -> None: + source = _archive("kind: app\napp: {mode: workflow}\n") + with zipfile.ZipFile(source, "a") as archive: + archive.writestr(path, "unexpected") + source.seek(0) + with pytest.raises(InvalidRosterAgentPackageError): + AppPackageService().read_dsl(source) + + +def test_rejects_oversized_container(config_overrides: Callable[..., None]) -> None: + source = _archive("kind: app\napp: {mode: workflow}\n") + config_overrides(AGENT_PACKAGE_MAX_BYTES=10) + with pytest.raises(RosterAgentPackageTooLargeError): + AppPackageService().read_dsl(source) + + +def _dsl_with_size(size: int) -> str: + header = "kind: app\napp:\n mode: workflow\n description: " + padding = size - len(header.encode("utf-8")) + return header + "\U0001f600" * (padding // 4) + "a" * (padding % 4) + + +@pytest.mark.parametrize("size", [6 * 1024 * 1024, DSL_MAX_SIZE]) +def test_package_round_trip_accepts_large_dsl_within_legacy_limit(size: int) -> None: + dsl = _dsl_with_size(size) + service = AppPackageService() + with service.export(dsl=dsl, name="Large Workflow") as package: + assert service.read_dsl(package.archive) == dsl + + +def test_export_rejects_dsl_exceeding_legacy_byte_limit() -> None: + dsl = _dsl_with_size(DSL_MAX_SIZE + 1) + with pytest.raises(RosterAgentPackageTooLargeError): + AppPackageService().export(dsl=dsl, name="Large Workflow") + + +def test_import_rejects_compressed_dsl_exceeding_legacy_byte_limit() -> None: + dsl = _dsl_with_size(DSL_MAX_SIZE + 1) + source = _archive(dsl) + with pytest.raises(RosterAgentPackageTooLargeError): + AppPackageService().read_dsl(source) diff --git a/e2e/features/apps/export-app.feature b/e2e/features/apps/export-app.feature index d6d040fb00f..6a00e54c4b5 100644 --- a/e2e/features/apps/export-app.feature +++ b/e2e/features/apps/export-app.feature @@ -1,9 +1,9 @@ @apps @authenticated @core -Feature: Export app DSL - Scenario: Export the DSL file for an existing app +Feature: Export app package + Scenario: Export the app package for an existing app Given I am signed in as the default E2E admin And there is an existing E2E completion app available for testing When I open the apps console And I open the options menu for the last created E2E app And I click "Export DSL" in the app options menu - Then a YAML file named after the app should be downloaded + Then an app package named after the app should be downloaded diff --git a/e2e/features/step-definitions/apps/export-app.steps.ts b/e2e/features/step-definitions/apps/export-app.steps.ts index 4ebeecb5076..cf794296679 100644 --- a/e2e/features/step-definitions/apps/export-app.steps.ts +++ b/e2e/features/step-definitions/apps/export-app.steps.ts @@ -1,8 +1,10 @@ import type { DifyWorld } from '../../support/world' +import { Buffer } from 'node:buffer' +import { readFile } from 'node:fs/promises' import { Then } from '@cucumber/cucumber' import { expect } from '@playwright/test' -Then('a YAML file named after the app should be downloaded', async function (this: DifyWorld) { +Then('an app package named after the app should be downloaded', async function (this: DifyWorld) { const appName = this.lastCreatedAppName if (!appName) { throw new Error( @@ -15,5 +17,7 @@ Then('a YAML file named after the app should be downloaded', async function (thi await expect.poll(() => this.capturedDownloads.length, { timeout: 10_000 }).toBeGreaterThan(0) const download = this.capturedDownloads.at(-1)! - expect(download.suggestedFilename()).toBe(`${appName}.yml`) + expect(download.suggestedFilename()).toBe(`${appName}.ifpkg`) + const content = await readFile(await download.path()) + expect(content.subarray(0, 4)).toEqual(Buffer.from([0x50, 0x4b, 0x03, 0x04])) }) diff --git a/packages/contracts/generated/api/console/apps/types.gen.ts b/packages/contracts/generated/api/console/apps/types.gen.ts index b6d9858be73..ba654ca190a 100644 --- a/packages/contracts/generated/api/console/apps/types.gen.ts +++ b/packages/contracts/generated/api/console/apps/types.gen.ts @@ -3157,7 +3157,13 @@ export type PostAppsImportsData = { body: | AppImportPayload | { + app_id?: string + description?: string file: Blob | File + icon?: string + icon_background?: string + icon_type?: string + name?: string } path?: never query?: never diff --git a/packages/contracts/generated/api/console/apps/zod.gen.ts b/packages/contracts/generated/api/console/apps/zod.gen.ts index e1df3fa9860..3ccf9a944cb 100644 --- a/packages/contracts/generated/api/console/apps/zod.gen.ts +++ b/packages/contracts/generated/api/console/apps/zod.gen.ts @@ -4257,7 +4257,13 @@ export const zPostAppsResponse = zAppDetailWithSite export const zPostAppsImportsBody = z.union([ zAppImportPayload, z.object({ + app_id: z.string().optional(), + description: z.string().optional(), file: z.custom((value) => value instanceof Blob || value instanceof File), + icon: z.string().optional(), + icon_background: z.string().optional(), + icon_type: z.string().optional(), + name: z.string().optional(), }), ]) diff --git a/web/app/components/app/use-export-app-dsl.ts b/web/app/components/app/use-export-app-dsl.ts index 13db963ab79..68a93c3f90a 100644 --- a/web/app/components/app/use-export-app-dsl.ts +++ b/web/app/components/app/use-export-app-dsl.ts @@ -17,6 +17,7 @@ type ExportAppDslInput = { includeSecret?: boolean versionId?: string format?: NonNullable['format'] + workflowId?: string } type ExportWorkflowAppDslInput = Pick @@ -46,10 +47,11 @@ async function getSecretEnvironmentVariables(appId: string) { return items.filter((environmentVariable) => environmentVariable.value_type === 'secret') } -async function exportAppDslFile({ +export async function exportAppDslFile({ appId, appName, includeSecret = false, + workflowId, versionId, format, }: ExportAppDslInput) { @@ -58,6 +60,7 @@ async function exportAppDslFile({ params: { app_id: appId }, query: { include_secret: includeSecret, + ...(workflowId ? { workflow_id: workflowId } : {}), ...(versionId ? { version_id: versionId } : {}), ...(format && { format }), }, diff --git a/web/app/components/workflow-app/hooks/__tests__/use-DSL.spec.ts b/web/app/components/workflow-app/hooks/__tests__/use-DSL.spec.ts index 0b522aa9292..9a5d199a1e5 100644 --- a/web/app/components/workflow-app/hooks/__tests__/use-DSL.spec.ts +++ b/web/app/components/workflow-app/hooks/__tests__/use-DSL.spec.ts @@ -59,8 +59,10 @@ vi.mock('../use-nodes-sync-draft', () => ({ }), })) -vi.mock('@/service/apps', () => ({ - exportAppConfig: (...args: unknown[]) => mockExportAppConfig(...args), +vi.mock('@/service/console', () => ({ + consoleClient: { + apps: { byAppId: { export: { get: (...args: unknown[]) => mockExportAppConfig(...args) } } }, + }, })) vi.mock('@/service/workflow', () => ({ @@ -93,6 +95,23 @@ describe('useDSLByCanEdit', () => { mockFetchWorkflowDraft.mockResolvedValue({ environment_variables: [] }) }) + it('downloads the default package bytes and forwards the selected workflow version', async () => { + const file = new File([new Uint8Array([0x50, 0x4b, 0xff])], 'workflow.ifpkg') + mockExportAppConfig.mockResolvedValue(file) + const { result } = renderHook(() => useDSLByCanEdit(true)) + await act(async () => { + await result.current.handleExportDSL(true, 'revision-1') + }) + expect(mockExportAppConfig).toHaveBeenCalledWith( + { + params: { app_id: 'app-1' }, + query: { include_secret: true, workflow_id: 'revision-1' }, + }, + { context: { silent: true } }, + ) + expect(mockDownloadBlob).toHaveBeenCalledWith({ data: file, fileName: 'workflow.ifpkg' }) + }) + it('should export workflow dsl and download the yaml blob when no secret env is present', async () => { const { result } = renderHook(() => useDSLByCanEdit(true)) @@ -102,11 +121,13 @@ describe('useDSLByCanEdit', () => { expect(mockFetchWorkflowDraft).toHaveBeenCalledWith('/apps/app-1/workflows/draft') expect(mockDoSyncWorkflowDraft).toHaveBeenCalled() - expect(mockExportAppConfig).toHaveBeenCalledWith({ - appID: 'app-1', - include: false, - workflowID: undefined, - }) + expect(mockExportAppConfig).toHaveBeenCalledWith( + { + params: { app_id: 'app-1' }, + query: { include_secret: false, workflow_id: undefined }, + }, + { context: { silent: true } }, + ) expect(mockDownloadBlob).toHaveBeenCalledWith( expect.objectContaining({ data: expect.any(Blob), @@ -151,11 +172,13 @@ workflow: await result.current.handleExportDSL(true, 'workflow-1') }) - expect(mockExportAppConfig).toHaveBeenCalledWith({ - appID: 'app-1', - include: true, - workflowID: 'workflow-1', - }) + expect(mockExportAppConfig).toHaveBeenCalledWith( + { + params: { app_id: 'app-1' }, + query: { include_secret: true, workflow_id: 'workflow-1' }, + }, + { context: { silent: true } }, + ) }) it('should emit DSL_EXPORT_CHECK when secret environment variables exist', async () => { diff --git a/web/app/components/workflow-app/hooks/use-DSL.ts b/web/app/components/workflow-app/hooks/use-DSL.ts index e7e8f2bc56c..74130912f17 100644 --- a/web/app/components/workflow-app/hooks/use-DSL.ts +++ b/web/app/components/workflow-app/hooks/use-DSL.ts @@ -2,12 +2,11 @@ import type { useNodesSyncDraft } from './use-nodes-sync-draft' import { useCallback, useState } from 'react' import { useTranslation } from 'react-i18next' import { useStore as useAppStore } from '@/app/components/app/store' +import { exportAppDslFile } from '@/app/components/app/use-export-app-dsl' import { DSL_EXPORT_CHECK } from '@/app/components/workflow/constants' import { toast } from '@/app/notifications' import { useEventEmitterContextContext } from '@/context/event-emitter' -import { exportAppConfig } from '@/service/apps' import { fetchWorkflowDraft } from '@/service/workflow' -import { downloadBlob } from '@/utils/download' import { useNodesSyncDraftByCanEdit } from './use-nodes-sync-draft' type DoSyncWorkflowDraft = ReturnType['doSyncWorkflowDraft'] @@ -28,13 +27,12 @@ const useDSLBase = (doSyncWorkflowDraft: DoSyncWorkflowDraft) => { try { setExporting(true) await doSyncWorkflowDraft() - const { data } = await exportAppConfig({ - appID: appDetail.id, - include, - workflowID: workflowId, + await exportAppDslFile({ + appId: appDetail.id, + appName: appDetail.name, + includeSecret: include, + workflowId, }) - const file = new Blob([data], { type: 'application/yaml' }) - downloadBlob({ data: file, fileName: `${appDetail.name}.yml` }) } catch { toast.error(t(($) => $.exportFailed, { ns: 'app' })) } finally { diff --git a/web/app/components/workflow/__tests__/update-dsl-modal.spec.tsx b/web/app/components/workflow/__tests__/update-dsl-modal.spec.tsx index afc95679c55..f3e6379dc58 100644 --- a/web/app/components/workflow/__tests__/update-dsl-modal.spec.tsx +++ b/web/app/components/workflow/__tests__/update-dsl-modal.spec.tsx @@ -32,9 +32,17 @@ vi.mock('@/app/notifications', () => ({ const mockImportDSL = vi.fn() const mockImportDSLConfirm = vi.fn() -vi.mock('@/service/apps', () => ({ - importDSL: (payload: unknown) => mockImportDSL(payload), - importDSLConfirm: (payload: unknown) => mockImportDSLConfirm(payload), +vi.mock('@/service/console', () => ({ + consoleClient: { + apps: { + imports: { + post: ({ body }: { body: unknown }) => mockImportDSL(body), + byImportId: { + confirm: { post: ({ params }: { params: unknown }) => mockImportDSLConfirm(params) }, + }, + }, + }, + }, })) const mockFetchWorkflowDraft = vi.fn() @@ -115,6 +123,16 @@ describe('UpdateDSLModal', () => { ) } + it('uploads an ifpkg without decoding it as YAML when overwriting a workflow', async () => { + mockImportDSL.mockResolvedValue({ status: DSLImportStatus.COMPLETED, app_id: 'app-1' }) + render() + const file = new File([new Uint8Array([0x50, 0x4b, 0xff])], 'workflow.IFPKG') + fireEvent.change(screen.getByTestId('dsl-file-input'), { target: { files: [file] } }) + fireEvent.click(screen.getByRole('button', { name: 'workflow.common.overwriteAndImport' })) + await waitFor(() => expect(mockImportDSL).toHaveBeenCalledWith({ file, app_id: 'app-1' })) + await waitFor(() => expect(defaultProps.onCancel).toHaveBeenCalled()) + }) + it('should keep import disabled until a file is selected', () => { renderModal() diff --git a/web/app/components/workflow/update-dsl-modal.helpers.ts b/web/app/components/workflow/update-dsl-modal.helpers.ts index ad257b441b3..67a6563cd5b 100644 --- a/web/app/components/workflow/update-dsl-modal.helpers.ts +++ b/web/app/components/workflow/update-dsl-modal.helpers.ts @@ -1,3 +1,4 @@ +import type { Import } from '@dify/contracts/api/console/apps/types.gen' import type { TFunction } from 'i18next' import type { CommonNodeType, Node } from './types' import { FILE_EXTS } from '@/app/components/base/prompt-editor/constants' @@ -68,12 +69,12 @@ export const validateDSLContent = (content: string, mode?: AppModeEnum) => { } } -export const isImportCompleted = (status: DSLImportStatus) => { +export const isImportCompleted = (status: Import['status']) => { return status === DSLImportStatus.COMPLETED || status === DSLImportStatus.COMPLETED_WITH_WARNINGS } export const getImportNotificationPayload = ( - status: DSLImportStatus, + status: Import['status'], t: TFunction, ): ImportNotificationPayload => { return { diff --git a/web/app/components/workflow/update-dsl-modal.tsx b/web/app/components/workflow/update-dsl-modal.tsx index 31901e4d222..c6009125fa5 100644 --- a/web/app/components/workflow/update-dsl-modal.tsx +++ b/web/app/components/workflow/update-dsl-modal.tsx @@ -1,7 +1,7 @@ 'use client' +import type { Import } from '@dify/contracts/api/console/apps/types.gen' import type { MouseEventHandler } from 'react' -import type { DSLImportWarning } from '@/models/app' import { Button } from '@langgenius/dify-ui/button' import { Dialog, DialogContent } from '@langgenius/dify-ui/dialog' import { RiAlertFill, RiCloseLine, RiFileDownloadLine } from '@remixicon/react' @@ -14,7 +14,7 @@ import { usePluginDependencies } from '@/app/components/workflow/plugin-dependen import { toast } from '@/app/notifications' import { useEventEmitterContextContext } from '@/context/event-emitter' import { DSLImportMode, DSLImportStatus } from '@/models/app' -import { importDSL, importDSLConfirm } from '@/service/apps' +import { consoleClient } from '@/service/console' import { fetchWorkflowDraft } from '@/service/workflow' import { collaborationManager } from './collaboration/core/collaboration-manager' import { WORKFLOW_DATA_UPDATE } from './constants' @@ -56,8 +56,8 @@ const UpdateDSLModal = ({ onCancel, onBackup, onImport }: UpdateDSLModalProps) = const handleFile = (file?: File) => { setDSLFile(file) - if (file) readFile(file) - if (!file) setFileContent('') + setFileContent('') + if (file && !file.name.toLowerCase().endsWith('.ifpkg')) readFile(file) } const handleWorkflowUpdate = useCallback( @@ -84,7 +84,7 @@ const UpdateDSLModal = ({ onCancel, onBackup, onImport }: UpdateDSLModalProps) = const isCreatingRef = useRef(false) const handleCompletedImport = useCallback( - async (status: DSLImportStatus, appId?: string, warnings: DSLImportWarning[] = []) => { + async (status: Import['status'], appId?: string | null, warnings: Import['warnings'] = []) => { if (!appId) { toast.error(t(($) => $['common.importFailure'], { ns: 'workflow' })) return @@ -134,12 +134,16 @@ const UpdateDSLModal = ({ onCancel, onBackup, onImport }: UpdateDSLModalProps) = return } try { - if (appDetail && fileContent && validateDSLContent(fileContent, appDetail.mode)) { + const isPackage = currentFile.name.toLowerCase().endsWith('.ifpkg') + if ( + appDetail && + (isPackage || (fileContent && validateDSLContent(fileContent, appDetail.mode))) + ) { setLoading(true) - const response = await importDSL({ - mode: DSLImportMode.YAML_CONTENT, - yaml_content: fileContent, - app_id: appDetail.id, + const response = await consoleClient.apps.imports.post({ + body: isPackage + ? { file: currentFile, app_id: appDetail.id } + : { mode: DSLImportMode.YAML_CONTENT, yaml_content: fileContent, app_id: appDetail.id }, }) const { id, status, app_id, imported_dsl_version, current_dsl_version, warnings } = response @@ -164,8 +168,8 @@ const UpdateDSLModal = ({ onCancel, onBackup, onImport }: UpdateDSLModalProps) = const onUpdateDSLConfirm: MouseEventHandler = async () => { try { if (!importId) return - const response = await importDSLConfirm({ - import_id: importId, + const response = await consoleClient.apps.imports.byImportId.confirm.post({ + params: { import_id: importId }, }) const { status, app_id, warnings } = response @@ -228,7 +232,12 @@ const UpdateDSLModal = ({ onCancel, onBackup, onImport }: UpdateDSLModalProps) = {t(($) => $['common.chooseDSL'], { ns: 'workflow' })}
- +
diff --git a/web/models/app.ts b/web/models/app.ts index 1ad5360d10a..a8e0f8d2151 100644 --- a/web/models/app.ts +++ b/web/models/app.ts @@ -11,8 +11,7 @@ import type { TracingProvider, WeaveConfig, } from '@/app/(commonLayout)/app/(appDetailLayout)/[appId]/overview/tracing/type' -import type { Dependency } from '@/app/components/plugins/types' -import type { App, AppModeEnum } from '@/types/app' +import type { App } from '@/types/app' export const DSLImportMode = { YAML_CONTENT: 'yaml-content', @@ -28,28 +27,8 @@ export const DSLImportStatus = { } as const export type DSLImportStatus = (typeof DSLImportStatus)[keyof typeof DSLImportStatus] -export type DSLImportWarning = { - code: string - path: string - message: string - details: Record -} - export type AppDetailResponse = App -export type DSLImportResponse = { - id: string - status: DSLImportStatus - app_mode: AppModeEnum - app_id?: string - current_dsl_version?: string - imported_dsl_version?: string - error: string - leaked_dependencies: Dependency[] - permission_keys: string[] - warnings?: DSLImportWarning[] -} - export type UpdateAppModelConfigResponse = { result: string } export type WorkflowOnlineUser = { diff --git a/web/service/apps.ts b/web/service/apps.ts index 23098ccc569..b86323e71ba 100644 --- a/web/service/apps.ts +++ b/web/service/apps.ts @@ -1,8 +1,6 @@ import type { TracingProvider } from '@/app/(commonLayout)/app/(appDetailLayout)/[appId]/overview/tracing/type' import type { AppDetailResponse, - DSLImportMode, - DSLImportResponse, TracingConfig, TracingStatus, UpdateAppModelConfigResponse, @@ -85,66 +83,6 @@ export const updateAppInfo = ({ return put(`apps/${appID}`, { body }) } -export const exportAppConfig = ({ - appID, - include = false, - workflowID, -}: { - appID: string - include?: boolean - workflowID?: string -}): Promise<{ data: string }> => { - const params = new URLSearchParams({ - include_secret: include.toString(), - }) - if (workflowID) params.append('workflow_id', workflowID) - return get<{ data: string }>(`apps/${appID}/export?${params.toString()}`) -} - -export const importDSL = ({ - mode, - yaml_content, - yaml_url, - app_id, - name, - description, - icon_type, - icon, - icon_background, -}: { - mode: DSLImportMode - yaml_content?: string - yaml_url?: string - app_id?: string - name?: string - description?: string - icon_type?: AppIconType - icon?: string - icon_background?: string -}): Promise => { - return post('apps/imports', { - body: { - mode, - yaml_content, - yaml_url, - app_id, - name, - description, - icon, - icon_type, - icon_background, - }, - }) -} - -export const importDSLConfirm = ({ - import_id, -}: { - import_id: string -}): Promise => { - return post(`apps/imports/${import_id}/confirm`, { body: {} }) -} - export const deleteApp = (appID: string): Promise => { return del(`apps/${appID}`) } diff --git a/web/service/console/client.spec.ts b/web/service/console/client.spec.ts index e954aaf1751..59c6bd75114 100644 --- a/web/service/console/client.spec.ts +++ b/web/service/console/client.spec.ts @@ -199,33 +199,37 @@ describe('consoleQuery transport context', () => { vi.restoreAllMocks() }) - it('uploads ifpkg imports as multipart files without decoding their bytes as YAML', async () => { - const bytes = new Uint8Array([0x50, 0x4b, 0x03, 0x04, 0x00, 0xff]) - const file = new File([bytes], 'agent.ifpkg', { type: 'application/zip' }) - const request = vi.fn().mockResolvedValue( - new Response(JSON.stringify({ id: 'import-1', status: 'completed' }), { - status: 200, - headers: { 'content-type': 'application/json' }, - }), - ) - const consoleQuery = await loadConsoleQueryWithRequest(request) - const mutation = new MutationObserver( - new QueryClient(), - consoleQuery.apps.imports.post.mutationOptions(), - ) - await mutation.mutate({ body: { file } }) + it.each([undefined, 'existing-workflow'])( + 'uploads ifpkg bytes with overwrite target %s', + async (appId) => { + const bytes = new Uint8Array([0x50, 0x4b, 0x03, 0x04, 0x00, 0xff]) + const file = new File([bytes], 'agent.ifpkg', { type: 'application/zip' }) + const request = vi.fn().mockResolvedValue( + new Response(JSON.stringify({ id: 'import-1', status: 'completed' }), { + status: 200, + headers: { 'content-type': 'application/json' }, + }), + ) + const consoleQuery = await loadConsoleQueryWithRequest(request) + const mutation = new MutationObserver( + new QueryClient(), + consoleQuery.apps.imports.post.mutationOptions(), + ) + await mutation.mutate({ body: { file, ...(appId ? { app_id: appId } : {}) } }) - const outgoing = request.mock.calls[0]?.[2]?.request as Request - expect(outgoing.url).toContain('/apps/imports') - expect(outgoing.headers.get('content-type')).toContain('multipart/form-data; boundary=') - const form = await outgoing.formData() - expect(Array.from(form.keys())).toEqual(['file']) - const uploaded = form.get('file') - expect(uploaded).toBeInstanceOf(File) - if (!(uploaded instanceof File)) throw new TypeError('Expected an uploaded archive') - expect(uploaded.name).toBe('agent.ifpkg') - expect(new Uint8Array(await uploaded.arrayBuffer())).toEqual(bytes) - }) + const outgoing = request.mock.calls[0]?.[2]?.request as Request + expect(outgoing.url).toContain('/apps/imports') + expect(outgoing.headers.get('content-type')).toContain('multipart/form-data; boundary=') + const form = await outgoing.formData() + expect(Array.from(form.keys()).sort()).toEqual(appId ? ['app_id', 'file'] : ['file']) + expect(form.get('app_id')).toBe(appId ?? null) + const uploaded = form.get('file') + expect(uploaded).toBeInstanceOf(File) + if (!(uploaded instanceof File)) throw new TypeError('Expected an uploaded archive') + expect(uploaded.name).toBe('agent.ifpkg') + expect(new Uint8Array(await uploaded.arrayBuffer())).toEqual(bytes) + }, + ) it('preserves archive bytes and the download filename for App exports', async () => { const bytes = new Uint8Array([0x50, 0x4b, 0x03, 0x04, 0x00, 0xff]) From 8e5b09701134f148c674fe7cad9f70c87d1c9d0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E7=8E=AE=20=28Jade=20Lin=29?= Date: Sun, 20 Sep 2026 09:19:51 +0000 Subject: [PATCH 04/37] fix(api): remove omitted tenant default models (#42572) Co-authored-by: Joel --- api/controllers/console/workspace/models.py | 30 ++- api/core/entities/model_entities.py | 6 + api/core/provider_manager.py | 57 ++++-- api/services/model_provider_service.py | 9 +- .../console/workspace/test_models.py | 91 ++++++++- .../unit_tests/core/test_provider_manager.py | 151 +++++++++++++++ oxlint-suppressions.json | 2 +- .../model-provider-page/hooks.ts | 10 +- .../__tests__/model-selector-trigger.spec.tsx | 59 ++++++ .../model-selector/index.tsx | 6 + .../model-selector/model-selector-trigger.tsx | 47 ++++- .../__tests__/index.spec.tsx | 173 ++++++++++++++++-- .../system-model-selector/index.tsx | 94 +++++++--- web/service/common.ts | 10 - 14 files changed, 653 insertions(+), 92 deletions(-) diff --git a/api/controllers/console/workspace/models.py b/api/controllers/console/workspace/models.py index 463b9e65f5e..85488610667 100644 --- a/api/controllers/console/workspace/models.py +++ b/api/controllers/console/workspace/models.py @@ -23,6 +23,7 @@ from controllers.console.wraps import ( with_current_tenant_id, with_current_user, ) +from core.entities.model_entities import DefaultModelSetting from core.entities.provider_entities import CredentialConfiguration from extensions.ext_database import db from fields.base import ResponseModel @@ -233,25 +234,16 @@ class DefaultModelApi(Resource): @model_validate(ParserPostDefault) def post(self, req_data: ParserPostDefault, tenant_id: str): model_provider_service = ModelProviderService() - model_settings = req_data.model_settings - for model_setting in model_settings: - if model_setting.provider is None: - continue - - try: - model_provider_service.update_default_model_of_model_type( - tenant_id=tenant_id, - model_type=model_setting.model_type, - provider=model_setting.provider, - model=cast(str, model_setting.model), - ) - except Exception as ex: - logger.exception( - "Failed to update default model, model type: %s, model: %s", - model_setting.model_type, - model_setting.model, - ) - raise ex + model_settings = [ + DefaultModelSetting( + model_type=setting.model_type, + provider=setting.provider, + model=setting.model, + ) + for setting in req_data.model_settings + if setting.provider is not None and setting.model is not None + ] + model_provider_service.update_default_models(tenant_id=tenant_id, model_settings=model_settings) return SimpleResultResponse(result="success").model_dump(mode="json") diff --git a/api/core/entities/model_entities.py b/api/core/entities/model_entities.py index 4aa4c61cafb..cfd90739460 100644 --- a/api/core/entities/model_entities.py +++ b/api/core/entities/model_entities.py @@ -116,3 +116,9 @@ class DefaultModelEntity(BaseModel): # pydantic configs model_config = ConfigDict(protected_namespaces=()) + + +class DefaultModelSetting(BaseModel): + model_type: ModelType + provider: str + model: str diff --git a/api/core/provider_manager.py b/api/core/provider_manager.py index e4b39ff7189..837beffc37c 100644 --- a/api/core/provider_manager.py +++ b/api/core/provider_manager.py @@ -16,7 +16,7 @@ from sqlalchemy.exc import IntegrityError from configs import dify_config from core.db.session_factory import session_factory -from core.entities.model_entities import DefaultModelEntity, DefaultModelProviderEntity +from core.entities.model_entities import DefaultModelEntity, DefaultModelProviderEntity, DefaultModelSetting from core.entities.provider_configuration import ProviderConfiguration, ProviderConfigurations, ProviderModelBundle from core.entities.provider_entities import ( CredentialConfiguration, @@ -930,16 +930,7 @@ class ProviderManager: :return: """ provider_configurations = self.get_configurations(tenant_id) - if provider not in provider_configurations: - raise ValueError(f"Provider {provider} does not exist.") - - # get available models from provider_configurations - available_models = provider_configurations.get_models(model_type=model_type, only_active=True) - - # check if the model is exist in available models - model_names = [model.model for model in available_models] - if model not in model_names: - raise ValueError(f"Model {model} does not exist.") + self._validate_default_model(provider_configurations, model_type, provider, model) stmt = select(TenantDefaultModel).where( TenantDefaultModel.tenant_id == tenant_id, TenantDefaultModel.model_type == model_type, @@ -965,6 +956,50 @@ class ProviderManager: return default_model + def replace_default_model_records(self, tenant_id: str, model_settings: Sequence[DefaultModelSetting]) -> None: + """Replace a tenant's defaults atomically, deleting model types omitted from the settings.""" + if model_settings: + provider_configurations = self.get_configurations(tenant_id) + # Provider resolution can perform external I/O, so validate before opening the write transaction. + for setting in model_settings: + self._validate_default_model( + provider_configurations, setting.model_type, setting.provider, setting.model + ) + + settings_by_type = {setting.model_type: setting for setting in model_settings} + with session_factory.create_session() as session, session.begin(): + default_models = session.scalars( + select(TenantDefaultModel).where(TenantDefaultModel.tenant_id == tenant_id) + ) + for default_model in default_models: + replacement = settings_by_type.pop(default_model.model_type, None) + if replacement is None: + session.delete(default_model) + else: + default_model.provider_name = replacement.provider + default_model.model_name = replacement.model + + session.add_all( + TenantDefaultModel( + tenant_id=tenant_id, + model_type=setting.model_type, + provider_name=setting.provider, + model_name=setting.model, + ) + for setting in settings_by_type.values() + ) + + @staticmethod + def _validate_default_model( + provider_configurations: ProviderConfigurations, model_type: ModelType, provider: str, model: str + ) -> None: + if provider not in provider_configurations: + raise ValueError(f"Provider {provider} does not exist.") + + available_models = provider_configurations.get_models(model_type=model_type, only_active=True) + if model not in [available_model.model for available_model in available_models]: + raise ValueError(f"Model {model} does not exist.") + @staticmethod def _get_all_providers(tenant_id: str) -> dict[str, list[Provider]]: provider_name_to_provider_records_dict = defaultdict(list) diff --git a/api/services/model_provider_service.py b/api/services/model_provider_service.py index 4804af7e508..ea052a348fa 100644 --- a/api/services/model_provider_service.py +++ b/api/services/model_provider_service.py @@ -1,5 +1,6 @@ import logging from collections import defaultdict +from collections.abc import Sequence from dataclasses import dataclass, field from typing import TYPE_CHECKING, Any @@ -10,7 +11,7 @@ if TYPE_CHECKING: from configs import dify_config from core.db.session_factory import session_factory -from core.entities.model_entities import ModelWithProviderEntity, ProviderModelWithStatusEntity +from core.entities.model_entities import DefaultModelSetting, ModelWithProviderEntity, ProviderModelWithStatusEntity from core.entities.provider_entities import CredentialConfiguration from core.helper.position_helper import is_filtered from core.plugin.entities.plugin import PluginInstallationSource @@ -852,6 +853,12 @@ class ModelProviderService: tenant_id=tenant_id, model_type=model_type_enum, provider=provider, model=model ) + def update_default_models(self, tenant_id: str, model_settings: Sequence[DefaultModelSetting]) -> None: + """Replace all configured default models for the workspace.""" + self._get_provider_manager(tenant_id).replace_default_model_records( + tenant_id=tenant_id, model_settings=model_settings + ) + def get_model_provider_icon( self, tenant_id: str, provider: str, icon_type: str, lang: str ) -> tuple[bytes | None, str | None]: diff --git a/api/tests/unit_tests/controllers/console/workspace/test_models.py b/api/tests/unit_tests/controllers/console/workspace/test_models.py index 38f4d21db0d..d67f7122bef 100644 --- a/api/tests/unit_tests/controllers/console/workspace/test_models.py +++ b/api/tests/unit_tests/controllers/console/workspace/test_models.py @@ -1,8 +1,10 @@ from inspect import unwrap -from unittest.mock import patch +from unittest.mock import MagicMock, Mock, patch import pytest from flask import Flask +from sqlalchemy import select +from sqlalchemy.orm import Session from controllers.console.workspace.models import ( DefaultModelApi, @@ -25,9 +27,12 @@ from controllers.console.workspace.models import ( ParserSwitch, ParserValidate, ) +from core.entities.model_entities import DefaultModelSetting +from core.provider_manager import ProviderManager from graphon.model_runtime.entities.model_entities import ModelType from graphon.model_runtime.errors.validate import CredentialsValidateFailedError from models import Account +from models.provider import TenantDefaultModel from tests.unit_tests.model_factories import make_account @@ -78,11 +83,93 @@ class TestDefaultModelApi: with ( app.test_request_context("/", json=payload), - patch("controllers.console.workspace.models.ModelProviderService"), + patch("controllers.console.workspace.models.ModelProviderService") as service, ): result = method(api, ParserPostDefault.model_validate(payload), "tenant1") assert result["result"] == "success" + service.return_value.update_default_models.assert_called_once_with( + tenant_id="tenant1", + model_settings=[DefaultModelSetting(model_type=ModelType.LLM, provider="openai", model="gpt-4")], + ) + + @pytest.mark.parametrize( + "cleared_setting", + [ + None, + {"model_type": ModelType.TEXT_EMBEDDING}, + {"model_type": ModelType.TEXT_EMBEDDING, "provider": None, "model": None}, + {"model_type": ModelType.TEXT_EMBEDDING, "model": "text-embedding-3-small"}, + {"model_type": ModelType.TEXT_EMBEDDING, "provider": "openai"}, + ], + ) + def test_post_removes_unconfigured_defaults( + self, app: Flask, sqlite_session: Session, cleared_setting: dict[str, str | None] | None + ) -> None: + sqlite_session.add_all( + [ + TenantDefaultModel( + tenant_id="tenant1", + model_type=ModelType.TEXT_EMBEDDING, + provider_name="openai", + model_name="text-embedding-3-small", + ), + TenantDefaultModel( + tenant_id="other-tenant", + model_type=ModelType.TEXT_EMBEDDING, + provider_name="openai", + model_name="text-embedding-3-small", + ), + ] + ) + sqlite_session.commit() + model_settings: list[dict[str, str | None]] = [ + {"model_type": ModelType.LLM, "provider": "openai", "model": "gpt-4"} + ] + if cleared_setting is not None: + model_settings.append(cleared_setting) + payload = ParserPostDefault.model_validate({"model_settings": model_settings}) + manager = ProviderManager(model_runtime=Mock()) + configurations = MagicMock() + configurations.__contains__.return_value = True + configurations.get_models.return_value = [Mock(model="gpt-4")] + api = DefaultModelApi() + + with ( + app.test_request_context("/"), + patch("services.model_provider_service.create_plugin_provider_manager", return_value=manager), + patch.object(manager, "get_configurations", return_value=configurations), + ): + result = unwrap(api.post)(api, payload, "tenant1") + + assert result["result"] == "success" + sqlite_session.expire_all() + assert { + (record.tenant_id, record.model_type, record.model_name) + for record in sqlite_session.scalars(select(TenantDefaultModel)) + } == { + ("tenant1", ModelType.LLM, "gpt-4"), + ("other-tenant", ModelType.TEXT_EMBEDDING, "text-embedding-3-small"), + } + + def test_post_empty_settings_clears_defaults(self, app: Flask, sqlite_session: Session) -> None: + sqlite_session.add( + TenantDefaultModel( + tenant_id="tenant1", model_type=ModelType.LLM, provider_name="openai", model_name="gpt-4" + ) + ) + sqlite_session.commit() + manager = ProviderManager(model_runtime=Mock()) + api = DefaultModelApi() + + with ( + app.test_request_context("/"), + patch("services.model_provider_service.create_plugin_provider_manager", return_value=manager), + ): + result = unwrap(api.post)(api, ParserPostDefault(model_settings=[]), "tenant1") + + assert result["result"] == "success" + assert sqlite_session.scalar(select(TenantDefaultModel)) is None def test_get_returns_empty_when_no_default(self, app: Flask): api = DefaultModelApi() diff --git a/api/tests/unit_tests/core/test_provider_manager.py b/api/tests/unit_tests/core/test_provider_manager.py index bb40efc0ae9..8f364f37f90 100644 --- a/api/tests/unit_tests/core/test_provider_manager.py +++ b/api/tests/unit_tests/core/test_provider_manager.py @@ -9,6 +9,7 @@ from sqlalchemy import Engine, event, select from sqlalchemy.orm import Session, sessionmaker from core import provider_manager as provider_manager_module +from core.entities.model_entities import DefaultModelSetting from core.entities.provider_entities import ( CustomConfiguration, CustomProviderConfiguration, @@ -973,6 +974,156 @@ def test_update_default_model_record_creates_record_with_origin_model_type(provi assert {record.tenant_id for record in persisted_defaults} == {"tenant-id", "other-tenant"} +@pytest.mark.parametrize("clear_all", [False, True]) +def test_replace_default_model_records_removes_omitted_types_only_for_current_tenant( + provider_db: Session, clear_all: bool +) -> None: + manager = _build_provider_manager() + existing_default = TenantDefaultModel( + tenant_id="tenant-id", + provider_name="anthropic", + model_name="claude-3-sonnet", + model_type=ModelType.LLM, + ) + omitted_default = TenantDefaultModel( + tenant_id="tenant-id", + provider_name="openai", + model_name="text-embedding-3-small", + model_type=ModelType.TEXT_EMBEDDING, + ) + other_tenant_default = TenantDefaultModel( + tenant_id="other-tenant", + provider_name="openai", + model_name="text-embedding-3-small", + model_type=ModelType.TEXT_EMBEDDING, + ) + provider_db.add_all([existing_default, omitted_default, other_tenant_default]) + provider_db.commit() + configurations = MagicMock() + configurations.__contains__.return_value = True + configurations.get_models.side_effect = lambda model_type, **_kwargs: { + ModelType.LLM: [Mock(model="gpt-4")], + ModelType.RERANK: [Mock(model="rerank-v3")], + }[model_type] + settings = ( + [] + if clear_all + else [ + DefaultModelSetting(model_type=ModelType.LLM, provider="openai", model="gpt-4"), + DefaultModelSetting(model_type=ModelType.RERANK, provider="cohere", model="rerank-v3"), + ] + ) + + with patch.object(manager, "get_configurations", return_value=configurations) as get_configurations: + manager.replace_default_model_records("tenant-id", settings) + + provider_db.expire_all() + defaults = list(provider_db.scalars(select(TenantDefaultModel))) + expected_defaults = {("other-tenant", ModelType.TEXT_EMBEDDING, "openai", "text-embedding-3-small")} + expected_defaults.update(("tenant-id", setting.model_type, setting.provider, setting.model) for setting in settings) + assert { + (record.tenant_id, record.model_type, record.provider_name, record.model_name) for record in defaults + } == expected_defaults + if clear_all: + get_configurations.assert_not_called() + else: + persisted_default = provider_db.get(TenantDefaultModel, existing_default.id) + assert persisted_default is not None + assert persisted_default.model_name == "gpt-4" + + +@pytest.mark.parametrize( + ("provider", "model", "error"), + [ + ("missing-provider", "text-embedding-3-small", "Provider missing-provider does not exist"), + ("openai", "missing-model", "Model missing-model does not exist"), + ], +) +def test_replace_default_model_records_preserves_defaults_when_validation_fails( + provider_db: Session, provider: str, model: str, error: str +) -> None: + manager = _build_provider_manager() + existing_defaults = [ + TenantDefaultModel( + tenant_id="tenant-id", provider_name="anthropic", model_name="claude-3-sonnet", model_type=ModelType.LLM + ), + TenantDefaultModel( + tenant_id="tenant-id", provider_name="cohere", model_name="rerank-v3", model_type=ModelType.RERANK + ), + ] + provider_db.add_all(existing_defaults) + provider_db.commit() + original_defaults = {(record.id, record.provider_name, record.model_name) for record in existing_defaults} + configurations = MagicMock() + configurations.__contains__.side_effect = lambda name: name == "openai" + configurations.get_models.side_effect = lambda model_type, **_kwargs: { + ModelType.LLM: [Mock(model="gpt-4")], + ModelType.TEXT_EMBEDDING: [Mock(model="text-embedding-3-small")], + }[model_type] + + with ( + patch.object(manager, "get_configurations", return_value=configurations), + pytest.raises(ValueError, match=error), + ): + manager.replace_default_model_records( + "tenant-id", + [ + DefaultModelSetting(model_type=ModelType.LLM, provider="openai", model="gpt-4"), + DefaultModelSetting(model_type=ModelType.TEXT_EMBEDDING, provider=provider, model=model), + ], + ) + + provider_db.expire_all() + assert { + (record.id, record.provider_name, record.model_name) + for record in provider_db.scalars(select(TenantDefaultModel)) + } == original_defaults + + +def test_replace_default_model_records_rolls_back_when_persistence_fails(provider_db: Session) -> None: + manager = _build_provider_manager() + existing_defaults = [ + TenantDefaultModel( + tenant_id="tenant-id", provider_name="anthropic", model_name="claude-3-sonnet", model_type=ModelType.LLM + ), + TenantDefaultModel( + tenant_id="tenant-id", provider_name="cohere", model_name="rerank-v3", model_type=ModelType.RERANK + ), + ] + provider_db.add_all(existing_defaults) + provider_db.commit() + original_defaults = {(record.id, record.provider_name, record.model_name) for record in existing_defaults} + configurations = MagicMock() + configurations.__contains__.return_value = True + configurations.get_models.return_value = [Mock(model="gpt-4"), Mock(model="text-embedding-3-small")] + + def fail_after_flush(_session: Session, _flush_context: object) -> None: + raise RuntimeError("Persistence failed") + + with Session(bind=provider_db.get_bind()) as write_session: + event.listen(write_session, "after_flush", fail_after_flush) + with ( + patch.object(manager, "get_configurations", return_value=configurations), + patch.object(provider_manager_module.session_factory, "create_session", return_value=write_session), + pytest.raises(RuntimeError, match="Persistence failed"), + ): + manager.replace_default_model_records( + "tenant-id", + [ + DefaultModelSetting(model_type=ModelType.LLM, provider="openai", model="gpt-4"), + DefaultModelSetting( + model_type=ModelType.TEXT_EMBEDDING, provider="openai", model="text-embedding-3-small" + ), + ], + ) + + provider_db.expire_all() + assert { + (record.id, record.provider_name, record.model_name) + for record in provider_db.scalars(select(TenantDefaultModel)) + } == original_defaults + + def test_get_all_providers_normalizes_provider_names_with_model_provider_id(provider_db: Session) -> None: openai_provider = Provider( tenant_id="tenant-id", diff --git a/oxlint-suppressions.json b/oxlint-suppressions.json index 4bdd3ebfec8..ee49b34c4e0 100644 --- a/oxlint-suppressions.json +++ b/oxlint-suppressions.json @@ -5303,7 +5303,7 @@ "count": 1 }, "typescript/no-explicit-any": { - "count": 6 + "count": 5 } }, "web/service/datasets.ts": { 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 6729ba706db..66c633886f0 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 @@ -32,7 +32,7 @@ import { CustomConfigurationStatusEnum, ModelStatusEnum, ModelTypeEnum } from '. type UseDefaultModelAndModelList = ( defaultModel: DefaultModelResponse | undefined, modelList: ProviderWithModelsResponse[], -) => [DefaultModel | undefined, (model: DefaultModel) => void] +) => [DefaultModel | undefined, (model: DefaultModel | undefined) => void, () => void] export const useSystemDefaultModelAndModelList: UseDefaultModelAndModelList = ( defaultModel, modelList, @@ -68,14 +68,18 @@ export const useSystemDefaultModelAndModelList: UseDefaultModelAndModelList = ( defaultModelSourceKey === currentDefaultModelKey ? defaultModelState : currentDefaultModel const handleDefaultModelChange = useCallback( - (model: DefaultModel) => { + (model: DefaultModel | undefined) => { setDefaultModelSourceKey(currentDefaultModelKey) setDefaultModelState(model) }, [currentDefaultModelKey], ) - return [selectedDefaultModel, handleDefaultModelChange] + return [ + selectedDefaultModel, + handleDefaultModelChange, + () => handleDefaultModelChange(currentDefaultModel), + ] } export const useLanguage = () => { diff --git a/web/app/components/header/account-setting/model-provider-page/model-selector/__tests__/model-selector-trigger.spec.tsx b/web/app/components/header/account-setting/model-provider-page/model-selector/__tests__/model-selector-trigger.spec.tsx index 21777436d45..4c2300f55de 100644 --- a/web/app/components/header/account-setting/model-provider-page/model-selector/__tests__/model-selector-trigger.spec.tsx +++ b/web/app/components/header/account-setting/model-provider-page/model-selector/__tests__/model-selector-trigger.spec.tsx @@ -149,6 +149,65 @@ describe('ModelSelectorTrigger', () => { }) }) + describe('Clearing the selection', () => { + it('clears without opening the model picker or submitting the containing form', async () => { + const user = userEvent.setup() + const onClear = vi.fn() + const onOpenChange = vi.fn() + const onSubmit = vi.fn((event) => event.preventDefault()) + renderComponent( +
+ + + +
, + ) + + await user.click(screen.getByRole('button', { name: 'Reset model' })) + + expect(onClear).toHaveBeenCalledTimes(1) + expect(onOpenChange).not.toHaveBeenCalled() + expect(onSubmit).not.toHaveBeenCalled() + await user.click(getTrigger()) + expect(onOpenChange).toHaveBeenCalledWith(true, expect.anything()) + }) + + it.each([{ disabled: true }, { loading: true }])( + 'prevents clearing when unavailable: %o', + async (props) => { + const user = userEvent.setup() + const onClear = vi.fn() + render( + , + ) + + const clearButton = screen.getByRole('button', { name: 'Reset model' }) + expect(clearButton).toBeDisabled() + await user.click(clearButton) + expect(onClear).not.toHaveBeenCalled() + }, + ) + + it('does not offer clear for an empty selection', () => { + render() + + expect(screen.queryByRole('button', { name: 'Reset model' })).not.toBeInTheDocument() + }) + }) + describe('Status Handling', () => { it('should show status badge when selected model is not active and enabled', () => { render( diff --git a/web/app/components/header/account-setting/model-provider-page/model-selector/index.tsx b/web/app/components/header/account-setting/model-provider-page/model-selector/index.tsx index 03194f327a4..669912065a9 100644 --- a/web/app/components/header/account-setting/model-provider-page/model-selector/index.tsx +++ b/web/app/components/header/account-setting/model-provider-page/model-selector/index.tsx @@ -31,6 +31,8 @@ type ModelSelectorBaseProps = { className?: string popupClassName?: string onValueChange?: (model: ModelSelectorValue) => void + onClear?: () => void + clearLabel?: string onHide?: () => void disabled?: boolean loading?: boolean @@ -57,6 +59,8 @@ function ModelSelectorRoot({ className, popupClassName, onValueChange, + onClear, + clearLabel, onHide, disabled, loading, @@ -142,6 +146,8 @@ function ModelSelectorRoot({ currentProvider={currentProvider} currentModel={currentModel} defaultModel={value} + onClear={onClear} + clearLabel={clearLabel} disabled={disabled || loading} loading={loading} size={size} diff --git a/web/app/components/header/account-setting/model-provider-page/model-selector/model-selector-trigger.tsx b/web/app/components/header/account-setting/model-provider-page/model-selector/model-selector-trigger.tsx index 0148368e5ac..7dc2da9f14d 100644 --- a/web/app/components/header/account-setting/model-provider-page/model-selector/model-selector-trigger.tsx +++ b/web/app/components/header/account-setting/model-provider-page/model-selector/model-selector-trigger.tsx @@ -1,5 +1,6 @@ import type { ModelSelectorModel, ModelSelectorProvider, ModelSelectorValue } from './types' import { cn } from '@langgenius/dify-ui/cn' +import { IconButton } from '@langgenius/dify-ui/icon-button' import { PopoverTrigger } from '@langgenius/dify-ui/popover' import { Tooltip, TooltipContent, TooltipTrigger } from '@langgenius/dify-ui/tooltip' import { useQuery } from '@tanstack/react-query' @@ -18,6 +19,8 @@ type ModelSelectorTriggerProps = { currentProvider?: ModelSelectorProvider currentModel?: ModelSelectorModel defaultModel?: ModelSelectorValue + onClear?: () => void + clearLabel?: string disabled?: boolean loading?: boolean size?: 'small' | 'medium' @@ -33,6 +36,8 @@ function ModelSelectorTrigger({ currentProvider, currentModel, defaultModel, + onClear, + clearLabel, disabled, loading = false, size = 'medium', @@ -45,6 +50,7 @@ function ModelSelectorTrigger({ }: ModelSelectorTriggerProps) { const { t } = useTranslation() + const showClear = !!defaultModel && !!onClear const isSelected = !!currentProvider && !!currentModel const isDeprecated = !isSelected && !!defaultModel const isEmpty = !isSelected && !defaultModel @@ -94,7 +100,7 @@ function ModelSelectorTrigger({ ? tooltipLabel : undefined - return ( + const trigger = ( } > - + {isEmpty ? ( @@ -201,7 +214,7 @@ function ModelSelectorTrigger({ )} {isDeprecated && !isStatusUnavailable && showDeprecatedWarnIcon && ( - + {statusLabel} @@ -210,7 +223,7 @@ function ModelSelectorTrigger({ )} - {!isDisabled && shape !== 'split' && (isActive || isEmpty) && ( + {!isDisabled && shape !== 'split' && (