[ENG-11769] Redo recipients page (#11821)

* Add recipients list and preview views for notification campaigns

Author: Ostap-Zherebetskyi

admin/notifications/urls.py

@@ -15,5 +15,6 @@
     re_path(r'notification_campaigns_detail/(?P<pk>\d+)/$', views.NotificationCampaignDetail.as_view(), name='notification_campaigns_detail'),
     re_path(r'notification_campaigns_create/$', views.NotificationCampaignCreateView.as_view(), name='notification_campaigns_create'),
     re_path(r'notification_campaigns_recipients_preview/$', views.NotificationCampaignsRecipientsPreview.as_view(), name='notification_campaigns_recipients_preview'),
+    re_path(r'notification_campaigns_recipients_list/$', views.NotificationCampaignsRecipientsView.as_view(), name='notification_campaigns_recipients_list'),
     re_path(r'notification_campaigns_start/(?P<pk>\d+)/$', views.StartNotificationCampaign.as_view(), name='notification_campaigns_start'),
 ]

admin/notifications/views.py

@@ -2,13 +2,13 @@
 import json
 from collections import defaultdict
 from django.urls import reverse_lazy
-from django.db.models import Q
+from django.db.models import Q, F
 from django.db import models
 from django.shortcuts import get_object_or_404, redirect
 from django.views.generic import ListView, DetailView, UpdateView, CreateView, View
 from django.contrib import messages
 from django.contrib.auth.mixins import PermissionRequiredMixin
-from osf.models import NotificationSubscription, NotificationType, Notification, EmailTask, NotificationCampaign, OSFUser
+from osf.models import NotificationSubscription, NotificationType, Notification, EmailTask, NotificationCampaign, OSFUser, NotificationCampaignRecipient
 from osf.models.notification_campaign import NotificationCampaignStatus
 from django.forms.models import model_to_dict
 from .forms import NotificationTypeForm, NotificationCampaignCreateForm
@@ -549,7 +549,7 @@ def get_context_data(self, **kwargs):
 
 
 class NotificationCampaignsRecipientsPreview(PermissionRequiredMixin, ListView):
-    template_name = 'users/list.html'
+    template_name = 'notifications/notification_campaing_recipients_preview.html'
     permission_required = 'osf.view_osfuser'
     raise_exception = True
     paginate_by = 25
@@ -568,7 +568,10 @@ def get_queryset(self):
                     else:
                         filters[f'{item["field"]}__{item["lookup"]}'] = [value.strip() for value in item['value'].split(',')]
 
-        return filter_users(filters)
+        qs = filter_users(filters)
+        return qs.annotate(
+            guid=F('guids___id')
+        )
 
     def get_context_data(self, **kwargs):
         users = self.get_queryset()
@@ -588,6 +591,45 @@ def get_context_data(self, **kwargs):
             is_paginated=is_paginated,
         )
 
+class NotificationCampaignsRecipientsView(PermissionRequiredMixin, ListView):
+    template_name = 'notifications/notification_campaing_recipients_list.html'
+    permission_required = 'osf.view_osfuser'
+    raise_exception = True
+    paginate_by = 25
+
+    def get_queryset(self):
+        status = self.request.GET.get('notification_status', None)
+        campaign_id = self.request.GET.get('campaign_id', None)
+        if not campaign_id:
+            return NotificationCampaignRecipient.objects.none()
+        query = {'campaign_id': campaign_id}
+        if status:
+            query['status'] = status
+
+        qs = NotificationCampaignRecipient.objects.filter(**query)
+
+        return qs.annotate(
+            guid=F('user__guids___id')
+        )
+
+    def get_context_data(self, **kwargs):
+        users = self.get_queryset()
+
+        page_size = self.get_paginate_by(users)
+        paginator, page, query_set, is_paginated = self.paginate_queryset(
+            users,
+            page_size,
+        )
+        # append search param to pagination links
+        kwargs.update({'extra_query_params': f'&notification_status={self.request.GET.get("notification_status")}&campaign_id={self.request.GET.get('campaign_id')}'})
+        return super().get_context_data(
+            **kwargs,
+            page=page,
+            query_set=query_set,
+            paginator=paginator,
+            is_paginated=is_paginated,
+        )
+
 class StartNotificationCampaign(PermissionRequiredMixin, View):
     permission_required = 'osf.change_notificationtype'
 

