serve what the frontend screens actually need

صفحه‌های فرانت خوانده شدند و با API مقایسه شدند. ساختارِ ما از کتابِ واقعی
درآمده و درست‌تر است، پس مدل عوض نشد — ولی چند چیز کم داشت.

مهم‌ترینش یک باگ بود: /api/home پارامتر را `grade` می‌خواند و کلاینتی که به
فرانت فرستادیم `gradeId` می‌فرستد. پارامترِ ناشناخته بی‌صدا نادیده گرفته
می‌شد، یعنی کاربر پایه‌ای را انتخاب می‌کرد و نقشه‌ی پایه‌ی دیگری می‌دید
بدونِ هیچ خطایی. حالا هر دو نام پذیرفته می‌شوند (`gradeId` نامِ درست است،
با بقیه‌ی API یکی). تستِ سرتاسریِ قبلی این را نگرفته بود چون home را بدونِ
آرگومان صدا زده بود.

/api/grades حالا lessonCount می‌دهد. فهرستِ پایه‌های فرانت تا دوازدهم است
ولی محتوای ما تا نهم؛ بدونِ این عدد، کاربر پایه‌ی خالی را انتخاب می‌کند و
صفحه‌ی خالی می‌بیند بی‌آنکه بفهمد چرا.

GET /api/nodes/{id}/lessons اضافه شد. /api/home فقط شناسه‌ی درس‌ها را
می‌دهد، ولی نقشه‌ی مهارت برای هر قدم عنوان، نوع، زیرنویس و «انجام شد» لازم
دارد — بدونش فرانت باید برای هر درس یک intro جدا می‌گرفت.

Lesson حالا kind (آزمون/ویدیو) و متنِ سه‌تکه دارد: توضیح، مثال، حلِ
گام‌به‌گام. ویدیو از قبل سوالِ بازِ محصول بود و فرانت آیتمش را دارد؛ حالا
API می‌تواند بیانش کند، حتی اگر محتوایش بعداً بیاید. Unit یک blurb گرفت و
Node آیکون و رنگ، تا فرانت رنگ‌ها را هاردکد نکند. هیچ‌کدام اجباری نیست، پس
محتوای موجود دست‌نخورده کار می‌کند.

PATCH /api/user/profile حالا age را هم می‌پذیرد (صفحه‌ی ثبت‌نامِ فرانت سن
می‌پرسد). ذخیره‌سازی همچنان birthYear است چون کهنه نمی‌شود؛ این فقط ورودی
را ترجمه می‌کند تا دو طرف حسابِ متفاوت درنیاورند.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
2026-09-14 01:42:24 +03:30
parent 8effe5b60b
commit 99a0cafe24
7 changed files with 386 additions and 7 deletions

View File

