Skip to content

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

FIX: Hide Voice badges while Voice is disabled (#44009)

Alan Guo Xiang Tan7b6f30d3341c
diff --git a/plugins/voice/app/services/voice/badge_granter_hooks.rb b/plugins/voice/app/services/voice/badge_granter_hooks.rb
index 3466014df03..81c768772fb 100644
--- a/plugins/voice/app/services/voice/badge_granter_hooks.rb
+++ b/plugins/voice/app/services/voice/badge_granter_hooks.rb
@@ -39,17 +39,20 @@ module Voice
# flipped in bulk, so the per-badge save callbacks that keep user badge
# counts consistent run once here instead.
def self.enable_all!
- badges = voice_badges
+ badges = voice_badges.where(enabled: false)
+ return unless badges.exists?
+
+ scheduled_badge_ids = badges.where.not(query: nil).pluck(:id)
badges.update_all(enabled: true)
sync_user_badges!
- badges
- .where.not(query: nil)
- .pluck(:id)
- .each { |badge_id| Jobs.enqueue(:backfill_badge, badge_id: badge_id) }
+ scheduled_badge_ids.each { |badge_id| Jobs.enqueue(:backfill_badge, badge_id: badge_id) }
end
def self.disable_all!
- voice_badges.update_all(enabled: false)
+ badges = voice_badges.where(enabled: true)
+ return unless badges.exists?
+
+ badges.update_all(enabled: false)
sync_user_badges!
end
@@ -112,8 +115,8 @@ module Voice
# Every badge here is derived from analytics sessions, so without them
# nothing can be earned.
def badges_enabled?
- SiteSetting.enable_badges && SiteSetting.voice_badges_enabled &&
- SiteSetting.voice_analytics_enabled
+ SiteSetting.enable_badges && SiteSetting.voice_enabled &&
+ SiteSetting.voice_badges_enabled && SiteSetting.voice_analytics_enabled
end
end
end
diff --git a/plugins/voice/config/locales/server.en.yml b/plugins/voice/config/locales/server.en.yml
index 10bdeb3a177..b200161b9b5 100644
--- a/plugins/voice/config/locales/server.en.yml
+++ b/plugins/voice/config/locales/server.en.yml
@@ -12,7 +12,7 @@ en:
voice_max_room_participants: "Maximum number of people who can be in a voice room at the same time. A room's own participant limit can lower this, but never raise it."
voice_auto_status_enabled: "Automatically set user status when they join a voice room (e.g. '🎙️ In Watercooler'). Requires the 'enable user status' site setting."
voice_mesh_privacy_warning_enabled: "Warn users before they join a peer-to-peer voice room that other participants may be able to see their IP address, with an option to not show the warning again on that device. Calls hosted on a LiveKit server never show the warning."
- voice_badges_enabled: "Enable voice chat badges. Grants badges for voice room milestones like time spent, rooms visited, and connections made. Toggling this enables or disables every badge in the Voice group at once. Requires {{setting:voice_analytics_enabled}}, which records the sessions the badges are computed from."
+ voice_badges_enabled: "Enable voice chat badges when {{setting:voice_enabled}} is enabled. Grants badges for voice room milestones like time spent, rooms visited, and connections made. Toggling this enables or disables every badge in the Voice group at once. Requires {{setting:voice_analytics_enabled}}, which records the sessions the badges are computed from."
voice_analytics_enabled: "Record who joined which voice room and when, and how long people spent in a room together. Powers the admin voice statistics, the contacts and companions suggestions, and every voice badge."
voice_session_retention_days: "Days to keep voice session and time-together history before it is deleted. Badges already earned are never taken away, but progress toward badges that accumulate over time (hours in voice, days in a room, people met) only counts history within this window."
voice_idle_threshold_minutes: "Minutes of inactivity before a voice room participant is marked as idle. Set to 0 to disable."
diff --git a/plugins/voice/config/settings.yml b/plugins/voice/config/settings.yml
index ddb360e285e..00027f22e97 100644
--- a/plugins/voice/config/settings.yml
+++ b/plugins/voice/config/settings.yml
@@ -191,6 +191,8 @@ plugins:
client: true
voice_badges_enabled:
default: true
+ depends_on:
+ - voice_enabled
voice_analytics_enabled:
default: true
voice_session_retention_days:
diff --git a/plugins/voice/db/fixtures/001_badges.rb b/plugins/voice/db/fixtures/001_badges.rb
index 61a8b0c52d5..3213d288256 100644
--- a/plugins/voice/db/fixtures/001_badges.rb
+++ b/plugins/voice/db/fixtures/001_badges.rb
@@ -1,6 +1,7 @@
# frozen_string_literal: true
voice_badge_group = "Voice"
+voice_badges_enabled = SiteSetting.voice_enabled && SiteSetting.voice_badges_enabled
BadgeGrouping.seed(:name) do |g|
g.name = voice_badge_group
@@ -62,7 +63,7 @@ Badge.seed(:name) do |b|
b.query = nil
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.system = true
end
@@ -89,7 +90,7 @@ end
b.auto_revoke = false
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.default_allow_title = type == BadgeType::Gold
b.system = true
end
@@ -107,7 +108,7 @@ Badge.seed(:name) do |b|
b.query = nil
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.system = true
end
@@ -126,7 +127,7 @@ end
b.auto_revoke = false
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.default_allow_title = type == BadgeType::Gold
b.system = true
end
@@ -150,7 +151,7 @@ end
b.auto_revoke = false
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.default_allow_title = type == BadgeType::Gold
b.system = true
end
@@ -180,7 +181,7 @@ end
b.auto_revoke = false
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.default_allow_title = type == BadgeType::Gold
b.system = true
end
@@ -204,7 +205,7 @@ end
b.auto_revoke = false
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.default_allow_title = type == BadgeType::Gold
b.system = true
end
@@ -222,7 +223,7 @@ Badge.seed(:name) do |b|
b.query = nil
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.system = true
end
@@ -248,7 +249,7 @@ end
b.auto_revoke = false
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.default_allow_title = type == BadgeType::Gold
b.system = true
end
@@ -266,7 +267,7 @@ Badge.seed(:name) do |b|
b.query = nil
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.system = true
end
@@ -291,7 +292,7 @@ end
b.auto_revoke = false
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.default_allow_title = type == BadgeType::Gold
b.system = true
end
@@ -309,7 +310,7 @@ Badge.seed(:name) do |b|
b.query = nil
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.system = true
end
@@ -323,7 +324,7 @@ Badge.seed(:name) do |b|
b.query = nil
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.system = true
end
@@ -337,7 +338,7 @@ Badge.seed(:name) do |b|
b.query = nil
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.system = true
end
@@ -358,7 +359,7 @@ Badge.seed(:name) do |b|
b.auto_revoke = false
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.system = true
end
@@ -372,7 +373,9 @@ Badge.seed(:name) do |b|
b.query = nil
b.default_badge_grouping_id = voice_grouping.id
b.trigger = Badge::Trigger::None
- b.default_enabled = true
+ b.default_enabled = voice_badges_enabled
b.default_allow_title = true
b.system = true
end
+
+Voice::BadgeGranterHooks.disable_all! unless voice_badges_enabled
diff --git a/plugins/voice/plugin.rb b/plugins/voice/plugin.rb
index a715e9364e0..351ec2e2be1 100644
--- a/plugins/voice/plugin.rb
+++ b/plugins/voice/plugin.rb
@@ -169,6 +169,11 @@ after_initialize do
# event handlers are skipped while the plugin is disabled, which silently
# covers the disabling transition itself.
on_enabled_change do |_old_value, new_value|
+ if new_value && SiteSetting.voice_badges_enabled
+ Voice::BadgeGranterHooks.enable_all!
+ else
+ Voice::BadgeGranterHooks.disable_all!
+ end
Voice::DefaultRoomSeeder.ensure! if new_value
new_value ? Voice::AgentBot.ensure! : Voice::AgentManager.stop_all!
clear_all_voice_statuses unless new_value
@@ -190,7 +195,7 @@ after_initialize do
new_value ? Voice::AgentBot.ensure! : Voice::AgentManager.stop_all!
end
if name.to_sym == :voice_badges_enabled
- if new_value
+ if new_value && SiteSetting.voice_enabled
Voice::BadgeGranterHooks.enable_all!
else
Voice::BadgeGranterHooks.disable_all!