worker/jobs/index: Extract SquashIndex into dedicated module

Author: Turbo87

src/worker/jobs/index/mod.rs

@@ -3,22 +3,20 @@ use crate::tasks::spawn_blocking;
 use crate::util::diesel::Conn;
 use crate::worker::Environment;
 use anyhow::Context;
-use chrono::Utc;
-use crates_io_env_vars::var_parsed;
 use crates_io_index::Repository;
 use crates_io_worker::BackgroundJob;
 use diesel::prelude::*;
 use diesel_async::async_connection_wrapper::AsyncConnectionWrapper;
 use sentry::Level;
 use std::fs::{self, File};
 use std::io::{ErrorKind, Write};
-use std::process::Command;
 use std::sync::Arc;
-use url::Url;
 
 mod normalize;
+mod squash;
 
 pub use normalize::NormalizeIndex;
+pub use squash::SquashIndex;
 
 #[derive(Serialize, Deserialize)]
 pub struct SyncToGitIndex {
@@ -167,61 +165,3 @@ pub fn get_index_data(name: &str, conn: &mut impl Conn) -> anyhow::Result<Option
 
     Ok(Some(str))
 }
-
-#[derive(Serialize, Deserialize)]
-pub struct SquashIndex;
-
-impl BackgroundJob for SquashIndex {
-    const JOB_NAME: &'static str = "squash_index";
-    const QUEUE: &'static str = "repository";
-
-    type Context = Arc<Environment>;
-
-    /// Collapse the index into a single commit, archiving the current history in a snapshot branch.
-    #[instrument(skip_all)]
-    async fn run(&self, env: Self::Context) -> anyhow::Result<()> {
-        info!("Squashing the index into a single commit");
-
-        spawn_blocking(move || {
-            let repo = env.lock_index()?;
-
-            let now = Utc::now().format("%Y-%m-%d");
-            let original_head = repo.head_oid()?.to_string();
-            let msg = format!("Collapse index into one commit\n\n\
-            Previous HEAD was {original_head}, now on the `snapshot-{now}` branch\n\n\
-            More information about this change can be found [online] and on [this issue].\n\n\
-            [online]: https://internals.rust-lang.org/t/cargos-crate-index-upcoming-squash-into-one-commit/8440\n\
-            [this issue]: https://github.com/rust-lang/crates-io-cargo-teams/issues/47");
-
-            repo.squash_to_single_commit(&msg)?;
-
-            // Shell out to git because libgit2 does not currently support push leases
-
-            repo.run_command(Command::new("git").args([
-                "push",
-                // Both updates should succeed or fail together
-                "--atomic",
-                "origin",
-                // Overwrite master, but only if it server matches the expected value
-                &format!("--force-with-lease=refs/heads/master:{original_head}"),
-                // The new squashed commit is pushed to master
-                "HEAD:refs/heads/master",
-                // The previous value of HEAD is pushed to a snapshot branch
-                &format!("{original_head}:refs/heads/snapshot-{now}"),
-            ]))?;
-
-            if let Some(archive_url) = var_parsed::<Url>("GIT_ARCHIVE_REPO_URL")? {
-                repo.run_command(Command::new("git").args([
-                    "push",
-                    archive_url.as_str(),
-                    &format!("{original_head}:snapshot-{now}"),
-                ]))?;
-            }
-
-            info!("The index has been successfully squashed.");
-
-            Ok(())
-        })
-        .await
-    }
-}

src/worker/jobs/index/squash.rs

@@ -0,0 +1,66 @@
+use crate::tasks::spawn_blocking;
+use crate::worker::Environment;
+use chrono::Utc;
+use crates_io_env_vars::var_parsed;
+use crates_io_worker::BackgroundJob;
+use std::process::Command;
+use std::sync::Arc;
+use url::Url;
+
+#[derive(Serialize, Deserialize)]
+pub struct SquashIndex;
+
+impl BackgroundJob for SquashIndex {
+    const JOB_NAME: &'static str = "squash_index";
+    const QUEUE: &'static str = "repository";
+
+    type Context = Arc<Environment>;
+
+    /// Collapse the index into a single commit, archiving the current history in a snapshot branch.
+    #[instrument(skip_all)]
+    async fn run(&self, env: Self::Context) -> anyhow::Result<()> {
+        info!("Squashing the index into a single commit");
+
+        spawn_blocking(move || {
+            let repo = env.lock_index()?;
+
+            let now = Utc::now().format("%Y-%m-%d");
+            let original_head = repo.head_oid()?.to_string();
+            let msg = format!("Collapse index into one commit\n\n\
+            Previous HEAD was {original_head}, now on the `snapshot-{now}` branch\n\n\
+            More information about this change can be found [online] and on [this issue].\n\n\
+            [online]: https://internals.rust-lang.org/t/cargos-crate-index-upcoming-squash-into-one-commit/8440\n\
+            [this issue]: https://github.com/rust-lang/crates-io-cargo-teams/issues/47");
+
+            repo.squash_to_single_commit(&msg)?;
+
+            // Shell out to git because libgit2 does not currently support push leases
+
+            repo.run_command(Command::new("git").args([
+                "push",
+                // Both updates should succeed or fail together
+                "--atomic",
+                "origin",
+                // Overwrite master, but only if it server matches the expected value
+                &format!("--force-with-lease=refs/heads/master:{original_head}"),
+                // The new squashed commit is pushed to master
+                "HEAD:refs/heads/master",
+                // The previous value of HEAD is pushed to a snapshot branch
+                &format!("{original_head}:refs/heads/snapshot-{now}"),
+            ]))?;
+
+            if let Some(archive_url) = var_parsed::<Url>("GIT_ARCHIVE_REPO_URL")? {
+                repo.run_command(Command::new("git").args([
+                    "push",
+                    archive_url.as_str(),
+                    &format!("{original_head}:snapshot-{now}"),
+                ]))?;
+            }
+
+            info!("The index has been successfully squashed.");
+
+            Ok(())
+        })
+        .await
+    }
+}