بتل کد Battle Codeدارد باز می‌شود…

جلسه‌ی 31: سرور کوییز، بخش ۱ The Quiz Server, Part 1

در دوره‌ی «اپ کوییز» صفحه‌ای ساختی که سؤال‌هایش را از یک سرور می‌گیرد. حالا خود آن سرور را می‌سازی: سؤال‌ها در یک جدول SQL، مسیر GET /api/v1/questions که سؤال‌ها را بدون جواب درست می‌فرستد، یک سؤال تنها با 404، و POST /api/v1/answer که یک جواب را روی سرور بررسی می‌کند. آخر هم با تست‌های جلسه‌ی ۳۰ مطمئن می‌شوی جواب‌ها لو نمی‌روند.

در این جلسه یاد می‌گیری

درس

🔐 قانون طلایی این دوره: سرور امانت‌دار است. هر سروری که می‌سازی داده‌ی آدم‌ها را نگه می‌دارد: اسم، امتیاز، یادداشت، رمز. پس به هر چه از بیرون می‌آید شک کن، رمز را هیچ‌وقت خام نگه ندار و داده‌ی کسی را به دیگری نشان نده. فقط سرورهای خودت را امتحان کن. سرور این دوره ساختگی است و داخل همین صفحه کار می‌کند: هر بار که برنامه را اجرا می‌کنی از صفر ساخته می‌شود، پس هر چه می‌خواهی امتحان کن.

یادت هست؟ در جلسه‌ی ۳۰ برای هر کار سرور یک تابع تست نوشتیم: درخواست با quiet=True، بعد assert روی r.status. از فاز ۵ هم یادت هست که db.one(...) وقتی ردیفی پیدا نکند None می‌دهد و آن‌وقت جواب درست 404 است. این‌جا هر دو کنار هم‌اند: یک مسیر روی SQL و تستی برای راه بدش.

from server import app, ask, abort, db

db.run("CREATE TABLE pets (id INTEGER PRIMARY KEY, name TEXT)")
db.run("INSERT INTO pets (name) VALUES (?)", "Pishi")

@app.get("/api/v1/pets/<int:pet_id>")
def one_pet(pet_id):
    pet = db.one("SELECT * FROM pets WHERE id = ?", pet_id)
    if pet is None:
        abort(404, "no such pet")
    return pet

def test_missing_pet():
    r = ask("GET /api/v1/pets/9", quiet=True)
    assert r.status == 404, "pet 9 should be missing"

test_missing_pet()
print("PASS test_missing_pet")

🗺️ نقشه‌ی سرور کوییز (بخش ۱). صفحه‌ی اپ کوییز (دوره‌ی /learn/quiz-app) سؤال‌ها را می‌خواهد و جواب بچه‌ها را می‌فرستد. پس اول نقشه، مثل جلسه‌ی ۲۹:

| متد | مسیر | کار | خوب | بد |
|---|---|---|---|---|
| GET | /api/v1/questions | همه‌ی سؤال‌ها، بی جواب | 200 | |
| GET | /api/v1/questions/<int:qid> | یک سؤال، بی جواب | 200 | 404 نیست |
| POST | /api/v1/answer | بررسی یک جواب: {"id": 1, "choice": 2} | 200 و {"id": 1, "correct": true} | 400 ورودی بد، 404 سؤال نیست |

هر سؤال سه گزینه دارد و choice شماره‌ی گزینه است: ۱، ۲ یا ۳.

🗄️ سؤال‌ها در SQL. سؤال‌ها در یک جدول می‌روند تا با خاموش شدن سرور از بین نروند (جلسه‌ی ۱۷). هر ردیف متن سؤال (text)، سه گزینه (c1، c2، c3) و شماره‌ی گزینه‌ی درست (answer) را دارد. db.script چند دستور SQL را با هم اجرا می‌کند، و یک INSERT می‌تواند چند ردیف را پشت هم با , اضافه کند. با db.show جدول را ببین.

from server import db

