Notify on slack when we receive a new invitation letter request (#4315)

Author: marcoacierno

backend/api/visa/mutations/request_invitation_letter.py

@@ -5,6 +5,7 @@
 from api.utils import validate_email
 from api.visa.types import InvitationLetterOnBehalfOf, InvitationLetterRequest
 from api.extensions import RateLimit
+from visa.tasks import notify_new_invitation_letter_request_on_slack
 from conferences.models.deadline import Deadline
 from privacy_policy.record import record_privacy_policy_acceptance
 from visa.models import (
@@ -168,5 +169,11 @@ def request_invitation_letter(
                 conference,
                 "invitation_letter",
             )
+            transaction.on_commit(
+                lambda: notify_new_invitation_letter_request_on_slack.delay(
+                    invitation_letter_request_id=invitation_letter.id,
+                    admin_absolute_uri=info.context.request.build_absolute_uri("/"),
+                )
+            )
 
     return InvitationLetterRequest.from_model(invitation_letter)

backend/api/visa/tests/mutations/test_request_invitation_letter.py

@@ -50,7 +50,12 @@ def _request_invitation_letter(client, **input):
     )
 
 
-def test_request_invitation_letter(graphql_client, user, mock_has_ticket):
+def test_request_invitation_letter(
+    graphql_client, user, mock_has_ticket, mocker, django_capture_on_commit_callbacks
+):
+    mock_notify = mocker.patch(
+        "api.visa.mutations.request_invitation_letter.notify_new_invitation_letter_request_on_slack"
+    )
     conference = ConferenceFactory()
     ActiveDeadlineFactory(
         conference=conference, type=Deadline.TYPES.invitation_letter_request
@@ -59,20 +64,21 @@ def test_request_invitation_letter(graphql_client, user, mock_has_ticket):
 
     graphql_client.force_login(user)
 
-    response = _request_invitation_letter(
-        graphql_client,
-        input={
-            "conference": conference.code,
-            "onBehalfOf": "SELF",
-            "fullName": "Mario Rossi",
-            "email": "",
-            "nationality": "Italian",
-            "address": "via Roma",
-            "passportNumber": "YA1234567",
-            "embassyName": "Italian Embassy in France",
-            "dateOfBirth": "1999-01-01",
-        },
-    )
+    with django_capture_on_commit_callbacks(execute=True):
+        response = _request_invitation_letter(
+            graphql_client,
+            input={
+                "conference": conference.code,
+                "onBehalfOf": "SELF",
+                "fullName": "Mario Rossi",
+                "email": "",
+                "nationality": "Italian",
+                "address": "via Roma",
+                "passportNumber": "YA1234567",
+                "embassyName": "Italian Embassy in France",
+                "dateOfBirth": "1999-01-01",
+            },
+        )
 
     assert (
         response["data"]["requestInvitationLetter"]["__typename"]
@@ -103,10 +109,19 @@ def test_request_invitation_letter(graphql_client, user, mock_has_ticket):
         user=user, conference=conference, privacy_policy="invitation_letter"
     ).exists()
 
+    mock_notify.delay.assert_called_once_with(
+        invitation_letter_request_id=invitation_letter_request.id,
+        admin_absolute_uri=mocker.ANY,
+    )
+
 
 def test_can_request_invitation_letter_to_multiple_conferences(
-    graphql_client, user, mock_has_ticket
+    graphql_client, user, mock_has_ticket, mocker
 ):
+    mocker.patch(
+        "api.visa.mutations.request_invitation_letter.notify_new_invitation_letter_request_on_slack"
+    )
+
     graphql_client.force_login(user)
 
     conference = ConferenceFactory()
@@ -176,8 +191,12 @@ def test_can_request_invitation_letter_to_multiple_conferences(
 
 
 def test_request_invitation_letter_email_is_ignored_for_self_requests(
-    graphql_client, user, mock_has_ticket
+    graphql_client, user, mock_has_ticket, mocker
 ):
+    mocker.patch(
+        "api.visa.mutations.request_invitation_letter.notify_new_invitation_letter_request_on_slack"
+    )
+
     conference = ConferenceFactory()
     mock_has_ticket(conference)
     ActiveDeadlineFactory(
@@ -224,8 +243,12 @@ def test_request_invitation_letter_email_is_ignored_for_self_requests(
 
 @pytest.mark.parametrize("has_ticket", [True, False])
 def test_request_invitation_letter_on_behalf_of_other(
-    graphql_client, user, mock_has_ticket, has_ticket
+    graphql_client, user, mock_has_ticket, has_ticket, mocker
 ):
+    mocker.patch(
+        "api.visa.mutations.request_invitation_letter.notify_new_invitation_letter_request_on_slack"
+    )
+
     conference = ConferenceFactory()
     mock_has_ticket(conference, has_ticket=has_ticket, user=user)
     ActiveDeadlineFactory(
@@ -278,8 +301,12 @@ def test_request_invitation_letter_on_behalf_of_other(
 
 
 def test_duplicate_requests_for_others_are_ignored(
-    graphql_client, user, mock_has_ticket
+    graphql_client, user, mock_has_ticket, mocker
 ):
+    mocker.patch(
+        "api.visa.mutations.request_invitation_letter.notify_new_invitation_letter_request_on_slack"
+    )
+
     conference = ConferenceFactory()
     mock_has_ticket(conference, has_ticket=True, user=user)
     ActiveDeadlineFactory(

backend/conferences/admin/conference.py

@@ -158,6 +158,7 @@ class ConferenceAdmin(
                     "slack_new_grant_reply_channel_id",
                     "slack_speaker_invitation_answer_channel_id",
                     "slack_new_sponsor_lead_channel_id",
+                    "slack_new_invitation_letter_request_channel_id",
                 )
             },
         ),

backend/conferences/migrations/0053_conference_slack_new_invitation_letter_request_channel_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.4 on 2025-01-18 20:49
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('conferences', '0052_alter_deadline_type'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='conference',
+            name='slack_new_invitation_letter_request_channel_id',
+            field=models.CharField(blank=True, default='', max_length=255, verbose_name='New invitation letter request Slack channel ID for notification'),
+        ),
+    ]

backend/conferences/models/conference.py

@@ -86,6 +86,12 @@ class Conference(GeoLocalizedModel, TimeFramedModel, TimeStampedModel):
         blank=True,
         default="",
     )
+    slack_new_invitation_letter_request_channel_id = models.CharField(
+        _("New invitation letter request Slack channel ID for notification"),
+        max_length=255,
+        blank=True,
+        default="",
+    )
 
     grants_default_ticket_amount = models.DecimalField(
         verbose_name=_("grants default ticket amount"),

backend/visa/tasks.py

@@ -1,3 +1,5 @@
+from django.urls import reverse
+from integrations import slack
 import time
 from django.template import Template, Context
 
@@ -179,3 +181,53 @@ def download_pretix_ticket(invitation_letter_request):
         break
 
     return io.BytesIO(response.content)
+
+
+@app.task
+def notify_new_invitation_letter_request_on_slack(
+    *, invitation_letter_request_id: int, admin_absolute_uri: str
+):
+    invitation_letter_request = InvitationLetterRequest.objects.get(
+        id=invitation_letter_request_id
+    )
+    conference = invitation_letter_request.conference
+    name = invitation_letter_request.full_name
+
+    admin_path = reverse(
+        "admin:visa_invitationletterrequest_change", args=[invitation_letter_request.id]
+    )
+
+    slack.send_message(
+        [
+            {
+                "type": "section",
+                "text": {
+                    "text": f"New invitation letter request from {name}",
+                    "type": "plain_text",
+                },
+            }
+        ],
+        [
+            {
+                "blocks": [
+                    {
+                        "type": "actions",
+                        "elements": [
+                            {
+                                "type": "button",
+                                "text": {
+                                    "type": "plain_text",
+                                    "text": "Open in Admin",
+                                    "emoji": True,
+                                },
+                                "action_id": "ignore-action",
+                                "url": f"{admin_absolute_uri}{admin_path[1:]}",
+                            }
+                        ],
+                    }
+                ]
+            }
+        ],
+        oauth_token=conference.get_slack_oauth_token(),
+        channel_id=conference.slack_new_invitation_letter_request_channel_id,
+    )

backend/visa/tests/test_tasks.py

@@ -9,6 +9,7 @@
 import pytest
 from django.test import override_settings
 from visa.tasks import (
+    notify_new_invitation_letter_request_on_slack,
     process_invitation_letter_request,
     process_invitation_letter_request_failed,
 )
@@ -352,3 +353,25 @@ def test_process_invitation_letter_request_failed():
     request.refresh_from_db()
 
     assert request.status == InvitationLetterRequestStatus.FAILED_TO_GENERATE
+
+
+def test_notify_new_invitation_letter_request_on_slack(mocker):
+    mock_slack = mocker.patch("visa.tasks.slack.send_message")
+    invitation_letter_request = InvitationLetterRequestFactory(
+        conference__slack_new_invitation_letter_request_channel_id="S123",
+        conference__organizer__slack_oauth_bot_token="token123",
+    )
+    admin_absolute_uri = (
+        "http://example.com/admin/visa/invitationletterrequest/1/change/"
+    )
+
+    notify_new_invitation_letter_request_on_slack(
+        invitation_letter_request_id=invitation_letter_request.id,
+        admin_absolute_uri=admin_absolute_uri,
+    )
+
+    mock_slack.assert_called_once()
+
+    kwargs = mock_slack.mock_calls[0][2]
+    assert kwargs["oauth_token"] == "token123"
+    assert kwargs["channel_id"] == "S123"