From 53f9c81790ca232b8dbfa9b04b7f0863cf0d16c2 Mon Sep 17 00:00:00 2001
From: Gabriel Grubba <70247653+Grubba27@users.noreply.github.com>
Date: Wed, 9 Oct 2024 09:51:40 -0300
Subject: [PATCH] FEATURE: add `trigger_with_pms` option to `topic tags
 changed` automation trigger (#29122)

---
 .../automation/config/locales/client.en.yml   |  3 ++
 .../discourse_automation/event_handlers.rb    |  4 +++
 .../triggers/topic_tags_changed.rb            |  1 +
 .../spec/triggers/topic_tags_changed_spec.rb  | 34 +++++++++++++++++++
 4 files changed, 42 insertions(+)

diff --git a/plugins/automation/config/locales/client.en.yml b/plugins/automation/config/locales/client.en.yml
index 9af98e2c8c5..6c9706486e8 100644
--- a/plugins/automation/config/locales/client.en.yml
+++ b/plugins/automation/config/locales/client.en.yml
@@ -223,6 +223,9 @@ en:
             watching_tags:
               label: Watching tags
               description: Will trigger only if the topic has any of these tags
+            trigger_with_pms:
+              label: Trigger with PMs
+              description: Will trigger even if the tags were changed in a PM
         after_post_cook:
           fields:
             valid_trust_levels:
diff --git a/plugins/automation/lib/discourse_automation/event_handlers.rb b/plugins/automation/lib/discourse_automation/event_handlers.rb
index 3e3133024fa..1a2447fb34f 100644
--- a/plugins/automation/lib/discourse_automation/event_handlers.rb
+++ b/plugins/automation/lib/discourse_automation/event_handlers.rb
@@ -224,6 +224,10 @@ module DiscourseAutomation
       DiscourseAutomation::Automation
         .where(trigger: name, enabled: true)
         .find_each do |automation|
+          if topic.private_message?
+            next if !automation.trigger_field("trigger_with_pms")["value"]
+          end
+
           watching_categories = automation.trigger_field("watching_categories")
           if watching_categories["value"]
             next if !watching_categories["value"].include?(topic.category_id)
diff --git a/plugins/automation/lib/discourse_automation/triggers/topic_tags_changed.rb b/plugins/automation/lib/discourse_automation/triggers/topic_tags_changed.rb
index 8ee5ba5cc98..092d4bd20a7 100644
--- a/plugins/automation/lib/discourse_automation/triggers/topic_tags_changed.rb
+++ b/plugins/automation/lib/discourse_automation/triggers/topic_tags_changed.rb
@@ -3,6 +3,7 @@
 DiscourseAutomation::Triggerable.add(DiscourseAutomation::Triggers::TOPIC_TAGS_CHANGED) do
   field :watching_categories, component: :categories
   field :watching_tags, component: :tags
+  field :trigger_with_pms, component: :boolean
 
   placeholder :topic_url
   placeholder :topic_title
diff --git a/plugins/automation/spec/triggers/topic_tags_changed_spec.rb b/plugins/automation/spec/triggers/topic_tags_changed_spec.rb
index df5b8f681a3..0572c4d12f4 100644
--- a/plugins/automation/spec/triggers/topic_tags_changed_spec.rb
+++ b/plugins/automation/spec/triggers/topic_tags_changed_spec.rb
@@ -19,6 +19,7 @@ describe DiscourseAutomation::Triggers::TOPIC_TAGS_CHANGED do
     SiteSetting.tagging_enabled = true
     SiteSetting.create_tag_allowed_groups = Group::AUTO_GROUPS[:everyone]
     SiteSetting.tag_topic_allowed_groups = Group::AUTO_GROUPS[:everyone]
+    SiteSetting.pm_tags_allowed_for_groups = Group::AUTO_GROUPS[:everyone]
   end
 
   context "when watching a cool tag" do
@@ -185,5 +186,38 @@ describe DiscourseAutomation::Triggers::TOPIC_TAGS_CHANGED do
       expect(list[0]["added_tags"]).to eq([another_tag.name])
       expect(list[0]["removed_tags"]).to eq([])
     end
+
+    it "should not fire the trigger on PMs by default" do
+      pm = Fabricate(:private_message_topic)
+      list =
+        capture_contexts do
+          DiscourseTagging.tag_topic_by_names(
+            pm,
+            Guardian.new(user),
+            [cool_tag.name, another_tag.name],
+          )
+        end
+      expect(list.length).to eq(0)
+    end
+
+    it "should fire the trigger on PMs if trigger_with_pms is set" do
+      automation.upsert_field!(
+        "trigger_with_pms",
+        "boolean",
+        { "value" => true },
+        target: "trigger",
+      )
+
+      pm = Fabricate(:private_message_topic)
+      list =
+        capture_contexts do
+          DiscourseTagging.tag_topic_by_names(
+            pm,
+            Guardian.new(user),
+            [cool_tag.name, another_tag.name],
+          )
+        end
+      expect(list.length).to eq(1)
+    end
   end
 end