Transform relink handler to canonicalize-issue-links issue handler

Author: Urgau

src/config.rs

@@ -46,7 +46,7 @@ pub(crate) struct Config {
     pub(crate) merge_conflicts: Option<MergeConflictConfig>,
     pub(crate) bot_pull_requests: Option<BotPullRequests>,
     pub(crate) rendered_link: Option<RenderedLinkConfig>,
-    pub(crate) relink: Option<RelinkConfig>,
+    pub(crate) canonicalize_issue_links: Option<CanonicalizeIssueLinksConfig>,
 }
 
 #[derive(PartialEq, Eq, Debug, serde::Deserialize)]
@@ -418,7 +418,7 @@ pub(crate) struct RenderedLinkConfig {
 #[derive(PartialEq, Eq, Debug, serde::Deserialize)]
 #[serde(rename_all = "kebab-case")]
 #[serde(deny_unknown_fields)]
-pub(crate) struct RelinkConfig {}
+pub(crate) struct CanonicalizeIssueLinksConfig {}
 
 fn get_cached_config(repo: &str) -> Option<Result<Arc<Config>, ConfigurationError>> {
     let cache = CONFIG_CACHE.read().unwrap();
@@ -541,7 +541,7 @@ mod tests {
 
             [shortcut]
 
-            [relink]
+            [canonicalize-issue-links]
 
             [rendered-link]
             trigger-files = ["posts/"]
@@ -607,7 +607,7 @@ mod tests {
                 rendered_link: Some(RenderedLinkConfig {
                     trigger_files: vec!["posts/".to_string()]
                 }),
-                relink: Some(RelinkConfig {}),
+                canonicalize_issue_links: Some(CanonicalizeIssueLinksConfig {}),
             }
         );
     }
@@ -671,7 +671,7 @@ mod tests {
                 merge_conflicts: None,
                 bot_pull_requests: None,
                 rendered_link: None,
-                relink: None
+                canonicalize_issue_links: None
             }
         );
     }

src/handlers.rs

@@ -27,6 +27,7 @@ impl fmt::Display for HandlerError {
 mod assign;
 mod autolabel;
 mod bot_pull_requests;
+mod canonicalize_issue_links;
 mod close;
 pub mod docs_update;
 mod github_releases;
@@ -46,7 +47,6 @@ mod prioritize;
 pub mod project_goals;
 pub mod pull_requests_assignment_update;
 mod relabel;
-mod relink;
 mod relnotes;
 mod rendered_link;
 mod review_requested;
@@ -104,16 +104,6 @@ pub async fn handle(ctx: &Context, event: &Event) -> Vec<HandlerError> {
         );
     }
 
-    if let Some(relink_config) = config.as_ref().ok().and_then(|c| c.relink.as_ref()) {
-        if let Err(e) = relink::handle(ctx, event, relink_config).await {
-            log::error!(
-                "failed to process event {:?} with relink handler: {:?}",
-                event,
-                e
-            );
-        }
-    }
-
     if let Some(rendered_link_config) = config.as_ref().ok().and_then(|c| c.rendered_link.as_ref())
     {
         if let Err(e) = rendered_link::handle(ctx, event, rendered_link_config).await {
@@ -224,6 +214,7 @@ macro_rules! issue_handlers {
 issue_handlers! {
     assign,
     autolabel,
+    canonicalize_issue_links,
     major_change,
     mentions,
     no_merges,

src/handlers/relink.rs src/handlers/canonicalize_issue_links.rssrc/handlers/relink.rs renamed to src/handlers/canonicalize_issue_links.rs

@@ -1,6 +1,6 @@
-//! This handler is used to "relink" linked GitHub issues into their long form
+//! This handler is used to canonicalize linked GitHub issues into their long form
 //! so that when pulling subtree into the main repository we don't accidentaly
-//! closes issue in the wrong repository.
+//! close issues in the wrong repository.
 //!
 //! Example: `Fixes #123` (in rust-lang/clippy) would now become `Fixes rust-lang/clippy#123`
 
@@ -10,8 +10,8 @@ use std::sync::LazyLock;
 use regex::Regex;
 
 use crate::{
-    config::RelinkConfig,
-    github::{Event, IssuesAction, IssuesEvent},
+    config::CanonicalizeIssueLinksConfig,
+    github::{IssuesAction, IssuesEvent},
     handlers::Context,
 };
 
@@ -21,34 +21,44 @@ static LINKED_RE: LazyLock<Regex> = LazyLock::new(|| {
         .unwrap()
 });
 
-pub async fn handle(ctx: &Context, event: &Event, config: &RelinkConfig) -> anyhow::Result<()> {
-    let Event::Issue(e) = event else {
-        return Ok(());
-    };
+pub(super) struct CanonicalizeIssueLinksInput {}
 
-    if !e.issue.is_pr() {
-        return Ok(());
+pub(super) async fn parse_input(
+    _ctx: &Context,
+    event: &IssuesEvent,
+    config: Option<&CanonicalizeIssueLinksConfig>,
+) -> Result<Option<CanonicalizeIssueLinksInput>, String> {
+    if !event.issue.is_pr() {
+        return Ok(None);
     }
 
-    if let Err(e) = relink_pr(&ctx, &e, config).await {
-        tracing::error!("Error relinking pr: {:?}", e);
+    if !matches!(
+        event.action,
+        IssuesAction::Opened | IssuesAction::Reopened | IssuesAction::Edited
+    ) {
+        return Ok(None);
     }
 
-    Ok(())
+    // Require a `[canoncalize-issue-links]` configuration block to enable the handler.
+    if config.is_none() {
+        return Ok(None);
+    };
+
+    Ok(Some(CanonicalizeIssueLinksInput {}))
 }
 
-async fn relink_pr(ctx: &Context, e: &IssuesEvent, _config: &RelinkConfig) -> anyhow::Result<()> {
-    if e.action == IssuesAction::Opened
-        || e.action == IssuesAction::Reopened
-        || e.action == IssuesAction::Edited
-    {
-        let full_repo_name = e.issue.repository().full_repo_name();
+pub(super) async fn handle_input(
+    ctx: &Context,
+    _config: &CanonicalizeIssueLinksConfig,
+    e: &IssuesEvent,
+    _input: CanonicalizeIssueLinksInput,
+) -> anyhow::Result<()> {
+    let full_repo_name = e.issue.repository().full_repo_name();
 
-        let new_body = fix_linked_issues(&e.issue.body, full_repo_name.as_str());
+    let new_body = fix_linked_issues(&e.issue.body, full_repo_name.as_str());
 
-        if e.issue.body != new_body {
-            e.issue.edit_body(&ctx.github, &new_body).await?;
-        }
+    if e.issue.body != new_body {
+        e.issue.edit_body(&ctx.github, &new_body).await?;
     }
 
     Ok(())