Public v2 endpoints answer 304 before the view runs and cache error responses

Offen
#6,408 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
38/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
django, python
Bereich
api, backend, testing

Rechercherichtung

Read contentcuration/kolibri_public/views.py around metadata_cache and get_last_modified, then inspect the tests for the contentnode and contentnode_tree endpoints. Add coverage for conditional requests, error response cache headers, and unchanged caching on successful responses; done means all listed acceptance criteria pass.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

DEV: backend

❌ This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.

Overview

metadata_cache wraps every public v2 endpoint in Django's last_modified, keyed on the newest ChannelMetadata.last_updated across all channels. Django answers a request whose If-Modified-Since is later than that with 304 before the view runs, so a request for a missing node, or with invalid parameters, gets 304 instead of 404 or 400. The decorator also marks error responses public and cacheable for 5 minutes, so a CDN serves them to everyone.

Complexity: Low
Target branch: hotfixes

Context
  • metadata_cache and get_last_modified apply last_modified, patch_response_headers and patch_cache_control(public=True) to every response.
  • Reproduced: GET /api/public/v2/contentnode/<nonexistent id>/ with an If-Modified-Since later than the newest channel update returns 304. A 404 or 400 response carries Cache-Control: max-age=300, public, stale-while-revalidate=100.
The Change
  • A conditional request should get 304 only when the view would otherwise return 200.
  • Error responses should not be marked public or cacheable.
Acceptance Criteria
General
  • A request for a missing node or with invalid parameters returns its 404 or 400 whatever its If-Modified-Since.
  • 4xx and 5xx responses from public v2 endpoints carry no public Cache-Control or max-age.
  • 200 responses keep their current caching headers, and conditional requests for them still get 304.
Testing
  • Tests cover each criterion on the contentnode and contentnode_tree endpoints.

AI usage

I scoped the audit. Claude Code found and reproduced these failures and drafted this issue.

Vorherrschende Sprache
Python
Sterne
212
Forks
321
Ø Merge
1 T. 7 Std.
Gemergte PRs (30 T.)
14

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus learningequality/studio

Alle Issues in learningequality/studio

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.