feat(nimbus):Removes question emoji if the request is cancelled (#15000)

Because

- We add a question emoji if the request is review pending, but user can
cancel the request so in that case we should remove the pending review
question emoji so it is easy for reviewers to know which request is
cancelled and which is pending for the review

This commit

- Removes the question emoji if the request is cancelled

Fixes #14972

Author: yashikakhurana

experimenter/experimenter/nimbus_ui/constants.py

@@ -238,6 +238,11 @@ class ReviewRequestMessages(Enum):
         UPDATE_ROLLOUT = "update this rollout"
         END_ROLLOUT = "end this rollout"
 
+    class CancelRequestMessages(Enum):
+        END_ENROLLMENT = "Cancelled end enrollment request."
+        END_EXPERIMENT = "Cancelled end experiment request."
+        UPDATE_ROLLOUT = "Cancelled update rollout."
+
     class ExposuresStatus(IntEnum):
         NO_EXPOSURES = 0
         VALID = 1

experimenter/experimenter/nimbus_ui/forms.py

@@ -1378,6 +1378,11 @@ class CancelRequestMixin:
     def save(self, commit=True):
         experiment = super().save(commit=commit)
         if self.cancel_request_alert_type:
+            remove_emoji_from_message_async.delay(
+                experiment.id,
+                self.cancel_request_alert_type,
+                SlackConstants.EmojiReaction.PENDING,
+            )
             add_emoji_to_message_async.delay(
                 experiment.id,
                 self.cancel_request_alert_type,

experimenter/experimenter/nimbus_ui/tests/test_forms.py

@@ -120,6 +120,82 @@ def setUp(self):
         self.addCleanup(self.mock_remove_emoji_task.stop)
 
 
+class CancelEmojiTestMixin:
+    @parameterized.expand(
+        [
+            (
+                "end_enrollment",
+                CancelEndEnrollmentForm,
+                NimbusConstants.AlertType.END_ENROLLMENT_REQUEST,
+                NimbusExperiment.Status.LIVE,
+                NimbusExperiment.Status.LIVE,
+                {
+                    "cancel_message": (
+                        NimbusUIConstants.CancelRequestMessages.END_ENROLLMENT.value
+                    )
+                },
+            ),
+            (
+                "end_experiment",
+                CancelEndExperimentForm,
+                NimbusConstants.AlertType.END_EXPERIMENT_REQUEST,
+                NimbusExperiment.Status.LIVE,
+                NimbusExperiment.Status.COMPLETE,
+                {
+                    "cancel_message": (
+                        NimbusUIConstants.CancelRequestMessages.END_EXPERIMENT.value
+                    )
+                },
+            ),
+            (
+                "update_rollout",
+                CancelUpdateRolloutForm,
+                NimbusConstants.AlertType.UPDATE_REQUEST,
+                NimbusExperiment.Status.LIVE,
+                NimbusExperiment.Status.LIVE,
+                {
+                    "cancel_message": (
+                        NimbusUIConstants.CancelRequestMessages.UPDATE_ROLLOUT.value
+                    )
+                },
+            ),
+        ]
+    )
+    def test_cancel_removes_pending_emoji(
+        self, name, form_class, alert_type, status, status_next, data
+    ):
+        is_rollout = form_class == CancelUpdateRolloutForm
+        is_paused = alert_type != NimbusConstants.AlertType.UPDATE_REQUEST
+
+        experiment = NimbusExperimentFactory.create(
+            status=status,
+            status_next=status_next,
+            publish_status=NimbusExperiment.PublishStatus.REVIEW,
+            is_paused=is_paused,
+            is_rollout=is_rollout,
+        )
+
+        form = form_class(
+            data=data,
+            instance=experiment,
+            request=self.request,
+        )
+        self.assertTrue(form.is_valid(), form.errors)
+
+        form.save()
+
+        self.mock_remove_emoji_task.assert_called_once_with(
+            experiment.id,
+            alert_type,
+            SlackConstants.EmojiReaction.PENDING,
+        )
+        self.mock_emoji_task.assert_called_once_with(
+            experiment.id,
+            alert_type,
+            SlackConstants.EmojiReaction.CANCEL,
+        )
+
+
 class KintoPushQueueMockMixin:
     def setUp(self):
         super().setUp()
@@ -1912,7 +1988,9 @@ def test_invalid_transition(self, status, status_next, publish_status, is_paused
         )
 
 
-class TestCancelEndEnrollmentForm(SlackEmojiMockMixin, RequestFormTestCase):
+class TestCancelEndEnrollmentForm(
+    CancelEmojiTestMixin, SlackEmojiMockMixin, RequestFormTestCase
+):
     def test_valid_transition(self):
         experiment = NimbusExperimentFactory.create(
             status=NimbusExperiment.Status.LIVE,
@@ -2004,7 +2082,9 @@ def test_cancel_end_enrollment_request(self):
         self.assertIn("Cancelled end enrollment request.", changelog.message)
 
 
-class TestCancelEndExperimentForm(SlackEmojiMockMixin, RequestFormTestCase):
+class TestCancelEndExperimentForm(
+    CancelEmojiTestMixin, SlackEmojiMockMixin, RequestFormTestCase
+):
     def test_valid_transition(self):
         experiment = NimbusExperimentFactory.create(
             status=NimbusExperiment.Status.LIVE,
@@ -2224,7 +2304,9 @@ def test_sends_slack_when_enabled(self, mock_send_slack):
         self.assertEqual(alert.slack_channel_id, "C123456")
 
 
-class TestCancelUpdateRolloutForm(SlackEmojiMockMixin, RequestFormTestCase):
+class TestCancelUpdateRolloutForm(
+    CancelEmojiTestMixin, SlackEmojiMockMixin, RequestFormTestCase
+):
     def test_valid_transition(self):
         experiment = NimbusExperimentFactory.create(
             status=NimbusExperiment.Status.LIVE,
@@ -2252,6 +2334,11 @@ def test_valid_transition(self):
             "rejected the update review with reason: Audience update not valid.",
             changelog.message,
         )
+        self.mock_remove_emoji_task.assert_called_once_with(
+            experiment.id,
+            NimbusConstants.AlertType.UPDATE_REQUEST,
+            SlackConstants.EmojiReaction.PENDING,
+        )
         self.mock_emoji_task.assert_called_once_with(
             experiment.id,
             NimbusConstants.AlertType.UPDATE_REQUEST,

experimenter/experimenter/nimbus_ui/tests/test_views.py

@@ -2619,13 +2619,14 @@ def test_cancel_end_enrollment_view(self):
             is_paused=True,
         )
 
+        cancel_msg = NimbusUIConstants.CancelRequestMessages.END_ENROLLMENT.value
         response = self.client.post(
             reverse(
                 "nimbus-ui-cancel-end-enrollment",
                 kwargs={"slug": experiment.slug},
             ),
             data={
-                "cancel_message": "Cancelled end enrollment request.",
+                "cancel_message": cancel_msg,
                 "action_type": "end_enrollment",
             },
         )
@@ -2638,7 +2639,7 @@ def test_cancel_end_enrollment_view(self):
 
         changelog = experiment.changes.latest("changed_on")
         self.assertEqual(changelog.changed_by, self.user)
-        self.assertIn("Cancelled end enrollment request.", changelog.message)
+        self.assertIn(cancel_msg, changelog.message)
 
     @parameterized.expand(
         [
@@ -2694,13 +2695,14 @@ def test_cancel_end_experiment_view(self, is_rollout):
             is_rollout=is_rollout,
         )
 
+        cancel_msg = NimbusUIConstants.CancelRequestMessages.END_EXPERIMENT.value
         response = self.client.post(
             reverse(
                 "nimbus-ui-cancel-end-experiment",
                 kwargs={"slug": experiment.slug},
             ),
             data={
-                "cancel_message": "Cancelled end experiment request.",
+                "cancel_message": cancel_msg,
                 "action_type": "end_experiment",
             },
         )
@@ -2713,7 +2715,7 @@ def test_cancel_end_experiment_view(self, is_rollout):
 
         changelog = experiment.changes.latest("changed_on")
         self.assertEqual(changelog.changed_by, self.user)
-        self.assertIn("Cancelled end experiment request.", changelog.message)
+        self.assertIn(cancel_msg, changelog.message)
 
     def test_live_to_update_rollout_view(self):
         experiment = NimbusExperimentFactory.create(
@@ -2765,10 +2767,11 @@ def test_cancel_update_rollout_view_with_cancel_message(self):
             is_rollout=True,
         )
 
+        cancel_msg = NimbusUIConstants.CancelRequestMessages.UPDATE_ROLLOUT.value
         response = self.client.post(
             reverse("nimbus-ui-cancel-update-rollout", kwargs={"slug": experiment.slug}),
             data={
-                "cancel_message": "Cancelled update rollout.",
+                "cancel_message": cancel_msg,
                 "action_type": "update_rollout",
             },
         )
@@ -2778,7 +2781,7 @@ def test_cancel_update_rollout_view_with_cancel_message(self):
         self.assertEqual(experiment.publish_status, NimbusExperiment.PublishStatus.IDLE)
 
         changelog = experiment.changes.latest("changed_on")
-        self.assertIn("Cancelled update rollout.", changelog.message)
+        self.assertIn(cancel_msg, changelog.message)
 
     def test_approve_update_rollout_view(self):
         experiment = NimbusExperimentFactory.create(