Append workflow links to auto build started comments

Author: Kobzol

src/bors/comment.rs

@@ -28,6 +28,7 @@ pub enum CommentMetadata {
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum CommentTag {
     TryBuildStarted,
+    AutoBuildStarted,
 }
 
 impl Comment {
@@ -199,6 +200,10 @@ pub fn try_build_started_comment(
 }
 
 pub fn append_workflow_links_to_comment(comment_content: &mut String, workflow_urls: Vec<String>) {
+    if !comment_content.ends_with("\n") {
+        comment_content.push('\n');
+    }
+
     if workflow_urls.len() == 1 {
         comment_content.push_str(&format!("\n**Workflow**: {}", workflow_urls[0]));
     } else {

src/bors/handlers/workflow.rs

@@ -1,12 +1,12 @@
 use crate::PgDbClient;
+use crate::bors::BuildKind;
 use crate::bors::comment::{
     CommentTag, append_workflow_links_to_comment, build_failed_comment, try_build_succeeded_comment,
 };
 use crate::bors::event::{WorkflowRunCompleted, WorkflowRunStarted};
 use crate::bors::handlers::labels::handle_label_trigger;
 use crate::bors::handlers::{hide_try_build_started_comments, is_bors_observed_branch};
 use crate::bors::merge_queue::MergeQueueSender;
-use crate::bors::{BuildKind, TRY_BRANCH_NAME};
 use crate::bors::{FailedWorkflowRun, RepositoryState, WorkflowRun};
 use crate::database::{
     BuildModel, BuildStatus, PullRequestModel, QueueStatus, WorkflowModel, WorkflowStatus,
@@ -66,14 +66,12 @@ pub(super) async fn handle_workflow_started(
     )
     .await?;
 
-    if build.branch == TRY_BRANCH_NAME {
-        add_workflow_links_to_try_build_start_comment(repo, db, &build, payload).await?;
-    }
+    add_workflow_links_to_build_start_comment(repo, db, &build, payload).await?;
 
     Ok(())
 }
 
-async fn add_workflow_links_to_try_build_start_comment(
+async fn add_workflow_links_to_build_start_comment(
     repo: Arc<RepositoryState>,
     db: Arc<PgDbClient>,
     build: &BuildModel,
@@ -83,27 +81,31 @@ async fn add_workflow_links_to_try_build_start_comment(
         tracing::warn!("PR for build not found");
         return Ok(());
     };
+
+    let tag = match build.kind {
+        BuildKind::Try => CommentTag::TryBuildStarted,
+        BuildKind::Auto => CommentTag::AutoBuildStarted,
+    };
     let comments = db
-        .get_tagged_bot_comments(&payload.repository, pr.number, CommentTag::TryBuildStarted)
+        .get_tagged_bot_comments(&payload.repository, pr.number, tag)
         .await?;
 
-    let Some(try_build_comment) = comments.last() else {
-        tracing::warn!("No try build comment found for PR");
+    let Some(build_started_comment) = comments.last() else {
+        tracing::warn!("No build started comment found for PR");
         return Ok(());
     };
 
     let workflows = db.get_workflow_urls_for_build(build).await?;
-
     if !workflows.is_empty() {
         let mut comment_content = repo
             .client
-            .get_comment_content(&try_build_comment.node_id)
+            .get_comment_content(&build_started_comment.node_id)
             .await?;
 
         append_workflow_links_to_comment(&mut comment_content, workflows);
 
         repo.client
-            .update_comment_content(&try_build_comment.node_id, &comment_content)
+            .update_comment_content(&build_started_comment.node_id, &comment_content)
             .await?;
     }
 
@@ -154,6 +156,7 @@ pub(super) async fn handle_workflow_completed(
     )
     .await
 }
+
 /// Attempt to complete a pending build after a workflow run has been completed.
 /// We assume that the status of the completed workflow run has already been updated in the
 /// database.
@@ -176,7 +179,7 @@ async fn maybe_complete_build(
         .await?
     else {
         tracing::warn!(
-            "Received check suite finished for an unknown build: {}",
+            "Received workflow finished for an unknown build: {}",
             payload.commit_sha
         );
         return Ok(());

src/bors/merge_queue.rs

@@ -8,8 +8,8 @@ use tracing::Instrument;
 
 use crate::BorsContext;
 use crate::bors::comment::{
-    auto_build_push_failed_comment, auto_build_started_comment, auto_build_succeeded_comment,
-    merge_conflict_comment,
+    CommentTag, auto_build_push_failed_comment, auto_build_started_comment,
+    auto_build_succeeded_comment, merge_conflict_comment,
 };
 use crate::bors::{AUTO_BRANCH_NAME, PullRequestStatus, RepositoryState};
 use crate::database::{
@@ -209,6 +209,7 @@ async fn handle_successful_build(
 
 /// Handle starting a new auto build for an approved PR.
 /// Returns true if the queue should break, false to continue.
+#[tracing::instrument(skip(repo, ctx, pr))]
 async fn handle_start_auto_build(
     repo: &RepositoryState,
     ctx: &BorsContext,
@@ -387,11 +388,24 @@ async fn start_auto_build(
 
     // 5. Post status comment
     let comment = auto_build_started_comment(&head_sha, &merge_sha);
-    if let Err(error) = client.post_comment(pr.number, comment).await {
-        tracing::error!(
-            "Failed to post auto build started comment on PR {}: {error:?}",
-            pr.number
-        );
+    match client.post_comment(pr.number, comment).await {
+        Ok(comment) => {
+            if let Err(error) = ctx
+                .db
+                .record_tagged_bot_comment(
+                    repo.repository(),
+                    pr.number,
+                    CommentTag::AutoBuildStarted,
+                    &comment.node_id,
+                )
+                .await
+            {
+                tracing::error!("Cannot tag auto build started comment: {error:?}",);
+            }
+        }
+        Err(error) => {
+            tracing::error!("Failed to post auto build started comment: {error:?}",);
+        }
     };
 
     Ok(())
@@ -1134,4 +1148,29 @@ auto_build_failed = ["+foo", "+bar", "-baz"]
         })
         .await;
     }
+
+    #[sqlx::test]
+    async fn update_auto_build_started_comment_after_workflow_starts(pool: sqlx::PgPool) {
+        run_test(pool, async |tester: &mut BorsTester| {
+            tester.approve(()).await?;
+            tester.process_merge_queue().await;
+            let comment = tester.get_next_comment(()).await?;
+
+            tester.workflow_start(tester.auto_branch().await).await?;
+
+            // Check that the comment text has been updated with a link to the started workflow
+            let updated_comment = tester
+                .get_comment_by_node_id(&comment.node_id.unwrap())
+                .await
+                .unwrap();
+            insta::assert_snapshot!(updated_comment.content, @r"
+            :hourglass: Testing commit pr-1-sha with merge merge-0-pr-1...
+
+            **Workflow**: https://github.com/rust-lang/borstest/actions/runs/1
+            ");
+
+            Ok(())
+        })
+        .await;
+    }
 }

src/database/mod.rs

@@ -622,6 +622,7 @@ impl sqlx::Encode<'_, sqlx::Postgres> for CommentTag {
     ) -> Result<sqlx::encode::IsNull, BoxDynError> {
         let tag = match self {
             CommentTag::TryBuildStarted => "TryBuildStarted",
+            CommentTag::AutoBuildStarted => "AutoBuildStarted",
         };
         <&str as sqlx::Encode<sqlx::Postgres>>::encode(tag, buf)
     }
@@ -631,6 +632,7 @@ impl sqlx::Decode<'_, sqlx::Postgres> for CommentTag {
     fn decode(value: sqlx::postgres::PgValueRef<'_>) -> Result<Self, BoxDynError> {
         match <&str as sqlx::Decode<sqlx::Postgres>>::decode(value)? {
             "TryBuildStarted" => Ok(CommentTag::TryBuildStarted),
+            "AutoBuildStarted" => Ok(CommentTag::AutoBuildStarted),
             tag => Err(format!("Unknown comment tag: {tag}").into()),
         }
     }