Merge pull request #4876 from nyaruka/trigger_channels

Add optional channel field to trigger types that are based on channel activity

temba/contacts/models.py

@@ -1343,6 +1343,7 @@ class ContactURN(models.Model):
         URN.INSTAGRAM_SCHEME,
     }
     SCHEMES_SUPPORTING_REFERRALS = {URN.FACEBOOK_SCHEME}  # schemes that support "referral" triggers
+    SCHEMES_SUPPORTING_OPTINS = {URN.FACEBOOK_SCHEME}  # schemes that support opt-in/opt-out triggers
 
     # mailroom sets priorites like 1000, 999, ...
     PRIORITY_HIGHEST = 1000

temba/triggers/models.py

@@ -64,8 +64,9 @@ class ChannelTriggerType(TriggerType):
     Base class for trigger types based on channel activity.
     """
 
-    # channels with these schemes allowed for this type
+    # channels with these schemes or role allowed for this type
     allowed_channel_schemes = ()
+    allowed_channel_role = None
 
     export_fields = TriggerType.export_fields + ("channel",)
 

temba/triggers/tests.py

@@ -307,6 +307,7 @@ def test_export_import_keyword(self):
             {
                 "trigger_type": "K",
                 "flow": {"uuid": str(flow.uuid), "name": "Test"},
+                "channel": None,
                 "groups": [
                     {"uuid": str(doctors.uuid), "name": "Doctors"},
                     {"uuid": str(farmers.uuid), "name": "Farmers"},
@@ -326,6 +327,7 @@ def test_export_import_inbound_call(self):
             {
                 "trigger_type": "V",
                 "flow": {"uuid": str(flow.uuid), "name": "Test"},
+                "channel": None,
                 "groups": [],
                 "exclude_groups": [],
                 "keyword": None,
@@ -553,7 +555,7 @@ def test_create_keyword(self):
             create_url,
             allow_viewers=False,
             allow_editors=True,
-            form_fields=["keyword", "match_type", "flow", "groups", "exclude_groups"],
+            form_fields=["keyword", "match_type", "flow", "channel", "groups", "exclude_groups"],
         )
 
         # flow options should show messaging and voice flows
@@ -633,6 +635,14 @@ def test_create_keyword(self):
             success_status=200,
         )
 
+        # or a channel
+        self.assertCreateSubmit(
+            create_url,
+            {"keyword": "start", "flow": flow2.id, "match_type": "F", "channel": self.channel.id},
+            new_obj_query=Trigger.objects.filter(keyword="start", flow=flow2, channel=self.channel),
+            success_status=200,
+        )
+
         # groups between triggers can't overlap
         self.assertCreateSubmit(
             create_url,
@@ -809,9 +819,11 @@ def test_create_schedule(self):
         )
 
     def test_create_inbound_call(self):
-        # make our channel support ivr
-        self.channel.role += Channel.ROLE_CALL + Channel.ROLE_ANSWER
-        self.channel.save()
+        channel1 = self.create_channel("NX", "Vonage", "78598", "AC")
+        channel2 = self.create_channel("T", "Twilio", "34636", "SRAC")
+
+        # channels that shouldn't appear as options
+        self.create_channel("T", "Twilio", "45674", "SR")
 
         flow1 = self.create_flow("Flow 1", flow_type=Flow.TYPE_VOICE)
         flow2 = self.create_flow("Flow 2", flow_type=Flow.TYPE_VOICE)
@@ -830,13 +842,16 @@ def test_create_inbound_call(self):
             create_url,
             allow_viewers=False,
             allow_editors=True,
-            form_fields=["action", "voice_flow", "msg_flow", "groups", "exclude_groups"],
+            form_fields=["action", "voice_flow", "msg_flow", "channel", "groups", "exclude_groups"],
         )
 
         # check which flows appear in which fields
         self.assertEqual([flow1, flow2], list(response.context["form"].fields["voice_flow"].queryset))
         self.assertEqual([flow3, flow4], list(response.context["form"].fields["msg_flow"].queryset))
 
+        # check which channels are allowed
+        self.assertEqual([channel2, channel1], list(response.context["form"].fields["channel"].queryset))
+
         # which flow field is required depends on the action selected
         self.assertCreateSubmit(create_url, {"action": "answer"}, form_errors={"voice_flow": "This field is required."})
         self.assertCreateSubmit(create_url, {"action": "hangup"}, form_errors={"msg_flow": "This field is required."})
@@ -1055,7 +1070,7 @@ def test_create_catchall(self):
             create_url,
             allow_viewers=False,
             allow_editors=True,
-            form_fields=["flow", "groups", "exclude_groups"],
+            form_fields=["flow", "channel", "groups", "exclude_groups"],
         )
 
         # flow options should show messaging and voice flows
@@ -1087,6 +1102,14 @@ def test_create_catchall(self):
             success_status=200,
         )
 
+        # or a channel
+        self.assertCreateSubmit(
+            create_url,
+            {"flow": flow2.id, "channel": self.channel.id},
+            new_obj_query=Trigger.objects.filter(trigger_type=Trigger.TYPE_CATCH_ALL, flow=flow2, channel=self.channel),
+            success_status=200,
+        )
+
         # groups between triggers can't overlap
         self.assertCreateSubmit(
             create_url,
@@ -1129,6 +1152,10 @@ def test_create_closed_ticket(self):
     def test_create_opt_in(self):
         flow1 = self.create_flow("Flow 1", flow_type=Flow.TYPE_MESSAGE)
         flow2 = self.create_flow("Flow 2", flow_type=Flow.TYPE_BACKGROUND)
+        group1 = self.create_group("Group 1", contacts=[])
+
+        channel1 = self.create_channel("FB", "Facebook 1", "1234567")
+        channel2 = self.create_channel("FB", "Facebook 2", "2345678")
 
         # flows that shouldn't appear as options
         self.create_flow("Flow 3", flow_type=Flow.TYPE_VOICE)
@@ -1138,29 +1165,55 @@ def test_create_opt_in(self):
         create_url = reverse("triggers.trigger_create_opt_in")
 
         response = self.assertCreateFetch(
-            create_url, allow_viewers=False, allow_editors=True, form_fields=["flow", "groups", "exclude_groups"]
+            create_url,
+            allow_viewers=False,
+            allow_editors=True,
+            form_fields=["flow", "channel", "groups", "exclude_groups"],
         )
 
         # flow options should be messaging and background flows
         self.assertEqual([flow1, flow2], list(response.context["form"].fields["flow"].queryset))
 
+        # channel options should only be channels that support optins
+        self.assertEqual([channel1, channel2], list(response.context["form"].fields["channel"].queryset))
+
         self.assertCreateSubmit(
             create_url,
             {"flow": flow1.id},
             new_obj_query=Trigger.objects.filter(flow=flow1, trigger_type=Trigger.TYPE_OPT_IN),
             success_status=200,
         )
 
-        # we can't create another...
+        # we can't create another
         self.assertCreateSubmit(
             create_url,
             {"flow": flow2.id},
             form_errors={"__all__": "There already exists a trigger of this type with these options."},
         )
 
+        # works if we specify a group
+        self.assertCreateSubmit(
+            create_url,
+            {"flow": flow2.id, "groups": group1.id},
+            new_obj_query=Trigger.objects.filter(trigger_type=Trigger.TYPE_OPT_IN, flow=flow2),
+            success_status=200,
+        )
+
+        # or a channel
+        self.assertCreateSubmit(
+            create_url,
+            {"flow": flow2.id, "channel": channel2.id},
+            new_obj_query=Trigger.objects.filter(trigger_type=Trigger.TYPE_OPT_IN, flow=flow2, channel=channel2),
+            success_status=200,
+        )
+
     def test_create_opt_out(self):
         flow1 = self.create_flow("Flow 1", flow_type=Flow.TYPE_MESSAGE)
         flow2 = self.create_flow("Flow 2", flow_type=Flow.TYPE_BACKGROUND)
+        group1 = self.create_group("Group 1", contacts=[])
+
+        channel1 = self.create_channel("FB", "Facebook 1", "1234567")
+        channel2 = self.create_channel("FB", "Facebook 2", "2345678")
 
         # flows that shouldn't appear as options
         self.create_flow("Flow 3", flow_type=Flow.TYPE_VOICE)
@@ -1170,12 +1223,18 @@ def test_create_opt_out(self):
         create_url = reverse("triggers.trigger_create_opt_out")
 
         response = self.assertCreateFetch(
-            create_url, allow_viewers=False, allow_editors=True, form_fields=["flow", "groups", "exclude_groups"]
+            create_url,
+            allow_viewers=False,
+            allow_editors=True,
+            form_fields=["flow", "channel", "groups", "exclude_groups"],
         )
 
         # flow options should be messaging and background flows
         self.assertEqual([flow1, flow2], list(response.context["form"].fields["flow"].queryset))
 
+        # channel options should only be channels that support optins
+        self.assertEqual([channel1, channel2], list(response.context["form"].fields["channel"].queryset))
+
         self.assertCreateSubmit(
             create_url,
             {"flow": flow1.id},
@@ -1190,11 +1249,28 @@ def test_create_opt_out(self):
             form_errors={"__all__": "There already exists a trigger of this type with these options."},
         )
 
+        # works if we specify a group
+        self.assertCreateSubmit(
+            create_url,
+            {"flow": flow2.id, "groups": group1.id},
+            new_obj_query=Trigger.objects.filter(trigger_type=Trigger.TYPE_OPT_OUT, flow=flow2),
+            success_status=200,
+        )
+
+        # or a channel
+        self.assertCreateSubmit(
+            create_url,
+            {"flow": flow2.id, "channel": channel1.id},
+            new_obj_query=Trigger.objects.filter(trigger_type=Trigger.TYPE_OPT_OUT, flow=flow2, channel=channel1),
+            success_status=200,
+        )
+
     def test_update_keyword(self):
         flow = self.create_flow("Test")
         group1 = self.create_group("Chat", contacts=[])
         group2 = self.create_group("Testers", contacts=[])
         group3 = self.create_group("Doctors", contacts=[])
+        channel1 = self.create_channel("NX", "Nexmo", "345636", role="SRAC")
         trigger = Trigger.create(
             self.org,
             self.admin,
@@ -1211,7 +1287,7 @@ def test_update_keyword(self):
             update_url,
             allow_viewers=False,
             allow_editors=True,
-            form_fields=["keyword", "match_type", "flow", "groups", "exclude_groups"],
+            form_fields=["keyword", "match_type", "flow", "channel", "groups", "exclude_groups"],
         )
 
         # submit with valid keyword and extra group
@@ -1221,6 +1297,7 @@ def test_update_keyword(self):
                 "keyword": "kiki",
                 "flow": flow.id,
                 "match_type": "O",
+                "channel": channel1.id,
                 "groups": [group1.id, group2.id],
                 "exclude_groups": [group3.id],
             },
@@ -1230,6 +1307,7 @@ def test_update_keyword(self):
         self.assertEqual("kiki", trigger.keyword)
         self.assertEqual(flow, trigger.flow)
         self.assertEqual(Trigger.MATCH_ONLY_WORD, trigger.match_type)
+        self.assertEqual(channel1, trigger.channel)
         self.assertEqual({group1, group2}, set(trigger.groups.all()))
         self.assertEqual({group3}, set(trigger.exclude_groups.all()))
 
@@ -1265,6 +1343,7 @@ def test_update_inbound_call(self):
                 "action": "answer",
                 "voice_flow": flow2,
                 "msg_flow": None,
+                "channel": None,
                 "groups": [],
                 "exclude_groups": [],
             },
@@ -1291,6 +1370,7 @@ def test_update_inbound_call(self):
                 "action": "hangup",
                 "voice_flow": None,
                 "msg_flow": flow3,
+                "channel": None,
                 "groups": [],
                 "exclude_groups": [],
             },