Skip to content

A platform for community discussion. Free, open, simple.

FEATURE: Add workflow triggers for group membership changes (#41608)

Joffrey JAFFEUXb4f930648050
diff --git a/plugins/discourse-workflows/app/jobs/regular/discourse_workflows/author_with_ai.rb b/plugins/discourse-workflows/app/jobs/regular/discourse_workflows/author_with_ai.rb
index d28e6a138a1..a903c2270e2 100644
--- a/plugins/discourse-workflows/app/jobs/regular/discourse_workflows/author_with_ai.rb
+++ b/plugins/discourse-workflows/app/jobs/regular/discourse_workflows/author_with_ai.rb
@@ -13,6 +13,7 @@ module Jobs
"trigger:topic_closed exposes only the closed topic under topic.*. When a closed-topic workflow needs a first-post link, add action:topic with operation get and topic_id ={{ $json.topic.id }} immediately after the trigger. Use the exact fields returned by workflow_validate_patch for any first-post author data; do not assume post.trust_level is available.",
"Do not ask whether trust level is available for trigger:post_created or trigger:post_edited; it is available as user.trust_level.",
"Do not generate fallback chains for undocumented author aliases; use the exact post.* fields from the node catalog output_schema.",
+ "trigger:user_added_to_group and trigger:user_removed_from_group expose the affected user under user.*, the selected group under group.*, and event metadata under membership.*. Use user.username for the affected username and membership.action to distinguish added vs removed if needed.",
"For named group membership checks, use workflow_resolve_entity to resolve the group, then use action:group with operation check_membership, group_id set to the resolved group id, and username ={{ $json.user.username }} when the input schema includes user.username, otherwise use the exact username field from the current input schema. It adds group_membership.in_group while preserving the original item fields. Do not use a Code node for simple group membership.",
"For personal messages, private messages, DMs, direct messages, or PM notifications, use action:send_personal_message with recipient_usernames or recipient_group_names as arrays, title, raw, and sender_username. Resolve named users with workflow_resolve_entity(kind: user), and named groups with workflow_resolve_entity(kind: group).",
].freeze
diff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.yml
index d56287952c7..3728d3f035d 100644
--- a/plugins/discourse-workflows/config/locales/client.en.yml
+++ b/plugins/discourse-workflows/config/locales/client.en.yml
@@ -213,6 +213,8 @@ en:
"trigger:topic_created": "Topic created"
"trigger:topic_category_changed": "Topic category changed"
"trigger:topic_tag_changed": "Topic tag changed"
+ "trigger:user_added_to_group": "User added to group"
+ "trigger:user_removed_from_group": "User removed from group"
"trigger:reviewable_approved": "Approved reviewable"
"trigger:user_search": "User search"
"trigger:webhook": "Webhook"
@@ -257,6 +259,8 @@ en:
"trigger:topic_created": "Fires when a new topic is created"
"trigger:topic_category_changed": "Fires when a topic is moved to a different category"
"trigger:topic_tag_changed": "Fires when tags are added to or removed from a topic"
+ "trigger:user_added_to_group": "Fires when a user is added to a selected group"
+ "trigger:user_removed_from_group": "Fires when a user is removed from a selected group"
"trigger:reviewable_approved": "Fires when a reviewable is approved"
"trigger:user_search": "Fires when a user searches the site"
"trigger:webhook": "Fires when an external service sends a webhook request"
@@ -695,6 +699,14 @@ en:
topic_tag_changed:
category_id: "Category"
category_id_description: "Only trigger for topics in this category"
+ user_added_to_group:
+ group_id: "Group"
+ group_id_description: "Only trigger when a user is added to this group"
+ group_id_placeholder: "Select a group"
+ user_removed_from_group:
+ group_id: "Group"
+ group_id_description: "Only trigger when a user is removed from this group"
+ group_id_placeholder: "Select a group"
reviewable_approved:
reviewable_types: "Reviewable types"
reviewable_types_description: "Only trigger for these reviewable types"
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/ai/tools/workflow_node_catalog.rb b/plugins/discourse-workflows/lib/discourse_workflows/ai/tools/workflow_node_catalog.rb
index 134d6f347b5..a87d50ae605 100644
--- a/plugins/discourse-workflows/lib/discourse_workflows/ai/tools/workflow_node_catalog.rb
+++ b/plugins/discourse-workflows/lib/discourse_workflows/ai/tools/workflow_node_catalog.rb
@@ -55,7 +55,7 @@ module DiscourseWorkflows
).merge("post" => "WebHookPostSerializer payload", "post.category_slug" => "string")
USER_SCHEMA = {
- "user" => "Basic safe user attributes for the post author",
+ "user" => "Basic safe user attributes",
"user.id" => "integer",
"user.username" => "string",
"user.name" => "string|null",
@@ -90,6 +90,33 @@ module DiscourseWorkflows
"group_membership.in_group" => "boolean",
}.freeze
+ GROUP_SCHEMA = {
+ "group" => "Group involved in the membership event",
+ "group.id" => "integer",
+ "group.name" => "string",
+ "group.full_name" => "string|null",
+ "group.automatic" => "boolean",
+ }.freeze
+
+ GROUP_MEMBERSHIP_EVENT_SCHEMA = {
+ "membership" => "Group membership event metadata",
+ "membership.automatic" => "boolean|null",
+ }.freeze
+
+ USER_ADDED_TO_GROUP_SCHEMA =
+ USER_SCHEMA
+ .merge(GROUP_SCHEMA)
+ .merge(GROUP_MEMBERSHIP_EVENT_SCHEMA)
+ .merge("membership.action" => "\"added\"")
+ .freeze
+
+ USER_REMOVED_FROM_GROUP_SCHEMA =
+ USER_SCHEMA
+ .merge(GROUP_SCHEMA)
+ .merge(GROUP_MEMBERSHIP_EVENT_SCHEMA)
+ .merge("membership.action" => "\"removed\"")
+ .freeze
+
OUTPUT_SCHEMAS = {
"trigger:manual" => {
},
@@ -98,6 +125,8 @@ module DiscourseWorkflows
"trigger:post_created" => POST_SCHEMA.merge(TOPIC_LIST_ITEM_SCHEMA).merge(USER_SCHEMA),
"trigger:post_edited" => POST_SCHEMA.merge(TOPIC_LIST_ITEM_SCHEMA).merge(USER_SCHEMA),
"trigger:topic_closed" => TOPIC_LIST_ITEM_SCHEMA,
+ "trigger:user_added_to_group" => USER_ADDED_TO_GROUP_SCHEMA,
+ "trigger:user_removed_from_group" => USER_REMOVED_FROM_GROUP_SCHEMA,
"action:topic" => TOPIC_LIST_ITEM_SCHEMA.merge(WEBHOOK_POST_SCHEMA),
"action:topic_tags" => {
"topic_id" => "integer",
@@ -304,6 +333,8 @@ module DiscourseWorkflows
"action:ai_agent" =>
"ai agent bot llm classify summarize generate sentiment triage runner run as permissions uploads attachments",
"action:group" => "group membership member belongs friend friends",
+ "trigger:user_added_to_group" => "joined added to group membership member",
+ "trigger:user_removed_from_group" => "left removed from group membership member",
"action:user" =>
"user profile bio title trust level lock groups fields lookup edit update",
}.freeze
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_added_to_group/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_added_to_group/v1.rb
new file mode 100644
index 00000000000..f3c51431ce2
--- /dev/null
+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_added_to_group/v1.rb
@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module DiscourseWorkflows
+ module Nodes
+ module UserAddedToGroup
+ class V1 < NodeType
+ description(
+ name: "trigger:user_added_to_group",
+ version: "1.0",
+ defaults: {
+ icon: "user-plus",
+ color: "teal",
+ },
+ group: "discourse_triggers",
+ events: [:user_added_to_group],
+ properties: {
+ group_id: {
+ type: :integer,
+ required: true,
+ type_options: {
+ load_options_method: "groups",
+ },
+ no_data_expression: true,
+ ui: {
+ control: :group_select,
+ },
+ control_options: {
+ value_property: "id",
+ name_property: "name",
+ filterable: true,
+ none: "discourse_workflows.user_added_to_group.group_id_placeholder",
+ },
+ },
+ },
+ )
+
+ def self.load_options_context(context)
+ case context.method_name
+ when "groups"
+ ::Group
+ .order(:name)
+ .pluck(:id, :name)
+ .select { |_, name| context.matches_filter?(name) }
+ .map { |id, name| { id:, name: } }
+ end
+ end
+
+ def initialize(user, group, options = {})
+ super(parameters: {})
+ @user = user
+ @group = group
+ @automatic =
+ options.respond_to?(:to_h) ? options.to_h.with_indifferent_access[:automatic] : nil
+ end
+
+ def valid?
+ @user.present? && @group.present?
+ end
+
+ def output
+ {
+ user: serialize_user(@user),
+ group: group_data,
+ membership: {
+ action: "added",
+ automatic: @automatic == true,
+ },
+ }
+ end
+
+ def matches?(trigger_ctx)
+ group_id = trigger_ctx.get_node_parameter("group_id")
+ group_id.present? && @group.id == group_id.to_i
+ end
+
+ private
+
+ def group_data
+ {
+ id: @group.id,
+ name: @group.name,
+ full_name: @group.full_name,
+ automatic: @group.automatic?,
+ }
+ end
+ end
+ end
+ end
+end
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_removed_from_group/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_removed_from_group/v1.rb
new file mode 100644
index 00000000000..8037017c10d
--- /dev/null
+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_removed_from_group/v1.rb
@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module DiscourseWorkflows
+ module Nodes
+ module UserRemovedFromGroup
+ class V1 < NodeType
+ description(
+ name: "trigger:user_removed_from_group",
+ version: "1.0",
+ defaults: {
+ icon: "user-minus",
+ color: "grey",
+ },
+ group: "discourse_triggers",
+ events: [:user_removed_from_group],
+ properties: {
+ group_id: {
+ type: :integer,
+ required: true,
+ type_options: {
+ load_options_method: "groups",
+ },
+ no_data_expression: true,
+ ui: {
+ control: :group_select,
+ },
+ control_options: {
+ value_property: "id",
+ name_property: "name",
+ filterable: true,
+ none: "discourse_workflows.user_removed_from_group.group_id_placeholder",
+ },
+ },
+ },
+ )
+
+ def self.load_options_context(context)
+ case context.method_name
+ when "groups"
+ ::Group
+ .order(:name)
+ .pluck(:id, :name)
+ .select { |_, name| context.matches_filter?(name) }
+ .map { |id, name| { id:, name: } }
+ end
+ end
+
+ def initialize(user, group)
+ super(parameters: {})
+ @user = user
+ @group = group
+ end
+
+ def valid?
+ @user.present? && @group.present?
+ end
+
+ def output
+ {
+ user: serialize_user(@user),
+ group: group_data,
+ membership: {
+ action: "removed",
+ automatic: nil,
+ },
+ }
+ end
+
+ def matches?(trigger_ctx)
+ group_id = trigger_ctx.get_node_parameter("group_id")
+ group_id.present? && @group.id == group_id.to_i
+ end
+
+ private
+
+ def group_data
+ {
+ id: @group.id,
+ name: @group.name,
+ full_name: @group.full_name,
+ automatic: @group.automatic?,
+ }
+ end
+ end
+ end
+ end
+end
diff --git a/plugins/discourse-workflows/plugin.rb b/plugins/discourse-workflows/plugin.rb
index 55d10825a13..d227fc94e86 100644
--- a/plugins/discourse-workflows/plugin.rb
+++ b/plugins/discourse-workflows/plugin.rb
@@ -45,6 +45,7 @@ register_svg_icon "comments"
register_svg_icon "pause"
register_svg_icon "window-maximize"
register_svg_icon "user-plus"
+register_svg_icon "user-minus"
register_svg_icon "grip-vertical"
register_svg_icon "paragraph"
register_svg_icon "arrow-down-a-z"
diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/ai/tools/workflow_node_catalog_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/ai/tools/workflow_node_catalog_spec.rb
index 7da3230b7e1..4315ec4d5b8 100644
--- a/plugins/discourse-workflows/spec/lib/discourse_workflows/ai/tools/workflow_node_catalog_spec.rb
+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/ai/tools/workflow_node_catalog_spec.rb
@@ -65,6 +65,22 @@ RSpec.describe DiscourseWorkflows::Ai::Tools::WorkflowNodeCatalog do
"topic.closed" => "boolean",
"topic.archived" => "boolean",
)
+ {
+ "trigger:user_added_to_group" => "\"added\"",
+ "trigger:user_removed_from_group" => "\"removed\"",
+ }.each do |trigger_type, membership_action|
+ expect(nodes_by_type.dig(trigger_type, :output_schema)).to include(
+ "user.id" => "integer",
+ "user.username" => "string",
+ "user.trust_level" => "integer",
+ "group.id" => "integer",
+ "group.name" => "string",
+ "group.full_name" => "string|null",
+ "group.automatic" => "boolean",
+ "membership.action" => membership_action,
+ "membership.automatic" => "boolean|null",
+ )
+ end
expect(nodes_by_type.dig("action:topic", :output_schema)).to include(
"topic.id" => "integer",
"topic.slug" => "string",
@@ -119,6 +135,8 @@ RSpec.describe DiscourseWorkflows::Ai::Tools::WorkflowNodeCatalog do
"condition:filter",
"action:group",
"action:user",
+ "trigger:user_added_to_group",
+ "trigger:user_removed_from_group",
"action:send_chat_message",
"action:send_personal_message",
)
diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/event_listener_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/event_listener_spec.rb
index b40256781ae..c13a1452063 100644
--- a/plugins/discourse-workflows/spec/lib/discourse_workflows/event_listener_spec.rb
+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/event_listener_spec.rb
@@ -7,6 +7,8 @@ RSpec.describe DiscourseWorkflows::EventListener do
fab!(:other_category, :category)
fab!(:topic) { Fabricate(:topic, category: category) }
fab!(:tag) { Fabricate(:tag, name: "matched") }
+ fab!(:membership_group) { Fabricate(:group, name: "workflow_helpers", full_name: "Helpers") }
+ fab!(:other_group) { Fabricate(:group, name: "workflow_others", full_name: "Others") }
before do
SiteSetting.tagging_enabled = true
@@ -236,6 +238,84 @@ RSpec.describe DiscourseWorkflows::EventListener do
)
end
+ it "only enqueues user added to group workflows matching the group" do
+ create_published_workflow(
+ "matching-add-trigger",
+ "trigger:user_added_to_group",
+ configuration: {
+ "group_id" => membership_group.id.to_s,
+ },
+ )
+ create_published_workflow(
+ "group-mismatch-add-trigger",
+ "trigger:user_added_to_group",
+ configuration: {
+ "group_id" => other_group.id.to_s,
+ },
+ )
+
+ membership_group.add(user, automatic: true)
+
+ expect(enqueued_trigger_node_ids).to include("matching-add-trigger")
+ expect(enqueued_trigger_node_ids).not_to include("group-mismatch-add-trigger")
+
+ trigger_data = trigger_data_for("matching-add-trigger")
+ expect(trigger_data).to include(
+ "user" => include("id" => user.id, "username" => user.username),
+ "group" =>
+ include(
+ "id" => membership_group.id,
+ "name" => membership_group.name,
+ "full_name" => membership_group.full_name,
+ "automatic" => false,
+ ),
+ "membership" => {
+ "action" => "added",
+ "automatic" => true,
+ },
+ )
+ end
+
+ it "only enqueues user removed from group workflows matching the group" do
+ Fabricate(:group_user, user: user, group: membership_group)
+
+ create_published_workflow(
+ "matching-remove-trigger",
+ "trigger:user_removed_from_group",
+ configuration: {
+ "group_id" => membership_group.id.to_s,
+ },
+ )
+ create_published_workflow(
+ "group-mismatch-remove-trigger",
+ "trigger:user_removed_from_group",
+ configuration: {
+ "group_id" => other_group.id.to_s,
+ },
+ )
+
+ membership_group.remove(user)
+
+ expect(enqueued_trigger_node_ids).to include("matching-remove-trigger")
+ expect(enqueued_trigger_node_ids).not_to include("group-mismatch-remove-trigger")
+
+ trigger_data = trigger_data_for("matching-remove-trigger")
+ expect(trigger_data).to include(
+ "user" => include("id" => user.id, "username" => user.username),
+ "group" =>
+ include(
+ "id" => membership_group.id,
+ "name" => membership_group.name,
+ "full_name" => membership_group.full_name,
+ "automatic" => false,
+ ),
+ "membership" => {
+ "action" => "removed",
+ "automatic" => nil,
+ },
+ )
+ end
+
it "does not query the dependencies table when no live workflow uses the fired trigger type" do
create_published_workflow("closed-trigger", "trigger:topic_closed")
DiscourseWorkflows::WorkflowDependency.active_node_types # warm the cache
@@ -290,4 +370,12 @@ RSpec.describe DiscourseWorkflows::EventListener do
job["args"].first["trigger_node_id"]
end
end
+
+ def trigger_data_for(trigger_node_id)
+ Jobs::DiscourseWorkflows::ExecuteWorkflow
+ .jobs
+ .find { |job| job["args"].first["trigger_node_id"] == trigger_node_id }
+ .dig("args", 0, "trigger_data")
+ .deep_stringify_keys
+ end
end
diff --git a/plugins/discourse-workflows/spec/services/discourse_workflows/node_type/list_spec.rb b/plugins/discourse-workflows/spec/services/discourse_workflows/node_type/list_spec.rb
index 9abf8c1b5ad..51235ae9e7c 100644
--- a/plugins/discourse-workflows/spec/services/discourse_workflows/node_type/list_spec.rb
+++ b/plugins/discourse-workflows/spec/services/discourse_workflows/node_type/list_spec.rb
@@ -18,6 +18,7 @@ RSpec.describe DiscourseWorkflows::NodeType::List do
context "when everything's ok" do
fab!(:badge) { Fabricate(:badge, name: "Helpful") }
+ fab!(:membership_group) { Fabricate(:group, name: "workflow_helpers") }
it { is_expected.to run_successfully }
@@ -101,6 +102,26 @@ RSpec.describe DiscourseWorkflows::NodeType::List do
expect(award_badge.dig(:metadata, "badges")).to include(id: badge.id, name: badge.name)
end
+ it "serializes the required group selector for group membership triggers",
+ :aggregate_failures do
+ %w[trigger:user_added_to_group trigger:user_removed_from_group].each do |identifier|
+ trigger = result[:node_types].find { |node_type| node_type[:identifier] == identifier }
+
+ expect(trigger.dig(:properties, :group_id)).to include(
+ type: :integer,
+ required: true,
+ no_data_expression: true,
+ ui: {
+ control: :group_select,
+ },
+ )
+ expect(trigger.dig(:metadata, "groups")).to include(
+ id: membership_group.id,
+ name: membership_group.name,
+ )
+ end
+ end
+
it "includes branching for condition nodes" do
condition = result[:node_types].find { |nt| nt[:identifier] == "condition:if" }
expect(condition[:branching]).to be(true)