Merge pull request #7286 from akatsoulas/vpn-routing

akatsoulas · web-flow · commit f5d21a0193d9 · 2026-03-05T17:05:01.000+02:00
Update routing options for ZD
diff --git a/kitsune/products/admin.py b/kitsune/products/admin.py
@@ -227,13 +227,14 @@ class ProductSupportConfigAdmin(admin.ModelAdmin):
         "enable_zendesk_support",
         "is_hybrid",
         "default_support_type",
+        "subscription_only",
     )
     list_display_links = ("product",)
     list_editable = ("is_active",)
     list_filter = ("is_active", "default_support_type")
     search_fields = ("product__title", "product__slug")
     filter_horizontal = ("hybrid_support_groups",)
-    autocomplete_fields = ("product", "forum_config", "zendesk_config")
+    autocomplete_fields = ("product", "forum_config", "zendesk_config", "unsubscribed_redirect_product")
     readonly_fields = (
         "is_hybrid",
         "enable_forum_support",
@@ -272,6 +273,17 @@ class ProductSupportConfigAdmin(admin.ModelAdmin):
                 "description": "Set default support type for all users and optionally for hybrid group members.",
             },
         ),
+        (
+            "Subscription Routing",
+            {
+                "fields": ("subscription_only", "unsubscribed_redirect_product"),
+                "description": (
+                    "When subscription_only is enabled, only users with an active product subscription "
+                    "can access support. Unsubscribed users are redirected to the specified product's AAQ, "
+                    "or the entire AAQ flow returns 404 if no redirect product is set."
+                ),
+            },
+        ),
         (
             "Hybrid Support (Forums + Zendesk)",
             {
diff --git a/kitsune/products/managers.py b/kitsune/products/managers.py
@@ -31,6 +31,9 @@ def locales_list(self):
             .distinct()
         )
 
+    SUPPORT_TYPE_REDIRECT = "redirect_unsubscribed"
+    SUPPORT_TYPE_HIDE = "hide_unsubscribed"
+
     def route_support_request(self, request, product):
         """
         Determines which support channel to route a request to (forum or Zendesk).
@@ -44,7 +47,8 @@ def route_support_request(self, request, product):
 
         Returns:
             tuple: (support_type, can_switch)
-                - support_type: SUPPORT_TYPE_FORUM, SUPPORT_TYPE_ZENDESK, or None
+                - support_type: SUPPORT_TYPE_FORUM, SUPPORT_TYPE_ZENDESK,
+                  SUPPORT_TYPE_REDIRECT, SUPPORT_TYPE_HIDE, or None
                 - can_switch: whether user can toggle between channels
                 - Returns (None, False) if no config exists - view should handle error
         """
@@ -57,6 +61,18 @@ def route_support_request(self, request, product):
             return (None, False)
 
         user = request.user
+
+        # Subscription gate: check before any other routing logic
+        if support_config.subscription_only:
+            is_subscribed = (
+                user.is_authenticated
+                and user.profile.products.filter(id=product.id).exists()
+            )
+            if not is_subscribed:
+                if support_config.unsubscribed_redirect_product_id:
+                    return (self.SUPPORT_TYPE_REDIRECT, False)
+                return (self.SUPPORT_TYPE_HIDE, False)
+
         requested_type = request.GET.get("support_type")
 
         # Validate requested_type
diff --git a/kitsune/products/migrations/0035_productsupportconfig_subscription_only_and_more.py b/kitsune/products/migrations/0035_productsupportconfig_subscription_only_and_more.py
@@ -0,0 +1,24 @@
+# Generated by Django 5.2.12 on 2026-03-05 14:14
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('products', '0034_zendeskconfig_brand_id'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='productsupportconfig',
+            name='subscription_only',
+            field=models.BooleanField(default=False, help_text="If enabled, only users with an active product subscription can access support. Unsubscribed users are redirected to another product's AAQ if one is configured, otherwise the support widget is hidden."),
+        ),
+        migrations.AddField(
+            model_name='productsupportconfig',
+            name='unsubscribed_redirect_product',
+            field=models.ForeignKey(blank=True, help_text="When subscription_only is enabled, redirect unsubscribed users to this product's AAQ. If not set, the support widget is hidden for unsubscribed users.", null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='redirect_target_for', to='products.product'),
+        ),
+    ]
diff --git a/kitsune/products/models.py b/kitsune/products/models.py
@@ -323,6 +323,25 @@ class ProductSupportConfig(ModelBase):
         blank=True,
         help_text="Default support type for users in hybrid groups (if not set, uses default_support_type)",
     )
