//! The member registry: every node that has joined the swarm, under //! `_continuum/members/`, replicated with the document (and carried into new //! epochs with the rest of `_continuum`). //! //! A pure registry: it decides nothing about admission (that's the swarm key). Each //! node registers itself once it is ready, and re-registers if its entry disappears //! while it is alive. An operator's forget (`DELETE /peers/{pk}`) removes the entry //! together with writing the forget record; a forgotten node that turns out to be alive //! cancels the record and registers again. use automerge::AutoCommit; use serde_json::{Value as JsonValue, json}; use tracing::{info, warn}; use crate::document::store::{self, StoreError}; use crate::state::{AppState, unix_millis}; const META_ROOT: &str = "_continuum"; fn members_dir() -> Vec { vec![META_ROOT.to_owned(), "members".to_owned()] } pub(crate) fn member_path(pk: &str) -> Vec { let mut path = members_dir(); path.push(pk.to_owned()); path } /// Public keys of all registered members, sorted. pub(crate) fn members(doc: &AutoCommit) -> Vec { let mut members = store::keys_at(doc, &members_dir()).unwrap_or_default(); members.sort(); members } /// A member's stability tier, judged by itself (`swarm::stability`). #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)] pub(crate) enum Tier { Stable, #[default] Transient, } impl Tier { pub(crate) fn as_str(self) -> &'static str { match self { Self::Stable => "stable", Self::Transient => "transient", } } } fn tier_path(pk: &str) -> Vec { let mut path = member_path(pk); path.push("tier".to_owned()); path } /// `pk`'s tier; transient unless its entry says stable. pub(crate) fn tier(doc: &AutoCommit, pk: &str) -> Tier { match store::read_path(doc, &tier_path(pk)) { Ok(Some(JsonValue::String(tier))) if tier == "stable" => Tier::Stable, _ => Tier::Transient, } } pub(crate) fn set_tier(doc: &mut AutoCommit, pk: &str, tier: Tier) -> Result<(), StoreError> { store::write_path(doc, &tier_path(pk), &json!(tier.as_str())) } /// Registers this node if it is ready and its entry is missing. pub(crate) async fn ensure_registered(state: &AppState) { if !state.is_ready().await { return; } let own = member_path(state.local_id()); let registered = store::read_path(&state.doc.read().await.doc, &own) .ok() .flatten() .is_some(); if registered { return; } let entry = json!({ "since": unix_millis() }); match state .mutate_doc(move |doc| store::write_path(doc, &own, &entry)) .await { Ok(()) => info!("Registered in the swarm's member list"), Err(error) => warn!(error = %error, "Failed to register in the member list"), } } /// Removes `pk`'s entry (an operator forgot it). Absent is fine. pub(crate) fn unregister(doc: &mut AutoCommit, pk: &str) -> Result<(), StoreError> { match store::delete_path(doc, &member_path(pk), false) { Err(StoreError::NotFound) => Ok(()), result => result, } }