Private
Public Access
Add the PWA layer: manifest, service worker, icons, offline page
Implements installable-PWA support per the plan: a manifest.webmanifest view (name/short_name "Evection", standalone display, 192/512/maskable icons), a service worker served at domain root (/sw.js, with Service-Worker-Allowed: / so its scope covers the whole app, not just /static/), and an offline fallback page. The service worker ignores all non-GET requests outright (so mutations like mark-read/star/OPML upload stay network-only without special- casing every endpoint), does network-first-with-cache-fallback for navigations (bounded to the 60 most recently viewed pages, trimmed oldest-first), and cache-first for /static/ assets, with the cache name keyed by EVECTION_PWA_CACHE_VERSION so a deploy can invalidate old caches. Per the earlier decision, embedded remote images in article content are not cached for offline reading — text/HTML only. Generates a simple RSS-glyph icon set (192/512/maskable/apple-touch) with a throwaway Pillow script (not a project dependency). Adds iOS meta tags and service-worker registration to base.html. Fixed a real bug found during this work: the first-run setup-wizard middleware was redirecting /manifest.webmanifest, /sw.js, and /offline/ to /setup/ before an admin account existed, which would have broken a browser's very first visit to a fresh install. Verified: manifest JSON validity and required fields, sw.js delivery (content-type, Service-Worker-Allowed header, correct body) via both curl and automated tests (112 passing). Actual service-worker registration could not be verified in this sandboxed browser pane — confirmed via a control test (even a trivial unrelated static file fails to register here with an opaque "unknown error fetching script") that this is an environment limitation of locally-started dev servers in this tool, not an application bug; registration, install-prompt, and offline behavior need confirming in a real browser. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
ea214dd9ce
commit
7577110238
14 files changed
+252
-3
No files matched your search
@@ -0,0 +1,29 @@
|
||||
{% load static %}{
|
||||
"name": "Evection",
|
||||
"short_name": "Evection",
|
||||
"description": "A self-hosted RSS/Atom feed reader.",
|
||||
"start_url": "{% url 'reader:stream' %}",
|
||||
"scope": "/",
|
||||
"display": "standalone",
|
||||
"background_color": "#111111",
|
||||
"theme_color": "#111111",
|
||||
"orientation": "portrait-primary",
|
||||
"icons": [
|
||||
{
|
||||
"src": "{% static 'pwa/icons/icon-192.png' %}",
|
||||
"sizes": "192x192",
|
||||
"type": "image/png"
|
||||
},
|
||||
{
|
||||
"src": "{% static 'pwa/icons/icon-512.png' %}",
|
||||
"sizes": "512x512",
|
||||
"type": "image/png"
|
||||
},
|
||||
{
|
||||
"src": "{% static 'pwa/icons/icon-maskable.png' %}",
|
||||
"sizes": "512x512",
|
||||
"type": "image/png",
|
||||
"purpose": "maskable"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
{% extends "base.html" %}
|
||||
{% block title %}Offline — Evection{% endblock %}
|
||||
{% block content %}
|
||||
<h1>You're offline</h1>
|
||||
<p>This page isn't available offline yet. Anything you've already opened while
|
||||
online should still work — try going back.</p>
|
||||
{% endblock %}
|
||||
@@ -0,0 +1,85 @@
|
||||
{% load static %}const CACHE_VERSION = "{{ cache_version }}";
|
||||
const SHELL_CACHE = `evection-shell-${CACHE_VERSION}`;
|
||||
const PAGES_CACHE = `evection-pages-${CACHE_VERSION}`;
|
||||
const MAX_CACHED_PAGES = 60;
|
||||
|
||||
const SHELL_URLS = [
|
||||
"{% url 'pwa:offline' %}",
|
||||
"{% url 'accounts:login' %}",
|
||||
"{% static 'css/base.css' %}",
|
||||
"{% static 'js/htmx.min.js' %}",
|
||||
"{% static 'pwa/icons/icon-192.png' %}",
|
||||
"{% static 'pwa/icons/icon-512.png' %}",
|
||||
];
|
||||
|
||||
self.addEventListener("install", (event) => {
|
||||
event.waitUntil(
|
||||
caches.open(SHELL_CACHE).then((cache) => cache.addAll(SHELL_URLS)).then(() => self.skipWaiting())
|
||||
);
|
||||
});
|
||||
|
||||
self.addEventListener("activate", (event) => {
|
||||
event.waitUntil(
|
||||
caches
|
||||
.keys()
|
||||
.then((names) =>
|
||||
Promise.all(
|
||||
names
|
||||
.filter((name) => name !== SHELL_CACHE && name !== PAGES_CACHE)
|
||||
.map((name) => caches.delete(name))
|
||||
)
|
||||
)
|
||||
.then(() => self.clients.claim())
|
||||
);
|
||||
});
|
||||
|
||||
async function trimCache(cacheName, maxItems) {
|
||||
const cache = await caches.open(cacheName);
|
||||
const keys = await cache.keys();
|
||||
if (keys.length <= maxItems) return;
|
||||
// Cache.keys() returns insertion order, so the oldest entries are first.
|
||||
const toDelete = keys.slice(0, keys.length - maxItems);
|
||||
await Promise.all(toDelete.map((key) => cache.delete(key)));
|
||||
}
|
||||
|
||||
async function networkFirstForNavigation(request) {
|
||||
try {
|
||||
const response = await fetch(request);
|
||||
const cache = await caches.open(PAGES_CACHE);
|
||||
cache.put(request, response.clone());
|
||||
trimCache(PAGES_CACHE, MAX_CACHED_PAGES);
|
||||
return response;
|
||||
} catch (err) {
|
||||
const cached = await caches.match(request);
|
||||
if (cached) return cached;
|
||||
const offline = await caches.match("{% url 'pwa:offline' %}");
|
||||
return offline || Response.error();
|
||||
}
|
||||
}
|
||||
|
||||
async function cacheFirstForAsset(request) {
|
||||
const cached = await caches.match(request);
|
||||
if (cached) return cached;
|
||||
const response = await fetch(request);
|
||||
const cache = await caches.open(SHELL_CACHE);
|
||||
cache.put(request, response.clone());
|
||||
return response;
|
||||
}
|
||||
|
||||
self.addEventListener("fetch", (event) => {
|
||||
const { request } = event;
|
||||
|
||||
// Mutations (mark-read, star, OPML upload, forms...) are always
|
||||
// network-only — never intercept anything but GET.
|
||||
if (request.method !== "GET") return;
|
||||
|
||||
if (request.mode === "navigate") {
|
||||
event.respondWith(networkFirstForNavigation(request));
|
||||
return;
|
||||
}
|
||||
|
||||
const url = new URL(request.url);
|
||||
if (url.pathname.startsWith("/static/")) {
|
||||
event.respondWith(cacheFirstForAsset(request));
|
||||
}
|
||||
});
|
||||
Reference in new issue
Block a user