admin/templates/notifications/notification_campaigns_detail.html

@@ -57,7 +57,7 @@ <h4>General</h4>
                     {% if field == 'Sent' and value != 0 %}
                         <td>
                             <a
-                                href="{% url 'notifications:notification_campaigns_recipients_preview' %}?filters={{ sent_filters_json|urlencode }}"
+                                href="{% url 'notifications:notification_campaigns_recipients_list' %}?notification_status=sent&campaign_id={{ notification_campaign.id }}"
                                 class="btn btn-default"
                                 target="_blank">
                                 Preview Recipients
@@ -67,7 +67,7 @@ <h4>General</h4>
                     {% elif field == 'Failed' and value != 0 %}
                         <td>
                             <a
-                                href="{% url 'notifications:notification_campaigns_recipients_preview' %}?filters={{ failed_filters_json|urlencode }}"
+                                href="{% url 'notifications:notification_campaigns_recipients_list' %}?notification_status=failed&campaign_id={{ notification_campaign.id }}"
                                 class="btn btn-default"
                                 target="_blank">
                                 Preview Recipients

admin/templates/notifications/notification_campaing_recipients_list.html

@@ -0,0 +1,52 @@
+{% extends 'base.html' %}
+{% load static %}
+{% block title %}
+<title>User Search Results</title>
+{% endblock title %}
+{% block content %}
+  {% load node_extras %}
+    {% include "util/pagination.html" with items=page status=status %}
+    {% if perms.osf.mark_spam %}
+        <form action="{% url 'users:flagged-spam' %}" method="post">
+            {% csrf_token %}
+    {% endif %}
+    <table class="table table-striped table-hover table-responsive">
+        <thead>
+            <tr>
+                <th>GUID</th>
+                <th>Username</th>
+                <th>Status</th>
+                <th>Error</th>
+                <th>Updated at</th>
+            </tr>
+        </thead>
+        <tbody>
+            {% for record in query_set %}
+                <tr>
+                    <td>
+                        <a href="{{ record.user | reverse_user }}" class="btn btn-primary">
+                            {{ record.guid }}
+                        </a>
+                    </td>
+                    <td>
+                        {{record.user.username}}
+                    </td>
+                    <td>
+                        {{ record.status }}
+                    </td>
+                    <td>
+                        {{ record.error_message }}
+                    </td>
+                    <td>
+                        {{ record.updated_at }}
+                    </td>
+                </tr>
+            {% endfor %}
+        </tbody>
+    </table>
+    </form>
+
+    {% if not query_set|length %}
+     <h3>No results found</h3>
+    {% endif %}
+{% endblock content %}

admin/templates/notifications/notification_campaing_recipients_preview.html

@@ -0,0 +1,52 @@
+{% extends 'base.html' %}
+{% load static %}
+{% block title %}
+<title>User Search Results</title>
+{% endblock title %}
+{% block content %}
+  {% load node_extras %}
+    {% include "util/pagination.html" with items=page status=status %}
+    {% if perms.osf.mark_spam %}
+        <form action="{% url 'users:flagged-spam' %}" method="post">
+            {% csrf_token %}
+    {% endif %}
+    <table class="table table-striped table-hover table-responsive">
+        <thead>
+            <tr>
+                <th>GUID</th>
+                <th>Username</th>
+                <th>Fullname</th>
+                <th>Date confirmed</th>
+                <th>Date disabled</th>
+            </tr>
+        </thead>
+        <tbody>
+            {% for user in users %}
+                <tr>
+                    <td>
+                        <a href="{{ user | reverse_user }}" class="btn btn-primary">
+                            {{ user.guid }}
+                        </a>
+                    </td>
+                    <td>
+                        {{user.username}}
+                    </td>
+                    <td>
+                        {{ user.fullname }}
+                    </td>
+                    <td>
+                        {{ user.is_confirmed }}
+                    </td>
+                    <td>
+                        {{ user.is_disabled }}
+                    </td>
+                </tr>
+            {% endfor %}
+        </tbody>
+    </table>
+    </form>
+
+    {% if not users|length %}
+     <h3>No results found</h3>
+    {% endif %}
+{% endblock content %}