Skip to content

Commit 2b06b8a

Browse files
apirainoapiraino
committed
Add alias for compound labels
Configure relabel command aliases from the `triagebot.toml`. When a valid alias is parsed, it will be replaced with the labels configured. Example configuration: ``` [relabel.cmd-alias] add-labels = ["Foo", "Bar"] rem-labels = ["Baz"] ``` The command `@rustbot label cmd-alias` will translate to: ``` @rustbot label +Foo +Bar -Baz ``` The command `@rustbot label -cmd-alias` will translate to: ``` @rustbot label +Baz -Foo -Bar ``` Note: self-canceling labels will be omitted. The command `@rustbot label cmd-alias +Bar` will translate to: ``` @rustbot label -Foo -Bar ```
1 parent 692de91 commit 2b06b8a

File tree

5 files changed

+187
-14
lines changed

5 files changed

+187
-14
lines changed

‎parser/src/command/relabel.rs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ fn delta_empty() {
102102
}
103103

104104
impl RelabelCommand {
105+
/// Parse and validate command tokens
105106
pub fn parse<'a>(input: &mut Tokenizer<'a>) -> Result<Option<Self>, Error<'a>> {
106107
let mut toks = input.clone();
107108

‎parser/src/lib.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ pub mod command;
22
pub mod error;
33
mod ignore_block;
44
mod mentions;
5-
mod token;
5+
pub mod token;
66

77
pub use ignore_block::replace_all_outside_ignore_blocks;
88
pub use mentions::get_mentions;

‎src/config.rs‎