@@ -0,0 +1,152 @@
"""
تست‌های قراردادِ API با صفحه‌های فرانت.
این‌ها از روی خودِ کدِ فرانت نوشته شده‌اند، نه از روی حدس: هر صفحه داده‌ی
مشخصی هاردکد داشت و اینجا بررسی می‌شود که API همان شکل را می‌دهد. بدونِ
این‌ها، هر بارِ بعدی که سریالایزری عوض شود، شکستن فقط در مرورگر معلوم می‌شد.
"""
from django.core.cache import cache
from django.test import TestCase
from django.urls import reverse
from accounts.models import User
from content.models import (
Choice, Grade, Lesson, Node, Question, Unit, UserLessonCompletion,
)
class GradePickerTests(TestCase):
"""صفحه‌ی انتخابِ پایه نباید پایه‌ی خالی را مثلِ پایه‌ی پر نشان دهد."""
def setUp(self):
cache.clear()
def test_grades_report_whether_they_have_any_content(self):
full = Grade.objects.create(title='پایه نهم', icon='g9', color='#FF9800')
Grade.objects.create(title='پایه یازدهم', icon='g11', color='#111111')
unit = Unit.objects.create(grade=full, title='فصل ۱', order=1)
node = Node.objects.create(unit=unit, title='درس ۱', order=1)
Lesson.objects.create(node=node, title='نوع ۱', intro_text='x')
rows = {g['title']: g['lessonCount'] for g in self.client.get('/api/grades').json()['grades']}
self.assertEqual(rows['پایه نهم'], 1)
self.assertEqual(rows['پایه یازدهم'], 0)
class SkillMapTests(TestCase):
"""نقشه‌ی مهارت برای هر قدم عنوان، نوع، زیرنویس و «انجام شد» می‌خواهد."""
def setUp(self):
cache.clear()
grade = Grade.objects.create(title='پایه نهم', icon='', color='')
unit = Unit.objects.create(grade=grade, title='فصل ۴', blurb='توان و ریشه', order=4)
self.node = Node.objects.create(unit=unit, title='توان صحیح',
icon='power', color='#ED6956', order=1)
self.quiz = Lesson.objects.create(node=self.node, title='آزمون توان',
intro_text='x', kind='quiz')
self.video = Lesson.objects.create(node=self.node, title='ویدیوی توان',
intro_text='y', kind='video',
video_url='https://example.com/v.mp4',
duration_minutes=12)
q = Question.objects.create(lesson=self.quiz, type='multiple_choice', prompt='؟')
Choice.objects.create(question=q, value='۱', is_correct=True)
self.user = User.objects.create(phone='09120000001')
from accounts.authentication import issue_access_token
token = issue_access_token(self.user.id)
self.auth = {'HTTP_AUTHORIZATION': f'Bearer {token}'}
def _lessons(self, **extra):
url = reverse('node-lessons', args=[self.node.pk])
return self.client.get(url, **extra).json()
def test_each_step_carries_what_the_card_shows(self):
rows = {r['title']: r for r in self._lessons()['lessons']}
self.assertEqual(rows['آزمون توان']['kind'], 'quiz')
self.assertEqual(rows['آزمون توان']['meta'], '1 سوال')
self.assertEqual(rows['ویدیوی توان']['kind'], 'video')
self.assertEqual(rows['ویدیوی توان']['meta'], '12 دقیقه')
def test_done_is_false_for_a_guest_and_true_after_completion(self):
self.assertFalse(any(r['done'] for r in self._lessons()['lessons']))
UserLessonCompletion.objects.create(user_id=self.user.id, lesson=self.quiz,
correct_count=1, stars=3)
rows = {r['title']: r for r in self._lessons(**self.auth)['lessons']}
self.assertTrue(rows['آزمون توان']['done'])
self.assertFalse(rows['ویدیوی توان']['done'])
def test_home_carries_the_visual_fields_the_topic_cards_need(self):
response = self.client.get(f'/api/home?gradeId={self.node.unit.grade_id}',
**self.auth)
unit = response.json()['units'][0]
self.assertEqual(unit['blurb'], 'توان و ریشه')
self.assertEqual(unit['nodes'][0]['icon'], 'power')
self.assertEqual(unit['nodes'][0]['color'], '#ED6956')
class LessonContentTests(TestCase):
"""صفحه‌ی درس سه تکه می‌خواهد: توضیح، مثال، حلِ گام‌به‌گام."""
def setUp(self):
cache.clear()
grade = Grade.objects.create(title='پایه نهم', icon='', color='')
unit = Unit.objects.create(grade=grade, title='فصل ۱', order=1)
node = Node.objects.create(unit=unit, title='درس ۱', order=1)
self.lesson = Lesson.objects.create(
node=node, title='بردار', intro_text='یک بردار پیکان است.',
example='a = (۳, ۴) → |a| = ۵',
steps=['مؤلفه‌ها را بنویس', 'اندازه را حساب کن'],
)
def test_intro_returns_all_three_parts(self):
data = self.client.get(f'/api/lessons/{self.lesson.pk}/intro').json()
self.assertEqual(data['introText'], 'یک بردار پیکان است.')
self.assertEqual(data['example'], 'a = (۳, ۴) → |a| = ۵')
self.assertEqual(len(data['steps']), 2)
self.assertEqual(data['kind'], 'quiz')
def test_existing_content_without_the_new_fields_still_works(self):
"""محتوای ساخته‌شده example و steps ندارد؛ نباید بشکند."""
bare = Lesson.objects.create(node=self.lesson.node, title='قدیمی', intro_text='z')
data = self.client.get(f'/api/lessons/{bare.pk}/intro').json()
self.assertEqual(data['example'], '')
self.assertEqual(data['steps'], [])
self.assertIsNone(data['durationMinutes'])
class HomeGradeParamTests(TestCase):
"""
کلاینتِ فرانت `?gradeId=` می‌فرستد ولی نسخه‌ی اولِ این اندپوینت `?grade=`
می‌خواند — و پارامترِ ناشناخته بی‌صدا نادیده گرفته می‌شد، یعنی کاربر نقشه‌ی
پایه‌ی دیگری را می‌دید بدونِ هیچ خطایی.
"""
def setUp(self):
cache.clear()
self.a = Grade.objects.create(title='پایه هفتم', icon='', color='')
self.b = Grade.objects.create(title='پایه نهم', icon='', color='')
for grade, unit_title in ((self.a, 'فصلِ هفتم'), (self.b, 'فصلِ نهم')):
unit = Unit.objects.create(grade=grade, title=unit_title, order=1)
node = Node.objects.create(unit=unit, title='درس', order=1)
Lesson.objects.create(node=node, title='نوع', intro_text='x')
user = User.objects.create(phone='09120000002', grade_id=self.a.id)
from accounts.authentication import issue_access_token
self.auth = {'HTTP_AUTHORIZATION': f'Bearer {issue_access_token(user.id)}'}
def _titles(self, query=''):
data = self.client.get(f'/api/home{query}', **self.auth).json()
return [u['title'] for u in data['units']]
def test_grade_id_selects_that_grade(self):
self.assertEqual(self._titles(f'?gradeId={self.b.id}'), ['فصلِ نهم'])
def test_the_old_grade_name_still_works(self):
self.assertEqual(self._titles(f'?grade={self.b.id}'), ['فصلِ نهم'])
def test_without_a_parameter_the_users_own_grade_is_used(self):
self.assertEqual(self._titles(), ['فصلِ هفتم'])
def test_an_unknown_grade_is_a_clean_404_not_a_silent_fallback(self):
self.assertEqual(self.client.get('/api/home?gradeId=999999', **self.auth).status_code, 404)