Auto merge of #20 - troy/cancel-actions, r=<dry>

cancel workflow runs when brawl cancel when brawl cancel is triggers, we cancel any github action workflows on the branch where the commit is the commit of the run. BRAWL-10 Requested-by: TroyKomodo <[email protected]>
ScuffleCloud · Dec 26, 2024 · 3db55bd · 3db55bd
2 parents 602b966 + 94c1736
commit 3db55bd
Show file tree

Hide file tree

Showing 5 changed files with 547 additions and 46 deletions.
diff --git a/server/src/github/merge_workflow.rs b/server/src/github/merge_workflow.rs
@@ -618,47 +618,30 @@ impl GitHubMergeWorkflow for DefaultMergeWorkflow {
         );
 
         // TODO: cancel runs on github actions
-        if let Some(_run_commit_sha) = &run.run_commit_sha {
-            // let page = repo
-            //     .client()
-            //     .workflows(repo.owner.login.clone(), repo.name.clone())
-            //     .list_all_runs()
-            //     .branch(self.ci_branch.clone())
-            //     .per_page(100)
-            //     .page(1u32)
-            //     .send()
-            //     .await?;
-
-            // let mut total_workflows = page.items;
-
-            // while let Some(page) = client.client().get_page(&page.next).await? {
-            //     total_workflows.extend(page.items);
-            // }
-
-            // for workflow in total_workflows.into_iter().filter(|w| w.head_sha ==
-            // run_commit_sha) {     if workflow.conclusion.is_none() {
-            //         client
-            //             .client()
-            //             .post::<_, serde_json::Value>(
-            //                 format!(
-            //                     "/repos/{owner}/{repo}/actions/runs/{id}/cancel",
-            //                     owner = repo_owner.login,
-            //                     repo = repo.name,
-            //                     id = workflow.id
-            //                 ),
-            //                 None::<&()>,
-            //             )
-            //             .await?;
-            //         tracing::info!(
-            //             run_id = %run_id,
-            //             repo_id = %run.github_repo_id,
-            //             "cancelled workflow {id} on https://github.com/{owner}/{repo}/actions/runs/{id}",
-            //             owner = repo_owner.login,
-            //             repo = repo.name,
-            //             id = workflow.id
-            //         );
-            //     }
-            // }
+        if let Some(run_commit_sha) = &run.run_commit_sha {
+            let runs = repo.branch_workflows(&run.ci_branch).await.context("get workflows")?;
+
+            for workflow in runs.into_iter().filter(|w| &w.head_sha == run_commit_sha) {
+                if workflow.conclusion.is_none() {
+                    if let Err(err) = repo.cancel_workflow_run(workflow.id).await {
+                        tracing::error!(
+                            run_id = %run.id,
+                            repo_id = %run.github_repo_id,
+                            url = repo.workflow_run_link(workflow.id),
+                            pr = repo.pr_link(run.github_pr_number as u64),
+                            "failed to cancel workflow: {err:#}",
+                        );
+                    } else {
+                        tracing::info!(
+                            run_id = %run.id,
+                            repo_id = %run.github_repo_id,
+                            url = repo.workflow_run_link(workflow.id),
+                            pr = repo.pr_link(run.github_pr_number as u64),
+                            "cancelled workflow",
+                        );
+                    }
+                }
+            }
 
             repo.delete_branch(&run.ci_branch).await?;
         }
@@ -702,14 +685,14 @@ mod tests {
     use std::time::Duration;
 
     use chrono::Utc;
-    use octocrab::models::RepositoryId;
+    use octocrab::models::{RepositoryId, RunId};
     use tokio::sync::mpsc;
 
     use super::*;
     use crate::database::ci_run::{InsertCiRun, UpdateCiRun};
     use crate::database::enums::{GithubPrMergeStatus, GithubPrStatus};
     use crate::github::config::{GitHubBrawlLabelsConfig, GitHubBrawlRepoConfig};
-    use crate::github::models::{CheckRunConclusion, CheckRunEvent, CheckRunStatus, Commit};
+    use crate::github::models::{CheckRunConclusion, CheckRunEvent, CheckRunStatus, Commit, WorkflowRun};
     use crate::github::repo::test_utils::{MockRepoAction, MockRepoClient};
 
     #[bon::builder]
@@ -2439,6 +2422,37 @@ mod tests {
             conn
         });
 
+        match rx.recv().await.unwrap() {
+            MockRepoAction::BranchWorkflows { branch, result } => {
+                assert_eq!(branch, "ci_branch");
+                result
+                    .send(Ok(vec![
+                        WorkflowRun {
+                            id: RunId(1),
+                            conclusion: None,
+                            head_sha: "run_commit_sha".to_string(),
+                            ..Default::default()
+                        },
+                        WorkflowRun {
+                            id: RunId(2),
+                            conclusion: None,
+                            head_sha: "not_run_commit_sha".to_string(),
+                            ..Default::default()
+                        },
+                    ]))
+                    .unwrap();
+            }
+            r => panic!("unexpected action: {:?} expected branch", r),
+        }
+
+        match rx.recv().await.unwrap() {
+            MockRepoAction::CancelWorkflowRun { run_id, result } => {
+                assert_eq!(run_id, RunId(1));
+                result.send(Ok(())).unwrap();
+            }
+            r => panic!("unexpected action: {:?} expected cancel workflow run", r),
+        }
+
         match rx.recv().await.unwrap() {
             MockRepoAction::DeleteBranch { branch, result } => {
                 assert_eq!(branch, "ci_branch");

diff --git a/server/src/github/mock/cancel_workflow_run.json b/server/src/github/mock/cancel_workflow_run.json
@@ -0,0 +1 @@
+{}
diff --git a/server/src/github/mock/get_workflow_runs.json b/server/src/github/mock/get_workflow_runs.json
@@ -0,0 +1,225 @@
+{
+	"total_count": 1,
+	"workflow_runs": [
+		{
+			"id": 30433642,
+			"name": "Build",
+			"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
+			"check_suite_id": 42,
+			"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
+			"head_branch": "master",
+			"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
+			"path": ".github/workflows/build.yml@main",
+			"run_number": 562,
+			"event": "push",
+			"display_title": "Update README.md",
+			"status": "queued",
+			"conclusion": null,
+			"workflow_id": 159038,
+			"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
+			"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
+			"pull_requests": [],
+			"created_at": "2020-01-22T19:33:08Z",
+			"updated_at": "2020-01-22T19:33:08Z",
+			"actor": {
+				"login": "octocat",
+				"id": 1,
+				"node_id": "MDQ6VXNlcjE=",
+				"avatar_url": "https://github.com/images/error/octocat_happy.gif",
+				"gravatar_id": "",
+				"url": "https://api.github.com/users/octocat",
+				"html_url": "https://github.com/octocat",
+				"followers_url": "https://api.github.com/users/octocat/followers",
+				"following_url": "https://api.github.com/users/octocat/following{/other_user}",
+				"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+				"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+				"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+				"organizations_url": "https://api.github.com/users/octocat/orgs",
+				"repos_url": "https://api.github.com/users/octocat/repos",
+				"events_url": "https://api.github.com/users/octocat/events{/privacy}",
+				"received_events_url": "https://api.github.com/users/octocat/received_events",
+				"type": "User",
+				"site_admin": false
+			},
+			"run_attempt": 1,
+			"run_started_at": "2020-01-22T19:33:08Z",
+			"triggering_actor": {
+				"login": "octocat",
+				"id": 1,
+				"node_id": "MDQ6VXNlcjE=",
+				"avatar_url": "https://github.com/images/error/octocat_happy.gif",
+				"gravatar_id": "",
+				"url": "https://api.github.com/users/octocat",
+				"html_url": "https://github.com/octocat",
+				"followers_url": "https://api.github.com/users/octocat/followers",
+				"following_url": "https://api.github.com/users/octocat/following{/other_user}",
+				"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+				"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+				"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+				"organizations_url": "https://api.github.com/users/octocat/orgs",
+				"repos_url": "https://api.github.com/users/octocat/repos",
+				"events_url": "https://api.github.com/users/octocat/events{/privacy}",
+				"received_events_url": "https://api.github.com/users/octocat/received_events",
+				"type": "User",
+				"site_admin": false
+			},
+			"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
+			"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
+			"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
+			"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
+			"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
+			"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
+			"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
+			"head_commit": {
+				"id": "acb5820ced9479c074f688cc328bf03f341a511d",
+				"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
+				"message": "Create linter.yaml",
+				"timestamp": "2020-01-22T19:33:05Z",
+				"author": {
+					"name": "Octo Cat",
+					"email": "[email protected]"
+				},
+				"committer": {
+					"name": "GitHub",
+					"email": "[email protected]"
+				}
+			},
+			"repository": {
+				"id": 1296269,
+				"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+				"name": "Hello-World",
+				"full_name": "octocat/Hello-World",
+				"owner": {
+					"login": "octocat",
+					"id": 1,
+					"node_id": "MDQ6VXNlcjE=",
+					"avatar_url": "https://github.com/images/error/octocat_happy.gif",
+					"gravatar_id": "",
+					"url": "https://api.github.com/users/octocat",
+					"html_url": "https://github.com/octocat",
+					"followers_url": "https://api.github.com/users/octocat/followers",
+					"following_url": "https://api.github.com/users/octocat/following{/other_user}",
+					"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+					"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+					"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+					"organizations_url": "https://api.github.com/users/octocat/orgs",
+					"repos_url": "https://api.github.com/users/octocat/repos",
+					"events_url": "https://api.github.com/users/octocat/events{/privacy}",
+					"received_events_url": "https://api.github.com/users/octocat/received_events",
+					"type": "User",
+					"site_admin": false
+				},
+				"private": false,
+				"html_url": "https://github.com/octocat/Hello-World",
+				"description": "This your first repo!",
+				"fork": false,
+				"url": "https://api.github.com/repos/octocat/Hello-World",
+				"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+				"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+				"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+				"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+				"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+				"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+				"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+				"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+				"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+				"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+				"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+				"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+				"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+				"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+				"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+				"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+				"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+				"git_url": "git:github.com/octocat/Hello-World.git",
+				"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+				"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+				"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+				"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+				"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+				"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+				"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+				"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+				"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+				"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+				"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+				"ssh_url": "[email protected]:octocat/Hello-World.git",
+				"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+				"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+				"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+				"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+				"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+				"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+				"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+				"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+			},
+			"head_repository": {
+				"id": 217723378,
+				"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
+				"name": "octo-repo",
+				"full_name": "octo-org/octo-repo",
+				"private": true,
+				"owner": {
+					"login": "octocat",
+					"id": 1,
+					"node_id": "MDQ6VXNlcjE=",
+					"avatar_url": "https://github.com/images/error/octocat_happy.gif",
+					"gravatar_id": "",
+					"url": "https://api.github.com/users/octocat",
+					"html_url": "https://github.com/octocat",
+					"followers_url": "https://api.github.com/users/octocat/followers",
+					"following_url": "https://api.github.com/users/octocat/following{/other_user}",
+					"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+					"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+					"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+					"organizations_url": "https://api.github.com/users/octocat/orgs",
+					"repos_url": "https://api.github.com/users/octocat/repos",
+					"events_url": "https://api.github.com/users/octocat/events{/privacy}",
+					"received_events_url": "https://api.github.com/users/octocat/received_events",
+					"type": "User",
+					"site_admin": false
+				},
+				"html_url": "https://github.com/octo-org/octo-repo",
+				"description": null,
+				"fork": false,
+				"url": "https://api.github.com/repos/octo-org/octo-repo",
+				"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
+				"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
+				"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
+				"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
+				"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
+				"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
+				"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
+				"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
+				"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
+				"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
+				"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
+				"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
+				"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
+				"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
+				"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
+				"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
+				"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
+				"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
+				"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
+				"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
+				"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
+				"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
+				"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
+				"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
+				"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
+				"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
+				"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
+				"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
+				"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
+				"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
+				"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
+				"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
+				"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
+				"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
+				"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
+				"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments"
+			}
+		}
+	]
+}