Lines changed: 169 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
use crate::changelogs::ChangelogFormat;
22
use crate::github::{GithubClient, Repository};
3+
use parser::command::relabel::{Label, LabelDelta, RelabelCommand};
34
use std::collections::{HashMap, HashSet};
45
use std::fmt;
56
use std::sync::{Arc, LazyLock, RwLock};
@@ -250,10 +251,64 @@ pub(crate) struct MentionsEntryConfig {
250251

251252
#[derive(PartialEq, Eq, Debug, serde::Deserialize)]
252253
#[serde(rename_all = "kebab-case")]
253-
#[serde(deny_unknown_fields)]
254254
pub(crate) struct RelabelConfig {
255255
#[serde(default)]
256256
pub(crate) allow_unauthenticated: Vec<String>,
257+
// alias identifier -> labels
258+
#[serde(flatten)]
259+
pub(crate) aliases: HashMap<String, RelabelAliasConfig>,
260+
}
261+
262+
impl RelabelConfig {
263+
pub(crate) fn retrieve_command_from_alias(&self, input: RelabelCommand) -> RelabelCommand {
264+
let mut deltas = vec![];
265+
if !self.aliases.is_empty() {
266+
// parse all tokens: if one matches an alias, extract the labels
267+
// else, it will assumed to be a valid label
268+
for tk in input.0.into_iter() {
269+
let name = tk.label() as &str;
270+
if let Some(alias) = self.aliases.get(name) {
271+
let cmd = alias.to_command(matches!(tk, LabelDelta::Remove(_)));
272+
deltas.extend(cmd.0);
273+
} else {
274+
deltas.push(tk);
275+
}
276+
}
277+
}
278+
RelabelCommand(deltas)
279+
}
280+
}
281+
282+
#[derive(Default, PartialEq, Eq, Debug, serde::Deserialize)]
283+
#[serde(rename_all = "kebab-case")]
284+
#[serde(deny_unknown_fields)]
285+
pub(crate) struct RelabelAliasConfig {
286+
/// Labels to be added
287+
pub(crate) add_labels: Vec<String>,
288+
/// Labels to be removed
289+
pub(crate) rem_labels: Vec<String>,
290+
}
291+
292+
impl RelabelAliasConfig {
293+
/// Translate a RelabelAliasConfig into a RelabelCommand for GitHub consumption
294+
pub fn to_command(&self, inverted: bool) -> RelabelCommand {
295+
let mut deltas = Vec::new();
296+
let mut add_labels = &self.add_labels;
297+
let mut rem_labels = &self.rem_labels;
298+
299+
// if the polarity of the alias is inverted, swap labels before parsing the command
300+
if inverted {
301+
std::mem::swap(&mut add_labels, &mut rem_labels);
302+
}
303+
304+
for l in add_labels.iter() {
305+
deltas.push(LabelDelta::Add(Label(l.into())));
306+
}
307+
for l in rem_labels.iter() {
308+
deltas.push(LabelDelta::Remove(Label(l.into())));
309+
}
310+
RelabelCommand(deltas)
311+
}
257312
}
258313

259314
#[derive(PartialEq, Eq, Debug, serde::Deserialize)]
@@ -725,6 +780,8 @@ where
725780
#[cfg(test)]
726781
mod tests {
727782
use super::*;
783+
use parser::error::Error;
784+
use parser::token::Tokenizer;
728785

729786
#[test]
730787
fn sample() {
@@ -761,11 +818,11 @@ mod tests {
761818
762819
[mentions."src/"]
763820
cc = ["@someone"]
764-
821+
765822
[mentions."target/"]
766823
message = "This is a message."
767824
cc = ["@someone"]
768-
825+
769826
[mentions."#[rustc_attr]"]
770827
type = "content"
771828
message = "This is a message."
@@ -835,6 +892,7 @@ mod tests {
835892
Config {
836893
relabel: Some(RelabelConfig {
837894
allow_unauthenticated: vec!["C-*".into()],
895+
aliases: HashMap::new()
838896
}),
839897
assign: Some(AssignConfig {
840898
warn_non_default_branch: WarnNonDefaultBranchConfig::Simple(false),
@@ -1033,6 +1091,82 @@ mod tests {
10331091
);
10341092
}
10351093

1094+
#[test]
1095+
fn relabel_alias_config() {
1096+
let config = r#"
1097+
[relabel.to-stable]
1098+
add-labels = ["regression-from-stable-to-stable"]
1099+
rem-labels = ["regression-from-stable-to-beta", "regression-from-stable-to-nightly"]
1100+
"#;
1101+
let config = toml::from_str::<Config>(&config).unwrap();
1102+
1103+
let mut relabel_configs = HashMap::new();
1104+
relabel_configs.insert(
1105+
"to-stable".into(),
1106+
RelabelAliasConfig {
1107+
add_labels: vec!["regression-from-stable-to-stable".to_string()],
1108+
rem_labels: vec![
1109+
"regression-from-stable-to-beta".to_string(),
1110+
"regression-from-stable-to-nightly".to_string(),
1111+
],
1112+
},
1113+
);
1114+
1115+
let expected_cfg = RelabelConfig {
1116+
allow_unauthenticated: vec![],
1117+
aliases: relabel_configs,
1118+
};
1119+
1120+
assert_eq!(config.relabel, Some(expected_cfg));
1121+
}
1122+
1123+
#[cfg(test)]
1124+
fn parse<'a>(input: &'a str) -> Result<Option<Vec<LabelDelta>>, Error<'a>> {
1125+
let mut toks = Tokenizer::new(input);
1126+
Ok(RelabelCommand::parse(&mut toks)?.map(|c| c.0))
1127+
}
1128+
1129+
#[test]
1130+
fn relabel_alias() {
1131+
// [relabel.my-alias]
1132+
// add-labels = ["Alpha"]
1133+
// rem-labels = ["Bravo", "Charlie"]
1134+
let relabel_cfg = RelabelConfig {
1135+
allow_unauthenticated: vec![],
1136+
aliases: HashMap::from([(
1137+
"my-alias".to_string(),
1138+
RelabelAliasConfig {
1139+
add_labels: vec!["Alpha".to_string()],
1140+
rem_labels: vec!["Bravo".to_string(), "Charlie".to_string()],
1141+
},
1142+
)]),
1143+
};
1144+
1145+
// @triagebot label my-alias
1146+
let deltas = parse("label my-alias").unwrap().unwrap();
1147+
let new_input = relabel_cfg.retrieve_command_from_alias(RelabelCommand(deltas));
1148+
assert_eq!(
1149+
new_input,
1150+
RelabelCommand(vec![
1151+
LabelDelta::Add(Label("Alpha".into())),
1152+
LabelDelta::Remove(Label("Bravo".into())),
1153+
LabelDelta::Remove(Label("Charlie".into())),
1154+
])
1155+
);
1156+
1157+
// @triagebot label -my-alias
1158+
let deltas = parse("label -my-alias").unwrap().unwrap();
1159+
let new_input = relabel_cfg.retrieve_command_from_alias(RelabelCommand(deltas));
1160+
assert_eq!(
1161+
new_input,
1162+
RelabelCommand(vec![
1163+
LabelDelta::Add(Label("Bravo".into())),
1164+
LabelDelta::Add(Label("Charlie".into())),
1165+
LabelDelta::Remove(Label("Alpha".into())),
1166+
])
1167+
);
1168+
}
1169+
10361170
#[test]
10371171
fn issue_links_uncanonicalized() {
10381172
let config = r#"
@@ -1093,4 +1227,36 @@ Multi text body with ${mcp_issue} and ${mcp_title}
10931227
})
10941228
);
10951229
}
1230+
1231+
#[test]
1232+
fn relabel_new_config() {
1233+
let config = r#"
1234+
[relabel]
1235+
allow-unauthenticated = ["ABCD-*"]
1236+
1237+
[relabel.to-stable]
1238+
add-labels = ["regression-from-stable-to-stable"]
1239+
rem-labels = ["regression-from-stable-to-beta", "regression-from-stable-to-nightly"]
1240+
"#;
1241+
let config = toml::from_str::<Config>(&config).unwrap();
1242+
1243+
let mut relabel_configs = HashMap::new();
1244+
relabel_configs.insert(
1245+
"to-stable".into(),
1246+
RelabelAliasConfig {
1247+
add_labels: vec!["regression-from-stable-to-stable".to_string()],
1248+
rem_labels: vec![
1249+
"regression-from-stable-to-beta".to_string(),
1250+
"regression-from-stable-to-nightly".to_string(),
1251+
],
1252+
},
1253+
);
1254+
1255+
let expected_cfg = RelabelConfig {
1256+
allow_unauthenticated: vec!["ABCD-*".to_string()],
1257+
aliases: relabel_configs,
1258+
};
1259+
1260+
assert_eq!(config.relabel, Some(expected_cfg));
1261+
}
10961262
}

‎src/github.rs‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1338,9 +1338,6 @@ impl IssuesEvent {
13381338
}
13391339
}
13401340

