[ENG-12144] Project PR for post-ENTER

admin/notifications/forms.py

@@ -48,6 +48,21 @@ class NotificationCampaignCreateForm(forms.ModelForm):
     sendgrid_bulk = forms.BooleanField(
         required=False,
         initial=False,
+        help_text=(
+            'SendGrid caps personalizations at about 1000 per request - keep Batch Size ≤ 1000 for bulk requests'
+        ),
+    )
+
+    max_queued_batches = forms.IntegerField(
+        min_value=1,
+        initial=settings.MAX_QUEUED_CAMPAIGN_BATCHES,
+        help_text='Maximum number of queued campaign batches allowed before new batches are rejected.',
+    )
+
+    dispatch_interval = forms.IntegerField(
+        min_value=1,
+        initial=settings.CAMPAIGN_DISPATCH_INTERVAL,
+        help_text='The time in seconds between dispatches of campaign batches.',
     )
 
     class Meta:

admin/notifications/urls.py

@@ -17,4 +17,6 @@
     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'),
+    re_path(r'notification_campaigns_create_recipients/(?P<pk>\d+)/$', views.CreateNotificationCampaignRecipients.as_view(), name='notification_campaigns_create_recipients'),
+    re_path(r'notification_campaigns_delete/(?P<pk>\d+)/$', views.DeleteNotificationCampaign.as_view(), name='notification_campaigns_delete'),
 ]

admin/notifications/views.py

@@ -19,7 +19,7 @@
 from mako.parsetree import ControlLine
 from string import Formatter
 from osf.email import _render_email_html
-from osf.email.notification_campaign import FILTER_PRESETS, counter_subquery, build_query
+from osf.email.notification_campaign import FILTER_PRESETS, counter_subquery, build_campaign_filter_query
 from website import settings
 from urllib.parse import urlencode
 
@@ -431,6 +431,8 @@ def get_context_data(self, *args, **kwargs):
                 if k not in {'filters', 'context', 'execution', 'template'}
             },
             'allow_restart_stuck': True if timezone.now() - notification_campaign.updated_at > timedelta(minutes=15) else False,
+            'delete_allowed': notification_campaign.status != NotificationCampaignStatus.RUNNING,
+            'start_allowed': notification_campaign.status == NotificationCampaignStatus.CREATED and metadata.get('recipients_creation_finished', False),
         }
 
         if notification_campaign.status != NotificationCampaignStatus.CREATED:
@@ -581,8 +583,11 @@ def form_valid(self, form):
                 'max_retries': form.cleaned_data['max_retries'],
                 'activity_threshold': form.cleaned_data['activity_threshold'],
                 'time_window': form.cleaned_data['time_window'],
+                'max_queued_batches': form.cleaned_data['max_queued_batches'],
+                'dispatch_interval': form.cleaned_data['dispatch_interval'],
             },
             'sendgrid_bulk': form.cleaned_data.get('sendgrid_bulk', False),
+            'recipients_creation_finished': False,
         }
         try:
             _render_email_html(form.instance.notification_type, form.cleaned_data['context'])
@@ -641,10 +646,7 @@ def get_queryset(self):
         raw_filters = self.request.GET.get('filters', None)
         if raw_filters:
             json_filters = json.loads(raw_filters)
-            if predefined := json_filters.get('predefined'):
-                query = Q(**FILTER_PRESETS.get(predefined, {}))
-            else:
-                query = build_query(json_filters.get('manual'))
+            query = build_campaign_filter_query(json_filters)
 
         qs = OSFUser.objects.filter(query)
         qs = qs.annotate(
@@ -748,3 +750,41 @@ def post(self, request, *args, **kwargs):
             'notifications:notification_campaigns_detail',
             pk=notification_campaign.pk,
         )
+
+class CreateNotificationCampaignRecipients(PermissionRequiredMixin, View):
+    permission_required = 'osf.change_notificationcampaign'
+
+    def post(self, request, *args, **kwargs):
+        notification_campaign = get_object_or_404(
+            NotificationCampaign,
+            pk=kwargs['pk'],
+        )
+
+        if notification_campaign.status != NotificationCampaignStatus.CREATED:
+            messages.error(request, 'Recipients can only be created for campaigns in CREATED status.')
+            return redirect(
+                'notifications:notification_campaigns_detail',
+                pk=notification_campaign.pk,
+            )
+
+        notification_campaign.create_recipients()
+
+        return redirect(
+            'notifications:notification_campaigns_detail',
+            pk=notification_campaign.pk,
+        )
+
+class DeleteNotificationCampaign(PermissionRequiredMixin, View):
+    permission_required = 'osf.delete_notificationcampaign'
+
+    def post(self, request, *args, **kwargs):
+        notification_campaign = get_object_or_404(
+            NotificationCampaign,
+            pk=kwargs['pk'],
+        )
+        if notification_campaign.status == NotificationCampaignStatus.RUNNING:
+            messages.error(request, 'Cannot delete a running campaign.')
+            return redirect('notifications:notification_campaigns_detail', pk=notification_campaign.pk)
+        notification_campaign.delete()
+        messages.success(request, f'Notification campaign {notification_campaign.name} deleted successfully.')
+        return redirect('notifications:notification_campaigns_list')

