AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.
refactor(backend): move the onboarding routes into features/onboarding (#14479)
Reinier van der Leerf654bce57207
diff --git a/autogpt_platform/backend/backend/api/features/onboarding/__init__.py b/autogpt_platform/backend/backend/api/features/onboarding/__init__.pynew file mode 100644index 0000000000..e69de29bb2diff --git a/autogpt_platform/backend/backend/api/features/onboarding_profile_test.py b/autogpt_platform/backend/backend/api/features/onboarding/profile_test.pysimilarity index 85%rename from autogpt_platform/backend/backend/api/features/onboarding_profile_test.pyrename to autogpt_platform/backend/backend/api/features/onboarding/profile_test.pyindex b384de96c6..a7b9686982 100644--- a/autogpt_platform/backend/backend/api/features/onboarding_profile_test.py+++ b/autogpt_platform/backend/backend/api/features/onboarding/profile_test.py@@ -4,10 +4,10 @@ import fastapiimport fastapi.testclientimport pytest-from backend.api.features.v1 import v1_router+from backend.api.features.onboarding.routes import routerapp = fastapi.FastAPI()-app.include_router(v1_router)+app.include_router(router)client = fastapi.testclient.TestClient(app)@@ -22,11 +22,11 @@ def setup_app_auth(mock_jwt_user):def test_onboarding_profile_success(mocker):mock_extract = mocker.patch(- "backend.api.features.v1.extract_business_understanding",+ "backend.api.features.onboarding.routes.extract_business_understanding",new_callable=AsyncMock,)mock_upsert = mocker.patch(- "backend.api.features.v1.upsert_business_understanding",+ "backend.api.features.onboarding.routes.upsert_business_understanding",new_callable=AsyncMock,)diff --git a/autogpt_platform/backend/backend/api/features/onboarding/routes.py b/autogpt_platform/backend/backend/api/features/onboarding/routes.pynew file mode 100644index 0000000000..c39c61703e--- /dev/null+++ b/autogpt_platform/backend/backend/api/features/onboarding/routes.py@@ -0,0 +1,145 @@+from typing import Annotated, get_args++import pydantic+from autogpt_libs.auth import get_user_id, requires_user+from fastapi import APIRouter, HTTPException, Security++from backend.api.features.store.model import StoreAgentDetails+from backend.data.model import UserOnboarding+from backend.data.onboarding import (+ FrontendOnboardingStep,+ OnboardingStep,+ UserOnboardingUpdate,+ complete_onboarding_step,+ format_onboarding_for_extraction,+ get_recommended_agents,+ get_user_onboarding,+ reset_user_onboarding,+ update_user_onboarding,+)+from backend.data.tally import extract_business_understanding+from backend.data.understanding import (+ BusinessUnderstandingInput,+ upsert_business_understanding,+)++# Tags stay per-route: /onboarding/completed publishes ["onboarding", "public"]+# while the other six publish ["onboarding"].+router = APIRouter(dependencies=[Security(requires_user)])+++ "/onboarding",+ summary="Onboarding state",+ tags=["onboarding"],+ response_model=UserOnboarding,+)+async def get_onboarding(user_id: Annotated[str, Security(get_user_id)]):+ return await get_user_onboarding(user_id)+++ "/onboarding",+ summary="Update onboarding state",+ tags=["onboarding"],+ response_model=UserOnboarding,+)+async def update_onboarding(+ user_id: Annotated[str, Security(get_user_id)], data: UserOnboardingUpdate+):+ return await update_user_onboarding(user_id, data)+++ "/onboarding/step",+ summary="Complete onboarding step",+ tags=["onboarding"],+)+async def onboarding_complete_step(+ user_id: Annotated[str, Security(get_user_id)], step: FrontendOnboardingStep+):+ if step not in get_args(FrontendOnboardingStep):+ raise HTTPException(status_code=400, detail="Invalid onboarding step")+ return await complete_onboarding_step(user_id, step)+++ "/onboarding/agents",+ summary="Recommended onboarding agents",+ tags=["onboarding"],+)+async def get_onboarding_agents(+ user_id: Annotated[str, Security(get_user_id)],+) -> list[StoreAgentDetails]:+ return await get_recommended_agents(user_id)+++class OnboardingProfileRequest(pydantic.BaseModel):+ """Request body for onboarding profile submission."""++ user_name: str = pydantic.Field(min_length=1, max_length=100)+ user_role: str = pydantic.Field(min_length=1, max_length=100)+ pain_points: list[str] = pydantic.Field(default_factory=list, max_length=20)+++class OnboardingStatusResponse(pydantic.BaseModel):+ """Response for onboarding completion check."""++ is_completed: bool+++ "/onboarding/completed",+ summary="Check if onboarding is completed",+ tags=["onboarding", "public"],+ response_model=OnboardingStatusResponse,+)+async def is_onboarding_completed(+ user_id: Annotated[str, Security(get_user_id)],+) -> OnboardingStatusResponse:+ user_onboarding = await get_user_onboarding(user_id)+ return OnboardingStatusResponse(+ is_completed=OnboardingStep.ONBOARDING_COMPLETE+ in user_onboarding.completedSteps,+ )+++ "/onboarding/reset",+ summary="Reset onboarding progress",+ tags=["onboarding"],+ response_model=UserOnboarding,+)+async def reset_onboarding(user_id: Annotated[str, Security(get_user_id)]):+ return await reset_user_onboarding(user_id)+++ "/onboarding/profile",+ summary="Submit onboarding profile",+ tags=["onboarding"],+)+async def submit_onboarding_profile(+ data: OnboardingProfileRequest,+ user_id: Annotated[str, Security(get_user_id)],+):+ formatted = format_onboarding_for_extraction(+ user_name=data.user_name,+ user_role=data.user_role,+ pain_points=data.pain_points,+ )++ try:+ understanding_input = await extract_business_understanding(formatted)+ except Exception:+ understanding_input = BusinessUnderstandingInput.model_construct()++ # Ensure the direct fields are set even if LLM missed them+ understanding_input.user_name = data.user_name+ understanding_input.user_role = data.user_role+ if not understanding_input.pain_points:+ understanding_input.pain_points = data.pain_points++ await upsert_business_understanding(user_id, understanding_input)++ return {"status": "ok"}diff --git a/autogpt_platform/backend/backend/api/features/onboarding/routes_test.py b/autogpt_platform/backend/backend/api/features/onboarding/routes_test.pynew file mode 100644index 0000000000..d07e17ff41--- /dev/null+++ b/autogpt_platform/backend/backend/api/features/onboarding/routes_test.py@@ -0,0 +1,51 @@+"""Pins the mounted onboarding surface."""++import pytest+from fastapi.routing import APIRoute++from backend.api.rest_api import app as real_app++# Tags stay per-route: /onboarding/completed publishes ["onboarding", "public"]+# while the other six publish ["onboarding"], so neither can hoist.+EXPECTED_OPERATIONS = {+ ("get", "/api/onboarding"): ["v1", "onboarding"],+ ("patch", "/api/onboarding"): ["v1", "onboarding"],+ ("post", "/api/onboarding/step"): ["v1", "onboarding"],+ ("get", "/api/onboarding/agents"): ["v1", "onboarding"],+ ("get", "/api/onboarding/completed"): ["v1", "onboarding", "public"],+ ("post", "/api/onboarding/reset"): ["v1", "onboarding"],+ ("post", "/api/onboarding/profile"): ["v1", "onboarding"],+}+++ "method,path,tags", [(m, p, t) for (m, p), t in EXPECTED_OPERATIONS.items()]+)+def test_onboarding_operation_is_published(method: str, path: str, tags: list[str]):+ assert real_app.openapi()["paths"][path][method]["tags"] == tags++[email protected]("path", sorted({p for _, p in EXPECTED_OPERATIONS}))+def test_onboarding_route_requires_an_authenticated_user(path: str):+ """`security` in the schema does not prove this — each handler's own+ Security(get_user_id) puts it there. Assert the dependency. The "public"+ tag on /onboarding/completed names its audience, not its auth."""+ for route in real_app.routes:+ if isinstance(route, APIRoute) and route.path == path:+ assert "requires_user" in {+ d.call.__name__ for d in route.dependant.dependencies if d.call+ }+++def test_onboarding_surface_has_no_other_operations():+ """Keyed on the owning module: /api/onboarding/brain-dump/* shares the+ prefix but belongs to features/onboarding_dump."""+ served = {+ (method.lower(), route.path)+ for route in real_app.routes+ if isinstance(route, APIRoute)+ and route.endpoint.__module__ == "backend.api.features.onboarding.routes"+ for method in route.methods+ if method != "HEAD"+ }+ assert served == set(EXPECTED_OPERATIONS)diff --git a/autogpt_platform/backend/backend/api/features/onboarding_step_test.py b/autogpt_platform/backend/backend/api/features/onboarding/step_test.pysimilarity index 92%rename from autogpt_platform/backend/backend/api/features/onboarding_step_test.pyrename to autogpt_platform/backend/backend/api/features/onboarding/step_test.pyindex b1148d720a..96e924c5b4 100644--- a/autogpt_platform/backend/backend/api/features/onboarding_step_test.py+++ b/autogpt_platform/backend/backend/api/features/onboarding/step_test.py@@ -4,13 +4,13 @@ import fastapiimport fastapi.testclientimport pytest-from backend.api.features.v1 import v1_router+from backend.api.features.onboarding.routes import routerfrom backend.data import onboarding as onboarding_modulefrom backend.data.model import UserOnboardingfrom backend.data.onboarding import OnboardingStepapp = fastapi.FastAPI()-app.include_router(v1_router)+app.include_router(router)client = fastapi.testclient.TestClient(app)@@ -34,7 +34,7 @@ def test_complete_step_rejects_invalid_step(invalid_step):def test_complete_step_accepts_renamed_complete_value(mocker):mock_complete = mocker.patch(- "backend.api.features.v1.complete_onboarding_step",+ "backend.api.features.onboarding.routes.complete_onboarding_step",new_callable=AsyncMock,return_value=None,)@@ -61,7 +61,7 @@ def test_complete_step_accepts_tab_intros(step, mocker):# Each tab's first-visit card records its own step; without all three on# FrontendOnboardingStep the card would 422 and reappear forever.mock_complete = mocker.patch(- "backend.api.features.v1.complete_onboarding_step",+ "backend.api.features.onboarding.routes.complete_onboarding_step",new_callable=AsyncMock,return_value=None,)@@ -86,7 +86,7 @@ def test_complete_step_rejects_rewarded_backend_only_steps(step, mocker):# the only thing standing between an authenticated user and self-awarding# credits, so it gets its own test.mock_complete = mocker.patch(- "backend.api.features.v1.complete_onboarding_step",+ "backend.api.features.onboarding.routes.complete_onboarding_step",new_callable=AsyncMock,return_value=None,)@@ -126,7 +126,7 @@ async def test_tab_intro_steps_grant_no_reward(step, mocker):def test_is_onboarding_completed_true_when_complete_step_present(mocker):mock_get = mocker.patch(- "backend.api.features.v1.get_user_onboarding",+ "backend.api.features.onboarding.routes.get_user_onboarding",new_callable=AsyncMock,)mock_get.return_value = UserOnboarding.model_construct(@@ -141,7 +141,7 @@ def test_is_onboarding_completed_true_when_complete_step_present(mocker):def test_is_onboarding_completed_false_without_complete_step(mocker):mock_get = mocker.patch(- "backend.api.features.v1.get_user_onboarding",+ "backend.api.features.onboarding.routes.get_user_onboarding",new_callable=AsyncMock,)mock_get.return_value = UserOnboarding.model_construct(@@ -187,7 +187,7 @@ def test_user_onboarding_response_model_accepts_deprecated_stored_values():def test_update_onboarding_rejects_invalid_notified_step(mocker):mock_update = mocker.patch(- "backend.api.features.v1.update_user_onboarding",+ "backend.api.features.onboarding.routes.update_user_onboarding",new_callable=AsyncMock,)diff --git a/autogpt_platform/backend/backend/api/features/v1.py b/autogpt_platform/backend/backend/api/features/v1.pyindex 2151479246..6d8c71f588 100644--- a/autogpt_platform/backend/backend/api/features/v1.py+++ b/autogpt_platform/backend/backend/api/features/v1.py@@ -1,33 +1,15 @@import asyncioimport loggingfrom datetime import datetime, timezone-from typing import Annotated, get_args+from typing import Annotated-import pydanticfrom autogpt_libs.auth import get_user_id, requires_userfrom autogpt_libs.auth.jwt_utils import get_jwt_payloadfrom fastapi import APIRouter, Body, HTTPException, Query, Response, Securityfrom prisma.enums import BriefingFrequencyfrom backend.api.model import TimezoneResponse, UpdateTimezoneRequest-from backend.data.model import UserOnboardingfrom backend.data.notifications import NotificationPreference, NotificationPreferenceDTO-from backend.data.onboarding import (- FrontendOnboardingStep,- OnboardingStep,- UserOnboardingUpdate,- complete_onboarding_step,- format_onboarding_for_extraction,- get_recommended_agents,- get_user_onboarding,- reset_user_onboarding,- update_user_onboarding,-)-from backend.data.tally import extract_business_understanding-from backend.data.understanding import (- BusinessUnderstandingInput,- upsert_business_understanding,-)from backend.data.user import (get_or_create_user,get_or_create_user_with_status,@@ -39,8 +21,6 @@ from backend.data.user import ()from backend.util.settings import Settings-from .store.model import StoreAgentDetails-settings = Settings()logger = logging.getLogger(__name__)@@ -219,132 +199,3 @@ def _preference_with_choice(store_verdicts_enabled=current.store_verdicts_enabled,daily_limit=current.daily_limit,)---########################################################-##################### Onboarding #######################-########################################################---@v1_router.get(- "/onboarding",- summary="Onboarding state",- tags=["onboarding"],- dependencies=[Security(requires_user)],- response_model=UserOnboarding,-)-async def get_onboarding(user_id: Annotated[str, Security(get_user_id)]):- return await get_user_onboarding(user_id)---@v1_router.patch(- "/onboarding",- summary="Update onboarding state",- tags=["onboarding"],- dependencies=[Security(requires_user)],- response_model=UserOnboarding,-)-async def update_onboarding(- user_id: Annotated[str, Security(get_user_id)], data: UserOnboardingUpdate-):- return await update_user_onboarding(user_id, data)---@v1_router.post(- "/onboarding/step",- summary="Complete onboarding step",- tags=["onboarding"],- dependencies=[Security(requires_user)],-)-async def onboarding_complete_step(- user_id: Annotated[str, Security(get_user_id)], step: FrontendOnboardingStep-):- if step not in get_args(FrontendOnboardingStep):- raise HTTPException(status_code=400, detail="Invalid onboarding step")- return await complete_onboarding_step(user_id, step)---@v1_router.get(- "/onboarding/agents",- summary="Recommended onboarding agents",- tags=["onboarding"],- dependencies=[Security(requires_user)],-)-async def get_onboarding_agents(- user_id: Annotated[str, Security(get_user_id)],-) -> list[StoreAgentDetails]:- return await get_recommended_agents(user_id)---class OnboardingProfileRequest(pydantic.BaseModel):- """Request body for onboarding profile submission."""-- user_name: str = pydantic.Field(min_length=1, max_length=100)- user_role: str = pydantic.Field(min_length=1, max_length=100)- pain_points: list[str] = pydantic.Field(default_factory=list, max_length=20)---class OnboardingStatusResponse(pydantic.BaseModel):- """Response for onboarding completion check."""-- is_completed: bool---@v1_router.get(- "/onboarding/completed",- summary="Check if onboarding is completed",- tags=["onboarding", "public"],- response_model=OnboardingStatusResponse,- dependencies=[Security(requires_user)],-)-async def is_onboarding_completed(- user_id: Annotated[str, Security(get_user_id)],-) -> OnboardingStatusResponse:- user_onboarding = await get_user_onboarding(user_id)- return OnboardingStatusResponse(- is_completed=OnboardingStep.ONBOARDING_COMPLETE- in user_onboarding.completedSteps,- )---@v1_router.post(- "/onboarding/reset",- summary="Reset onboarding progress",- tags=["onboarding"],- dependencies=[Security(requires_user)],- response_model=UserOnboarding,-)-async def reset_onboarding(user_id: Annotated[str, Security(get_user_id)]):- return await reset_user_onboarding(user_id)---@v1_router.post(- "/onboarding/profile",- summary="Submit onboarding profile",- tags=["onboarding"],- dependencies=[Security(requires_user)],-)-async def submit_onboarding_profile(- data: OnboardingProfileRequest,- user_id: Annotated[str, Security(get_user_id)],-):- formatted = format_onboarding_for_extraction(- user_name=data.user_name,- user_role=data.user_role,- pain_points=data.pain_points,- )-- try:- understanding_input = await extract_business_understanding(formatted)- except Exception:- understanding_input = BusinessUnderstandingInput.model_construct()-- # Ensure the direct fields are set even if LLM missed them- understanding_input.user_name = data.user_name- understanding_input.user_role = data.user_role- if not understanding_input.pain_points:- understanding_input.pain_points = data.pain_points-- await upsert_business_understanding(user_id, understanding_input)-- return {"status": "ok"}diff --git a/autogpt_platform/backend/backend/api/rest_api.py b/autogpt_platform/backend/backend/api/rest_api.pyindex 64dda20736..2ea3361102 100644--- a/autogpt_platform/backend/backend/api/rest_api.py+++ b/autogpt_platform/backend/backend/api/rest_api.py@@ -52,6 +52,7 @@ import backend.api.features.library.routesimport backend.api.features.mcp.routes as mcp_routesimport backend.api.features.memory.routes as memory_routesimport backend.api.features.oauth+import backend.api.features.onboarding.routes as onboarding_routesimport backend.api.features.onboarding_dump.routes as onboarding_dump_routesimport backend.api.features.orgs.invitation_routesimport backend.api.features.orgs.routes as org_routes@@ -437,6 +438,11 @@ app.include_router(tags=["v1"],prefix="/api",)+app.include_router(+ onboarding_routes.router,+ tags=["v1"],+ prefix="/api",+)app.include_router(auth_email_routes.auth_email_router,prefix="/api/auth/email",