1341-
#[derive(Debug, serde::Deserialize)]
1342-
struct PullRequestEventFields {}
1343-
13441341
#[derive(Debug, serde::Deserialize)]
13451342
pub struct WorkflowRunJob {
13461343
pub name: String,

‎src/handlers/relabel.rs‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
//! Purpose: Allow any user to modify issue labels on GitHub via comments.
1+
//! Purpose: Allow any user to modify labels on GitHub issues and pull requests via comments.
22
//!
3-
//! Labels are checked against the labels in the project; the bot does not support creating new
4-
//! labels.
3+
//! Labels are checked against the existing set in the git repository; the bot does not support
4+
//! creating new labels.
55
//!
66
//! Parsing is done in the `parser::command::relabel` module.
77
//!
@@ -27,13 +27,17 @@ pub(super) async fn handle_command(
2727
input: RelabelCommand,
2828
) -> anyhow::Result<()> {
2929
let Some(issue) = event.issue() else {
30-
return user_error!("Can only add and remove labels on an issue");
30+
return user_error!("Can only add and remove labels on issues and pull requests");
3131
};
3232

33+
// If the input matches a valid alias, read the [relabel] config.
34+
// if any alias matches, extract the alias config (RelabelAliasConfig) and build a new RelabelCommand.
35+
let new_input = config.retrieve_command_from_alias(input);
36+
3337
// Check label authorization for the current user
34-
for delta in &input.0 {
38+
for delta in &new_input.0 {
3539
let name = delta.label() as &str;
36-
let err = match check_filter(name, config, is_member(event.user(), &ctx.team).await) {
40+
let err = match check_filter(name, config, is_member(&event.user(), &ctx.team).await) {
3741
Ok(CheckFilterResult::Allow) => None,
3842
Ok(CheckFilterResult::Deny) => {
3943
Some(format!("Label {name} can only be set by Rust team members"))
@@ -44,14 +48,15 @@ pub(super) async fn handle_command(
4448
)),
4549
Err(err) => Some(err),
4650
};
51+
4752
if let Some(err) = err {
4853
// bail-out and inform the user why
4954
return user_error!(err);
5055
}
5156
}
5257

5358
// Compute the labels to add and remove
54-
let (to_add, to_remove) = compute_label_deltas(&input.0);
59+
let (to_add, to_remove) = compute_label_deltas(&new_input.0);
5560

5661
// Add labels
5762
if let Err(e) = issue.add_labels(&ctx.github, to_add.clone()).await {
@@ -103,6 +108,8 @@ enum CheckFilterResult {
103108
DenyUnknown,
104109
}
105110

111+
/// Check if the team member is allowed to apply labels
112+
/// configured in `allow_unauthenticated`
106113
fn check_filter(
107114
label: &str,
108115
config: &RelabelConfig,
@@ -194,6 +201,7 @@ fn compute_label_deltas(deltas: &[LabelDelta]) -> (Vec<Label>, Vec<Label>) {
194201
#[cfg(test)]
195202
mod tests {
196203
use parser::command::relabel::{Label, LabelDelta};
204+
use std::collections::HashMap;
197205

198206
use super::{
199207
CheckFilterResult, MatchPatternResult, TeamMembership, check_filter, compute_label_deltas,
@@ -232,6 +240,7 @@ mod tests {
232240
($($member:ident { $($label:expr => $res:ident,)* })*) => {
233241
let config = RelabelConfig {
234242
allow_unauthenticated: vec!["T-*".into(), "I-*".into(), "!I-*nominated".into()],
243+
aliases: HashMap::new()
235244
};
236245
$($(assert_eq!(
237246
check_filter($label, &config, TeamMembership::$member),

0 commit comments

Comments
 (0)