db.script("""
CREATE TABLE questions (id INTEGER PRIMARY KEY, text TEXT, c1 TEXT, c2 TEXT, c3 TEXT, answer INTEGER);
INSERT INTO questions (text, c1, c2, c3, answer) VALUES
    ('Which code means Not Found?', '200', '404', '500', 2),
    ('Which method makes a new thing?', 'POST', 'GET', 'DELETE', 1),
    ('What do APIs usually send?', 'Photos', 'Python', 'JSON', 3);
""")
db.show("SELECT * FROM questions")

🙈 جواب درست هیچ‌وقت از سرور بیرون نمی‌رود. هر چه سرور به اپ بفرستد، هر کسی می‌تواند ببیند: کافی است ابزار برنامه‌نویس مرورگر (DevTools) را باز کند. اگر answer در جواب باشد، تقلب یک کلیک است. پس در SELECT فقط ستون‌هایی را بیاور که باید فرستاده شوند، نه *. بعد تابع کوچک public(q) هر ردیف را به شکلی درمی‌آورد که اپ می‌خواهد: {"id": ..., "text": ..., "choices": [...]}. همین تابع در هر دو مسیر به کار می‌رود، پس شکل جواب همه‌جا یکی است.

from server import app, ask, request, abort, db

db.script("""
CREATE TABLE questions (id INTEGER PRIMARY KEY, text TEXT, c1 TEXT, c2 TEXT, c3 TEXT, answer INTEGER);
INSERT INTO questions (text, c1, c2, c3, answer) VALUES
    ('Which code means Not Found?', '200', '404', '500', 2),
    ('Which method makes a new thing?', 'POST', 'GET', 'DELETE', 1),
    ('What do APIs usually send?', 'Photos', 'Python', 'JSON', 3);
""")

def public(q):
    return {"id": q["id"], "text": q["text"], "choices": [q["c1"], q["c2"], q["c3"]]}

@app.get("/api/v1/questions")
def all_questions():
    rows = db.all("SELECT id, text, c1, c2, c3 FROM questions ORDER BY id")
    result = []
    for q in rows:
        result.append(public(q))
    return result

@app.get("/api/v1/questions/<int:qid>")
def one_question(qid):
    q = db.one("SELECT id, text, c1, c2, c3 FROM questions WHERE id = ?", qid)
    if q is None:
        abort(404, "no such question")
    return public(q)

ask("GET /api/v1/questions")
ask("GET /api/v1/questions/3")
ask("GET /api/v1/questions/8")

✔️ بررسی جواب روی سرور. اپ فقط می‌گوید بازیکن کدام گزینه را زده: {"id": 1, "choice": 2}. درست یا غلط بودنش را سرور حساب می‌کند، چون فقط سرور جواب را دارد و به کلاینت اعتماد نمی‌کنیم (جلسه‌ی ۲۵). ترتیب بررسی: اول نوع ورودی با isinstance (عدد باشند، وگرنه 400)، بعد اینکه choice یکی از ۱، ۲، ۳ باشد (400)، بعد اینکه سؤال باشد (404)، و آخر مقایسه. choice in (1, 2, 3) یعنی «یکی از این سه است».

from server import app, ask, request, abort, db

db.script("""
CREATE TABLE questions (id INTEGER PRIMARY KEY, text TEXT, c1 TEXT, c2 TEXT, c3 TEXT, answer INTEGER);
INSERT INTO questions (text, c1, c2, c3, answer) VALUES
    ('Which code means Not Found?', '200', '404', '500', 2),
    ('Which method makes a new thing?', 'POST', 'GET', 'DELETE', 1),
    ('What do APIs usually send?', 'Photos', 'Python', 'JSON', 3);
""")

@app.post("/api/v1/answer")
def answer():
    data = request.json or {}
    qid = data.get("id")
    choice = data.get("choice")
    if not isinstance(qid, int) or not isinstance(choice, int):
        abort(400, "send id and choice as numbers")
    if choice not in (1, 2, 3):
        abort(400, "choice must be 1, 2 or 3")
    q = db.one("SELECT answer FROM questions WHERE id = ?", qid)
    if q is None:
        abort(404, "no such question")
    return {"id": qid, "correct": choice == q["answer"]}