+    subscription_only = models.BooleanField(
+        default=False,
+        help_text=(
+            "If enabled, only users with an active product subscription can access support. "
+            "Unsubscribed users are redirected to another product's AAQ if one is configured, "
+            "otherwise the support widget is hidden."
+        ),
+    )
+    unsubscribed_redirect_product = models.ForeignKey(
+        "Product",
+        null=True,
+        blank=True,
+        on_delete=models.SET_NULL,
+        related_name="redirect_target_for",
+        help_text=(
+            "When subscription_only is enabled, redirect unsubscribed users to this product's AAQ. "
+            "If not set, the support widget is hidden for unsubscribed users."
+        ),
+    )
 
     objects = ProductSupportConfigManager()
 
@@ -364,6 +383,15 @@ def clean(self):
             ).exists():
                 raise ValidationError("The selected forum configuration has no enabled locales.")
 
+        if not self.subscription_only and self.unsubscribed_redirect_product_id:
+            raise ValidationError(
+                {
+                    "unsubscribed_redirect_product": (
+                        "Redirect product should only be set when subscription_only is enabled."
+                    )
+                }
+            )
+
     @property
     def is_hybrid(self):
         """Returns True if both forum and Zendesk support are enabled."""
diff --git a/kitsune/products/tests/test_support_routing.py b/kitsune/products/tests/test_support_routing.py
@@ -1,6 +1,7 @@
 from django.contrib.auth.models import AnonymousUser
 from django.test import RequestFactory, TestCase
 
+from kitsune.products.managers import ProductSupportConfigManager
 from kitsune.products.models import ProductSupportConfig
 from kitsune.products.tests import (
     ProductFactory,
@@ -299,3 +300,89 @@ def test_no_support_channels_constraint(self):
             )
 
         self.assertIn("at_least_one_support_channel", str(context.exception))
+
+
+class SubscriptionRoutingTests(TestCase):
+    """Tests for subscription_only routing in route_support_request()."""
+
+    def setUp(self):
+        self.factory = RequestFactory()
+        self.product = ProductFactory(slug="mozilla-vpn")
+        self.zendesk_config = ZendeskConfigFactory()
+        self.user = UserFactory()
+        self.config = ProductSupportConfigFactory(
+            product=self.product,
+            forum_config=None,
+            zendesk_config=self.zendesk_config,
+            is_active=True,
+            subscription_only=True,
+        )
+
+    def test_subscriber_routes_to_zendesk(self):
+        """Subscribed user on a subscription_only product is routed to ZD."""
+        self.user.profile.products.add(self.product)
+
+        request = self.factory.get("/")
+        request.user = self.user
+
+        support_type, can_switch = ProductSupportConfig.objects.route_support_request(
+            request, self.product
+        )
+
+        self.assertEqual(support_type, ProductSupportConfig.SUPPORT_TYPE_ZENDESK)
+        self.assertFalse(can_switch)
+
+    def test_non_subscriber_with_redirect_returns_redirect_sentinel(self):
+        """Non-subscribed user is returned SUPPORT_TYPE_REDIRECT when redirect product is set."""
+        redirect_product = ProductFactory(slug="firefox")
+        self.config.unsubscribed_redirect_product = redirect_product
+        self.config.save()
+
+        request = self.factory.get("/")
+        request.user = self.user  # has no subscription
+
+        support_type, can_switch = ProductSupportConfig.objects.route_support_request(
+            request, self.product
+        )
+
+        self.assertEqual(support_type, ProductSupportConfigManager.SUPPORT_TYPE_REDIRECT)
+        self.assertFalse(can_switch)
+
+    def test_non_subscriber_without_redirect_returns_hide_sentinel(self):
+        """Non-subscribed user is returned SUPPORT_TYPE_HIDE when no redirect product is set."""
+        request = self.factory.get("/")
+        request.user = self.user  # has no subscription, no redirect product configured
+
+        support_type, can_switch = ProductSupportConfig.objects.route_support_request(
+            request, self.product
+        )
+
+        self.assertEqual(support_type, ProductSupportConfigManager.SUPPORT_TYPE_HIDE)
+        self.assertFalse(can_switch)
+
+    def test_anonymous_user_returns_hide_sentinel(self):
+        """Anonymous users on a subscription_only product are treated as non-subscribers."""
+        request = self.factory.get("/")
+        request.user = AnonymousUser()
+
+        support_type, can_switch = ProductSupportConfig.objects.route_support_request(
+            request, self.product
+        )
+
+        self.assertEqual(support_type, ProductSupportConfigManager.SUPPORT_TYPE_HIDE)
+        self.assertFalse(can_switch)
+
+    def test_subscription_only_false_bypasses_check(self):
+        """When subscription_only is False, all users pass through to normal routing."""
+        self.config.subscription_only = False
+        self.config.save()
+
+        request = self.factory.get("/")
+        request.user = self.user  # no subscription, but subscription_only is off
+
+        support_type, can_switch = ProductSupportConfig.objects.route_support_request(
+            request, self.product
+        )
+
+        self.assertEqual(support_type, ProductSupportConfig.SUPPORT_TYPE_ZENDESK)
+        self.assertFalse(can_switch)
diff --git a/kitsune/products/views.py b/kitsune/products/views.py
@@ -8,6 +8,7 @@
 
 from kitsune.flagit.views import get_hierarchical_topics
 from kitsune.products import get_product_redirect_response
