Skip to content

Persist default author in docs database #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anchpop wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Persist default author in docs database #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions src/actor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,23 @@ enum Action {
#[debug("reply")]
reply: oneshot::Sender<Result<()>>,
},
#[display("DefaultAuthor")]
DefaultAuthor {
#[debug("reply")]
reply: oneshot::Sender<Result<Option<AuthorId>>>,
},
#[display("InitializeDefaultAuthor")]
InitializeDefaultAuthor {
author: Author,
#[debug("reply")]
reply: oneshot::Sender<Result<AuthorId>>,
},
#[display("SetDefaultAuthor")]
SetDefaultAuthor {
author: AuthorId,
#[debug("reply")]
reply: oneshot::Sender<Result<()>>,
},
#[display("NewReplica")]
ImportNamespace {
capability: Capability,
Expand Down Expand Up @@ -555,6 +572,26 @@ impl SyncHandle {
rx.await?
}

pub(crate) async fn default_author(&self) -> Result<Option<AuthorId>> {
let (reply, rx) = oneshot::channel();
self.send(Action::DefaultAuthor { reply }).await?;
rx.await?
}

pub(crate) async fn initialize_default_author(&self, author: Author) -> Result<AuthorId> {
let (reply, rx) = oneshot::channel();
self.send(Action::InitializeDefaultAuthor { author, reply })
.await?;
rx.await?
}

pub(crate) async fn set_default_author(&self, author: AuthorId) -> Result<()> {
let (reply, rx) = oneshot::channel();
self.send(Action::SetDefaultAuthor { author, reply })
.await?;
rx.await?
}

pub async fn import_namespace(&self, capability: Capability) -> Result<NamespaceId> {
let (reply, rx) = oneshot::channel();
self.send(Action::ImportNamespace { capability, reply })
Expand Down Expand Up @@ -734,6 +771,13 @@ impl Actor {
Action::DeleteAuthor { author, reply } => {
send_reply(reply, self.store.delete_author(author))
}
Action::DefaultAuthor { reply } => send_reply(reply, self.store.default_author()),
Action::InitializeDefaultAuthor { author, reply } => {
send_reply(reply, self.store.initialize_default_author(author))
}
Action::SetDefaultAuthor { author, reply } => {
send_reply(reply, self.store.set_default_author(author))
}
Action::ImportNamespace { capability, reply } => send_reply_with(reply, self, |this| {
let id = capability.id();
let outcome = this.store.import_namespace(capability.clone())?;
Expand Down
7 changes: 3 additions & 4 deletions src/api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,7 @@ impl DocsApi {

/// Returns the default document author of this node.
///
/// On persistent nodes, the author is created on first start and its public key is saved
/// in the data directory.
/// On persistent nodes, the author is created on first start and saved in the docs database.
///
/// The default author can be set with [`Self::author_set_default`].
pub async fn author_default(&self) -> Result<AuthorId> {
Expand All @@ -145,8 +144,8 @@ impl DocsApi {
///
/// If the author does not exist, an error is returned.
///
/// On a persistent node, the author id will be saved to a file in the data directory and
/// reloaded after a restart.
/// On a persistent node, the author id is saved in the docs database and reloaded after a
/// restart.
pub async fn author_set_default(&self, author_id: AuthorId) -> Result<()> {
self.inner
.rpc(AuthorSetDefaultRequest { author_id })
Expand Down
116 changes: 11 additions & 105 deletions src/engine.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

use std::sync::{Arc, RwLock};

use anyhow::{bail, Result};
use anyhow::Result;
use iroh::{Endpoint, EndpointAddr, PublicKey};
use iroh_blobs::{
api::{blobs::BlobStatus, downloader::Downloader, Store},
Expand Down Expand Up @@ -66,7 +66,6 @@ impl Engine {
replica_store: crate::store::Store,
bao_store: iroh_blobs::api::Store,
downloader: Downloader,
default_author_storage: DefaultAuthorStorage,
protect_cb: Option<ProtectCallbackHandler>,
) -> anyhow::Result<Self> {
let (live_actor_tx, to_live_actor_recv) = mpsc::channel(ACTOR_CHANNEL_CAP);
Expand Down Expand Up @@ -132,7 +131,7 @@ impl Engine {
.instrument(error_span!("sync", %me)),
);

let default_author = match DefaultAuthor::load(default_author_storage, &sync).await {
let default_author = match DefaultAuthor::load(&sync).await {
Ok(author) => author,
Err(err) => {
// If loading the default author failed, make sure to shutdown the sync actor before
Expand Down Expand Up @@ -338,116 +337,26 @@ impl LiveEvent {
}
}

/// Where to persist the default author.
///
/// If set to `Mem`, a new author will be created in the docs store before spawning the sync
/// engine. Changing the default author will not be persisted.
///
/// If set to `Persistent`, the default author will be loaded from and persisted to the specified
/// path (as hex encoded string of the author's public key).
#[derive(Debug)]
pub enum DefaultAuthorStorage {
/// Memory storage.
Mem,
/// File based persistent storage.
#[cfg(feature = "fs-store")]
Persistent(std::path::PathBuf),
}

impl DefaultAuthorStorage {
/// Load the default author from the storage.
///
/// Will create and save a new author if the storage is empty.
///
/// Returns an error if the author can't be parsed or if the uathor does not exist in the docs
/// store.
pub async fn load(&self, docs_store: &SyncHandle) -> anyhow::Result<AuthorId> {
match self {
Self::Mem => {
let author = Author::new(&mut rand::rng());
let author_id = author.id();
docs_store.import_author(author).await?;
Ok(author_id)
}
#[cfg(feature = "fs-store")]
Self::Persistent(ref path) => {
use std::str::FromStr;

use anyhow::Context;
if path.exists() {
let data = tokio::fs::read_to_string(path).await.with_context(|| {
format!(
"Failed to read the default author file at `{}`",
path.to_string_lossy()
)
})?;
let author_id = AuthorId::from_str(&data).with_context(|| {
format!(
"Failed to parse the default author from `{}`",
path.to_string_lossy()
)
})?;
if docs_store.export_author(author_id).await?.is_none() {
bail!(
"The default author is missing from the docs store. To recover, delete the file `{}`. Then iroh will create a new default author.",
path.to_string_lossy()
)
}
Ok(author_id)
} else {
let author = Author::new(&mut rand::rng());
let author_id = author.id();
docs_store.import_author(author).await?;
// Make sure to write the default author to the store
// *before* we write the default author ID file.
// Otherwise the default author ID file is effectively a dangling reference.
docs_store.flush_store().await?;
self.persist(author_id).await?;
Ok(author_id)
}
}
}
}

/// Save a new default author.
pub async fn persist(&self, #[allow(unused)] author_id: AuthorId) -> anyhow::Result<()> {
match self {
Self::Mem => {
// persistence is not possible for the mem storage so this is a noop.
}
#[cfg(feature = "fs-store")]
Self::Persistent(ref path) => {
use anyhow::Context;
tokio::fs::write(path, author_id.to_string())
.await
.with_context(|| {
format!(
"Failed to write the default author to `{}`",
path.to_string_lossy()
)
})?;
}
}
Ok(())
}
}

/// Persistent default author for a docs engine.
#[derive(Debug)]
pub struct DefaultAuthor {
value: RwLock<AuthorId>,
storage: DefaultAuthorStorage,
}

impl DefaultAuthor {
/// Load the default author from storage.
///
/// If the storage is empty creates a new author and persists it.
pub async fn load(storage: DefaultAuthorStorage, docs_store: &SyncHandle) -> Result<Self> {
let value = storage.load(docs_store).await?;
pub async fn load(docs_store: &SyncHandle) -> Result<Self> {
let value = match docs_store.default_author().await? {
Some(author) => author,
None => {
let author = Author::new(&mut rand::rng());
docs_store.initialize_default_author(author).await?
}
};
Ok(Self {
value: RwLock::new(value),
storage,
})
}

Expand All @@ -458,10 +367,7 @@ impl DefaultAuthor {

/// Set the default author.
pub async fn set(&self, author_id: AuthorId, docs_store: &SyncHandle) -> Result<()> {
if docs_store.export_author(author_id).await?.is_none() {
bail!("The author does not exist");
}
self.storage.persist(author_id).await?;
docs_store.set_default_author(author_id).await?;
*self.value.write().unwrap() = author_id;
Ok(())
}
Expand Down
12 changes: 2 additions & 10 deletions src/protocol.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use iroh_gossip::net::Gossip;

use crate::{
api::DocsApi,
engine::{DefaultAuthorStorage, Engine, ProtectCallbackHandler},
engine::{Engine, ProtectCallbackHandler},
store::Store,
};

Expand Down Expand Up @@ -104,26 +104,18 @@ impl Builder {
blobs: BlobsStore,
gossip: Gossip,
) -> anyhow::Result<Docs> {
let replica_store = match &self.storage {
let replica_store = match self.storage {
Storage::Memory => Store::memory(),
#[cfg(feature = "fs-store")]
Storage::Persistent(path) => Store::persistent(path.join("docs.redb"))?,
};
let author_store = match &self.storage {
Storage::Memory => DefaultAuthorStorage::Mem,
#[cfg(feature = "fs-store")]
Storage::Persistent(path) => {
DefaultAuthorStorage::Persistent(path.join("default-author"))
}
};
let downloader = blobs.downloader(&endpoint);
let engine = Engine::spawn(
endpoint,
gossip,
replica_store,
blobs,
downloader,
author_store,
self.protect_cb,
)
.await?;
Expand Down
Loading