kobotoolbox / kpi / 15618414823 / 1

81%

master: 76%

push

github

feat(massEmails): preview query results DEV-478 (#5841)


### 📣 Summary
Allow users to download a list of expected recipients of a mass email
based on the query used.


### 📖 Description
Creates ExportJobs for MassEmailConfigs that will have details about the
expected recipients for the emails. Once requested, the user will
receive an email when the job is done and be able to download the list
from Django admin.


### 💭 Notes
Uses the existing django-import-export-celery framework even though it's
more meant for exporting lists of models rather than this kind of
byproduct of a model. However, the framework is already there and allows
multiple formats as well as handling the email portion, and the tweaks
necessary to make it work for a list of users rather than a list of
configs are pretty slight (just doing some work in the `after_export`
hook).
If there are no recipients, the process will just return an empty csv
(only headers). This is not ideal, but there is not an easy way to tell
the user that no recipients were found using just the library. The job
status would be the most obvious place to put this kind of information,
but is part of the ExportJob object which we don't have access to in any
of the export methods. We could run the query first before creating the
export job and use the usual admin error alerts if the query returns
empty, but the query could take a long time and this would defeat the
purpose of doing all the work in the background.


### 👀 Preview steps
Run mailhog or file-backed email for easier testing.

1. ℹ️ have a superuser account and at least one other
2. In Django admin, update MASS_EMAIL_TEST_EMAILS in Constance with at
least 2 user emails
3. In Django admin, create a MassEmailConfig that uses the 'test_users'
query. Frequency/live doesn't matter here.
4. On the list of MassEmailConfigs, select your new configuration.
5. 🟢 There should be an "Export with celery" action
6. Trigger the export
7. You will be taken to a prefil... (continued)

6159 of 10001 branches covered (61.58%)

23340 of 29561 relevant lines covered (78.96%)

0.79 hits per line