Switch from bool to ForcePush enum

Author: Sakib25800

src/bors/handlers/trybuild.rs

@@ -16,6 +16,7 @@ use crate::database::RunId;
 use crate::database::{BuildModel, BuildStatus, PullRequestModel};
 use crate::github::GithubRepoName;
 use crate::github::api::client::GithubRepositoryClient;
+use crate::github::api::operations::ForcePush;
 use crate::github::{CommitSha, GithubUser, LabelTrigger, MergeError, PullRequestNumber};
 use crate::permissions::PermissionType;
 use crate::utils::text::suppress_github_mentions;
@@ -146,7 +147,7 @@ async fn attempt_merge(
 
     // First set the try branch to our base commit (either the selected parent or the main branch).
     client
-        .set_branch_to_sha(TRY_MERGE_BRANCH_NAME, base_sha, true)
+        .set_branch_to_sha(TRY_MERGE_BRANCH_NAME, base_sha, ForcePush::Yes)
         .await
         .map_err(|error| anyhow!("Cannot set try merge branch to {}: {error:?}", base_sha.0))?;
 
@@ -177,7 +178,7 @@ async fn run_try_build(
     parent_sha: CommitSha,
 ) -> anyhow::Result<()> {
     client
-        .set_branch_to_sha(TRY_BRANCH_NAME, &commit_sha, true)
+        .set_branch_to_sha(TRY_BRANCH_NAME, &commit_sha, ForcePush::Yes)
         .await
         .map_err(|error| anyhow!("Cannot set try branch to main branch: {error:?}"))?;
 

src/bors/merge_queue.rs

@@ -14,7 +14,7 @@ use crate::{
         handlers::labels::handle_label_trigger,
     },
     database::{BuildStatus, MergeableState, PullRequestModel},
-    github::{CommitSha, LabelTrigger, MergeError, api::client::GithubRepositoryClient},
+    github::{CommitSha, LabelTrigger, MergeError, api::client::GithubRepositoryClient, api::operations::ForcePush},
     utils::sort_queue::sort_queue_prs,
 };
 
@@ -80,7 +80,7 @@ pub async fn handle_merge_queue(ctx: Arc<BorsContext>) -> anyhow::Result<()> {
 
                         match repo
                             .client
-                            .set_branch_to_sha(&pr.base_branch, &commit_sha, false)
+                            .set_branch_to_sha(&pr.base_branch, &commit_sha, ForcePush::No)
                             .await
                         {
                             Ok(()) => {
@@ -202,7 +202,7 @@ async fn start_auto_build(
         MergeResult::Success(merge_sha) => {
             // 2. Push merge commit to `AUTO_BRANCH_NAME` where CI runs
             client
-                .set_branch_to_sha(AUTO_BRANCH_NAME, &merge_sha, true)
+                .set_branch_to_sha(AUTO_BRANCH_NAME, &merge_sha, ForcePush::Yes)
                 .await?;
 
             // 3. Record the build in the database
@@ -282,7 +282,7 @@ async fn attempt_merge(
 
     // Reset auto merge branch to point to base branch
     client
-        .set_branch_to_sha(AUTO_MERGE_BRANCH_NAME, base_sha, true)
+        .set_branch_to_sha(AUTO_MERGE_BRANCH_NAME, base_sha, ForcePush::Yes)
         .await
         .map_err(|error| anyhow!("Cannot set auto merge branch to {}: {error:?}", base_sha.0))?;
 

src/github/api/client.rs

@@ -9,7 +9,7 @@ use crate::bors::{CheckSuite, CheckSuiteStatus, Comment};
 use crate::config::{CONFIG_FILE_PATH, RepositoryConfig};
 use crate::database::RunId;
 use crate::github::api::base_github_html_url;
-use crate::github::api::operations::{MergeError, merge_branches, set_branch_to_commit};
+use crate::github::api::operations::{MergeError, merge_branches, set_branch_to_commit, ForcePush};
 use crate::github::{CommitSha, GithubRepoName, PullRequest, PullRequestNumber};
 use crate::utils::timing::{measure_network_request, perform_network_request_with_retry};
 use futures::TryStreamExt;
@@ -144,7 +144,7 @@ impl GithubRepositoryClient {
         &self,
         branch: &str,
         sha: &CommitSha,
-        force: bool,
+        force: ForcePush,
     ) -> anyhow::Result<()> {
         perform_network_request_with_retry("set_branch_to_sha", || async {
             Ok(set_branch_to_commit(self, branch.to_string(), sha, force).await?)

src/github/api/operations.rs

@@ -5,6 +5,21 @@ use thiserror::Error;
 use crate::github::CommitSha;
 use crate::github::api::client::GithubRepositoryClient;
 
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum ForcePush {
+    Yes,
+    No,
+}
+
+impl From<ForcePush> for bool {
+    fn from(force_push: ForcePush) -> bool {
+        match force_push {
+            ForcePush::Yes => true,
+            ForcePush::No => false,
+        }
+    }
+}
+
 #[derive(Error, Debug)]
 pub enum MergeError {
     #[error("Branch not found")]
@@ -94,7 +109,7 @@ pub async fn set_branch_to_commit(
     repo: &GithubRepositoryClient,
     branch_name: String,
     sha: &CommitSha,
-    force: bool,
+    force: ForcePush,
 ) -> Result<(), BranchUpdateError> {
     // Fast-path: assume that the branch exists
     match update_branch(repo, branch_name.clone(), sha, force).await {
@@ -138,7 +153,7 @@ async fn update_branch(
     repo: &GithubRepositoryClient,
     branch_name: String,
     sha: &CommitSha,
-    force: bool,
+    force: ForcePush,
 ) -> Result<(), BranchUpdateError> {
     let url = format!(
         "/repos/{}/git/refs/{}",
@@ -154,7 +169,7 @@ async fn update_branch(
             url.as_str(),
             Some(&serde_json::json!({
                 "sha": sha.as_ref(),
-                "force": force
+                "force": bool::from(force)
             })),
         )
         .await?;