feat: Include an absolute link to notification.url in the default emails

Author: kevinrenskers

README.md

@@ -38,6 +38,31 @@ Run migrations:
 uv run ./manage.py migrate generic_notifications
 ```
 
+## Settings
+
+### `NOTIFICATION_BASE_URL`
+
+Configure the base URL for generating absolute URLs in email notifications:
+
+```python
+# With protocol (recommended)
+NOTIFICATION_BASE_URL = "https://www.example.com"
+NOTIFICATION_BASE_URL = "http://localhost:8000"
+
+# Without protocol (auto-detects based on DEBUG setting)
+NOTIFICATION_BASE_URL = "www.example.com"
+```
+
+**Protocol handling**: If you omit the protocol, it's automatically added:
+- `https://` in production (`DEBUG = False`)  
+- `http://` in development (`DEBUG = True`)
+
+**Fallback order** if `NOTIFICATION_BASE_URL` is not set:
+1. `BASE_URL` setting  
+2. `SITE_URL` setting
+3. Django Sites framework (if `django.contrib.sites` is installed)
+4. URLs remain relative if no base URL is found (not ideal in emails!)
+
 ## Quick Start
 
 ### 1. Define a notification type

example/config/settings.py

@@ -27,6 +27,10 @@
 
 ALLOWED_HOSTS = ["*"]
 
+# Base URL for generating absolute URLs in notifications
+# In production, set this to your domain: NOTIFICATION_BASE_URL = "https://yourdomain.com"
+NOTIFICATION_BASE_URL = "http://localhost:8000"
+
 
 # Application definition
 

generic_notifications/channels.py

@@ -135,8 +135,11 @@ def send_email_now(self, notification: "Notification") -> None:
             try:
                 text_message = render_to_string(text_template, context)
             except Exception:
-                # Fallback to notification's text
+                # Fallback to notification's text with URL if available
                 text_message = notification.get_text()
