[change] Improved batch email template

- Improved formatting of date time
- Fixed semantics in HTML template

Author: pandafy

openwisp_notifications/tasks.py

@@ -265,19 +265,15 @@ def send_batched_email_notifications(instance_id):
 
             unsent_notifications.append(notification)
 
-        starting_time = (
-            cache_data.get('start_time')
-            .strftime('%B %-d, %Y, %-I:%M %p')
-            .lower()
-            .replace('am', 'a.m.')
-            .replace('pm', 'p.m.')
-        ) + ' UTC'
+        start_time = timezone.localtime(cache_data.get('start_time')).strftime(
+            '%B %-d, %Y, %-I:%M %p %Z'
+        )
 
         context = {
             'notifications': unsent_notifications[:display_limit],
             'notifications_count': notifications_count,
             'site_name': current_site.name,
-            'start_time': starting_time,
+            'start_time': start_time,
         }
 
         extra_context = {}
@@ -293,7 +289,7 @@ def send_batched_email_notifications(instance_id):
         notifications_count = min(notifications_count, display_limit)
 
         send_email(
-            subject=f'[{current_site.name}] {notifications_count} new notifications since {starting_time}',
+            subject=f'[{current_site.name}] {notifications_count} new notifications since {start_time}',
             body_text=plain_text_content,
             body_html=html_content,
             recipients=[email_id],

openwisp_notifications/templates/emails/batch_email.html

@@ -3,9 +3,11 @@
         .alert {
             border: 1px solid #e0e0e0;
             border-radius: 5px;
-            margin-bottom: 10px;
             padding: 10px;
         }
+        .alert + .alert {
+            margin-top: 10px;
+        }
         .alert.error {
             background-color: #ffefef;
         }
@@ -60,22 +62,30 @@
             background-color: #1c8828;
         }
         .badge.warning {
-            background-color: #f0ad4e;
+            background-color: #ec942c;
         }
         .alert a {
             text-decoration: none;
         }
-        .alert.error a, .alert.error h2 {
+        .alert.error a,
+        .alert.error h2,
+        .alert.error p {
             color: #d9534f;
         }
-        .alert.info a, .alert.info h2 {
+        .alert.info a,
+        .alert.info h2,
+        .alert.info p {
             color: #333333;
         }
-        .alert.success a, .alert.success h2 {
+        .alert.success a,
+        .alert.success h2,
+        .alert.success p {
             color: #1c8828;
         }
-        .alert.warning a, .alert.warning h2 {
-            color: #f0ad4e;
+        .alert.warning a,
+        .alert.warning h2,
+        .alert.warning p {
+            color: #ec942c;
         }
         .alert a:hover {
             text-decoration: underline;
@@ -91,13 +101,13 @@ <h2>
                     <span class="badge {{ notification.level }}">{{ notification.level|upper }}</span>
                     <span class="title">
                         {% if notification.url %}
-                            <a href="{{ notification.url }}" target="_blank">{{ notification.email_message }}</a>
+                            <a href="{{ notification.url }}" target="_blank"><p>{{ notification.email_message|striptags }}</p></a>
                         {% else %}
                             {{ notification.email_message }}
                         {% endif %}
                     </span>
                 </h2>
-                <p>{{ notification.timestamp|date:"F j, Y, g:i a" }}</p>
+                <p>{{ notification.timestamp|date:"F j, Y, g:i A e" }}</p>
                 {% if notification.rendered_description %}
                     <p>{{ notification.rendered_description|safe }}</p>
                 {% endif %}

openwisp_notifications/templates/emails/batch_email.txt

@@ -5,7 +5,7 @@
 {% for notification in notifications %}
 - {{ notification.email_message }}{% if notification.rendered_description %}
   {% translate "Description" %}: {{ notification.rendered_description }}{% endif %}
-  {% translate "Date & Time" %}: {{ notification.timestamp|date:"F j, Y, g:i a" }}{% if notification.url %}
+  {% translate "Date & Time" %}: {{ notification.timestamp|date:"F j, Y, g:i A e" }}{% if notification.url %}
   {% translate "URL" %}: {{ notification.url }}{% endif %}
 {% endfor %}
 

openwisp_notifications/tests/test_notifications.py

@@ -16,6 +16,7 @@
 from django.urls import reverse
 from django.utils import timezone
 from django.utils.timesince import timesince
+from freezegun import freeze_time
 
 from openwisp_notifications import settings as app_settings
 from openwisp_notifications import tasks
@@ -950,11 +951,15 @@ def test_notification_for_unverified_email(self):
         # we don't send emails to unverified email addresses
         self.assertEqual(len(mail.outbox), 0)
 
+    # @override_settings(TIME_ZONE='UTC')
     @patch('openwisp_notifications.tasks.send_batched_email_notifications.apply_async')
     def test_batch_email_notification(self, mock_send_email):
-        fixed_datetime = datetime(2024, 7, 26, 11, 40)
+        fixed_datetime = timezone.localtime(
+            datetime(2024, 7, 26, 11, 40, tzinfo=timezone.utc)
+        )
+        datetime_str = fixed_datetime.strftime('%B %-d, %Y, %-I:%M %p %Z')
 
-        with patch.object(timezone, 'now', return_value=fixed_datetime):
+        with freeze_time(fixed_datetime):
             for _ in range(5):
                 notify.send(recipient=self.admin, **self.notification_options)
 
@@ -967,31 +972,29 @@ def test_batch_email_notification(self, mock_send_email):
             # Check if the rest of the notifications are sent in a batch
             self.assertEqual(len(mail.outbox), 2)
 
-            expected_subject = (
-                '[example.com] 4 new notifications since july 26, 2024, 11:40 a.m. UTC'
-            )
-            expected_body = """
-[example.com] 4 new notifications since july 26, 2024, 11:40 a.m. UTC
+            expected_subject = f'[example.com] 4 new notifications since {datetime_str}'
+            expected_body = f"""
+[example.com] 4 new notifications since {datetime_str}
 
 
 - Test Notification
   Description: Test Notification
-  Date & Time: July 26, 2024, 11:40 a.m.
+  Date & Time: {datetime_str}
   URL: https://localhost:8000/admin
 
 - Test Notification
   Description: Test Notification
-  Date & Time: July 26, 2024, 11:40 a.m.
+  Date & Time: {datetime_str}
   URL: https://localhost:8000/admin
 
 - Test Notification
   Description: Test Notification
-  Date & Time: July 26, 2024, 11:40 a.m.
+  Date & Time: {datetime_str}
   URL: https://localhost:8000/admin
 
 - Test Notification
   Description: Test Notification
-  Date & Time: July 26, 2024, 11:40 a.m.
+  Date & Time: {datetime_str}
   URL: https://localhost:8000/admin
             """