Linking a device is one flow in the core: sync::link

The desktop's sync_link and the ffi's link_with_password/link_with_token were
the same steps written out twice: probe, refuse an incompatible server before
any credential is sent, log in or verify a pasted token, keep the link, and adopt
the server's trash retention. link::authenticate(url, Credential) does the
network half and link::store(conn, ..., seal) keeps it, sealed when the client
has a seal. Each client now only reads its input and picks its seal.

The desktop checks for a missing email/password before probing rather than after.
Same error, sooner.

DRY pass #2, batch 1, F2 (#5372).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
2026-10-08 14:16:53 -04:00
co-authored by Claude Opus 5.5
parent 70274347af
commit 91c47245ab
4 changed files with 139 additions and 68 deletions
+23 -33
View File
@@ -41,7 +41,7 @@ use std::sync::Arc;
use inkwell_core::local::{self, Db}; use inkwell_core::local::{self, Db};
use inkwell_core::sync::blobs::BlobStore; use inkwell_core::sync::blobs::BlobStore;
use inkwell_core::sync::{client, compat, engine, push, sharing, state}; use inkwell_core::sync::{client, compat, engine, link, push, sharing, state};
use models::{ use models::{
patch_from, BodyItem, BodyTag, ClientUpdate, Directory, Identity, Label, Note, NoteDraft, patch_from, BodyItem, BodyTag, ClientUpdate, Directory, Identity, Label, Note, NoteDraft,
@@ -502,18 +502,12 @@ impl Inkwell {
password: String, password: String,
device_name: String, device_name: String,
) -> Result<Identity, CoreError> { ) -> Result<Identity, CoreError> {
let probe = client::probe(&url).await.map_err(CoreError::network)?; let credential = link::Credential::Password {
if let compat::Compatibility::Incompatible { reason, .. } = &probe.compatibility { email: &email,
return Err(CoreError::Network { password: &password,
message: reason.clone(), device_name: &device_name,
}); };
} self.link(&url, credential).await
let (token, identity) =
client::device_login(&probe.base_url, &email, &password, &device_name)
.await
.map_err(CoreError::network)?;
self.store_link(&probe.base_url, &token, probe.server.trash_retention_days)?;
Ok(identity.into())
} }
/// Pair using a device token pasted from the web app — for anyone who would /// Pair using a device token pasted from the web app — for anyone who would
@@ -522,17 +516,7 @@ impl Inkwell {
/// The token is verified before it is stored, so a copy/paste slip fails here /// The token is verified before it is stored, so a copy/paste slip fails here
/// rather than at the next sync. /// rather than at the next sync.
pub async fn link_with_token(&self, url: String, token: String) -> Result<Identity, CoreError> { pub async fn link_with_token(&self, url: String, token: String) -> Result<Identity, CoreError> {
let probe = client::probe(&url).await.map_err(CoreError::network)?; self.link(&url, link::Credential::Token(&token)).await
if let compat::Compatibility::Incompatible { reason, .. } = &probe.compatibility {
return Err(CoreError::Network {
message: reason.clone(),
});
}
let identity = client::fetch_identity(&probe.base_url, &token)
.await
.map_err(CoreError::network)?;
self.store_link(&probe.base_url, &token, probe.server.trash_retention_days)?;
Ok(identity.into())
} }
/// Stop syncing, and retire this device's token on the server. /// Stop syncing, and retire this device's token on the server.
@@ -757,9 +741,19 @@ impl Inkwell {
link.ok_or(CoreError::NotLinked) link.ok_or(CoreError::NotLinked)
} }
/// Persist a fresh link, adopting the server's retention window at the same time /// Both ways of linking, once the credential is chosen: ask the server, then
/// so the Trash view stops counting down against this device's offline default /// keep the link sealed.
/// the moment it is no longer the policy in force. async fn link(
&self,
url: &str,
credential: link::Credential<'_>,
) -> Result<Identity, CoreError> {
let granted = link::authenticate(url, credential).await.map_err(CoreError::network)?;
self.store_link(&granted.base_url, &granted.token, granted.retention_days)?;
Ok(granted.identity.into())
}
/// Keep a fresh link, sealed (`link::store`).
fn store_link( fn store_link(
&self, &self,
base_url: &str, base_url: &str,
@@ -767,12 +761,8 @@ impl Inkwell {
retention_days: Option<u32>, retention_days: Option<u32>,
) -> Result<(), CoreError> { ) -> Result<(), CoreError> {
let conn = self.db.conn().map_err(CoreError::store)?; let conn = self.db.conn().map_err(CoreError::store)?;
state::set_sealed_link(&conn, base_url, token, &self.seal).map_err(CoreError::store)?; link::store(&conn, base_url, token, retention_days, Some(&self.seal))
if let Some(days) = retention_days { .map_err(CoreError::store)
state::set_server_retention(&conn, days as i64).map_err(CoreError::store)?;
}
log::info!("linked to {base_url}");
Ok(())
} }
} }
+90
View File
@@ -0,0 +1,90 @@
//! Linking a device to a server.
//!
//! One flow for every client. The desktop and Android each wrote it out, the same
//! steps in the same order; what differs between them is only how the token is
//! kept (Android seals it, `state::TokenSeal`) and how the result is reported.
use rusqlite::Connection;
use super::client::{self, Identity};
use super::compat::Compatibility;
use super::state::{self, TokenSeal};
/// How a device proves whose it is.
pub enum Credential<'a> {
/// A password login, which mints a token named `device_name` on the server.
Password {
email: &'a str,
password: &'a str,
device_name: &'a str,
},
/// A device token pasted from the web app, for anyone who would rather not
/// type a password into an app. Verified before it is kept, so a copy/paste
/// slip fails here rather than at the next sync.
Token(&'a str),
}
/// A server that accepted this device, before anything is kept.
pub struct Granted {
pub base_url: String,
pub token: String,
pub identity: Identity,
/// Carried through so a client can warn about a `degraded` server right after
/// linking, instead of staying silent until a feature quietly does nothing.
pub compatibility: Compatibility,
pub retention_days: Option<u32>,
}
/// Ask the server at `url` to accept this device. Nothing is stored.
///
/// The handshake runs FIRST, and an incompatible server is refused before any
/// credential is sent: that is exactly the case where a later failure would be
/// hardest to attribute.
pub async fn authenticate(url: &str, credential: Credential<'_>) -> Result<Granted, String> {
let probe = client::probe(url).await?;
if let Compatibility::Incompatible { reason, .. } = &probe.compatibility {
return Err(reason.clone());
}
let base_url = probe.base_url;
let (token, identity) = match credential {
Credential::Password {
email,
password,
device_name,
} => client::device_login(&base_url, email, password, device_name).await?,
Credential::Token(token) => {
let identity = client::fetch_identity(&base_url, token).await?;
(token.to_string(), identity)
}
};
Ok(Granted {
base_url,
token,
identity,
compatibility: probe.compatibility,
retention_days: probe.server.trash_retention_days,
})
}
/// Keep a link: sealed when the client has a seal, plain when it has none.
///
/// The server's trash-retention window is adopted at the same time, so the Trash
/// view stops counting down against this device's offline default the moment it
/// is no longer the policy in force.
pub fn store(
conn: &Connection,
base_url: &str,
token: &str,
retention_days: Option<u32>,
seal: Option<&dyn TokenSeal>,
) -> rusqlite::Result<()> {
match seal {
Some(seal) => state::set_sealed_link(conn, base_url, token, seal)?,
None => state::set_link(conn, base_url, token)?,
}
if let Some(days) = retention_days {
state::set_server_retention(conn, i64::from(days))?;
}
log::info!("linked to {base_url}");
Ok(())
}
+1
View File
@@ -17,6 +17,7 @@ pub mod blobs;
pub mod client; pub mod client;
pub mod compat; pub mod compat;
pub mod engine; pub mod engine;
pub mod link;
pub mod pull; pub mod pull;
pub mod push; pub mod push;
pub mod sharing; pub mod sharing;
+25 -35
View File
@@ -11,6 +11,7 @@ use inkwell_core::sync::client::{self, Identity, ProbeResult};
use inkwell_core::sync::client::{Directory, NoteShare, ShareTarget}; use inkwell_core::sync::client::{Directory, NoteShare, ShareTarget};
use inkwell_core::sync::compat::Compatibility; use inkwell_core::sync::compat::Compatibility;
use inkwell_core::sync::engine; use inkwell_core::sync::engine;
use inkwell_core::sync::link;
use inkwell_core::sync::push; use inkwell_core::sync::push;
use inkwell_core::sync::sharing; use inkwell_core::sync::sharing;
use inkwell_core::sync::state; use inkwell_core::sync::state;
@@ -63,55 +64,44 @@ fn trimmed(value: &Option<String>) -> Option<&str> {
#[tauri::command] #[tauri::command]
pub async fn sync_link(input: LinkInput, db: State<'_, Db>) -> Result<LinkResult, String> { pub async fn sync_link(input: LinkInput, db: State<'_, Db>) -> Result<LinkResult, String> {
// 1. Handshake FIRST. Never hand credentials to a server we've established we let name = trimmed(&input.name)
// can't sync with — and an incompatible server is exactly the case where a .map(str::to_string)
// later failure would be hardest to attribute. .unwrap_or_else(default_device_name);
let probe = client::probe(&input.url).await?; let credential = match trimmed(&input.token) {
if let Compatibility::Incompatible { reason, .. } = &probe.compatibility { Some(token) => link::Credential::Token(token),
return Err(reason.clone());
}
let base_url = probe.base_url;
// 2. Obtain a credential.
let (token, identity) = match trimmed(&input.token) {
Some(token) => {
// Verify before storing: an unverified paste turns a copy/paste slip
// into a failure that only surfaces at the next sync.
let identity = client::fetch_identity(&base_url, token).await?;
(token.to_string(), identity)
}
None => { None => {
let (Some(email), Some(password)) = (trimmed(&input.email), trimmed(&input.password)) let (Some(email), Some(password)) = (trimmed(&input.email), trimmed(&input.password))
else { else {
return Err("Enter your email and password, or paste a device token.".to_string()); return Err("Enter your email and password, or paste a device token.".to_string());
}; };
let name = trimmed(&input.name) link::Credential::Password {
.map(str::to_string) email,
.unwrap_or_else(default_device_name); password,
client::device_login(&base_url, email, password, &name).await? device_name: &name,
}
} }
}; };
let granted = link::authenticate(&input.url, credential).await?;
// 3. Persist. The lock is taken only now, for two reasons: a std MutexGuard // The lock is taken only now: a std MutexGuard isn't Send so it cannot be held
// isn't Send so it cannot be held across an await, and holding the store // across an await, and holding the store locked for a network round-trip would
// locked for a network round-trip would freeze every note operation in the UI. // freeze every note operation in the UI.
let status = { let status = {
let conn = db.conn()?; let conn = db.conn()?;
state::set_link(&conn, &base_url, &token).map_err(|e| e.to_string())?; link::store(
// Adopt the server's trash-retention window immediately, so the Trash view &conn,
// stops counting down against this device's offline default the moment it's &granted.base_url,
// no longer the policy in force. &granted.token,
if let Some(days) = probe.server.trash_retention_days { granted.retention_days,
state::set_server_retention(&conn, days as i64).map_err(|e| e.to_string())?; None,
} )
.map_err(|e| e.to_string())?;
state::status(&conn).map_err(|e| e.to_string())? state::status(&conn).map_err(|e| e.to_string())?
}; };
log::info!("linked to {} as {}", base_url, identity.email);
Ok(LinkResult { Ok(LinkResult {
status, status,
identity, identity: granted.identity,
compatibility: probe.compatibility, compatibility: granted.compatibility,
}) })
} }