save report file every time cryo is run

crates/cli/Cargo.toml

@@ -1,5 +1,6 @@
 [package]
 name = "cryo_cli"
+build = "build.rs"
 description = "cryo is the easiest way to extract blockchain data to parquet, csv, or json"
 version.workspace = true
 edition.workspace = true
@@ -32,3 +33,5 @@ chrono = "0.4.26"
 anstyle = "1.0.1"
 eyre = "0.6.8"
 governor = "0.5.1"
+serde = { version = "1.0.183", features = ["derive"] }
+serde_json = "1.0.104"

crates/cli/build.rs

@@ -0,0 +1,22 @@
+use std::process::Command;
+
+fn main() {
+    // Run `git describe --tags --always`
+    let output =
+        Command::new("git").args(["describe", "--tags", "--always"]).output().unwrap_or_else(|e| {
+            panic!("Failed to execute git command: {}", e);
+        });
+
+    if output.status.success() {
+        let git_description = String::from_utf8(output.stdout)
+            .unwrap_or_else(|e| {
+                panic!("Failed to read git command output: {}", e);
+            })
+            .trim()
+            .to_string();
+
+        println!("cargo:rustc-env=GIT_DESCRIPTION={}", git_description);
+    } else {
+        println!("cargo:warning=Could not determine git description");
+    }
+}

crates/cli/src/args.rs

@@ -1,8 +1,9 @@
 use clap_cryo::Parser;
 use color_print::cstr;
+use serde::{Deserialize, Serialize};
 
 /// Command line arguments
-#[derive(Parser, Debug)]
+#[derive(Parser, Debug, Serialize, Deserialize)]
 #[command(name = "cryo", author, version, about = get_about_str(), long_about = None, styles=get_styles(), after_help=get_after_str(), allow_negative_numbers = true)]
 pub struct Args {
     /// datatype to collect
@@ -132,9 +133,15 @@ pub struct Args {
     #[arg(long, help_heading="Output Options", value_name="NAME [#]", num_args(1..=2), default_value = "lz4")]
     pub compression: Vec<String>,
 
-    // /// [transactions] track gas used by each transaction
-    // #[arg(long, help_heading = "Dataset-specific Options")]
-    // pub gas_used: bool,
+    /// Directory to save summary report
+    /// [default: {output_dir}/.cryo_reports]
+    #[arg(long, help_heading = "Output Options")]
+    pub report_dir: Option<String>,
+
+    /// Avoid saving a summary report
+    #[arg(long, help_heading = "Output Options")]
+    pub no_report: bool,
+
     /// [logs] filter logs by contract address
     #[arg(long, help_heading = "Dataset-specific Options")]
     pub contract: Option<String>,

crates/cli/src/lib.rs

@@ -9,6 +9,7 @@
 
 mod args;
 mod parse;
+mod reports;
 mod run;
 mod summaries;
 

crates/cli/src/main.rs

@@ -4,6 +4,7 @@ use clap_cryo::Parser;
 
 mod args;
 mod parse;
+mod reports;
 mod run;
 mod summaries;
 

crates/cli/src/reports.rs

@@ -0,0 +1,61 @@
+use crate::args;
+use chrono::{DateTime, Local};
+use cryo_freeze::{FreezeError, FreezeSummary};
+use std::{fs::File, io::Write, path::Path, time::SystemTime};
+
+#[derive(serde::Serialize, Debug)]
+struct FreezeReport<'a> {
+    cryo_version: String,
+    // node_client: String,
+    cli_command: Vec<String>,
+    args: &'a args::Args,
+    chunk_summary: Option<&'a FreezeSummary>,
+}
+
+pub(crate) fn get_report_path(
+    args: &args::Args,
+    t_start: SystemTime,
+    is_complete: bool,
+) -> Result<String, FreezeError> {
+    let report_dir = match &args.report_dir {
+        Some(report_dir) => Path::new(&report_dir).into(),
+        None => Path::new(&args.output_dir).join(".cryo_reports"),
+    };
+    std::fs::create_dir_all(&report_dir)?;
+    let t_start: DateTime<Local> = t_start.into();
+    let timestamp: String = t_start.format("%Y-%m-%d_%H-%M-%S").to_string();
+    let filename = if is_complete {
+        timestamp + ".json"
+    } else {
+        format!("incomplete_{}", timestamp + ".json")
+    };
+    let path = report_dir.join(filename);
+    path.to_str()
+        .ok_or(FreezeError::GeneralError("non-String path".to_string()))
+        .map(|s| s.to_string())
+}
+
+pub(crate) fn write_report(
+    args: &args::Args,
+    freeze_summary: Option<&FreezeSummary>,
+    t_start: SystemTime,
+) -> Result<String, FreezeError> {
+    // determine version
+    let cryo_version = format!("{}__{}", env!("CARGO_PKG_VERSION"), env!("GIT_DESCRIPTION"));
+    let report = FreezeReport {
+        cryo_version,
+        cli_command: std::env::args().collect(),
+        args,
+        chunk_summary: freeze_summary,
+    };
+    let serialized = serde_json::to_string(&report)?;
+
+    // create path
+    let path = get_report_path(args, t_start, freeze_summary.is_some())?;
+
+    // save to file
+    let mut file = File::create(&path)?;
+    file.write_all(serialized.as_bytes())?;
+
+    Ok(path)
+}