+                absolute_url = notification.get_absolute_url()
+                if absolute_url:
+                    text_message += f"\n{absolute_url}"
 
             send_mail(
                 subject=subject,
@@ -216,6 +219,9 @@ def send_digest_emails(
                 message_lines = [f"You have {notifications_count} new notification{pluralize(notifications_count)}:\n"]
                 for notification in notifications[:10]:  # Limit to first 10
                     message_lines.append(f"- {notification.get_text()}")
+                    absolute_url = notification.get_absolute_url()
+                    if absolute_url:
+                        message_lines.append(f"  {absolute_url}")
                 if notifications_count > 10:
                     message_lines.append(f"... and {notifications_count - 10} more")
                 text_message = "\n".join(message_lines)

generic_notifications/models.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
@@ -226,3 +227,48 @@ def get_text(self) -> str:
     @property
     def is_read(self) -> bool:
         return self.read is not None
+
+    def get_absolute_url(self) -> str:
+        """
+        Get the absolute URL for this notification.
+        If the URL is already absolute (starts with http:// or https://), return as-is.
+        Otherwise, prepend the base URL from settings if available.
+        """
+        if not self.url:
+            return ""
+
+        # If already absolute, return as-is
+        if self.url.startswith(("http://", "https://")):
+            return self.url
+
+        # Get base URL from settings, with fallback
+        base_url = getattr(settings, "NOTIFICATION_BASE_URL", "")
+
+        if not base_url:
+            # Try common alternatives
+            base_url = getattr(settings, "BASE_URL", "")
+            if not base_url:
+                base_url = getattr(settings, "SITE_URL", "")
+
+        if not base_url and "django.contrib.sites" in settings.INSTALLED_APPS:
+            # Try the Sites framework
+            from django.contrib.sites.models import Site
+
+            try:
+                base_url = Site.objects.get_current().domain
+            except Site.DoesNotExist:
+                pass
+
+        if base_url:
+            # Add protocol if missing
+            if not base_url.startswith(("http://", "https://")):
+                protocol = "http" if settings.DEBUG else "https"
+                base_url = f"{protocol}://{base_url}"
+
+            # Ensure base URL doesn't end with slash and relative URL doesn't start with slash
+            base_url = base_url.rstrip("/")
+            relative_url = self.url.lstrip("/")
+            return f"{base_url}/{relative_url}"
+
+        # No base URL configured, return relative URL
+        return self.url

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-generic-notifications"
-version = "1.2.1"
+version = "1.3.0"
 description = "A flexible, multi-channel notification system for Django applications with built-in support for email digests, user preferences, and extensible delivery channels."
 authors = [
     {name = "Kevin Renskers", email = "kevin@loopwerk.io"},

tests/test_channels.py

@@ -269,7 +269,7 @@ def test_send_digest_emails_basic(self):
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
         self.assertEqual(email.to, [self.user.email])
-        self.assertIn("3 new notifications", email.subject)
+        self.assertEqual(email.subject, "Digest - 3 new notifications")
 
         # Check all notifications marked as sent
         for notification in notifications:
@@ -288,7 +288,7 @@ def test_send_digest_emails_with_frequency(self):
         )
 
         email = mail.outbox[0]
-        self.assertIn("1 new notification", email.subject)
+        self.assertEqual(email.subject, "Digest - 1 new notification")
 
     @override_settings(DEFAULT_FROM_EMAIL="test@example.com")
     def test_send_digest_emails_without_frequency(self):
@@ -302,7 +302,7 @@ def test_send_digest_emails_without_frequency(self):
         )
 
         email = mail.outbox[0]
-        self.assertIn("Digest - 1 new notification", email.subject)
+        self.assertEqual(email.subject, "Digest - 1 new notification")
 
     @override_settings(DEFAULT_FROM_EMAIL="test@example.com")
     def test_send_digest_emails_text_limit(self):
@@ -322,7 +322,7 @@ def test_send_digest_emails_text_limit(self):
         # The implementation may not have this feature, so we'll just check that email was sent
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
-        self.assertIn("15 new notifications", email.subject)
+        self.assertEqual(email.subject, "Digest - 15 new notifications")
 
     @override_settings(DEFAULT_FROM_EMAIL="test@example.com")
     @patch("generic_notifications.channels.render_to_string")
@@ -354,3 +354,59 @@ def test_send_digest_emails_with_html_template(self, mock_render):
         self.assertEqual(text_call[0][0], "notifications/email/digest/message.txt")
         self.assertEqual(html_call[0][1]["user"], self.user)
         self.assertEqual(html_call[0][1]["count"], 1)
+
+    def test_send_email_now_fallback_includes_url(self):
+        """Test that fallback email content includes URL when available"""
+        notification = Notification.objects.create(
+            recipient=self.user,
+            notification_type=TestNotificationType.key,
+            channels=["email"],
+            subject="Test Subject",
+            text="Test notification text",
+            url="https://example.com/test/url/123",
+        )
+
+        EmailChannel().send_email_now(notification)
+
+        # Check that one email was sent
+        self.assertEqual(len(mail.outbox), 1)
+        sent_email = mail.outbox[0]
+
+        # Check the exact email body content
+        expected_body = "Test notification text\nhttps://example.com/test/url/123"
+        self.assertEqual(sent_email.body, expected_body)
+
+    def test_send_digest_emails_fallback_includes_urls(self):
+        """Test that digest fallback email content includes URLs when available"""
+        # Create notifications with URLs
+        Notification.objects.create(
+            recipient=self.user,
+            notification_type=TestNotificationType.key,
+            channels=["email"],
+            text="First notification",
+            url="https://example.com/url/1",
+        )
+        Notification.objects.create(
+            recipient=self.user,
+            notification_type=TestNotificationType.key,
+            channels=["email"],
+            text="Second notification",
+            url="https://example.com/url/2",
+        )
+
+        EmailChannel.send_digest_emails(
+            self.user, Notification.objects.filter(recipient=self.user, email_sent_at__isnull=True)
+        )
+
+        # Check that one email was sent
+        self.assertEqual(len(mail.outbox), 1)
+        sent_email = mail.outbox[0]
+
+        # Check the exact digest email body content
+        expected_body = """You have 2 new notifications:
+
+- Second notification
+  https://example.com/url/2
+- First notification
+  https://example.com/url/1"""
+        self.assertEqual(sent_email.body, expected_body)

tests/test_management_commands.py

@@ -98,8 +98,8 @@ def test_send_digest_emails_basic_flow(self):
 
         # Check email details
         self.assertEqual(email.to, [self.user1.email])
-        self.assertIn("1 new notification", email.subject)
-        self.assertIn("This is a test notification", email.body)
+        self.assertEqual(email.subject, "Daily digest - 1 new notification")
+        self.assertEqual(email.body, "You have 1 new notification:\n\n- This is a test notification")
 
         # Verify notification was marked as sent
         notification.refresh_from_db()
@@ -150,8 +150,7 @@ def test_only_includes_unread_notifications(self):
         # Should send one email with only unread notification
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
-        self.assertIn("Unread notification text", email.body)
-        self.assertNotIn("Read notification text", email.body)
+        self.assertEqual(email.body, "You have 1 new notification:\n\n- Unread notification text")
 
         # Only unread notification should be marked as sent
         read_notification.refresh_from_db()
@@ -184,8 +183,7 @@ def test_only_includes_unsent_notifications(self):
         # Should send one email with only unsent notification
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
-        self.assertIn("Unsent notification text", email.body)
-        self.assertNotIn("Sent notification text", email.body)
+        self.assertEqual(email.body, "You have 1 new notification:\n\n- Unsent notification text")
 
         # Unsent notification should now be marked as sent
         unsent_notification.refresh_from_db()
@@ -220,9 +218,10 @@ def test_sends_all_unsent_notifications(self):
         # Should send one email with both notifications (no time window filtering)
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
-        self.assertIn("Recent notification text", email.body)
-        self.assertIn("Old notification text", email.body)
-        self.assertIn("2 new notifications", email.subject)
+        self.assertEqual(email.subject, "Daily digest - 2 new notifications")
+        self.assertEqual(
+            email.body, "You have 2 new notifications:\n\n- Recent notification text\n- Old notification text"
+        )
 
         # Both notifications should be marked as sent
         old_notification.refresh_from_db()
@@ -258,7 +257,7 @@ def test_specific_frequency_filter(self):
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
         self.assertEqual(email.to, [self.user1.email])
-        self.assertIn("Daily user notification text", email.body)
+        self.assertEqual(email.body, "You have 1 new notification:\n\n- Daily user notification text")
 
         # Clear outbox and test weekly frequency
         mail.outbox.clear()
@@ -268,7 +267,7 @@ def test_specific_frequency_filter(self):
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
         self.assertEqual(email.to, [self.user2.email])
-        self.assertIn("Weekly user notification text", email.body)
+        self.assertEqual(email.body, "You have 1 new notification:\n\n- Weekly user notification text")
 
     def test_multiple_notification_types_for_user(self):
         # Set up user with multiple notification types for daily frequency
@@ -297,9 +296,10 @@ def test_multiple_notification_types_for_user(self):
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
         self.assertEqual(email.to, [self.user1.email])
-        self.assertIn("2 new notifications", email.subject)
-        self.assertIn("Test type notification text", email.body)
-        self.assertIn("Other type notification text", email.body)
+        self.assertEqual(email.subject, "Daily digest - 2 new notifications")
+        self.assertEqual(
+            email.body, "You have 2 new notifications:\n\n- Other type notification text\n- Test type notification text"
+        )
 
         # Both notifications should be marked as sent
         notification1.refresh_from_db()
@@ -357,8 +357,7 @@ def test_users_with_default_frequencies_get_digest(self):
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
         self.assertEqual(email.to, [self.user1.email])
-        self.assertIn("This is a test notification", email.body)
-        self.assertNotIn("This is another type of notification", email.body)
+        self.assertEqual(email.body, "You have 1 new notification:\n\n- This is a test notification")
 
         # Verify only test notification was marked as sent
         test_notification.refresh_from_db()
@@ -396,8 +395,7 @@ def test_mixed_explicit_and_default_preferences(self):
         call_command("send_digest_emails", "--frequency", "weekly")
         self.assertEqual(len(mail.outbox), 1)
         email = mail.outbox[0]
-        self.assertIn("Test notification text", email.body)
-        self.assertNotIn("Other notification text", email.body)
+        self.assertEqual(email.body, "You have 1 new notification:\n\n- Test notification text")
 
     def test_multiple_users_default_and_explicit_mix(self):
         """Test digest emails work correctly with multiple users having different preference configurations."""
@@ -423,13 +421,11 @@ def test_multiple_users_default_and_explicit_mix(self):
         self.assertEqual(len(mail.outbox), 2)
 
         recipients = {email.to[0] for email in mail.outbox}
-        self.assertIn(self.user1.email, recipients)
-        self.assertIn(self.user3.email, recipients)
-        self.assertNotIn(self.user2.email, recipients)
+        self.assertEqual(set(recipients), {self.user1.email, self.user3.email})
 
         # Clear outbox and run weekly digest - should get user2
         mail.outbox.clear()
         call_command("send_digest_emails", "--frequency", "weekly")
         self.assertEqual(len(mail.outbox), 1)
         self.assertEqual(mail.outbox[0].to[0], self.user2.email)
-        self.assertIn("Test notification for user 2 text", mail.outbox[0].body)
+        self.assertEqual(mail.outbox[0].body, "You have 1 new notification:\n\n- Test notification for user 2 text")