refactor(grants): use send_conference_voucher_email; drop grant_voucher_code

- create_and_send_voucher_to_grantee queues send_conference_voucher_email with
  conference_voucher_id (lazy import avoids circular import with get_name).
- Remove send_grant_voucher_email; grantees get the shared voucher_code template
  like the Voucher admin action.
- send_conference_voucher_email always sends and updates voucher_email_sent_at
  (reminders and admin resends supported).
- Remove EmailTemplateIdentifier.grant_voucher_code; migration reassigns any
  rows to voucher_code then tightens choices.

Author: estyxx

backend/conferences/tasks.py

@@ -1,14 +1,11 @@
 from django.utils import timezone
 from notifications.models import EmailTemplate, EmailTemplateIdentifier
 from grants.tasks import get_name
-import logging
 from pycon.celery import app
 
-logger = logging.getLogger(__name__)
-
 
 @app.task
-def send_conference_voucher_email(conference_voucher_id):
+def send_conference_voucher_email(conference_voucher_id: int) -> None:
     from conferences.models import ConferenceVoucher
 
     conference_voucher = ConferenceVoucher.objects.get(id=conference_voucher_id)
@@ -31,4 +28,4 @@ def send_conference_voucher_email(conference_voucher_id):
     )
 
     conference_voucher.voucher_email_sent_at = timezone.now()
-    conference_voucher.save()
+    conference_voucher.save(update_fields=["voucher_email_sent_at"])

backend/conferences/tests/test_tasks.py

@@ -60,3 +60,26 @@ def test_send_conference_voucher_email(voucher_type, sent_emails):
     assert conference_voucher.voucher_email_sent_at == datetime(
         2020, 10, 10, 10, 0, 0, tzinfo=timezone.utc
     )
+
+
+def test_send_conference_voucher_email_sends_again_when_already_sent(sent_emails):
+    user = UserFactory(full_name="Remind Me")
+    conference_voucher = ConferenceVoucherFactory(
+        user=user,
+        voucher_type=ConferenceVoucher.VoucherType.SPEAKER,
+        voucher_code="REM123",
+        voucher_email_sent_at=datetime(2020, 1, 1, tzinfo=timezone.utc),
+    )
+    EmailTemplateFactory(
+        conference=conference_voucher.conference,
+        identifier=EmailTemplateIdentifier.voucher_code,
+    )
+
+    with time_machine.travel("2020-06-01 12:00:00Z", tick=False):
+        send_conference_voucher_email(conference_voucher_id=conference_voucher.id)
+
+    assert sent_emails().count() == 1
+    conference_voucher.refresh_from_db()
+    assert conference_voucher.voucher_email_sent_at == datetime(
+        2020, 6, 1, 12, 0, 0, tzinfo=timezone.utc
+    )

backend/grants/tasks.py

@@ -23,51 +23,10 @@ def get_name(user: User | None, fallback: str = "<no name specified>") -> str:
     return user.full_name or user.name or user.username or fallback
 
 
-@app.task
-def send_grant_voucher_email(*, grant_id: int) -> None:
-    grant = Grant.objects.select_related("conference", "user").get(pk=grant_id)
-    if not grant.user_id:
-        return
-
-    conference_voucher = (
-        ConferenceVoucher.objects.for_conference(grant.conference)
-        .for_user(grant.user)
-        .first()
-    )
-    if not conference_voucher:
-        return
-
-    if conference_voucher.voucher_email_sent_at is not None:
-        logger.info(
-            "Grant voucher email already sent for user %s conference %s, skipping",
-            grant.user_id,
-            grant.conference_id,
-        )
-        return
-
-    visa_page_link = urljoin(settings.FRONTEND_URL, "/visa")
-    conference_name = grant.conference.name.localize("en")
-
-    email_template = EmailTemplate.objects.for_conference(
-        grant.conference
-    ).get_by_identifier(EmailTemplateIdentifier.grant_voucher_code)
-    email_template.send_email(
-        recipient=grant.user,
-        placeholders={
-            "conference_name": conference_name,
-            "user_name": get_name(grant.user, "there"),
-            "voucher_code": conference_voucher.voucher_code,
-            "has_approved_accommodation": grant.has_approved_accommodation(),
-            "visa_page_link": visa_page_link,
-        },
-    )
-
-    conference_voucher.voucher_email_sent_at = timezone.now()
-    conference_voucher.save(update_fields=["voucher_email_sent_at"])
-
-
 @app.task
 def create_and_send_voucher_to_grantee(*, grant_id: int) -> None:
