Add Matomo retention dimension: Days Since Registration (#12227)

* Add Matomo retention dimension: Days Since Registration (issue #12144)

- Add get_patron_status(user) helper that buckets patron account age
  into visit-scoped Matomo dimension values: visitor, d0, d1+, d7+,
  d14+, d30+, d90+
- Set web.ctx.patron_status per-request in setup_contextvars processor
- Add patron_status default ('visitor') to context.defaults
- Push _paq.setCustomDimension(1, patron_status) in head.html before
  the Matomo Tag Manager container fires trackPageView
- Add unit tests covering all bucket boundaries and error cases

Author: mekarpeles

openlibrary/accounts/__init__.py

@@ -1,3 +1,4 @@
+import datetime
 from typing import TYPE_CHECKING
 
 import web
@@ -61,6 +62,41 @@ def get_current_user() -> "User | None":
     return site.get().get_user()
 
 
+@public
+def get_days_registered(user) -> str:
+    """Return a Matomo custom dimension value for patron account age.
+
+    Buckets for visit-scoped dimension 1 ("Days Since Registration"):
+      visitor  — not logged in
+      d0       — account created today (UTC)
+      d1+      — 1-6 days since registration
+      d7+      — 7-13 days
+      d14+     — 14-29 days
+      d30+     — 30-89 days
+      d90+     — 90+ days (also the safe fallback on any error)
+    """
+    if not user:
+        return 'visitor'
+    try:
+        reg_date = user.created.date()
+        days = (datetime.datetime.now(datetime.UTC).date() - reg_date).days
+    except (AttributeError, TypeError):
+        # If the date is incorrectly encoded, assume the patron
+        # registered a long time ago before we had this set up.
+        return 'd90+'
+    if days <= 0:
+        return 'd0'
+    elif days < 7:
+        return 'd1+'
+    elif days < 14:
+        return 'd7+'
+    elif days < 30:
+        return 'd14+'
+    elif days < 90:
+        return 'd30+'
+    return 'd90+'
+
+
 def find(
     username: str | None = None, lusername: str | None = None, email: str | None = None
 ) -> Account | None:

openlibrary/plugins/openlibrary/code.py

@@ -1298,7 +1298,13 @@ def get_supported_languages():
 def setup_context_defaults():
     from infogami.utils import context
 
-    context.defaults.update({'features': [], 'user': None, 'MAX_VISIBLE_BOOKS': 5})
+    context.defaults.update(
+        {
+            'features': [],
+            'user': None,
+            'MAX_VISIBLE_BOOKS': 5,
+        }
+    )
 
 
 def setup():

openlibrary/plugins/openlibrary/tests/test_patron_status.py

@@ -0,0 +1,66 @@
+"""Tests for get_days_registered — Matomo retention dimension helper."""
+
+import datetime
+from unittest.mock import MagicMock
+
+import pytest
+
+from openlibrary.accounts import get_days_registered
+
+
+def _user(days_ago):
+    """Return a mock user whose account was created `days_ago` days ago (UTC)."""
+    user = MagicMock()
+    user.created = datetime.datetime.now(datetime.UTC) - datetime.timedelta(days=days_ago)
+    return user
+
+
+# ---------------------------------------------------------------------------
+# Unauthenticated / missing data
+# ---------------------------------------------------------------------------
+
+
+def test_no_user_returns_visitor():
+    assert get_days_registered(None) == "visitor"
+
+
+def test_falsy_user_returns_visitor():
+    assert get_days_registered(0) == "visitor"
+    assert get_days_registered("") == "visitor"
+
+
+def test_missing_created_returns_d90_plus():
+    user = MagicMock()
+    user.created = None
+    assert get_days_registered(user) == "d90+"
+
+
+def test_invalid_created_returns_d90_plus():
+    user = MagicMock()
+    user.created = "not-a-date"
+    assert get_days_registered(user) == "d90+"
+
+
+# ---------------------------------------------------------------------------
+# Bucket boundaries
+# ---------------------------------------------------------------------------
+
+
+@pytest.mark.parametrize(
+    ("days_ago", "expected"),
+    [
+        (0, "d0"),
+        (1, "d1+"),
+        (6, "d1+"),
+        (7, "d7+"),
+        (13, "d7+"),
+        (14, "d14+"),
+        (29, "d14+"),
+        (30, "d30+"),
+        (89, "d30+"),
+        (90, "d90+"),
+        (365, "d90+"),
+    ],
+)
+def test_day_buckets(days_ago, expected):
+    assert get_days_registered(_user(days_ago)) == expected

openlibrary/templates/site/head.html

@@ -70,6 +70,10 @@
     </noscript>
  <script>
  $if not is_bot():
+   // Dimension 1 (visit-scoped): "Days Since Registration" — ID must match Matomo admin config (issue #12144)
+   var _paq = window._paq = window._paq || [];
+   _paq.push(['setCustomDimension', 1, $:dumps(get_days_registered(ctx.user))]);
+
    var _mtm = window._mtm = window._mtm || [];
    _mtm.push({'mtm.startTime': (new Date().getTime()), 'event': 'mtm.Start'});
    (function() {