Added mrecordlog_cli. (#64)

* Added mrecordlog_cli.

* blop

Author: fulmicoton

Cargo.toml

@@ -1,3 +1,4 @@
+workspace = { members = ["mrecordlog_cli"] }
 [package]
 name = "mrecordlog"
 version = "0.4.0"

Dockerfile

@@ -0,0 +1,29 @@
+# --- Builder
+
+FROM rust:bullseye AS bin-builder
+
+COPY . /mrecordlog
+
+WORKDIR /mrecordlog/mrecordlog_cli
+
+RUN --mount=type=cache,target=/usr/local/cargo/registry \
+    --mount=type=cache,target=/mrecordlog/target \
+    cargo build --release --bin mrecordlog && \
+    ls /mrecordlog/target/release && \
+    mkdir -p /quickwit/bin && \
+    mv /mrecordlog/target/release/mrecordlog /quickwit/bin/mrecordlog
+
+# --- ACTUAL image.
+
+FROM debian:bullseye-slim AS quickwit
+
+LABEL org.opencontainers.image.title="Quickwit MRecordlog utils CLI"
+LABEL maintainer="Quickwit, Inc. <hello@quickwit.io>"
+LABEL org.opencontainers.image.vendor="Quickwit, Inc."
+LABEL org.opencontainers.image.licenses="AGPL-3.0"
+
+WORKDIR /quickwit
+
+COPY --from=bin-builder /quickwit/bin/mrecordlog /usr/local/bin/mrecordlog
+
+ENTRYPOINT ["mrecordlog"]

Makefile

@@ -8,3 +8,7 @@ fmt:
 fix: fmt
 	@echo "Running cargo clippy --fix"
 	cargo clippy --fix --all-features --allow-dirty --allow-staged
+
+push:
+	docker buildx build --platform linux/amd64  -t quickwit/mrecordlog:0.1 . --push
+

mrecordlog_cli/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "mrecordlog_cli"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+mrecordlog = { path = "../" }
+anyhow = "*"
+structopt = "0.3"
+
+[[bin]]
+name = "mrecordlog"
+path = "src/main.rs"

mrecordlog_cli/src/main.rs

@@ -0,0 +1,55 @@
+use std::path::{Path, PathBuf};
+
+use mrecordlog::MultiRecordLog;
+use structopt::StructOpt;
+
+#[derive(Debug, StructOpt)]
+enum Command {
+    Summary {
+        #[structopt(short = "f", default_value = "./wal")]
+        wal_path: PathBuf,
+    },
+    Read {
+        #[structopt(short = "f", default_value = "./wal")]
+        wal_path: PathBuf,
+        queue_name: String,
+    },
+}
+
+fn run_summary(path: &Path) -> anyhow::Result<()> {
+    let multi_record_log = MultiRecordLog::open(path)?;
+    let summary = multi_record_log.summary();
+    for (queue, summary) in summary.queues {
+        println!("{}", queue);
+        println!("{summary:?}");
+    }
+    Ok(())
+}
+
+fn run_read_queue(path: &Path, queue_name: &str) -> anyhow::Result<()> {
+    let multi_record_log = MultiRecordLog::open(path)?;
+    for record in multi_record_log.range(queue_name, ..)? {
+        let Ok(payload_str) = std::str::from_utf8(&record.payload) else {
+            eprintln!("Payload is not utf8: {:?}", record.payload);
+            continue;
+        };
+        println!("{payload_str}");
+    }
+    Ok(())
+}
+
+fn main() -> anyhow::Result<()> {
+    let command = Command::from_args();
+    match command {
+        Command::Summary { wal_path } => {
+            run_summary(&wal_path)?;
+        }
+        Command::Read {
+            queue_name,
+            wal_path,
+        } => {
+            run_read_queue(&wal_path, &queue_name)?;
+        }
+    }
+    Ok(())
+}

src/error.rs

@@ -76,6 +76,14 @@ impl From<MissingQueue> for AppendError {
 #[derive(Debug)]
 pub struct MissingQueue(pub String);
 
+impl std::fmt::Display for MissingQueue {
+    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+        write!(f, "Missing queue: {}", self.0)
+    }
+}
+
+impl std::error::Error for MissingQueue {}
+
 #[derive(Error, Debug)]
 pub enum ReadRecordError {
     #[error("Io error: {0}")]