A platform for community discussion. Free, open, simple.
FEATURE: Allow AI bot conversations as the default homepage (#43823)
Kris1057dafc7f7e
diff --git a/app/models/homepage_site_setting.rb b/app/models/homepage_site_setting.rbindex ce037e07f9d..4cf372b7f57 100644--- a/app/models/homepage_site_setting.rb+++ b/app/models/homepage_site_setting.rb@@ -11,9 +11,10 @@ class HomepageSiteSetting < EnumSiteSetting# A blank value means the homepage is derived from the first top_menu item.[{ name: "admin.homepage.top_menu_default", value: "" }] +TopMenu.homepage_choices.map { |f| { name: "filters.#{f}.title", value: f } } +- DiscoursePluginRegistry.homepage_options.map do |option|- { name: option[:name], value: option[:id] }- end+ DiscoursePluginRegistry+ .homepage_options+ .select { |option| offered?(option) }+ .map { |option| { name: option[:name], value: option[:id] } }enddef self.choices@@ -23,4 +24,14 @@ class HomepageSiteSetting < EnumSiteSettingdef self.translate_names?trueend++ def self.offered?(option)+ option[:enabled].nil? || !!option[:enabled].call+ rescue StandardError => e+ # The homepage is resolved from these choices on every page load, so a+ # failing condition must not take the site down with it.+ Discourse.warn_exception(e, message: "Homepage enabled check failed for '#{option[:id]}'")+ false+ end+ private_class_method :offered?enddiff --git a/frontend/discourse/admin/controllers/edit-category/tabs.js b/frontend/discourse/admin/controllers/edit-category/tabs.jsindex ccc3cc39bd3..7f9fe9989dd 100644--- a/frontend/discourse/admin/controllers/edit-category/tabs.js+++ b/frontend/discourse/admin/controllers/edit-category/tabs.js@@ -8,9 +8,9 @@ import { popupAjaxError } from "discourse/lib/ajax-error";import { AUTO_GROUPS } from "discourse/lib/constants";import { registeredEditCategoryTabs } from "discourse/lib/edit-category-tabs";import getURL from "discourse/lib/get-url";+import { homepageNavigationDestination } from "discourse/lib/homepage-router-overrides";import { autoTrackedArray } from "discourse/lib/tracked-tools";import DiscourseURL from "discourse/lib/url";-import { defaultHomepage } from "discourse/lib/utilities";import Category from "discourse/models/category";import { i18n } from "discourse-i18n";@@ -410,7 +410,7 @@ export default class EditCategoryTabsController extends Controller {updatedModel.setupGroupsAndPermissions();if (lostAccess) {- this.router.transitionTo(`discovery.${defaultHomepage()}`);+ this.router.transitionTo(homepageNavigationDestination());return;}diff --git a/frontend/discourse/app/lib/homepage-router-overrides.js b/frontend/discourse/app/lib/homepage-router-overrides.jsindex 660c52bc8d5..8ace1ed6ad4 100644--- a/frontend/discourse/app/lib/homepage-router-overrides.js+++ b/frontend/discourse/app/lib/homepage-router-overrides.js@@ -1,5 +1,6 @@import { defaultHomepage } from "discourse/lib/utilities";import Site from "discourse/models/site";+import User from "discourse/models/user";/*** We want / to display one of our discovery routes/controllers, but we don't@@ -16,7 +17,7 @@ export default function applyRouterHomepageOverrides(router) {for (const method of ["updateURL", "replaceURL"]) {const original = microLib[method].bind(microLib);microLib[method] = function (url) {- url = rewriteIfNeeded(url, this.activeTransition);+ url = rewriteIfNeeded(url, this.activeTransition, router.location);return original(url);};}@@ -63,6 +64,32 @@ export function homepagePath() {return option?.path || `/${homepage}`;}+/**+ * The homepage route when a topic list is required. A registered homepage+ * can't serve as one, so this falls back to the first top menu item the+ * current user can see.+ *+ * Use it when leaving a registered homepage, where going "home" would lead+ * straight back.+ *+ * @returns {string}+ */+export function discoveryHomepageRoute() {+ if (!registeredHomepageOption()) {+ return `discovery.${defaultHomepage()}`;+ }++ const site = Site.current();+ const items = site.siteSettings.top_menu+ .split("|")+ .map((item) => item.split(",")[0]);+ const item = User.current()+ ? items[0]+ : items.find((name) => site.anonymous_top_menu_items.includes(name));++ return `discovery.${item ?? "latest"}`;+}+export function serverSideHomepage() {return registeredHomepageOption()?.server_side === true;}@@ -73,16 +100,19 @@ function registeredHomepageOption() {return Site.current()?.homepage_options?.find(({ id }) => id === homepage);}-function rewriteIfNeeded(url, transition) {+function rewriteIfNeeded(url, transition, location) {const intentUrl = transition?.intent?.url;+ const stayingOnHomepage = isStayingOnRegisteredHomepage(url, location);if (+ stayingOnHomepage ||(homepageDestination() !== "/" &&intentUrl?.startsWith(homepageDestination())) ||intentUrl?.startsWith("/login-required") ||(transition?.intent.name === `discovery.${defaultHomepage()}` &&transition?.intent.queryParams[homepageRewriteParam])) {- const params = (intentUrl || url).split("?", 2)[1];+ const source = stayingOnHomepage ? url : intentUrl || url;+ const params = source.split("?", 2)[1];url = "/";if (params) {const searchParams = new URLSearchParams(params);@@ -94,3 +124,20 @@ function rewriteIfNeeded(url, transition) {}return url;}++/**+ * While a registered homepage is shown at `/`, navigating to its own path+ * (e.g. the page updating its query params) would otherwise swap `/` for the+ * page's real path.+ */+function isStayingOnRegisteredHomepage(url, location) {+ const option = registeredHomepageOption();++ if (!option || option.server_side) {+ return false;+ }++ const currentPath = location?.getURL?.().split(/[?#]/, 1)[0];++ return currentPath === "/" && url?.split(/[?#]/, 1)[0] === option.path;+}diff --git a/frontend/discourse/tests/unit/lib/homepage-router-overrides-test.js b/frontend/discourse/tests/unit/lib/homepage-router-overrides-test.jsindex bfc1b5a7b2c..306335fd9c5 100644--- a/frontend/discourse/tests/unit/lib/homepage-router-overrides-test.js+++ b/frontend/discourse/tests/unit/lib/homepage-router-overrides-test.js@@ -1,6 +1,7 @@import { setupTest } from "ember-qunit";import { module, test } from "qunit";-import {+import applyRouterHomepageOverrides, {+ discoveryHomepageRoute,homepageDestination,homepageNavigationDestination,homepagePath,@@ -8,6 +9,7 @@ import {} from "discourse/lib/homepage-router-overrides";import { setDefaultHomepage } from "discourse/lib/utilities";import Site from "discourse/models/site";+import { logIn } from "discourse/tests/helpers/qunit-helpers";module("Unit | Lib | homepage-router-overrides", function (hooks) {setupTest(hooks);@@ -54,4 +56,55 @@ module("Unit | Lib | homepage-router-overrides", function (hooks) {assert.strictEqual(homepageNavigationDestination(), "/");assert.strictEqual(homepagePreviewDestination(), "discovery.latest");});++ test("uses the homepage for topic lists when it is a discovery route", function (assert) {+ setDefaultHomepage("categories");++ assert.strictEqual(discoveryHomepageRoute(), "discovery.categories");+ });++ test("falls back to the top menu for topic lists when a registered homepage is active", function (assert) {+ Site.current().set("homepage_options", [+ { id: "directory", path: "/directory" },+ ]);+ this.owner.lookup("service:site-settings").top_menu =+ "new|categories|latest";+ setDefaultHomepage("directory");++ assert.strictEqual(+ discoveryHomepageRoute(),+ "discovery.categories",+ "skips top menu items anonymous visitors cannot see"+ );++ logIn(this.owner);++ assert.strictEqual(discoveryHomepageRoute(), "discovery.new");+ });++ test("keeps `/` when a registered homepage shown there updates its own URL", function (assert) {+ Site.current().set("homepage_options", [+ { id: "directory", path: "/directory" },+ ]);+ setDefaultHomepage("directory");++ let currentURL = "/";+ const updatedURLs = [];+ const microLib = {+ activeTransition: null,+ updateURL: (url) => updatedURLs.push(url),+ replaceURL: (url) => updatedURLs.push(url),+ };+ applyRouterHomepageOverrides({+ location: { getURL: () => currentURL },+ // eslint-disable-next-line ember/no-private-routing-service+ _routerMicrolib: microLib,+ });++ microLib.replaceURL("/directory?sort=name");+ currentURL = "/latest";+ microLib.updateURL("/directory");++ assert.deepEqual(updatedURLs, ["/?sort=name", "/directory"]);+ });});diff --git a/lib/homepage_helper.rb b/lib/homepage_helper.rbindex 66d105f7155..9d3d7a92f40 100644--- a/lib/homepage_helper.rb+++ b/lib/homepage_helper.rb@@ -1,6 +1,8 @@# frozen_string_literal: trueclass HomepageHelper+ AVAILABILITY_CACHE_KEY = "discourse.homepage_availability"+def self.resolve(request = nil, current_user = nil)return "blank" if !current_user && SiteSetting.login_required?@@ -18,7 +20,10 @@ class HomepageHelperreturn custom_homepage_route(request) if enabled- current_user ? SiteSetting.homepage : SiteSetting.anonymous_homepage+ homepage = current_user ? SiteSetting.homepage : SiteSetting.anonymous_homepage+ return homepage if option_available?(homepage, request, current_user)++ top_menu_homepage(current_user)enddef self.custom_homepage_route(request)@@ -28,4 +33,34 @@ class HomepageHelper"custom"end++ def self.option_available?(homepage, request, current_user)+ option = DiscoursePluginRegistry.homepage_options.find { |o| o[:id] == homepage }+ return true if option.nil? || option[:available].nil?++ check = -> do+ !!option[:available].call(guardian: Guardian.new(current_user, request), request: request)+ rescue StandardError => e+ # Every page load resolves the homepage, so a failing check must not+ # take the site down with it.+ Discourse.warn_exception(e, message: "Homepage availability check failed for '#{homepage}'")+ false+ end+ return check.call if request.nil?++ # Resolving `/` evaluates every homepage route constraint, and the layout+ # resolves again, so the check would otherwise run many times per request.+ cache = (request.env[AVAILABILITY_CACHE_KEY] ||= {})+ key = [homepage, current_user&.id]+ cache.key?(key) ? cache[key] : (cache[key] = check.call)+ end++ def self.top_menu_homepage(current_user)+ names = SiteSetting.top_menu_items.map(&:name)+ return names.first if current_user++ names.find { |name| SiteSetting.anonymous_menu_items.include?(name) }+ end++ private_class_method :option_available?, :top_menu_homepageenddiff --git a/lib/plugin/instance.rb b/lib/plugin/instance.rbindex 26d9b6e7ba4..86e4bd50898 100644--- a/lib/plugin/instance.rb+++ b/lib/plugin/instance.rb@@ -1169,7 +1169,23 @@ class Plugin::Instance# @param route [String] Rails controller action, in `controller#action` form# @param anonymous [Boolean] whether logged-out visitors may use this homepage# @param server_side [Boolean] whether navigation requires a full page request- def register_homepage(id, name:, path:, route:, anonymous: false, server_side: false)+ # @param enabled [Proc, nil] site-wide condition for offering this homepage in+ # the admin setting; while it returns false, a site that selected it falls+ # back to the top menu homepage+ # @param available [Proc, nil] called with `guardian:` and `request:` (which+ # may be nil); when it returns false the visitor gets the regular top menu+ # homepage instead. It runs whenever the homepage is resolved, including on+ # page loads and topic list requests, so keep it cheap.+ def register_homepage(+ id,+ name:,+ path:,+ route:,+ anonymous: false,+ server_side: false,+ enabled: nil,+ available: nil+ )id = id.to_sif !id.match?(/\A[a-z0-9][a-z0-9_-]*\z/)@@ -1187,6 +1203,12 @@ class Plugin::Instanceif ![true, false].include?(server_side)raise ArgumentError, "homepage server_side must be true or false"end+ if !enabled.nil? && !enabled.respond_to?(:call)+ raise ArgumentError, "homepage enabled must be callable"+ end+ if !available.nil? && !available.respond_to?(:call)+ raise ArgumentError, "homepage available must be callable"+ endregistered_ids =DiscoursePluginRegistry._raw_homepage_options.map { |entry| entry[:value][:id] }@@ -1204,6 +1226,8 @@ class Plugin::Instanceroute: route.to_s,anonymous: anonymous,server_side: server_side,+ enabled: enabled,+ available: available,},self,)diff --git a/plugins/chat/assets/javascripts/discourse/routes/chat.js b/plugins/chat/assets/javascripts/discourse/routes/chat.jsindex 44e38ee0e06..39702674714 100644--- a/plugins/chat/assets/javascripts/discourse/routes/chat.js+++ b/plugins/chat/assets/javascripts/discourse/routes/chat.js@@ -1,6 +1,6 @@import { service } from "@ember/service";+import { discoveryHomepageRoute } from "discourse/lib/homepage-router-overrides";import { withPluginApi } from "discourse/lib/plugin-api";-import { defaultHomepage } from "discourse/lib/utilities";import Session from "discourse/models/session";import DiscourseRoute from "discourse/routes/discourse";import { i18n } from "discourse-i18n";@@ -32,7 +32,7 @@ export default class ChatRoute extends DiscourseRoute {}if (!this.chat.userCanChat && !this.chat.anonymousUserCanViewPublicChat) {- return this.router.transitionTo(`discovery.${defaultHomepage()}`);+ return this.router.transitionTo(discoveryHomepageRoute());}// Check if user prefers drawer mode and the route can be handled in drawer@@ -69,8 +69,7 @@ export default class ChatRoute extends DiscourseRoute {// navigate to a non-chat page first before opening the drawerif (fullPageReload) {const appURL =- this.chatStateManager.lastKnownAppURL ||- `discovery.${defaultHomepage()}`;+ this.chatStateManager.lastKnownAppURL || discoveryHomepageRoute();return this.router.transitionTo(appURL).then(() => {this.appEvents.trigger("chat:open-url", url);});diff --git a/plugins/chat/assets/javascripts/discourse/routes/chat/browse/index.js b/plugins/chat/assets/javascripts/discourse/routes/chat/browse/index.jsindex fec1c162c3c..def4738b2ce 100644--- a/plugins/chat/assets/javascripts/discourse/routes/chat/browse/index.js+++ b/plugins/chat/assets/javascripts/discourse/routes/chat/browse/index.js@@ -1,5 +1,5 @@import { service } from "@ember/service";-import { defaultHomepage } from "discourse/lib/utilities";+import { discoveryHomepageRoute } from "discourse/lib/homepage-router-overrides";import DiscourseRoute from "discourse/routes/discourse";export default class ChatBrowseIndexRoute extends DiscourseRoute {@@ -9,7 +9,7 @@ export default class ChatBrowseIndexRoute extends DiscourseRoute {beforeModel() {if (!this.siteSettings.enable_public_channels) {- return this.router.transitionTo(`discovery.${defaultHomepage()}`);+ return this.router.transitionTo(discoveryHomepageRoute());}}diff --git a/plugins/chat/assets/javascripts/discourse/routes/preferences/chat.js b/plugins/chat/assets/javascripts/discourse/routes/preferences/chat.jsindex 8e438423cda..8607b4a5f45 100644--- a/plugins/chat/assets/javascripts/discourse/routes/preferences/chat.js+++ b/plugins/chat/assets/javascripts/discourse/routes/preferences/chat.js@@ -1,5 +1,5 @@import { service } from "@ember/service";-import { defaultHomepage } from "discourse/lib/utilities";+import { homepageNavigationDestination } from "discourse/lib/homepage-router-overrides";import RestrictedUserRoute from "discourse/routes/restricted-user";export default class PreferencesChatRoute extends RestrictedUserRoute {@@ -14,7 +14,7 @@ export default class PreferencesChatRoute extends RestrictedUserRoute {!this.siteSettings.chat_enabled ||(!user.can_chat && !this.currentUser?.admin)) {- return this.router.transitionTo(`discovery.${defaultHomepage()}`);+ return this.router.transitionTo(homepageNavigationDestination());}controller.set("model", user);diff --git a/plugins/chat/assets/javascripts/discourse/services/chat-state-manager.js b/plugins/chat/assets/javascripts/discourse/services/chat-state-manager.jsindex b3f53f44e27..d55b71bd645 100644--- a/plugins/chat/assets/javascripts/discourse/services/chat-state-manager.js+++ b/plugins/chat/assets/javascripts/discourse/services/chat-state-manager.js@@ -1,10 +1,10 @@import { tracked } from "@glimmer/tracking";import Service, { service } from "@ember/service";import { withoutPrefix } from "discourse/lib/get-url";+import { discoveryHomepageRoute } from "discourse/lib/homepage-router-overrides";import KeyValueStore from "discourse/lib/key-value-store";import { withPluginApi } from "discourse/lib/plugin-api";import { MAIN_PANEL } from "discourse/lib/sidebar/panels";-import { defaultHomepage } from "discourse/lib/utilities";import { getUserChatSeparateSidebarMode } from "discourse/plugins/chat/discourse/lib/get-user-chat-separate-sidebar-mode";import { CHAT_PANEL } from "discourse/plugins/chat/discourse/lib/init-sidebar-state";@@ -85,7 +85,7 @@ export default class ChatStateManager extends Service {let url = this._appURL;if (!url || url === "/") {- url = this.router.urlFor(`discovery.${defaultHomepage()}`);+ url = this.router.urlFor(discoveryHomepageRoute());}return withoutPrefix(url);diff --git a/plugins/discourse-ai/assets/javascripts/discourse/services/ai-conversations-sidebar-manager.js b/plugins/discourse-ai/assets/javascripts/discourse/services/ai-conversations-sidebar-manager.jsindex 12143f041a8..25f72d65c96 100644--- a/plugins/discourse-ai/assets/javascripts/discourse/services/ai-conversations-sidebar-manager.js+++ b/plugins/discourse-ai/assets/javascripts/discourse/services/ai-conversations-sidebar-manager.js@@ -7,6 +7,7 @@ import { ajax } from "discourse/lib/ajax";import { popupAjaxError } from "discourse/lib/ajax-error";import discourseDebounce from "discourse/lib/debounce";import { autoUpdatingRelativeAge } from "discourse/lib/formatter";+import { discoveryHomepageRoute } from "discourse/lib/homepage-router-overrides";import { MAIN_PANEL } from "discourse/lib/sidebar/panels";import { defaultHomepage } from "discourse/lib/utilities";import { i18n } from "discourse-i18n";@@ -14,6 +15,7 @@ import AiBotSidebarEmptyState from "../components/ai-bot-sidebar-empty-state";import AiConversationSidebarContextMenu from "../components/ai-conversation-sidebar-context-menu";export const AI_CONVERSATIONS_PANEL = "ai-conversations";+const AI_CONVERSATIONS_HOMEPAGE = "ai-conversations";const SCROLL_BUFFER = 100;const DEBOUNCE = 100;const TITLE_CHANNEL = `/discourse-ai/ai-bot/topic-titles`;@@ -264,12 +266,19 @@ export default class AiConversationsSidebarManager extends Service {}_captureLastKnownAppURL() {+ // When conversations are the homepage, `/` is not a way back to the forum.+ const conversationsIsHomepage =+ defaultHomepage() === AI_CONVERSATIONS_HOMEPAGE;const lastForumUrl = this.routeHistory.history.find((url) => {+ if (conversationsIsHomepage && url.split(/[?#]/, 1)[0] === "/") {+ return false;+ }+return !url.startsWith("/discourse-ai");});this.lastKnownAppURL =- lastForumUrl || this.router.urlFor(`discovery.${defaultHomepage()}`);+ lastForumUrl || this.router.urlFor(discoveryHomepageRoute());}_handleNewBotPM(topic) {diff --git a/plugins/discourse-ai/config/locales/client.en.yml b/plugins/discourse-ai/config/locales/client.en.ymlindex 1e49ba9896b..47eab273ca6 100644--- a/plugins/discourse-ai/config/locales/client.en.yml+++ b/plugins/discourse-ai/config/locales/client.en.yml@@ -1631,6 +1631,7 @@ en:mixtral-8x7B-Instruct-V0:"1": "Mixtral-8x7B V0.1"conversations:+ homepage_option: "AI bot conversations"header: "What can I help with?"submit: "Submit question"disclaimer: "Generative AI can make mistakes. Verify important information."diff --git a/plugins/discourse-ai/lib/ai_bot/entry_point.rb b/plugins/discourse-ai/lib/ai_bot/entry_point.rbindex d11ef5e784c..06d0cbc7c7c 100644--- a/plugins/discourse-ai/lib/ai_bot/entry_point.rb+++ b/plugins/discourse-ai/lib/ai_bot/entry_point.rb@@ -94,6 +94,17 @@ module DiscourseAiplugin.register_topic_custom_field_type(TOPIC_AI_BOT_PM_FIELD, :string)+ plugin.register_homepage(+ "ai-conversations",+ name: "discourse_ai.ai_bot.conversations.homepage_option",+ path: "/discourse-ai/ai-bot/conversations",+ route: "discourse_ai/ai_bot/conversations#index",+ enabled: -> { SiteSetting.ai_bot_enabled },+ available: ->(guardian:, request:) do+ EntryPoint.personal_message_bot_user_ids(guardian.user).present?+ end,+ )+# Hide bot PMs from the personal inbox queries (Latest, New, Unread)# so human conversations are not buried under bot replies. Sent and# Archive are intentionally untouched.diff --git a/plugins/discourse-ai/spec/lib/modules/ai_bot/entry_point_spec.rb b/plugins/discourse-ai/spec/lib/modules/ai_bot/entry_point_spec.rbindex a447868e2f8..d8e72a32cf6 100644--- a/plugins/discourse-ai/spec/lib/modules/ai_bot/entry_point_spec.rb+++ b/plugins/discourse-ai/spec/lib/modules/ai_bot/entry_point_spec.rb@@ -4,6 +4,37 @@ describe DiscourseAi::AiBot::EntryPoint dobefore { enable_current_plugin }describe "#inject_into" do+ describe "registers conversations as a homepage option" do+ fab!(:user)+ fab!(:bot_allowed_group, :group)+ fab!(:llm_model)++ before do+ toggle_enabled_bots(bots: [llm_model])+ SiteSetting.ai_bot_enabled = true+ SiteSetting.ai_bot_allowed_groups = bot_allowed_group.id.to_s+ SiteSetting.top_menu = "latest|new|top|categories"+ SiteSetting.default_homepage = "ai-conversations"+ bot_allowed_group.add(user)+ end++ it "offers conversations as a default homepage choice" do+ expect(HomepageSiteSetting.choices).to include("ai-conversations")+ expect(HomepageHelper.resolve(nil, user)).to eq("ai-conversations")+ end++ it "is not offered, and falls back to the top menu homepage, when the bot is disabled" do+ SiteSetting.ai_bot_enabled = false++ expect(HomepageSiteSetting.choices).not_to include("ai-conversations")+ expect(HomepageHelper.resolve(nil, user)).to eq("latest")+ end++ it "falls back to the top menu homepage for anonymous visitors" do+ expect(HomepageHelper.resolve).to eq("latest")+ end+ end+describe "subscribes to the post_created event" dofab!(:admin)fab!(:bot_allowed_group, :group)diff --git a/plugins/discourse-ai/spec/requests/ai_bot/conversations_controller_spec.rb b/plugins/discourse-ai/spec/requests/ai_bot/conversations_controller_spec.rbindex 40678c75d92..676d8f7ef01 100644--- a/plugins/discourse-ai/spec/requests/ai_bot/conversations_controller_spec.rb+++ b/plugins/discourse-ai/spec/requests/ai_bot/conversations_controller_spec.rb@@ -27,6 +27,38 @@ RSpec.describe DiscourseAi::AiBot::ConversationsController do[conversation, starred_conversation, other_conversation].each { |topic| mark_ai_bot_pm(topic) }end+ describe "GET /" do+ fab!(:bot_allowed_group, :group)+ fab!(:llm_model)++ before do+ toggle_enabled_bots(bots: [llm_model])+ SiteSetting.ai_bot_enabled = true+ SiteSetting.ai_bot_allowed_groups = bot_allowed_group.id.to_s+ SiteSetting.top_menu = "latest|new|top|categories"+ SiteSetting.default_homepage = "ai-conversations"+ SiteSetting.has_login_hint = false+ end++ it "renders conversations as the homepage for people who can use the bot" do+ bot_allowed_group.add(current_user)++ get "/"++ expect(response.status).to eq(200)+ expect(response.body).to include(+ '<meta name="discourse_current_homepage" content="ai-conversations">',+ )+ end++ it "renders the top menu homepage for people outside the bot's allowed groups" do+ get "/"++ expect(response.status).to eq(200)+ expect(response.body).to include('<meta name="discourse_current_homepage" content="latest">')+ end+ end+describe "GET /discourse-ai/ai-bot/conversations.json" dobefore doDiscourseAi::AiBot::ConversationStar.create!(user: current_user, topic: starred_conversation)diff --git a/plugins/discourse-ai/spec/system/ai_bot/default_homepage_spec.rb b/plugins/discourse-ai/spec/system/ai_bot/default_homepage_spec.rbnew file mode 100644index 00000000000..4c53f5efb79--- /dev/null+++ b/plugins/discourse-ai/spec/system/ai_bot/default_homepage_spec.rb@@ -0,0 +1,56 @@+# frozen_string_literal: true++RSpec.describe "AI Bot - Conversations as the default homepage" do+ let(:ai_pm_homepage) { PageObjects::Components::AiPmHomepage.new }+ let(:header) { PageObjects::Pages::DiscourseAi::Header.new }+ let(:login_form) { PageObjects::Pages::Login.new }++ fab!(:user) do+ Fabricate(:user, username: "john", password: "supersecurepassword", refresh_auto_groups: true)+ end+ fab!(:group)+ fab!(:gpt_4) { Fabricate(:llm_model, name: "gpt-4") }++ before do+ enable_current_plugin+ SiteSetting.ai_bot_enabled = true+ toggle_enabled_bots(bots: [gpt_4])+ SiteSetting.ai_bot_allowed_groups = group.id.to_s+ SiteSetting.ai_bot_add_to_header = true+ SiteSetting.navigation_menu = "sidebar"+ SiteSetting.top_menu = "hot|latest|new|categories"+ SiteSetting.default_homepage = "ai-conversations"+ group.add(user)+ end++ it "renders conversations at the root path and exits to the top menu homepage" do+ sign_in(user)++ visit "/"++ expect(ai_pm_homepage).to have_homepage+ expect(page).to have_current_path("/?agent=forum-helper")++ header.click_bot_button++ expect(ai_pm_homepage).to have_no_homepage+ expect(page).to have_current_path("/hot")+ end++ it "asks anonymous visitors to log in when login is required, then shows conversations" do+ SiteSetting.login_required = true+ SiteSetting.enable_local_logins_via_code = false+ EmailToken.confirm(Fabricate(:email_token, user: user).token)++ visit "/"++ expect(page).to have_css(".login-welcome")+ expect(ai_pm_homepage).to have_no_homepage++ find(".login-welcome .login-button").click+ login_form.fill(username: "john", password: "supersecurepassword").click_login++ expect(ai_pm_homepage).to have_homepage+ expect(page).to have_current_path("/?agent=forum-helper")+ end+enddiff --git a/plugins/discourse-chat-integration/assets/javascripts/discourse/routes/transcript.js b/plugins/discourse-chat-integration/assets/javascripts/discourse/routes/transcript.jsindex efa901f6a21..495790e62f5 100644--- a/plugins/discourse-chat-integration/assets/javascripts/discourse/routes/transcript.js+++ b/plugins/discourse-chat-integration/assets/javascripts/discourse/routes/transcript.js@@ -1,7 +1,7 @@import { service } from "@ember/service";import { ajax } from "discourse/lib/ajax";import { popupAjaxError } from "discourse/lib/ajax-error";-import { defaultHomepage } from "discourse/lib/utilities";+import { homepageNavigationDestination } from "discourse/lib/homepage-router-overrides";import DiscourseRoute from "discourse/routes/discourse";export default class Transcript extends DiscourseRoute {@@ -16,7 +16,7 @@ export default class Transcript extends DiscourseRoute {}await this.router- .replaceWith(`discovery.${defaultHomepage()}`)+ .replaceWith(homepageNavigationDestination()).followRedirects();try {diff --git a/plugins/voice/assets/javascripts/discourse/components/voice/room-page.gjs b/plugins/voice/assets/javascripts/discourse/components/voice/room-page.gjsindex 8345895d632..ea4300436f8 100644--- a/plugins/voice/assets/javascripts/discourse/components/voice/room-page.gjs+++ b/plugins/voice/assets/javascripts/discourse/components/voice/room-page.gjs@@ -10,8 +10,8 @@ import { cancel, next } from "@ember/runloop";import { service } from "@ember/service";import { trustHTML } from "@ember/template";import DMenu from "discourse/float-kit/components/d-menu";+import { homepageNavigationDestination } from "discourse/lib/homepage-router-overrides";import discourseLater from "discourse/lib/later";-import { defaultHomepage } from "discourse/lib/utilities";import { or } from "discourse/truth-helpers";import DButton from "discourse/ui-kit/d-button";import DDropdownMenu from "discourse/ui-kit/d-dropdown-menu";@@ -419,7 +419,7 @@ export default class VoiceRoomPage extends Component {}// Nothing to return to, e.g. the room page was opened directly.- this.router.replaceWith(`discovery.${defaultHomepage()}`);+ this.router.replaceWith(homepageNavigationDestination());}@actiondiff --git a/plugins/voice/assets/javascripts/discourse/routes/voice-room.js b/plugins/voice/assets/javascripts/discourse/routes/voice-room.jsindex 6eb7854116e..6f922a3a2d3 100644--- a/plugins/voice/assets/javascripts/discourse/routes/voice-room.js+++ b/plugins/voice/assets/javascripts/discourse/routes/voice-room.js@@ -1,6 +1,6 @@import { service } from "@ember/service";import { ajax } from "discourse/lib/ajax";-import { defaultHomepage } from "discourse/lib/utilities";+import { homepageNavigationDestination } from "discourse/lib/homepage-router-overrides";import DiscourseRoute from "discourse/routes/discourse";import urlFlagSet from "discourse/plugins/voice/discourse/lib/voice/url-flag";@@ -38,7 +38,7 @@ export default class VoiceRoomRoute extends DiscourseRoute {return;}- this.router.replaceWith(`discovery.${defaultHomepage()}`);+ this.router.replaceWith(homepageNavigationDestination());}titleToken() {diff --git a/spec/lib/homepage_helper_spec.rb b/spec/lib/homepage_helper_spec.rbindex 35075196cf8..d3c3482823a 100644--- a/spec/lib/homepage_helper_spec.rb+++ b/spec/lib/homepage_helper_spec.rb@@ -86,6 +86,100 @@ RSpec.describe HomepageHelper doendend+ context "with a registered homepage" do+ let(:plugin) { Plugin::Instance.new }++ around do |example|+ registrations = DiscoursePluginRegistry._raw_homepage_options.dup+ example.run+ DiscoursePluginRegistry._raw_homepage_options.replace(registrations)+ end++ before do+ plugin.stubs(:enabled?).returns(true)+ SiteSetting.top_menu = "new|top|latest"+ end++ it "falls back to the top menu when the homepage is unavailable" do+ plugin.register_homepage(+ "members_only",+ name: "plugin.members_only",+ path: "/members-only",+ route: "plugin#index",+ anonymous: true,+ available: ->(guardian:, request:) { !guardian.anonymous? },+ )+ SiteSetting.default_homepage = "members_only"++ expect(HomepageHelper.resolve(nil, user)).to eq("members_only")+ expect(HomepageHelper.resolve).to eq("top")+ end++ it "checks availability once per request and user" do+ calls = 0+ plugin.register_homepage(+ "counted",+ name: "plugin.counted",+ path: "/counted",+ route: "plugin#index",+ available: ->(guardian:, request:) do+ calls += 1+ true+ end,+ )+ SiteSetting.default_homepage = "counted"+ request = ActionDispatch::TestRequest.create++ 3.times { HomepageHelper.resolve(request, user) }+ expect(calls).to eq(1)++ HomepageHelper.resolve(request, Fabricate(:user))+ expect(calls).to eq(2)+ end++ it "falls back to the top menu when the availability check raises" do+ plugin.register_homepage(+ "broken",+ name: "plugin.broken",+ path: "/broken",+ route: "plugin#index",+ available: ->(guardian:, request:) { raise "availability check failed" },+ )+ SiteSetting.default_homepage = "broken"++ expect(HomepageHelper.resolve(nil, user)).to eq("new")+ end++ it "gives the availability check a guardian bound to the request" do+ current_request = ActionDispatch::TestRequest.create+ plugin.register_homepage(+ "request_bound",+ name: "plugin.request_bound",+ path: "/request-bound",+ route: "plugin#index",+ available: ->(guardian:, request:) { guardian.request.equal?(request) },+ )+ SiteSetting.default_homepage = "request_bound"++ expect(HomepageHelper.resolve(current_request, user)).to eq("request_bound")+ end++ it "passes the request to the availability check" do+ crawler_request = ActionDispatch::TestRequest.create("HTTP_USER_AGENT" => "Googlebot")+ plugin.register_homepage(+ "humans_only",+ name: "plugin.humans_only",+ path: "/humans-only",+ route: "plugin#index",+ available: ->(guardian:, request:) { !CrawlerDetection.crawler_layout_request?(request) },+ )+ SiteSetting.default_homepage = "humans_only"++ expect(HomepageHelper.resolve(nil, user)).to eq("humans_only")+ expect(HomepageHelper.resolve(crawler_request, user)).to eq("new")+ end+ end+context "with login required" dobefore doSiteSetting.login_required = truediff --git a/spec/lib/plugin/instance_spec.rb b/spec/lib/plugin/instance_spec.rbindex b2736677790..a96e0762516 100644--- a/spec/lib/plugin/instance_spec.rb+++ b/spec/lib/plugin/instance_spec.rb@@ -1223,6 +1223,8 @@ TEXTroute: "sample_plugin/homepage#index",anonymous: true,server_side: false,+ enabled: nil,+ available: nil,},)@@ -1259,6 +1261,26 @@ TEXT)end.to raise_error(ArgumentError, /server_side/)+ expect do+ plugin_instance.register_homepage(+ "other_homepage",+ name: "plugin.other_homepage",+ path: "/other",+ route: "plugin#other",+ available: true,+ )+ end.to raise_error(ArgumentError, /available/)++ expect do+ plugin_instance.register_homepage(+ "other_homepage",+ name: "plugin.other_homepage",+ path: "/other",+ route: "plugin#other",+ enabled: true,+ )+ end.to raise_error(ArgumentError, /enabled/)+plugin_instance.register_homepage("sample_homepage",name: "plugin.homepage",diff --git a/spec/models/homepage_site_setting_spec.rb b/spec/models/homepage_site_setting_spec.rbindex 4d3989a25e5..c62ea0cc7fa 100644--- a/spec/models/homepage_site_setting_spec.rb+++ b/spec/models/homepage_site_setting_spec.rb@@ -43,6 +43,38 @@ describe HomepageSiteSetting doexpect(described_class.values.map { |value| value[:value] }).not_to include("directory")end+ it "offers a plugin homepage only while its enabled condition holds" do+ plugin = Plugin::Instance.new+ plugin.stubs(:enabled?).returns(true)+ plugin.register_homepage(+ "directory",+ name: "discourse_directory.navigation.title",+ path: "/directory",+ route: "discourse_directory/directory#index",+ enabled: -> { SiteSetting.enable_user_directory },+ )++ SiteSetting.enable_user_directory = true+ expect(described_class.choices).to include("directory")++ SiteSetting.enable_user_directory = false+ expect(described_class.choices).not_to include("directory")+ end++ it "does not offer a plugin homepage whose enabled condition raises" do+ plugin = Plugin::Instance.new+ plugin.stubs(:enabled?).returns(true)+ plugin.register_homepage(+ "directory",+ name: "discourse_directory.navigation.title",+ path: "/directory",+ route: "discourse_directory/directory#index",+ enabled: -> { raise "enabled check failed" },+ )++ expect(described_class.choices).not_to include("directory")+ end+it "does not offer unread when it is excluded from top menu choices" doTopMenu.stubs(:choices).returns(%w[latest new top categories])diff --git a/spec/models/site_setting_spec.rb b/spec/models/site_setting_spec.rbindex e66a20633b4..c09ccf54be5 100644--- a/spec/models/site_setting_spec.rb+++ b/spec/models/site_setting_spec.rb@@ -156,6 +156,26 @@ RSpec.describe SiteSetting doexpect(SiteSetting.anonymous_homepage).to eq("categories")end+ it "falls back when a registered plugin homepage's enabled condition fails" do+ plugin = Plugin::Instance.new+ plugin.stubs(:enabled?).returns(true)+ plugin.register_homepage(+ "directory",+ name: "discourse_directory.navigation.title",+ path: "/directory",+ route: "discourse_directory/directory#index",+ anonymous: true,+ enabled: -> { SiteSetting.enable_user_directory },+ )+ SiteSetting.top_menu = "categories|latest"+ SiteSetting.default_homepage = "directory"++ SiteSetting.enable_user_directory = false++ expect(SiteSetting.homepage).to eq("categories")+ expect(SiteSetting.anonymous_homepage).to eq("categories")+ end+it "does not use a private plugin homepage for anonymous visitors" doplugin = Plugin::Instance.newplugin.stubs(:enabled?).returns(true)diff --git a/spec/requests/home_page_controller_spec.rb b/spec/requests/home_page_controller_spec.rbindex bbde504f039..e370af26fef 100644--- a/spec/requests/home_page_controller_spec.rb+++ b/spec/requests/home_page_controller_spec.rb@@ -2,6 +2,61 @@RSpec.describe HomePageController dodescribe "homepage" do+ context "with a registered homepage that has an availability check" do+ fab!(:user)++ let(:plugin) { Plugin::Instance.new }+ let(:allowed_user_ids) { [] }+ let(:check_calls) { [] }++ before do+ SiteSetting.has_login_hint = false+ SiteSetting.top_menu = "latest|new|top|categories"+ plugin.stubs(:enabled?).returns(true)+ plugin.register_homepage(+ "members",+ name: "plugin.members",+ path: "/members",+ route: "home_page#blank",+ available: ->(guardian:, request:) do+ check_calls << guardian.user&.id+ allowed_user_ids.include?(guardian.user&.id)+ end,+ )+ Rails.application.reload_routes!+ SiteSetting.default_homepage = "members"+ sign_in(user)+ end++ after do+ DiscoursePluginRegistry._raw_homepage_options.reject! do |registration|+ registration[:plugin] == plugin+ end+ Rails.application.reload_routes!+ end++ it "serves the registered homepage and checks availability once" do+ allowed_user_ids << user.id++ get "/"++ expect(response.status).to eq(200)+ expect(response.body).to include(+ '<meta name="discourse_current_homepage" content="members">',+ )+ expect(check_calls.size).to eq(1)+ end++ it "serves the top menu homepage when the registered one is unavailable" do+ get "/"++ expect(response.status).to eq(200)+ expect(response.body).to include(+ '<meta name="discourse_current_homepage" content="latest">',+ )+ end+ end+context "with crawler view" dobefore doSiteSetting.site_description = "This is a test description"