Add a purge_artifact command to manually remove all data of an artifact

Author: Kobzol

collector/src/bin/collector.rs

@@ -570,6 +570,15 @@ enum Commands {
 
     /// Download a crate into collector/benchmarks.
     Download(DownloadCommand),
+
+    /// Removes all data associated with artifact(s) with the given name.
+    PurgeArtifact {
+        /// Name of the artifact.
+        name: String,
+
+        #[command(flatten)]
+        db: DbOption,
+    },
 }
 
 #[derive(Debug, clap::Parser)]
@@ -953,6 +962,14 @@ fn main_result() -> anyhow::Result<i32> {
             println!("Benchmark stored at {}", target_dir.display());
             Ok(0)
         }
+        Commands::PurgeArtifact { name, db } => {
+            let pool = Pool::open(&db.db);
+            let conn = rt.block_on(pool.connection());
+            rt.block_on(conn.purge_artifact(&ArtifactId::Tag(name.clone())));
+
+            println!("Data of artifact {name} were removed");
+            Ok(0)
+        }
     }
 }
 

database/manual-modifications.md

@@ -0,0 +1,23 @@
+# Useful queries and commands
+This document contains useful queries and commands that should be performed manually in exceptional
+situations.
+
+## Remove data for an artifact from the DB
+This is important for situations where there is some compilation error for a stable benchmark,
+with a stable release of the compiler. While this should be rare, it happens sometimes e.g. because
+of future incompatibility lints turning into errors.
+
+First, the benchmark should be fixed, and then any data for (published) artifacts that were
+benchmarked with the broken benchmark should be removed.
+
+All data associated with an artifact can be removed using the following command:
+```bash
+$ cargo run --bin collector purge_artifact <artifact-name>
+```
+
+Here is an example to remove the data of the `1.70.0` stable release artifact:
+```bash
+$ cargo run --bin collector purge_artifact 1.70.0
+```
+
+After executing this command, the server should automatically re-benchmark the affected artifacts again.