Skip to content

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

UX: Do not prefill basic category details when not first category type (#38322)

Martin Brennane85f4d58107c
diff --git a/app/controllers/categories_controller.rb b/app/controllers/categories_controller.rb
index 5abbc53a440..fae8db12f5e 100644
--- a/app/controllers/categories_controller.rb
+++ b/app/controllers/categories_controller.rb
@@ -129,7 +129,15 @@ class CategoriesController < ApplicationController
def types
guardian.ensure_can_create_category!
- render json: { types: Categories::TypeRegistry.list }
+
+ counts_by_type =
+ Discourse
+ .cache
+ .fetch(Categories::TypeRegistry::COUNTS_CACHE_KEY, expires_in: 1.hour) do
+ Categories::TypeRegistry.counts
+ end
+
+ render json: { types: Categories::TypeRegistry.list, counts: counts_by_type }
end
def show
@@ -321,6 +329,7 @@ class CategoriesController < ApplicationController
def destroy
guardian.ensure_can_delete!(@category)
@category.destroy
+ Discourse.cache.delete(Categories::TypeRegistry::COUNTS_CACHE_KEY)
Scheduler::Defer.later "Log staff action delete category" do
@staff_action_logger.log_category_deletion(@category)
diff --git a/app/services/categories/configure.rb b/app/services/categories/configure.rb
index 47c49138c4c..5a792c98f03 100644
--- a/app/services/categories/configure.rb
+++ b/app/services/categories/configure.rb
@@ -34,6 +34,7 @@ module Categories
end
step :log_action
+ step :clear_category_type_counts_cache
private
@@ -79,5 +80,9 @@ module Categories
{ category_id: category.id, category_type: params.category_type },
)
end
+
+ def clear_category_type_counts_cache
+ Discourse.cache.delete(Categories::TypeRegistry::COUNTS_CACHE_KEY)
+ end
end
end
diff --git a/app/services/categories/type_registry.rb b/app/services/categories/type_registry.rb
index 8e80a20c9a6..d6dbb133a8e 100644
--- a/app/services/categories/type_registry.rb
+++ b/app/services/categories/type_registry.rb
@@ -2,9 +2,15 @@
module Categories
class TypeRegistry
+ COUNTS_CACHE_KEY = "category_type_counts"
+
class << self
def register(klass, plugin_identifier: nil)
id = klass.type_id
+ unless id.to_s.match?(/\A[a-z0-9_]+\z/)
+ raise ArgumentError,
+ "Category type_id '#{id}' must only contain lowercase letters, digits, and underscores"
+ end
if types.key?(id) && owners[id] != plugin_identifier
raise ArgumentError,
"Category type '#{id}' is already registered#{owners[id] ? " by #{owners[id]}" : ""}"
@@ -38,6 +44,34 @@ module Categories
@owners = nil
end
+ # Returns all the category type counts in a hash with the type
+ # and count like this:
+ #
+ # {
+ # discussion: 10,
+ # support: 5,
+ # }
+ #
+ # Relies on the find_matches method overriden by each category type
+ # to return an AR relation that will be used to count the categories.
+ def counts
+ type_list = types.values
+ return {} if type_list.empty?
+
+ # We want to get all the counts in a single query to avoid N1
+ conn = Category.connection
+ select_parts =
+ type_list.map do |type|
+ subquery_sql = type.find_matches.select("COUNT(*)").to_sql
+ alias_name = conn.quote_column_name(type.type_id.to_s)
+ "(#{subquery_sql}) AS #{alias_name}"
+ end
+ result = conn.select_one("SELECT #{select_parts.join(", ")}")
+ type_list.each_with_object({}) do |type, counts|
+ counts[type.type_id] = (result[type.type_id.to_s] || 0).to_i
+ end
+ end
+
private
def types
diff --git a/app/services/categories/types/base.rb b/app/services/categories/types/base.rb
index e54af34393e..576f483d504 100644
--- a/app/services/categories/types/base.rb
+++ b/app/services/categories/types/base.rb
@@ -76,6 +76,16 @@ module Categories
raise NotImplementedError
end
+ # Returns a relation for categories that match this type (for counting, listing, etc.).
+ # Override in subclasses that match a subset of categories (e.g. by custom_fields).
+ #
+ # Basically the same as category_matches but for a list instead.
+ #
+ # See Categories::TypeRegistry.counts for an example of how this is used.
+ def find_matches
+ raise NotImplementedError
+ end
+
# Use this to enable any related plugin for the category type,
# since we register category types without the plugin being enabled.
#
diff --git a/app/services/categories/types/discussion.rb b/app/services/categories/types/discussion.rb
index 14bceb4d577..5a19012ddcc 100644
--- a/app/services/categories/types/discussion.rb
+++ b/app/services/categories/types/discussion.rb
@@ -6,6 +6,14 @@ module Categories
type_id :discussion
class << self
+ def find_matches
+ # All categories are implicitly discussion categories, so there's no
+ # meaningful subset to count. Returning Category.none keeps count at 0,
+ # which means discussion always prefills — correct since it has no
+ # general_category_settings to prefill anyway.
+ Category.none
+ end
+
def category_matches?(category)
# NOTE (martin) For now, all categories are considered discussion categories,
# a discussion category is basically the old "vanilla" category type
diff --git a/frontend/discourse/admin/routes/new-category/setup.js b/frontend/discourse/admin/routes/new-category/setup.js
index 3cf55f16e5b..8664016d22c 100644
--- a/frontend/discourse/admin/routes/new-category/setup.js
+++ b/frontend/discourse/admin/routes/new-category/setup.js
@@ -14,8 +14,7 @@ export default class NewCategorySetup extends DiscourseRoute {
}
async model() {
- const result = await ajax("/categories/types");
- return result.types;
+ return await ajax("/categories/types");
}
titleToken() {
diff --git a/frontend/discourse/admin/routes/new-category/tabs.js b/frontend/discourse/admin/routes/new-category/tabs.js
index 88064823ffa..d7006ac814d 100644
--- a/frontend/discourse/admin/routes/new-category/tabs.js
+++ b/frontend/discourse/admin/routes/new-category/tabs.js
@@ -40,9 +40,13 @@ export default class NewCategoryTabs extends DiscourseRoute {
};
model.set("category_types", initialTypes);
- result.typeSchema.general_category_settings?.forEach((setting) => {
- model.set(setting.key, setting.default);
- });
+ // Only want to prefill the general settings (name etc) if it's the
+ // first category of this type.
+ if ((result.count ?? 0) === 0) {
+ result.typeSchema.general_category_settings?.forEach((setting) => {
+ model.set(setting.key, setting.default);
+ });
+ }
}
const selectedTab = transition.to.params.tab;
diff --git a/frontend/discourse/admin/templates/new-category/setup.gjs b/frontend/discourse/admin/templates/new-category/setup.gjs
index 1b971d02076..a09da86edf3 100644
--- a/frontend/discourse/admin/templates/new-category/setup.gjs
+++ b/frontend/discourse/admin/templates/new-category/setup.gjs
@@ -5,6 +5,6 @@ import { i18n } from "discourse-i18n";
export default <template>
<div class="edit-category admin-new-category-setup">
<DPageHeader @titleLabel={{i18n "category.choose_type.title"}} />
- <CategoryTypeCards @types={{@model}} />
+ <CategoryTypeCards @types={{@model.types}} @counts={{@model.counts}} />
</div>
</template>
diff --git a/frontend/discourse/app/components/category-type-cards.gjs b/frontend/discourse/app/components/category-type-cards.gjs
index 640bea50529..49546e78f1d 100644
--- a/frontend/discourse/app/components/category-type-cards.gjs
+++ b/frontend/discourse/app/components/category-type-cards.gjs
@@ -19,7 +19,8 @@ export default class CategoryTypeCards extends Component {
type.id,
type.name,
type.configuration_schema,
- type.title
+ type.title,
+ this.args.counts[type.id]
);
this.router.transitionTo("newCategory.tabs", "general");
}
diff --git a/frontend/discourse/app/services/category-type-chooser.js b/frontend/discourse/app/services/category-type-chooser.js
index f898fec7783..bb32cf67064 100644
--- a/frontend/discourse/app/services/category-type-chooser.js
+++ b/frontend/discourse/app/services/category-type-chooser.js
@@ -15,8 +15,8 @@ export default class CategoryTypeChooser extends Service {
return this._selection !== null || this._setupComplete;
}
- choose(typeId, typeName, typeSchema, typeTitle) {
- this._selection = { type: typeId, typeName, typeSchema, typeTitle };
+ choose(typeId, typeName, typeSchema, typeTitle, count) {
+ this._selection = { type: typeId, typeName, typeSchema, typeTitle, count };
this._setupComplete = true;
}
diff --git a/frontend/discourse/tests/acceptance/category-new-test.js b/frontend/discourse/tests/acceptance/category-new-test.js
index ae2f3dddfb9..30e794a9990 100644
--- a/frontend/discourse/tests/acceptance/category-new-test.js
+++ b/frontend/discourse/tests/acceptance/category-new-test.js
@@ -147,6 +147,10 @@ acceptance("Category type setup page", function (needs) {
available: true,
},
],
+ counts: {
+ discussion: 1,
+ support: 0,
+ },
});
});
});
diff --git a/plugins/discourse-solved/app/services/discourse_solved/categories/types/support.rb b/plugins/discourse-solved/app/services/discourse_solved/categories/types/support.rb
index b20f6415a04..457c66d50d2 100644
--- a/plugins/discourse-solved/app/services/discourse_solved/categories/types/support.rb
+++ b/plugins/discourse-solved/app/services/discourse_solved/categories/types/support.rb
@@ -15,6 +15,16 @@ module DiscourseSolved
category.custom_fields[DiscourseSolved::ENABLE_ACCEPTED_ANSWERS_CUSTOM_FIELD] == "true"
end
+ def find_matches
+ Category
+ .joins(:_custom_fields)
+ .where(
+ "category_custom_fields.name = ?",
+ DiscourseSolved::ENABLE_ACCEPTED_ANSWERS_CUSTOM_FIELD,
+ )
+ .where("category_custom_fields.value = ?", "true")
+ end
+
def configure_category(category, guardian:, configuration_values: {})
configuration_values.merge!(
DiscourseSolved::ENABLE_ACCEPTED_ANSWERS_CUSTOM_FIELD => "true",
diff --git a/plugins/discourse-solved/spec/models/discourse_solved/categories_types_support_spec.rb b/plugins/discourse-solved/spec/models/discourse_solved/categories_types_support_spec.rb
index ffecaf8e621..2fd1a4c1b42 100644
--- a/plugins/discourse-solved/spec/models/discourse_solved/categories_types_support_spec.rb
+++ b/plugins/discourse-solved/spec/models/discourse_solved/categories_types_support_spec.rb
@@ -3,6 +3,7 @@
require "rails_helper"
RSpec.describe DiscourseSolved::Categories::Types::Support do
+ fab!(:admin)
fab!(:category)
describe ".enable_plugin" do
@@ -15,8 +16,6 @@ RSpec.describe DiscourseSolved::Categories::Types::Support do
end
describe ".configure_site_settings" do
- fab!(:admin)
-
before do
SiteSetting.show_filter_by_solved_status = false
SiteSetting.notify_on_staff_accept_solved = false
@@ -48,7 +47,6 @@ RSpec.describe DiscourseSolved::Categories::Types::Support do
end
describe ".configure_category" do
- fab!(:admin)
fab!(:topic) { Fabricate(:topic, category: category) }
fab!(:reply) { Fabricate(:post, topic: topic, post_number: 2) }
@@ -57,6 +55,13 @@ RSpec.describe DiscourseSolved::Categories::Types::Support do
DiscourseSolved::AcceptedAnswerCache.reset_accepted_answer_cache
end
+ it "sets the enable_accepted_answers custom field to true" do
+ described_class.configure_category(category, guardian: admin.guardian)
+ expect(category.custom_fields[DiscourseSolved::ENABLE_ACCEPTED_ANSWERS_CUSTOM_FIELD]).to eq(
+ "true",
+ )
+ end
+
it "allows accepting answers on the category" do
expect(Guardian.new(admin).can_accept_answer?(topic, reply)).to eq(false)
@@ -83,4 +88,21 @@ RSpec.describe DiscourseSolved::Categories::Types::Support do
expect(category.custom_fields["solved_topics_auto_close_hours"]).to eq("72")
end
end
+
+ describe ".find_matches" do
+ fab!(:other_category, :category)
+
+ before { described_class.configure_category(category, guardian: admin.guardian) }
+
+ it "returns a relation for support categories" do
+ matches = described_class.find_matches
+ expect(matches).to be_a(ActiveRecord::Relation)
+ expect(matches.to_a).to include(category)
+ expect(matches.to_a).not_to include(other_category)
+ end
+
+ it "counts the support categories" do
+ expect(Categories::TypeRegistry.counts[:support]).to eq(1)
+ end
+ end
end
diff --git a/plugins/discourse-solved/spec/system/support_category_type_setup_spec.rb b/plugins/discourse-solved/spec/system/support_category_type_setup_spec.rb
index 467e49fc542..4b8a4d0197f 100644
--- a/plugins/discourse-solved/spec/system/support_category_type_setup_spec.rb
+++ b/plugins/discourse-solved/spec/system/support_category_type_setup_spec.rb
@@ -42,6 +42,30 @@ RSpec.describe "Support Category Type Setup", type: :system do
expect(category.custom_fields["solved_topics_auto_close_hours"]).to eq("48")
end
+ context "when there is a support category already configured" do
+ fab!(:category)
+
+ before do
+ DiscourseSolved::Categories::Types::Support.configure_category(
+ category,
+ guardian: admin.guardian,
+ )
+ end
+
+ it "does not preload basic data for the support category type" do
+ visit("/new-category/setup")
+ category_type_card.find_type_card("support").click
+
+ expect(page).to have_content(I18n.t("js.category.create_with_type", typeName: "support"))
+ expect(form.field("name").value).to eq("")
+ expect(
+ form.field("style_type").find(".form-kit__control-radio[type='radio'][value='emoji']")[
+ "checked"
+ ],
+ ).to eq(nil)
+ end
+ end
+
context "when visiting the Support tab for a non-support category" do
fab!(:category)
diff --git a/spec/services/categories/configure_spec.rb b/spec/services/categories/configure_spec.rb
index e5d3986730d..ecc5f37ce71 100644
--- a/spec/services/categories/configure_spec.rb
+++ b/spec/services/categories/configure_spec.rb
@@ -1,88 +1,83 @@
# frozen_string_literal: true
RSpec.describe Categories::Configure do
- fab!(:admin)
- fab!(:category)
-
- let(:guardian) { Guardian.new(admin) }
+ describe Categories::Configure::Contract, type: :model do
+ it { is_expected.to validate_presence_of(:category_id) }
+ it { is_expected.to validate_presence_of(:category_type) }
+ end
describe ".call" do
- context "with valid params" do
- it "configures the discussion type successfully" do
- result =
- described_class.call(
- guardian:,
- params: {
- category_id: category.id,
- category_type: "discussion",
- },
- )
-
- expect(result).to be_success
- end
+ subject(:result) { described_class.call(params:, **dependencies) }
- it "logs a staff action" do
- described_class.call(
- guardian:,
- params: {
- category_id: category.id,
- category_type: "discussion",
- },
- )
+ fab!(:admin)
+ fab!(:category)
- log =
- UserHistory.find_by(
- acting_user_id: admin.id,
- action: UserHistory.actions[:custom_staff],
- custom_type: "configure_category_type",
- )
- expect(log).to be_present
- expect(log.details).to include("category_type")
- end
+ let(:params) { { category_id: category.id, category_type: "discussion" } }
+ let(:dependencies) { { guardian: admin.guardian } }
+
+ context "when params are invalid" do
+ let(:params) { { category_id: nil, category_type: nil } }
+
+ it { is_expected.to fail_a_contract }
end
- context "with invalid category_id" do
- it "fails with model not found" do
- result =
- described_class.call(guardian:, params: { category_id: -1, category_type: "discussion" })
+ context "when category type is invalid" do
+ let(:params) { super().merge(category_type: "invalid_type") }
- expect(result).to be_failure
- expect(result["result.model.category"].not_found).to be true
- end
+ it { is_expected.to fail_a_contract }
end
- context "with invalid category_type" do
- it "fails with contract error" do
- result =
- described_class.call(
- guardian:,
- params: {
- category_id: category.id,
- category_type: "invalid_type",
- },
- )
-
- expect(result).to be_failure
- expect(result["result.contract.default"].errors[:category_type]).to be_present
- end
+ context "when category is not found" do
+ let(:params) { super().merge(category_id: -1) }
+
+ it { is_expected.to fail_to_find_a_model(:category) }
end
context "when user cannot modify category" do
fab!(:user)
- let(:guardian) { Guardian.new(user) }
-
- it "fails with policy error" do
- result =
- described_class.call(
- guardian:,
- params: {
- category_id: category.id,
- category_type: "discussion",
- },
- )
-
- expect(result).to be_failure
- expect(result["result.policy.can_modify_category"]).to be_failure
+ let(:dependencies) { { guardian: user.guardian } }
+
+ it { is_expected.to fail_a_policy(:can_modify_category) }
+ end
+
+ context "when type is not available" do
+ before { allow(Categories::Types::Discussion).to receive(:available?).and_return(false) }
+
+ it { is_expected.to fail_a_policy(:type_is_available) }
+ end
+
+ context "when everything's ok" do
+ it { is_expected.to run_successfully }
+
+ it "calls enable_plugin on the type class" do
+ Categories::Types::Discussion.expects(:enable_plugin).once
+ result
+ end
+
+ it "calls configure_site_settings on the type class" do
+ Categories::Types::Discussion.expects(:configure_site_settings).once
+ result
+ end
+
+ it "calls configure_category on the type class" do
+ Categories::Types::Discussion.expects(:configure_category).once
+ result
+ end
+
+ it "logs a staff action" do
+ expect { result }.to change { UserHistory.count }.by(1)
+ expect(UserHistory.last).to have_attributes(
+ action: UserHistory.actions[:custom_staff],
+ custom_type: "configure_category_type",
+ acting_user_id: admin.id,
+ )
+ expect(UserHistory.last.details).to include("category_type")
+ end
+
+ it "clears the category type counts cache" do
+ Discourse.cache.write(Categories::TypeRegistry::COUNTS_CACHE_KEY, "cached_value")
+ result
+ expect(Discourse.cache.read(Categories::TypeRegistry::COUNTS_CACHE_KEY)).to be_nil
end
end
end
diff --git a/spec/services/categories/type_registry_spec.rb b/spec/services/categories/type_registry_spec.rb
index ec6ca90cb40..04bb04c0f2f 100644
--- a/spec/services/categories/type_registry_spec.rb
+++ b/spec/services/categories/type_registry_spec.rb
@@ -44,6 +44,26 @@ RSpec.describe Categories::TypeRegistry do
end
end
+ describe ".counts" do
+ it "returns a hash of type_id => count in a single query" do
+ counts = nil
+ queries = track_sql_queries { counts = described_class.counts }
+
+ expect(counts).to be_a(Hash)
+ expect(counts.keys).to include(:discussion)
+ expect(counts.values).to all(be_a(Integer))
+ expect(queries.size).to eq(1)
+ end
+
+ it "returns empty hash when no types are registered" do
+ original_types = described_class.all.dup
+ described_class.reset!
+ expect(described_class.counts).to eq({})
+ ensure
+ original_types&.each_value { |klass| described_class.register(klass) }
+ end
+ end
+
describe ".register" do
let(:test_type) do
Class.new(Categories::Types::Base).tap { |t| t.type_id(:test_registry_type) }
@@ -58,6 +78,14 @@ RSpec.describe Categories::TypeRegistry do
expect(described_class.valid?(:test_registry_type)).to be true
end
+ it "raises when type_id contains invalid characters" do
+ invalid_type = Class.new(Categories::Types::Base).tap { |t| t.type_id(:"invalid-type!") }
+ expect { described_class.register(invalid_type) }.to raise_error(
+ ArgumentError,
+ /must only contain lowercase letters/,
+ )
+ end
+
it "raises when a type_id is already registered by another owner" do
described_class.register(test_type, plugin_identifier: "plugin-a")