context

Author: epompeii

lib/bencher_client/src/lib.rs

@@ -32,6 +32,7 @@ macro_rules! from_client {
 }
 
 from_client!(
+    JsonReportContext,
     BenchmarkName,
     Boundary,
     BranchName,

lib/bencher_json/src/lib.rs

@@ -48,7 +48,7 @@ pub use project::{
     model::{JsonModel, ModelUuid},
     perf::{JsonPerf, JsonPerfQuery, ReportBenchmarkUuid},
     plot::{JsonNewPlot, JsonPlot, JsonPlots, PlotUuid},
-    report::{JsonNewReport, JsonReport, JsonReports, ReportUuid},
+    report::{JsonNewReport, JsonReport, JsonReportContext, JsonReports, ReportUuid},
     testbed::{JsonNewTestbed, JsonTestbed, JsonTestbeds, TestbedUuid},
     threshold::{JsonNewThreshold, JsonThreshold, JsonThresholds, ThresholdUuid},
     JsonNewProject, JsonProject, JsonProjects, ProjectUuid,

lib/bencher_json/src/project/report.rs

@@ -51,6 +51,8 @@ pub struct JsonNewReport {
     pub results: Vec<String>,
     /// Settings for how to handle the report.
     pub settings: Option<JsonReportSettings>,
+    /// Context for the report.
+    pub context: Option<JsonReportContext>,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -80,6 +82,31 @@ pub struct JsonReportSettings {
     pub fold: Option<JsonFold>,
 }
 
+#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[cfg_attr(feature = "schema", derive(JsonSchema))]
+pub struct JsonReportContext(pub HashMap<String, Option<String>>);
+
+impl JsonReportContext {
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    pub fn insert(&mut self, key: String, value: Option<String>) -> Option<Option<String>> {
+        self.0.insert(key, value)
+    }
+
+    pub fn remove(&mut self, key: &str) -> Option<Option<String>> {
+        self.0.remove(key)
+    }
+}
+
+#[allow(clippy::implicit_hasher)]
+impl From<JsonReportContext> for HashMap<String, Option<String>> {
+    fn from(context: JsonReportContext) -> Self {
+        context.0
+    }
+}
+
 const MAGIC_INT: i32 = 0;
 const JSON_INT: i32 = 10;
 const RUST_INT: i32 = 20;

services/api/openapi.json

@@ -9387,6 +9387,15 @@
               }
             ]
           },
+          "context": {
+            "nullable": true,
+            "description": "Context for the report.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/JsonReportContext"
+              }
+            ]
+          },
           "end_time": {
             "description": "End time for the report. Must be an ISO 8601 formatted string.",
             "allOf": [
@@ -10731,6 +10740,13 @@
           "uuid"
         ]
       },
+      "JsonReportContext": {
+        "type": "object",
+        "additionalProperties": {
+          "nullable": true,
+          "type": "string"
+        }
+      },
       "JsonReportMeasure": {
         "type": "object",
         "properties": {

services/cli/src/bencher/sub/project/report/create.rs

@@ -99,6 +99,7 @@ impl From<Create> for JsonNewReport {
                 average,
                 fold,
             }),
+            context: None,
         }
     }
 }

services/cli/src/bencher/sub/project/run/context.rs

@@ -1,31 +1,50 @@
-use bencher_json::{Fingerprint, GitHash};
+use bencher_json::{project::report::JsonReportContext, Fingerprint, GitHash};
 use gix::Repository;
 
 use super::branch::find_repo;
 
 const ROOT: &str = "root";
 
-pub fn context() {
+pub fn get_context() -> Option<JsonReportContext> {
+    let mut context = JsonReportContext::new();
+
     let repo = find_repo();
     let repo_name = repo_name(repo.as_ref());
     if let Some(repo_name) = repo_name {
-        println!("{repo_name}");
+        context.insert("bencher.dev/repo/name".to_owned(), Some(repo_name));
+    }
+    if let Some(repo) = &repo {
+        if let Some(root_commit) = find_default_branch_and_root_commit(&repo) {
+            context.insert(
+                "bencher.dev/repo/hash".to_owned(),
+                Some(root_commit.to_string()),
+            );
+        }
     }
 
     if let Some(repo) = repo {
-        if let Some(branch) = current_branch_name(&repo) {
-            println!("{branch:?}");
+        if let Some((branch_ref, branch_ref_name)) = current_branch_name(&repo) {
+            context.insert("bencher.dev/branch/ref".to_owned(), Some(branch_ref));
+            context.insert(
+                "bencher.dev/branch/ref/name".to_owned(),
+                Some(branch_ref_name),
+            );
         }
 
-        if let Some(root_commit) = find_default_branch_and_root_commit(&repo) {
-            println!("Root commit hash: {root_commit:?}");
+        if let Some(hash) = current_branch_hash(&repo) {
+            context.insert("bencher.dev/branch/hash".to_owned(), Some(hash));
         }
     }
 
     let fingerprint = Fingerprint::new();
     if let Some(fingerprint) = fingerprint {
-        println!("{fingerprint}");
+        context.insert(
+            "bencher.dev/testbed/fingerprint".to_owned(),
+            Some(fingerprint.to_string()),
+        );
     }
+
+    Some(context)
 }
 
 fn repo_name(repo: Option<&Repository>) -> Option<String> {
@@ -46,6 +65,12 @@ fn current_branch_name(repo: &Repository) -> Option<(String, String)> {
     })
 }
 
+fn current_branch_hash(repo: &Repository) -> Option<String> {
+    let head_id = repo.head_id().ok()?;
+    let head_object = head_id.object().ok()?;
+    Some(head_object.id.to_string())
+}
+
 fn find_default_branch_and_root_commit(repo: &Repository) -> Option<GitHash> {
     let head_id = repo.head_id().ok()?;
     let rev_walk = repo.rev_walk([head_id]).all().ok()?;

services/cli/src/bencher/sub/project/run/mod.rs

@@ -187,8 +187,9 @@ impl Run {
             (start_time, end_time)
         };
 
-        context::context();
         let (branch, hash, start_point) = self.branch.clone().into();
+        let context = context::get_context();
+        println!("{context:?}");
         Ok(Some(JsonNewReport {
             branch,
             hash,
@@ -203,6 +204,7 @@ impl Run {
                 average: self.average,
                 fold: self.fold,
             }),
+            context: context.map(Into::into),
         }))
     }