Send voucher to the speaker when accepting their invitation (#4248)

Author: marcoacierno

backend/api/schedule/mutations/update_schedule_invitation.py

@@ -15,6 +15,7 @@
 from api.submissions.permissions import IsSubmissionSpeakerOrStaff
 
 from schedule.tasks import (
+    create_and_send_voucher_to_speaker,
     notify_new_schedule_invitation_answer_slack,
     send_schedule_invitation_plain_message,
 )
@@ -59,11 +60,9 @@ def update_schedule_invitation(
 
     new_status = input.option.to_schedule_item_status()
     new_notes = input.notes
+    status_changed = schedule_item.status != new_status
 
-    if (
-        schedule_item.status == new_status
-        and schedule_item.speaker_invitation_notes == new_notes
-    ):
+    if not status_changed and schedule_item.speaker_invitation_notes == new_notes:
         # If nothing changed, do nothing
         return ScheduleInvitation.from_django_model(schedule_item)
 
@@ -72,6 +71,9 @@ def update_schedule_invitation(
         schedule_item.speaker_invitation_notes = new_notes
         schedule_item.save()
 
+    if status_changed and new_status == ScheduleItem.STATUS.confirmed:
+        create_and_send_voucher_to_speaker.delay(schedule_item.id)
+
     request = info.context.request
     invitation_admin_url = request.build_absolute_uri(
         schedule_item.get_invitation_admin_url()

backend/api/schedule/tests/test_update_schedule_invitation.py

@@ -29,6 +29,9 @@ def test_update_invitation_answer(
     mock_plain = mocker.patch(
         "api.schedule.mutations.update_schedule_invitation.send_schedule_invitation_plain_message"
     )
+    mock_send_voucher = mocker.patch(
+        "api.schedule.mutations.update_schedule_invitation.create_and_send_voucher_to_speaker"
+    )
 
     graphql_client.force_login(user)
     submission = SubmissionFactory(
@@ -80,6 +83,9 @@ def test_update_invitation_answer(
         message="notes",
     )
 
+    if expected_status == ScheduleItem.STATUS.confirmed:
+        mock_send_voucher.delay.assert_called_once_with(schedule_item.id)
+
 
 def test_saving_the_same_answer_does_not_trigger_event(
     graphql_client,
@@ -92,6 +98,9 @@ def test_saving_the_same_answer_does_not_trigger_event(
     mock_plain = mocker.patch(
         "api.schedule.mutations.update_schedule_invitation.send_schedule_invitation_plain_message"
     )
+    mock_send_voucher = mocker.patch(
+        "api.schedule.mutations.update_schedule_invitation.create_and_send_voucher_to_speaker"
+    )
 
     graphql_client.force_login(user)
     submission = SubmissionFactory(
@@ -141,6 +150,7 @@ def test_saving_the_same_answer_does_not_trigger_event(
 
     mock_event.delay.assert_not_called()
     mock_plain.delay.assert_not_called()
+    mock_send_voucher.delay.assert_not_called()
 
 
 def test_changing_notes_triggers_a_new_event(
@@ -350,6 +360,9 @@ def test_staff_can_update_invitation_answer(
     mock_plain = mocker.patch(
         "api.schedule.mutations.update_schedule_invitation.send_schedule_invitation_plain_message"
     )
+    mock_send_voucher = mocker.patch(
+        "api.schedule.mutations.update_schedule_invitation.create_and_send_voucher_to_speaker"
+    )
 
     graphql_client.force_login(admin_user)
     submission = SubmissionFactory()
@@ -398,3 +411,4 @@ def test_staff_can_update_invitation_answer(
         schedule_item_id=schedule_item.id,
         message="notes",
     )
+    mock_send_voucher.delay.assert_called_once_with(schedule_item.id)

backend/conferences/querysets.py

@@ -14,4 +14,5 @@ def for_conference_code(self, conference):
 
 
 class ConferenceVoucherQuerySet(ConferenceQuerySetMixin, models.QuerySet):
-    pass
+    def for_user(self, user):
+        return self.filter(user=user)

backend/conferences/vouchers.py

@@ -0,0 +1,35 @@
+from conferences.models.conference_voucher import ConferenceVoucher
+from conferences.models.conference import Conference
+from users.models import User
+from pretix import create_voucher
+
+
+def create_conference_voucher(
+    *,
+    conference: Conference,
+    user: User,
+    voucher_type: ConferenceVoucher.VoucherType,
+) -> ConferenceVoucher:
+    conference_voucher = ConferenceVoucher(
+        conference=conference,
+        user=user,
+        voucher_type=voucher_type,
+        voucher_code=ConferenceVoucher.generate_code(),
+    )
+
+    price_mode, value = conference_voucher.get_voucher_configuration()
+
+    pretix_voucher = create_voucher(
+        conference=conference_voucher.conference,
+        code=conference_voucher.voucher_code,
+        comment=f"Voucher for user_id={conference_voucher.user_id}",
+        tag=conference_voucher.voucher_type,
+        quota_id=conference_voucher.conference.pretix_conference_voucher_quota_id,
+        price_mode=price_mode,
+        value=value,
+    )
+
+    pretix_voucher_id = pretix_voucher["id"]
+    conference_voucher.pretix_voucher_id = pretix_voucher_id
+    conference_voucher.save()
+    return conference_voucher

backend/schedule/models.py

@@ -309,12 +309,13 @@ def speakers(self):
         if self.submission_id:
             speakers.append(self.submission.speaker)
 
-        speakers.extend([speaker.user for speaker in self.additional_speakers.all()])
-
         if self.keynote_id:
-            for speaker_keynote in self.keynote.speakers.all():
+            for speaker_keynote in self.keynote.speakers.order_by("id").all():
                 speakers.append(speaker_keynote.user)
 
+        speakers.extend(
+            [speaker.user for speaker in self.additional_speakers.order_by("id").all()]
+        )
         return speakers
 
     def clean(self):

backend/schedule/tasks.py

@@ -1,4 +1,7 @@
 from django.db.models import Q
+from conferences.tasks import send_conference_voucher_email
+from conferences.vouchers import create_conference_voucher
+from conferences.models.conference_voucher import ConferenceVoucher
 from pycon.celery_utils import OnlyOneAtTimeTask
 from google_api.exceptions import NoGoogleCloudQuotaLeftError
 from googleapiclient.errors import HttpError
@@ -373,3 +376,50 @@ def process_schedule_items_videos_to_upload():
             )
             sent_for_video_upload_state.failed_reason = str(e)
             sent_for_video_upload_state.save(update_fields=["status", "failed_reason"])
+
+
+@app.task
+def create_and_send_voucher_to_speaker(schedule_item_id: int):
+    schedule_item = ScheduleItem.objects.get(id=schedule_item_id)
+    speakers = schedule_item.speakers
+
+    if not speakers:
+        return
+
+    speaker = speakers[0]
+    co_speaker = speakers[1] if len(speakers) > 1 else None
+
+    _send_conference_voucher(
+        speaker,
+        schedule_item.conference,
+        ConferenceVoucher.VoucherType.SPEAKER,
+    )
+
+    if co_speaker:
+        _send_conference_voucher(
+            co_speaker,
+            schedule_item.conference,
+            ConferenceVoucher.VoucherType.CO_SPEAKER,
+        )
+
+
+def _send_conference_voucher(user, conference, voucher_type):
+    conference_voucher = (
+        ConferenceVoucher.objects.for_conference(conference).for_user(user).first()
+    )
+
+    if conference_voucher:
+        logger.info(
+            "User %s already has a voucher for conference %s, not creating a new one",
+            user.id,
+            conference.id,
+        )
+        return
+
+    conference_voucher = create_conference_voucher(
+        conference=conference,
+        user=user,
+        voucher_type=voucher_type,
+    )
+
+    send_conference_voucher_email.delay(conference_voucher_id=conference_voucher.id)

backend/schedule/tests/test_tasks.py

@@ -1,3 +1,4 @@
+from conferences.models.conference_voucher import ConferenceVoucher
 from notifications.tests.factories import EmailTemplateFactory
 from google_api.exceptions import NoGoogleCloudQuotaLeftError
 from googleapiclient.errors import HttpError
@@ -6,13 +7,14 @@
 from django.core.files.storage import storages
 from django.core.files.uploadedfile import InMemoryUploadedFile
 from unittest import mock
-from conferences.tests.factories import ConferenceFactory
+from conferences.tests.factories import ConferenceFactory, ConferenceVoucherFactory
 from i18n.strings import LazyI18nString
 from datetime import datetime, timezone
 from unittest.mock import ANY, patch
 from django.test import override_settings
 
 from schedule.tasks import (
+    create_and_send_voucher_to_speaker,
     notify_new_schedule_invitation_answer_slack,
     process_schedule_items_videos_to_upload,
     send_schedule_invitation_email,
@@ -22,6 +24,7 @@
     upload_schedule_item_video,
 )
 from schedule.tests.factories import (
+    ScheduleItemAdditionalSpeakerFactory,
     ScheduleItemFactory,
     ScheduleItemSentForVideoUploadFactory,
 )
@@ -736,3 +739,140 @@ def test_upload_schedule_item_video_with_failing_thumbnail_upload_fails(mocker):
         upload_schedule_item_video(
             sent_for_video_upload_state_id=sent_for_upload.id,
         )
+
+
+def test_create_and_send_voucher_to_speaker(mocker):
+    mock_create = mocker.patch(
+        "conferences.vouchers.create_voucher", return_value={"id": 123}
+    )
+    mock_send_email = mocker.patch("schedule.tasks.send_conference_voucher_email")
+
+    schedule_item = ScheduleItemFactory(type=ScheduleItem.TYPES.talk)
+    create_and_send_voucher_to_speaker(schedule_item.id)
+
+    assert (
+        ConferenceVoucher.objects.for_conference(schedule_item.conference)
+        .filter(
+            user=schedule_item.submission.speaker,
+            voucher_type=ConferenceVoucher.VoucherType.SPEAKER,
+        )
+        .exists()
+    )
+
+    mock_create.assert_called_once()
+    mock_send_email.delay.assert_called_once()
+
+
+def test_create_and_send_voucher_to_speaker_to_speaker_and_co_speakers(mocker):
+    mock_create = mocker.patch(
+        "conferences.vouchers.create_voucher", return_value={"id": 123}
+    )
+    mock_send_email = mocker.patch("schedule.tasks.send_conference_voucher_email")
+
+    schedule_item = ScheduleItemFactory(
+        type=ScheduleItem.TYPES.talk,
+    )
+    additional_speaker_1 = ScheduleItemAdditionalSpeakerFactory(
+        scheduleitem=schedule_item
+    ).user
+    additional_speaker_2 = ScheduleItemAdditionalSpeakerFactory(
+        scheduleitem=schedule_item
+    ).user
+
+    create_and_send_voucher_to_speaker(schedule_item.id)
+
+    speaker_voucher = (
+        ConferenceVoucher.objects.for_conference(schedule_item.conference)
+        .filter(
+            user=schedule_item.submission.speaker,
+            voucher_type=ConferenceVoucher.VoucherType.SPEAKER,
+        )
+        .get()
+    )
+
+    co_speaker_voucher = (
+        ConferenceVoucher.objects.for_conference(schedule_item.conference)
+        .filter(
+            user=additional_speaker_1,
+            voucher_type=ConferenceVoucher.VoucherType.CO_SPEAKER,
+        )
+        .get()
+    )
+
+    assert not (
+        ConferenceVoucher.objects.for_conference(schedule_item.conference)
+        .filter(
+            user=additional_speaker_2,
+            voucher_type=ConferenceVoucher.VoucherType.CO_SPEAKER,
+        )
+        .exists()
+    )
+
+    assert mock_create.call_count == 2
+    mock_send_email.delay.assert_has_calls(
+        [
+            mock.call(conference_voucher_id=speaker_voucher.id),
+            mock.call(conference_voucher_id=co_speaker_voucher.id),
+        ],
+        any_order=True,
+    )
+
+
+def test_create_and_send_voucher_to_speaker_works_if_existing_voucher_is_for_different_conf(
+    mocker,
+):
+    mock_create = mocker.patch(
+        "conferences.vouchers.create_voucher", return_value={"id": 123}
+    )
+    mock_send_email = mocker.patch("schedule.tasks.send_conference_voucher_email")
+
+    schedule_item = ScheduleItemFactory(type=ScheduleItem.TYPES.talk)
+
+    ConferenceVoucherFactory(
+        user=schedule_item.submission.speaker,
+    )
+
+    create_and_send_voucher_to_speaker(schedule_item.id)
+
+    assert (
+        ConferenceVoucher.objects.for_conference(schedule_item.conference)
+        .filter(
+            user=schedule_item.submission.speaker,
+            voucher_type=ConferenceVoucher.VoucherType.SPEAKER,
+        )
+        .exists()
+    )
+
+    mock_create.assert_called_once()
+    mock_send_email.delay.assert_called_once()
+
+
+def test_create_and_send_voucher_to_speaker_does_nothing_if_voucher_exists(mocker):
+    mock_create = mocker.patch("conferences.vouchers.create_voucher")
+    mock_send_email = mocker.patch("schedule.tasks.send_conference_voucher_email")
+
+    schedule_item = ScheduleItemFactory(type=ScheduleItem.TYPES.talk)
+
+    ConferenceVoucherFactory(
+        conference=schedule_item.conference,
+        user=schedule_item.submission.speaker,
+    )
+
+    create_and_send_voucher_to_speaker(schedule_item.id)
+
+    mock_create.assert_not_called()
+    mock_send_email.delay.assert_not_called()
+
+
+def test_create_and_send_voucher_to_speaker_does_nothing_if_schedule_item_does_not_hav_speakers(
+    mocker,
+):
+    mock_create = mocker.patch("conferences.vouchers.create_voucher")
+    mock_send_email = mocker.patch("schedule.tasks.send_conference_voucher_email")
+
+    schedule_item = ScheduleItemFactory(type=ScheduleItem.TYPES.talk, submission=None)
+
+    create_and_send_voucher_to_speaker(schedule_item.id)
+
+    mock_create.assert_not_called()
+    mock_send_email.delay.assert_not_called()