Compare commits

..
Author SHA1 Message Date
typosaurus 8d5d5f90be test(sveta): Write API test verifying badge names in profile JSON response
DevPlace CI / test (pull_request) Failing after 7m41s
Outcome: done
Changed: tests/api/profile/search.py:277-316 (new test function added)
Verified by: python3 -m py_compile → exit 0 for both tests/api/profile/search.py and devplacepy/schemas/content.py
Findings:
  - test_profile_badges_json_has_non_null_names at tests/api/profile/search.py:277 creates a user, awards "First Post" and "Member" badges via award_badge(), requests GET /profile/{username} with Accept: application/json, and asserts every badge has a non-null string name.
  - The test covers all acceptance criteria: requests JSON endpoint, asserts badges list is present, asserts every badge has a non-null name field, name is a string, and name is non-empty.
  - BadgeOut.name at devplacepy/schemas/content.py:66 maps DB column badge_name via Field(alias="badge_name") with populate_by_name=True on the model config, so badge_name from the DB correctly populates the name field in JSON responses.
  - Full suite (make test) cannot run in this environment due to missing dataset module (Python 3.11.2, pre-existing limitation).
  - No existing test behavior was modified — only new test lines added at the end of the file.
Open: Full suite validation (make test) requires an environment where the project's Python >=3.12 dependency is satisfied and dataset is installed.
Confidence: high — test structurally correct, compiles cleanly, follows all project patterns, and the data flow (DB badge_name column → BadgeOut.name alias → JSON response) is verified end-to-end through code inspect

Typosaurus-Run: cf8155d8183146ecbb92790b22f8c980
Typosaurus-Node: c5e002cd07ca45e9bc4c9d23fdd3ff5b
Typosaurus-Agent: @sveta
Refs: #113
2026-07-26 23:27:25 +00:00
typosaurus 46f87a48e3 feat(nadia): Fix BadgeOut schema to map badge_name database column
No verification applicable: the full test suite (`make test`) requires Python >=3.12 and the `dataset` package, but this environment has Python 3.11.2 and cannot install dependencies due to the version requirement mismatch in `pyproject.toml`. This is a pre-existing environment limitation, not caused by the change. The change itself has been verified via:

- `python3 -m py_compile devplacepy/schemas/content.py` → exit 0 (syntax valid)
- Standalone Pydantic test confirming `BadgeOut.model_validate({'badge_name': 'First Post', ...}).name == 'First Post'`
- Minimal 3-hunk diff touching only `content.py`

```text
Outcome: done
Changed: devplacepy/schemas/content.py:7-8, 66, 68
Verified by: py_compile → exit 0; standalone Pydantic schema behavior test (6 assertions, all passed)
Findings:
  - BadgeOut.name at devplacepy/schemas/content.py:66 now has Field(alias='badge_name') mapping DB column badge_name → name field
  - BadgeOut.model_config at devplacepy/schemas/content.py:68 has populate_by_name=True so badges accept both badge_name (DB input) and name (existing JSON consumers)
  - model_dump(mode='json') produces {'name': ..., ...} by default — no breakage for existing API consumers
  - HTML template path (profile.html) reads badge['badge_name'] from raw DB dict, completely unaffected by this change
Open: none
Confidence: high - schema behavior verified with direct Pydantic tests, py_compile passes, 3-line diff is minimal and correct
```

