Skip to content

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

DEV: Move category approval settings to join table (#38523)

Alan Guo Xiang Tan79a4bafbbc12
diff --git a/app/models/category.rb b/app/models/category.rb
index 73191d0d81d..a239a9be238 100644
--- a/app/models/category.rb
+++ b/app/models/category.rb
@@ -37,6 +37,7 @@ class Category < ActiveRecord::Base
has_many :category_groups, dependent: :destroy
has_many :category_moderation_groups, dependent: :destroy
+ has_many :category_posting_review_groups, dependent: :destroy
has_many :groups, through: :category_groups
has_many :moderating_groups, through: :category_moderation_groups, source: :group
has_many :topic_timers, dependent: :destroy
diff --git a/app/models/category_posting_review_group.rb b/app/models/category_posting_review_group.rb
new file mode 100644
index 00000000000..4f5a45208f6
--- /dev/null
+++ b/app/models/category_posting_review_group.rb
@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class CategoryPostingReviewGroup < ActiveRecord::Base
+ belongs_to :category
+ belongs_to :group
+
+ validates :category, presence: true
+ validates :group, presence: true
+ validate :only_everyone_group_with_required_permission
+
+ enum :post_type, { topic: 0, reply: 1 }
+ enum :permission, { exempt: 0, required: 1 }
+
+ private
+
+ def only_everyone_group_with_required_permission
+ if group_id != Group::AUTO_GROUPS[:everyone]
+ errors.add(
+ :base,
+ "Group-based approval permissions for specific groups are not supported yet",
+ )
+ end
+ end
+end
+
+# == Schema Information
+#
+# Table name: category_posting_review_groups
+#
+# id :bigint not null, primary key
+# permission :integer not null
+# post_type :integer not null
+# created_at :datetime not null
+# updated_at :datetime not null
+# category_id :integer not null
+# group_id :integer not null
+#
+# Indexes
+#
+# idx_category_posting_review_groups_unique (category_id,group_id,post_type) UNIQUE
+#
diff --git a/app/models/category_setting.rb b/app/models/category_setting.rb
index 95eb4a215d1..e879278ffc0 100644
--- a/app/models/category_setting.rb
+++ b/app/models/category_setting.rb
@@ -1,8 +1,33 @@
# frozen_string_literal: true
class CategorySetting < ActiveRecord::Base
+ # TODO: drop columns require_topic_approval, require_reply_approval in a future migration
+ self.ignored_columns += %i[require_topic_approval require_reply_approval]
+
belongs_to :category
+ before_save :sync_posting_review_groups
+
+ def require_topic_approval=(value)
+ @require_topic_approval = value
+ updated_at_will_change!
+ end
+
+ def require_reply_approval=(value)
+ @require_reply_approval = value
+ updated_at_will_change!
+ end
+
+ def require_topic_approval
+ goldiload { |ids| CategorySetting.approval_required_map(ids, :topic) }
+ end
+ alias_method :require_topic_approval?, :require_topic_approval
+
+ def require_reply_approval
+ goldiload { |ids| CategorySetting.approval_required_map(ids, :reply) }
+ end
+ alias_method :require_reply_approval?, :require_reply_approval
+
validates :num_auto_bump_daily,
numericality: {
only_integer: true,
@@ -16,6 +41,41 @@ class CategorySetting < ActiveRecord::Base
greater_than_or_equal_to: 0,
allow_nil: true,
}
+
+ def self.approval_required_map(ids, post_type)
+ approved_ids =
+ where(
+ id: ids,
+ category_id:
+ CategoryPostingReviewGroup.where(post_type: post_type, permission: :required).select(
+ :category_id,
+ ),
+ ).pluck(:id).to_set
+
+ ids.index_with { |id| approved_ids.include?(id) }
+ end
+
+ private
+
+ def sync_posting_review_groups
+ return if @require_topic_approval.nil? && @require_reply_approval.nil?
+
+ everyone = Group[:everyone]
+
+ { topic: @require_topic_approval, reply: @require_reply_approval }.each do |type, value|
+ next if value.nil?
+
+ scope = category.category_posting_review_groups.where(post_type: type)
+ if ActiveModel::Type::Boolean.new.cast(value)
+ scope.create_or_find_by!(permission: :required, group: everyone)
+ else
+ scope.where(group: everyone, permission: :required).delete_all
+ end
+ end
+
+ @require_topic_approval = nil
+ @require_reply_approval = nil
+ end
end
# == Schema Information
@@ -23,13 +83,12 @@ end
# Table name: category_settings
#
# id :bigint not null, primary key
-# category_id :bigint not null
-# require_topic_approval :boolean default(FALSE)
-# require_reply_approval :boolean default(FALSE)
+# auto_bump_cooldown_days :integer default(1)
# num_auto_bump_daily :integer default(0)
# created_at :datetime not null
# updated_at :datetime not null
-# auto_bump_cooldown_days :integer default(1)
+# category_id :bigint not null
+#
# Indexes
#
# index_category_settings_on_category_id (category_id) UNIQUE
diff --git a/db/migrate/20260310072550_mark_category_approval_booleans_readonly.rb b/db/migrate/20260310072550_mark_category_approval_booleans_readonly.rb
new file mode 100644
index 00000000000..49bb0a0c2f4
--- /dev/null
+++ b/db/migrate/20260310072550_mark_category_approval_booleans_readonly.rb
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class MarkCategoryApprovalBooleansReadonly < ActiveRecord::Migration[8.0]
+ def up
+ change_column_default :category_settings, :require_topic_approval, nil
+ change_column_default :category_settings, :require_reply_approval, nil
+
+ Migration::ColumnDropper.mark_readonly(:category_settings, :require_topic_approval)
+ Migration::ColumnDropper.mark_readonly(:category_settings, :require_reply_approval)
+ end
+
+ def down
+ Migration::ColumnDropper.drop_readonly(:category_settings, :require_topic_approval)
+ Migration::ColumnDropper.drop_readonly(:category_settings, :require_reply_approval)
+ end
+end
diff --git a/db/migrate/20260310072759_create_category_approval_groups.rb b/db/migrate/20260310072759_create_category_approval_groups.rb
new file mode 100644
index 00000000000..dcdc78856fa
--- /dev/null
+++ b/db/migrate/20260310072759_create_category_approval_groups.rb
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class CreateCategoryApprovalGroups < ActiveRecord::Migration[8.0]
+ def up
+ create_table :category_posting_review_groups do |t|
+ t.integer :post_type, null: false
+ t.integer :permission, null: false
+ t.integer :category_id, null: false
+ t.integer :group_id, null: false
+ t.timestamps null: false
+ end
+
+ add_index :category_posting_review_groups,
+ %i[category_id group_id post_type],
+ unique: true,
+ name: "idx_category_posting_review_groups_unique"
+
+ # Backfill: for each category with require_topic_approval = true,
+ # insert a "required" row for the everyone group (id 0) with post_type topic (0).
+ execute(<<~SQL)
+ INSERT INTO category_posting_review_groups (post_type, permission, category_id, group_id, created_at, updated_at)
+ SELECT 0, 1, cs.category_id, 0, NOW(), NOW()
+ FROM category_settings cs
+ WHERE cs.require_topic_approval = true
+ SQL
+
+ # Same for reply approval: post_type reply (1).
+ execute(<<~SQL)
+ INSERT INTO category_posting_review_groups (post_type, permission, category_id, group_id, created_at, updated_at)
+ SELECT 1, 1, cs.category_id, 0, NOW(), NOW()
+ FROM category_settings cs
+ WHERE cs.require_reply_approval = true
+ SQL
+ end
+
+ def down
+ drop_table :category_posting_review_groups
+ end
+end
diff --git a/script/bulk_import/discourse_merger.rb b/script/bulk_import/discourse_merger.rb
index 5cabd00d161..d8a28795541 100644
--- a/script/bulk_import/discourse_merger.rb
+++ b/script/bulk_import/discourse_merger.rb
@@ -366,12 +366,10 @@ class BulkImport::DiscourseMerger < BulkImport::Base
next unless category_id
category = Category.find_by_id(category_id)
next if category.name == "Uncategorized"
- category_settings = CategorySetting.find_by(category_id: category_id)
+ category_settings = category.category_setting
next unless category_settings
- category_settings["require_topic_approval"] = row["require_topic_approval"]
- category_settings["require_reply_approval"] = row["require_reply_approval"]
- category_settings["num_auto_bump_daily"] = row["num_auto_bump_daily"]
- category_settings["auto_bump_cooldown_days"] = row["auto_bump_cooldown_days"]
+ category_settings.num_auto_bump_daily = row["num_auto_bump_daily"]
+ category_settings.auto_bump_cooldown_days = row["auto_bump_cooldown_days"]
category_settings.save!
end
end
@@ -528,7 +526,12 @@ class BulkImport::DiscourseMerger < BulkImport::Base
)
end
- [CategoryFeaturedTopic, CategoryFormTemplate, CategorySearchData].each { |k| copy_model(k) }
+ [
+ CategoryFeaturedTopic,
+ CategoryFormTemplate,
+ CategoryPostingReviewGroup,
+ CategorySearchData,
+ ].each { |k| copy_model(k) }
# Copy custom fields
[CategoryCustomField].each do |k|
diff --git a/spec/db/migrate/20260310072759_create_category_approval_groups_spec.rb b/spec/db/migrate/20260310072759_create_category_approval_groups_spec.rb
new file mode 100644
index 00000000000..06d09ea051b
--- /dev/null
+++ b/spec/db/migrate/20260310072759_create_category_approval_groups_spec.rb
@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require Rails.root.join("db/migrate/20260310072550_mark_category_approval_booleans_readonly.rb")
+require Rails.root.join("db/migrate/20260310072759_create_category_approval_groups.rb")
+
+RSpec.describe CreateCategoryApprovalGroups do
+ before do
+ @original_verbose = ActiveRecord::Migration.verbose
+ ActiveRecord::Migration.verbose = false
+ end
+
+ after { ActiveRecord::Migration.verbose = @original_verbose }
+
+ it "backfills category_posting_review_groups from boolean approval columns" do
+ topic_approval_category = Fabricate(:category)
+ reply_approval_category = Fabricate(:category)
+ both_approval_category = Fabricate(:category)
+ no_approval_category = Fabricate(:category)
+
+ CreateCategoryApprovalGroups.new.down
+ MarkCategoryApprovalBooleansReadonly.new.down
+
+ CategorySetting.where(
+ category_id: [topic_approval_category.id, both_approval_category.id],
+ ).update_all("require_topic_approval = true")
+
+ CategorySetting.where(
+ category_id: [reply_approval_category.id, both_approval_category.id],
+ ).update_all("require_reply_approval = true")
+
+ MarkCategoryApprovalBooleansReadonly.new.up
+ CreateCategoryApprovalGroups.new.up
+
+ everyone = Group::AUTO_GROUPS[:everyone]
+
+ topic_groups = CategoryPostingReviewGroup.where(category_id: topic_approval_category.id)
+ expect(topic_groups.count).to eq(1)
+ expect(topic_groups.first).to have_attributes(
+ post_type: "topic",
+ permission: "required",
+ group_id: everyone,
+ )
+
+ reply_groups = CategoryPostingReviewGroup.where(category_id: reply_approval_category.id)
+ expect(reply_groups.count).to eq(1)
+ expect(reply_groups.first).to have_attributes(
+ post_type: "reply",
+ permission: "required",
+ group_id: everyone,
+ )
+
+ both_groups =
+ CategoryPostingReviewGroup.where(category_id: both_approval_category.id).order(:post_type)
+ expect(both_groups.count).to eq(2)
+ expect(both_groups.first).to have_attributes(
+ post_type: "topic",
+ permission: "required",
+ group_id: everyone,
+ )
+ expect(both_groups.second).to have_attributes(
+ post_type: "reply",
+ permission: "required",
+ group_id: everyone,
+ )
+
+ expect(CategoryPostingReviewGroup.where(category_id: no_approval_category.id).count).to eq(0)
+ end
+end
diff --git a/spec/models/category_posting_review_group_spec.rb b/spec/models/category_posting_review_group_spec.rb
new file mode 100644
index 00000000000..c13c2ae5d04
--- /dev/null
+++ b/spec/models/category_posting_review_group_spec.rb
@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+RSpec.describe CategoryPostingReviewGroup do
+ fab!(:category)
+
+ subject do
+ described_class.new(
+ category: category,
+ group: Group[:everyone],
+ post_type: :topic,
+ permission: :required,
+ )
+ end
+
+ it { is_expected.to validate_presence_of(:category) }
+ it { is_expected.to validate_presence_of(:group) }
+
+ it "rejects non-everyone groups" do
+ record =
+ described_class.new(
+ category: category,
+ group: Fabricate(:group),
+ post_type: :topic,
+ permission: :required,
+ )
+
+ expect(record).not_to be_valid
+ expect(record.errors[:base]).to include(
+ "Group-based approval permissions for specific groups are not supported yet",
+ )
+ end
+end
diff --git a/spec/models/category_setting_spec.rb b/spec/models/category_setting_spec.rb
index c9bf1160a7d..60451ac4fde 100644
--- a/spec/models/category_setting_spec.rb
+++ b/spec/models/category_setting_spec.rb
@@ -16,4 +16,26 @@ RSpec.describe CategorySetting do
.is_greater_than_or_equal_to(0)
.allow_nil
end
+
+ it "removes category_posting_review_groups when approval is disabled" do
+ category =
+ Fabricate(
+ :category,
+ category_setting_attributes: {
+ require_topic_approval: true,
+ require_reply_approval: true,
+ },
+ )
+ expect(category.category_posting_review_groups.count).to eq(2)
+
+ category.require_topic_approval = false
+ category.save!
+
+ expect(category.category_posting_review_groups.pluck(:post_type)).to eq(%w[reply])
+
+ category.require_reply_approval = false
+ category.save!
+
+ expect(category.category_posting_review_groups.count).to eq(0)
+ end
end
diff --git a/spec/models/category_spec.rb b/spec/models/category_spec.rb
index 9dc4f2bcf4c..d792b1a01b1 100644
--- a/spec/models/category_spec.rb
+++ b/spec/models/category_spec.rb
@@ -87,6 +87,14 @@ RSpec.describe Category do
).count,
).to eq(0)
end
+
+ it "destroys category_posting_review_groups when category is destroyed" do
+ category = Fabricate(:category, category_setting_attributes: { require_topic_approval: true })
+
+ expect { category.destroy! }.to change { category.category_posting_review_groups.count }.by(
+ -1,
+ )
+ end
end
describe "slug" do
@@ -903,24 +911,6 @@ RSpec.describe Category do
end
end
- describe "require topic/post approval" do
- fab!(:category, :category_with_definition)
-
- it "delegates methods to category settings" do
- expect(category).to delegate_method(:require_reply_approval).to(:category_setting)
- expect(category).to delegate_method(:require_reply_approval=).with_arguments(true).to(
- :category_setting,
- )
- expect(category).to delegate_method(:require_reply_approval?).to(:category_setting)
-
- expect(category).to delegate_method(:require_topic_approval).to(:category_setting)
- expect(category).to delegate_method(:require_topic_approval=).with_arguments(true).to(
- :category_setting,
- )
- expect(category).to delegate_method(:require_topic_approval?).to(:category_setting)
- end
- end
-
describe "auto bump" do
it "should correctly automatically bump topics" do
freeze_time
diff --git a/spec/serializers/category_serializer_spec.rb b/spec/serializers/category_serializer_spec.rb
index 2ea0311b9ed..94a5d7e9c47 100644
--- a/spec/serializers/category_serializer_spec.rb
+++ b/spec/serializers/category_serializer_spec.rb
@@ -198,4 +198,44 @@ RSpec.describe CategorySerializer do
expect(json[:description]).to eq("Original Description")
end
end
+
+ describe "#require_topic_approval" do
+ it "returns false when topic approval is not required" do
+ category.require_topic_approval = false
+ category.save!
+
+ json = described_class.new(category, scope: Guardian.new(admin), root: false).as_json
+
+ expect(json[:category_setting][:require_topic_approval]).to eq(false)
+ end
+
+ it "returns true when topic approval is required" do
+ category.require_topic_approval = true
+ category.save!
+
+ json = described_class.new(category, scope: Guardian.new(admin), root: false).as_json
+
+ expect(json[:category_setting][:require_topic_approval]).to eq(true)
+ end
+ end
+
+ describe "#require_reply_approval" do
+ it "returns false when reply approval is not required" do
+ category.require_reply_approval = false
+ category.save!
+
+ json = described_class.new(category, scope: Guardian.new(admin), root: false).as_json
+
+ expect(json[:category_setting][:require_reply_approval]).to eq(false)
+ end
+
+ it "returns true when reply approval is required" do
+ category.require_reply_approval = true
+ category.save!
+
+ json = described_class.new(category, scope: Guardian.new(admin), root: false).as_json
+
+ expect(json[:category_setting][:require_reply_approval]).to eq(true)
+ end
+ end
end