Merge pull request #144 from corenting/fix/cookie-expiry

fix(cookies): set expiry (fix #143)

CHANGELOG.md

@@ -1,3 +1,7 @@
+# Version 0.8.2 (not released yet)
+
+- Fix settings cookies expiration as reported by [ValiumBear](https://github.com/ValiumBear) [in](https://github.com/corenting/eddrit/issues/143)
+
 # Version 0.8.1
 
 - Fix galleries without captions

Makefile

@@ -11,15 +11,15 @@ init:
 .PHONY: format
 format:
 	$(PYTHON) ruff format $(SRC)
-	$(PYTHON) ruff --fix $(SRC)
+	$(PYTHON) ruff check --fix $(SRC)
 	$(BIOME) format --write $(JS_SRC)
 	$(BIOME) check --apply $(JS_SRC)
 
 
 .PHONY: style
 style:
 	$(PYTHON) ruff format --check $(SRC)
-	$(PYTHON) ruff $(SRC)
+	$(PYTHON) ruff check $(SRC)
 	$(PYTHON) pyright -- $(SRC)
 	$(BIOME) lint  $(JS_SRC)
 

eddrit/app.py

@@ -22,11 +22,24 @@
 )
 from eddrit.routes.xhr import routes
 from eddrit.utils.httpx import raise_if_rate_limited
-from eddrit.utils.middlewares import CurrentHostMiddleware, NoReferrerMiddleware
+from eddrit.utils.middlewares import (
+    CookiesRefreshMiddleware,
+    CurrentHostMiddleware,
+    NoReferrerMiddleware,
+)
 
 middlewares = [
     Middleware(NoReferrerMiddleware),
     Middleware(CurrentHostMiddleware),
+    Middleware(
+        CookiesRefreshMiddleware,
+        cookies_to_refresh=[
+            "layout",
+            "nsfw_popular_all",
+            "nsfw_thumbnails" "over18",
+            "thumbnails",
+        ],
+    ),
 ]
 
 exceptions_handlers = {

eddrit/routes/common/context.py

@@ -6,19 +6,7 @@
 
 from eddrit import models
 from eddrit.models.settings import LayoutMode, ThumbnailsMode
-
-
-def _get_bool_setting_value_from_cookie(
-    name: str, cookies: dict[str, str], default: bool = False
-) -> bool:
-    """Get boolean value of a given setting according to the given cookies.
-
-    If setting not present, use default value
-    """
-    if name in cookies:
-        return cookies[name] == "1"
-    else:
-        return default
+from eddrit.routes.common.cookies import get_bool_setting_value_from_cookie
 
 
 def get_templates_common_context(
@@ -37,10 +25,10 @@ def get_templates_common_context(
         thumbnails=ThumbnailsMode(
             cookies_source.get("thumbnails", ThumbnailsMode.SUBREDDIT_PREFERENCE.value)
         ),
-        nsfw_popular_all=_get_bool_setting_value_from_cookie(
+        nsfw_popular_all=get_bool_setting_value_from_cookie(
             "nsfw_popular_all", cookies_source
         ),
-        nsfw_thumbnails=_get_bool_setting_value_from_cookie(
+        nsfw_thumbnails=get_bool_setting_value_from_cookie(
             "nsfw_thumbnails", cookies_source
         ),
     )

eddrit/routes/common/cookies.py

@@ -0,0 +1,35 @@
+from dataclasses import dataclass
+from datetime import UTC, datetime, timedelta
+
+from eddrit.config import DEBUG
+
+
+@dataclass
+class CookieSettings:
+    secure: bool
+    http_only: bool
+    expiration_date: datetime
+
+
+def get_default_cookie_settings() -> CookieSettings:
+    """
+    Get default cookie settings
+    """
+    return CookieSettings(
+        secure=not DEBUG,
+        http_only=True,
+        expiration_date=datetime.now(tz=UTC) + timedelta(days=90),
+    )
+
+
+def get_bool_setting_value_from_cookie(
+    name: str, cookies: dict[str, str], default: bool = False
+) -> bool:
+    """Get boolean value of a given setting according to the given cookies.
+
+    If setting not present, use default value
+    """
+    if name in cookies:
+        return cookies[name] == "1"
+    else:
+        return default

eddrit/routes/pages/over18.py

@@ -3,6 +3,7 @@
 from starlette.routing import Route
 
 from eddrit.routes.common.context import get_templates_common_context
+from eddrit.routes.common.cookies import get_default_cookie_settings
 from eddrit.templates import templates
 
 
@@ -27,7 +28,15 @@ async def over18_gate_submit(request: Request) -> Response:
     body = await request.form()
     continue_url = str(body.get("continue", "/"))
     res = RedirectResponse(url=continue_url, status_code=302)
-    res.set_cookie("over18", "1", secure=True, httponly=True)
+
+    default_cookie_settings = get_default_cookie_settings()
+    res.set_cookie(
+        "over18",
+        "1",
+        secure=default_cookie_settings.secure,
+        httponly=default_cookie_settings.http_only,
+        expires=default_cookie_settings.expiration_date,
+    )
     return res
 
 

eddrit/routes/pages/settings.py

@@ -2,8 +2,8 @@
 from starlette.responses import Response
 from starlette.routing import Route
 
-from eddrit.config import DEBUG
 from eddrit.routes.common.context import get_templates_common_context
+from eddrit.routes.common.cookies import get_default_cookie_settings
 from eddrit.templates import templates
 
 
@@ -39,12 +39,14 @@ async def settings_submit(request: Request) -> Response:
         },
     )
 
+    default_cookie_settings = get_default_cookie_settings()
     for cookie_name, cookie_value in updated_cookies.items():
         res.set_cookie(
             cookie_name,
             cookie_value,
-            secure=not DEBUG,
-            httponly=True,
+            secure=default_cookie_settings.secure,
+            httponly=default_cookie_settings.http_only,
+            expires=default_cookie_settings.expiration_date,
         )
 
     return res

eddrit/utils/middlewares.py

@@ -1,12 +1,60 @@
+import http.cookies
 from contextvars import ContextVar
+from email.utils import format_datetime
 
 from starlette.datastructures import MutableHeaders
 from starlette.requests import Request
 from starlette.types import ASGIApp, Message, Receive, Scope, Send
 
+from eddrit.routes.common.cookies import get_default_cookie_settings
+
 _current_host_ctx_var: ContextVar[str] = ContextVar("CURRENT_HOST_CTX_VAR", default="")
 
 
+class CookiesRefreshMiddleware:
+    """Middleware to refresh a specified set of cookies in all responses."""
+
+    def __init__(self, app: ASGIApp, cookies_to_refresh: list[str]) -> None:
+        self.app = app
+        self.cookies_to_refresh = cookies_to_refresh
+
+    async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
+        if scope["type"] != "http":
+            return await self.app(scope, receive, send)
+
+        async def send_with_refreshed_cookies(message: Message) -> None:
+            if message["type"] == "http.response.start":
+                initial_request = Request(scope)
+                headers = MutableHeaders(scope=message)
+                cookie_default_settings = get_default_cookie_settings()
+
+                for cookie_name, cookie_value in initial_request.cookies.items():
+                    if cookie_name not in self.cookies_to_refresh:
+                        continue
+
+                    # Same code as Response.set_cookie from starlette
+                    updated_cookie = http.cookies.SimpleCookie()
+                    updated_cookie[cookie_name] = cookie_value
+                    updated_cookie[cookie_name]["expires"] = format_datetime(
+                        cookie_default_settings.expiration_date, usegmt=True
+                    )
+                    updated_cookie[cookie_name]["path"] = "/"
+                    updated_cookie[cookie_name]["secure"] = (
+                        cookie_default_settings.secure
+                    )
+                    updated_cookie[cookie_name]["httponly"] = (
+                        cookie_default_settings.http_only
+                    )
+                    updated_cookie[cookie_name]["samesite"] = "lax"
+                    headers.append(
+                        key="set-cookie", value=updated_cookie.output(header="").strip()
+                    )
+
+            await send(message)
+
+        await self.app(scope, receive, send_with_refreshed_cookies)
+
+
 class NoReferrerMiddleware:
     """Middleware adding a no-referrer Referrer-Policy on all responses"""