🏆Eindproject: De server afmaken

Hoofdstuk 11 bouwde de leeslijst opnieuw in FastAPI. Dit hoofdstuk gaat terug naar de zelfgebouwde server en naar de requests-client uit hoofdstuk 10, en vraagt beide om tegelijk aan één document te voldoen: SERVICE_CONTRACT.md.

Het contract ligt vast. Niets in dit hoofdstuk verandert er een route, een status, een header of een exitcode in. Twee programma’s vertrouwen nu op dezelfde woorden. Als de server location: /books/3 stuurt, maakt de client er een URL van en drukt die af; als de server met 304 antwoordt, hergebruikt de client een boek dat hij een minuut geleden heeft opgeslagen. Als een van de twee helften van het contract afwijkt, breekt de andere helft, terwijl de eigen code er goed uitziet. Elke helft heeft eerder zijn eigen tests doorstaan; nieuw is dat je beide tegelijk aan één contract houdt.

Lees het contract, vind de gaten

Open SERVICE_CONTRACT.md in het tabblad Project en scrol naar de laatste sectie, “Not built yet” (nog niet gebouwd). Die noemt drie rijen. Elke rij heeft een serverhelft, die je in deze les herstelt, en een clienthelft, die de volgende twee lessen bouwen:

Geen van de serverhelften is nieuw voor je. De location-regel komt uit hoofdstuk 5, legacy_location en de 308-tak uit hoofdstuk 6, en etag_matches, not_modified en de 304-regel uit hoofdstuk 8. Ze zijn uit een verder afgemaakte server gehaald, zodat de clienthelften iets hebben om mee overeen te stemmen.

De rest van reading_server.py is de nagekeken server van het eind van hoofdstuk 9: HTTP/1.1 met keep-alive, read_body die na elke weigering de verbinding sluit, inloggen en sessies, bearer-tokens, en etag en cache-control op elke 200 voor een leesverzoek. Laat die zoals hij is. Check my work bewijst die rijen opnieuw, met boeken, gebruikers en tokens die je niet hebt gezien, omdat een wijziging op de ene plek een rij ver weg kan breken.

Mijlpalen

Eerst de oude paden. Schrijf legacy_location(target): neem het pad met urlsplit(target).path, knip de eerste drie tekens eraf, /v0, en voeg ? en de query toe als die er is. Werk vanuit het ruwe target, niet vanuit de gedecodeerde segmenten, zodat de waarde ASCII blijft. Voeg dan de tak helemaal bovenaan handle toe, vóór elke andere route: als de eerste twee segmenten v0 en books zijn, is het antwoord redirect(308, legacy_location(request["target"])). Hij komt eerst, zodat een schrijfverzoek naar een oud pad wordt doorverwezen voordat het token wordt gecontroleerd, en er niets wordt opgeslagen.

Dan de hervalidatie. Schrijf etag_matches(values, etag): values is de lijst met if-none-match-regels, en elke regel kan meerdere tags bevatten, gescheiden door komma’s. Strip elk element, haal een W/ aan het begin weg, en geef True terug voor * of voor een tag die gelijk is aan etag. Schrijf not_modified(response): een nieuwe antwoord-dict met status 304, de etag en cache-control van de 200 gekopieerd, en de body b"". Voeg dan de regel aan handle toe, na de routering en vóór de regels voor no-store en HEAD: als het antwoord een etag heeft en het verzoek if-none-match stuurde, en die twee overeenkomen, wordt het antwoord not_modified(response). Alleen een 200 voor een leesverzoek draagt een etag, dus fouten en schrijfverzoeken blijven ongemoeid, en * op een ontbrekend boek krijgt nog steeds zijn 404.

Dan de location. Voeg in create_book één regel toe vóór de return: in de headers van de 201 wordt location gezet op /books/ plus het nieuwe id. De client zet deze relatieve waarde in les 2 om.

Twee helperruns uit eerdere hoofdstukken werken nog steeds op deze server:

python pl_http.py moved
python pl_http.py conditional

In de moved-run zou het log van je server 308 moeten tonen voor de twee /v0-verzoeken waar de server waarmee je dit hoofdstuk begon 404 antwoordde. In de conditional-run zou het log 200, 304, 304, 200 moeten tonen: de eerste GET krijgt de tag, de volgende GET en de HEAD sturen hem terug en krijgen 304, en het laatste verzoek stuurt een verouderde tag en krijgt de hele lijst opnieuw.

Je tests

tests/test_server.py roept handle rechtstreeks aan met make_request, zoals sinds hoofdstuk 5. Voer het uit na elke mijlpaal:

python -m pytest -q

Elke test die met het project meekwam, zou nog moeten slagen. Les 4 voegt tests toe voor de drie rijen.

Je opdracht

1. Schrijf legacy_location, en de 308-tak bovenaan handle.

2. Schrijf etag_matches en not_modified, en de 304-regel in handle.

3. Voeg location toe aan de 201 in create_book.

4. Voer python -m pytest -q uit, en daarna de twee helperruns.

5. Klik op Check my work.

Als een controle mislukt, noemt de melding het verzoek en de regel. Vraag Monty om die samen met je naast de bijbehorende tabel in SERVICE_CONTRACT.md te lezen, zonder de oplossing te schrijven.

De server voldoet nu aan elke serverrij van het contract. De client downloadt nog steeds elk boek elke keer opnieuw en drukt een nieuw boek af zonder zijn URL; de volgende les verhelpt beide.