aboutsummaryrefslogtreecommitdiffstats
path: root/src/federation/revision.rs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-19 03:48:03 +0000
committertv <tv@krebsco.de>2026-11-19 05:10:06 +0100
commit54bcc0e4ee8e1e6a29e0e01369c2ba95b27abce8 (patch)
tree20568ac1b47394ae9e603630fe1ab5464d1f7900 /src/federation/revision.rs
parente5f8df2a78f26d5928d1c96573dae5620dba5e25 (diff)
federation: a version names the revision of federation 1 it follows
What every node must agree on was named by the federation's number alone, and a change that only took more kept it: a party could use it before every node ran it, and nodes not upgraded refused what followed and parted from the others. A version now names the revision it follows by its ID (`"revision": "<ID>"`), the SHA-256 of the JCS list of the features it adds to the base revision federation 1 began with (`federation::revision`); a version naming none follows the base revision, ECDSA keys among it, so the versions written so far read as they did. A version names the base revision only by leaving `revision` out, and a revision no earlier than the one of the version it changes. A continuum that doesn't know a revision, another build's among them, can't read a version naming it: it stops at a version event writing one, and says which revision and what it knows. There are no revisions yet but the base revision. `federation.md` says how a revision is rolled out, then passed, and what a later continuum may leave out; the upgrades guide, and the one on a node stopped, alike.
Diffstat (limited to 'src/federation/revision.rs')
-rw-r--r--src/federation/revision.rs123
1 files changed, 123 insertions, 0 deletions
diff --git a/src/federation/revision.rs b/src/federation/revision.rs
new file mode 100644
index 0000000..876ec15
--- /dev/null
+++ b/src/federation/revision.rs
@@ -0,0 +1,123 @@
+//! The revisions of federation 1 (`docs/federation.md`, Changing the federation): what a
+//! version names of what nodes take, refuse and count beyond the base revision the
+//! federation began with. Each adds a feature to those of the one before. A revision is
+//! named by the SHA-256 of the JCS list of its features' names, so that a continuum that
+//! doesn't know it, another build's among them, can't read a version naming it, and stops
+//! there.
+
+use std::fmt;
+
+use super::jcs::Json;
+use super::store::Id;
+
+/// A feature a revision adds.
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+pub(crate) enum Feature {}
+
+impl Feature {
+ /// Its name, in the IDs of the revisions that have it: never changed once released,
+ /// and specific, so that a feature another build names alike is one it adds alike.
+ pub(crate) fn name(self) -> &'static str {
+ match self {}
+ }
+
+ /// What it adds, in a line.
+ pub(crate) fn what(self) -> &'static str {
+ match self {}
+ }
+}
+
+/// The features, in the order revisions add them: revision n has the first n, the base
+/// revision none. Only ever appended to.
+pub(crate) const FEATURES: &[Feature] = &[];
+
+/// A revision: how many of `FEATURES` it has.
+#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
+pub(crate) struct Revision(pub(crate) usize);
+
+impl Revision {
+ /// The newest this continuum knows.
+ pub(crate) fn newest() -> Revision {
+ Revision(FEATURES.len())
+ }
+
+ /// Every revision this continuum knows, the base revision first.
+ pub(crate) fn known() -> impl Iterator<Item = Revision> {
+ (0..=FEATURES.len()).map(Revision)
+ }
+
+ /// Its ID: the SHA-256 of the JCS list of its features' names.
+ pub(crate) fn id(self) -> Id {
+ let names = self
+ .features()
+ .iter()
+ .map(|feature| Json::Str(feature.name().to_owned()))
+ .collect();
+ Id::of(&Json::Array(names).bytes())
+ }
+
+ /// The revision of ID `id`, of those this continuum knows.
+ pub(crate) fn of(id: &Id) -> Option<Revision> {
+ Revision::known().find(|revision| revision.id() == *id)
+ }
+
+ /// Its features.
+ pub(crate) fn features(self) -> &'static [Feature] {
+ &FEATURES[..self.0]
+ }
+
+ /// Whether it has `feature`.
+ pub(crate) fn has(self, feature: Feature) -> bool {
+ self.features().contains(&feature)
+ }
+
+ /// What this continuum knows, as people read it: "the base revision alone", or
+ /// "revisions up to 2 (…)".
+ pub(crate) fn knowing() -> String {
+ match Revision::newest() {
+ Revision(0) => "the base revision alone".to_owned(),
+ newest => format!("revisions up to {} ({})", newest.0, newest.names()),
+ }
+ }
+
+ /// Its features' names, as people read them.
+ fn names(self) -> String {
+ let names: Vec<&str> = self
+ .features()
+ .iter()
+ .map(|feature| feature.name())
+ .collect();
+ names.join(", ")
+ }
+}
+
+/// As people read it: "the base revision", or "revision 2 (merge-events, …)".
+impl fmt::Display for Revision {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self.0 {
+ 0 => f.write_str("the base revision"),
+ n => write!(f, "revision {n} ({})", self.names()),
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ /// A revision's ID is the SHA-256 of the JCS list of its features' names: the base
+ /// revision's, of `[]`.
+ #[test]
+ fn a_revision_is_named_by_its_features() {
+ assert_eq!(Revision::default().id(), Id::of(b"[]"));
+ assert_eq!(Revision::of(&Id::of(b"[]")), Some(Revision(0)));
+ assert_eq!(Revision::of(&Id::of(b"[\"elsewhere\"]")), None);
+ assert_eq!(Revision::default().to_string(), "the base revision");
+ let names: Vec<&str> = FEATURES.iter().map(|feature| feature.name()).collect();
+ let distinct: std::collections::BTreeSet<&str> = names.iter().copied().collect();
+ assert_eq!(distinct.len(), names.len(), "a feature named twice");
+ for revision in Revision::known() {
+ assert_eq!(Revision::of(&revision.id()), Some(revision));
+ }
+ }
+}