admin/templates/notifications/notification_campaigns_detail.html

@@ -158,7 +158,7 @@ <h4>Progress</h4>
 {% if notification_campaign.developer_reminder_sent %}
 <div class="alert alert-warning">
     <strong>Warning!</strong>
-    The campaign exceeded the expected timeframe ({{ metadata.execution.time_window }}s). A reminder was sent.
+    The high-activity phase exceeded the expected timeframe ({{ metadata.execution.time_window }}s). A reminder was sent.
 </div>
 {% endif %}
     {% endif %}
@@ -169,10 +169,21 @@ <h4>Progress</h4>
         style="display:inline;"
     >
         {% csrf_token %}
-        <button type="submit" class="btn btn-primary" {% if notification_campaign.status != "created" %}disabled{% endif %}>
+        <button type="submit" class="btn btn-primary" {% if not start_allowed %}disabled{% endif %}>
             Start Campaign
         </button>
     </form>
+    <form
+        id="create-campaign-recipients-form"
+        method="post"
+        action="{% url 'notifications:notification_campaigns_create_recipients' notification_campaign.id %}"
+        style="display:inline;"
+    >
+        {% csrf_token %}
+        <button type="submit" class="btn btn-primary" {% if notification_campaign.status != "created" %}disabled{% endif %}>
+            Create Campaign Recipients
+        </button>
+    </form>
     <form
         id="restart-stuck-campaign-form"
         method="post"
@@ -197,6 +208,18 @@ <h4>Progress</h4>
             Cancel Campaign
         </button>
     </form>
+    <form
+        id="delete-campaign-form"
+        method="post"
+        action="{% url 'notifications:notification_campaigns_delete' notification_campaign.id %}"
+        style="display:inline;"
+    >
+        {% csrf_token %}
+        <button type="submit" class="btn btn-primary" {% if not delete_allowed %}disabled{% endif %}
+        title="Delete the campaign and all associated data.">
+            Delete Campaign
+        </button>
+    </form>
 
     <!-- General information -->
     <div class="row">
@@ -267,25 +290,19 @@ <h4>General</h4>
         <div class="col-md-12">
             <h4>Recipient Filters</h4>
 
-            {% if not "predefined" in metadata.filters  %}
-
-                {% if not "predefined" in metadata.filters %}
-                    {% if metadata.filters.manual %}
-                        {% include "notifications/campaign_filter_group.html" with group=metadata.filters.manual is_root=True %}
-                    {% else %}
-                        <p class="text-muted">No filters configured.</p>
-                    {% endif %}
-                {% endif %}
-
-            {% elif "predefined" in metadata.filters %}
-
+            {% if "predefined" in metadata.filters %}
                 <table class="table table-bordered">
                     <tr>
                         <th style="width:250px;">Predefined Filter</th>
                         <td>{{ metadata.filters.predefined }}</td>
                     </tr>
                 </table>
+            {% endif %}
 
+            {% if metadata.filters.manual %}
+                {% include "notifications/campaign_filter_group.html" with group=metadata.filters.manual is_root=True %}
+            {% elif not "predefined" in metadata.filters %}
+                <p class="text-muted">No filters configured.</p>
             {% endif %}
 
             <a
@@ -451,5 +468,13 @@ <h4>Additional Metadata</h4>
         });
     }
 
+    const deleteForm = document.getElementById("delete-campaign-form");
+
+    if (deleteForm) {
+        deleteForm.addEventListener("submit", function (e) {
+            confirmCampaign(this, e);
+        });
+    }
+
 </script>
 {% endblock %}

admin/templates/notifications/notification_campaigns_list.html

@@ -5,6 +5,16 @@
     <title>List of Notification Campaigns</title>
 {% endblock title %}
 {% block content %}
+    <div>
+        {% if messages %}
+            <ul>
+            {% for message in messages %}
+            <li{% if message.tags %} class="{{ message.tags }}"{% endif %}>{{ message }}
+            </li>
+            {% endfor %}
+        </ul>
+        {% endif %}
+    </div>
     <h2>List of Notification Campaigns</h2>
     {% if active_campaign %}
         <h3>Active Campaign</h3>

admin/templates/notifications/notification_campaing_create.html

@@ -163,6 +163,20 @@ <h4>Recipient Filters</h4>
                     </select>
                 </div>
 
+                <div class="form-group" style="margin-top:15px;">
+                    <label>
+                        <input
+                            type="checkbox"
+                            id="exclude-unconfirmed"
+                        >
+                        Exclude unconfirmed accounts
+                    </label>
+                    <p class="help-block">
+                        When enabled, users who have not confirmed their accounts
+                        are excluded from the recipient list.
+                    </p>
+                </div>
+
                 <input
                     type="hidden"
                     id="filters-input"
@@ -264,6 +278,34 @@ <h4>Execution</h4>
                                 name="sendgrid_bulk"
                                 value="{{ form.sendgrid_bulk.initial }}"
                             >
