A platform for community discussion. Free, open, simple.
FEATURE: adds user-search trigger to workflows (#41423)
Joffrey JAFFEUX11ddfc8de940
diff --git a/lib/search.rb b/lib/search.rbindex 74183df1506..9eb0ab56f93 100644--- a/lib/search.rb+++ b/lib/search.rb@@ -374,6 +374,8 @@ class SearchSearch.preload(@results, self)+ trigger_user_search_event(readonly_mode)+@resultsend@@ -1653,6 +1655,15 @@ class Search@opts[:type_filter] != "exclude_topics"end+ def trigger_user_search_event(readonly_mode)+ return if @clean_term.blank?+ return if @opts[:search_type].blank?+ return if readonly_mode+ return if @opts[:type_filter] == "exclude_topics"++ DiscourseEvent.trigger(:user_search, @clean_term, continue_on_error: true)+ end+def filter_short_terms(term_string)return "" if term_string.blank?diff --git a/plugins/discourse-workflows/app/models/discourse_workflows/workflow_dependency.rb b/plugins/discourse-workflows/app/models/discourse_workflows/workflow_dependency.rbindex 44957548e8b..a70ea352422 100644--- a/plugins/discourse-workflows/app/models/discourse_workflows/workflow_dependency.rb+++ b/plugins/discourse-workflows/app/models/discourse_workflows/workflow_dependency.rb@@ -4,9 +4,7 @@ module DiscourseWorkflowsclass WorkflowDependency < ActiveRecord::Baseself.table_name = "discourse_workflows_workflow_dependencies"- TOPIC_ADMIN_BUTTON_CACHE_KEY = "topic_admin_buttons"- ACTIVE_NODE_TYPES_KEY = "active_node_types"- USER_MODAL_CACHE_KEY = "has_user_modals"+ DEPENDENCY_INDEX_CACHE_KEY = "dependency_index"belongs_to :workflow, class_name: "DiscourseWorkflows::Workflow"belongs_to :workflow_version,@@ -37,30 +35,32 @@ module DiscourseWorkflowsenddef self.cached_topic_admin_buttons- cache.defer_get_set(TOPIC_ADMIN_BUTTON_CACHE_KEY) do- Workflow::Action::FindPublishedTriggers- .call(trigger_type: "trigger:topic_admin_button")- .map do |published_trigger|- {- trigger_node_id: published_trigger.trigger_node_id,- workflow_id: published_trigger.workflow_id,- label: NodeData.parameters(published_trigger.trigger_node)["label"],- icon: NodeData.parameters(published_trigger.trigger_node)["icon"],- }- end+ cached_published_triggers("trigger:topic_admin_button").map do |published_trigger|+ {+ trigger_node_id: published_trigger.trigger_node_id,+ workflow_id: published_trigger.workflow_id,+ label: NodeData.parameters(published_trigger.trigger_node)["label"],+ icon: NodeData.parameters(published_trigger.trigger_node)["icon"],+ }endenddef self.active_node_types- cache.defer_get_set(ACTIVE_NODE_TYPES_KEY) do- of_type("node_type").on_active_version.distinct.pluck(:dependency_key).to_set+ cached_dependency_index[:active_node_types].to_set+ end++ def self.cached_published_triggers(trigger_type)+ Array(+ cached_dependency_index[:published_triggers_by_type][trigger_type],+ ).map do |published_trigger|+ DiscourseWorkflows::CachedPublishedTrigger.from_hash(published_trigger)endenddef self.cached_user_modals?- cache.defer_get_set(USER_MODAL_CACHE_KEY) do- workflows_referencing("node_type", DiscourseWorkflows::Nodes::Modal::V1.identifier).exists?- end+ cached_dependency_index[:referenced_node_types].include?(+ DiscourseWorkflows::Nodes::Modal::V1.identifier,+ )enddef self.workflows_referencing(type, key)@@ -73,6 +73,71 @@ module DiscourseWorkflows).select(:workflow_id)end++ def self.cached_dependency_index+ cache.defer_get_set(DEPENDENCY_INDEX_CACHE_KEY) do+ rows = active_node_type_rows+ versions_by_id =+ WorkflowVersion.where(+ version_id: rows.map { |row| row[:workflow_version_id] }.uniq,+ ).index_by(&:version_id)++ {+ active_node_types: rows.map { |row| row[:node_type] }.uniq,+ referenced_node_types: referenced_node_types,+ published_triggers_by_type: published_triggers_by_type(rows, versions_by_id),+ }+ end+ end++ def self.active_node_type_rows+ of_type("node_type")+ .on_active_version+ .pluck(:dependency_key, :workflow_id, :workflow_version_id, :node_id)+ .map do |node_type, workflow_id, workflow_version_id, node_id|+ {+ node_type: node_type,+ workflow_id: workflow_id,+ workflow_version_id: workflow_version_id,+ node_id: node_id,+ }+ end+ end++ def self.referenced_node_types+ of_type("node_type")+ .joins(:workflow)+ .where(+ "discourse_workflows_workflow_dependencies.workflow_version_id IN " \+ "(discourse_workflows_workflows.version_id, " \+ "discourse_workflows_workflows.active_version_id)",+ )+ .distinct+ .pluck(:dependency_key)+ end++ def self.published_triggers_by_type(rows, versions_by_id)+ rows.each_with_object({}) do |row, published_triggers|+ node_type = row[:node_type]+ next if !node_type.start_with?("trigger:")++ trigger_node =+ versions_by_id[row[:workflow_version_id]]&.nodes&.find do |candidate|+ candidate["id"] == row[:node_id].to_s+ end+ next unless trigger_node&.dig("type") == node_type++ cached_trigger =+ DiscourseWorkflows::CachedPublishedTrigger.new(+ workflow_id: row[:workflow_id],+ workflow_version_id: row[:workflow_version_id],+ trigger_node: trigger_node.deep_dup,+ )++ published_triggers[node_type] ||= []+ published_triggers[node_type] << cached_trigger.to_h+ end+ endendenddiff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.ymlindex c0527158ed0..22424fc1716 100644--- a/plugins/discourse-workflows/config/locales/client.en.yml+++ b/plugins/discourse-workflows/config/locales/client.en.yml@@ -214,6 +214,7 @@ en:"trigger:topic_category_changed": "Topic category changed""trigger:topic_tag_changed": "Topic tag changed""trigger:reviewable_approved": "Approved reviewable"+ "trigger:user_search": "User search""trigger:webhook": "Webhook""trigger:workflow_call": "Workflow call""trigger:manual": "Manual trigger"@@ -257,6 +258,7 @@ en:"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: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""trigger:manual": "Fires when triggered manually by an admin"diff --git a/plugins/discourse-workflows/lib/discourse_workflows/cached_published_trigger.rb b/plugins/discourse-workflows/lib/discourse_workflows/cached_published_trigger.rbnew file mode 100644index 00000000000..ee8141481a2--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/cached_published_trigger.rb@@ -0,0 +1,28 @@+# frozen_string_literal: true++module DiscourseWorkflows+ CachedPublishedTrigger =+ Data.define(:workflow_id, :workflow_version_id, :trigger_node) do+ def self.from_hash(hash)+ attrs = hash.with_indifferent_access++ new(+ workflow_id: attrs[:workflow_id],+ workflow_version_id: attrs[:workflow_version_id],+ trigger_node: attrs[:trigger_node],+ )+ end++ def trigger_node_id+ trigger_node["id"]+ end++ def to_h+ {+ workflow_id: workflow_id,+ workflow_version_id: workflow_version_id,+ trigger_node: trigger_node,+ }+ end+ end+enddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/event_listener.rb b/plugins/discourse-workflows/lib/discourse_workflows/event_listener.rbindex 4a9b9318cf0..d9a83f4cf93 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/event_listener.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/event_listener.rb@@ -11,15 +11,13 @@ module DiscourseWorkflowstrigger_data = nil- DiscourseWorkflows::Workflow::Action::FindPublishedTriggers- .call(- trigger_type: trigger_class.identifier,- filter: ->(published_trigger) do- trigger.matches?(- DiscourseWorkflows::TriggerNodeContext.from_published_trigger(published_trigger),- )- end,- )+ WorkflowDependency+ .cached_published_triggers(trigger_class.identifier)+ .select do |published_trigger|+ trigger.matches?(+ DiscourseWorkflows::TriggerNodeContext.from_published_trigger(published_trigger),+ )+ end.each do |published_trigger|DiscourseWorkflows::TriggerDispatcher.enqueue(published_trigger,diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_search/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_search/v1.rbnew file mode 100644index 00000000000..8f91dda3621--- /dev/null+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user_search/v1.rb@@ -0,0 +1,33 @@+# frozen_string_literal: true++module DiscourseWorkflows+ module Nodes+ module UserSearch+ class V1 < NodeType+ description(+ name: "trigger:user_search",+ version: "1.0",+ defaults: {+ icon: "magnifying-glass",+ color: "blue",+ },+ group: "discourse_triggers",+ events: [:user_search],+ )++ def initialize(query, *)+ super(parameters: {})+ @query = query.to_s+ end++ def valid?+ @query.present?+ end++ def output+ { query: @query }+ end+ end+ end+ end+enddiff --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 4805ee14857..b40256781ae 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@@ -222,6 +222,20 @@ RSpec.describe DiscourseWorkflows::EventListener doexpect(enqueued_trigger_node_ids).not_to include("first-post-only")end+ it "enqueues user search workflows with the query" do+ create_published_workflow("user-search-trigger", "trigger:user_search")++ Search.execute("workflow query", guardian: Guardian.new(user), search_type: :header)++ job = Jobs::DiscourseWorkflows::ExecuteWorkflow.jobs.last+ expect(job["args"].first).to include(+ "trigger_node_id" => "user-search-trigger",+ "trigger_data" => {+ "query" => "workflow query",+ },+ )+ 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 cache@@ -237,6 +251,30 @@ RSpec.describe DiscourseWorkflows::EventListener doexpect(enqueued_trigger_node_ids).to be_emptyend+ it "does not query workflow tables for a cached user search trigger" do+ create_published_workflow("user-search-trigger", "trigger:user_search")+ DiscourseWorkflows::WorkflowDependency.active_node_types+ DiscourseWorkflows::WorkflowDependency.cached_published_triggers("trigger:user_search")++ queries =+ track_sql_queries do+ Search.execute("workflow query", guardian: Guardian.new(user), search_type: :header)+ end++ workflow_queries =+ queries.select do |sql|+ sql.match?(+ /+ discourse_workflows_workflow_dependencies|+ discourse_workflows_workflow_versions|+ discourse_workflows_workflows+ /x,+ )+ end+ expect(workflow_queries).to be_empty+ expect(enqueued_trigger_node_ids).to contain_exactly("user-search-trigger")+ end+def create_published_workflow(trigger_node_id, trigger_type, configuration: {})graph =build_workflow_graph do |g|diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_search_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_search_spec.rbnew file mode 100644index 00000000000..34a8fec8a12--- /dev/null+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_search_spec.rb@@ -0,0 +1,25 @@+# frozen_string_literal: true++RSpec.describe DiscourseWorkflows::Nodes::UserSearch::V1 do+ describe "#valid?" do+ it "returns true when the query is present" do+ trigger = described_class.new("workflow query")++ expect(trigger).to be_valid+ end++ it "returns false when the query is blank" do+ trigger = described_class.new("")++ expect(trigger).not_to be_valid+ end+ end++ describe "#output" do+ it "returns the query" do+ trigger = described_class.new("workflow query")++ expect(trigger.output).to eq(query: "workflow query")+ end+ end+end