Skip to content

armgit / dify

Public Imported from GitHub
0

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

fix(api): handle invalid app icon references (#41977)

林玮 (Jade Lin)0c443b766661
diff --git a/api/services/app_dsl_service.py b/api/services/app_dsl_service.py
index de501b83ca2..9bc467fcd6a 100644
--- a/api/services/app_dsl_service.py
+++ b/api/services/app_dsl_service.py
@@ -62,6 +62,11 @@ from services.entities.dsl_entities import (
)
from services.errors.account import NoPermissionError
from services.errors.app import WorkflowNotFoundError
+from services.icon_configuration import (
+ DEFAULT_ICON,
+ DEFAULT_ICON_TYPE,
+ is_valid_image_icon,
+)
from services.plugin.dependencies_analysis import DependenciesAnalysisService
from services.workflow_draft_variable_service import WorkflowDraftVariableService
from services.workflow_service import WorkflowService
@@ -505,6 +510,10 @@ class AppDslService:
if app_mode == AppMode.AGENT:
self._ensure_agent_import_permission(account, app=app)
+ target_tenant_id = app.tenant_id if app is not None else account.current_tenant_id
+ if target_tenant_id is None:
+ raise ValueError("Current tenant is not set")
+
# Set icon type
icon_type_value = icon_type or app_data.get("icon_type")
resolved_icon_type: IconType
@@ -513,6 +522,14 @@ class AppDslService:
else:
resolved_icon_type = IconType.EMOJI
icon = icon or str(app_data.get("icon", ""))
+ if not is_valid_image_icon(
+ session=self._session,
+ tenant_id=target_tenant_id,
+ icon_type=resolved_icon_type,
+ icon=icon,
+ ):
+ resolved_icon_type = DEFAULT_ICON_TYPE
+ icon = DEFAULT_ICON
if app:
# Update existing app
@@ -524,13 +541,10 @@ class AppDslService:
app.updated_by = account.id
app.updated_at = naive_utc_now()
else:
- if account.current_tenant_id is None:
- raise ValueError("Current tenant is not set")
-
# Create new app
app = App()
app.id = import_app_id or str(uuid4())
- app.tenant_id = account.current_tenant_id
+ app.tenant_id = target_tenant_id
app.mode = app_mode
app.name = name or app_data.get("name", "")
app.description = description or app_data.get("description", "")
diff --git a/api/services/file_service.py b/api/services/file_service.py
index 9fe68ab75b3..ded70111e3d 100644
--- a/api/services/file_service.py
+++ b/api/services/file_service.py
@@ -30,7 +30,7 @@ from models import Account
from models.enums import CreatorUserRole
from models.model import EndUser, UploadFile
-from .errors.file import BlockedFileExtensionError, FileTooLargeError, UnsupportedFileTypeError
+from .errors.file import BlockedFileExtensionError, FileNotExistsError, FileTooLargeError, UnsupportedFileTypeError
PREVIEW_WORDS_LIMIT = 3000
@@ -171,14 +171,7 @@ class FileService:
def get_file_presigned_url(self, *, file_id: str, tenant_id: str) -> str:
"""Generate a direct storage URL for a tenant-owned upload file."""
with self._session_maker(expire_on_commit=False) as session:
- upload_file = session.scalar(
- select(UploadFile)
- .where(
- UploadFile.id == file_id,
- UploadFile.tenant_id == tenant_id,
- )
- .limit(1)
- )
+ upload_file = self.get_upload_file_by_id(tenant_id, file_id, session=session)
if upload_file is None:
raise NotFound("File not found")
@@ -192,10 +185,17 @@ class FileService:
)
def get_icon_url(self, file_id: str, tenant_id: str) -> str:
- if dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD and (
- StorageType(dify_config.STORAGE_TYPE) == StorageType.S3
- ):
- return self.get_file_presigned_url(file_id=file_id, tenant_id=tenant_id)
+ try:
+ if dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD and (
+ StorageType(dify_config.STORAGE_TYPE) == StorageType.S3
+ ):
+ return self.get_file_presigned_url(file_id=file_id, tenant_id=tenant_id)
+ with self._session_maker(expire_on_commit=False) as session:
+ upload_file = self.get_upload_file_by_id(tenant_id, file_id, session=session)
+ if upload_file is None:
+ raise NotFound("File not found")
+ except NotFound as exc:
+ raise FileNotExistsError("File reference not found") from exc
return file_helpers.get_signed_file_url(upload_file_id=file_id)
def upload_text(self, text: str, text_name: str, user_id: str, tenant_id: str) -> UploadFile:
@@ -271,6 +271,17 @@ class FileService:
storage.delete(upload_file.key)
session.delete(upload_file)
+ @staticmethod
+ def get_upload_file_by_id(tenant_id: str, upload_file_id: str, *, session: Session) -> UploadFile | None:
+ return session.scalar(
+ select(UploadFile)
+ .where(
+ UploadFile.tenant_id == tenant_id,
+ UploadFile.id == upload_file_id,
+ )
+ .limit(1)
+ )
+
@staticmethod
def get_upload_files_by_ids(
tenant_id: str, upload_file_ids: Sequence[str], *, session: Session
diff --git a/api/services/icon_configuration.py b/api/services/icon_configuration.py
new file mode 100644
index 00000000000..e403d51de5b
--- /dev/null
+++ b/api/services/icon_configuration.py
@@ -0,0 +1,40 @@
+from uuid import UUID
+
+from sqlalchemy import select
+from sqlalchemy.orm import Session
+
+from models.model import IconType, UploadFile
+
+DEFAULT_ICON_TYPE = IconType.EMOJI
+DEFAULT_ICON = "🤖"
+DEFAULT_ICON_BACKGROUND = "#FFEAD5"
+
+
+def is_valid_image_icon(
+ *,
+ session: Session,
+ tenant_id: str,
+ icon_type: IconType | str | None,
+ icon: str | None,
+) -> bool:
+ icon_type_value = icon_type.value if isinstance(icon_type, IconType) else icon_type
+ if icon_type_value != IconType.IMAGE.value:
+ return True
+
+ if not icon:
+ return False
+ try:
+ UUID(icon)
+ except ValueError:
+ return False
+ return (
+ session.scalar(
+ select(UploadFile.id)
+ .where(
+ UploadFile.id == icon,
+ UploadFile.tenant_id == tenant_id,
+ )
+ .limit(1)
+ )
+ is not None
+ )
diff --git a/api/services/web_app_runtime_query_service.py b/api/services/web_app_runtime_query_service.py
index 5b64c946be5..a8bf2ce3b68 100644
--- a/api/services/web_app_runtime_query_service.py
+++ b/api/services/web_app_runtime_query_service.py
@@ -1,13 +1,18 @@
"""Application service for building the public Web app runtime bootstrap."""
import json
+import logging
from collections.abc import Callable, Mapping
from typing import NamedTuple, Protocol, cast
from enums import DeploymentEdition
from services.app_definition_query_service import AppSiteConfiguration
from services.entities.feature_entities import FeatureModel
+from services.errors.file import FileNotExistsError
from services.file_service import FileService
+from services.icon_configuration import DEFAULT_ICON, DEFAULT_ICON_BACKGROUND, DEFAULT_ICON_TYPE
+
+logger = logging.getLogger(__name__)
class WebAppRuntimeRecord(NamedTuple):
@@ -65,14 +70,29 @@ class WebAppRuntimeQueryService:
raise WebAppRuntimeUnavailableError("Site not found")
features = self._workspace_features(record.tenant_id)
- site_icon_url = (
- self._file_service.get_icon_url(record.site.icon, record.tenant_id)
- if record.site.icon_type == "image" and record.site.icon
- else None
- )
+ site_icon_unavailable = False
+ try:
+ site_icon_url = (
+ self._file_service.get_icon_url(record.site.icon, record.tenant_id)
+ if record.site.icon_type == "image" and record.site.icon
+ else None
+ )
+ except FileNotExistsError as exc:
+ logger.warning(
+ "Web app site icon is unavailable: app_id=%s tenant_id=%s file_id=%s",
+ record.app_id,
+ record.tenant_id,
+ record.site.icon,
+ )
+ site_icon_url = None
+ site_icon_unavailable = True
site = cast(dict[str, str | bool | None], record.site._asdict())
site["icon_url"] = site_icon_url
+ if site_icon_unavailable:
+ site["icon_type"] = DEFAULT_ICON_TYPE.value
+ site["icon"] = DEFAULT_ICON
+ site["icon_background"] = DEFAULT_ICON_BACKGROUND
if self._deployment_edition == DeploymentEdition.CLOUD and not features.webapp_copyright_enabled:
site["copyright"] = None
site["input_placeholder"] = None
diff --git a/api/tests/test_containers_integration_tests/services/test_app_dsl_service.py b/api/tests/test_containers_integration_tests/services/test_app_dsl_service.py
index 05ea4111378..74f9572bb34 100644
--- a/api/tests/test_containers_integration_tests/services/test_app_dsl_service.py
+++ b/api/tests/test_containers_integration_tests/services/test_app_dsl_service.py
@@ -759,8 +759,8 @@ class TestAppDslService:
)
assert updated is app
assert app.name == "override-name"
- assert app.icon_type == IconType.IMAGE
- assert app.icon == "X"
+ assert app.icon_type == app_dsl_service.DEFAULT_ICON_TYPE
+ assert app.icon == app_dsl_service.DEFAULT_ICON
assert app.icon_background == "#222222"
assert app.updated_at is fixed_now
diff --git a/api/tests/unit_tests/controllers/web/test_site.py b/api/tests/unit_tests/controllers/web/test_site.py
index 8440796984a..8090a870785 100644
--- a/api/tests/unit_tests/controllers/web/test_site.py
+++ b/api/tests/unit_tests/controllers/web/test_site.py
@@ -6,7 +6,10 @@ from werkzeug.exceptions import Forbidden
from controllers.web import site as site_module
from services.app_definition_query_service import AppSiteConfiguration
-from services.web_app_runtime_query_service import WebAppBootstrap, WebAppRuntimeUnavailableError
+from services.web_app_runtime_query_service import (
+ WebAppBootstrap,
+ WebAppRuntimeUnavailableError,
+)
def _bootstrap() -> WebAppBootstrap:
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 da7efbe5acf..d736e14bbc4 100644
--- a/api/tests/unit_tests/services/test_app_dsl_service.py
+++ b/api/tests/unit_tests/services/test_app_dsl_service.py
@@ -453,6 +453,28 @@ def test_create_or_update_app_loads_existing_model_config_with_service_session(
assert [config.id for config in configs] == [app_model_config_id]
+def test_create_or_update_app_silently_discards_invalid_image_icon(sqlite_session: Session) -> None:
+ app = _app(tenant_id=_TENANT_ID)
+ service = AppDslService(session=sqlite_session)
+
+ result = service._create_or_update_app(
+ app=app,
+ data={
+ "app": {
+ "mode": AppMode.CHAT.value,
+ "icon_type": IconType.IMAGE.value,
+ "icon": "55555555-5555-4555-8555-555555555555",
+ },
+ "model_config": {"model": {}},
+ },
+ account=_account(tenant_id=_TENANT_ID),
+ )
+
+ assert result.icon_type == IconType.EMOJI
+ assert result.icon == "🤖"
+ assert service._warnings == []
+
+
def test_create_or_update_app_flushes_new_model_config_before_signal(
monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
) -> None:
diff --git a/api/tests/unit_tests/services/test_file_service.py b/api/tests/unit_tests/services/test_file_service.py
index 6b979b24e87..a807bc6aa41 100644
--- a/api/tests/unit_tests/services/test_file_service.py
+++ b/api/tests/unit_tests/services/test_file_service.py
@@ -15,7 +15,12 @@ from extensions.storage.storage_type import StorageType
from models.base import TypeBase
from models.enums import CreatorUserRole
from models.model import Account, EndUser, UploadFile
-from services.errors.file import BlockedFileExtensionError, FileTooLargeError, UnsupportedFileTypeError
+from services.errors.file import (
+ BlockedFileExtensionError,
+ FileNotExistsError,
+ FileTooLargeError,
+ UnsupportedFileTypeError,
+)
from services.file_service import FileService
@@ -328,6 +333,16 @@ class TestFileService:
assert result == "direct-url"
get_presigned_url.assert_called_once_with(file_id="file_id", tenant_id="tenant_id")
+ def test_get_icon_url_maps_missing_cloud_file_to_service_error(
+ self, file_service: FileService, config_overrides: Callable[..., None]
+ ) -> None:
+ config_overrides(DEPLOYMENT_EDITION=DeploymentEdition.CLOUD, STORAGE_TYPE=StorageType.S3)
+ with (
+ patch.object(file_service, "get_file_presigned_url", side_effect=NotFound("File not found")),
+ pytest.raises(FileNotExistsError, match="File reference not found"),
+ ):
+ file_service.get_icon_url("file_id", "tenant_id")
+
@pytest.mark.parametrize(
("deployment_edition", "storage_type"),
[
@@ -338,10 +353,12 @@ class TestFileService:
def test_get_icon_url_uses_preview_url_outside_cloud_s3(
self,
file_service: FileService,
+ db_session: Session,
deployment_edition: DeploymentEdition,
storage_type: StorageType,
config_overrides: Callable[..., None],
):
+ self._persist_upload_file(db_session)
config_overrides(DEPLOYMENT_EDITION=deployment_edition, STORAGE_TYPE=storage_type)
with patch("services.file_service.file_helpers.get_signed_file_url", return_value="preview-url") as get_url:
result = file_service.get_icon_url("file_id", "tenant_id")
@@ -349,6 +366,37 @@ class TestFileService:
assert result == "preview-url"
get_url.assert_called_once_with(upload_file_id="file_id")
+ @pytest.mark.parametrize(
+ ("deployment_edition", "storage_type"),
+ [
+ (DeploymentEdition.COMMUNITY, StorageType.S3),
+ (DeploymentEdition.CLOUD, StorageType.LOCAL),
+ ],
+ )
+ def test_get_icon_url_rejects_missing_file_outside_cloud_s3(
+ self,
+ file_service: FileService,
+ deployment_edition: DeploymentEdition,
+ storage_type: StorageType,
+ config_overrides: Callable[..., None],
+ ) -> None:
+ config_overrides(DEPLOYMENT_EDITION=deployment_edition, STORAGE_TYPE=storage_type)
+
+ with pytest.raises(FileNotExistsError, match="File reference not found"):
+ file_service.get_icon_url("file_id", "tenant_id")
+
+ def test_get_icon_url_rejects_cross_tenant_file_outside_cloud_s3(
+ self,
+ file_service: FileService,
+ db_session: Session,
+ config_overrides: Callable[..., None],
+ ) -> None:
+ self._persist_upload_file(db_session, tenant_id="other_tenant_id")
+ config_overrides(DEPLOYMENT_EDITION=DeploymentEdition.COMMUNITY, STORAGE_TYPE=StorageType.LOCAL)
+
+ with pytest.raises(FileNotExistsError, match="File reference not found"):
+ file_service.get_icon_url("file_id", "tenant_id")
+
def test_upload_text_success(self, file_service: FileService, db_session: Session):
# Setup
text = "sample text"
@@ -427,6 +475,12 @@ class TestFileService:
result = FileService.get_upload_files_by_ids("tenant_id", [], session=db_session)
assert result == {}
+ def test_get_upload_file_by_id_scopes_to_tenant(self, db_session: Session) -> None:
+ upload_file = self._persist_upload_file(db_session)
+
+ assert FileService.get_upload_file_by_id("tenant_id", "file_id", session=db_session) == upload_file
+ assert FileService.get_upload_file_by_id("other_tenant_id", "file_id", session=db_session) is None
+
def test_get_upload_files_by_ids(self, db_session: Session):
upload_file = self._persist_upload_file(db_session, file_id="550e8400-e29b-41d4-a716-446655440000")
self._persist_upload_file(
diff --git a/api/tests/unit_tests/services/test_icon_configuration.py b/api/tests/unit_tests/services/test_icon_configuration.py
new file mode 100644
index 00000000000..e190f4b9f68
--- /dev/null
+++ b/api/tests/unit_tests/services/test_icon_configuration.py
@@ -0,0 +1,79 @@
+from datetime import UTC, datetime
+
+import pytest
+from sqlalchemy.orm import Session
+
+from extensions.storage.storage_type import StorageType
+from models.enums import CreatorUserRole
+from models.model import IconType, UploadFile
+from services.icon_configuration import is_valid_image_icon
+
+TENANT_ID = "22222222-2222-2222-2222-222222222222"
+OTHER_TENANT_ID = "33333333-3333-3333-3333-333333333333"
+FILE_ID = "44444444-4444-4444-4444-444444444444"
+ACCOUNT_ID = "55555555-5555-5555-5555-555555555555"
+
+
+def _upload_file(*, tenant_id: str) -> UploadFile:
+ upload_file = UploadFile(
+ tenant_id=tenant_id,
+ storage_type=StorageType.LOCAL,
+ key=f"upload_files/{tenant_id}/icon.png",
+ name="icon.png",
+ size=10,
+ extension="png",
+ mime_type="image/png",
+ created_by_role=CreatorUserRole.ACCOUNT,
+ created_by=ACCOUNT_ID,
+ created_at=datetime(2026, 1, 1, tzinfo=UTC),
+ used=True,
+ )
+ upload_file.id = FILE_ID
+ return upload_file
+
+
+def test_validate_icon_reference_accepts_tenant_owned_file(sqlite_session: Session) -> None:
+ sqlite_session.add(_upload_file(tenant_id=TENANT_ID))
+ sqlite_session.commit()
+
+ assert is_valid_image_icon(
+ session=sqlite_session,
+ tenant_id=TENANT_ID,
+ icon_type=IconType.IMAGE,
+ icon=FILE_ID,
+ )
+
+
[email protected]("persisted_tenant_id", [None, OTHER_TENANT_ID], ids=["missing", "cross-tenant"])
+def test_validate_icon_reference_rejects_unavailable_file(
+ sqlite_session: Session,
+ persisted_tenant_id: str | None,
+) -> None:
+ if persisted_tenant_id is not None:
+ sqlite_session.add(_upload_file(tenant_id=persisted_tenant_id))
+ sqlite_session.commit()
+
+ assert not is_valid_image_icon(
+ session=sqlite_session,
+ tenant_id=TENANT_ID,
+ icon_type=IconType.IMAGE,
+ icon=FILE_ID,
+ )
+
+
+def test_validate_icon_reference_rejects_empty_image_icon(sqlite_session: Session) -> None:
+ assert not is_valid_image_icon(
+ session=sqlite_session,
+ tenant_id=TENANT_ID,
+ icon_type=IconType.IMAGE,
+ icon=None,
+ )
+
+
+def test_validate_icon_reference_rejects_non_uuid_without_querying_database(sqlite_session: Session) -> None:
+ assert not is_valid_image_icon(
+ session=sqlite_session,
+ tenant_id=TENANT_ID,
+ icon_type=IconType.IMAGE,
+ icon="not-a-uuid",
+ )
diff --git a/api/tests/unit_tests/services/test_web_app_runtime_query_service.py b/api/tests/unit_tests/services/test_web_app_runtime_query_service.py
index 487d0f80b67..ba1e328cee6 100644
--- a/api/tests/unit_tests/services/test_web_app_runtime_query_service.py
+++ b/api/tests/unit_tests/services/test_web_app_runtime_query_service.py
@@ -5,6 +5,7 @@ import pytest
from enums import DeploymentEdition
from services.app_definition_query_service import AppSiteConfiguration
from services.entities.feature_entities import FeatureModel
+from services.errors.file import FileNotExistsError
from services.file_service import FileService
from services.web_app_runtime_query_service import (
WebAppBootstrap,
@@ -158,3 +159,17 @@ def test_get_bootstrap_skips_legacy_custom_config_when_branding_is_not_allowed(
assert result.site == {**record.site._asdict(), "icon_url": None}
assert result.can_replace_logo is False
assert result.custom_config is None
+
+
+def test_get_bootstrap_falls_back_when_site_icon_is_unavailable() -> None:
+ runtime: MagicMock = create_autospec(WebAppRuntimeQuery, instance=True, spec_set=True)
+ runtime.get_runtime_record.return_value = _runtime_record()
+ file_service = MagicMock(spec=FileService)
+ file_service.get_icon_url.side_effect = FileNotExistsError("File reference not found")
+
+ result = _service(runtime, file_service=file_service).get_bootstrap("app-1")
+
+ assert result.site["icon_type"] == "emoji"
+ assert result.site["icon"] == "🤖"
+ assert result.site["icon_background"] == "#FFEAD5"
+ assert result.site["icon_url"] is None