A platform for community discussion. Free, open, simple.
FIX: Require the summary backfill before publishing AI summaries to crawlers (#44318)
Natalie Tay6318da11aded
diff --git a/plugins/discourse-ai/config/locales/server.en.yml b/plugins/discourse-ai/config/locales/server.en.ymlindex 647f6f87b2f..05771d44d66 100644--- a/plugins/discourse-ai/config/locales/server.en.yml+++ b/plugins/discourse-ai/config/locales/server.en.yml@@ -147,12 +147,12 @@ en:ai_admin_dashboard_highlights_category_scope: "Choose which categories AI highlights can use. Include and exclude options use {{setting:ai_admin_dashboard_highlights_categories}}. Personal messages are always excluded."ai_admin_dashboard_highlights_categories: "Categories used when the AI highlights category scope is set to <strong>include</strong> or <strong>exclude</strong>."ai_summarization_enabled: "Enable the summarize feature"- ai_summaries_for_crawlers: "Include AI topic summaries in public HTML topic pages served to search engines and other crawlers. Requires {{setting:ai_summarization_enabled}}."+ ai_summaries_for_crawlers: "Include AI topic summaries in public HTML topic pages served to search engines and other crawlers. Requires {{setting:ai_summarization_enabled}} and {{setting:ai_summary_backfill_maximum_topics_per_hour}} above 0, so summaries stay up to date."ai_summarization_agent: "Agent to use for summarize feature"ai_pm_summarization_allowed_groups: "Groups allowed to create and view summaries in PMs."ai_summary_gists_enabled: "Generate brief summaries of latest replies in topics automatically"ai_summary_gists_agent: "Agent used to generate brief topic summaries. Gist generation always uses the built-in final-summary tool; other tools and structured response formats configured on the agent are ignored."- ai_summary_backfill_maximum_topics_per_hour: "Number of topic summaries to backfill per hour. Each localized gist counts toward this limit."+ ai_summary_backfill_maximum_topics_per_hour: "Number of topic summaries to backfill per hour. Each localized gist counts toward this limit. Must be above 0 to turn on {{setting:ai_summaries_for_crawlers}}."ai_bot_enabled: "Enable the AI Bot module."ai_bot_enabled_llms: "LLMs available to select for AI bot conversations"@@ -1242,6 +1242,8 @@ en:summarization:published_summary_heading: "AI-generated summary"+ configuration:+ backfill_required: "Set 'ai summary backfill maximum topics per hour' above 0 first, so summaries shown to crawlers stay up to date."configuration_hint:one: "Configure the `%{setting}` setting first."other: "Configure these settings first: %{settings}"diff --git a/plugins/discourse-ai/config/settings.yml b/plugins/discourse-ai/config/settings.ymlindex 499f4eae48a..bd8397c83d6 100644--- a/plugins/discourse-ai/config/settings.yml+++ b/plugins/discourse-ai/config/settings.yml@@ -349,6 +349,7 @@ discourse_ai:area: "ai-features/summarization"ai_summaries_for_crawlers:default: false+ validator: "DiscourseAi::Configuration::SummariesForCrawlersValidator"area: "ai-features/summarization"ai_pm_summarization_allowed_groups:type: group_listdiff --git a/plugins/discourse-ai/lib/configuration/summaries_for_crawlers_validator.rb b/plugins/discourse-ai/lib/configuration/summaries_for_crawlers_validator.rbnew file mode 100644index 00000000000..e0e9fb7c0f3--- /dev/null+++ b/plugins/discourse-ai/lib/configuration/summaries_for_crawlers_validator.rb@@ -0,0 +1,21 @@+# frozen_string_literal: true++module DiscourseAi+ module Configuration+ class SummariesForCrawlersValidator+ def initialize(opts = {})+ @opts = opts+ end++ def valid_value?(val)+ return true if val == false || val == "f" || val == "false"++ SiteSetting.ai_summary_backfill_maximum_topics_per_hour > 0+ end++ def error_message+ I18n.t("discourse_ai.summarization.configuration.backfill_required")+ end+ end+ end+enddiff --git a/plugins/discourse-ai/spec/configuration/summaries_for_crawlers_validator_spec.rb b/plugins/discourse-ai/spec/configuration/summaries_for_crawlers_validator_spec.rbnew file mode 100644index 00000000000..b6a17534e70--- /dev/null+++ b/plugins/discourse-ai/spec/configuration/summaries_for_crawlers_validator_spec.rb@@ -0,0 +1,36 @@+# frozen_string_literal: true++describe DiscourseAi::Configuration::SummariesForCrawlersValidator do+ before do+ enable_current_plugin+ assign_fake_provider_to(:ai_default_llm_model)+ SiteSetting.ai_summarization_enabled = true+ end++ it "rejects publishing summaries to crawlers while the summary backfill is off" do+ SiteSetting.ai_summary_backfill_maximum_topics_per_hour = 0++ expect { SiteSetting.ai_summaries_for_crawlers = true }.to raise_error(+ Discourse::InvalidParameters,+ /#{Regexp.escape(I18n.t("discourse_ai.summarization.configuration.backfill_required"))}/,+ )+ end++ it "allows publishing summaries to crawlers when the summary backfill is on" do+ SiteSetting.ai_summary_backfill_maximum_topics_per_hour = 10++ SiteSetting.ai_summaries_for_crawlers = true++ expect(SiteSetting.ai_summaries_for_crawlers).to eq(true)+ end++ it "allows turning off crawler summaries after the backfill is turned off" do+ SiteSetting.ai_summary_backfill_maximum_topics_per_hour = 10+ SiteSetting.ai_summaries_for_crawlers = true+ SiteSetting.ai_summary_backfill_maximum_topics_per_hour = 0++ SiteSetting.ai_summaries_for_crawlers = false++ expect(SiteSetting.ai_summaries_for_crawlers).to eq(false)+ end+enddiff --git a/plugins/discourse-ai/spec/requests/summarization/published_summary_spec.rb b/plugins/discourse-ai/spec/requests/summarization/published_summary_spec.rbindex 6a05a5709c5..2d6b529cdd3 100644--- a/plugins/discourse-ai/spec/requests/summarization/published_summary_spec.rb+++ b/plugins/discourse-ai/spec/requests/summarization/published_summary_spec.rb@@ -15,6 +15,7 @@ describe TopicsController doassign_agent_to(:ai_summarization_agent, [Group::AUTO_GROUPS[:admins]])SiteSetting.ai_summarization_enabled = trueSiteSetting.enable_markdown_endpoints = true+ SiteSetting.ai_summary_backfill_maximum_topics_per_hour = 10SiteSetting.ai_summaries_for_crawlers = trueend