Skip to content

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

FEATURE: allows group node to set primary group (#43822)

Joffrey JAFFEUX812c9197786f
diff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.yml
index 727e6eeb886..3a62c8b0a33 100644
--- a/plugins/discourse-workflows/config/locales/client.en.yml
+++ b/plugins/discourse-workflows/config/locales/client.en.yml
@@ -479,6 +479,8 @@ en:
get: "Get group"
check_membership: "Check membership"
username: "User"
+ set_primary_group: "Set as primary group"
+ set_primary_group_description: "Make this the user's primary group after adding them. The primary group is used for their title and flair."
manage_groups: "Manage groups"
actor_username: "Performed by user"
user:
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/group/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/group/v1.rb
index d7c9b8b9afb..6759ad54f0b 100644
--- a/plugins/discourse-workflows/lib/discourse_workflows/nodes/group/v1.rb
+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/group/v1.rb
@@ -78,6 +78,20 @@ module DiscourseWorkflows
filterable: true,
},
},
+ set_primary_group: {
+ type: :boolean,
+ required: false,
+ default: false,
+ ui: {
+ control: :boolean,
+ expression: true,
+ },
+ display_options: {
+ show: {
+ operation: ["add"],
+ },
+ },
+ },
actor_username: {
type: :string,
required: false,
@@ -107,6 +121,8 @@ module DiscourseWorkflows
"operation" => exec_ctx.get_node_parameter("operation", item_index, default: "add"),
"username" => exec_ctx.get_node_parameter("username", item_index),
"group_id" => exec_ctx.get_node_parameter("group_id", item_index),
+ "set_primary_group" =>
+ exec_ctx.get_node_parameter("set_primary_group", item_index, default: false),
}
if config["operation"] == "check_membership"
@@ -143,11 +159,17 @@ module DiscourseWorkflows
else
group.add(user)
logger.log_add_user_to_group(user)
+ set_primary_group(user, group, guardian) if config["set_primary_group"]
end
{ group: serialized_group, user: user_data(user, guardian) }
end
+ def set_primary_group(user, group, guardian)
+ guardian.ensure_can_change_primary_group!(user, group)
+ user.update!(primary_group_id: group.id)
+ end
+
def check_membership(exec_ctx, item, config, item_index)
group = ::Group.find(config["group_id"])
actor = exec_ctx.actor_from_parameter("actor_username", item_index)
diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/group_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/group_spec.rb
index 0dc19f9aa3f..40ee40bf988 100644
--- a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/group_spec.rb
+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/group_spec.rb
@@ -135,6 +135,82 @@ RSpec.describe DiscourseWorkflows::Nodes::Group::V1 do
Discourse::InvalidAccess,
)
end
+
+ it "does not change the primary group by default" do
+ user.update!(primary_group: group_2)
+ group_2.add(user)
+
+ config = { "operation" => "add", "username" => user.username, "group_id" => group.id.to_s }
+
+ execute_node(configuration: config, item: item)
+
+ expect(user.reload.primary_group_id).to eq(group_2.id)
+ end
+
+ context "with set_primary_group" do
+ let(:config) do
+ {
+ "operation" => "add",
+ "username" => user.username,
+ "group_id" => group.id.to_s,
+ "set_primary_group" => true,
+ }
+ end
+
+ it "sets the group as the user's primary group", :aggregate_failures do
+ result = execute_node(configuration: config, item: item)
+
+ expect(user.reload.primary_group_id).to eq(group.id)
+ expect(GroupUser.exists?(user: user, group: group)).to be(true)
+ expect(result["user"]["id"]).to eq(user.id)
+ expect(result).to match_node_output_schema(described_class, configuration: config)
+ end
+
+ it "replaces an existing primary group and its title and flair", :aggregate_failures do
+ group_2.update!(title: "Old title")
+ group_2.add(user)
+ user.update!(primary_group: group_2, flair_group: group_2, title: "Old title")
+ group.update!(title: "New title")
+
+ execute_node(configuration: config, item: item)
+
+ user.reload
+ expect(user.primary_group_id).to eq(group.id)
+ expect(user.flair_group_id).to eq(group.id)
+ expect(user.title).to eq("New title")
+ end
+
+ it "agrees with a group that automatically becomes the primary group",
+ :aggregate_failures do
+ group_2.update!(title: "Old title")
+ group_2.add(user)
+ user.update!(primary_group: group_2, flair_group: group_2, title: "Old title")
+ group.update!(primary_group: true, title: "New title")
+
+ execute_node(configuration: config, item: item)
+
+ user.reload
+ expect(user.primary_group_id).to eq(group.id)
+ expect(user.flair_group_id).to eq(group.id)
+ expect(user.title).to eq("New title")
+ end
+
+ it "sets the primary group when the user is already a member" do
+ group.add(user)
+
+ execute_node(configuration: config, item: item)
+
+ expect(user.reload.primary_group_id).to eq(group.id)
+ end
+
+ it "resolves the value from an expression" do
+ config["set_primary_group"] = "={{ $json.make_primary }}"
+
+ execute_node(configuration: config, item: { "json" => { "make_primary" => true } })
+
+ expect(user.reload.primary_group_id).to eq(group.id)
+ end
+ end
end
context "with remove operation" do