A platform for community discussion. Free, open, simple.
FIX: adds user created/updated trigger to workflows (#42311)
Joffrey JAFFEUXbf2d387329d8
diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/property-engine.js b/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/property-engine.jsindex c5e655f2876..39dc78c12c7 100644--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/property-engine.js+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/property-engine.js@@ -228,6 +228,7 @@ export function propertySelectNoneKey(nodeDefinitionOrType, fieldName) {return translationKeyWithFallback([`${base}.select_${selectField}`,`${base}.${key}_placeholder`,+ `${SHARED_FIELDS_BASE}.${key}_placeholder`,]);}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.rbindex c5ef468eaff..1d890ac2732 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@@ -14,6 +14,7 @@ module Jobs"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_contracts.","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.",+ "trigger:user_created and trigger:user_updated expose the affected user under user.* only, including user.username, user.trust_level, user.staged, and user.created_at. They do not expose a post or topic object. They also fire for staged users (accounts auto-created by incoming email or invites); to skip those, add condition:filter on user.staged equals false after the trigger.","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).",].freezediff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.ymlindex 315f88e5b1d..c04b2a8cb58 100644--- a/plugins/discourse-workflows/config/locales/client.en.yml+++ b/plugins/discourse-workflows/config/locales/client.en.yml@@ -222,6 +222,8 @@ en:"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:user_created": "User created"+ "trigger:user_updated": "User updated""trigger:reviewable_approved": "Approved reviewable""trigger:badge_granted": "Badge granted""trigger:user_search": "User search"@@ -276,6 +278,8 @@ en:"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:user_created": "Fires when a new user account is created"+ "trigger:user_updated": "Fires when a user account or profile is updated""trigger:reviewable_approved": "Fires when a reviewable is approved""trigger:badge_granted": "Fires when a user is granted a badge""trigger:user_search": "Fires when a user searches the site"@@ -328,7 +332,6 @@ en:label: "Button label"label_placeholder: "Run workflow"icon: "Button icon"- group_ids: "Groups"group_ids_description: "Only members of at least one of these groups can see and use the button"position: "Position"position_first: "First in the row"@@ -443,8 +446,6 @@ en:get: "Get group"check_membership: "Check membership"username: "User"- group_id: "Group"- group_id_placeholder: "Select a group"manage_groups: "Manage groups"actor_username: "Performed by user"user:@@ -698,6 +699,11 @@ en:combinator: "Match mode"combinator_and: "All conditions must pass"combinator_or: "Any condition can pass"+ group_id: "Group"+ group_id_placeholder: "Select a group"+ group_ids: "Groups"+ group_ids_description: "Only trigger for users in at least one of these groups"+ group_ids_placeholder: "All groups"include_subcategories: "Include subcategories"dynamic_values:badge_id: "a badge ID"@@ -802,13 +808,9 @@ en:tag_names: "Tags"tag_names_description: "Only trigger for topics that have at least one of these tags"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"@@ -818,9 +820,6 @@ en:badge_id_description: "Only trigger when this badge is granted. Leave blank for any badge."badge_id_placeholder: "Any badge"user_seen:- group_ids: "Groups"- group_ids_description: "Only trigger for users in at least one of these groups"- group_ids_placeholder: "All groups"trigger_on_first_seen: "First seen"trigger_on_first_seen_description: "The user has never been seen before."trigger_on_not_seen_for_more_than: "Returning after inactivity"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.rbindex d1ccd74f58f..fb1f584b1ea 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@@ -217,6 +217,8 @@ module DiscourseWorkflows"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",+ "trigger:user_created" => "signup sign up register registration new account joined site",+ "trigger:user_updated" => "profile edited changed avatar name username email account","trigger:badge_granted" => "badge award achievement medal granted earned","action:user" =>"user profile bio title trust level lock groups fields lookup edit update",diff --git a/plugins/discourse-workflows/lib/discourse_workflows/node_type.rb b/plugins/discourse-workflows/lib/discourse_workflows/node_type.rbindex 2c6055c3017..50a49fd36b2 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/node_type.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/node_type.rb@@ -245,6 +245,18 @@ module DiscourseWorkflowscategory_ids.include?(topic_category_id)end+ def self.matches_user_groups?(user, group_ids)+ raw_group_ids = Array.wrap(group_ids).reject(&:blank?)+ return true if raw_group_ids.empty?++ group_ids =+ raw_group_ids.filter_map do |group_id|+ value = group_id.to_s+ value.to_i if value.match?(/\A\d+\z/)+ end+ group_ids.present? && !!user&.in_any_groups?(group_ids)+ end+def self.trust_level_optionsTrustLevel.levels.map do |name, level|{ value: level.to_s, label_key: "trust_levels.names.#{name}" }@@ -317,6 +329,10 @@ module DiscourseWorkflowstimezoneend+ def matches_user_groups?(user, group_ids)+ self.class.matches_user_groups?(user, group_ids)+ end+def wrap(data, paired_item: nil)Item.wrap(data, paired_item:)enddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/group/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/group/v1.rbindex 3805623241d..d7c9b8b9afb 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/nodes/group/v1.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/group/v1.rb@@ -76,7 +76,6 @@ module DiscourseWorkflowsvalue_property: "id",name_property: "name",filterable: true,- none: "discourse_workflows.group.group_id_placeholder",},},actor_username: {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.rbindex 0872655c0e2..001cbb2073e 100644--- 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@@ -29,7 +29,6 @@ module DiscourseWorkflowsvalue_property: "id",name_property: "name",filterable: true,- none: "discourse_workflows.user_added_to_group.group_id_placeholder",},},},diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_created/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_created/v1.rbnew file mode 100644index 00000000000..295a672a5b9--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_created/v1.rb@@ -0,0 +1,47 @@+# frozen_string_literal: true++module DiscourseWorkflows+ module Nodes+ module UserCreated+ class V1 < NodeType+ description(+ name: "trigger:user_created",+ version: "1.0",+ defaults: {+ icon: "user-plus",+ color: "teal",+ },+ group: "discourse_triggers",+ events: [:user_created],+ output_contracts: [{ schema: Schema::USER_EVENT_SCHEMA }],+ capabilities: {+ provides_current_user: true,+ },+ )++ def initialize(user, *)+ super(parameters: {})+ @user = user+ end++ def valid?+ @user.present? && @user.human?+ end++ def user_id+ @user.id+ end++ def output+ {+ user:+ serialize_user(@user).merge(+ staged: @user.staged?,+ created_at: @user.created_at&.iso8601,+ ),+ }+ end+ end+ end+ end+enddiff --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.rbindex 0187d812036..f6b30c10e5c 100644--- 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@@ -29,7 +29,6 @@ module DiscourseWorkflowsvalue_property: "id",name_property: "name",filterable: true,- none: "discourse_workflows.user_removed_from_group.group_id_placeholder",},},},diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_seen/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_seen/v1.rbindex 77f8fc05209..666376fd4c4 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_seen/v1.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_seen/v1.rb@@ -130,18 +130,7 @@ module DiscourseWorkflowsenddef matches_groups?(group_ids)- raw_group_ids = Array.wrap(group_ids).reject(&:blank?)- return true if raw_group_ids.empty?-- group_ids = normalize_group_ids(raw_group_ids)- group_ids.present? && !!@user&.in_any_groups?(group_ids)- end-- def normalize_group_ids(group_ids)- group_ids.filter_map do |group_id|- value = group_id.to_s- value.to_i if value.match?(/\A\d+\z/)- end+ matches_user_groups?(@user, group_ids)enddef first_seen?diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_updated/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_updated/v1.rbnew file mode 100644index 00000000000..0ec50d2222c--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_updated/v1.rb@@ -0,0 +1,77 @@+# frozen_string_literal: true++module DiscourseWorkflows+ module Nodes+ module UserUpdated+ class V1 < NodeType+ description(+ name: "trigger:user_updated",+ version: "1.0",+ defaults: {+ icon: "user-pen",+ color: "teal",+ },+ group: "discourse_triggers",+ events: [:user_updated],+ output_contracts: [{ schema: Schema::USER_EVENT_SCHEMA }],+ properties: {+ group_ids: {+ type: :multi_options,+ required: false,+ default: [],+ type_options: {+ load_options_method: "groups",+ },+ control_options: {+ value_property: "id",+ name_property: "name",+ filterable: true,+ },+ },+ },+ capabilities: {+ provides_current_user: true,+ },+ )++ 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, *)+ super(parameters: {})+ @user = user+ end++ def valid?+ @user.present? && @user.human?+ end++ def user_id+ @user.id+ end++ def output+ {+ user:+ serialize_user(@user).merge(+ staged: @user.staged?,+ created_at: @user.created_at&.iso8601,+ ),+ }+ end++ def matches?(trigger_ctx)+ matches_user_groups?(@user, trigger_ctx.get_node_parameter("group_ids", []))+ end+ end+ end+ end+enddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/schema.rb b/plugins/discourse-workflows/lib/discourse_workflows/schema.rbindex 810638814e6..b77dd45b961 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/schema.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/schema.rb@@ -222,6 +222,21 @@ module DiscourseWorkflowsUSER_ADDED_TO_GROUP_SCHEMA = group_membership_event("added")USER_REMOVED_FROM_GROUP_SCHEMA = group_membership_event("removed")+ USER_EVENT_SCHEMA =+ entity(+ "user",+ USER_PROPERTIES.merge(+ "staged" => {+ "type" => "boolean",+ },+ "created_at" => {+ "type" => "string",+ "format" => "date-time",+ },+ ),+ "User account event payload",+ )+USER_SEEN_SCHEMA =document(BASIC_USER_SCHEMA.fetch("properties").merge(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.rbindex 80fbfc097e0..6793ea7f580 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@@ -446,6 +446,62 @@ RSpec.describe DiscourseWorkflows::EventListener do)end+ it "enqueues user created workflows with the staged flag in the payload" do+ create_published_workflow("user-created-trigger", "trigger:user_created")++ new_user = Fabricate(:user)++ expect(enqueued_trigger_node_ids).to contain_exactly("user-created-trigger")+ expect(Jobs::DiscourseWorkflows::ExecuteWorkflow.jobs.last["args"].first["user_id"]).to eq(+ new_user.id,+ )++ trigger_data = trigger_data_for("user-created-trigger")+ expect(trigger_data).to include(+ "user" => include("id" => new_user.id, "username" => new_user.username, "staged" => false),+ )++ Jobs::DiscourseWorkflows::ExecuteWorkflow.jobs.clear+ staged_user = Fabricate(:user, staged: true)++ expect(enqueued_trigger_node_ids).to contain_exactly("user-created-trigger")+ expect(trigger_data_for("user-created-trigger")).to include(+ "user" => include("id" => staged_user.id, "staged" => true),+ )+ end++ it "only enqueues user updated workflows matching the selected groups" do+ group = Fabricate(:group)+ group.add(user)+ Jobs::DiscourseWorkflows::ExecuteWorkflow.jobs.clear++ create_published_workflow("user-updated-trigger", "trigger:user_updated")+ create_published_workflow(+ "matching-group-updated-trigger",+ "trigger:user_updated",+ configuration: {+ "group_ids" => [group.id.to_s],+ },+ )+ create_published_workflow(+ "group-mismatch-updated-trigger",+ "trigger:user_updated",+ configuration: {+ "group_ids" => [other_group.id.to_s],+ },+ )++ UserUpdater.new(admin, user).update(bio_raw: "Updated bio")++ expect(enqueued_trigger_node_ids).to contain_exactly(+ "user-updated-trigger",+ "matching-group-updated-trigger",+ )++ trigger_data = trigger_data_for("user-updated-trigger")+ expect(trigger_data).to include("user" => include("id" => user.id, "username" => user.username))+ end+it "does not query the dependencies table when no live workflow uses the fired trigger type" docreate_published_workflow("closed-trigger", "trigger:topic_closed")DiscourseWorkflows::WorkflowDependency.active_node_types # warm the cachediff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_created_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_created_spec.rbnew file mode 100644index 00000000000..4397a5764f1--- /dev/null+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_created_spec.rb@@ -0,0 +1,59 @@+# frozen_string_literal: true++RSpec.describe DiscourseWorkflows::Nodes::UserCreated::V1 do+ fab!(:user)++ describe "#valid?" do+ it "returns true for a human user" do+ expect(described_class.new(user)).to be_valid+ end++ it "returns false when the user is missing" do+ expect(described_class.new(nil)).not_to be_valid+ end++ it "returns false for bot users" do+ expect(described_class.new(Discourse.system_user)).not_to be_valid+ end+ end++ describe "#user_id" do+ it "returns the created user ID" do+ expect(described_class.new(user).user_id).to eq(user.id)+ end+ end++ describe "#output" do+ it "returns the user payload", :aggregate_failures do+ output = described_class.new(user).output++ expect(output[:user]).to include(+ id: user.id,+ username: user.username,+ trust_level: user.trust_level,+ staged: false,+ created_at: user.created_at.iso8601,+ )+ expect(output).to match_node_output_schema(described_class)+ end++ it "flags staged users in the payload" do+ staged_user = Fabricate(:user, staged: true)++ expect(described_class.new(staged_user).output[:user]).to include(staged: true)+ end+ end++ describe "#matches?" do+ it "matches regular and staged users" do+ staged_user = Fabricate(:user, staged: true)++ expect(described_class.new(user).matches?(trigger_context({}))).to eq(true)+ expect(described_class.new(staged_user).matches?(trigger_context({}))).to eq(true)+ end+ end++ def trigger_context(parameters)+ DiscourseWorkflows::TriggerNodeContext.new({ "parameters" => parameters })+ end+enddiff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_updated_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_updated_spec.rbnew file mode 100644index 00000000000..348723ce182--- /dev/null+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_updated_spec.rb@@ -0,0 +1,98 @@+# frozen_string_literal: true++RSpec.describe DiscourseWorkflows::Nodes::UserUpdated::V1 do+ fab!(:user)+ fab!(:group) { Fabricate(:group, name: "workflow_updated_grp") }+ fab!(:other_group) { Fabricate(:group, name: "workflow_other_grp") }++ describe ".load_options_context" do+ def load_options(filter: nil)+ context =+ DiscourseWorkflows::LoadOptionsContext.new(+ method_name: "groups",+ filter: filter,+ node_class: described_class,+ )++ described_class.load_options_context(context)+ end++ it "returns groups for the chooser" do+ expect(load_options).to include(+ { id: group.id, name: group.name },+ { id: other_group.id, name: other_group.name },+ )+ end++ it "filters groups by the filter term" do+ expect(load_options(filter: group.name)).to contain_exactly(+ { id: group.id, name: group.name },+ )+ end+ end++ describe "#valid?" do+ it "returns true for a human user" do+ expect(described_class.new(user)).to be_valid+ end++ it "returns false when the user is missing" do+ expect(described_class.new(nil)).not_to be_valid+ end++ it "returns false for bot users" do+ expect(described_class.new(Discourse.system_user)).not_to be_valid+ end+ end++ describe "#user_id" do+ it "returns the updated user ID" do+ expect(described_class.new(user).user_id).to eq(user.id)+ end+ end++ describe "#output" do+ it "returns the user payload", :aggregate_failures do+ output = described_class.new(user).output++ expect(output[:user]).to include(+ id: user.id,+ username: user.username,+ trust_level: user.trust_level,+ staged: false,+ created_at: user.created_at.iso8601,+ )+ expect(output).to match_node_output_schema(described_class)+ end+ end++ describe "#matches?" do+ it "matches regular and staged users by default" do+ staged_user = Fabricate(:user, staged: true)++ expect(described_class.new(user).matches?(trigger_context({}))).to eq(true)+ expect(described_class.new(staged_user).matches?(trigger_context({}))).to eq(true)+ end++ it "matches only users in the selected groups" do+ group.add(user)++ expect(+ described_class.new(user).matches?(trigger_context("group_ids" => [group.id.to_s])),+ ).to eq(true)+ expect(+ described_class.new(user).matches?(trigger_context("group_ids" => [other_group.id.to_s])),+ ).to eq(false)+ end++ it "does not match malformed group filters" do+ expect(described_class.new(user).matches?(trigger_context("group_ids" => ["bogus"]))).to eq(+ false,+ )+ end+ end++ def trigger_context(parameters)+ DiscourseWorkflows::TriggerNodeContext.new({ "parameters" => parameters })+ end+enddiff --git a/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-property-engine-test.js b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-property-engine-test.jsindex 93713e81a50..0b553f0f4fd 100644--- a/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-property-engine-test.js+++ b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-property-engine-test.js@@ -88,6 +88,22 @@ module("Unit | Utility | workflows property engine", function () {propertyLabel("trigger:topic_tag_changed", "include_subcategories"),"Include subcategories");+ assert.strictEqual(+ propertyLabel("trigger:user_updated", "group_ids"),+ "Groups"+ );+ assert.strictEqual(+ propertyDescription("trigger:user_seen", "group_ids"),+ "Only trigger for users in at least one of these groups"+ );+ assert.strictEqual(+ propertyPlaceholder("trigger:user_updated", "group_ids"),+ "All groups"+ );+ assert.strictEqual(+ propertySelectNoneKey("trigger:user_added_to_group", "group_id"),+ "discourse_workflows.property_engine.fields.group_id_placeholder"+ );// node-scoped keys win over the shared scopeassert.strictEqual(@@ -98,6 +114,10 @@ module("Unit | Utility | workflows property engine", function () {propertyDescription("trigger:stale_topic", "category_ids"),"Only consider topics in these categories. Leave empty to match all categories.");+ assert.strictEqual(+ propertyDescription("trigger:post_button", "group_ids"),+ "Only members of at least one of these groups can see and use the button"+ );});test("resolves dynamic value hints for expression fields", function (assert) {