Skip to content

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

DEV: Add DiscourseAi.register_feature public API (#39127)

Alan Guo Xiang Tan467d42c2dfc3
diff --git a/plugins/discourse-ai/lib/engine.rb b/plugins/discourse-ai/lib/engine.rb
index a694a91e704..61aa616571d 100644
--- a/plugins/discourse-ai/lib/engine.rb
+++ b/plugins/discourse-ai/lib/engine.rb
@@ -5,4 +5,90 @@ module DiscourseAi
engine_name PLUGIN_NAME
isolate_namespace DiscourseAi
end
+
+ # Register an AI-powered feature from another plugin. The feature will
+ # appear in the AI features admin page, where admins can select which agent
+ # backs it.
+ #
+ # The agent_klass must be a subclass of {DiscourseAi::Agents::Agent} and
+ # implement at minimum `#tools` (returning an array of tool classes) and
+ # `#system_prompt` (returning the prompt string).
+ #
+ # Each tool class must be a subclass of {DiscourseAi::Agents::Tools::Tool}
+ # and implement:
+ # - `.signature` - returns a hash with `name`, `description`, and `parameters`
+ # - `.name` - returns the tool name string
+ # - `#invoke` - executes the tool and returns a result hash
+ #
+ # @example Defining a tool, agent, and registering the feature
+ # class MyPlugin::Tools::RunQuery < DiscourseAi::Agents::Tools::Tool
+ # def self.signature
+ # { name: "run_query", description: "Runs a query", parameters: [] }
+ # end
+ #
+ # def self.name
+ # "run_query"
+ # end
+ #
+ # def invoke
+ # { result: "ok" }
+ # end
+ # end
+ #
+ # class MyPlugin::QueryAgent < DiscourseAi::Agents::Agent
+ # def tools
+ # [MyPlugin::Tools::RunQuery]
+ # end
+ #
+ # def system_prompt
+ # "You are a query expert."
+ # end
+ # end
+ #
+ # DiscourseAi.register_feature(
+ # module_name: :my_plugin,
+ # feature: :query_generation,
+ # agent_klass: MyPlugin::QueryAgent,
+ # enabled_by_setting: "my_plugin_ai_enabled",
+ # plugin: self,
+ # )
+ #
+ # @param module_name [Symbol] groups features under a module in the admin UI
+ # @param feature [Symbol] the feature name within the module
+ # @param agent_klass [Class] a subclass of {DiscourseAi::Agents::Agent}
+ # @param enabled_by_setting [String, nil] site setting that gates this feature
+ # @param plugin [Plugin::Instance] the plugin instance registering the feature
+ def self.register_feature(module_name:, feature:, agent_klass:, enabled_by_setting: nil, plugin:)
+ area = "ai-features/#{module_name}"
+ plugin.register_site_setting_area(area)
+
+ setting_name = "#{module_name}_#{feature}_agent"
+ SiteSetting.send(
+ :setting,
+ setting_name.to_sym,
+ DiscourseAi::Agents::Agent.external_agent_id(agent_klass).to_s,
+ type: "enum",
+ enum: "DiscourseAi::Configuration::AgentEnumerator",
+ depends_on: ["discourse_ai_enabled", enabled_by_setting].compact,
+ depends_behavior: "hidden",
+ area: area,
+ )
+
+ if enabled_by_setting.present?
+ key = enabled_by_setting.to_sym
+ existing = SiteSetting.areas[key]
+ SiteSetting.areas[key] = existing ? (Array.wrap(existing) | [area]) : area
+ end
+
+ DiscoursePluginRegistry.register_external_ai_feature(
+ {
+ module_name: module_name,
+ feature: feature,
+ agent_klass: agent_klass,
+ enabled_by_setting: enabled_by_setting,
+ visible: true,
+ },
+ plugin,
+ )
+ end
end
diff --git a/plugins/discourse-ai/plugin.rb b/plugins/discourse-ai/plugin.rb
index 3389d055b44..39ccfe094a0 100644
--- a/plugins/discourse-ai/plugin.rb
+++ b/plugins/discourse-ai/plugin.rb
@@ -131,7 +131,10 @@ after_initialize do
end
end
- require_relative "spec/support/embeddings_generation_stubs" if Rails.env.test?
+ if Rails.env.test?
+ require_relative "spec/support/embeddings_generation_stubs"
+ require_relative "spec/support/fake_external_agent"
+ end
reloadable_patch do |plugin|
Guardian.prepend DiscourseAi::GuardianExtensions
diff --git a/plugins/discourse-ai/spec/configuration/feature_register_spec.rb b/plugins/discourse-ai/spec/configuration/feature_register_spec.rb
index c8d401fe416..857eb88fa50 100644
--- a/plugins/discourse-ai/spec/configuration/feature_register_spec.rb
+++ b/plugins/discourse-ai/spec/configuration/feature_register_spec.rb
@@ -1,17 +1,5 @@
# frozen_string_literal: true
-unless defined?(FakeExternalAgent)
- class FakeExternalAgent < DiscourseAi::Agents::Agent
- def tools
- []
- end
-
- def system_prompt
- "Test agent"
- end
- end
-end
-
describe DiscourseAi::Configuration::Feature do
fab!(:fake_plugin) do
plugin = Plugin::Instance.new
@@ -20,14 +8,11 @@ describe DiscourseAi::Configuration::Feature do
end
before do
- DiscoursePluginRegistry.register_external_ai_feature(
- {
- module_name: :test_plugin,
- feature: :test_feature,
- agent_klass: FakeExternalAgent,
- enabled_by_setting: nil,
- },
- fake_plugin,
+ DiscourseAi.register_feature(
+ module_name: :test_plugin,
+ feature: :test_feature,
+ agent_klass: DiscourseAi::TestHelpers::FakeExternalAgent,
+ plugin: fake_plugin,
)
end
diff --git a/plugins/discourse-ai/spec/configuration/module_register_spec.rb b/plugins/discourse-ai/spec/configuration/module_register_spec.rb
index f96f27b8128..28633fc68b1 100644
--- a/plugins/discourse-ai/spec/configuration/module_register_spec.rb
+++ b/plugins/discourse-ai/spec/configuration/module_register_spec.rb
@@ -1,17 +1,5 @@
# frozen_string_literal: true
-unless defined?(FakeExternalAgent)
- class FakeExternalAgent < DiscourseAi::Agents::Agent
- def tools
- []
- end
-
- def system_prompt
- "Test agent"
- end
- end
-end
-
describe DiscourseAi::Configuration::Module do
fab!(:fake_plugin) do
plugin = Plugin::Instance.new
@@ -20,14 +8,11 @@ describe DiscourseAi::Configuration::Module do
end
before do
- DiscoursePluginRegistry.register_external_ai_feature(
- {
- module_name: :test_plugin,
- feature: :test_feature,
- agent_klass: FakeExternalAgent,
- enabled_by_setting: nil,
- },
- fake_plugin,
+ DiscourseAi.register_feature(
+ module_name: :test_plugin,
+ feature: :test_feature,
+ agent_klass: DiscourseAi::TestHelpers::FakeExternalAgent,
+ plugin: fake_plugin,
)
end
@@ -52,30 +37,53 @@ describe DiscourseAi::Configuration::Module do
expect(test_mod.id).to eq(expected_id)
end
+ it "auto-defines the agent site setting for the feature" do
+ expected_default =
+ DiscourseAi::Agents::Agent.external_agent_id(
+ DiscourseAi::TestHelpers::FakeExternalAgent,
+ ).to_s
+ expect(SiteSetting.test_plugin_test_feature_agent).to eq(expected_default)
+ end
+
+ it "registers the ai-features area and assigns the agent setting to it" do
+ expect(SiteSetting.valid_areas).to include("ai-features/test_plugin")
+ expect(SiteSetting.areas[:test_plugin_test_feature_agent]).to include(
+ "ai-features/test_plugin",
+ )
+ end
+
+ it "assigns enabled_by_setting to the area when provided" do
+ DiscourseAi.register_feature(
+ module_name: :test_plugin,
+ feature: :gated_feature,
+ agent_klass: DiscourseAi::TestHelpers::FakeExternalAgent,
+ enabled_by_setting: "discourse_ai_enabled",
+ plugin: fake_plugin,
+ )
+
+ expect(SiteSetting.areas[:discourse_ai_enabled]).to eq("ai-features/test_plugin")
+ end
+
context "with multiple features gated by different settings" do
before do
DiscoursePluginRegistry._raw_external_ai_features.reject! do |entry|
entry[:value][:module_name] == :test_plugin
end
- DiscoursePluginRegistry.register_external_ai_feature(
- {
- module_name: :test_plugin,
- feature: :feature_a,
- agent_klass: FakeExternalAgent,
- enabled_by_setting: "data_explorer_enabled",
- },
- fake_plugin,
+ DiscourseAi.register_feature(
+ module_name: :test_plugin,
+ feature: :feature_a,
+ agent_klass: DiscourseAi::TestHelpers::FakeExternalAgent,
+ enabled_by_setting: "data_explorer_enabled",
+ plugin: fake_plugin,
)
- DiscoursePluginRegistry.register_external_ai_feature(
- {
- module_name: :test_plugin,
- feature: :feature_b,
- agent_klass: FakeExternalAgent,
- enabled_by_setting: "data_explorer_ai_queries_enabled",
- },
- fake_plugin,
+ DiscourseAi.register_feature(
+ module_name: :test_plugin,
+ feature: :feature_b,
+ agent_klass: DiscourseAi::TestHelpers::FakeExternalAgent,
+ enabled_by_setting: "data_explorer_ai_queries_enabled",
+ plugin: fake_plugin,
)
end
diff --git a/plugins/discourse-ai/spec/support/fake_external_agent.rb b/plugins/discourse-ai/spec/support/fake_external_agent.rb
new file mode 100644
index 00000000000..9bd8046d48a
--- /dev/null
+++ b/plugins/discourse-ai/spec/support/fake_external_agent.rb
@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DiscourseAi
+ module TestHelpers
+ class FakeExternalAgent < DiscourseAi::Agents::Agent
+ def tools
+ []
+ end
+
+ def system_prompt
+ "Test agent"
+ end
+ end
+ end
+end
diff --git a/plugins/discourse-ai/spec/system/admin_ai_features_spec.rb b/plugins/discourse-ai/spec/system/admin_ai_features_spec.rb
index 2d62c8de026..9a8a4d39463 100644
--- a/plugins/discourse-ai/spec/system/admin_ai_features_spec.rb
+++ b/plugins/discourse-ai/spec/system/admin_ai_features_spec.rb
@@ -1,17 +1,5 @@
# frozen_string_literal: true
-unless defined?(FakeExternalAgent)
- class FakeExternalAgent < DiscourseAi::Agents::Agent
- def tools
- []
- end
-
- def system_prompt
- "Test agent"
- end
- end
-end
-
RSpec.describe "Admin AI features configuration" do
fab!(:admin)
fab!(:llm_model)
@@ -118,14 +106,11 @@ RSpec.describe "Admin AI features configuration" do
end
before do
- DiscoursePluginRegistry.register_external_ai_feature(
- {
- module_name: :test_external,
- feature: :test_feature,
- agent_klass: FakeExternalAgent,
- enabled_by_setting: nil,
- },
- fake_plugin,
+ DiscourseAi.register_feature(
+ module_name: :test_external,
+ feature: :test_feature,
+ agent_klass: DiscourseAi::TestHelpers::FakeExternalAgent,
+ plugin: fake_plugin,
)
end
diff --git a/plugins/discourse-data-explorer/config/settings.yml b/plugins/discourse-data-explorer/config/settings.yml
index 2f51cdbf3e8..9274e7bcb9b 100644
--- a/plugins/discourse-data-explorer/config/settings.yml
+++ b/plugins/discourse-data-explorer/config/settings.yml
@@ -8,13 +8,6 @@ discourse_data_explorer:
depends_on:
- discourse_ai_enabled
depends_behavior: hidden
- data_explorer_query_generation_agent:
- default: "-1492485"
- type: enum
- enum: "DiscourseDataExplorer::AiAgentEnumerator"
- depends_on:
- - discourse_ai_enabled
- depends_behavior: hidden
data_explorer_query_result_limit:
default: 1000
hidden: true
diff --git a/plugins/discourse-data-explorer/lib/discourse_data_explorer/ai_agent_enumerator.rb b/plugins/discourse-data-explorer/lib/discourse_data_explorer/ai_agent_enumerator.rb
deleted file mode 100644
index 033c69ecff1..00000000000
--- a/plugins/discourse-data-explorer/lib/discourse_data_explorer/ai_agent_enumerator.rb
+++ /dev/null
@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "enum_site_setting"
-
-module DiscourseDataExplorer
- class AiAgentEnumerator < ::EnumSiteSetting
- def self.valid_value?(val)
- true
- end
-
- def self.values
- return [] unless defined?(::AiAgent)
- ::AiAgent
- .all_agents(enabled_only: false)
- .map { |agent| { name: agent.name, value: agent.id } }
- end
- end
-end
diff --git a/plugins/discourse-data-explorer/plugin.rb b/plugins/discourse-data-explorer/plugin.rb
index f5b22eda1aa..6de9fbce64f 100644
--- a/plugins/discourse-data-explorer/plugin.rb
+++ b/plugins/discourse-data-explorer/plugin.rb
@@ -9,8 +9,6 @@
enabled_site_setting :data_explorer_enabled
-register_site_setting_area("ai-features/data_explorer") if defined?(DiscourseAi)
-
register_asset "stylesheets/explorer.scss"
register_svg_icon "angle-down"
@@ -202,17 +200,12 @@ after_initialize do
require_relative "lib/discourse_data_explorer/tools/run_sql"
require_relative "lib/discourse_data_explorer/ai_query_generator"
- DiscoursePluginRegistry.register_external_ai_feature(
- {
- module_name: :data_explorer,
- feature: :query_generation,
- agent_klass: DiscourseDataExplorer::AiQueryGenerator,
- enabled_by_setting: "data_explorer_ai_queries_enabled",
- },
- self,
+ DiscourseAi.register_feature(
+ module_name: :data_explorer,
+ feature: :query_generation,
+ agent_klass: DiscourseDataExplorer::AiQueryGenerator,
+ enabled_by_setting: "data_explorer_ai_queries_enabled",
+ plugin: self,
)
-
- SiteSetting.areas[:data_explorer_ai_queries_enabled] ||= "ai-features/data_explorer"
- SiteSetting.areas[:data_explorer_query_generation_agent] ||= "ai-features/data_explorer"
end
end