A platform for community discussion. Free, open, simple.
FEATURE: Expose review outcomes as workflow building blocks
Régis Hanol40d0ae52ae03
diff --git a/plugins/discourse-workflows/USE_CASES.md b/plugins/discourse-workflows/USE_CASES.mdindex 20a0b1a728d..984acd32b7c 100644--- a/plugins/discourse-workflows/USE_CASES.md+++ b/plugins/discourse-workflows/USE_CASES.md@@ -62,6 +62,8 @@ For each run, record:- `trigger:topic_timer_changed` exposes `change` (`created`, `updated`, `cancelled`, `completed`), `timer`, and `previous_timer`. Its timer-type filter matches either the previous or current type; inspect `timer.status_type` when handling replacement of a publication timer with another timer type.- `trigger:topic_published` and completed publication timers expose the topic in its destination category. Use `trigger:topic_timer_changed` for scheduling and cancellation, and `trigger:topic_published` for publication cleanup.- Topic status triggers are separate nodes: `topic_closed`, `topic_reopened`, `topic_archived`, `topic_unarchived`, `topic_listed`, `topic_unlisted`, `topic_pinned`, `topic_unpinned`, `topic_pinned_globally`, and `topic_unpinned_globally` (all prefixed with `trigger:`). They share category and tag filters. Closing includes automatic closes; unpin events use the previous pin scope. Workflow and AI actions use the same status updater.+- Review outcome triggers are `trigger:reviewable_approved`, `trigger:reviewable_rejected`, `trigger:reviewable_ignored`, `trigger:reviewable_deleted`, and `trigger:reviewable_pending`. They share the reviewable-type filter. Pending handles an existing item returning to review; use `trigger:reviewable_created` for new items.+- Connect multiple event triggers to the same downstream node to handle several events. Existing `trigger:topic_status_changed` and `trigger:reviewable_status_changed` nodes remain editable and executable, but are hidden from the picker and AI discovery. Fixed-event nodes have no status selector and ignore any supplied `statuses` configuration.- Topic-only triggers that need author/post fields should use `action:topic` get before filtering or messaging.- Generic prompts like "when someone posts" should use `trigger:post_created` for all regular posts; do not ask whether to include replies unless the prompt explicitly narrows the scope.- Actions that replace item JSON require downstream nodes to use the action output schema, not the original trigger schema.diff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.ymlindex f7881e93cbd..3478fc63136 100644--- a/plugins/discourse-workflows/config/locales/client.en.yml+++ b/plugins/discourse-workflows/config/locales/client.en.yml@@ -217,6 +217,7 @@ en:"trigger:topic_published": "Topic published""trigger:topic_timer_changed": "Topic timer changed""trigger:topic_status_changed": "Topic status changed"+ "trigger:reviewable_status_changed": "Review outcome changed""trigger:topic_closed": "Topic closed""trigger:topic_reopened": "Topic reopened""trigger:topic_archived": "Topic archived"@@ -241,7 +242,11 @@ en:"trigger:user_created": "User created""trigger:user_updated": "User updated""trigger:reviewable_created": "New reviewable"- "trigger:reviewable_approved": "Approved reviewable"+ "trigger:reviewable_approved": "Review item approved"+ "trigger:reviewable_rejected": "Review item rejected"+ "trigger:reviewable_ignored": "Review item ignored"+ "trigger:reviewable_deleted": "Review item deleted"+ "trigger:reviewable_pending": "Review item returned to pending""trigger:badge_granted": "Badge granted""trigger:user_search": "User search""trigger:user_seen": "User seen"@@ -292,6 +297,7 @@ en:"trigger:topic_published": "Fires when a topic is published""trigger:topic_timer_changed": "Fires when a topic timer is created, updated, cancelled, or completed""trigger:topic_status_changed": "Fires when a topic is closed, reopened, archived, listed, or pinned, or those changes are reversed"+ "trigger:reviewable_status_changed": "Fires when an item's status changes in the review queue""trigger:topic_closed": "Fires when a topic is closed by a user or auto-close timer""trigger:topic_reopened": "Fires when a topic is reopened""trigger:topic_archived": "Fires when a topic is archived"@@ -316,7 +322,11 @@ en:"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_created": "Fires when a new item is added to the review queue"- "trigger:reviewable_approved": "Fires when a reviewable is approved"+ "trigger:reviewable_approved": "Fires when a review item is approved"+ "trigger:reviewable_rejected": "Fires when a review item is rejected"+ "trigger:reviewable_ignored": "Fires when a review item is ignored"+ "trigger:reviewable_deleted": "Fires when a review item is marked deleted"+ "trigger:reviewable_pending": "Fires when an existing review item returns to pending""trigger:badge_granted": "Fires when a user is granted a badge""trigger:user_search": "Fires when a user searches the site""trigger:user_seen": "Fires when a user is seen"@@ -920,6 +930,15 @@ en:statuses_unpinned_globally: "Unpinned globally"tag_names: "Tags"tag_names_description: "Only trigger for topics that have at least one of these tags"+ reviewable_status_changed:+ statuses: "Outcomes"+ statuses_description: "Leave empty to match any outcome."+ statuses_placeholder: "Any outcome"+ statuses_pending: "Pending"+ statuses_approved: "Approved"+ statuses_rejected: "Rejected"+ statuses_ignored: "Ignored"+ statuses_deleted: "Deleted"post_created:topic_type: "Topic type"topic_type_description: "Choose whether topics, personal messages, or both should trigger the workflow"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.rbindex 0142ac150cb..fc299a56fb1 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_approved/v1.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_approved/v1.rb@@ -3,29 +3,14 @@module DiscourseWorkflowsmodule Nodesmodule ReviewableApproved- class V1 < NodeType+ class V1 < ReviewableStatusChanged::V1description(- name: "trigger:reviewable_approved",- version: "1.0",- defaults: {- icon: "user-check",- color: "green",- },- group: "discourse_triggers",- event: :reviewable_transitioned_to,- output_contracts: [{ schema: Schema::REVIEWABLE_EVENT_SCHEMA }],- properties: -> do- {- reviewable_types: {- type: :multi_options,- required: false,- options:- reviewable_type_options.map do |option|- { value: option[:id], label: option[:name] }- end,- },- }- end,+ ReviewableStatusChanged::V1.description_for_status("approved").merge(+ defaults: {+ icon: "user-check",+ color: "green",+ },+ ),)def self.load_options_context(context)@@ -35,23 +20,9 @@ module DiscourseWorkflowsendend- 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)- matches_reviewable_types?(@reviewable, trigger_ctx.get_node_parameter("reviewable_types"))- endendendenddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_deleted/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_deleted/v1.rbnew file mode 100644index 00000000000..846e3889890--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_deleted/v1.rb@@ -0,0 +1,11 @@+# frozen_string_literal: true++module DiscourseWorkflows+ module Nodes+ module ReviewableDeleted+ class V1 < ReviewableStatusChanged::V1+ description ReviewableStatusChanged::V1.description_for_status("deleted")+ end+ end+ end+enddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_ignored/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_ignored/v1.rbnew file mode 100644index 00000000000..599693fb441--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_ignored/v1.rb@@ -0,0 +1,11 @@+# frozen_string_literal: true++module DiscourseWorkflows+ module Nodes+ module ReviewableIgnored+ class V1 < ReviewableStatusChanged::V1+ description ReviewableStatusChanged::V1.description_for_status("ignored")+ end+ end+ end+enddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_pending/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_pending/v1.rbnew file mode 100644index 00000000000..cd51f71d61e--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_pending/v1.rb@@ -0,0 +1,11 @@+# frozen_string_literal: true++module DiscourseWorkflows+ module Nodes+ module ReviewablePending+ class V1 < ReviewableStatusChanged::V1+ description ReviewableStatusChanged::V1.description_for_status("pending")+ end+ end+ end+enddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_rejected/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_rejected/v1.rbnew file mode 100644index 00000000000..391293bf6e5--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_rejected/v1.rb@@ -0,0 +1,11 @@+# frozen_string_literal: true++module DiscourseWorkflows+ module Nodes+ module ReviewableRejected+ class V1 < ReviewableStatusChanged::V1+ description ReviewableStatusChanged::V1.description_for_status("rejected")+ end+ end+ end+enddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_status_changed/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_status_changed/v1.rbnew file mode 100644index 00000000000..c8fc5b6449f--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/reviewable_status_changed/v1.rb@@ -0,0 +1,75 @@+# frozen_string_literal: true++module DiscourseWorkflows+ module Nodes+ module ReviewableStatusChanged+ class V1 < NodeType+ description(+ name: "trigger:reviewable_status_changed",+ version: "1.0",+ defaults: {+ icon: "list-check",+ color: "green",+ },+ group: "discourse_triggers",+ palette_visible: false,+ event: :reviewable_transitioned_to,+ output_contracts: [{ schema: Schema::REVIEWABLE_EVENT_SCHEMA }],+ properties: -> do+ {+ statuses: {+ type: :multi_options,+ default: [],+ options: ::Reviewable.statuses.keys,+ },+ reviewable_types: {+ type: :multi_options,+ options:+ reviewable_type_options.map do |option|+ { value: option[:id], label: option[:name] }+ end,+ },+ }+ end,+ )++ def self.description_for_status(status)+ description.merge(+ name: "trigger:reviewable_#{status}",+ fixed_status: status,+ palette_visible: true,+ i18n_scope: "reviewable_status_changed",+ properties: -> { properties.except(:statuses) },+ )+ end++ def initialize(status, reviewable)+ super(parameters: {})+ @status = status.to_s+ @reviewable = reviewable+ end++ def valid?+ fixed_status = self.class.description[:fixed_status]+ @reviewable.present? && ::Reviewable.statuses.key?(@status) &&+ (fixed_status.nil? || fixed_status == @status)+ end++ def output+ { reviewable: reviewable_data(@reviewable).merge(status: @status) }+ end++ def matches?(trigger_ctx)+ statuses =+ Array.wrap(+ self.class.description[:fixed_status] ||+ trigger_ctx.get_node_parameter("statuses", []),+ ).compact_blank+ return false if statuses.present? && statuses.exclude?(@status)++ matches_reviewable_types?(@reviewable, trigger_ctx.get_node_parameter("reviewable_types"))+ end+ end+ end+ end+enddiff --git a/plugins/discourse-workflows/spec/integration/status_event_triggers_spec.rb b/plugins/discourse-workflows/spec/integration/status_event_triggers_spec.rbindex f897aa00d83..11e70fddd44 100644--- a/plugins/discourse-workflows/spec/integration/status_event_triggers_spec.rb+++ b/plugins/discourse-workflows/spec/integration/status_event_triggers_spec.rb@@ -49,6 +49,29 @@ RSpec.describe "Workflow status event triggers" do)end+ it "dispatches rejected reviewables to the matching outcome trigger" do+ reviewable = Fabricate(:reviewable_flagged_post)+ create_workflow("rejected", "trigger:reviewable_status_changed", "statuses" => ["rejected"])+ create_workflow("fixed-rejected", "trigger:reviewable_rejected", "statuses" => ["approved"])+ create_workflow("approved", "trigger:reviewable_approved")++ reviewable.transition_to(:rejected, admin)++ expect(enqueued_jobs.map { |job| job["trigger_node_id"] }).to contain_exactly(+ "rejected",+ "fixed-rejected",+ )+ enqueued_jobs.each do |job|+ expect(job.dig("trigger_data", "reviewable")).to include(+ "id" => reviewable.id,+ "status" => "rejected",+ )+ expect(job["trigger_data"]).to match_node_output_schema(+ DiscourseWorkflows::Nodes::ReviewableStatusChanged::V1,+ )+ end+ end+def create_workflow(trigger_id, trigger_type, configuration = {})graph =build_workflow_graph do |graph_builder|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.rbindex d434a8ba784..cad947d2e62 100644--- 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@@ -40,26 +40,6 @@ RSpec.describe DiscourseWorkflows::Nodes::ReviewableApproved::V1 doendend- 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" doit "returns reviewable data", :aggregate_failures doreviewable.update!(status: :approved)@@ -82,27 +62,4 @@ RSpec.describe DiscourseWorkflows::Nodes::ReviewableApproved::V1 doexpect(output).to match_node_output_schema(described_class)endend-- 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 })- endenddiff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/reviewable_status_changed_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/reviewable_status_changed_spec.rbnew file mode 100644index 00000000000..bb759581420--- /dev/null+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/reviewable_status_changed_spec.rb@@ -0,0 +1,85 @@+# frozen_string_literal: true++RSpec.describe DiscourseWorkflows::Nodes::ReviewableStatusChanged::V1 do+ fab!(:reviewable, :reviewable_flagged_post)++ let(:fixed_triggers) do+ Reviewable.statuses.keys.to_h do |status|+ [status, DiscourseWorkflows::Registry.find_node_type("trigger:reviewable_#{status}")]+ end+ end++ describe ".property_schema" do+ it "exposes fixed outcomes while keeping the generic status selector for existing nodes" do+ expect(described_class.palette_visible?).to eq(false)+ expect(described_class.property_schema).to have_key(:statuses)++ fixed_triggers.each_value do |node_class|+ expect(node_class.palette_visible?).to eq(true)+ expect(node_class.property_schema.keys).to eq([:reviewable_types])+ end+ end+ end++ describe "#valid?" do+ it "accepts every review outcome for existing reviewables" do+ Reviewable.statuses.each_key do |status|+ expect(described_class.new(status, reviewable)).to be_valid+ end++ expect(described_class.new(:unknown, reviewable)).not_to be_valid+ expect(described_class.new(:rejected, nil)).not_to be_valid+ end++ it "restricts each fixed trigger to its outcome" do+ fixed_triggers.each do |outcome, node_class|+ Reviewable.statuses.each_key do |status|+ expect(node_class.new(status, reviewable).valid?).to eq(status == outcome)+ end++ expect(node_class.new(outcome, nil)).not_to be_valid+ end+ end+ end++ describe "#matches?" do+ it "filters by outcome and reviewable type" do+ trigger = described_class.new(:rejected, reviewable)++ expect(trigger.matches?(trigger_context({}))).to eq(true)+ expect(+ trigger.matches?(+ trigger_context(+ "statuses" => ["rejected"],+ "reviewable_types" => ["ReviewableFlaggedPost"],+ ),+ ),+ ).to eq(true)+ expect(trigger.matches?(trigger_context("statuses" => ["approved"]))).to eq(false)+ expect(trigger.matches?(trigger_context("reviewable_types" => ["ReviewableUser"]))).to eq(+ false,+ )+ end++ it "keeps fixed outcomes when statuses are supplied and still filters by reviewable type" do+ fixed_triggers.each do |outcome, node_class|+ trigger = node_class.new(outcome, reviewable)+ statuses = Reviewable.statuses.keys - [outcome]++ expect(trigger.matches?(trigger_context({}))).to eq(true)+ expect(+ trigger.matches?(+ trigger_context("statuses" => statuses, "reviewable_types" => [reviewable.type]),+ ),+ ).to eq(true)+ expect(trigger.matches?(trigger_context("reviewable_types" => ["ReviewableUser"]))).to eq(+ false,+ )+ end+ end+ end++ def trigger_context(parameters)+ DiscourseWorkflows::TriggerNodeContext.new({ "parameters" => parameters })+ end+enddiff --git a/plugins/discourse-workflows/spec/system/page_objects/pages/workflow_editor.rb b/plugins/discourse-workflows/spec/system/page_objects/pages/workflow_editor.rbindex 07eb95e3c09..1e6b8e1ced7 100644--- a/plugins/discourse-workflows/spec/system/page_objects/pages/workflow_editor.rb+++ b/plugins/discourse-workflows/spec/system/page_objects/pages/workflow_editor.rb@@ -118,6 +118,45 @@ module PageObjectspage.has_css?(".workflows-configurator-modal__save-status--saved")end+ def add_status_filter(status)+ selector = PageObjects::Components::SelectKit.new("[data-name='statuses'] .multi-select")+ selector.expand+ selector.select_row_by_value(status)+ self+ end++ def has_status_filter?(status)+ page.has_css?("[data-name='statuses'] .select-kit-header", text: status)+ end++ def filter_topics_by_category(category)+ selector =+ PageObjects::Components::SelectKit.new("[data-name='category_ids'] .category-selector")+ selector.expand+ selector.select_row_by_value(category.id)+ self+ end++ def has_fixed_topic_filters?(category)+ page.has_css?("[data-name='category_ids'] .select-kit-header", text: category.name) &&+ page.has_css?("[data-name='include_subcategories']") &&+ page.has_css?("[data-name='tag_names'] .mini-tag-chooser") &&+ page.has_no_css?("[data-name='statuses']")+ end++ def filter_reviewable_type(type)+ selector =+ PageObjects::Components::SelectKit.new("[data-name='reviewable_types'] .multi-select")+ selector.expand+ selector.select_row_by_value(type)+ self+ end++ def has_fixed_reviewable_filter?(type)+ page.has_css?("[data-name='reviewable_types'] .select-kit-header", text: type) &&+ page.has_no_css?("[data-name='statuses']")+ end+def has_workflow_path?(workflow)page.has_current_path?(workflow_path(workflow))end@@ -161,6 +200,8 @@ module PageObjectsNODE_TYPE_LABELS = {"trigger:topic_closed" => "Topic closed",+ "trigger:topic_reopened" => "Topic reopened",+ "trigger:reviewable_rejected" => "Review item rejected","trigger:post_created" => "Post created","trigger:topic_created" => "Topic created","trigger:webhook" => "Webhook",diff --git a/plugins/discourse-workflows/spec/system/workflows_spec.rb b/plugins/discourse-workflows/spec/system/workflows_spec.rbindex 9e4a3837c88..a74d95e7f68 100644--- a/plugins/discourse-workflows/spec/system/workflows_spec.rb+++ b/plugins/discourse-workflows/spec/system/workflows_spec.rb@@ -82,6 +82,54 @@ RSpec.describe "Discourse Workflows" doexpect(workflows_page).to have_workflow("My workflow")end+ it "lets an admin add fixed event triggers while keeping existing status filters editable" do+ category = Fabricate(:category)+ node_id = "existing-status"+ workflow =+ Fabricate(+ :discourse_workflows_workflow,+ created_by: admin,+ nodes: [+ {+ "id" => node_id,+ "type" => "trigger:topic_status_changed",+ "typeVersion" => "1.0",+ "name" => "Topic status changed",+ "parameters" => {+ "statuses" => ["closed"],+ },+ },+ ],+ )++ editor_page.visit_node(workflow, node_id)+ expect(editor_page).to have_status_filter("Closed")+ editor_page.add_status_filter("reopened")+ expect(editor_page).to have_saved_node_configuration+ page.refresh+ expect(editor_page).to have_status_filter("Reopened")++ editor_page.close_node_configurator+ editor_page.click_add_node+ editor_page.select_node_type("trigger:topic_reopened")+ editor_page.double_click_node(1)+ editor_page.filter_topics_by_category(category)+ expect(editor_page).to have_saved_node_configuration+ page.refresh+ expect(editor_page).to have_node_configurator(name: "Topic reopened")+ expect(editor_page).to have_fixed_topic_filters(category)++ editor_page.close_node_configurator+ editor_page.click_add_node+ editor_page.select_node_type("trigger:reviewable_rejected")+ editor_page.double_click_node(2)+ editor_page.filter_reviewable_type("ReviewableQueuedPost")+ expect(editor_page).to have_saved_node_configuration+ page.refresh+ expect(editor_page).to have_node_configurator(name: "Review item rejected")+ expect(editor_page).to have_fixed_reviewable_filter("Reviewable queued post")+ end+it "renders the failed-run warning icon based on the most recent execution" dofailed_workflow = Fabricate(:discourse_workflows_workflow, created_by: admin)recovered_workflow = Fabricate(:discourse_workflows_workflow, created_by: admin)