mirror of
https://github.com/langgenius/dify.git
synced 2026-10-04 13:47:55 +08:00
refactor(api): decouple onboarding and notification services (#40759)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: hjlarry <hjlarry@163.com>
This commit is contained in:
21 files changed
+1305
-597
No files matched your search
@@ -0,0 +1,77 @@
|
||||
from inspect import unwrap
|
||||
from types import SimpleNamespace
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
from controllers.console.notification import (
|
||||
DismissNotificationPayload,
|
||||
NotificationApi,
|
||||
NotificationDismissApi,
|
||||
)
|
||||
from machinery.context import RequestContext
|
||||
from services.entities.notification_entities import NotificationItem, NotificationResult
|
||||
|
||||
|
||||
def _request_context() -> RequestContext:
|
||||
return RequestContext(
|
||||
request_id="request-1",
|
||||
trace_id="trace-1",
|
||||
account_id="account-1",
|
||||
active_workspace_id="workspace-1",
|
||||
)
|
||||
|
||||
|
||||
def test_get_notification_delegates_and_serializes_result() -> None:
|
||||
service = Mock()
|
||||
service.get_active.return_value = NotificationResult(
|
||||
should_show=True,
|
||||
notifications=(
|
||||
NotificationItem(
|
||||
notification_id="notification-1",
|
||||
frequency="once",
|
||||
lang="en-US",
|
||||
title="Title",
|
||||
subtitle="Subtitle",
|
||||
body="Body",
|
||||
title_pic_url="https://example.com/title.png",
|
||||
),
|
||||
),
|
||||
)
|
||||
services = SimpleNamespace(notifications=service)
|
||||
api = NotificationApi()
|
||||
method = unwrap(api.get)
|
||||
context = _request_context()
|
||||
|
||||
with patch("controllers.console.notification.application_services", return_value=services):
|
||||
result, status = method(api, context)
|
||||
|
||||
assert status == 200
|
||||
assert result == {
|
||||
"should_show": True,
|
||||
"notifications": [
|
||||
{
|
||||
"notification_id": "notification-1",
|
||||
"frequency": "once",
|
||||
"lang": "en-US",
|
||||
"title": "Title",
|
||||
"subtitle": "Subtitle",
|
||||
"body": "Body",
|
||||
"title_pic_url": "https://example.com/title.png",
|
||||
}
|
||||
],
|
||||
}
|
||||
service.get_active.assert_called_once_with(context)
|
||||
|
||||
|
||||
def test_dismiss_notification_delegates_with_stable_account_context() -> None:
|
||||
service = Mock()
|
||||
services = SimpleNamespace(notifications=service)
|
||||
api = NotificationDismissApi()
|
||||
method = unwrap(api.post)
|
||||
context = _request_context()
|
||||
|
||||
with patch("controllers.console.notification.application_services", return_value=services):
|
||||
result, status = method(api, DismissNotificationPayload(notification_id="notification-1"), context)
|
||||
|
||||
assert status == 200
|
||||
assert result == {"result": "success"}
|
||||
service.dismiss.assert_called_once_with(context, "notification-1")
|
||||
@@ -2,47 +2,48 @@ from __future__ import annotations
|
||||
|
||||
from datetime import UTC, datetime
|
||||
from inspect import unwrap
|
||||
from unittest.mock import Mock
|
||||
from types import SimpleNamespace
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
import pytest
|
||||
from flask import Flask
|
||||
from pydantic import ValidationError
|
||||
|
||||
from controllers.console.onboarding import (
|
||||
StepByStepTourStateApi,
|
||||
StepByStepTourStatePatchPayload,
|
||||
StepByStepTourStateResponse,
|
||||
)
|
||||
from extensions.ext_database import db
|
||||
from models.account import Account, AccountStatus
|
||||
from services.step_by_step_tour_service import StepByStepTourService
|
||||
from machinery.context import RequestContext
|
||||
from services.entities.onboarding_entities import StepByStepTourPatch, StepByStepTourResult
|
||||
|
||||
|
||||
def _account() -> Account:
|
||||
account = Account(name="User", email="user@example.com", status=AccountStatus.ACTIVE)
|
||||
account.id = "account-1"
|
||||
return account
|
||||
def _request_context() -> RequestContext:
|
||||
return RequestContext(
|
||||
request_id="request-1",
|
||||
trace_id="trace-1",
|
||||
account_id="account-1",
|
||||
active_workspace_id="workspace-1",
|
||||
)
|
||||
|
||||
|
||||
def _state_response() -> dict[str, object]:
|
||||
return {
|
||||
"first_workspace_id": "workspace-1",
|
||||
"skipped": False,
|
||||
"completed_task_ids": ["home"],
|
||||
"manually_enabled_workspace_ids": [],
|
||||
"manually_disabled_workspace_ids": [],
|
||||
"updated_at": datetime(2026, 6, 28, tzinfo=UTC),
|
||||
}
|
||||
def _state_result() -> StepByStepTourResult:
|
||||
return StepByStepTourResult(
|
||||
first_workspace_id="workspace-1",
|
||||
completed_task_ids=("home",),
|
||||
updated_at=datetime(2026, 6, 28, tzinfo=UTC),
|
||||
)
|
||||
|
||||
|
||||
def test_get_step_by_step_tour_state(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
get_state = Mock(return_value=_state_response())
|
||||
monkeypatch.setattr(StepByStepTourService, "get_state", get_state)
|
||||
|
||||
def test_get_step_by_step_tour_state_delegates_with_request_context() -> None:
|
||||
service = Mock()
|
||||
service.get_state.return_value = _state_result()
|
||||
services = SimpleNamespace(step_by_step_tour=service)
|
||||
api = StepByStepTourStateApi()
|
||||
method = unwrap(api.get)
|
||||
context = _request_context()
|
||||
|
||||
with app.test_request_context("/console/api/onboarding/step-by-step-tour/state", method="GET"):
|
||||
result = method(api, "workspace-1", _account())
|
||||
with patch("controllers.console.onboarding.application_services", return_value=services):
|
||||
result = method(api, context)
|
||||
|
||||
assert result == {
|
||||
"first_workspace_id": "workspace-1",
|
||||
@@ -52,35 +53,26 @@ def test_get_step_by_step_tour_state(app: Flask, monkeypatch: pytest.MonkeyPatch
|
||||
"manually_disabled_workspace_ids": [],
|
||||
"updated_at": "2026-06-28T00:00:00Z",
|
||||
}
|
||||
get_state.assert_called_once()
|
||||
assert get_state.call_args.kwargs["current_tenant_id"] == "workspace-1"
|
||||
assert get_state.call_args.kwargs["session"] is db.session
|
||||
service.get_state.assert_called_once_with(context)
|
||||
|
||||
|
||||
def test_patch_step_by_step_tour_state_passes_action_payload(
|
||||
app: Flask,
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
) -> None:
|
||||
patch_state = Mock(return_value=_state_response())
|
||||
monkeypatch.setattr(StepByStepTourService, "patch_state", patch_state)
|
||||
|
||||
def test_patch_step_by_step_tour_state_maps_transport_payload_to_command() -> None:
|
||||
service = Mock()
|
||||
service.patch_state.return_value = _state_result()
|
||||
services = SimpleNamespace(step_by_step_tour=service)
|
||||
api = StepByStepTourStateApi()
|
||||
method = unwrap(api.patch)
|
||||
payload = {"action": "complete_task", "task_id": "studio"}
|
||||
context = _request_context()
|
||||
payload = StepByStepTourStatePatchPayload.model_validate({"action": "complete_task", "task_id": "studio"})
|
||||
|
||||
req_data = StepByStepTourStatePatchPayload.model_validate(payload)
|
||||
with app.test_request_context(
|
||||
"/console/api/onboarding/step-by-step-tour/state",
|
||||
method="PATCH",
|
||||
json=payload,
|
||||
):
|
||||
result = method(api, req_data, "workspace-1", _account())
|
||||
with patch("controllers.console.onboarding.application_services", return_value=services):
|
||||
result = method(api, payload, context)
|
||||
|
||||
assert result["completed_task_ids"] == ["home"]
|
||||
patch_state.assert_called_once()
|
||||
assert patch_state.call_args.kwargs["current_tenant_id"] == "workspace-1"
|
||||
assert patch_state.call_args.kwargs["patch"] == payload
|
||||
assert patch_state.call_args.kwargs["session"] is db.session
|
||||
service.patch_state.assert_called_once_with(
|
||||
context,
|
||||
StepByStepTourPatch(action="complete_task", task_id="studio"),
|
||||
)
|
||||
|
||||
|
||||
def test_patch_payload_rejects_non_action_fields() -> None:
|
||||
@@ -96,3 +88,21 @@ def test_patch_payload_rejects_task_id_without_task_action() -> None:
|
||||
def test_patch_payload_requires_action() -> None:
|
||||
with pytest.raises(ValidationError):
|
||||
StepByStepTourStatePatchPayload.model_validate({"task_id": "home"})
|
||||
|
||||
|
||||
def test_step_by_step_tour_schemas_preserve_enum_values() -> None:
|
||||
patch_schema = StepByStepTourStatePatchPayload.model_json_schema()
|
||||
action_schema = patch_schema["properties"]["action"]
|
||||
task_id_schema = patch_schema["properties"]["task_id"]
|
||||
task_id_values = next(candidate["enum"] for candidate in task_id_schema["anyOf"] if "enum" in candidate)
|
||||
response_schema = StepByStepTourStateResponse.model_json_schema()
|
||||
|
||||
assert set(action_schema["enum"]) == {
|
||||
"skip",
|
||||
"complete_task",
|
||||
"uncomplete_task",
|
||||
"enable_current_workspace",
|
||||
"disable_current_workspace",
|
||||
}
|
||||
assert set(task_id_values) == {"home", "studio", "knowledge", "integration"}
|
||||
assert set(response_schema["properties"]["completed_task_ids"]["items"]["enum"]) == set(task_id_values)
|
||||
Reference in new issue
Block a user