+from kitsune.products.managers import ProductSupportConfigManager
 from kitsune.products.models import Product, Topic, TopicSlugHistory
 from kitsune.sumo.utils import get_aaq_context, set_aaq_context
 from kitsune.wiki.decorators import check_simple_wiki_locale
@@ -70,7 +71,9 @@ def product_landing(request: HttpRequest, slug: str) -> HttpResponse:
             "search_params": {"product": slug},
             "latest_version": latest_version,
             "featured": get_featured_articles(product=product, locale=request.LANGUAGE_CODE),
-            "has_support_config": bool(aaq_context),
+            "has_support_config": bool(aaq_context)
+            and aaq_context.get("current_support_type")
+            != ProductSupportConfigManager.SUPPORT_TYPE_HIDE,
             "aaq_context": aaq_context,
         },
     )
diff --git a/kitsune/questions/views.py b/kitsune/questions/views.py
@@ -37,6 +37,7 @@
 from kitsune.flagit.models import FlaggedObject
 from kitsune.flagit.views import get_hierarchical_topics
 from kitsune.products import get_product_redirect_response
+from kitsune.products.managers import ProductSupportConfigManager
 from kitsune.products.models import Product, ProductSupportConfig, Topic, TopicSlugHistory
 from kitsune.questions import config
 from kitsune.questions.events import QuestionReplyEvent, QuestionSolvedEvent
@@ -641,6 +642,13 @@ def aaq(request, product_slug=None, step=1, is_loginless=False):
             )
             return HttpResponseRedirect(reverse("products.product", args=[product.slug]))
 
+        # Handle subscription-gated products
+        if support_type == ProductSupportConfigManager.SUPPORT_TYPE_REDIRECT:
+            return HttpResponseRedirect(aaq_context["redirect_url"])
+
+        if support_type == ProductSupportConfigManager.SUPPORT_TYPE_HIDE:
+            raise Http404
+
         has_public_forum = aaq_context.get("has_public_forum", False)
 
         context["ga_products"] = f"/{product_slug}/"
diff --git a/kitsune/sumo/utils.py b/kitsune/sumo/utils.py
@@ -424,14 +424,33 @@ def get_aaq_context(request, product, multiple_products=False):
     Given a request and a product, determine the AAQ context and return it.
 
     Returns an empty dict when there is no support config for the product.
+
+    When subscription_only is enabled and the user lacks a subscription:
+    - current_support_type is SUPPORT_TYPE_REDIRECT with redirect_url set, or
+    - current_support_type is SUPPORT_TYPE_HIDE (caller should return Http404)
     """
+    from kitsune.products.managers import ProductSupportConfigManager
     from kitsune.products.models import ProductSupportConfig
 
     if not has_support_config(product):
         return {}
 
     support_type, can_switch = ProductSupportConfig.objects.route_support_request(request, product)
 
+    if support_type == ProductSupportConfigManager.SUPPORT_TYPE_REDIRECT:
+        config = ProductSupportConfig.objects.get(product=product, is_active=True)
+        redirect_url = reverse(
+            "questions.aaq_step2",
+            kwargs={"product_slug": config.unsubscribed_redirect_product.slug},
+        )
+        return {
+            "current_support_type": support_type,
+            "redirect_url": redirect_url,
+        }
+
+    if support_type == ProductSupportConfigManager.SUPPORT_TYPE_HIDE:
+        return {"current_support_type": support_type}
+
     aaq_context = {
         "product_slug": product.slug,
         "multiple_products": multiple_products,
@@ -467,6 +486,11 @@ def get_aaq_url(aaq_context, topic=None):
 
     Expects a dict as returned by get_aaq_context (may be empty).
     """
+    from kitsune.products.managers import ProductSupportConfigManager
+
+    if aaq_context.get("current_support_type") == ProductSupportConfigManager.SUPPORT_TYPE_REDIRECT:
+        return aaq_context.get("redirect_url")
+
     is_ticketed = aaq_context.get("current_support_type") == "zendesk"
     has_forum = aaq_context.get("has_public_forum", False)
     multiple_products = aaq_context.get("multiple_products", False)
