Template
Add campaign UTM links and piha.li shortener as a core helper.
Keep mint/UTM in always-on core so email_sms and directmail stay optional, and brand utm_source from SITE_NAME (or UTM_SOURCE) instead of a hardcoded client name. Closes #3
This commit is contained in:
+166
-2
@@ -1,5 +1,5 @@
|
||||
from django.contrib.auth import get_user_model
|
||||
from django.test import Client, TestCase
|
||||
from django.test import Client, TestCase, override_settings
|
||||
from django.urls import reverse
|
||||
|
||||
from contacts.models import Channel, ConsentRecord, Contact, Suppression
|
||||
@@ -1070,6 +1070,7 @@ class CampaignRecipientTableTests(TestCase):
|
||||
self.assertEqual(self.campaign.messages.count(), 2)
|
||||
|
||||
|
||||
@override_settings(SHORTENER_BASE_URL="", SHORTENER_API_TOKEN="")
|
||||
class Smtp2goSmsSendTests(TestCase):
|
||||
def setUp(self):
|
||||
self.contact = Contact.objects.create(
|
||||
@@ -1127,7 +1128,8 @@ class Smtp2goSmsSendTests(TestCase):
|
||||
payload = post.call_args.kwargs["json"]
|
||||
self.assertEqual(payload["api_key"], "api-test-key")
|
||||
self.assertEqual(payload["destination"], ["+13304022675"])
|
||||
self.assertEqual(payload["content"], "Hello Rufus")
|
||||
self.assertTrue(payload["content"].startswith("Hello Rufus"))
|
||||
self.assertIn("utm_medium=sms", payload["content"])
|
||||
self.assertNotIn("to", payload)
|
||||
self.assertNotIn("text", payload)
|
||||
|
||||
@@ -1161,3 +1163,165 @@ class Smtp2goSmsSendTests(TestCase):
|
||||
|
||||
self.assertIn("Missing required field", str(ctx.exception))
|
||||
self.assertIn("INVALID_REQUEST", str(ctx.exception))
|
||||
|
||||
|
||||
class CampaignUtmLinkTests(TestCase):
|
||||
def setUp(self):
|
||||
User = get_user_model()
|
||||
self.user = User.objects.create_user(
|
||||
username="utm-composer", password="test-pass-123"
|
||||
)
|
||||
self.client = Client()
|
||||
self.client.login(username="utm-composer", password="test-pass-123")
|
||||
self.contact = Contact.objects.create(
|
||||
email="pat@example.com",
|
||||
phone="5550100199",
|
||||
first_name="Pat",
|
||||
)
|
||||
set_channel_consent(
|
||||
self.contact, Channel.EMAIL, opted_in=True, reason="test"
|
||||
)
|
||||
set_channel_consent(
|
||||
self.contact, Channel.SMS, opted_in=True, reason="test"
|
||||
)
|
||||
|
||||
@override_settings(
|
||||
PUBLIC_SITE_URL="https://acmehvac.com",
|
||||
SITE_NAME="Acme HVAC",
|
||||
UTM_SOURCE="",
|
||||
SHORTENER_BASE_URL="",
|
||||
SHORTENER_API_TOKEN="",
|
||||
)
|
||||
def test_email_draft_inserts_html_link(self):
|
||||
campaign = create_campaign_draft(
|
||||
name="Spring seller tips",
|
||||
audience=Campaign.Audience.EMAIL_OPT_IN,
|
||||
subject="Hello",
|
||||
body="<p>Hi there</p>",
|
||||
created_by=self.user,
|
||||
)
|
||||
self.assertIn('data-campaign-utm="1"', campaign.body_override)
|
||||
self.assertIn("utm_source=acme-hvac", campaign.body_override)
|
||||
self.assertIn("utm_medium=email", campaign.body_override)
|
||||
self.assertIn("utm_campaign=spring-seller-tips", campaign.body_override)
|
||||
self.assertIn("Hi there", campaign.body_override)
|
||||
|
||||
@override_settings(
|
||||
PUBLIC_SITE_URL="https://acmehvac.com",
|
||||
SITE_NAME="Acme HVAC",
|
||||
UTM_SOURCE="",
|
||||
SHORTENER_BASE_URL="",
|
||||
SHORTENER_API_TOKEN="",
|
||||
)
|
||||
def test_sms_draft_inserts_plain_url(self):
|
||||
campaign = create_campaign_draft(
|
||||
name="Open house",
|
||||
audience=Campaign.Audience.SMS_OPT_IN,
|
||||
body="See you Saturday",
|
||||
created_by=self.user,
|
||||
)
|
||||
self.assertIn("See you Saturday", campaign.body_override)
|
||||
self.assertIn(
|
||||
"https://acmehvac.com/?utm_source=acme-hvac&utm_medium=sms"
|
||||
"&utm_campaign=open-house",
|
||||
campaign.body_override,
|
||||
)
|
||||
self.assertNotIn("<a ", campaign.body_override)
|
||||
|
||||
def test_composer_shows_tracked_link_panel(self):
|
||||
url = reverse("email_sms:campaign_list")
|
||||
response = self.client.get(url)
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, "Tracked site link")
|
||||
self.assertContains(response, "campaign-utm.js")
|
||||
self.assertContains(response, "qrcode.min.js")
|
||||
self.assertContains(response, "data-utm-qr")
|
||||
self.assertContains(response, "utm_campaign")
|
||||
self.assertContains(response, reverse("campaign_short_link"))
|
||||
|
||||
@override_settings(
|
||||
PUBLIC_SITE_URL="https://acmehvac.com",
|
||||
SITE_NAME="Acme HVAC",
|
||||
UTM_SOURCE="",
|
||||
SHORTENER_BASE_URL="",
|
||||
SHORTENER_API_TOKEN="",
|
||||
)
|
||||
def test_detail_shows_tracked_url(self):
|
||||
campaign = create_campaign_draft(
|
||||
name="Spring seller tips",
|
||||
audience=Campaign.Audience.EMAIL_OPT_IN,
|
||||
subject="Hello",
|
||||
body="Hi",
|
||||
created_by=self.user,
|
||||
)
|
||||
url = reverse("email_sms:campaign_detail", kwargs={"pk": campaign.pk})
|
||||
response = self.client.get(url)
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, "utm_campaign=spring-seller-tips")
|
||||
self.assertContains(response, "utm_medium=email")
|
||||
self.assertContains(response, "qrcode.min.js")
|
||||
self.assertContains(response, "data-utm-qr")
|
||||
|
||||
@override_settings(
|
||||
PUBLIC_SITE_URL="https://acmehvac.com",
|
||||
SITE_NAME="Acme HVAC",
|
||||
UTM_SOURCE="",
|
||||
SHORTENER_BASE_URL="https://shortener.aimloperations.com",
|
||||
SHORTENER_API_TOKEN="acme:test-token",
|
||||
)
|
||||
def test_shortener_mints_into_sms_body(self):
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
mock = MagicMock()
|
||||
mock.status_code = 201
|
||||
mock.json.return_value = {
|
||||
"code": "a3k9xm",
|
||||
"short_url": "https://piha.li/a3k9xm",
|
||||
"target_url": (
|
||||
"https://acmehvac.com/?utm_source=acme-hvac"
|
||||
"&utm_medium=sms&utm_campaign=open-house"
|
||||
),
|
||||
}
|
||||
with patch("core.shortener.requests.post", return_value=mock) as post:
|
||||
campaign = create_campaign_draft(
|
||||
name="Open house",
|
||||
audience=Campaign.Audience.SMS_OPT_IN,
|
||||
body="See you Saturday",
|
||||
created_by=self.user,
|
||||
)
|
||||
self.assertIn("https://piha.li/a3k9xm", campaign.body_override)
|
||||
self.assertIn("See you Saturday", campaign.body_override)
|
||||
self.assertNotIn("utm_medium=sms", campaign.body_override)
|
||||
post.assert_called_once()
|
||||
headers = post.call_args.kwargs["headers"]
|
||||
self.assertEqual(headers["Authorization"], "Bearer acme:test-token")
|
||||
payload = post.call_args.kwargs["json"]
|
||||
self.assertIn("utm_medium=sms", payload["target_url"])
|
||||
self.assertIn("utm_campaign=open-house", payload["target_url"])
|
||||
self.assertEqual(payload["external_ref"], str(campaign.pk))
|
||||
self.assertEqual(campaign.messages.get().body_snapshot, campaign.body_override)
|
||||
|
||||
@override_settings(
|
||||
PUBLIC_SITE_URL="https://acmehvac.com",
|
||||
SITE_NAME="Acme HVAC",
|
||||
UTM_SOURCE="",
|
||||
SHORTENER_BASE_URL="https://shortener.aimloperations.com",
|
||||
SHORTENER_API_TOKEN="acme:test-token",
|
||||
)
|
||||
def test_shortener_failure_falls_back_to_long_url(self):
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
mock = MagicMock()
|
||||
mock.status_code = 401
|
||||
mock.text = '{"detail":"Unauthorized"}'
|
||||
with patch("core.shortener.requests.post", return_value=mock):
|
||||
campaign = create_campaign_draft(
|
||||
name="Open house",
|
||||
audience=Campaign.Audience.SMS_OPT_IN,
|
||||
body="See you Saturday",
|
||||
created_by=self.user,
|
||||
)
|
||||
self.assertIn("utm_medium=sms", campaign.body_override)
|
||||
self.assertIn("utm_campaign=open-house", campaign.body_override)
|
||||
self.assertNotIn("piha.li", campaign.body_override)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user