A platform for community discussion. Free, open, simple.
FEATURE: badge granted workflows trigger (#41733)
Joffrey JAFFEUX978e9b2e5dcc
diff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.ymlindex 3728d3f035d..8108904cebe 100644--- a/plugins/discourse-workflows/config/locales/client.en.yml+++ b/plugins/discourse-workflows/config/locales/client.en.yml@@ -216,6 +216,7 @@ en:"trigger:user_added_to_group": "User added to group""trigger:user_removed_from_group": "User removed from group""trigger:reviewable_approved": "Approved reviewable"+ "trigger:badge_granted": "Badge granted""trigger:user_search": "User search""trigger:webhook": "Webhook""trigger:workflow_call": "Workflow call"@@ -262,6 +263,7 @@ en:"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:badge_granted": "Fires when a user is granted a badge""trigger:user_search": "Fires when a user searches the site""trigger:webhook": "Fires when an external service sends a webhook request""trigger:workflow_call": "Fires when another workflow calls this workflow"@@ -711,6 +713,10 @@ en:reviewable_types: "Reviewable types"reviewable_types_description: "Only trigger for these reviewable types"reviewable_types_placeholder: "All types"+ badge_granted:+ badge_id: "Badge"+ badge_id_description: "Only trigger when this badge is granted. Leave blank for any badge."+ badge_id_placeholder: "Any badge"schedule:rule: "Trigger rules"add_rule: "Add rule"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 1f7bfd6ca5f..98571b344e0 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@@ -195,6 +195,7 @@ 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:badge_granted" => "badge award achievement medal granted earned","action:user" =>"user profile bio title trust level lock groups fields lookup edit update",}.freezediff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/badge_granted/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/badge_granted/v1.rbnew file mode 100644index 00000000000..0dae509dbf7--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/badge_granted/v1.rb@@ -0,0 +1,87 @@+# frozen_string_literal: true++module DiscourseWorkflows+ module Nodes+ module BadgeGranted+ class V1 < NodeType+ description(+ name: "trigger:badge_granted",+ version: "1.0",+ defaults: {+ icon: "certificate",+ color: "yellow",+ },+ group: "discourse_triggers",+ events: [:user_badge_granted],+ output_contracts: [{ schema: Schema::BADGE_GRANTED_SCHEMA }],+ properties: {+ badge_id: {+ type: :integer,+ required: false,+ type_options: {+ load_options_method: "badges",+ },+ no_data_expression: true,+ ui: {+ control: :combo_box,+ },+ control_options: {+ value_property: "id",+ name_property: "name",+ filterable: true,+ none: "discourse_workflows.badge_granted.badge_id_placeholder",+ },+ },+ },+ )++ def self.load_options_context(context)+ case context.method_name+ when "badges"+ ::Badge+ .where(enabled: true)+ .order(:name)+ .pluck(:id, :name)+ .select { |_, name| context.matches_filter?(name) }+ .map { |id, name| { id:, name: } }+ end+ end++ def initialize(badge_id, user_id)+ super(parameters: {})+ @badge = ::Badge.find_by(id: badge_id)+ @user = ::User.find_by(id: user_id)+ end++ def valid?+ @badge.present? && @user.present?+ end++ def output+ { user: serialize_user(@user), badge: badge_data }+ end++ def matches?(trigger_ctx)+ badge_id = trigger_ctx.get_node_parameter("badge_id")+ badge_id.blank? || @badge.id == badge_id.to_i+ end++ private++ def badge_data+ {+ id: @badge.id,+ name: @badge.name,+ description: @badge.description.presence,+ badge_type_id: @badge.badge_type_id,+ icon: @badge.icon,+ image_url: @badge.image_url,+ grant_count: @badge.grant_count,+ system: @badge.system?,+ multiple_grant: @badge.multiple_grant?,+ }+ end+ end+ end+ end+enddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/schema.rb b/plugins/discourse-workflows/lib/discourse_workflows/schema.rbindex 890314bc655..5783b77fa5e 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/schema.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/schema.rb@@ -221,6 +221,24 @@ module DiscourseWorkflowsUSER_ADDED_TO_GROUP_SCHEMA = group_membership_event("added")USER_REMOVED_FROM_GROUP_SCHEMA = group_membership_event("removed")+ BADGE_PROPERTIES = JSON.parse(<<~JSON).freeze+ {+ "id": { "type": "integer" },+ "name": { "type": "string" },+ "description": { "type": ["string", "null"] },+ "badge_type_id": { "type": "integer" },+ "icon": { "type": ["string", "null"] },+ "image_url": { "type": ["string", "null"] },+ "grant_count": { "type": "integer" },+ "system": { "type": "boolean" },+ "multiple_grant": { "type": "boolean" }+ }+ JSON++ BADGE_SCHEMA = entity("badge", BADGE_PROPERTIES, "Badge involved in the grant event")+ BADGE_GRANTED_SCHEMA =+ document(USER_SCHEMA.fetch("properties").merge(BADGE_SCHEMA.fetch("properties")))+class << selfdef normalize(schema)return {} if schema.blank?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 3782e5f6e08..ee2741b9a08 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@@ -9,6 +9,8 @@ RSpec.describe DiscourseWorkflows::EventListener dofab!(: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") }+ fab!(:badge) { Fabricate(:badge, name: "Workflow badge") }+ fab!(:other_badge) { Fabricate(:badge, name: "Other workflow badge") }before doSiteSetting.tagging_enabled = true@@ -214,6 +216,35 @@ RSpec.describe DiscourseWorkflows::EventListener doexpect(enqueued_trigger_node_ids).not_to include("type-mismatch")end+ it "only enqueues badge granted workflows matching the badge" do+ create_published_workflow(+ "matching-badge-trigger",+ "trigger:badge_granted",+ configuration: {+ "badge_id" => badge.id.to_s,+ },+ )+ create_published_workflow(+ "badge-mismatch-trigger",+ "trigger:badge_granted",+ configuration: {+ "badge_id" => other_badge.id.to_s,+ },+ )+ create_published_workflow("any-badge-trigger", "trigger:badge_granted")++ BadgeGranter.grant(badge, user, granted_by: admin)++ expect(enqueued_trigger_node_ids).to include("matching-badge-trigger", "any-badge-trigger")+ expect(enqueued_trigger_node_ids).not_to include("badge-mismatch-trigger")++ trigger_data = trigger_data_for("matching-badge-trigger")+ expect(trigger_data).to include(+ "user" => include("id" => user.id, "username" => user.username),+ "badge" => include("id" => badge.id, "name" => badge.name),+ )+ end+it "does not enqueue post edited workflows for replies by default" docreate_post(topic: topic)create_published_workflow("first-post-only", "trigger:post_edited")diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/badge_granted_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/badge_granted_spec.rbnew file mode 100644index 00000000000..5111e046fb4--- /dev/null+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/badge_granted_spec.rb@@ -0,0 +1,90 @@+# frozen_string_literal: true++RSpec.describe DiscourseWorkflows::Nodes::BadgeGranted::V1 do+ fab!(:user)+ fab!(:badge)+ fab!(:other_badge) { Fabricate(:badge, name: "Other badge") }++ describe ".load_options_context" do+ def load_options(filter: nil)+ context =+ DiscourseWorkflows::LoadOptionsContext.new(+ method_name: "badges",+ filter: filter,+ node_class: described_class,+ )++ described_class.load_options_context(context)+ end++ it "returns enabled badges for the chooser" do+ expect(load_options).to include(+ { id: badge.id, name: badge.name },+ { id: other_badge.id, name: other_badge.name },+ )+ end++ it "excludes disabled badges" do+ disabled_badge = Fabricate(:badge, name: "Disabled badge", enabled: false)++ expect(load_options).not_to include({ id: disabled_badge.id, name: disabled_badge.name })+ end++ it "filters badges by the filter term" do+ expect(load_options(filter: "Other badge")).to contain_exactly(+ { id: other_badge.id, name: other_badge.name },+ )+ end+ end++ describe "#valid?" do+ it "returns true when the badge and user exist" do+ expect(described_class.new(badge.id, user.id)).to be_valid+ end++ it "returns false when the badge is missing" do+ expect(described_class.new(nil, user.id)).not_to be_valid+ end++ it "returns false when the user is missing" do+ expect(described_class.new(badge.id, User.maximum(:id).to_i + 1)).not_to be_valid+ end+ end++ describe "#output" do+ it "returns the user and badge payloads", :aggregate_failures do+ output = described_class.new(badge.id, user.id).output++ expect(output[:user]).to include(id: user.id, username: user.username)+ expect(output[:badge]).to include(+ id: badge.id,+ name: badge.name,+ badge_type_id: badge.badge_type_id,+ icon: badge.icon,+ grant_count: badge.grant_count,+ system: false,+ multiple_grant: false,+ )+ expect(output).to match_node_output_schema(described_class)+ end+ end++ describe "#matches?" do+ it "matches any badge when badge_id is blank" do+ trigger = described_class.new(badge.id, user.id)++ expect(trigger.matches?(trigger_context({}))).to eq(true)+ end++ it "matches only the configured badge" do+ trigger = described_class.new(badge.id, user.id)++ expect(trigger.matches?(trigger_context("badge_id" => badge.id.to_s))).to eq(true)+ expect(trigger.matches?(trigger_context("badge_id" => other_badge.id.to_s))).to eq(false)+ end+ end++ def trigger_context(parameters)+ DiscourseWorkflows::TriggerNodeContext.new({ "parameters" => parameters })+ end+end