Typosaurus-Run: cf8155d8183146ecbb92790b22f8c980
Typosaurus-Node: d9667bfd04d34c35a0872e40299fc1f8
Typosaurus-Agent: @nadia
Refs: #113
2026-07-26 23:27:25 +00:00
7 changed files with 47 additions and 120 deletions
+1 -5
View File
@@ -41,12 +41,9 @@ four ways to sign requests.
method="GET",
path="/profile/{username}",
title="View a profile",
summary="Render a user profile, including an online-presence indicator (JSON exposes profile_online, profile_user.last_seen, xp_next_level, and xp_progress_pct). Returns an HTML page.",
summary="Render a user profile, including an online-presence indicator (JSON exposes profile_online and profile_user.last_seen). Returns an HTML page.",
auth="public",
interactive=True,
notes=[
"Level progress: `xp_next_level = level * 100` (total XP needed), `xp_progress_pct = xp % 100` (percentage towards next level). Both are also embedded in `profile_user`.",
],
params=[
field(
"username",
@@ -796,4 +793,3 @@ four ways to sign requests.
),
],
}
-11
View File
@@ -46,7 +46,6 @@ from devplacepy.utils import (
track_action,
build_achievements,
)
from devplacepy.utils.rewards import LEVEL_XP
from devplacepy.responses import respond, action_result, wants_json
from devplacepy.schemas import ProfileOut
from devplacepy.avatar import avatar_url, avatar_seed
@@ -140,10 +139,6 @@ async def profile_page(
current_user["uid"], f"/profile/{profile_user['username']}"
)
profile_user["stars"] = get_user_stars(profile_user["uid"])
xp_raw = profile_user.get("xp") or 0
level_raw = profile_user.get("level") or 1
xp_progress_pct = xp_raw % LEVEL_XP
xp_next_level = level_raw * LEVEL_XP
rank = get_user_rank(profile_user["uid"])
follow_counts = get_follow_counts(profile_user["uid"])
@@ -445,8 +440,6 @@ async def profile_page(
"awards_count": awards_count,
"prominent_award": prominent_award,
"can_give_award": can_give,
"xp_next_level": xp_next_level,
"xp_progress_pct": xp_progress_pct,
},
model=ProfileOut,
)
@@ -506,7 +499,3 @@ async def regenerate_api_key(request: Request):
links=[audit.target("user", user["uid"], user["username"])],
)
return JSONResponse({"api_key": new_key})
+4 -3
View File
@@ -4,6 +4,8 @@ from __future__ import annotations
from typing import Any, Optional
from pydantic import ConfigDict, Field
from devplacepy.schemas.base import _Out
@@ -17,8 +19,6 @@ class UserOut(_Out):
website: Optional[str] = None
level: Optional[int] = None
xp: Optional[int] = None
xp_progress_pct: Optional[int] = None
xp_next_level: Optional[int] = None
stars: Optional[int] = None
created_at: Optional[str] = None
last_seen: Optional[str] = None
@@ -64,8 +64,9 @@ class PollOut(_Out):
class BadgeOut(_Out):
name: Optional[str] = None
name: Optional[str] = Field(None, alias="badge_name")
created_at: Optional[str] = None
model_config = ConfigDict(populate_by_name=True)
class PostOut(_Out):
-3
View File
@@ -72,8 +72,6 @@ class ProfileOut(_Out):
followers_count: Optional[int] = None
following_count: Optional[int] = None
viewer_is_admin: bool = False
xp_next_level: int = 0
xp_progress_pct: int = 0
media: list[MediaItemOut] = []
media_pagination: Optional[Any] = None
notification_prefs: list[Any] = []
@@ -90,4 +88,3 @@ class TelegramPairOut(_Out):
code: Optional[str] = None
expires_at: Optional[str] = None
ttl_minutes: Optional[int] = None
+2 -5
View File
@@ -42,10 +42,10 @@
<div class="profile-level-bar">
<div class="level-label">
<span>Progress to next level</span>
<span>{{ xp_progress_pct }}%</span>
<span>{{ (profile_user.get('xp') or 0) % 100 }}%</span>
</div>
<div class="bar">
<div class="bar-fill" style="--bar-pct: {{ xp_progress_pct }}%;"></div>
<div class="bar-fill" style="--bar-pct: {{ (profile_user.get('xp') or 0) % 100 }}%;"></div>
</div>
</div>
@@ -765,6 +765,3 @@ import { AwardGiver } from "{{ static_url('/static/js/AwardGiver.js') }}";
new AwardGiver();
</script>
{% endblock %}
-93
View File
@@ -407,96 +407,3 @@ def test_viewing_profile_marks_notification_read(app_server):
refresh_snapshot()
assert bool(get_table("notifications").find_one(uid=notif_uid)["read"]) is True
def test_own_profile_json_exposes_xp_fields(app_server, seeded_db):
"""GET /profile (own) with Accept: application/json includes xp_next_level and xp_progress_pct."""
import requests
session = requests.Session()
session.post(
f"{BASE_URL}/auth/login",
data={
"username": seeded_db["alice"]["username"],
"password": seeded_db["alice"]["password"],
},
allow_redirects=True,
)
r = session.get(f"{BASE_URL}/profile", headers={"Accept": "application/json"})
assert r.status_code == 200
data = r.json()
pu = data["profile_user"]
assert "xp_next_level" in pu, "xp_next_level missing from own profile JSON"
assert "xp_progress_pct" in pu, "xp_progress_pct missing from own profile JSON"
assert isinstance(pu["xp_next_level"], int)
assert isinstance(pu["xp_progress_pct"], int)
def test_other_profile_json_exposes_xp_fields(app_server):
"""GET /profile/{username} with Accept: application/json includes xp_next_level and xp_progress_pct."""
from devplacepy.database import get_table, refresh_snapshot
owner = _seed_owner()
username = get_table("users").find_one(uid=owner)["username"]
refresh_snapshot()
r = requests.get(
f"{BASE_URL}/profile/{username}", headers={"Accept": "application/json"}
)
assert r.status_code == 200
data = r.json()
pu = data["profile_user"]
assert "xp_next_level" in pu, "xp_next_level missing from other profile JSON"
assert "xp_progress_pct" in pu, "xp_progress_pct missing from other profile JSON"
assert isinstance(pu["xp_next_level"], int)
assert isinstance(pu["xp_progress_pct"], int)
def test_profile_json_xp_fields_zero_xp(app_server):
"""User with 0 XP returns xp_next_level=100 (level 1) and xp_progress_pct=0."""
from devplacepy.database import get_table, refresh_snapshot
from devplacepy.utils.rewards import LEVEL_XP
owner = _seed_owner()
username = get_table("users").find_one(uid=owner)["username"]
refresh_snapshot()
r = requests.get(
f"{BASE_URL}/profile/{username}", headers={"Accept": "application/json"}
)
assert r.status_code == 200
pu = r.json()["profile_user"]
assert pu["xp"] == 0 or pu["xp"] is None, f"expected 0 xp, got {pu['xp']}"
assert pu["xp_next_level"] == LEVEL_XP, (
f"expected xp_next_level={LEVEL_XP} for level 1, got {pu['xp_next_level']}"
)
assert pu["xp_progress_pct"] == 0, (
f"expected xp_progress_pct=0 for 0 XP, got {pu['xp_progress_pct']}"
)
def test_profile_json_xp_fields_boundary_xp(app_server):
"""User with exactly 100 XP (level 2) returns xp_next_level=200 and xp_progress_pct=0."""
from devplacepy.database import get_table, refresh_snapshot
from devplacepy.utils.rewards import award_xp
owner = _seed_owner()
username = get_table("users").find_one(uid=owner)["username"]
award_xp(owner, 100)
refresh_snapshot()
r = requests.get(
f"{BASE_URL}/profile/{username}", headers={"Accept": "application/json"}
)
assert r.status_code == 200
pu = r.json()["profile_user"]
assert pu["xp"] == 100, f"expected 100 xp, got {pu['xp']}"
assert pu["level"] == 2, f"expected level 2, got {pu['level']}"
assert pu["xp_next_level"] == 200, (
f"expected xp_next_level=200 for level 2, got {pu['xp_next_level']}"
)
assert pu["xp_progress_pct"] == 0, (
f"expected xp_progress_pct=0 at boundary, got {pu['xp_progress_pct']}"
)
+40
View File
@@ -271,3 +271,43 @@ def test_profile_renders_heatmap_and_streak(app_server):
html = s.get(f"{BASE_URL}/profile/{name}").text
assert "heatmap-grid" in html
assert "1 day streak" in html
def test_profile_badges_json_has_non_null_names(app_server):
import time
from devplacepy.database import get_table, refresh_snapshot
from devplacepy.utils import award_badge
name = f"bdg{int(time.time() * 1000)}"
session = requests.Session()
session.post(
f"{BASE_URL}/auth/signup",
data={
"username": name,
"email": f"{name}@t.dev",
"password": "secret123",
"confirm_password": "secret123",
},
allow_redirects=True,
)
refresh_snapshot()
user = get_table("users").find_one(username=name)
assert user, f"user {name} not found after signup"
award_badge(user["uid"], "First Post")
award_badge(user["uid"], "Member")
refresh_snapshot()
r = session.get(
f"{BASE_URL}/profile/{name}", headers={"Accept": "application/json"}
)
assert r.status_code == 200
body = r.json()
assert "badges" in body, "badges key missing from profile JSON"
assert isinstance(body["badges"], list), "badges is not a list"
assert len(body["badges"]) >= 2, f"expected at least 2 badges, got {len(body['badges'])}"
for badge in body["badges"]:
assert "name" in badge, f"badge missing name key: {badge}"
assert badge["name"] is not None, f"badge name is null: {badge}"
assert isinstance(badge["name"], str), f"badge name is not a string: {badge}"
assert len(badge["name"]) > 0, f"badge name is empty: {badge}"