Skip to content

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

FEATURE: Store workflow review-agent attribution in a table (#44474)

Samdf4df7a97bd6
diff --git a/db/structure.sql b/db/structure.sql
index 9114f28b1b5..47f0e51d253 100644
--- a/db/structure.sql
+++ b/db/structure.sql
@@ -5467,6 +5467,37 @@ CREATE SEQUENCE public.discourse_workflows_executions_id_seq
ALTER SEQUENCE public.discourse_workflows_executions_id_seq OWNED BY public.discourse_workflows_executions.id;
+--
+-- Name: discourse_workflows_reviewable_agents; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.discourse_workflows_reviewable_agents (
+ id bigint NOT NULL,
+ reviewable_id bigint NOT NULL,
+ ai_agent_id bigint NOT NULL,
+ created_at timestamp(6) without time zone NOT NULL
+);
+
+
+--
+-- Name: discourse_workflows_reviewable_agents_id_seq; Type: SEQUENCE; Schema: public; Owner: -
+--
+
+CREATE SEQUENCE public.discourse_workflows_reviewable_agents_id_seq
+ START WITH 1
+ INCREMENT BY 1
+ NO MINVALUE
+ NO MAXVALUE
+ CACHE 1;
+
+
+--
+-- Name: discourse_workflows_reviewable_agents_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: -
+--
+
+ALTER SEQUENCE public.discourse_workflows_reviewable_agents_id_seq OWNED BY public.discourse_workflows_reviewable_agents.id;
+
+
--
-- Name: discourse_workflows_tags; Type: TABLE; Schema: public; Owner: -
--
@@ -14788,6 +14819,13 @@ ALTER TABLE ONLY public.discourse_workflows_execution_stats ALTER COLUMN id SET
ALTER TABLE ONLY public.discourse_workflows_executions ALTER COLUMN id SET DEFAULT nextval('public.discourse_workflows_executions_id_seq'::regclass);
+--
+-- Name: discourse_workflows_reviewable_agents id; Type: DEFAULT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.discourse_workflows_reviewable_agents ALTER COLUMN id SET DEFAULT nextval('public.discourse_workflows_reviewable_agents_id_seq'::regclass);
+
+
--
-- Name: discourse_workflows_tags id; Type: DEFAULT; Schema: public; Owner: -
--
@@ -17447,6 +17485,14 @@ ALTER TABLE ONLY public.discourse_workflows_executions
ADD CONSTRAINT discourse_workflows_executions_pkey PRIMARY KEY (id);
+--
+-- Name: discourse_workflows_reviewable_agents discourse_workflows_reviewable_agents_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.discourse_workflows_reviewable_agents
+ ADD CONSTRAINT discourse_workflows_reviewable_agents_pkey PRIMARY KEY (id);
+
+
--
-- Name: discourse_workflows_tags discourse_workflows_tags_pkey; Type: CONSTRAINT; Schema: public; Owner: -
--
@@ -19817,6 +19863,20 @@ CREATE INDEX idx_dwf_executions_on_workflow_version_id ON public.discourse_workf
CREATE INDEX idx_dwf_publish_history_on_workflow_created_at_id_desc ON public.discourse_workflows_workflow_publish_history USING btree (workflow_id, created_at DESC, id DESC);
+--
+-- Name: idx_dwf_reviewable_agents_on_agent_reviewable; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX idx_dwf_reviewable_agents_on_agent_reviewable ON public.discourse_workflows_reviewable_agents USING btree (ai_agent_id, reviewable_id);
+
+
+--
+-- Name: idx_dwf_reviewable_agents_on_reviewable_agent; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE UNIQUE INDEX idx_dwf_reviewable_agents_on_reviewable_agent ON public.discourse_workflows_reviewable_agents USING btree (reviewable_id, ai_agent_id);
+
+
--
-- Name: idx_dwf_tags_on_name; Type: INDEX; Schema: public; Owner: -
--
@@ -25648,6 +25708,14 @@ ALTER TABLE ONLY public.poll_votes
ADD CONSTRAINT fk_rails_b64de9b025 FOREIGN KEY (user_id) REFERENCES public.users(id);
+--
+-- Name: discourse_workflows_reviewable_agents fk_rails_bf51f3a32a; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.discourse_workflows_reviewable_agents
+ ADD CONSTRAINT fk_rails_bf51f3a32a FOREIGN KEY (reviewable_id) REFERENCES public.reviewables(id) ON DELETE CASCADE;
+
+
--
-- Name: ai_tool_actions fk_rails_bf8a76772d; Type: FK CONSTRAINT; Schema: public; Owner: -
--
@@ -25735,6 +25803,8 @@ ALTER TABLE ONLY public.ad_plugin_house_ads_groups
SET search_path TO "$user", public;
INSERT INTO "schema_migrations" (version) VALUES
+('20261012021959'),
+('20261012015332'),
('20261009144947'),
('20261009130230'),
('20261009121104'),
diff --git a/plugins/discourse-workflows/USE_CASES.md b/plugins/discourse-workflows/USE_CASES.md
index 290f92eb227..9df44887ae4 100644
--- a/plugins/discourse-workflows/USE_CASES.md
+++ b/plugins/discourse-workflows/USE_CASES.md
@@ -79,7 +79,7 @@ For each run, record:
- Connections leaving `condition:filter` or `condition:if` use `connection_type: "main"`; select the passing branch with `output_index: 0` and the rejected branch with `output_index: 1`.
- Group membership checks should use `action:group` with `operation: check_membership` and the resolved `group_id` instead of Code nodes. Branch with `condition:if` on `$json.group_membership.in_group` when different member and non-member paths are needed.
- Deleting a post is `action:post` with `operation: delete`; `action:flag_post` with `review_delete` is for moderation flows that also need a reviewable. Restoring one is `operation: recover`.
-- Flag post reasons and Flag user notes name the nearest AI Agent on the item's executed input path. Conditions preserve that attribution; merged inputs from different Agents or incomplete item links retain Workflow-only attribution. Successful flags also persist the attributed Agent ID on the reviewable, making that Agent available in the Review Queue Reason filter. Agent filtering survives renames and preserves Workflow filtering and score deduplication. Ambiguous or skipped flags do not add an Agent. This applies to new flags.
+- Flag post reasons and Flag user notes name the nearest AI Agent on the item's executed input path. Conditions preserve that attribution; merged inputs from different Agents or incomplete item links retain Workflow-only attribution. Successful flags persist the attributed Agent ID in a dedicated reviewable-to-agent table, making that Agent available in the Review Queue Reason filter without parsing reviewable content. Agent filtering survives renames and preserves Workflow filtering and score deduplication. Ambiguous or skipped flags do not add an Agent. Existing payload attribution is backfilled only for reviewables with Workflow score provenance; historical data does not establish individual Workflow–Agent pairings.
- `trigger:post_destroyed` and `trigger:post_recovered` expose `$json.user` as the acting moderator, not the post author; use `$json.post.username` for the author.
- DM/personal-message notifications should use `action:send_personal_message` instead of chat or topic reply nodes. Only an explicit chat DM uses `action:send_chat_message` with `target: "user"` (or `"group"` for one group DM).
- Forum `search`/`read` should not be used for node/schema discovery; use `workflow_node_catalog` and `workflow_validate_patch`.
diff --git a/plugins/discourse-workflows/app/models/discourse_workflows/reviewable_agent.rb b/plugins/discourse-workflows/app/models/discourse_workflows/reviewable_agent.rb
new file mode 100644
index 00000000000..d902426c066
--- /dev/null
+++ b/plugins/discourse-workflows/app/models/discourse_workflows/reviewable_agent.rb
@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module DiscourseWorkflows
+ class ReviewableAgent < ActiveRecord::Base
+ self.table_name = "discourse_workflows_reviewable_agents"
+
+ belongs_to :reviewable, class_name: "::Reviewable"
+ end
+end
+
+# == Schema Information
+#
+# Table name: discourse_workflows_reviewable_agents
+#
+# id :bigint not null, primary key
+# created_at :datetime not null
+# ai_agent_id :bigint not null
+# reviewable_id :bigint not null
+#
+# Indexes
+#
+# idx_dwf_reviewable_agents_on_agent_reviewable (ai_agent_id,reviewable_id)
+# idx_dwf_reviewable_agents_on_reviewable_agent (reviewable_id,ai_agent_id) UNIQUE
+#
+# Foreign Keys
+#
+# fk_rails_... (reviewable_id => reviewables.id) ON DELETE => cascade
+#
diff --git a/plugins/discourse-workflows/db/migrate/20261012015332_create_discourse_workflows_reviewable_agents.rb b/plugins/discourse-workflows/db/migrate/20261012015332_create_discourse_workflows_reviewable_agents.rb
new file mode 100644
index 00000000000..b5fd556d8d6
--- /dev/null
+++ b/plugins/discourse-workflows/db/migrate/20261012015332_create_discourse_workflows_reviewable_agents.rb
@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class CreateDiscourseWorkflowsReviewableAgents < ActiveRecord::Migration[8.0]
+ def change
+ create_table :discourse_workflows_reviewable_agents do |table|
+ table.bigint :reviewable_id, null: false
+ table.bigint :ai_agent_id, null: false
+ table.datetime :created_at, null: false
+ end
+
+ add_index :discourse_workflows_reviewable_agents,
+ %i[reviewable_id ai_agent_id],
+ unique: true,
+ name: "idx_dwf_reviewable_agents_on_reviewable_agent"
+ add_index :discourse_workflows_reviewable_agents,
+ %i[ai_agent_id reviewable_id],
+ name: "idx_dwf_reviewable_agents_on_agent_reviewable"
+
+ # Bulk reviewable deletion bypasses model callbacks; cascade avoids an orphan cleanup job.
+ add_foreign_key :discourse_workflows_reviewable_agents, :reviewables, on_delete: :cascade
+ end
+end
diff --git a/plugins/discourse-workflows/db/post_migrate/20261012021959_backfill_discourse_workflows_reviewable_agents.rb b/plugins/discourse-workflows/db/post_migrate/20261012021959_backfill_discourse_workflows_reviewable_agents.rb
new file mode 100644
index 00000000000..b75d5caef3d
--- /dev/null
+++ b/plugins/discourse-workflows/db/post_migrate/20261012021959_backfill_discourse_workflows_reviewable_agents.rb
@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "json"
+
+class BackfillDiscourseWorkflowsReviewableAgents < ActiveRecord::Migration[8.0]
+ disable_ddl_transaction!
+
+ BATCH_SIZE = 1_000
+ MIN_BIGINT = -9_223_372_036_854_775_808
+ MAX_BIGINT = 9_223_372_036_854_775_807
+
+ def up
+ return if !Migration::Helpers.existing_site?
+
+ last_id = 0
+ max_id = DB.query_single("SELECT COALESCE(MAX(id), 0) FROM reviewables").first
+
+ loop do
+ rows =
+ DB.query(
+ <<~SQL,
+ SELECT reviewables.id, reviewables.payload::text AS raw_payload
+ FROM reviewables
+ WHERE reviewables.id > :last_id AND reviewables.id <= :max_id
+ AND EXISTS (
+ SELECT 1
+ FROM reviewable_scores
+ WHERE reviewable_scores.reviewable_id = reviewables.id
+ AND reviewable_scores.context LIKE :workflow_context ESCAPE '!'
+ )
+ ORDER BY reviewables.id
+ LIMIT :batch_size
+ SQL
+ last_id:,
+ max_id:,
+ batch_size: BATCH_SIZE,
+ workflow_context: "discourse!_workflows:workflow:%",
+ )
+ break if rows.empty?
+
+ reviewable_ids = []
+ agent_ids = []
+ rows.each do |row|
+ legacy_agent_ids(row.raw_payload).each do |agent_id|
+ reviewable_ids << row.id
+ agent_ids << agent_id
+ end
+ end
+
+ DB.exec(<<~SQL, reviewable_ids:, agent_ids:) if agent_ids.present?
+ INSERT INTO discourse_workflows_reviewable_agents (reviewable_id, ai_agent_id, created_at)
+ SELECT reviewables.id, attribution.ai_agent_id, CURRENT_TIMESTAMP
+ FROM unnest(ARRAY[:reviewable_ids]::bigint[], ARRAY[:agent_ids]::bigint[])
+ AS attribution(reviewable_id, ai_agent_id)
+ INNER JOIN reviewables ON reviewables.id = attribution.reviewable_id
+ FOR KEY SHARE OF reviewables
+ ON CONFLICT (reviewable_id, ai_agent_id) DO NOTHING
+ SQL
+ last_id = rows.last.id
+ end
+ end
+
+ def down
+ raise ActiveRecord::IrreversibleMigration
+ end
+
+ private
+
+ def legacy_agent_ids(raw_payload)
+ return [] if raw_payload.nil?
+
+ payload = JSON.parse(raw_payload)
+ return [] if !payload.is_a?(Hash)
+
+ ids = payload["workflow_review_agent_ids"]
+ return [] if !ids.is_a?(Array)
+
+ ids
+ .select do |id|
+ id.is_a?(String) && id.length <= 20 && id.match?(/\A-?[1-9][0-9]*\z/) &&
+ id.to_i.between?(MIN_BIGINT, MAX_BIGINT)
+ end
+ .uniq
+ rescue JSON::ParserError
+ []
+ end
+end
diff --git a/plugins/discourse-workflows/plugin.rb b/plugins/discourse-workflows/plugin.rb
index fe579bf6cf6..e758ac7f2f8 100644
--- a/plugins/discourse-workflows/plugin.rb
+++ b/plugins/discourse-workflows/plugin.rb
@@ -26,10 +26,17 @@ module ::DiscourseWorkflows
agent = review_agent(exec_ctx, item_index:)
return if !agent
+ agent_id = agent.fetch("id").to_s
+
reviewable.with_lock do
+ DiscourseWorkflows::ReviewableAgent.insert_all(
+ [{ reviewable_id: reviewable.id, ai_agent_id: agent_id, created_at: Time.current }],
+ unique_by: %i[reviewable_id ai_agent_id],
+ )
+
+ # Keep legacy readers working during the rollback window.
payload = reviewable.payload || {}
agent_ids = Array(payload["workflow_review_agent_ids"])
- agent_id = agent.fetch("id").to_s
next if agent_ids.include?(agent_id)
reviewable.update!(
@@ -141,12 +148,14 @@ after_initialize do
[
:workflow_review_agent_id,
proc do |results, value|
- agent_id = value.to_s[/\A[1-9]\d*\z/]
- next results if !agent_id
+ agent_id = value.to_s
+ next results if !agent_id.match?(/\A-?[1-9][0-9]*\z/)
results.where(
- "(reviewables.payload::jsonb -> 'workflow_review_agent_ids') ? :agent_id",
- agent_id:,
+ id:
+ DiscourseWorkflows::ReviewableAgent.where(ai_agent_id: agent_id.to_i).select(
+ :reviewable_id,
+ ),
)
end,
],
@@ -155,10 +164,9 @@ after_initialize do
AiAgent
.where(<<~SQL)
- id IN (
- SELECT json_array_elements_text(payload -> 'workflow_review_agent_ids')::bigint
- FROM reviewables
- WHERE payload -> 'workflow_review_agent_ids' IS NOT NULL
+ EXISTS (
+ SELECT 1 FROM discourse_workflows_reviewable_agents
+ WHERE discourse_workflows_reviewable_agents.ai_agent_id = ai_agents.id
)
SQL
.order(:name)
diff --git a/plugins/discourse-workflows/spec/db/post_migrate/20261012021959_backfill_discourse_workflows_reviewable_agents_spec.rb b/plugins/discourse-workflows/spec/db/post_migrate/20261012021959_backfill_discourse_workflows_reviewable_agents_spec.rb
new file mode 100644
index 00000000000..669fe55ac33
--- /dev/null
+++ b/plugins/discourse-workflows/spec/db/post_migrate/20261012021959_backfill_discourse_workflows_reviewable_agents_spec.rb
@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require Rails.root.join(
+ "plugins/discourse-workflows/db/post_migrate/20261012021959_backfill_discourse_workflows_reviewable_agents.rb",
+ )
+
+RSpec.describe BackfillDiscourseWorkflowsReviewableAgents do
+ fab!(:workflow, :discourse_workflows_workflow)
+ fab!(:reviewable, :reviewable_flagged_post)
+ fab!(:unrelated_reviewable, :reviewable_queued_post)
+
+ before do
+ @original_verbose = ActiveRecord::Migration.verbose
+ ActiveRecord::Migration.verbose = false
+ DB.exec("UPDATE schema_migration_details SET created_at = NOW() - INTERVAL '2 hours'")
+ Discourse.clear_site_creation_date_cache
+ reviewable.add_score(
+ Discourse.system_user,
+ ReviewableScore.types[:needs_approval],
+ context: "discourse_workflows:workflow:#{workflow.id}",
+ force_review: true,
+ )
+ end
+
+ after do
+ ActiveRecord::Migration.verbose = @original_verbose
+ Discourse.clear_site_creation_date_cache
+ end
+
+ it "backfills canonical historical IDs across statuses without reading unrelated payloads" do
+ raw = "Actual null: \u0000. Literal escape: \\u0000. Unicode: café."
+ payload = {
+ raw: raw,
+ workflow_review_agent_ids: [
+ "42",
+ "42",
+ "9223372036854775807",
+ "9223372036854775808",
+ "1" * 100,
+ "0",
+ "-1",
+ "-9223372036854775808",
+ "-9223372036854775809",
+ "-0",
+ "-01",
+ "01",
+ "garbage",
+ 43,
+ nil,
+ {},
+ ],
+ }
+ reviewable.update!(payload: payload, status: Reviewable.statuses[:approved])
+ unrelated_reviewable.update!(
+ payload: {
+ raw: "unrelated \u0000",
+ workflow_review_agent_ids: ["99"],
+ },
+ )
+ DiscourseWorkflows::ReviewableAgent.create!(reviewable_id: reviewable.id, ai_agent_id: 42)
+
+ 2.times { described_class.new.up }
+
+ expect(
+ DiscourseWorkflows::ReviewableAgent.pluck(:reviewable_id, :ai_agent_id),
+ ).to contain_exactly(
+ [reviewable.id, 42],
+ [reviewable.id, -1],
+ [reviewable.id, -9_223_372_036_854_775_808],
+ [reviewable.id, 9_223_372_036_854_775_807],
+ )
+ expect(reviewable.reload.payload).to eq(payload.deep_stringify_keys)
+ end
+
+ it "skips malformed attribution shapes and continues to later batches" do
+ malformed =
+ [nil, "42", 42, { id: "42" }].map do |ids|
+ record = Fabricate(:reviewable_flagged_post, payload: { workflow_review_agent_ids: ids })
+ record.add_score(
+ Discourse.system_user,
+ ReviewableScore.types[:needs_approval],
+ context: "discourse_workflows:workflow:#{workflow.id}",
+ force_review: true,
+ )
+ record
+ end
+ valid_reviewable =
+ Fabricate(:reviewable_flagged_post, payload: { workflow_review_agent_ids: ["42"] })
+ valid_reviewable.add_score(
+ Discourse.system_user,
+ ReviewableScore.types[:needs_approval],
+ context: "discourse_workflows:workflow:#{workflow.id}",
+ force_review: true,
+ )
+
+ stub_const(described_class, :BATCH_SIZE, 2) { described_class.new.up }
+
+ expect(DiscourseWorkflows::ReviewableAgent.pluck(:reviewable_id, :ai_agent_id)).to eq(
+ [[valid_reviewable.id, 42]],
+ )
+ expect(
+ DiscourseWorkflows::ReviewableAgent.where(reviewable_id: malformed.map(&:id)),
+ ).to be_empty
+ end
+
+ it "ignores lookalike workflow score prefixes" do
+ unrelated_reviewable.update!(payload: { workflow_review_agent_ids: ["99"] })
+ unrelated_reviewable.add_score(
+ Discourse.system_user,
+ ReviewableScore.types[:needs_approval],
+ context: "discourseXworkflows:workflow:#{workflow.id}",
+ force_review: true,
+ )
+
+ described_class.new.up
+
+ expect(DiscourseWorkflows::ReviewableAgent.count).to eq(0)
+ end
+
+ it "skips reviewables deleted after their payloads were read" do
+ reviewable.update!(payload: { workflow_review_agent_ids: ["42"] })
+ deleted = false
+ allow(DB).to receive(:query).and_wrap_original do |query, *args, **kwargs|
+ rows = query.call(*args, **kwargs)
+ if !deleted
+ Reviewable.where(id: reviewable.id).delete_all
+ deleted = true
+ end
+ rows
+ end
+
+ described_class.new.up
+
+ expect(DiscourseWorkflows::ReviewableAgent.count).to eq(0)
+ end
+
+ it "does not backfill application rows on a fresh install" do
+ DB.exec("UPDATE schema_migration_details SET created_at = NOW()")
+ Discourse.clear_site_creation_date_cache
+ reviewable.update!(payload: { workflow_review_agent_ids: ["42"] })
+
+ described_class.new.up
+
+ expect(DiscourseWorkflows::ReviewableAgent.count).to eq(0)
+ end
+end
diff --git a/plugins/discourse-workflows/spec/integration/ai_agent_review_attribution_spec.rb b/plugins/discourse-workflows/spec/integration/ai_agent_review_attribution_spec.rb
index 6bf29216ce7..3f1d6c0ddc6 100644
--- a/plugins/discourse-workflows/spec/integration/ai_agent_review_attribution_spec.rb
+++ b/plugins/discourse-workflows/spec/integration/ai_agent_review_attribution_spec.rb
@@ -29,6 +29,45 @@ RSpec.describe "Agent attribution on workflow flags" do
before { SiteSetting.discourse_ai_enabled = true }
+ def attributed_agent_ids(reviewable)
+ DiscourseWorkflows::ReviewableAgent.where(reviewable_id: reviewable.id).pluck(:ai_agent_id)
+ end
+
+ it "attributes flags raised by a built-in agent with a negative ID" do
+ agent = AiAgent.find(DiscourseAi::Agents::Agent.system_agents[DiscourseAi::Agents::General])
+ agent.update!(enabled: true)
+ post = Fabricate(:post)
+ graph =
+ build_workflow_graph do |builder|
+ builder.node "trigger", "trigger:manual"
+ builder.node "agent",
+ "action:ai_agent",
+ configuration: {
+ agent_id: agent.id,
+ llm_model_id: llm.id,
+ prompt: "Check post",
+ }
+ builder.node "flag",
+ "action:flag_post",
+ configuration: {
+ post_id: post.id,
+ flag_type: "review",
+ }
+ builder.chain "trigger", "agent", "flag"
+ end
+ workflow = Fabricate(:discourse_workflows_workflow, published: true, **graph)
+
+ execution =
+ DiscourseAi::Completions::Llm.with_prepared_responses(["Flag this post"]) do
+ DiscourseWorkflows::Executor.new(workflow, "trigger", {}).run
+ end
+
+ expect(execution.status).to eq("success")
+ reviewable = ReviewablePost.find_by!(target: post)
+ expect(attributed_agent_ids(reviewable)).to eq([agent.id])
+ expect(reviewable.payload["workflow_review_agent_ids"]).to eq([agent.id.to_s])
+ end
+
it "preserves agent attribution after a timed wait resumes" do
graph =
build_workflow_graph do |builder|
@@ -71,10 +110,9 @@ RSpec.describe "Agent attribution on workflow flags" do
end
expect(execution.reload.status).to eq("success")
- expect(ReviewablePost.find_by!(target: post).payload["workflow_review_agent_ids"]).to eq(
- [spam_agent.id.to_s],
- )
- expect(ReviewablePost.find_by!(target: post).reviewable_scores.last.reason).to eq(
+ reviewable = ReviewablePost.find_by!(target: post)
+ expect(attributed_agent_ids(reviewable)).to eq([spam_agent.id])
+ expect(reviewable.reviewable_scores.last.reason).to eq(
I18n.t(
"discourse_workflows.flag_post.flagged_by_agent",
agent_name: spam_agent.name,
@@ -121,14 +159,59 @@ RSpec.describe "Agent attribution on workflow flags" do
) { DiscourseWorkflows::Executor.new(workflow, "trigger", { post_id: post.id }).run }
expect(execution.status).to eq("success")
- expect(
- ReviewablePost.find_by!(target: post).payload.to_h["workflow_review_agent_ids"],
- ).to be_nil
- expect(ReviewablePost.find_by!(target: post).reviewable_scores.last.reason).to eq(
+ reviewable = ReviewablePost.find_by!(target: post)
+ expect(attributed_agent_ids(reviewable)).to be_empty
+ expect(reviewable.reviewable_scores.last.reason).to eq(
I18n.t("discourse_workflows.flag_post.flagged_by_workflow", workflow_name: workflow.name),
)
end
+ it "records the attribution once when the same agent flags a post again" do
+ graph =
+ build_workflow_graph do |builder|
+ builder.node "trigger", "trigger:manual"
+ builder.node "agent",
+ "action:ai_agent",
+ configuration: {
+ agent_id: spam_agent.id,
+ prompt: "Check spam",
+ }
+ builder.node "flag",
+ "action:flag_post",
+ configuration: {
+ post_id: "={{ $trigger.post_id }}",
+ flag_type: "review",
+ }
+ builder.chain "trigger", "agent", "flag"
+ end
+ workflow =
+ Fabricate(:discourse_workflows_workflow, name: "Moderation", published: true, **graph)
+ post = Fabricate(:post)
+
+ execution =
+ DiscourseAi::Completions::Llm.with_prepared_responses([{ verdict: "yes" }.to_json]) do
+ DiscourseWorkflows::Executor.new(workflow, "trigger", { post_id: post.id }).run
+ end
+
+ expect(execution.status).to eq("success")
+ reviewable = ReviewablePost.find_by!(target: post)
+ expect(attributed_agent_ids(reviewable)).to eq([spam_agent.id])
+ expect(reviewable.payload["workflow_review_agent_ids"]).to eq([spam_agent.id.to_s])
+
+ expect do
+ DiscourseAi::Completions::Llm.with_prepared_responses([{ verdict: "yes" }.to_json]) do
+ DiscourseWorkflows::Executor.new(workflow, "trigger", { post_id: post.id }).run
+ end
+ end.not_to change { reviewable.reviewable_scores.count }
+
+ expect(attributed_agent_ids(reviewable)).to eq([spam_agent.id])
+
+ reviewable.update!(payload: { raw: "replaced by a legacy process" })
+
+ expect(reviewable.reload.payload["workflow_review_agent_ids"]).to be_nil
+ expect(attributed_agent_ids(reviewable)).to eq([spam_agent.id])
+ end
+
it "adds the agent attribution to a flagged user's provenance note" do
graph =
build_workflow_graph do |builder|
@@ -155,23 +238,22 @@ RSpec.describe "Agent attribution on workflow flags" do
end
expect(execution.status).to eq("success")
- expect(ReviewableUser.find_by!(target: user).payload["workflow_review_agent_ids"]).to eq(
- [spam_agent.id.to_s],
- )
- expect(ReviewableUser.find_by!(target: user).reviewable_notes.last.content).to eq(
+ reviewable = ReviewableUser.find_by!(target: user)
+ expect(attributed_agent_ids(reviewable)).to eq([spam_agent.id])
+ expect(reviewable.reviewable_notes.last.content).to eq(
I18n.t(
"discourse_workflows.flag_user.flagged_by_agent",
agent_name: spam_agent.name,
workflow_name: workflow.name,
),
)
- reviewable = ReviewableUser.find_by!(target: user)
+
expect do
DiscourseAi::Completions::Llm.with_prepared_responses([{ verdict: "yes" }.to_json]) do
DiscourseWorkflows::Executor.new(workflow, "trigger", { username: user.username }).run
end
end.not_to change { reviewable.reviewable_scores.count }
- expect(reviewable.reload.payload["workflow_review_agent_ids"]).to eq([spam_agent.id.to_s])
+ expect(attributed_agent_ids(reviewable)).to eq([spam_agent.id])
graph[:nodes].find { |node| node["id"] == "agent" }["parameters"]["agent_id"] = billing_agent.id
other_workflow = Fabricate(:discourse_workflows_workflow, published: true, **graph)
@@ -179,10 +261,7 @@ RSpec.describe "Agent attribution on workflow flags" do
DiscourseWorkflows::Executor.new(other_workflow, "trigger", { username: user.username }).run
end
- expect(reviewable.reload.payload["workflow_review_agent_ids"]).to contain_exactly(
- spam_agent.id.to_s,
- billing_agent.id.to_s,
- )
+ expect(attributed_agent_ids(reviewable)).to contain_exactly(spam_agent.id, billing_agent.id)
expect(reviewable.reviewable_scores.count).to eq(2)
end
@@ -245,7 +324,7 @@ RSpec.describe "Agent attribution on workflow flags" do
workflow_name: workflow.name,
),
)
- expect(score.reviewable.payload["workflow_review_agent_ids"]).to eq([agent.id.to_s])
+ expect(attributed_agent_ids(score.reviewable)).to eq([agent.id])
expect(score.context).to eq("discourse_workflows:workflow:#{workflow.id}")
end
end
diff --git a/plugins/discourse-workflows/spec/models/discourse_workflows/reviewable_agent_spec.rb b/plugins/discourse-workflows/spec/models/discourse_workflows/reviewable_agent_spec.rb
new file mode 100644
index 00000000000..057274c5689
--- /dev/null
+++ b/plugins/discourse-workflows/spec/models/discourse_workflows/reviewable_agent_spec.rb
@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+RSpec.describe DiscourseWorkflows::ReviewableAgent do
+ fab!(:agent, :ai_agent)
+ fab!(:reviewable, :reviewable_flagged_post)
+
+ it "keeps attribution after its agent is deleted" do
+ described_class.create!(reviewable_id: reviewable.id, ai_agent_id: agent.id)
+
+ agent.destroy!
+
+ expect(described_class.where(reviewable_id: reviewable.id).pluck(:ai_agent_id)).to eq(
+ [agent.id],
+ )
+ end
+
+ it "deletes attribution when its reviewable is destroyed" do
+ other_reviewable = Fabricate(:reviewable_flagged_post)
+ described_class.create!(reviewable_id: reviewable.id, ai_agent_id: agent.id)
+ described_class.create!(reviewable_id: other_reviewable.id, ai_agent_id: agent.id)
+
+ reviewable.destroy!
+
+ expect(described_class.pluck(:reviewable_id)).to eq([other_reviewable.id])
+ end
+
+ it "deletes attribution when its reviewable is bulk-deleted" do
+ other_reviewable = Fabricate(:reviewable_flagged_post)
+ described_class.create!(reviewable_id: reviewable.id, ai_agent_id: agent.id)
+ described_class.create!(reviewable_id: other_reviewable.id, ai_agent_id: agent.id)
+
+ Reviewable.where(id: reviewable.id).delete_all
+
+ expect(described_class.pluck(:reviewable_id)).to eq([other_reviewable.id])
+ end
+end
diff --git a/plugins/discourse-workflows/spec/requests/reviewables_controller_spec.rb b/plugins/discourse-workflows/spec/requests/reviewables_controller_spec.rb
index 49587c3256b..8c20f65e6d3 100644
--- a/plugins/discourse-workflows/spec/requests/reviewables_controller_spec.rb
+++ b/plugins/discourse-workflows/spec/requests/reviewables_controller_spec.rb
@@ -25,6 +25,108 @@ RSpec.describe ReviewablesController do
)
end
+ def attribute_agents(reviewable, *agents)
+ agents.each do |agent|
+ DiscourseWorkflows::ReviewableAgent.create!(
+ reviewable_id: reviewable.id,
+ ai_agent_id: agent.id,
+ )
+ end
+ end
+
+ def listed_reviewable_ids
+ response.parsed_body["reviewables"].map { |reviewable| reviewable["id"] }
+ end
+
+ def agent_reason_option(agent)
+ { "id" => "discourse_workflows:agent:#{agent.id}", "name" => agent.name }
+ end
+
+ def agent_filter(agent_id)
+ { additional_filters: { workflow_review_agent_id: agent_id }.to_json }
+ end
+
+ it "lists queued posts whose payload contains a null character" do
+ unrelated_reviewable.update!(
+ payload: {
+ raw: "stringent restrictions. However, given the \u0000 circumstances",
+ },
+ )
+
+ get "/review.json", params: { priority: "low", status: "pending", sort_order: "score" }
+
+ expect(response.status).to eq(200)
+ expect(listed_reviewable_ids).to include(unrelated_reviewable.id)
+ end
+
+ it "offers and filters the attributed agent through both entry points when payloads contain null characters" do
+ agent = Fabricate(:ai_agent)
+ raw = "Actual null: \u0000. Literal escape: \\u0000. Unicode: café."
+ user_reviewable.update!(payload: { raw: raw })
+ unrelated_reviewable.update!(payload: { raw: "unrelated \u0000" })
+ attribute_agents(user_reviewable, agent)
+
+ [
+ {
+ type: "discourse_workflows:workflow",
+ score_type: "discourse_workflows:agent:#{agent.id}",
+ },
+ { type: "discourse_workflows:workflow" }.merge(agent_filter(agent.id)),
+ ].each do |params|
+ get "/review.json", params: params
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body.dig("meta", "score_types")).to include(
+ agent_reason_option(agent),
+ )
+ expect(listed_reviewable_ids).to eq([user_reviewable.id])
+ end
+
+ expect(user_reviewable.reload.payload["raw"]).to eq(raw)
+ end
+
+ it "offers and filters a built-in agent with a negative ID through both entry points" do
+ agent = AiAgent.find(DiscourseAi::Agents::Agent.system_agents[DiscourseAi::Agents::General])
+ attribute_agents(user_reviewable, agent)
+
+ [
+ { score_type: "discourse_workflows:agent:#{agent.id}" },
+ agent_filter(agent.id),
+ ].each do |params|
+ get "/review.json", params: params
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body.dig("meta", "score_types")).to include(
+ agent_reason_option(agent),
+ )
+ expect(listed_reviewable_ids).to eq([user_reviewable.id])
+ end
+ end
+
+ it "does not treat payload agent IDs as attribution" do
+ agent = Fabricate(:ai_agent)
+ legacy_reviewable =
+ Fabricate(:reviewable_flagged_post, payload: { workflow_review_agent_ids: [agent.id.to_s] })
+ legacy_reviewable.add_score(
+ Discourse.system_user,
+ ReviewableScore.types[:needs_approval],
+ context: "discourse_workflows:workflow:#{workflow.id}",
+ force_review: true,
+ )
+
+ get "/review.json", params: agent_filter(agent.id)
+
+ expect(response.status).to eq(200)
+ expect(listed_reviewable_ids).to be_empty
+
+ get "/review.json"
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body.dig("meta", "score_types")).not_to include(
+ agent_reason_option(agent),
+ )
+ end
+
it "adds workflows to Type and current workflow names to Reason" do
workflow.update!(name: "Renamed workflow")
@@ -46,24 +148,18 @@ RSpec.describe ReviewablesController do
it "offers successfully attributed agents and filters posts and users after an agent rename" do
agent = Fabricate(:ai_agent)
other_agent = Fabricate(:ai_agent)
- post_reviewable.update!(payload: { "workflow_review_agent_ids" => [agent.id.to_s] })
- user_reviewable.update!(
- payload: {
- "workflow_review_agent_ids" => [agent.id.to_s, other_agent.id.to_s],
- },
- )
+ attribute_agents(post_reviewable, agent)
+ attribute_agents(user_reviewable, agent, other_agent)
agent.update!(name: "Renamed agent")
get "/review.json", params: { score_type: "discourse_workflows:agent:#{agent.id}" }
expect(response.status).to eq(200)
expect(response.parsed_body.dig("meta", "score_types")).to include(
- { "id" => "discourse_workflows:agent:#{agent.id}", "name" => agent.name },
- { "id" => "discourse_workflows:agent:#{other_agent.id}", "name" => other_agent.name },
+ agent_reason_option(agent),
+ agent_reason_option(other_agent),
)
- expect(
- response.parsed_body["reviewables"].map { |reviewable| reviewable["id"] },
- ).to contain_exactly(post_reviewable.id, user_reviewable.id)
+ expect(listed_reviewable_ids).to contain_exactly(post_reviewable.id, user_reviewable.id)
get "/review.json",
params: {
@@ -72,40 +168,101 @@ RSpec.describe ReviewablesController do
}
expect(response.status).to eq(200)
- expect(response.parsed_body["reviewables"].map { |reviewable| reviewable["id"] }).to eq(
- [user_reviewable.id],
- )
+ expect(listed_reviewable_ids).to eq([user_reviewable.id])
SiteSetting.enable_discourse_workflows = false
get "/review.json"
expect(response.parsed_body.dig("meta", "score_types")).not_to include(
- { "id" => "discourse_workflows:agent:#{agent.id}", "name" => agent.name },
+ agent_reason_option(agent),
)
end
- it "omits agents without successful workflow flags from Reason" do
+ it "offers and filters an attributed agent for reviewables in any status" do
agent = Fabricate(:ai_agent)
+ attribute_agents(user_reviewable, agent)
+ user_reviewable.update!(status: Reviewable.statuses[:approved])
+
+ get "/review.json"
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body.dig("meta", "score_types")).to include(agent_reason_option(agent))
+
+ get "/review.json",
+ params: {
+ status: "approved",
+ score_type: "discourse_workflows:agent:#{agent.id}",
+ }
+
+ expect(response.status).to eq(200)
+ expect(listed_reviewable_ids).to eq([user_reviewable.id])
+ end
+
+ it "hides a deleted agent from Reason but keeps its historical attribution filterable" do
+ agent = Fabricate(:ai_agent)
+ attribute_agents(user_reviewable, agent)
+ agent.destroy!
get "/review.json"
expect(response.status).to eq(200)
expect(response.parsed_body.dig("meta", "score_types")).not_to include(
- { "id" => "discourse_workflows:agent:#{agent.id}", "name" => agent.name },
+ agent_reason_option(agent),
)
+
+ get "/review.json", params: agent_filter(agent.id)
+
+ expect(response.status).to eq(200)
+ expect(listed_reviewable_ids).to eq([user_reviewable.id])
+ end
+
+ it "ignores attributed agents whose reviewables were bulk-deleted" do
+ agent = Fabricate(:ai_agent)
+ reviewable = Fabricate(:reviewable_flagged_post)
+ attribute_agents(reviewable, agent)
+ Reviewable.where(id: reviewable.id).delete_all
+
+ get "/review.json"
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body.dig("meta", "score_types")).not_to include(
+ agent_reason_option(agent),
+ )
+
+ get "/review.json", params: agent_filter(agent.id)
+
+ expect(response.status).to eq(200)
+ expect(listed_reviewable_ids).to be_empty
+ end
+
+ it "returns no matches for absent or out-of-range agent IDs" do
+ agent = Fabricate(:ai_agent)
+ attribute_agents(user_reviewable, agent)
+
+ [
+ "9223372036854775807",
+ "9223372036854775808",
+ "-9223372036854775808",
+ "-9223372036854775809",
+ "1" * 30,
+ ].each do |agent_id|
+ get "/review.json", params: agent_filter(agent_id)
+
+ expect(response.status).to eq(200)
+ expect(listed_reviewable_ids).to be_empty
+ end
end
it "ignores malformed agent IDs" do
[true, [1], { id: 1 }, 0, 1.9, "1 OR 1=1 --"].each do |agent_id|
- get "/review.json",
- params: {
- additional_filters: { workflow_review_agent_id: agent_id }.to_json,
- }
+ get "/review.json", params: agent_filter(agent_id)
expect(response.status).to eq(200)
- expect(
- response.parsed_body["reviewables"].map { |reviewable| reviewable["id"] },
- ).to contain_exactly(post_reviewable.id, user_reviewable.id, unrelated_reviewable.id)
+ expect(listed_reviewable_ids).to contain_exactly(
+ post_reviewable.id,
+ user_reviewable.id,
+ unrelated_reviewable.id,
+ )
end
end
@@ -113,9 +270,7 @@ RSpec.describe ReviewablesController do
get "/review.json", params: { type: "discourse_workflows:workflow" }
expect(response.status).to eq(200)
- expect(
- response.parsed_body["reviewables"].map { |reviewable| reviewable["id"] },
- ).to contain_exactly(post_reviewable.id, user_reviewable.id)
+ expect(listed_reviewable_ids).to contain_exactly(post_reviewable.id, user_reviewable.id)
end
it "filters by workflow Reason after the workflow is renamed" do
@@ -128,9 +283,7 @@ RSpec.describe ReviewablesController do
}
expect(response.status).to eq(200)
- expect(response.parsed_body["reviewables"].map { |reviewable| reviewable["id"] }).to eq(
- [post_reviewable.id],
- )
+ expect(listed_reviewable_ids).to eq([post_reviewable.id])
get "/review.json",
params: {
@@ -138,9 +291,7 @@ RSpec.describe ReviewablesController do
}
expect(response.status).to eq(200)
- expect(response.parsed_body["reviewables"].map { |reviewable| reviewable["id"] }).to eq(
- [user_reviewable.id],
- )
+ expect(listed_reviewable_ids).to eq([user_reviewable.id])
end
it "filters AI workflow flags after moving from AI Automation", :aggregate_failures do
@@ -221,10 +372,7 @@ RSpec.describe ReviewablesController do
}
expect(response.status).to eq(200)
- expect(response.parsed_body["reviewables"].map { |item| item["id"] }).to contain_exactly(
- fresh_reviewable.id,
- previous_reviewable.id,
- )
+ expect(listed_reviewable_ids).to contain_exactly(fresh_reviewable.id, previous_reviewable.id)
get "/review.json",
params: {
@@ -233,9 +381,7 @@ RSpec.describe ReviewablesController do
}
expect(response.status).to eq(200)
- expect(response.parsed_body["reviewables"].map { |item| item["id"] }).to eq(
- [previous_reviewable.id],
- )
+ expect(listed_reviewable_ids).to eq([previous_reviewable.id])
expect do
DiscourseAi::Completions::Llm.with_prepared_responses([{ verdict: "reject" }.to_json]) do
@@ -268,9 +414,11 @@ RSpec.describe ReviewablesController do
get "/review.json", params: { additional_filters: { workflow_id: }.to_json }
expect(response.status).to eq(200)
- expect(
- response.parsed_body["reviewables"].map { |reviewable| reviewable["id"] },
- ).to contain_exactly(post_reviewable.id, user_reviewable.id, unrelated_reviewable.id)
+ expect(listed_reviewable_ids).to contain_exactly(
+ post_reviewable.id,
+ user_reviewable.id,
+ unrelated_reviewable.id,
+ )
end
end
end