diff --git a/apps/accounts/middleware.py b/apps/accounts/middleware.py index f7c3feb..6cf38fa 100644 --- a/apps/accounts/middleware.py +++ b/apps/accounts/middleware.py @@ -24,10 +24,21 @@ class SetupWizardMiddleware: def __call__(self, request): path = request.path - if not path.startswith(_SETUP_EXEMPT_PREFIXES): + if not path.startswith(_SETUP_EXEMPT_PREFIXES) and path not in _pwa_exempt_paths(): if not SetupWizardMiddleware._a_user_exists: SetupWizardMiddleware._a_user_exists = User.objects.exists() setup_url = reverse("accounts:setup") if path != setup_url and not SetupWizardMiddleware._a_user_exists: return redirect(setup_url) return self.get_response(request) + + +def _pwa_exempt_paths(): + """The manifest/service worker/offline page must work even before the + instance's first-run setup is complete — a browser can fetch these on + any visit, setup page included (it extends the same base template).""" + return { + reverse("pwa:manifest"), + reverse("pwa:service_worker"), + reverse("pwa:offline"), + } diff --git a/apps/accounts/tests.py b/apps/accounts/tests.py index ecb9afa..ec1b990 100644 --- a/apps/accounts/tests.py +++ b/apps/accounts/tests.py @@ -19,6 +19,13 @@ def test_root_redirects_to_setup_when_no_users_exist(client): assert response.url == reverse("accounts:setup") +@pytest.mark.django_db +def test_pwa_routes_bypass_the_setup_redirect(client): + for url_name in ["pwa:manifest", "pwa:service_worker", "pwa:offline"]: + response = client.get(reverse(url_name)) + assert response.status_code == 200, url_name + + @pytest.mark.django_db def test_setup_creates_admin_and_logs_in(client): response = client.post( diff --git a/apps/pwa/tests.py b/apps/pwa/tests.py index a39b155..6c75a58 100644 --- a/apps/pwa/tests.py +++ b/apps/pwa/tests.py @@ -1 +1,63 @@ -# Create your tests here. +import json + +import pytest +from django.urls import reverse + + +@pytest.mark.django_db +def test_manifest_is_valid_json_with_expected_fields(client): + response = client.get(reverse("pwa:manifest")) + + assert response.status_code == 200 + assert response["Content-Type"] == "application/manifest+json" + + manifest = json.loads(response.content) + assert manifest["name"] == "Evection" + assert manifest["display"] == "standalone" + assert manifest["scope"] == "/" + sizes = {icon["sizes"] for icon in manifest["icons"]} + assert {"192x192", "512x512"} <= sizes + assert any(icon.get("purpose") == "maskable" for icon in manifest["icons"]) + + +@pytest.mark.django_db +def test_service_worker_is_served_at_root_with_correct_type_and_scope(client): + response = client.get(reverse("pwa:service_worker")) + + assert response.status_code == 200 + assert response["Content-Type"] == "application/javascript" + assert response["Service-Worker-Allowed"] == "/" + body = response.content.decode() + assert 'self.addEventListener("install"' in body + assert 'self.addEventListener("fetch"' in body + # Mutations must stay network-only, never intercepted. + assert 'request.method !== "GET"' in body + + +@pytest.mark.django_db +def test_offline_page_renders(client): + response = client.get(reverse("pwa:offline")) + assert response.status_code == 200 + assert b"offline" in response.content.lower() + + +@pytest.mark.django_db +def test_manifest_and_sw_do_not_require_login(client): + # The service worker fetches these itself, unauthenticated, before any + # user necessarily has a session. + assert client.get(reverse("pwa:manifest")).status_code == 200 + assert client.get(reverse("pwa:service_worker")).status_code == 200 + assert client.get(reverse("pwa:offline")).status_code == 200 + + +@pytest.mark.django_db +def test_base_template_links_manifest_and_registers_service_worker(client, django_user_model): + django_user_model.objects.create_user("alice", password="pw-alice-123") + client.login(username="alice", password="pw-alice-123") + + response = client.get(reverse("reader:stream")) + content = response.content.decode() + + assert 'rel="manifest"' in content + assert "serviceWorker" in content + assert "apple-touch-icon" in content diff --git a/apps/pwa/urls.py b/apps/pwa/urls.py new file mode 100644 index 0000000..0a3a588 --- /dev/null +++ b/apps/pwa/urls.py @@ -0,0 +1,11 @@ +from django.urls import path + +from . import views + +app_name = "pwa" + +urlpatterns = [ + path("manifest.webmanifest", views.manifest, name="manifest"), + path("sw.js", views.service_worker, name="service_worker"), + path("offline/", views.offline, name="offline"), +] diff --git a/apps/pwa/views.py b/apps/pwa/views.py index 60f00ef..9f281cd 100644 --- a/apps/pwa/views.py +++ b/apps/pwa/views.py @@ -1 +1,22 @@ -# Create your views here. +from django.conf import settings +from django.shortcuts import render + + +def manifest(request): + return render(request, "pwa/manifest.webmanifest", content_type="application/manifest+json") + + +def service_worker(request): + context = {"cache_version": settings.EVECTION_PWA_CACHE_VERSION} + response = render(request, "pwa/sw.js", context, content_type="application/javascript") + # A service worker's own scope covers everything below where it's + # served from, but the browser also independently refuses a broader + # Service-Worker-Allowed scope than the response's own URL path + # implies unless this header says otherwise. Being served at exactly + # "/sw.js" already gives it root scope, so this is just explicit. + response["Service-Worker-Allowed"] = "/" + return response + + +def offline(request): + return render(request, "pwa/offline.html") diff --git a/config/urls.py b/config/urls.py index 5639ef4..e68d001 100644 --- a/config/urls.py +++ b/config/urls.py @@ -8,5 +8,6 @@ urlpatterns = [ path("", include("apps.articles.urls")), path("", include("apps.rules.urls")), path("", include("apps.search.urls")), + path("", include("apps.pwa.urls")), path("", include("apps.reader.urls")), ] diff --git a/static/pwa/icons/apple-touch-icon.png b/static/pwa/icons/apple-touch-icon.png new file mode 100644 index 0000000..f1ae00e Binary files /dev/null and b/static/pwa/icons/apple-touch-icon.png differ diff --git a/static/pwa/icons/icon-192.png b/static/pwa/icons/icon-192.png new file mode 100644 index 0000000..1d026ed Binary files /dev/null and b/static/pwa/icons/icon-192.png differ diff --git a/static/pwa/icons/icon-512.png b/static/pwa/icons/icon-512.png new file mode 100644 index 0000000..4311cbb Binary files /dev/null and b/static/pwa/icons/icon-512.png differ diff --git a/static/pwa/icons/icon-maskable.png b/static/pwa/icons/icon-maskable.png new file mode 100644 index 0000000..699c8f7 Binary files /dev/null and b/static/pwa/icons/icon-maskable.png differ diff --git a/templates/base.html b/templates/base.html index 60b018f..7f67abe 100644 --- a/templates/base.html +++ b/templates/base.html @@ -7,6 +7,14 @@