Add Profile model + migration + own-profile endpoints (US-3)
Implements user profile data model and own-profile management endpoints: - Profile and ProfileFavorites models in backend/app/models/profile.py - Migration 0010_add_profile_tables.py (profiles, profile_favorites) - Endpoints in backend/app/routers/profiles.py: - GET /api/profile/me (own profile with default fallback) - PUT /api/profile/me (upsert bio, avatar_asset_id, privacy settings) - GET /api/profile/me/favorites (list favorite world IDs) - PUT /api/profile/me/favorites (replace favorite world IDs) - Fixes values_callable on Asset.asset_type ENUM in app/models/asset.py - Added test_profile.py covering auth, validation, favorites, privacy Independently re-verified: 19/19 new profile tests pass, 258/258 full backend regression suite passes with zero regressions.
This commit is contained in:
+2
-1
@@ -6,7 +6,7 @@ from fastapi import FastAPI
|
||||
from fastapi.middleware.cors import CORSMiddleware
|
||||
|
||||
from app.config import settings
|
||||
from app.routers import auth, users, worlds, assets, avatar, world_content, internal, presence, groups, social_friends
|
||||
from app.routers import auth, users, worlds, assets, avatar, world_content, internal, presence, groups, social_friends, profiles
|
||||
|
||||
|
||||
from app.services.game_servers import supervisor
|
||||
@@ -47,6 +47,7 @@ app.include_router(internal.router, prefix="/api/internal", tags=["internal"])
|
||||
app.include_router(presence.router, prefix="/api/presence", tags=["presence"])
|
||||
app.include_router(groups.router, prefix="/api/groups", tags=["groups"])
|
||||
app.include_router(social_friends.router, prefix="/api/friends", tags=["friends"])
|
||||
app.include_router(profiles.router, prefix="/api/profile", tags=["profile"])
|
||||
|
||||
|
||||
@app.get("/api/health")
|
||||
|
||||
@@ -9,6 +9,7 @@ from app.models.chat import (
|
||||
Conversation, ConversationParticipant, Message, MessageReport, ReportStatus,
|
||||
)
|
||||
from app.models.groups import Group, GroupMember, GroupRole
|
||||
from app.models.profile import Profile, ProfileFavorite, ProfileVisibility
|
||||
|
||||
__all__ = [
|
||||
"User", "Session", "World", "Asset", "AvatarLoadout",
|
||||
@@ -16,4 +17,5 @@ __all__ = [
|
||||
"Friendship", "Follow", "Block", "FriendshipStatus",
|
||||
"Conversation", "ConversationParticipant", "Message", "MessageReport", "ReportStatus",
|
||||
"Group", "GroupMember", "GroupRole",
|
||||
"Profile", "ProfileFavorite", "ProfileVisibility",
|
||||
]
|
||||
|
||||
@@ -23,7 +23,12 @@ class Asset(Base):
|
||||
name = Column(String(255), nullable=False)
|
||||
description = Column(Text, nullable=True)
|
||||
asset_type = Column(
|
||||
ENUM(AssetType, name="asset_type", create_type=False),
|
||||
ENUM(
|
||||
AssetType,
|
||||
name="asset_type",
|
||||
create_type=False,
|
||||
values_callable=lambda enum_cls: [e.value for e in enum_cls],
|
||||
),
|
||||
nullable=False,
|
||||
)
|
||||
file_path = Column(String(512), nullable=False)
|
||||
|
||||
@@ -0,0 +1,129 @@
|
||||
"""User profile: bio, avatar reference, privacy settings, favorite worlds.
|
||||
|
||||
This module is models + migration only -- the public profile view endpoint
|
||||
(``GET /api/profile/{user_id}``, which will need to interpret ``privacy_json``
|
||||
against the viewer's relationship to the owner) belongs to a sibling task
|
||||
that depends on this one. This task only owns the authenticated-owner
|
||||
read/write endpoints (``/api/profile/me`` and its ``favorites`` sub-resource).
|
||||
|
||||
Design choices:
|
||||
|
||||
- ``profiles.user_id`` is both the primary key and the FK to ``users.id``
|
||||
(``ondelete="CASCADE"``) -- exactly one profile row per user, following the
|
||||
same one-row-per-user shape as ``AvatarLoadout`` (app/models/avatar_loadout.py).
|
||||
The row is created lazily (upserted) on first ``PUT /api/profile/me``
|
||||
rather than at registration time, again mirroring ``AvatarLoadout``.
|
||||
- ``avatar_asset_id`` -> ``assets.id`` with ``ondelete="SET NULL"``. A
|
||||
profile's chosen "avatar picture" asset is a soft reference: if the
|
||||
underlying asset is later deleted the profile shouldn't be destroyed or
|
||||
left pointing at a dangling id, it should just fall back to "no avatar
|
||||
picture set" (nullable). The API layer additionally validates on write
|
||||
that the referenced asset actually exists (existence is not enforced by
|
||||
the FK alone at the API layer, since the FK only stops inserts of a
|
||||
nonexistent id -- it doesn't tell the caller *why* their PUT failed).
|
||||
- ``bio`` is ``Text`` with the 500-char cap enforced at the API/schema layer
|
||||
(Pydantic ``max_length``), matching how ``StatusUpdate.status_message`` in
|
||||
presence.py enforces its length cap in the router rather than the schema.
|
||||
- ``privacy_json`` is JSONB (project convention for document-shaped fields --
|
||||
see avatar_loadout.py, world_content.py) holding exactly three keys, each a
|
||||
``ProfileVisibility`` enum value (stored as its string value in JSON, not a
|
||||
Postgres ENUM type -- there's no need for a DB-level enum since this is a
|
||||
small, entirely API-validated document, and a plain JSONB column is easier
|
||||
to extend with more privacy keys later without a migration):
|
||||
- ``profile_visibility``: who can view the profile at all.
|
||||
- ``friends_list_visibility``: who can see the user's friends list.
|
||||
- ``favorites_visibility``: who can see the user's favorited worlds.
|
||||
Each value is one of "public", "friends", "private". Defaults (applied when
|
||||
a profile is first created) are all "public" -- the least surprising
|
||||
default for a new social feature, matching the "everything visible unless
|
||||
you lock it down" posture other social features here take by default
|
||||
(e.g. presence/status has no privacy gate at all yet).
|
||||
- Favorites use a join table (``profile_favorites``: ``user_id`` + ``world_id``,
|
||||
composite PK) rather than a JSON array column. A plain FK join table gets
|
||||
referential integrity for free (a favorited world that's later deleted
|
||||
disappears from favorites automatically via ON DELETE CASCADE, matching
|
||||
how ``World.assets``/``World.rooms`` cascade), lets Postgres enforce
|
||||
"no duplicate favorite" via the composite PK instead of API-layer
|
||||
deduplication, and keeps "does this world still exist" as a DB invariant
|
||||
rather than something every reader has to re-check against a JSON blob.
|
||||
The tradeoff (an extra table/join vs. a single JSON column) is worth it
|
||||
here because favorites are a list of foreign-key references, not a
|
||||
free-form document -- the exact case join tables suit better than JSONB.
|
||||
"""
|
||||
import enum
|
||||
|
||||
from sqlalchemy import Column, Integer, ForeignKey, Text, DateTime
|
||||
from sqlalchemy.dialects.postgresql import JSONB
|
||||
from sqlalchemy.orm import relationship
|
||||
from sqlalchemy.sql import func
|
||||
|
||||
from app.database import Base
|
||||
|
||||
|
||||
class ProfileVisibility(str, enum.Enum):
|
||||
PUBLIC = "public"
|
||||
FRIENDS = "friends"
|
||||
PRIVATE = "private"
|
||||
|
||||
|
||||
# Applied when a profile is created for the first time (lazy upsert on the
|
||||
# first PUT /api/profile/me). Keys match the three privacy_json fields
|
||||
# documented above.
|
||||
DEFAULT_PRIVACY: dict = {
|
||||
"profile_visibility": ProfileVisibility.PUBLIC.value,
|
||||
"friends_list_visibility": ProfileVisibility.PUBLIC.value,
|
||||
"favorites_visibility": ProfileVisibility.PUBLIC.value,
|
||||
}
|
||||
|
||||
BIO_MAX_LEN = 500
|
||||
|
||||
|
||||
class Profile(Base):
|
||||
"""One row per user: bio, avatar picture reference, privacy settings."""
|
||||
|
||||
__tablename__ = "profiles"
|
||||
|
||||
user_id = Column(
|
||||
Integer,
|
||||
ForeignKey("users.id", ondelete="CASCADE"),
|
||||
primary_key=True,
|
||||
)
|
||||
avatar_asset_id = Column(
|
||||
Integer,
|
||||
ForeignKey("assets.id", ondelete="SET NULL"),
|
||||
nullable=True,
|
||||
)
|
||||
bio = Column(Text, nullable=True)
|
||||
privacy_json = Column(JSONB, nullable=False, server_default="{}")
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
updated_at = Column(DateTime(timezone=True), server_default=func.now(), onupdate=func.now(), nullable=False)
|
||||
|
||||
user = relationship("User", back_populates="profile")
|
||||
avatar_asset = relationship("Asset")
|
||||
# Deliberately no ORM relationship to ProfileFavorite here: profiles and
|
||||
# profile_favorites both independently FK users.id (no direct FK between
|
||||
# the two tables), and the router only ever needs to query/replace a
|
||||
# user's favorites by user_id directly -- not traverse it off a loaded
|
||||
# Profile object. Keeping it a plain queryable table avoids a
|
||||
# hand-spelled, easy-to-get-wrong primaryjoin for no real benefit.
|
||||
|
||||
|
||||
class ProfileFavorite(Base):
|
||||
"""A user's favorited world. Composite PK -- see module docstring for why
|
||||
this is a join table rather than a JSON array column."""
|
||||
|
||||
__tablename__ = "profile_favorites"
|
||||
|
||||
user_id = Column(
|
||||
Integer,
|
||||
ForeignKey("users.id", ondelete="CASCADE"),
|
||||
primary_key=True,
|
||||
)
|
||||
world_id = Column(
|
||||
Integer,
|
||||
ForeignKey("worlds.id", ondelete="CASCADE"),
|
||||
primary_key=True,
|
||||
)
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
|
||||
world = relationship("World")
|
||||
@@ -35,6 +35,14 @@ class User(Base):
|
||||
cascade="all, delete-orphan",
|
||||
)
|
||||
|
||||
# Profile (app/models/profile.py): bio/avatar picture/privacy + favorites.
|
||||
profile = relationship(
|
||||
"Profile",
|
||||
back_populates="user",
|
||||
uselist=False,
|
||||
cascade="all, delete-orphan",
|
||||
)
|
||||
|
||||
# Social graph (docs/planning/social.md US-1; app/models/social.py)
|
||||
sent_friend_requests = relationship(
|
||||
"Friendship",
|
||||
|
||||
@@ -0,0 +1,205 @@
|
||||
"""Profile router -- the authenticated user's own profile + favorites.
|
||||
|
||||
Endpoints:
|
||||
- GET /api/profile/me -- read own profile (server default if none saved)
|
||||
- PUT /api/profile/me -- upsert bio/avatar_asset_id/privacy
|
||||
- GET /api/profile/me/favorites -- list own favorited world ids
|
||||
- PUT /api/profile/me/favorites -- replace own favorited world ids
|
||||
|
||||
Only the authenticated owner can read/write their own profile via these
|
||||
routes -- there is no user_id path parameter here at all, so there's nothing
|
||||
to authorize against another user's data. The public profile view endpoint
|
||||
(GET /api/profile/{user_id}, which will need to apply privacy_json against
|
||||
the viewer's relationship to the owner) is a sibling task's responsibility.
|
||||
"""
|
||||
|
||||
from typing import Annotated
|
||||
|
||||
from fastapi import APIRouter, Depends, HTTPException
|
||||
from pydantic import BaseModel, Field, field_validator
|
||||
from sqlalchemy import select
|
||||
from sqlalchemy.ext.asyncio import AsyncSession
|
||||
|
||||
from app.database import get_db
|
||||
from app.dependencies import CurrentUser
|
||||
from app.models.asset import Asset
|
||||
from app.models.profile import (
|
||||
BIO_MAX_LEN,
|
||||
DEFAULT_PRIVACY,
|
||||
Profile,
|
||||
ProfileFavorite,
|
||||
ProfileVisibility,
|
||||
)
|
||||
from app.models.world import World
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
DbDep = Annotated[AsyncSession, Depends(get_db)]
|
||||
|
||||
_PRIVACY_KEYS = ("profile_visibility", "friends_list_visibility", "favorites_visibility")
|
||||
_VISIBILITY_VALUES = {v.value for v in ProfileVisibility}
|
||||
|
||||
|
||||
# ──────────────────────────── Pydantic schemas ────────────────────────────────
|
||||
|
||||
|
||||
class ProfileResponse(BaseModel):
|
||||
user_id: int
|
||||
avatar_asset_id: int | None
|
||||
bio: str | None
|
||||
privacy: dict[str, str]
|
||||
is_default: bool = Field(
|
||||
description="True when the user has never saved a profile and this "
|
||||
"is the server default (no bio/avatar, default-open privacy)."
|
||||
)
|
||||
|
||||
|
||||
class ProfileUpdate(BaseModel):
|
||||
bio: str | None = Field(default=None, max_length=BIO_MAX_LEN)
|
||||
avatar_asset_id: int | None = None
|
||||
privacy: dict[str, str] | None = None
|
||||
|
||||
@field_validator("bio")
|
||||
@classmethod
|
||||
def strip_bio(cls, v: str | None) -> str | None:
|
||||
if v is not None:
|
||||
v = v.strip()
|
||||
return v
|
||||
|
||||
|
||||
class FavoritesResponse(BaseModel):
|
||||
world_ids: list[int]
|
||||
|
||||
|
||||
class FavoritesUpdate(BaseModel):
|
||||
world_ids: list[int]
|
||||
|
||||
|
||||
# ──────────────────────────────── Helpers ─────────────────────────────────────
|
||||
|
||||
|
||||
def _validate_privacy(privacy: dict[str, str]) -> dict[str, str]:
|
||||
"""Validate privacy dict has exactly the allowed keys, each a valid
|
||||
ProfileVisibility value. Returns the dict unchanged (already valid) so
|
||||
callers can assign it straight to privacy_json."""
|
||||
extra = set(privacy.keys()) - set(_PRIVACY_KEYS)
|
||||
if extra:
|
||||
raise HTTPException(
|
||||
status_code=422,
|
||||
detail=f"privacy contains unknown key(s): {sorted(extra)}",
|
||||
)
|
||||
for key, value in privacy.items():
|
||||
if value not in _VISIBILITY_VALUES:
|
||||
raise HTTPException(
|
||||
status_code=422,
|
||||
detail=f"privacy.{key} must be one of {sorted(_VISIBILITY_VALUES)}, got {value!r}",
|
||||
)
|
||||
return privacy
|
||||
|
||||
|
||||
def _profile_response(row: Profile | None, user_id: int) -> ProfileResponse:
|
||||
if row is None:
|
||||
return ProfileResponse(
|
||||
user_id=user_id,
|
||||
avatar_asset_id=None,
|
||||
bio=None,
|
||||
privacy=dict(DEFAULT_PRIVACY),
|
||||
is_default=True,
|
||||
)
|
||||
privacy = dict(DEFAULT_PRIVACY)
|
||||
if row.privacy_json:
|
||||
privacy.update(row.privacy_json)
|
||||
return ProfileResponse(
|
||||
user_id=row.user_id,
|
||||
avatar_asset_id=row.avatar_asset_id,
|
||||
bio=row.bio,
|
||||
privacy=privacy,
|
||||
is_default=False,
|
||||
)
|
||||
|
||||
|
||||
# ──────────────────────────────── Endpoints ───────────────────────────────────
|
||||
|
||||
|
||||
@router.get("/me", response_model=ProfileResponse)
|
||||
async def get_my_profile(current_user: CurrentUser, db: DbDep):
|
||||
"""Return the authenticated user's profile, or the server default if
|
||||
they have never saved one."""
|
||||
row = await db.get(Profile, current_user.id)
|
||||
return _profile_response(row, current_user.id)
|
||||
|
||||
|
||||
@router.put("/me", response_model=ProfileResponse)
|
||||
async def update_my_profile(payload: ProfileUpdate, current_user: CurrentUser, db: DbDep):
|
||||
"""Upsert the authenticated user's bio/avatar_asset_id/privacy.
|
||||
|
||||
Only fields explicitly present in the request body are changed; omitted
|
||||
fields keep their current (or default, on first save) value.
|
||||
"""
|
||||
fields_set = payload.model_fields_set
|
||||
|
||||
if "avatar_asset_id" in fields_set and payload.avatar_asset_id is not None:
|
||||
asset = await db.get(Asset, payload.avatar_asset_id)
|
||||
if asset is None:
|
||||
raise HTTPException(status_code=422, detail="avatar_asset_id does not reference an existing asset")
|
||||
|
||||
validated_privacy = None
|
||||
if "privacy" in fields_set and payload.privacy is not None:
|
||||
validated_privacy = _validate_privacy(payload.privacy)
|
||||
|
||||
row = await db.get(Profile, current_user.id)
|
||||
if row is None:
|
||||
row = Profile(
|
||||
user_id=current_user.id,
|
||||
bio=payload.bio if "bio" in fields_set else None,
|
||||
avatar_asset_id=payload.avatar_asset_id if "avatar_asset_id" in fields_set else None,
|
||||
privacy_json={**DEFAULT_PRIVACY, **(validated_privacy or {})},
|
||||
)
|
||||
db.add(row)
|
||||
else:
|
||||
if "bio" in fields_set:
|
||||
row.bio = payload.bio
|
||||
if "avatar_asset_id" in fields_set:
|
||||
row.avatar_asset_id = payload.avatar_asset_id
|
||||
if validated_privacy is not None:
|
||||
merged = dict(row.privacy_json or DEFAULT_PRIVACY)
|
||||
merged.update(validated_privacy)
|
||||
row.privacy_json = merged
|
||||
|
||||
await db.commit()
|
||||
await db.refresh(row)
|
||||
return _profile_response(row, current_user.id)
|
||||
|
||||
|
||||
@router.get("/me/favorites", response_model=FavoritesResponse)
|
||||
async def get_my_favorites(current_user: CurrentUser, db: DbDep):
|
||||
"""List the authenticated user's favorited world ids."""
|
||||
result = await db.execute(
|
||||
select(ProfileFavorite.world_id).where(ProfileFavorite.user_id == current_user.id)
|
||||
)
|
||||
return FavoritesResponse(world_ids=[wid for wid in result.scalars().all()])
|
||||
|
||||
|
||||
@router.put("/me/favorites", response_model=FavoritesResponse)
|
||||
async def replace_my_favorites(payload: FavoritesUpdate, current_user: CurrentUser, db: DbDep):
|
||||
"""Replace the full set of the authenticated user's favorited worlds."""
|
||||
world_ids = list(dict.fromkeys(payload.world_ids)) # de-dupe, preserve order
|
||||
|
||||
if world_ids:
|
||||
result = await db.execute(select(World.id).where(World.id.in_(world_ids)))
|
||||
existing_ids = set(result.scalars().all())
|
||||
missing = [wid for wid in world_ids if wid not in existing_ids]
|
||||
if missing:
|
||||
raise HTTPException(
|
||||
status_code=422,
|
||||
detail=f"world_id(s) do not reference an existing world: {missing}",
|
||||
)
|
||||
|
||||
await db.execute(
|
||||
ProfileFavorite.__table__.delete().where(ProfileFavorite.user_id == current_user.id)
|
||||
)
|
||||
for wid in world_ids:
|
||||
db.add(ProfileFavorite(user_id=current_user.id, world_id=wid))
|
||||
|
||||
await db.commit()
|
||||
return FavoritesResponse(world_ids=world_ids)
|
||||
Reference in New Issue
Block a user