ask("POST /api/v1/answer", {"id": 1, "choice": 2})
ask("POST /api/v1/answer", {"id": 1, "choice": 3})
ask("POST /api/v1/answer", {"id": 1, "choice": "2"})

🧪 سرور کوییز را تست کن. همان روش جلسه‌ی ۳۰: یک تابع برای هر کار و یک حلقه که می‌شمارد. مهم‌ترین تست این سرور این است: «در جواب GET /api/v1/questions هیچ سؤالی کلید answer ندارد». "answer" not in q یعنی «این دیکشنری کلید answer ندارد». اگر روزی کسی SELECT * بنویسد، این تست فوراً FAIL می‌شود، پیش از آنکه بچه‌ها جواب‌ها را ببینند.

from server import app, ask, request, abort, db

db.script("""
CREATE TABLE questions (id INTEGER PRIMARY KEY, text TEXT, c1 TEXT, c2 TEXT, c3 TEXT, answer INTEGER);
INSERT INTO questions (text, c1, c2, c3, answer) VALUES
    ('Which code means Not Found?', '200', '404', '500', 2),
    ('Which method makes a new thing?', 'POST', 'GET', 'DELETE', 1),
    ('What do APIs usually send?', 'Photos', 'Python', 'JSON', 3);
""")

def public(q):
    return {"id": q["id"], "text": q["text"], "choices": [q["c1"], q["c2"], q["c3"]]}

@app.get("/api/v1/questions")
def all_questions():
    rows = db.all("SELECT id, text, c1, c2, c3 FROM questions ORDER BY id")
    result = []
    for q in rows:
        result.append(public(q))
    return result

@app.post("/api/v1/answer")
def answer():
    data = request.json or {}
    qid = data.get("id")
    choice = data.get("choice")
    if not isinstance(qid, int) or not isinstance(choice, int):
        abort(400, "send id and choice as numbers")
    if choice not in (1, 2, 3):
        abort(400, "choice must be 1, 2 or 3")
    q = db.one("SELECT answer FROM questions WHERE id = ?", qid)
    if q is None:
        abort(404, "no such question")
    return {"id": qid, "correct": choice == q["answer"]}

def test_no_answers():
    for q in ask("GET /api/v1/questions", quiet=True).json:
        assert "answer" not in q, "the answers leak"

def test_right_answer():
    r = ask("POST /api/v1/answer", {"id": 2, "choice": 1}, quiet=True)
    assert r.json["correct"] is True, "choice 1 is right for question 2"

def test_bad_choice():
    r = ask("POST /api/v1/answer", {"id": 2, "choice": 5}, quiet=True)
    assert r.status == 400, "choice 5 should give 400"

tests = [test_no_answers, test_right_answer, test_bad_choice]
passed = 0
for test in tests:
    try:
        test()
        print("PASS", test.__name__)
        passed += 1
    except AssertionError as err:
        print("FAIL", test.__name__, "-", err)
print(passed, "of", len(tests), "tests passed")

⚠️ اشتباه‌های رایج:
- SELECT * FROM questions در مسیری که به اپ جواب می‌دهد: ستون answer هم می‌رود.
- قبول کردن {"correct": true} از اپ به‌جای حساب کردنش روی سرور. هر کسی می‌تواند هر چه بخواهد بفرستد.
- مقایسه‌ی متن با عدد: "2" == 2 در پایتون False است، پس جواب درستی که به شکل متن آمده «غلط» حساب می‌شود. نوع را اول با isinstance بررسی کن و 400 بده.
- فرستادن جواب درست همراه «غلط بود» ("answer": 2): این‌طوری با یک بار غلط زدن جواب همه‌ی سؤال‌ها جمع می‌شود.

مثال‌های این جلسه

چالش‌ها

  1. A Test That Tests (آسان)
  2. Send or Keep? (آسان)
  3. Questions Without Answers (متوسط)
  4. One Question (متوسط)
  5. Check One Answer (سخت)
  6. A Test Against Leaks (سخت)

بیشتر بخوان

← جلسه‌ی 30: تست کردن سرور جلسه‌ی 32: پروژه‌ی پایانی: سرور کوییز آنلاین می‌شود →