+    from conferences.tasks import send_conference_voucher_email
+
     grant = Grant.objects.select_related("user", "conference").get(pk=grant_id)
     if grant.status != Grant.Status.confirmed:
         return
@@ -97,15 +56,17 @@ def create_and_send_voucher_to_grantee(*, grant_id: int) -> None:
             conference_voucher.save(
                 update_fields=["voucher_type", "voucher_email_sent_at"]
             )
-            send_grant_voucher_email.delay(grant_id=grant.id)
+            send_conference_voucher_email.delay(
+                conference_voucher_id=conference_voucher.id
+            )
             return
 
-    create_conference_voucher(
+    new_voucher = create_conference_voucher(
         conference=conference,
         user=user,
         voucher_type=ConferenceVoucher.VoucherType.GRANT,
     )
-    send_grant_voucher_email.delay(grant_id=grant.id)
+    send_conference_voucher_email.delay(conference_voucher_id=new_voucher.id)
 
 
 @app.task

backend/grants/tests/test_tasks.py

@@ -16,7 +16,6 @@
     send_grant_reply_rejected_email,
     send_grant_reply_waiting_list_email,
     send_grant_reply_waiting_list_update_email,
-    send_grant_voucher_email,
 )
 from grants.tests.factories import GrantFactory, GrantReimbursementFactory
 from users.tests.factories import UserFactory
@@ -474,110 +473,29 @@ def test_send_grant_waiting_list_email_missing_deadline():
         send_grant_reply_waiting_list_email(grant_id=grant.id)
 
 
-def test_send_grant_voucher_email(settings, sent_emails):
-    from notifications.models import EmailTemplateIdentifier
-    from notifications.tests.factories import EmailTemplateFactory
-
-    settings.FRONTEND_URL = "https://pycon.it"
-    user = UserFactory(
-        full_name="Marco Acierno",
-        email="marco@placeholder.it",
-        name="Marco",
-        username="marco",
-    )
-    grant = GrantFactory(user=user, status=Grant.Status.confirmed)
-    ConferenceVoucherFactory(
-        user=user,
-        conference=grant.conference,
-        voucher_type=ConferenceVoucher.VoucherType.GRANT,
-        voucher_code="GRANT99",
-    )
-
-    EmailTemplateFactory(
-        conference=grant.conference,
-        identifier=EmailTemplateIdentifier.grant_voucher_code,
-    )
-
-    with time_machine.travel("2020-10-10 10:00:00Z", tick=False):
-        send_grant_voucher_email(grant_id=grant.id)
-
-    emails_sent = sent_emails()
-    assert emails_sent.count() == 1
-
-    sent_email = emails_sent.first()
-    assert (
-        sent_email.email_template.identifier
-        == EmailTemplateIdentifier.grant_voucher_code
-    )
-    assert sent_email.email_template.conference == grant.conference
-    assert sent_email.recipient == user
-    assert sent_email.placeholders["user_name"] == "Marco Acierno"
-    assert sent_email.placeholders["conference_name"] == grant.conference.name.localize(
-        "en"
-    )
-    assert sent_email.placeholders["voucher_code"] == "GRANT99"
-    assert sent_email.placeholders["has_approved_accommodation"] is False
-    assert sent_email.placeholders["visa_page_link"] == "https://pycon.it/visa"
-
-    voucher = ConferenceVoucher.objects.get(
-        conference=grant.conference,
-        user=user,
-    )
-    assert voucher.voucher_email_sent_at == datetime(
-        2020, 10, 10, 10, 0, 0, tzinfo=timezone.utc
-    )
-
-
-def test_send_grant_voucher_email_skips_when_already_sent(settings, sent_emails):
-    from notifications.models import EmailTemplateIdentifier
-    from notifications.tests.factories import EmailTemplateFactory
-
-    settings.FRONTEND_URL = "https://pycon.it"
-    user = UserFactory()
-    grant = GrantFactory(user=user, status=Grant.Status.confirmed)
-    ConferenceVoucherFactory(
-        user=user,
-        conference=grant.conference,
-        voucher_type=ConferenceVoucher.VoucherType.GRANT,
-        voucher_code="GRANT99",
-        voucher_email_sent_at=datetime(2020, 1, 1, tzinfo=timezone.utc),
-    )
-    EmailTemplateFactory(
-        conference=grant.conference,
-        identifier=EmailTemplateIdentifier.grant_voucher_code,
-    )
-
-    send_grant_voucher_email(grant_id=grant.id)
-
-    assert sent_emails().count() == 0
-
-
 def test_create_and_send_voucher_to_grantee(mocker):
     mock_create = mocker.patch(
         "conferences.vouchers.create_voucher", return_value={"id": 123}
     )
