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>

api/controllers/console/notification.py

@@ -1,56 +1,16 @@
-from collections.abc import Mapping
-from typing import TypedDict
-
 from flask_restx import Resource
 from pydantic import BaseModel, Field
 
 from controllers.common.fields import SimpleResultResponse
 from controllers.common.schema import register_response_schema_models, register_schema_models
 from controllers.console import console_ns
-from controllers.console.wraps import (
-    account_initialization_required,
-    model_validate,
-    only_edition_cloud,
-    setup_required,
-    with_current_user,
-)
+from controllers.console.flask_admission import console_account_admission
+from controllers.console.wraps import model_validate
+from enums import DeploymentEdition
+from extensions.ext_application_services import application_services
 from fields.base import ResponseModel
-from libs.login import login_required
-from models import Account
-from services.billing_service import BillingService
-
-# Notification content is stored under three lang tags.
-_FALLBACK_LANG = "en-US"
-
-
-class NotificationLangContent(TypedDict, total=False):
-    lang: str
-    title: str
-    subtitle: str
-    body: str
-    titlePicUrl: str
-
-
-class NotificationItemDict(TypedDict):
-    notification_id: str | None
-    frequency: str | None
-    lang: str
-    title: str
-    subtitle: str
-    body: str
-    title_pic_url: str
-
-
-class NotificationResponseDict(TypedDict):
-    should_show: bool
-    notifications: list[NotificationItemDict]
-
-
-def _pick_lang_content(contents: Mapping[str, NotificationLangContent], lang: str) -> NotificationLangContent:
-    """Return the single LangContent for *lang*, falling back to English."""
-    return (
-        contents.get(lang) or contents.get(_FALLBACK_LANG) or next(iter(contents.values()), NotificationLangContent())
-    )
+from libs.helper import dump_response
+from machinery.context import RequestContext
 
 
 class DismissNotificationPayload(BaseModel):
@@ -92,39 +52,10 @@ class NotificationApi(Resource):
         },
     )
     @console_ns.response(200, "Success", console_ns.models[NotificationResponse.__name__])
-    @setup_required
-    @login_required
-    @with_current_user
-    @account_initialization_required
-    @only_edition_cloud
-    def get(self, current_user: Account):
-        result = BillingService.get_account_notification(str(current_user.id))
-
-        # Proto JSON uses camelCase field names (Kratos default marshaling).
-        response: NotificationResponseDict
-        if not result.get("shouldShow"):
-            response = {"should_show": False, "notifications": []}
-            return response, 200
-
-        lang = current_user.interface_language or _FALLBACK_LANG
-
-        notifications: list[NotificationItemDict] = []
-        for notification in result.get("notifications") or []:
-            contents: Mapping[str, NotificationLangContent] = notification.get("contents") or {}
-            lang_content = _pick_lang_content(contents, lang)
-            item: NotificationItemDict = {
-                "notification_id": notification.get("notificationId"),
-                "frequency": notification.get("frequency"),
-                "lang": lang_content.get("lang", lang),
-                "title": lang_content.get("title", ""),
-                "subtitle": lang_content.get("subtitle", ""),
-                "body": lang_content.get("body", ""),
-                "title_pic_url": lang_content.get("titlePicUrl", ""),
-            }
-            notifications.append(item)
-
-        response = {"should_show": bool(notifications), "notifications": notifications}
-        return response, 200
+    @console_account_admission(editions=frozenset({DeploymentEdition.CLOUD}))
+    def get(self, request_context: RequestContext):
+        result = application_services().notifications.get_active(request_context)
+        return dump_response(NotificationResponse, result), 200
 
 
 @console_ns.route("/notification/dismiss")
@@ -134,17 +65,10 @@ class NotificationDismissApi(Resource):
         description="Mark a notification as dismissed for the current user.",
         responses={200: "Success", 401: "Unauthorized"},
     )
-    @setup_required
-    @login_required
-    @with_current_user
-    @account_initialization_required
-    @only_edition_cloud
+    @console_account_admission(editions=frozenset({DeploymentEdition.CLOUD}))
     @console_ns.expect(console_ns.models[DismissNotificationPayload.__name__])
     @console_ns.response(200, "Success", console_ns.models[SimpleResultResponse.__name__])
     @model_validate(DismissNotificationPayload)
