chore: centralize and improve subscription state logic

Author: herzog0

core/views.py

@@ -46,7 +46,10 @@
 
 from . import context_processors
 from .mixins import V3Mixin, iter_v3_views
-from mailing_list.mixins import MailingListCardMixin
+from mailing_list.mixins import (
+    MailingListCardMixin,
+    get_subscription_state_count_and_email,
+)
 from .asciidoc import convert_adoc_to_html
 from .boostrenderer import (
     convert_img_paths,
@@ -2230,14 +2233,30 @@ def get_context_data(self, **kwargs):
         context["demo_quick_subscribe_url"] = self.request.build_absolute_uri(
             reverse("mailing-list-quick-subscribe")
         )
-        context["demo_subscribed_lists"] = set(
-            UserMailingListSubscription.objects.filter(
-                user=self.request.user, list_id__in=_settings.MAILMAN_LISTS
-            ).values_list("list_id", flat=True)
-        )
+
+        mailing_list_state = None
+
+        if self.request.user.is_authenticated:
+            mailing_list_state = get_subscription_state_count_and_email(
+                self.request.user, _settings.MAILMAN_LISTS
+            )
+            context["demo_subscribed_lists"] = set(
+                UserMailingListSubscription.objects.filter(
+                    user=self.request.user, list_id__in=_settings.MAILMAN_LISTS
+                ).values_list("list_id", flat=True)
+            )
+        else:
+            context["demo_subscribed_lists"] = set()
+
+        print(f"\n\n\n\n\n{mailing_list_state}\n\n\n\n\n")
+
         context["demo_mailing_list_card_list_id"] = _demo_card_list_id
-        context["demo_mailing_list_card_is_subscribed"] = (
-            _demo_card_list_id in context["demo_subscribed_lists"]
+        context["demo_mailing_list_card_state"] = mailing_list_state[0]
+        context["demo_subscription_count"] = (
+            mailing_list_state[1] if mailing_list_state else 0
+        )
+        context["demo_subscribed_lists_email"] = (
+            mailing_list_state[2] if mailing_list_state else ""
         )
         # V3 paths registry
         v3_paths = [

mailing_list/mixins.py

@@ -1,3 +1,5 @@
+from typing import Union, Tuple
+
 from django.conf import settings
 from django.urls import reverse
 
@@ -7,16 +9,50 @@
 _DEFAULT_LIST_ID = "boost.lists.boost.org"
 
 
+def get_subscription_state_count_and_email(
+    user, list_ids
+) -> Tuple[Union[str, None], int, Union[str, None]]:
+    """Return the subscription state for a single user/list pair.
+
+    Returns:
+        "pending"  — a subscription record exists with PENDING status
+        "active"   — a subscription record exists with ACTIVE status
+        None       — user is not authenticated or has no subscription for list_id
+    """
+    if not user.is_authenticated:
+        return None, 0, None
+
+    subscriptions = list(
+        UserMailingListSubscription.objects.filter(user=user, list_id__in=list_ids)
+    )
+
+    pending_subs = [
+        sub for sub in subscriptions if sub.status == SubscriptionStatus.PENDING
+    ]
+    pending_count = len(pending_subs)
+
+    active_subs = [
+        sub for sub in subscriptions if sub.status == SubscriptionStatus.ACTIVE
+    ]
+    active_count = len(active_subs)
+
+    if pending_count > 0:
+        return SubscriptionStatus.PENDING, pending_count, subscriptions[0].email
+    elif active_count > 0:
+        return SubscriptionStatus.ACTIVE, active_count, subscriptions[0].email
+    else:
+        return None, 0, None
+
+
 class MailingListCardMixin:
     """Injects mailing-list card context into any class-based view.
 
     Adds the variables needed by v3/includes/_mailing_list_card.html:
       mailing_list_card_subscribe_url
       mailing_list_card_list_id
-      mailing_list_card_state             (authenticated users only — "pending" or None)
-      mailing_list_card_user_email        (authenticated users only)
-      mailing_list_card_is_subscribed     (authenticated users only — True only when ACTIVE)
-      mailing_list_card_manage_url        (authenticated users only)
+      mailing_list_card_state              ("pending", "active", or None)
+      mailing_list_card_user_email         (authenticated users only)
+      mailing_list_card_manage_url         (authenticated users only)
       mailing_list_card_subscription_count (authenticated users only — ACTIVE count only)
     """
 
@@ -31,31 +67,11 @@ def get_context_data(self, **kwargs):
 
         if request.user.is_authenticated:
             managed_lists = set(settings.MAILMAN_LISTS)
-            subscription = UserMailingListSubscription.objects.filter(
-                user=request.user, list_id=_DEFAULT_LIST_ID
-            ).first()
-
-            is_subscribed = False
-            card_state = None
-            user_email = ""
-
-            if subscription:
-                user_email = subscription.email or ""
-                if subscription.status == SubscriptionStatus.ACTIVE:
-                    is_subscribed = True
-                else:
-                    card_state = "pending"
-
-            context["mailing_list_card_is_subscribed"] = is_subscribed
-            context["mailing_list_card_state"] = card_state
-            context["mailing_list_card_user_email"] = user_email
-            context["mailing_list_card_subscription_count"] = (
-                UserMailingListSubscription.objects.filter(
-                    user=request.user,
-                    list_id__in=managed_lists,
-                    status=SubscriptionStatus.ACTIVE,
-                ).count()
-            )
+            state = get_subscription_state_count_and_email(request.user, managed_lists)
+
+            context["mailing_list_card_state"] = state[0]
+            context["mailing_list_card_subscription_count"] = state[1]
+            context["mailing_list_card_user_email"] = state[2]
             context["mailing_list_card_manage_url"] = request.build_absolute_uri(
                 reverse("profile-account")
             )

templates/v3/community.html

@@ -38,7 +38,7 @@
             {% include "v3/includes/_post_card.html" with heading="Posts from the Boost community" items=posts variant="card" theme="teal" primary_cta_label="View all posts" primary_cta_url=news_url %}
           </div>
           <div class="community-masonry__cell community-masonry__cell--mailing">
-            {% include "v3/includes/_mailing_list_card.html" with subscribe_url=mailing_list_card_subscribe_url list_id=mailing_list_card_list_id is_subscribed=mailing_list_card_is_subscribed state=mailing_list_card_state user_email=mailing_list_card_user_email manage_url=mailing_list_card_manage_url subscription_count=mailing_list_card_subscription_count %}
+            {% include "v3/includes/_mailing_list_card.html" with subscribe_url=mailing_list_card_subscribe_url list_id=mailing_list_card_list_id state=mailing_list_card_state user_email=mailing_list_card_user_email manage_url=mailing_list_card_manage_url subscription_count=mailing_list_card_subscription_count %}
           </div>
         </div>
       </div>

templates/v3/examples/_v3_example_section.html

@@ -608,7 +608,7 @@ <h3>{{ section_title }}</h3>
   {% with section_title="Mailing List Card" %}
     <div class="v3-examples-section__block" id="{{ section_title|slugify }}">
       <h3>{{ section_title }}</h3>
-      <div class="v3-examples-section__example-box">{% include "v3/includes/_mailing_list_card.html" with subscribe_url=demo_quick_subscribe_url list_id=demo_mailing_list_card_list_id is_subscribed=demo_mailing_list_card_is_subscribed user_email=request.user.email %}</div>
+      <div class="v3-examples-section__example-box">{% include "v3/includes/_mailing_list_card.html" with subscribe_url=demo_quick_subscribe_url list_id=demo_mailing_list_card_list_id state=demo_mailing_list_card_state user_email=demo_subscribed_lists_email subscription_count=demo_subscription_count %}</div>
     </div>
   {% endwith %}
 

templates/v3/includes/_mailing_list_card.html

@@ -3,14 +3,17 @@
 Variables:
   subscribe_url      — (required) POST endpoint; build via request.build_absolute_uri(reverse("mailing-list-quick-subscribe"))
   list_id            — (optional) mailing list ID; defaults to "boost.lists.boost.org"
-  is_subscribed      — (optional) whether the current user is already subscribed to list_id
+  state              — "active" | "pending" | "error" | None
+                       "active"  — user is subscribed; shows success card
+                       "pending" — confirmation email sent; shows pending card
+                       "error"   — form submission failed; shows form with error_message
+                       None      — default; shows subscribe form
   user_email         — (optional) email used in the subscription
-manage_url         — (optional) URL for managing subscriptions; shown in success card
+  manage_url         — (optional) URL for managing subscriptions; shown in success/pending card
   subscription_count — (optional) number of lists subscribed to; shown in success card
-  state              — (internal) "error" | "pending" when re-rendered by the view
-  error_message      — (internal) error text shown when state="error"
+  error_message      — error text shown when state="error"
 {% endcomment %}
-{% if is_subscribed %}
+{% if state == "active" %}
   {% include "v3/mailing_list/_subscribe_success_card.html" with email=user_email manage_url=manage_url subscription_count=subscription_count only %}
 {% elif state == "pending" %}
   <div class="basic-card card">

templates/v3/learn_page.html

@@ -49,7 +49,7 @@ <h1>Start anywhere. Learn everything. Build anything.</h1>
         {% endwith %}
       </div>
       <div class="item-e">
-        {% include 'v3/includes/_mailing_list_card.html' with subscribe_url=mailing_list_card_subscribe_url list_id=mailing_list_card_list_id is_subscribed=mailing_list_card_is_subscribed state=mailing_list_card_state user_email=mailing_list_card_user_email manage_url=mailing_list_card_manage_url subscription_count=mailing_list_card_subscription_count %}
+        {% include 'v3/includes/_mailing_list_card.html' with subscribe_url=mailing_list_card_subscribe_url list_id=mailing_list_card_list_id state=mailing_list_card_state user_email=mailing_list_card_user_email manage_url=mailing_list_card_manage_url subscription_count=mailing_list_card_subscription_count %}
       </div>
     </div>
   </div>

templates/v3/libraries/library-subpage.html

@@ -53,7 +53,7 @@
         {% include "v3/includes/_post_card.html" with heading="Latest "|add:object.display_name|add:" posts" items=library_posts variant="card" theme="teal" layout="horizontal" primary_cta_label="View all posts" primary_cta_url="/news/" %}
       </div>
       <div class="item-b">
-        {% include "v3/includes/_mailing_list_card.html" with subscribe_url=mailing_list_card_subscribe_url list_id=mailing_list_card_list_id is_subscribed=mailing_list_card_is_subscribed state=mailing_list_card_state user_email=mailing_list_card_user_email manage_url=mailing_list_card_manage_url subscription_count=mailing_list_card_subscription_count %}
+        {% include "v3/includes/_mailing_list_card.html" with subscribe_url=mailing_list_card_subscribe_url list_id=mailing_list_card_list_id state=mailing_list_card_state user_email=mailing_list_card_user_email manage_url=mailing_list_card_manage_url subscription_count=mailing_list_card_subscription_count %}
       </div>
     </div>
 

templates/v3/release_detail.html

@@ -34,7 +34,7 @@
     {% endif %}
 
     <section class="release-detail__bottom-cards" aria-label="Community and resources">
-      {% include "v3/includes/_mailing_list_card.html" with subscribe_url=mailing_list_card_subscribe_url list_id=mailing_list_card_list_id is_subscribed=mailing_list_card_is_subscribed state=mailing_list_card_state user_email=mailing_list_card_user_email manage_url=mailing_list_card_manage_url subscription_count=mailing_list_card_subscription_count %}
+      {% include "v3/includes/_mailing_list_card.html" with subscribe_url=mailing_list_card_subscribe_url list_id=mailing_list_card_list_id state=mailing_list_card_state user_email=mailing_list_card_user_email manage_url=mailing_list_card_manage_url subscription_count=mailing_list_card_subscription_count %}
 
       {% include "v3/includes/_basic_card.html" with title="Want to fix bugs, review code, maintain libraries, and propose new features?" text="Read our contributors guide and join the Boost community." primary_button_url="/contribute" primary_button_label="Start here" primary_button_style="green" theme="green" only %}
       {% large_static 'img/v3/home-page/heros.png' as image_url %}