Private
Public Access
Make the updater deploy tagged releases, like ds-chat's upgrade.sh
scripts/upgrade.sh now fetches tags and does a detached-HEAD checkout of the latest one (git tag --sort=-creatordate | head -n1), matching the ds-chat project's deploy/upgrade.sh exactly rather than a plain git pull on whatever branch happened to be checked out. Errors clearly if the repo has no tags yet (true for Evection right now — nothing to deploy until a release is tagged and pushed), and no-ops cleanly if already on the latest tag. scripts/install.sh does the same tag pin on first install (falling back to whatever's checked out if no tags exist yet), so the very first deploy is consistent with every upgrade after it. Added a GET /health/ endpoint (apps.core.views.health) that checks DB connectivity and is exempt from the first-run setup redirect, for the upgrade script's post-restart verification (curled over the gunicorn unix socket, same as ds-chat's curl-based check) and for any external uptime monitor. While wiring the setup-wizard exemption for /health/, found that SetupWizardMiddleware._a_user_exists's reset fixture was scoped only to apps/accounts/tests.py, so a test anywhere else that creates a user and makes a request could leak a stale "a user exists" into later test files with no reset — confirmed this concretely by temporarily breaking the new exemption and watching the "works before setup" test still pass purely from accounts/tests.py leaving the module-order-adjacent apps/articles tests to poison the shared class attribute. Moved the fixture to a new top-level conftest.py so it's autouse across every test file, which also makes the new health-check test meaningful regardless of run order. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
a89f651a71
commit
2e4674a18f
8 files changed
+128
-28
No files matched your search
@@ -24,7 +24,7 @@ class SetupWizardMiddleware:
|
||||
|
||||
def __call__(self, request):
|
||||
path = request.path
|
||||
if not path.startswith(_SETUP_EXEMPT_PREFIXES) and path not in _pwa_exempt_paths():
|
||||
if not path.startswith(_SETUP_EXEMPT_PREFIXES) and path not in _setup_exempt_paths():
|
||||
if not SetupWizardMiddleware._a_user_exists:
|
||||
SetupWizardMiddleware._a_user_exists = User.objects.exists()
|
||||
setup_url = reverse("accounts:setup")
|
||||
@@ -33,12 +33,16 @@ class SetupWizardMiddleware:
|
||||
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)."""
|
||||
def _setup_exempt_paths():
|
||||
"""Routes that must work even before the instance's first-run setup is
|
||||
complete: the manifest/service worker/offline page (a browser can fetch
|
||||
these on any visit, setup page included — it extends the same base
|
||||
template) and the health check (ops tooling, e.g. scripts/upgrade.sh,
|
||||
needs it reachable immediately after a fresh deploy, before anyone has
|
||||
created an account)."""
|
||||
return {
|
||||
reverse("pwa:manifest"),
|
||||
reverse("pwa:service_worker"),
|
||||
reverse("pwa:offline"),
|
||||
reverse("core:health"),
|
||||
}
|
||||
@@ -1,15 +1,10 @@
|
||||
import pytest
|
||||
from django.urls import reverse
|
||||
|
||||
from .middleware import SetupWizardMiddleware
|
||||
from .models import User
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def _reset_setup_wizard_cache():
|
||||
SetupWizardMiddleware._a_user_exists = False
|
||||
yield
|
||||
SetupWizardMiddleware._a_user_exists = False
|
||||
# SetupWizardMiddleware's cache is reset around every test by the autouse
|
||||
# fixture in the top-level conftest.py, not just here.
|
||||
|
||||
|
||||
@pytest.mark.django_db
|
||||
|
||||
@@ -6,6 +6,22 @@ from django.urls import reverse
|
||||
from apps.feeds.models import Feed, Subscription
|
||||
|
||||
|
||||
@pytest.mark.django_db
|
||||
def test_health_check_returns_ok_without_login(client):
|
||||
response = client.get(reverse("core:health"))
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"status": "ok"}
|
||||
|
||||
|
||||
@pytest.mark.django_db
|
||||
def test_health_check_works_before_first_run_setup(client):
|
||||
# No User exists yet, so SetupWizardMiddleware would normally redirect
|
||||
# every request to /setup/ — scripts/upgrade.sh needs this reachable
|
||||
# immediately after a fresh deploy, before anyone's created an account.
|
||||
response = client.get(reverse("core:health"))
|
||||
assert response.status_code == 200
|
||||
|
||||
|
||||
@pytest.mark.django_db
|
||||
def test_dashboard_requires_staff(client, django_user_model):
|
||||
django_user_model.objects.create_user("regular", password="pw-regular-123")
|
||||
|
||||
@@ -5,6 +5,7 @@ from . import views
|
||||
app_name = "core"
|
||||
|
||||
urlpatterns = [
|
||||
path("health/", views.health, name="health"),
|
||||
path("dashboard/", views.dashboard, name="dashboard"),
|
||||
path("dashboard/feeds/<int:feed_id>/retry/", views.retry_feed, name="retry_feed"),
|
||||
]
|
||||
@@ -1,6 +1,8 @@
|
||||
from django.contrib import messages
|
||||
from django.contrib.auth.decorators import user_passes_test
|
||||
from django.db import connection
|
||||
from django.db.models import Count, Q
|
||||
from django.http import JsonResponse
|
||||
from django.shortcuts import get_object_or_404, redirect, render
|
||||
from django.views.decorators.http import require_POST
|
||||
|
||||
@@ -11,6 +13,19 @@ from apps.feeds.tasks import fetch_feed, reset_feed_backoff
|
||||
is_admin = user_passes_test(lambda u: u.is_authenticated and u.is_staff)
|
||||
|
||||
|
||||
def health(request):
|
||||
"""Unauthenticated liveness/readiness check — reachable even before
|
||||
first-run setup (see SetupWizardMiddleware). Used by scripts/upgrade.sh
|
||||
to confirm a freshly restarted deploy actually came up, and is a
|
||||
reasonable target for any external uptime monitor too."""
|
||||
try:
|
||||
with connection.cursor() as cursor:
|
||||
cursor.execute("SELECT 1")
|
||||
except Exception:
|
||||
return JsonResponse({"status": "error"}, status=503)
|
||||
return JsonResponse({"status": "ok"})
|
||||
|
||||
|
||||
@is_admin
|
||||
def dashboard(request):
|
||||
feeds = Feed.objects.annotate(subscriber_count=Count("subscriptions"))
|
||||
|
||||
Reference in new issue
Block a user