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.
fix(backend): resetting onboarding clears the wizard draft with a JSON null (#15756)
Reinier van der Leer867e22fce9d8
diff --git a/autogpt_platform/backend/backend/data/onboarding.py b/autogpt_platform/backend/backend/data/onboarding.pyindex badd99d3f8..b54e5d2d61 100644--- a/autogpt_platform/backend/backend/data/onboarding.py+++ b/autogpt_platform/backend/backend/data/onboarding.py@@ -130,7 +130,8 @@ async def reset_user_onboarding(user_id: str):"create": UserOnboardingCreateInput(userId=user_id),"update": {"completedSteps": [],- "wizardProgress": None,+ # Prisma refuses a bare None for a Json column.+ "wizardProgress": SafeJson(None),"wizardRevision": {"increment": 1},"walletShown": False,"notified": [],@@ -177,8 +178,8 @@ async def update_user_onboarding(user_id: str, data: UserOnboardingUpdate):if data.onboardingAgentExecutionId is not None:update["onboardingAgentExecutionId"] = data.onboardingAgentExecutionIdif "wizardProgress" in data.model_fields_set:- update["wizardProgress"] = (- SafeJson(data.wizardProgress.model_dump(mode="json"))+ update["wizardProgress"] = SafeJson(+ data.wizardProgress.model_dump(mode="json")if data.wizardProgress is not Noneelse None)diff --git a/autogpt_platform/backend/backend/data/onboarding_wizard_db_test.py b/autogpt_platform/backend/backend/data/onboarding_wizard_db_test.pynew file mode 100644index 0000000000..add999e01c--- /dev/null+++ b/autogpt_platform/backend/backend/data/onboarding_wizard_db_test.py@@ -0,0 +1,75 @@+"""Clearing the onboarding wizard's saved draft, against the real database.++Needs the database (``server`` starts the test stack). A mocked Prisma client+accepts payloads the real one refuses, such as a bare ``None`` for a Json column.+"""++import uuid++import pytest+from prisma.models import User, UserOnboarding++from backend.data.onboarding import (+ UserOnboardingUpdate,+ reset_user_onboarding,+ update_user_onboarding,+)+from backend.data.onboarding_wizard_test import wizard_progress+from backend.util.json import SafeJson+from backend.util.test import SpinTestServer++DRAFT_REVISION = 3+++async def users_with_drafts(server: SpinTestServer):+ user_ids = [f"onboarding-draft-{uuid.uuid4()}" for _ in range(2)]+ for user_id in user_ids:+ await User.prisma().create(+ data={"id": user_id, "email": f"{user_id}@example.com"}+ )+ await UserOnboarding.prisma().create(+ data={+ "userId": user_id,+ "wizardProgress": SafeJson(wizard_progress()),+ "wizardRevision": DRAFT_REVISION,+ }+ )+ yield user_ids+ await User.prisma().delete_many(where={"id": {"in": user_ids}})+++async def test_reset_clears_only_the_users_own_draft(users_with_drafts):+ user_id, other_user_id = users_with_drafts++ await reset_user_onboarding(user_id)++ reset = await read_row(user_id)+ other = await read_row(other_user_id)+ assert (reset.wizardProgress, reset.wizardRevision) == (None, DRAFT_REVISION + 1)+ assert (other.wizardProgress, other.wizardRevision) == (+ wizard_progress(),+ DRAFT_REVISION,+ )+++async def test_explicit_null_clears_the_draft(users_with_drafts):+ user_id, _ = users_with_drafts++ await update_user_onboarding(+ user_id,+ UserOnboardingUpdate.model_validate(+ {+ "wizardProgress": None,+ "wizardRevision": DRAFT_REVISION,+ "wizardUserId": user_id,+ }+ ),+ )++ row = await read_row(user_id)+ assert (row.wizardProgress, row.wizardRevision) == (None, DRAFT_REVISION + 1)+++async def read_row(user_id: str) -> UserOnboarding:+ return await UserOnboarding.prisma().find_unique_or_raise(where={"userId": user_id})diff --git a/autogpt_platform/backend/backend/data/onboarding_wizard_test.py b/autogpt_platform/backend/backend/data/onboarding_wizard_test.pyindex f5d2468463..08b688c14a 100644--- a/autogpt_platform/backend/backend/data/onboarding_wizard_test.py+++ b/autogpt_platform/backend/backend/data/onboarding_wizard_test.py@@ -8,7 +8,6 @@ from backend.data.model import UserOnboardingfrom backend.data.onboarding import (UserOnboardingUpdate,get_user_onboarding,- reset_user_onboarding,update_user_onboarding,)from backend.util.json import SafeJson@@ -154,19 +153,6 @@ async def test_reading_draft_scopes_each_authenticated_user(mocker):assert second.userId == "user-two"[email protected](loop_scope="function")-async def test_reset_clears_only_the_authenticated_users_draft(mocker):- prisma = mocker.patch("backend.data.onboarding.UserOnboarding.prisma")- prisma.return_value.upsert = AsyncMock()-- await reset_user_onboarding("authenticated-user")-- call = prisma.return_value.upsert.call_args- assert call.kwargs["where"] == {"userId": "authenticated-user"}- assert call.kwargs["data"]["update"]["wizardProgress"] is None- assert call.kwargs["data"]["update"]["wizardRevision"] == {"increment": 1}--@pytest.mark.asyncio(loop_scope="function")async def test_unrelated_update_does_not_overwrite_draft(mocker):prisma = mocker.patch("backend.data.onboarding.UserOnboarding.prisma")@@ -179,24 +165,6 @@ async def test_unrelated_update_does_not_overwrite_draft(mocker):}[email protected](loop_scope="function")-async def test_explicit_null_clears_draft(mocker, draft_transaction):- prisma = mocker.patch("backend.data.onboarding.UserOnboarding.prisma")- prisma.return_value.upsert = AsyncMock(return_value=Mock(notified=[]))-- await update_user_onboarding(- "user-one",- UserOnboardingUpdate.model_validate(- {"wizardProgress": None, "wizardRevision": 0, "wizardUserId": "user-one"}- ),- )-- assert draft_transaction.useronboarding.update_many.call_args.kwargs["data"] == {- "wizardProgress": None,- "wizardRevision": {"increment": 1},- }--def test_response_exposes_nullable_typed_progress():schema = UserOnboarding.model_json_schema()