Skip to content

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

FEATURE: Add approved reviewable workflow trigger (#40517)

Joffrey JAFFEUX10ebbb1583a1
diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/configurators/multi-combo-box.gjs b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/configurators/multi-combo-box.gjs
index 204f9ec3295..2345e6f7c2b 100644
--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/configurators/multi-combo-box.gjs
+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/configurators/multi-combo-box.gjs
@@ -1,4 +1,5 @@
import Component from "@glimmer/component";
+import { hash } from "@ember/helper";
import MultiSelect from "discourse/select-kit/components/multi-select";
import {
formatOptionValue,
@@ -38,6 +39,7 @@ export default class MultiComboBox extends Component {
<MultiSelect
@content={{this.options}}
@value={{this.value}}
+ @options={{hash translatedNone=@placeholder}}
@onChange={{@field.set}}
/>
</ExpressionWrapper>
diff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.yml
index b5e6a6b025b..4af558b00bc 100644
--- a/plugins/discourse-workflows/config/locales/client.en.yml
+++ b/plugins/discourse-workflows/config/locales/client.en.yml
@@ -135,6 +135,7 @@ en:
"trigger:topic_created": "Topic created"
"trigger:topic_category_changed": "Topic category changed"
"trigger:topic_tag_changed": "Topic tag changed"
+ "trigger:reviewable_approved": "Approved reviewable"
"trigger:webhook": "Webhook"
"trigger:manual": "Manual trigger"
"condition:if": "If"
@@ -171,6 +172,7 @@ 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:reviewable_approved": "Fires when a reviewable is approved"
"trigger:webhook": "Fires when an external service sends a webhook request"
"trigger:manual": "Fires when triggered manually by an admin"
"condition:if": "Branch the workflow based on a condition"
@@ -526,6 +528,10 @@ en:
topic_tag_changed:
category_id: "Category"
category_id_description: "Only trigger for topics in this category"
+ reviewable_approved:
+ reviewable_types: "Reviewable types"
+ reviewable_types_description: "Only trigger for these reviewable types"
+ reviewable_types_placeholder: "All types"
schedule:
rule: "Trigger rules"
add_rule: "Add rule"
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_approved/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_approved/v1.rb
new file mode 100644
index 00000000000..1fb35fd18eb
--- /dev/null
+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_approved/v1.rb
@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module DiscourseWorkflows
+ module Nodes
+ module ReviewableApproved
+ class V1 < NodeType
+ description(
+ name: "trigger:reviewable_approved",
+ version: "1.0",
+ defaults: {
+ icon: "user-check",
+ color: "green",
+ },
+ group: "discourse_triggers",
+ events: [:reviewable_transitioned_to],
+ properties: -> do
+ {
+ reviewable_types: {
+ type: :multi_options,
+ required: false,
+ options:
+ reviewable_type_options.map do |option|
+ { value: option[:id], label: option[:name] }
+ end,
+ },
+ }
+ end,
+ )
+
+ def self.load_options_context(context)
+ case context.method_name
+ when "reviewable_types"
+ reviewable_type_options.select { |option| context.matches_filter?(option[:name]) }
+ end
+ end
+
+ def self.reviewable_type_options
+ Reviewable
+ .types
+ .uniq(&:sti_name)
+ .sort_by(&:name)
+ .map { |klass| { id: klass.sti_name, name: klass.name.demodulize.underscore.humanize } }
+ end
+
+ class << self
+ private :reviewable_type_options
+ end
+
+ def initialize(status, reviewable)
+ super(parameters: {})
+ @status = status
+ @reviewable = reviewable
+ end
+
+ def valid?
+ @status.to_s == "approved" && @reviewable.present?
+ end
+
+ def output
+ { reviewable: reviewable_data(@reviewable) }
+ end
+
+ def matches?(trigger_ctx)
+ reviewable_types =
+ Array.wrap(trigger_ctx.get_node_parameter("reviewable_types")).compact_blank
+
+ reviewable_types.empty? || reviewable_types.include?(@reviewable.class.sti_name)
+ end
+
+ private
+
+ def reviewable_data(reviewable)
+ {
+ id: reviewable.id,
+ type: reviewable.type,
+ status: reviewable.status,
+ target_type: reviewable.target_type,
+ target_id: reviewable.target_id,
+ topic_id: reviewable.topic_id,
+ category_id: reviewable.category_id,
+ score: reviewable.score,
+ created_at: reviewable.created_at&.iso8601,
+ }
+ end
+ end
+ end
+ end
+end
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 19f2b2fd41f..6acdcd29b2e 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
@@ -168,6 +168,29 @@ RSpec.describe DiscourseWorkflows::EventListener do
expect(enqueued_trigger_node_ids).not_to include("trust-level-mismatch", "tag-mismatch")
end
+ it "only enqueues reviewable approved workflows matching the reviewable type" do
+ create_published_workflow(
+ "matching-trigger",
+ "trigger:reviewable_approved",
+ configuration: {
+ "reviewable_types" => ["ReviewableFlaggedPost"],
+ },
+ )
+ create_published_workflow(
+ "type-mismatch",
+ "trigger:reviewable_approved",
+ configuration: {
+ "reviewable_types" => ["ReviewableUser"],
+ },
+ )
+
+ reviewable = Fabricate(:reviewable_flagged_post)
+ described_class.handle(DiscourseWorkflows::Nodes::ReviewableApproved::V1, :approved, reviewable)
+
+ expect(enqueued_trigger_node_ids).to include("matching-trigger")
+ expect(enqueued_trigger_node_ids).not_to include("type-mismatch")
+ end
+
it "does not enqueue post edited workflows for replies by default" do
create_post(topic: topic)
create_published_workflow("first-post-only", "trigger:post_edited")
diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/reviewable_approved_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/reviewable_approved_spec.rb
new file mode 100644
index 00000000000..c20119d717a
--- /dev/null
+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/reviewable_approved_spec.rb
@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+RSpec.describe DiscourseWorkflows::Nodes::ReviewableApproved::V1 do
+ fab!(:reviewable, :reviewable_flagged_post)
+
+ describe ".property_schema" do
+ it "includes reviewable type options for the multi-select control" do
+ expect(described_class.property_schema.dig(:reviewable_types, :options)).to include(
+ { value: "ReviewableFlaggedPost", label: "Reviewable flagged post" },
+ )
+ end
+ end
+
+ describe ".load_options_context" do
+ it "returns core and plugin reviewable types" do
+ plugin_instance = Plugin::Instance.new
+ plugin_reviewable_type =
+ Class.new(Reviewable) do
+ def self.name
+ "CustomReviewableType"
+ end
+ end
+
+ plugin_instance.register_reviewable_type(plugin_reviewable_type)
+
+ context =
+ DiscourseWorkflows::LoadOptionsContext.new(
+ method_name: "reviewable_types",
+ filter: "reviewable",
+ )
+
+ expect(described_class.load_options_context(context)).to include(
+ { id: "ReviewableFlaggedPost", name: "Reviewable flagged post" },
+ { id: "CustomReviewableType", name: "Custom reviewable type" },
+ )
+ ensure
+ DiscoursePluginRegistry._raw_reviewable_types.reject! do |entry|
+ entry[:value] == plugin_reviewable_type
+ end
+ end
+ end
+
+ describe "#valid?" do
+ it "returns true when a reviewable is approved" do
+ trigger = described_class.new(:approved, reviewable)
+
+ expect(trigger).to be_valid
+ end
+
+ it "returns false for other reviewable transitions" do
+ trigger = described_class.new(:rejected, reviewable)
+
+ expect(trigger).not_to be_valid
+ end
+
+ it "returns false when the reviewable is missing" do
+ trigger = described_class.new(:approved, nil)
+
+ expect(trigger).not_to be_valid
+ end
+ end
+
+ describe "#output" do
+ it "returns reviewable data only" do
+ reviewable.update!(status: :approved)
+ trigger = described_class.new(:approved, reviewable)
+
+ expect(trigger.output).to eq(
+ reviewable: {
+ id: reviewable.id,
+ type: "ReviewableFlaggedPost",
+ status: "approved",
+ target_type: "Post",
+ target_id: reviewable.target_id,
+ topic_id: reviewable.topic_id,
+ category_id: reviewable.category_id,
+ score: reviewable.score,
+ created_at: reviewable.created_at.iso8601,
+ },
+ )
+ end
+ end
+
+ describe "#matches?" do
+ it "returns true when reviewable types are blank" do
+ trigger = described_class.new(:approved, reviewable)
+
+ expect(trigger.matches?(trigger_context({}))).to eq(true)
+ end
+
+ it "matches configured reviewable types by STI name" do
+ trigger = described_class.new(:approved, reviewable)
+
+ expect(
+ trigger.matches?(trigger_context("reviewable_types" => ["ReviewableFlaggedPost"])),
+ ).to eq(true)
+ expect(trigger.matches?(trigger_context("reviewable_types" => ["ReviewableUser"]))).to eq(
+ false,
+ )
+ end
+ end
+
+ def trigger_context(parameters)
+ DiscourseWorkflows::TriggerNodeContext.new({ "parameters" => parameters })
+ end
+end
diff --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.js
index 8af776f8beb..384250897d4 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
@@ -61,6 +61,10 @@ module("Unit | Utility | workflows property engine", function () {
propertyPlaceholder("trigger:webhook", "path"),
"my-webhook"
);
+ assert.strictEqual(
+ propertyPlaceholder("trigger:reviewable_approved", "reviewable_types"),
+ "All types"
+ );
});
test("resolves dynamic value hints for expression fields", function (assert) {