+                            <p class="help-block">
+                                {{ form.sendgrid_bulk.help_text }}
+                            </p>
+                        </td>
+                    </tr>
+                    <tr>
+                        <th>Max Queued Batches</th>
+                        <td>
+                            <input
+                                class="form-control"
+                                type="text"
+                                name="max_queued_batches"
+                                value="{{ form.max_queued_batches.initial }}"
+                            >
+                        </td>
+                    </tr>
+                    <tr>
+                        <th>Dispatch Interval</th>
+                        <td>
+                            <input
+                                class="form-control"
+                                type="text"
+                                name="dispatch_interval"
+                                value="{{ form.dispatch_interval.initial }}"
+                            >
+                            <p class="help-block">
+                                {{ form.dispatch_interval.help_text }}
+                            </p>
                         </td>
                     </tr>
                 </table>
@@ -406,15 +448,37 @@ <h4>Execution</h4>
 }
 
 function buildFilters() {
+    let filters;
 
     if (filterMode.value === "predefined") {
-        return {
+        filters = {
             "predefined": document.getElementById("filter-row").value
         };
+    } else {
+        const root = builder.querySelector(":scope > .group");
+        filters = {"manual": serializeGroup(root)};
+    }
+
+    if (document.getElementById("exclude-unconfirmed").checked) {
+        const confirmed = {
+            field: "date_confirmed",
+            lookup: "isnull",
+            value: false,
+        };
+        if (filters.manual) {
+            filters.manual = {
+                operator: "AND",
+                children: [filters.manual, confirmed],
+            };
+        } else {
+            filters.manual = {
+                operator: "AND",
+                children: [confirmed],
+            };
+        }
     }
 
-    const root = builder.querySelector(":scope > .group");
-    return {"manual": serializeGroup(root)}
+    return filters;
 }
 
 function updateFiltersInput() {

admin_tests/notifications/test_campaigns.py

@@ -16,6 +16,7 @@
     NotificationCampaignDetail,
     NotificationCampaignsList,
     StartNotificationCampaign,
+    DeleteNotificationCampaign,
 )
 from admin_tests.utilities import setup_form_view
 from osf.models import NotificationType
@@ -60,6 +61,8 @@ def _valid_form_data(notification_type, **overrides):
         'activity_threshold': settings.DEFAULT_CAMPAIGN_ACTIVITY_THRESHOLD,
         'sendgrid_bulk': False,
         'time_window': 8 * 60 * 60,
+        'max_queued_batches': settings.MAX_QUEUED_CAMPAIGN_BATCHES,
+        'dispatch_interval': settings.CAMPAIGN_DISPATCH_INTERVAL,
     }
     data.update(overrides)
     return data
@@ -260,7 +263,9 @@ def test_form_valid_persists_execution_metadata(self):
                 max_retries=4,
                 activity_threshold=77,
                 sendgrid_bulk=True,
-                time_window=28800
+                time_window=28800,
+                max_queued_batches=10,
+                dispatch_interval=60,
             ),
         )
         request.user = self.user
@@ -282,7 +287,9 @@ def test_form_valid_persists_execution_metadata(self):
             'batch_size': 25,
             'max_retries': 4,
             'activity_threshold': 77,
-            'time_window': 28800
+            'time_window': 28800,
+            'max_queued_batches': 10,
+            'dispatch_interval': 60,
         }
         assert campaign.metadata['sendgrid_bulk'] is True
         assert campaign.metadata['filters'] == {'predefined': 'active'}
@@ -419,3 +426,33 @@ def test_start_rejects_when_another_campaign_is_running(self):
         mock_start.assert_not_called()
         self.campaign.refresh_from_db()
         assert self.campaign.status == NotificationCampaignStatus.CREATED
+
+class TestNotificationCampaignDeleteView(AdminTestCase):
+
+    def setUp(self):
+        super().setUp()
+        self.user = AuthUserFactory()
+        self.notification_type, _ = NotificationType.objects.get_or_create(
+            name='blank',
+            defaults={'subject': 'Test', 'template': 'Hello'},
+        )
+        self.campaign = NotificationCampaign.objects.create(
+            name='Campaign',
+            notification_type=self.notification_type,
+            metadata={'filters': {}, 'context': {}, 'execution': {}},
+        )
+
+    def test_delete_requires_change_notificationcampaign_permission(self):
+        request = RequestFactory().post(
+            reverse('notifications:notification_campaigns_delete', kwargs={'pk': self.campaign.pk})
+        )
+        request.user = self.user
+        patch_messages(request)
+
+        with self.assertRaises(PermissionDenied):
+            DeleteNotificationCampaign.as_view()(request, pk=self.campaign.pk)
+
+        grant_permission(self.user, 'delete_notificationcampaign')
+        response = DeleteNotificationCampaign.as_view()(request, pk=self.campaign.pk)
+        assert response.status_code == 302
+        assert not NotificationCampaign.objects.filter(pk=self.campaign.pk).exists()