-    def post(self, payload: DismissNotificationPayload, current_user: Account):
-        BillingService.dismiss_notification(
-            notification_id=payload.notification_id,
-            account_id=str(current_user.id),
-        )
-        return {"result": "success"}, 200
+    def post(self, payload: DismissNotificationPayload, request_context: RequestContext):
+        application_services().notifications.dismiss(request_context, payload.notification_id)
+        return dump_response(SimpleResultResponse, {"result": "success"}), 200

api/controllers/console/onboarding.py

@@ -7,36 +7,20 @@ action-based so callers do not replace server-side arrays with stale snapshots.
 """
 
 from datetime import datetime
-from typing import Literal, cast
 
 from flask_restx import Resource
 from pydantic import BaseModel, ConfigDict, Field, model_validator
 
 from controllers.common.schema import register_response_schema_models, register_schema_models
-from extensions.ext_database import db
+from controllers.console.flask_admission import console_account_admission
+from controllers.console.wraps import model_validate
+from extensions.ext_application_services import application_services
 from fields.base import ResponseModel
 from libs.helper import dump_response
-from libs.login import login_required
-from models import Account
-from services.step_by_step_tour_service import StepByStepTourPatch, StepByStepTourService
+from machinery.context import RequestContext
+from services.entities.onboarding_entities import StepByStepTourAction, StepByStepTourPatch, StepByStepTourTaskId
 
 from . import console_ns
-from .wraps import (
-    account_initialization_required,
-    model_validate,
-    setup_required,
-    with_current_tenant_id,
-    with_current_user,
-)
-
-StepByStepTourAction = Literal[
-    "skip",
-    "complete_task",
-    "uncomplete_task",
-    "enable_current_workspace",
-    "disable_current_workspace",
-]
-StepByStepTourTaskId = Literal["home", "studio", "knowledge", "integration"]
 
 
 class StepByStepTourStatePatchPayload(BaseModel):
@@ -74,39 +58,22 @@ class StepByStepTourStateApi(Resource):
     @console_ns.doc("get_step_by_step_tour_state")
     @console_ns.doc(description="Get account-level Step-by-step Tour state")
     @console_ns.response(200, "Success", console_ns.models[StepByStepTourStateResponse.__name__])
-    @setup_required
-    @login_required
-    @account_initialization_required
-    @with_current_user
-    @with_current_tenant_id
-    def get(self, current_tenant_id: str, current_user: Account):
+    @console_account_admission()
+    def get(self, request_context: RequestContext):
         return dump_response(
             StepByStepTourStateResponse,
-            StepByStepTourService.get_state(
-                account=current_user,
-                current_tenant_id=current_tenant_id,
-                session=db.session,
-            ),
+            application_services().step_by_step_tour.get_state(request_context),
         )
 
     @console_ns.doc("patch_step_by_step_tour_state")
     @console_ns.doc(description="Update account-level Step-by-step Tour state")
     @console_ns.expect(console_ns.models[StepByStepTourStatePatchPayload.__name__])
     @console_ns.response(200, "Success", console_ns.models[StepByStepTourStateResponse.__name__])
-    @setup_required
-    @login_required
-    @account_initialization_required
-    @with_current_user
-    @with_current_tenant_id
+    @console_account_admission()
     @model_validate(StepByStepTourStatePatchPayload)
-    def patch(self, req_data: StepByStepTourStatePatchPayload, current_tenant_id: str, current_user: Account):
-        patch = cast(StepByStepTourPatch, req_data.model_dump(exclude_unset=True, exclude_none=True))
+    def patch(self, req_data: StepByStepTourStatePatchPayload, request_context: RequestContext):
+        patch = StepByStepTourPatch(action=req_data.action, task_id=req_data.task_id)
         return dump_response(
             StepByStepTourStateResponse,
-            StepByStepTourService.patch_state(
-                account=current_user,
-                current_tenant_id=current_tenant_id,
-                patch=patch,
-                session=db.session,
-            ),
+            application_services().step_by_step_tour.patch_state(request_context, patch),
         )