aboutsummaryrefslogtreecommitdiffstats
path: root/src/release.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/release.rs')
-rw-r--r--src/release.rs65
1 files changed, 65 insertions, 0 deletions
diff --git a/src/release.rs b/src/release.rs
new file mode 100644
index 0000000..fe0df3b
--- /dev/null
+++ b/src/release.rs
@@ -0,0 +1,65 @@
+//! What this build of continuum is, as `--version` says it: its release, the wire versions
+//! it speaks, the federation and the revisions of it it knows, and the Automerge it makes
+//! documents with; what decides which builds work together in one swarm
+//! (`docs/operations.md`, Upgrading). Its peers say theirs with their handshakes
+//! (`swarm::speaking`).
+
+use std::sync::OnceLock;
+
+use crate::transport::wire;
+
+/// What `--version` says after the program's name: the release, then a line each.
+pub(crate) fn described() -> &'static str {
+ static DESCRIBED: OnceLock<String> = OnceLock::new();
+ DESCRIBED.get_or_init(|| {
+ let mut lines = vec![
+ env!("CARGO_PKG_VERSION").to_owned(),
+ format!("wire versions {} to {}", wire::OLDEST, wire::VERSION),
+ ];
+ lines.extend(federation());
+ lines.push(format!("automerge {}", crate::document::engine_version()));
+ lines.join("\n")
+ })
+}
+
+/// The federation this build knows, and its revisions, the base revision first.
+#[cfg(feature = "federation")]
+fn federation() -> Option<String> {
+ use crate::federation::revision::Revision;
+ let revisions: Vec<String> = Revision::known()
+ .map(|revision| revision.to_string())
+ .collect();
+ Some(format!(
+ "federation {}: {}",
+ crate::federation::version::FEDERATION,
+ revisions.join(", ")
+ ))
+}
+
+#[cfg(not(feature = "federation"))]
+fn federation() -> Option<String> {
+ None
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn a_build_says_what_decides_whom_it_works_with() {
+ let lines: Vec<&str> = described().lines().collect();
+ assert_eq!(lines[0], env!("CARGO_PKG_VERSION"));
+ assert_eq!(
+ lines[1],
+ format!("wire versions {} to {}", wire::OLDEST, wire::VERSION)
+ );
+ #[cfg(feature = "federation")]
+ assert!(
+ lines[2].starts_with("federation 1: the base revision"),
+ "{}",
+ lines[2]
+ );
+ let automerge = lines.last().expect("lines");
+ assert!(automerge.starts_with("automerge 0."), "{automerge}");
+ }
+}