feat(app): gate a collapsing guild header behind an experiment (#2779)

This commit is contained in:
Hampus
2026-09-14 21:15:31 +02:00
committed by GitHub
parent 550e6b05a1
commit d0c6146429
29 changed files with 1449 additions and 115 deletions
+54
View File
@@ -10570,6 +10570,7 @@
"message_keyboard_focus": {"$ref": "#/components/schemas/MessageKeyboardFocusConfigResponse"},
"blocked_message_groups": {"$ref": "#/components/schemas/BlockedMessageGroupsConfigResponse"},
"expression_info_card": {"$ref": "#/components/schemas/ExpressionInfoCardConfigResponse"},
"guild_header_collapse": {"$ref": "#/components/schemas/GuildHeaderCollapseConfigResponse"},
"registration": {
"type": "object",
"properties": {
@@ -10978,6 +10979,7 @@
"message_keyboard_focus",
"blocked_message_groups",
"expression_info_card",
"guild_header_collapse",
"registration",
"self_hosted",
"app_public",
@@ -11135,6 +11137,10 @@
"nullable": true,
"allOf": [{"$ref": "#/components/schemas/ExpressionInfoCardConfigUpdateRequest"}]
},
"guild_header_collapse": {
"nullable": true,
"allOf": [{"$ref": "#/components/schemas/GuildHeaderCollapseConfigUpdateRequest"}]
},
"registration": {
"nullable": true,
"type": "object",
@@ -15201,6 +15207,24 @@
"enum": ["open", "approval", "closed"],
"type": "string"
},
"GuildHeaderCollapseConfigUpdateRequest": {
"type": "object",
"properties": {
"enabled": {"type": "boolean"},
"rollout_basis_points": {"type": "integer", "minimum": 0, "maximum": 10000},
"rollout_salt": {"type": "string", "minLength": 1, "maxLength": 64},
"included_user_ids": {
"maxItems": 1000,
"type": "array",
"items": {"type": "string", "pattern": "^\\d{1,20}$"}
},
"excluded_user_ids": {
"maxItems": 1000,
"type": "array",
"items": {"type": "string", "pattern": "^\\d{1,20}$"}
}
}
},
"ExpressionInfoCardConfigUpdateRequest": {
"type": "object",
"properties": {
@@ -15355,6 +15379,36 @@
"type": "string",
"enum": ["none", "standard", "gate", "speex", "rnnoise", "gtcrn", "deep_filter"]
},
"GuildHeaderCollapseConfigResponse": {
"type": "object",
"properties": {
"enabled": {"default": false, "type": "boolean"},
"config_version": {"default": 0, "type": "integer", "minimum": 0, "maximum": 9007199254740991},
"rollout_basis_points": {"default": 0, "type": "integer", "minimum": 0, "maximum": 10000},
"rollout_salt": {"default": "guild-header-collapse-v1", "type": "string", "minLength": 1, "maxLength": 64},
"included_user_ids": {
"default": [],
"maxItems": 1000,
"type": "array",
"items": {"type": "string", "pattern": "^\\d{1,20}$"}
},
"excluded_user_ids": {
"default": [],
"maxItems": 1000,
"type": "array",
"items": {"type": "string", "pattern": "^\\d{1,20}$"}
}
},
"required": [
"enabled",
"config_version",
"rollout_basis_points",
"rollout_salt",
"included_user_ids",
"excluded_user_ids"
],
"additionalProperties": false
},
"ExpressionInfoCardConfigResponse": {
"type": "object",
"properties": {
@@ -34,6 +34,8 @@ pub struct InstanceConfigResponse {
pub guild_activity_log_presentation: GuildActivityLogPresentationConfigResponse,
#[serde(default)]
pub expression_info_card: ExpressionInfoCardConfigResponse,
#[serde(default)]
pub guild_header_collapse: GuildHeaderCollapseConfigResponse,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
@@ -737,6 +739,44 @@ pub struct ExpressionInfoCardConfigUpdateRequest {
pub excluded_user_ids: Option<Vec<String>>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(default)]
pub struct GuildHeaderCollapseConfigResponse {
pub enabled: bool,
pub config_version: u64,
pub rollout_basis_points: u32,
pub rollout_salt: String,
pub included_user_ids: Vec<String>,
pub excluded_user_ids: Vec<String>,
}
impl Default for GuildHeaderCollapseConfigResponse {
fn default() -> Self {
Self {
enabled: false,
config_version: 0,
rollout_basis_points: 0,
rollout_salt: "guild-header-collapse-v1".to_owned(),
included_user_ids: Vec::new(),
excluded_user_ids: Vec::new(),
}
}
}
#[derive(Clone, Debug, Default, Serialize)]
pub struct GuildHeaderCollapseConfigUpdateRequest {
#[serde(skip_serializing_if = "Option::is_none")]
pub enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub rollout_basis_points: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
pub rollout_salt: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub included_user_ids: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub excluded_user_ids: Option<Vec<String>>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(default)]
pub struct ExperimentDeliveryConfigResponse {
@@ -864,6 +904,8 @@ pub struct InstanceConfigUpdateRequest {
pub guild_activity_log_presentation: Option<GuildActivityLogPresentationConfigUpdateRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub expression_info_card: Option<ExpressionInfoCardConfigUpdateRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub guild_header_collapse: Option<GuildHeaderCollapseConfigUpdateRequest>,
}
#[derive(Clone, Debug, Default, Serialize)]
@@ -1209,6 +1251,8 @@ mod tests {
.expect("default guild activity log presentation config");
let expression = serde_json::from_value::<ExpressionInfoCardConfigResponse>(json!({}))
.expect("default expression info card config");
let collapse = serde_json::from_value::<GuildHeaderCollapseConfigResponse>(json!({}))
.expect("default guild header collapse config");
let noise = serde_json::to_value(noise).expect("serializable noise config");
let delivery = serde_json::to_value(delivery).expect("serializable delivery config");
let hover =
@@ -1221,6 +1265,8 @@ mod tests {
.expect("serializable guild activity log presentation config");
let expression =
serde_json::to_value(expression).expect("serializable expression info card config");
let collapse =
serde_json::to_value(collapse).expect("serializable guild header collapse config");
let generated_noise: generated_types::VoiceNoiseSuppressionConfigResponse =
serde_json::from_value(noise.clone()).expect("generated noise config contract");
let generated_delivery: generated_types::ExperimentDeliveryConfigResponse =
@@ -1240,6 +1286,9 @@ mod tests {
let generated_expression: generated_types::ExpressionInfoCardConfigResponse =
serde_json::from_value(expression.clone())
.expect("generated expression info card config contract");
let generated_collapse: generated_types::GuildHeaderCollapseConfigResponse =
serde_json::from_value(collapse.clone())
.expect("generated guild header collapse config contract");
assert_eq!(
serde_json::to_value(generated_noise).expect("serializable generated noise config"),
noise
@@ -1274,6 +1323,11 @@ mod tests {
.expect("serializable generated expression info card config"),
expression
);
assert_eq!(
serde_json::to_value(generated_collapse)
.expect("serializable generated guild header collapse config"),
collapse
);
for (name, value) in [
("VoiceNoiseSuppressionConfigResponse", noise),
("ExperimentDeliveryConfigResponse", delivery),
@@ -1282,6 +1336,7 @@ mod tests {
("BlockedMessageGroupsConfigResponse", blocked),
("GuildActivityLogPresentationConfigResponse", activity_log),
("ExpressionInfoCardConfigResponse", expression),
("GuildHeaderCollapseConfigResponse", collapse),
] {
for (field, value) in value.as_object().expect("config object") {
assert_eq!(
@@ -1345,6 +1400,46 @@ mod tests {
);
}
#[test]
fn guild_header_collapse_update_preserves_empty_lists_and_omitted_fields() {
let update = GuildHeaderCollapseConfigUpdateRequest {
included_user_ids: Some(Vec::new()),
excluded_user_ids: Some(Vec::new()),
..Default::default()
};
let value = serde_json::to_value(update).expect("serializable update");
serde_json::from_value::<generated_types::GuildHeaderCollapseConfigUpdateRequest>(
value.clone(),
)
.expect("generated update contract");
assert_eq!(
value,
json!({"included_user_ids": [], "excluded_user_ids": []})
);
assert_eq!(
serde_json::to_value(GuildHeaderCollapseConfigUpdateRequest::default())
.expect("serializable update"),
json!({})
);
}
#[test]
fn guild_header_collapse_response_defaults_to_the_guild_header_collapse_v1_salt() {
let config = GuildHeaderCollapseConfigResponse::default();
assert!(!config.enabled);
assert_eq!(config.config_version, 0);
assert_eq!(config.rollout_basis_points, 0);
assert_eq!(config.rollout_salt, "guild-header-collapse-v1");
assert!(config.included_user_ids.is_empty());
assert!(config.excluded_user_ids.is_empty());
assert_eq!(
serde_json::from_value::<GuildHeaderCollapseConfigResponse>(json!({}))
.expect("default guild header collapse config")
.rollout_salt,
"guild-header-collapse-v1"
);
}
#[test]
fn message_hover_tracking_update_preserves_empty_lists_and_omitted_fields() {
let update = MessageHoverTrackingConfigUpdateRequest {
+111 -1
View File
@@ -10,7 +10,8 @@ use crate::{
CreateRegistrationUrlRequest, DeferredPhoneGateUpdateRequest,
ExperimentDeliveryConfigUpdateRequest, ExpressionInfoCardConfigUpdateRequest,
GatewayRolloutConfigUpdateRequest, GatewayRolloutMode,
GuildActivityLogPresentationConfigUpdateRequest, InstanceAttachmentDecayUpdateRequest,
GuildActivityLogPresentationConfigUpdateRequest,
GuildHeaderCollapseConfigUpdateRequest, InstanceAttachmentDecayUpdateRequest,
InstanceBlueskyIntegrationUpdateRequest, InstanceBlueskyKeyIntegrationUpdateRequest,
InstanceCaptchaIntegrationUpdateRequest, InstanceConfigUpdateRequest,
InstanceEmailIntegrationUpdateRequest, InstanceEmailSmtpIntegrationUpdateRequest,
@@ -231,6 +232,10 @@ pub async fn instance_config_post(
Ok(update) => instance_config_result(client.update_instance_config(&update).await),
Err(message) => FlashData::error(message),
},
"update_guild_header_collapse" => match build_guild_header_collapse_update(&form) {
Ok(update) => instance_config_result(client.update_instance_config(&update).await),
Err(message) => FlashData::error(message),
},
"update_experiment_delivery" => match build_experiment_delivery_update(&form) {
Ok(update) => instance_config_result(client.update_instance_config(&update).await),
Err(message) => FlashData::error(message),
@@ -805,6 +810,38 @@ fn build_expression_info_card_update(
})
}
fn build_guild_header_collapse_update(
form: &MultiValueForm,
) -> Result<InstanceConfigUpdateRequest, String> {
Ok(InstanceConfigUpdateRequest {
guild_header_collapse: Some(GuildHeaderCollapseConfigUpdateRequest {
enabled: Some(form.bool_value("guild_header_collapse_enabled")),
rollout_basis_points: parse_form_number(
form,
"guild_header_collapse_rollout_basis_points",
"Rollout basis points",
0,
EXPERIMENT_ROLLOUT_BASIS_POINTS_MAX,
)?,
rollout_salt: parse_experiment_rollout_salt(
form,
"guild_header_collapse_rollout_salt",
)?,
included_user_ids: Some(parse_experiment_user_ids(
form.first("guild_header_collapse_included_user_ids")
.unwrap_or_default(),
"Included user IDs",
)?),
excluded_user_ids: Some(parse_experiment_user_ids(
form.first("guild_header_collapse_excluded_user_ids")
.unwrap_or_default(),
"Excluded user IDs",
)?),
}),
..Default::default()
})
}
fn build_experiment_delivery_update(
form: &MultiValueForm,
) -> Result<InstanceConfigUpdateRequest, String> {
@@ -1726,6 +1763,79 @@ mod tests {
}
}
#[test]
fn build_guild_header_collapse_update_reads_the_whole_form() {
let form = MultiValueForm::parse(
b"guild_header_collapse_enabled=true&guild_header_collapse_rollout_basis_points=2500&guild_header_collapse_rollout_salt=%20guild-header-collapse-v2%20&guild_header_collapse_included_user_ids=1500000000000000001%0A1500000000000000001&guild_header_collapse_excluded_user_ids=1500000000000000002%2C%201500000000000000003",
);
let update = build_guild_header_collapse_update(&form)
.expect("valid form")
.guild_header_collapse
.expect("guild header collapse update");
assert_eq!(update.enabled, Some(true));
assert_eq!(update.rollout_basis_points, Some(2_500));
assert_eq!(
update.rollout_salt,
Some("guild-header-collapse-v2".to_owned())
);
assert_eq!(
update.included_user_ids,
Some(vec!["1500000000000000001".to_owned()])
);
assert_eq!(
update.excluded_user_ids,
Some(vec![
"1500000000000000002".to_owned(),
"1500000000000000003".to_owned()
])
);
}
#[test]
fn build_guild_header_collapse_update_leaves_the_rollout_inert_when_nothing_is_submitted() {
let form = MultiValueForm::parse(b"_csrf=token");
let request = build_guild_header_collapse_update(&form).expect("valid form");
assert_eq!(
serde_json::to_value(request).expect("serializable update"),
serde_json::json!({"guild_header_collapse": {
"enabled": false,
"included_user_ids": [],
"excluded_user_ids": [],
}})
);
}
#[test]
fn build_guild_header_collapse_update_rejects_a_rollout_above_the_maximum() {
let form = MultiValueForm::parse(b"guild_header_collapse_rollout_basis_points=10001");
assert_eq!(
build_guild_header_collapse_update(&form).expect_err("invalid rollout"),
"Rollout basis points must be a whole number between 0 and 10000"
);
}
#[test]
fn build_guild_header_collapse_update_reads_only_its_own_prefix() {
let form = MultiValueForm::parse(
b"guild_header_collapse_enabled=true&guild_header_collapse_rollout_basis_points=2500&guild_header_collapse_rollout_salt=guild-header-collapse-v2&guild_header_collapse_included_user_ids=1500000000000000001&expression_card_rollout_basis_points=750&expression_card_rollout_salt=expression-info-card-v2&expression_card_excluded_user_ids=1500000000000000009",
);
let update = build_guild_header_collapse_update(&form)
.expect("valid form")
.guild_header_collapse
.expect("guild header collapse update");
assert_eq!(update.enabled, Some(true));
assert_eq!(update.rollout_basis_points, Some(2_500));
assert_eq!(
update.rollout_salt,
Some("guild-header-collapse-v2".to_owned())
);
assert_eq!(
update.included_user_ids,
Some(vec!["1500000000000000001".to_owned()])
);
assert_eq!(update.excluded_user_ids, Some(Vec::new()));
}
#[test]
fn build_experiment_delivery_update_leaves_both_fields_unchanged_when_absent() {
let form = MultiValueForm::parse(b"_csrf=token");
@@ -5,12 +5,12 @@ use crate::{
AppPublicConfigResponse, BlockedMessageGroupsConfigResponse,
ExperimentDeliveryConfigResponse, ExpressionInfoCardConfigResponse,
GatewayRolloutConfigResponse, GuildActivityLogPresentationConfigResponse,
InstanceConfigResponse, InstanceIntegrationsResponse, InstanceMediaResponse,
InstancePolicyResponse, InstanceRegistrationResponse, LimitConfigResponse,
MessageHoverTrackingConfigResponse, MessageKeyboardFocusConfigResponse,
NoiseSuppressionBackend, PendingRegistrationResponse, RegistrationUrlResponse,
SsoConfigResponse, VOICE_NS_MAX_GUILD_OVERRIDES, VOICE_NS_MAX_TARGETED_USERS,
VoiceNoiseSuppressionConfigResponse,
GuildHeaderCollapseConfigResponse, InstanceConfigResponse, InstanceIntegrationsResponse,
InstanceMediaResponse, InstancePolicyResponse, InstanceRegistrationResponse,
LimitConfigResponse, MessageHoverTrackingConfigResponse,
MessageKeyboardFocusConfigResponse, NoiseSuppressionBackend, PendingRegistrationResponse,
RegistrationUrlResponse, SsoConfigResponse, VOICE_NS_MAX_GUILD_OVERRIDES,
VOICE_NS_MAX_TARGETED_USERS, VoiceNoiseSuppressionConfigResponse,
},
config::AdminConfig,
middleware::auth::AuthContext,
@@ -156,6 +156,7 @@ pub fn instance_config_page(
(blocked_message_groups_section(base, csrf_token, &instance_config.blocked_message_groups))
(guild_activity_log_presentation_section(base, csrf_token, &instance_config.guild_activity_log_presentation))
(expression_info_card_section(base, csrf_token, &instance_config.expression_info_card))
(guild_header_collapse_section(base, csrf_token, &instance_config.guild_header_collapse))
(experiment_delivery_section(base, csrf_token, &instance_config.experiment_delivery))
@if let Some(limit_config) = limit_config {
(limit_config_section(base, limit_config))
@@ -1702,6 +1703,110 @@ fn expression_info_card_section(
)
}
fn guild_header_collapse_section(
base: &str,
csrf_token: &str,
guild_header_collapse: &GuildHeaderCollapseConfigResponse,
) -> Markup {
let status = if guild_header_collapse.enabled {
("Live", BadgeVariant::Success)
} else {
("Inert", BadgeVariant::Default)
};
let included_user_ids = guild_header_collapse.included_user_ids.join("\n");
let excluded_user_ids = guild_header_collapse.excluded_user_ids.join("\n");
section_card_with_description(
"Guild Header Collapse",
"Picks how a targeted client draws the guild banner above the channel list. A targeted \
client reduces that banner to the height of the header as the channel list scrolls down \
and returns it to full height as the list scrolls back up. While the master switch below \
is off every client keeps the fixed banner height it ships with, whatever the rest of \
these fields say.",
html! {
form method="post" action={(base) "/instance-config?action=update_guild_header_collapse"} {
(csrf_input(csrf_token))
div class="space-y-6" {
div class="flex flex-wrap items-center gap-2" {
h3 class="text-sm font-semibold text-neutral-900" { "Master switch" }
(badge(status.0, status.1))
span class="text-xs text-neutral-500" {
"Config version " (guild_header_collapse.config_version)
}
}
(checkbox(
"guild_header_collapse_enabled",
"true",
"Serve guild header collapse assignments to clients",
guild_header_collapse.enabled,
true,
))
p class="text-xs text-neutral-500" {
"Off is the safe state. With this unchecked every client is told the \
rollout is inert and keeps its current banner height, so the rollout \
and targeting fields below have no effect at all."
}
h3 class="text-sm font-semibold text-neutral-900" { "Rollout" }
(number_field(
"guild_header_collapse_rollout_basis_points",
"Rollout (basis points)",
&guild_header_collapse.rollout_basis_points.to_string(),
Some(0), Some(10000), "1",
Some("Share of users bucketed into the canary, in basis points: 0 is nobody, 100 is 1%, 10000 is everybody."),
))
div class="flex flex-col gap-2" {
(text_input(
"guild_header_collapse_rollout_salt",
"Rollout Salt",
&guild_header_collapse.rollout_salt,
"guild-header-collapse-v1",
))
p class="text-xs text-neutral-500" {
"Seeds the bucketing hash. Changing it reshuffles which users fall \
inside the percentage above. Leave it alone to keep the current \
cohort stable."
}
}
div class="flex flex-col gap-2" {
(textarea_input(
"guild_header_collapse_included_user_ids",
"Always-on User IDs",
"1500000000000000001\n1500000000000000002",
&included_user_ids,
4,
false,
))
p class="text-xs text-neutral-500" {
"One snowflake per line, or comma separated. These users are targeted \
regardless of the percentage above. IDs must contain 1 to 20 decimal \
digits. Invalid entries prevent the save. Blank entries and duplicate \
IDs are ignored."
}
}
div class="flex flex-col gap-2" {
(textarea_input(
"guild_header_collapse_excluded_user_ids",
"Never-on User IDs",
"1500000000000000003\n1500000000000000004",
&excluded_user_ids,
4,
false,
))
p class="text-xs text-neutral-500" {
"Same format. Exclusion wins over both the always-on list and the \
percentage, so this is the per-user kill switch."
}
}
(form_actions(html! {
(submit_button("Save Guild Header Collapse Configuration"))
}))
}
}
},
)
}
fn experiment_delivery_section(
base: &str,
csrf_token: &str,
@@ -2357,4 +2462,24 @@ mod tests {
assert!(markup.contains("1000 of 1000 stored"));
assert!(markup.contains("at the cap"));
}
#[test]
fn guild_header_collapse_section_posts_its_own_action_and_fields() {
let guild_header_collapse = GuildHeaderCollapseConfigResponse {
included_user_ids: vec!["1500000000000000001".to_owned()],
excluded_user_ids: vec!["1500000000000000002".to_owned()],
..GuildHeaderCollapseConfigResponse::default()
};
let markup =
guild_header_collapse_section("/admin", "csrf", &guild_header_collapse).into_string();
assert!(markup.contains("/instance-config?action=update_guild_header_collapse"));
assert!(markup.contains("Guild Header Collapse"));
assert!(markup.contains("guild-header-collapse-v1"));
assert!(markup.contains("guild_header_collapse_enabled"));
assert!(markup.contains("guild_header_collapse_rollout_basis_points"));
assert!(markup.contains("guild_header_collapse_rollout_salt"));
assert!(markup.contains("guild_header_collapse_included_user_ids"));
assert!(markup.contains("guild_header_collapse_excluded_user_ids"));
assert!(!markup.contains("expression_card_"));
}
}
@@ -449,6 +449,14 @@ fn deserialize_instance_config_response_with_unknown_keys() {
"future_object_knob": {"nested": true},
"future_list_knob": ["a", "b"]
},
"guild_header_collapse": {
"enabled": false,
"config_version": 0,
"rollout_basis_points": 0,
"rollout_salt": "guild-header-collapse-v1",
"included_user_ids": [],
"excluded_user_ids": []
},
"registration": {
"mode": "open",
"admin_registration_urls_enabled": false,
@@ -592,6 +600,7 @@ fn deserialize_instance_config_response_with_unknown_keys() {
assert!(!resp.message_hover_tracking.enabled);
assert!(!resp.message_keyboard_focus.enabled);
assert!(!resp.blocked_message_groups.enabled);
assert!(!resp.guild_header_collapse.enabled);
assert_eq!(resp.experiment_delivery.poll_interval_seconds, 300);
assert!(resp.policy.single_community_guild_id.is_none());
assert_eq!(resp.policy.services.gif_enabled, Some(true));
+9
View File
@@ -432,6 +432,7 @@ async fn mutating_admin_pages_render_usable_csrf_tokens() {
"/instance-config?action=update_gateway_rollout",
"/instance-config?action=update_sso",
"/instance-config?action=update_voice_noise_suppression",
"/instance-config?action=update_guild_header_collapse",
"/instance-config?action=update_experiment_delivery",
][..],
),
@@ -1097,6 +1098,14 @@ fn instance_config() -> Value {
"max_concurrent_guild_starts": 16,
"voice_e2ee_scope": "guild_feature_only"
},
"guild_header_collapse": {
"enabled": false,
"config_version": 0,
"rollout_basis_points": 0,
"rollout_salt": "guild-header-collapse-v1",
"included_user_ids": [],
"excluded_user_ids": []
},
"voice_noise_suppression": {
"enabled": false,
"config_version": 0,