-    mock_send_email = mocker.patch("grants.tasks.send_grant_voucher_email")
+    mock_send_email = mocker.patch("conferences.tasks.send_conference_voucher_email")
 
     grant = GrantFactory(status=Grant.Status.confirmed)
 
     create_and_send_voucher_to_grantee(grant_id=grant.id)
 
-    assert (
-        ConferenceVoucher.objects.for_conference(grant.conference)
-        .filter(
-            user=grant.user,
-            voucher_type=ConferenceVoucher.VoucherType.GRANT,
-        )
-        .exists()
+    voucher = ConferenceVoucher.objects.get(
+        conference=grant.conference,
+        user=grant.user,
+        voucher_type=ConferenceVoucher.VoucherType.GRANT,
     )
 
     mock_create.assert_called_once()
-    mock_send_email.delay.assert_called_once_with(grant_id=grant.id)
+    mock_send_email.delay.assert_called_once_with(conference_voucher_id=voucher.id)
 
 
 def test_create_and_send_voucher_to_grantee_does_nothing_if_not_confirmed(mocker):
     mock_create = mocker.patch("conferences.vouchers.create_voucher")
-    mock_send_email = mocker.patch("grants.tasks.send_grant_voucher_email")
+    mock_send_email = mocker.patch("conferences.tasks.send_conference_voucher_email")
 
     grant = GrantFactory(status=Grant.Status.waiting_for_confirmation)
 
@@ -589,7 +507,7 @@ def test_create_and_send_voucher_to_grantee_does_nothing_if_not_confirmed(mocker
 
 def test_create_and_send_voucher_to_grantee_does_nothing_if_no_user(mocker):
     mock_create = mocker.patch("conferences.vouchers.create_voucher")
-    mock_send_email = mocker.patch("grants.tasks.send_grant_voucher_email")
+    mock_send_email = mocker.patch("conferences.tasks.send_conference_voucher_email")
 
     grant = GrantFactory(status=Grant.Status.confirmed)
     Grant.objects.filter(pk=grant.pk).update(user_id=None)
@@ -612,7 +530,7 @@ def test_create_and_send_voucher_to_grantee_does_nothing_if_voucher_exists(
     mocker, voucher_type
 ):
     mock_create = mocker.patch("conferences.vouchers.create_voucher")
-    mock_send_email = mocker.patch("grants.tasks.send_grant_voucher_email")
+    mock_send_email = mocker.patch("conferences.tasks.send_conference_voucher_email")
 
     grant = GrantFactory(status=Grant.Status.confirmed)
     ConferenceVoucherFactory(
@@ -629,34 +547,30 @@ def test_create_and_send_voucher_to_grantee_does_nothing_if_voucher_exists(
 
 def test_create_and_send_voucher_to_grantee_upgrades_co_speaker(mocker):
     mock_create = mocker.patch("conferences.vouchers.create_voucher")
-    mock_send_email = mocker.patch("grants.tasks.send_grant_voucher_email")
+    mock_send_email = mocker.patch("conferences.tasks.send_conference_voucher_email")
 
     grant = GrantFactory(status=Grant.Status.confirmed)
-    ConferenceVoucherFactory(
+    voucher = ConferenceVoucherFactory(
         conference=grant.conference,
         user=grant.user,
         voucher_type=ConferenceVoucher.VoucherType.CO_SPEAKER,
     )
 
     create_and_send_voucher_to_grantee(grant_id=grant.id)
 
-    voucher = ConferenceVoucher.objects.get(
-        conference=grant.conference,
-        user=grant.user,
-    )
+    voucher.refresh_from_db()
     assert voucher.voucher_type == ConferenceVoucher.VoucherType.GRANT
 
     mock_create.assert_not_called()
-    mock_send_email.delay.assert_called_once_with(grant_id=grant.id)
+    mock_send_email.delay.assert_called_once_with(conference_voucher_id=voucher.id)
 
 
 def test_create_and_send_voucher_to_grantee_upgrades_co_speaker_clears_email_sent_at(
-    mocker, settings, sent_emails
+    mocker, sent_emails
 ):
     from notifications.models import EmailTemplateIdentifier
     from notifications.tests.factories import EmailTemplateFactory
 
-    settings.FRONTEND_URL = "https://pycon.it"
     mock_create = mocker.patch("conferences.vouchers.create_voucher")
     grant = GrantFactory(status=Grant.Status.confirmed)
     prior_sent = datetime(2020, 5, 5, 12, 0, 0, tzinfo=timezone.utc)
@@ -668,20 +582,27 @@ def test_create_and_send_voucher_to_grantee_upgrades_co_speaker_clears_email_sen
     )
     EmailTemplateFactory(
         conference=grant.conference,
-        identifier=EmailTemplateIdentifier.grant_voucher_code,
+        identifier=EmailTemplateIdentifier.voucher_code,
     )
 
-    create_and_send_voucher_to_grantee(grant_id=grant.id)
+    with time_machine.travel("2020-10-10 10:00:00Z", tick=False):
+        create_and_send_voucher_to_grantee(grant_id=grant.id)
 
     mock_create.assert_not_called()
     voucher = ConferenceVoucher.objects.get(
         conference=grant.conference,
         user=grant.user,
     )
     assert voucher.voucher_type == ConferenceVoucher.VoucherType.GRANT
-    assert voucher.voucher_email_sent_at is not None
-    assert voucher.voucher_email_sent_at != prior_sent
+    assert voucher.voucher_email_sent_at == datetime(
+        2020, 10, 10, 10, 0, 0, tzinfo=timezone.utc
+    )
     assert sent_emails().count() == 1
+    sent_email = sent_emails().first()
+    assert sent_email.email_template.identifier == EmailTemplateIdentifier.voucher_code
+    assert (
+        sent_email.placeholders["voucher_type"] == ConferenceVoucher.VoucherType.GRANT
+    )
 
 
 def test_create_and_send_voucher_to_grantee_creates_when_voucher_on_other_conference(
@@ -690,7 +611,7 @@ def test_create_and_send_voucher_to_grantee_creates_when_voucher_on_other_confer
     mock_create = mocker.patch(
         "conferences.vouchers.create_voucher", return_value={"id": 123}
     )
-    mock_send_email = mocker.patch("grants.tasks.send_grant_voucher_email")
+    mock_send_email = mocker.patch("conferences.tasks.send_conference_voucher_email")
 
     other_conference = ConferenceFactory()
     grant = GrantFactory(status=Grant.Status.confirmed)
@@ -711,5 +632,11 @@ def test_create_and_send_voucher_to_grantee_creates_when_voucher_on_other_confer
         .exists()
     )
 
+    voucher = ConferenceVoucher.objects.get(
+        conference=grant.conference,
+        user=grant.user,
+        voucher_type=ConferenceVoucher.VoucherType.GRANT,
+    )
+
     mock_create.assert_called_once()
-    mock_send_email.delay.assert_called_once_with(grant_id=grant.id)
+    mock_send_email.delay.assert_called_once_with(conference_voucher_id=voucher.id)