[ENG-11881] Time window needs to be set in seconds (#11847)

* Change notification campaign time window to be in seconds

Author: antkryt

admin/notifications/forms.py

@@ -41,8 +41,8 @@ class NotificationCampaignCreateForm(forms.ModelForm):
 
     time_window = forms.IntegerField(
         min_value=1,
-        initial=8,
-        help_text='The time in hours before the developer reminder is sent.',
+        initial=8 * 60 * 60,  # 8 hours
+        help_text='The time in seconds before the developer reminder is sent.',
     )
 
     sendgrid_bulk = forms.BooleanField(

admin/templates/notifications/notification_campaigns_detail.html

@@ -158,7 +158,7 @@ <h4>Progress</h4>
 {% if notification_campaign.developer_reminder_sent and notification_campaign.status == "running" %}
 <div class="alert alert-warning">
     <strong>Warning!</strong>
-    The campaign exceeded the expected timeframe ({{ metadata.execution.time_window }}h). A reminder was sent.
+    The campaign exceeded the expected timeframe ({{ metadata.execution.time_window }}s). A reminder was sent.
 </div>
 {% endif %}
     {% endif %}

admin/templates/notifications/notification_campaing_create.html

@@ -226,7 +226,7 @@ <h4>Execution</h4>
                                 min="1"
                             >
                             <p class="help-block">
-                                The time in hours before the developer reminder is sent.
+                                The time in seconds before the developer reminder is sent.
                             </p>
                         </td>
                     </tr>

admin_tests/notifications/test_campaigns.py

@@ -59,7 +59,7 @@ def _valid_form_data(notification_type, **overrides):
         'max_retries': settings.DEFAULT_CAMPAIGN_MAX_RETRIES,
         'activity_threshold': settings.DEFAULT_CAMPAIGN_ACTIVITY_THRESHOLD,
         'sendgrid_bulk': False,
-        'time_window': 8,
+        'time_window': 8 * 60 * 60,
     }
     data.update(overrides)
     return data
@@ -75,15 +75,15 @@ def test_valid_form_parses_context_and_filters(self, notification_type):
         assert form.cleaned_data['batch_size'] == settings.DEFAULT_CAMPAIGN_BATCH_SIZE
         assert form.cleaned_data['max_retries'] == settings.DEFAULT_CAMPAIGN_MAX_RETRIES
         assert form.cleaned_data['activity_threshold'] == settings.DEFAULT_CAMPAIGN_ACTIVITY_THRESHOLD
-        assert form.cleaned_data['time_window'] == 8
+        assert form.cleaned_data['time_window'] == 8 * 60 * 60
         assert form.cleaned_data['sendgrid_bulk'] is False
 
     def test_defaults_come_from_settings(self):
         form = NotificationCampaignCreateForm()
         assert form.fields['batch_size'].initial == settings.DEFAULT_CAMPAIGN_BATCH_SIZE
         assert form.fields['max_retries'].initial == settings.DEFAULT_CAMPAIGN_MAX_RETRIES
         assert form.fields['activity_threshold'].initial == settings.DEFAULT_CAMPAIGN_ACTIVITY_THRESHOLD
-        assert form.fields['time_window'].initial == 8
+        assert form.fields['time_window'].initial == 8 * 60 * 60
         assert form.fields['sendgrid_bulk'].initial is False
 
     def test_invalid_context_json(self, notification_type):
@@ -138,10 +138,10 @@ def test_time_window_must_be_at_least_one(self, notification_type):
 
     def test_time_window_is_accepted(self, notification_type):
         form = NotificationCampaignCreateForm(
-            data=_valid_form_data(notification_type, time_window=6)
+            data=_valid_form_data(notification_type, time_window=3600)
         )
         assert form.is_valid()
-        assert form.cleaned_data['time_window'] == 6
+        assert form.cleaned_data['time_window'] == 3600
 
     def test_name_is_required(self, notification_type):
         form = NotificationCampaignCreateForm(
@@ -191,7 +191,7 @@ def test_form_valid_persists_execution_metadata(self):
                 max_retries=4,
                 activity_threshold=77,
                 sendgrid_bulk=True,
-                time_window=8
+                time_window=28800
             ),
         )
         request.user = self.user
@@ -213,7 +213,7 @@ def test_form_valid_persists_execution_metadata(self):
             'batch_size': 25,
             'max_retries': 4,
             'activity_threshold': 77,
-            'time_window': 8
+            'time_window': 28800
         }
         assert campaign.metadata['sendgrid_bulk'] is True
         assert campaign.metadata['filters'] == {'predefined': 'active'}

osf/email/notification_campaign.py

@@ -321,10 +321,10 @@ def send_campaign_batch(context, recipients_ids, notification_type_name='blank',
                 campaign.save()
             return
 
-    execution_time_window = campaign.metadata.get('execution', {}).get('time_window', 8)
-    if campaign.started_at < timezone.now() - timedelta(hours=execution_time_window):
+    execution_time_window = campaign.metadata.get('execution', {}).get('time_window', 8 * 60 * 60)
+    if campaign.started_at < timezone.now() - timedelta(seconds=execution_time_window):
         if not campaign.developer_reminder_sent:
-            message = f'[Notification Campaign] Campaign {campaign_id} exceeded its execution time window ({execution_time_window}h).'
+            message = f'[Notification Campaign] Campaign {campaign_id} exceeded its execution time window ({execution_time_window}s).'
             logger.warning(message)
             sentry.log_message(message)
             campaign.developer_reminder_sent = True

osf_tests/test_notification_campaign.py

@@ -551,7 +551,7 @@ def test_send_campaign_batch_sendgrid_bulk_failure(self, mock_sentry, mock_sendg
     @mock.patch('osf.email.notification_campaign.sentry.log_message')
     def test_send_campaign_batch_logs_when_time_window_exceeded(self, mock_sentry, running_campaign):
         user = UserFactory()
-        running_campaign.started_at = timezone.now() - timedelta(hours=9)
+        running_campaign.started_at = timezone.now() - timedelta(seconds=9)
         running_campaign.metadata['execution']['time_window'] = 8
         running_campaign.save()
         create_campaign_recipients(Q(**{'id__in': [user.id]}), campaign_id=running_campaign.id)