#vary

Vary: Service Worker

Über Monate war der Service Worker meines Kegelclubs defekt: Zwar wurden Seiten aus dem Cache geholt, wenn man offline war, aber eben nicht die Kegelspiele – und gerade für die war doch dieses tolle Feature gedacht, sitzen wir doch oft auf Kegelbahnen ohne stabiles Internet!

Wie sich herausgestellt hat, war mein Wille, HTTP-konform zu sein, Schuld daran: Ich liefere unter einer URI mehrere Ressourcen aus, je nach Accept-Header. Die Kegelspiele können also in verschiedenen Varianten (HTML, JSON, XML, Markdown) abgefragt werden:

Accept: text/html
GET https://kegelclub-tüddern.de/kegelspiele/grosse-hausnummer

<!doctype html>
...
Accept: application/json
GET https://kegelclub-tüddern.de/kegelspiele/grosse-hausnummer

{
  ...

Gedacht war das mal für eine potentielle iOS-App, um direkt eine JSON-Repräsentation zu haben. Ohje … 🤷🏻‍♂️ Pro-Tipp: Baut keine APIs, bevor Ihr sie nicht auch braucht!

Aber nun gut. HTTP-Konformität, hm? Also ein ganz kleiner Exkurs: Wenn sich die Response einer URI aufgrund eines beliebigen Request-Headers ändern kann, so muss man diese Request-Header mit dem Vary-Response-Header auflisten. In meinem Fall ist das:

Vary: Accept, Accept-Encoding

Den Header setzt man vor allem wegen Caching:

The Vary HTTP response header determines how to match future request headers to decide whether a cached response can be used rather than requesting a fresh one from the origin server. It is used by the server to indicate which headers it used when selecting a representation of a resource in a content negotiation algorithm.

Wegen Caching! Dieser Vary-Header war der Grund für den defekten Service Worker, denn Letzterer versuchte nun immer, diese eine Ressource direkt aus dem Netz statt aus dem Cache zu holen!

Die Lösung im Service Worker ist ignoreVary:

// cache will not be used for requests with Vary header, response is undefined
const response = await caches.match(request);

// cache will ignore Vary header, response is the cached ressource
const response = await caches.match(request, { ignoreVary: true });

Aaaalter … Das hat mich heute Abend gute drei Stunden Ausprobier- und Suchzeit gekostet. Aber hey, wieder was gelernt! 😓