kobotoolbox / kpi / 35242188777

83%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

fix(massemails): fix edge cases for one-off mass email campaigns DEV-2737 (#7555)

### 📣 Summary
Fixes edge cases where one-off mass email campaigns (`frequency = -1`)
could be accidentally resent if remaining enqueued records transitioned
to STALE or if the Celery worker process terminated before the campaign
was finalized

### 📖 Description
* `get_users_for_config()` now excludes users who already have a
terminal status (SENT, FAILED, STALE) under that one-off config
* Any one-off campaign that has already run and has 0 enqueued records
is disabled immediately, even if all remaining records went STALE.
`send_emails()` now filters on `jobs__isnull=False` instead of
`pk__in=sender.config_ids`.
* If an unclosed one-off config has records and no eligible recipients
remaining, `generate_mass_email_user_lists()` marks `live = False`
directly without creating an empty `MassEmailJob` re-enqueueing records
* Included new unit tests to validate that the edge cases are handled
correctly

### 👀 Preview steps
1. ℹ️ have two user accounts (one of them should be inactive)
2. Create a mass email config with `frequency = -1`, `query =
'test_users'` and `live = True`
```
from django.core.cache import cache
from kobo.apps.mass_emails.tasks import generate_mass_email_user_lists, send_emails
from datetime import timedelta
from django.utils import timezone

cache.clear()

# First call to send_emails to 
send_emails()

config = MassEmailConfig.objects.get(id=<id>)
# It has to be 1 day old to be processed
config.date_created = timezone.now() - timedelta(days=1)
config.save()

generate_mass_email_user_lists()

# 🟢 [on PR] Config is turned off immediately
# The inactive account should have status = STALE
assert not config.live
assert MassEmailRecord.objects.get(user__username='<inactive username>').status == EmailStatus.STALE


send_emails()
```
3. Wait for the next 15-minute window and clear cache to simulate next
run and verify that no new records are created:
```
# Make c... (continued)

Coverage Stats

10185 of 13517 branches covered (75.35%)

0 of 23 new or added lines in 1 file covered. (0.0%)

2180 existing lines in 87 files now uncovered.

32587 of 39337 relevant lines covered (82.84%)

5.51 hits per line