Merge pull request #7283 from akatsoulas/zd-brand

Add brand_id to ZD tickets

Author: akatsoulas

kitsune/customercare/tests/test_zendesk.py

@@ -299,3 +299,71 @@ def test_create_ticket_omits_empty_deployment_fields(self, mock_zenpy):
 
         self.assertNotIn(127, field_ids)
         self.assertNotIn(128, field_ids)
+
+    @patch("kitsune.customercare.zendesk.Zenpy")
+    @patch("django.conf.settings.ZENDESK_PRODUCT_FIELD_ID", 123)
+    @patch("django.conf.settings.ZENDESK_OS_FIELD_ID", 124)
+    @patch("django.conf.settings.ZENDESK_COUNTRY_FIELD_ID", 125)
+    @patch("django.conf.settings.ZENDESK_CATEGORY_FIELD_ID", 126)
+    def test_create_ticket_includes_brand_id(self, mock_zenpy):
+        """Test that create_ticket sets brand_id on the ticket when provided."""
+        mock_client = Mock()
+        mock_zenpy.return_value = mock_client
+        mock_client.tickets.create.return_value = Mock(id=789)
+        self.user.profile.zendesk_id = "123"
+
+        client = ZendeskClient()
+        client.update_user = Mock(return_value=Mock(id=456))
+
+        ticket_fields = {
+            "product": "firefox",
+            "product_title": "Firefox",
+            "subject": "Test subject",
+            "description": "Test description",
+            "category": "technical",
+            "os": "win10",
+            "country": "US",
+            "ticket_form_id": 456,
+            "brand_id": "360000001234",
+        }
+
+        client.create_ticket(self.user, ticket_fields)
+
+        mock_client.tickets.create.assert_called_once()
+        call_args = mock_client.tickets.create.call_args[0][0]
+
+        self.assertEqual(call_args.brand_id, 360000001234)
+
+    @patch("kitsune.customercare.zendesk.Zenpy")
+    @patch("django.conf.settings.ZENDESK_PRODUCT_FIELD_ID", 123)
+    @patch("django.conf.settings.ZENDESK_OS_FIELD_ID", 124)
+    @patch("django.conf.settings.ZENDESK_COUNTRY_FIELD_ID", 125)
+    @patch("django.conf.settings.ZENDESK_CATEGORY_FIELD_ID", 126)
+    def test_create_ticket_omits_brand_id_when_not_set(self, mock_zenpy):
+        """Test that create_ticket does not set brand_id when not provided."""
+        mock_client = Mock()
+        mock_zenpy.return_value = mock_client
+        mock_client.tickets.create.return_value = Mock(id=789)
+        self.user.profile.zendesk_id = "123"
+
+        client = ZendeskClient()
+        client.update_user = Mock(return_value=Mock(id=456))
+
+        ticket_fields = {
+            "product": "firefox",
+            "product_title": "Firefox",
+            "subject": "Test subject",
+            "description": "Test description",
+            "category": "technical",
+            "os": "win10",
+            "country": "US",
+            "ticket_form_id": 456,
+            "brand_id": "",
+        }
+
+        client.create_ticket(self.user, ticket_fields)
+
+        mock_client.tickets.create.assert_called_once()
+        call_args = mock_client.tickets.create.call_args[0][0]
+
+        self.assertFalse(hasattr(call_args, "brand_id") and call_args.brand_id)

kitsune/customercare/utils.py

@@ -115,7 +115,8 @@ def _handle_zendesk_exception(error: Exception) -> bool:
     )
 
     support_config = ProductSupportConfig.objects.get(product=submission.product, is_active=True)
-    ticket_form_id = support_config.zendesk_config.ticket_form_id
+    zendesk_config = support_config.zendesk_config
+    ticket_form_id = zendesk_config.ticket_form_id
 
     client = ZendeskClient()
     ticket_fields = {
@@ -131,6 +132,7 @@ def _handle_zendesk_exception(error: Exception) -> bool:
         "product_title": submission.product.title,
         "zendesk_tags": submission.zendesk_tags,
         "ticket_form_id": int(ticket_form_id),
+        "brand_id": zendesk_config.brand_id,
     }
 
     try:

kitsune/customercare/zendesk.py

@@ -138,6 +138,9 @@ def create_ticket(self, user, ticket_fields):
             "ticket_form_id": ticket_fields.get("ticket_form_id"),
         }
 
+        if brand_id := ticket_fields.get("brand_id"):
+            ticket_kwargs["brand_id"] = int(brand_id)
+
         tags = []
         # If this is the normal, athenticated form we want to use the category field
         if user and user.is_authenticated:

kitsune/products/migrations/0034_zendeskconfig_brand_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.11 on 2026-03-03 14:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('products', '0033_add_deployment_fields'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='zendeskconfig',
+            name='brand_id',
+            field=models.CharField(blank=True, help_text='Zendesk brand ID to associate tickets with for this product', max_length=50),
+        ),
+    ]

kitsune/products/models.py

@@ -373,6 +373,11 @@ class ZendeskConfig(ModelBase):
         blank=True,
         help_text="Zendesk ticket form ID to use for this product (leave blank to use global default)",
     )
+    brand_id = models.CharField(
+        max_length=50,
+        blank=True,
+        help_text="Zendesk brand ID to associate tickets with for this product",
+    )
     enable_os_field = models.BooleanField(
         default=False, help_text="Show operating system selector in the support form"
     )