second-brain-api 0.13.0

HTTP API server for second-brain: REST endpoints for recall, remember, and ingest
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
//! Replays the writes the MCP server queued under `queue/` while this
//! daemon was unreachable. Each entry is the request the MCP server would
//! have sent; it goes through this daemon's own router, so auth, redaction
//! and every handler apply exactly as for a live call.

use std::collections::BTreeMap;
use std::fs::File;
use std::io::Write;
use std::os::unix::fs::{DirBuilderExt, OpenOptionsExt};
use std::path::{Path, PathBuf};
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::time::{Duration, SystemTime};

use age::x25519::{Identity, Recipient};
use axum::Router;
use axum::body::Body;
use axum::http::{Method, Request, StatusCode, header};
use chrono::{DateTime, Utc};
use fs4::fs_std::FileExt;
use second_brain_core::keys::{self, KeyStorage};
use second_brain_core::write_queue::{OpenError, entry_name, is_sealed_name, open};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use tower::ServiceExt;

use crate::health::Health;
use crate::write_gate::{REPLAY_HEADER, WriteGate};

pub use second_brain_core::write_queue::{DIR_NAME, Entry, is_entry_name};
pub const INTERVAL: Duration = Duration::from_secs(30);
const LOCK_FILE: &str = ".lock";
/// A writer that crashed between write and rename left it; a live writer
/// renames within milliseconds.
const STALE_TMP: Duration = Duration::from_secs(60 * 60);
const MAX_RESPONSE_BYTES: usize = 1024 * 1024;
const ALIASES_FILE: &str = "aliases.json";
const ALIAS_KEEP: chrono::Duration = chrono::Duration::hours(1);
/// The MCP server refuses to queue past the same count.
const MAX_ENTRIES: usize = 10_000;

fn entry_time(name: &str) -> Option<DateTime<Utc>> {
    let nanos: i64 = name.get(..19)?.parse().ok()?;
    Some(DateTime::from_timestamp_nanos(nanos))
}

/// Entry file names, oldest first.
pub fn entry_names(dir: &Path) -> std::io::Result<Vec<String>> {
    let mut names = Vec::new();
    for item in std::fs::read_dir(dir)? {
        let name = item?.file_name().to_string_lossy().into_owned();
        if is_entry_name(&name) {
            names.push(name);
        }
    }
    names.sort();
    Ok(names)
}

/// This device's age identity, which seals and opens queued writes, after
/// publishing its recipient for the MCP server; None, logged, when the device
/// keys can't be read, and writes then queue in plaintext.
pub fn publish_device_identity(data_dir: &Path, storage: &KeyStorage) -> Option<Identity> {
    let keys = match keys::load_device_keys_in(data_dir, storage) {
        Ok(Some(keys)) => keys,
        Ok(None) => {
            tracing::warn!("no device key: queued writes are not sealed");
            return None;
        }
        Err(e) => {
            tracing::error!("device keys unreadable: queued writes are not sealed: {e:#}");
            return None;
        }
    };
    if let Err(e) = keys::publish_device_pub(data_dir, &keys) {
        tracing::warn!("the MCP server cannot seal the writes it queues: {e:#}");
    }
    Some(keys.age_identity().clone())
}

/// Saves a write for the replayer under the name the MCP server would give
/// it, so both writers' entries replay in the order they were made; sealed
/// when there is a recipient.
pub fn push(dir: &Path, entry: &Entry, recipient: Option<&Recipient>) -> anyhow::Result<()> {
    std::fs::DirBuilder::new()
        .recursive(true)
        .mode(0o700)
        .create(dir)?;
    match entry_names(dir) {
        Ok(names) if names.len() >= MAX_ENTRIES => {
            anyhow::bail!("the write queue is full ({MAX_ENTRIES} entries)")
        }
        Ok(_) => {}
        Err(e) => return Err(e.into()),
    }
    let nanos = SystemTime::now()
        .duration_since(SystemTime::UNIX_EPOCH)?
        .as_nanos();
    let bytes = match recipient {
        Some(recipient) => entry.to_sealed_file(std::slice::from_ref(recipient))?,
        None => entry.to_plain_file()?,
    };
    let name = entry_name(nanos, recipient.is_some());
    let tmp = dir.join(format!("{name}.tmp"));
    let mut file = std::fs::OpenOptions::new()
        .write(true)
        .create_new(true)
        .mode(0o600)
        .open(&tmp)?;
    file.write_all(&bytes)?;
    file.sync_all()?;
    std::fs::rename(&tmp, dir.join(name))?;
    Ok(())
}

#[derive(Debug, Default, PartialEq)]
pub struct Pass {
    pub sent: usize,
    pub rejected: usize,
    /// Sealed entries left in place because this daemon has no device key.
    pub waiting: usize,
    /// The status or error that stopped the pass with entries left.
    pub stopped: Option<String>,
}

pub struct WriteQueue {
    dir: PathBuf,
    app: Router,
    token: String,
    health: Arc<Health>,
    gate: Arc<WriteGate>,
    identity: Option<Identity>,
    warned_no_key: AtomicBool,
}

enum Verdict {
    Done,
    Rejected(StatusCode, String),
    Retry(String),
}

impl WriteQueue {
    pub fn new(
        dir: PathBuf,
        app: Router,
        token: String,
        health: Arc<Health>,
        gate: Arc<WriteGate>,
    ) -> Self {
        Self {
            dir,
            app,
            token,
            health,
            gate,
            identity: None,
            warned_no_key: AtomicBool::new(false),
        }
    }

    /// Opens entries sealed to this device; without it sealed entries stay
    /// in place and the rest replay past them.
    pub fn opening_with(mut self, identity: Identity) -> Self {
        self.identity = Some(identity);
        self
    }

    pub fn spawn(self) {
        tokio::spawn(async move {
            let mut interval = tokio::time::interval(INTERVAL);
            interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
            loop {
                tokio::select! {
                    _ = interval.tick() => {}
                    _ = self.gate.reopened() => {}
                }
                self.tick().await;
            }
        });
    }

    /// Replays what it can, unless store maintenance holds the writer or
    /// another replayer on this `HOME` holds the lock, then reports the
    /// queue as it stands to health.
    pub async fn tick(&self) -> Option<Pass> {
        if self.gate.is_closed() {
            self.report();
            return None;
        }
        let pass = match self.try_lock() {
            Ok(Some(_lock)) => {
                self.remove_stale_tmp();
                Some(self.replay().await)
            }
            Ok(None) => None,
            Err(e) => {
                tracing::warn!("cannot lock the write queue at {}: {e}", self.dir.display());
                None
            }
        };
        self.gate.open_when_drained(|| self.nothing_to_replay());
        self.report();
        pass
    }

    /// Sealed entries waiting for a device key don't count, so they never
    /// hold the gate.
    fn nothing_to_replay(&self) -> bool {
        match entry_names(&self.dir) {
            Ok(names) => names.iter().all(|name| self.waits_for_key(name)),
            Err(e) => e.kind() == std::io::ErrorKind::NotFound,
        }
    }

    fn waits_for_key(&self, name: &str) -> bool {
        self.identity.is_none() && is_sealed_name(name)
    }

    fn try_lock(&self) -> std::io::Result<Option<File>> {
        if !self.dir.is_dir() {
            return Ok(None);
        }
        let file = std::fs::OpenOptions::new()
            .create(true)
            .truncate(false)
            .write(true)
            .open(self.dir.join(LOCK_FILE))?;
        Ok(file.try_lock_exclusive()?.then_some(file))
    }

    fn report(&self) {
        let names = match entry_names(&self.dir) {
            Ok(names) => names,
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),
            Err(e) => {
                tracing::warn!("cannot list the write queue at {}: {e}", self.dir.display());
                return;
            }
        };
        let oldest = names.first().and_then(|n| entry_time(n));
        self.health
            .queue_checked(names.len() as u64, oldest, Utc::now());
    }

    fn remove_stale_tmp(&self) {
        let Ok(items) = std::fs::read_dir(&self.dir) else {
            return;
        };
        let now = SystemTime::now();
        for item in items.flatten() {
            let path = item.path();
            let stale = path.extension().is_some_and(|e| e == "tmp")
                && item
                    .metadata()
                    .and_then(|m| m.modified())
                    .is_ok_and(|t| now.duration_since(t).unwrap_or_default() >= STALE_TMP);
            if stale && let Err(e) = std::fs::remove_file(&path) {
                tracing::warn!("cannot remove {}: {e}", path.display());
            }
        }
    }

    async fn replay(&self) -> Pass {
        let mut pass = Pass::default();
        let names = match entry_names(&self.dir) {
            Ok(names) => names,
            Err(e) => {
                pass.stopped = Some(format!("listing the queue: {e}"));
                return pass;
            }
        };
        let mut aliases = Aliases::load(&self.dir);
        for name in &names {
            let path = self.dir.join(name);
            let entry = match read_entry(&path, self.identity.as_ref()) {
                Ok(Some(entry)) => aliases.apply(entry),
                Ok(None) => continue,
                Err(OpenError::NoKey) => {
                    pass.waiting += 1;
                    continue;
                }
                Err(OpenError::Unreadable(e)) => {
                    set_aside(&path, &e);
                    continue;
                }
            };
            let (verdict, reply) = self.send(&entry).await;
            match verdict {
                Verdict::Done => {
                    if let Some((client, stored)) = remember_alias(&entry, reply.as_ref()) {
                        aliases.add(client, stored, Utc::now());
                        if let Err(e) = aliases.save(&self.dir) {
                            pass.stopped = Some(format!("saving the id aliases: {e:#}"));
                            return pass;
                        }
                    }
                    remove_entry(&path);
                    pass.sent += 1;
                }
                Verdict::Rejected(status, message) => {
                    tracing::warn!(
                        "queued {} rejected by the daemon (HTTP {}): {message}; dropped {name}",
                        entry.tool,
                        status.as_u16()
                    );
                    self.health
                        .write_rejected(&entry.tool, status.as_u16(), Utc::now());
                    remove_entry(&path);
                    pass.rejected += 1;
                }
                Verdict::Retry(why) => {
                    tracing::info!("write queue replay paused at {name}: {why}");
                    pass.stopped = Some(why);
                    return pass;
                }
            }
        }
        if entry_names(&self.dir).is_ok_and(|left| left.is_empty())
            && aliases.prune(Utc::now())
            && let Err(e) = aliases.save(&self.dir)
        {
            tracing::warn!("cannot prune the write queue id aliases: {e:#}");
        }
        if pass.waiting > 0 && !self.warned_no_key.swap(true, Ordering::Relaxed) {
            tracing::warn!(
                "{} sealed queued writes wait in {} for the device key, which this daemon \
                 could not read at start; later writes replay without them",
                pass.waiting,
                self.dir.display()
            );
        }
        pass
    }

    async fn send(&self, entry: &Entry) -> (Verdict, Option<Value>) {
        let request = match build_request(entry, &self.token) {
            Ok(r) => r,
            Err(e) => {
                return (
                    Verdict::Rejected(StatusCode::BAD_REQUEST, format!("unusable entry: {e}")),
                    None,
                );
            }
        };
        let response = match self.app.clone().oneshot(request).await {
            Ok(r) => r,
            Err(e) => return (Verdict::Retry(format!("dispatch failed: {e}")), None),
        };
        let status = response.status();
        let bytes = match axum::body::to_bytes(response.into_body(), MAX_RESPONSE_BYTES).await {
            Ok(b) => b,
            Err(e) => return (Verdict::Retry(format!("reading the reply: {e}")), None),
        };
        let reply: Option<Value> = serde_json::from_slice(&bytes).ok();
        let verdict = if status.is_success()
            || (status == StatusCode::NOT_FOUND && is_idempotent_removal(entry))
        {
            Verdict::Done
        } else if matches!(status.as_u16(), 401 | 403 | 408 | 429) || status.is_server_error() {
            Verdict::Retry(format!("HTTP {status}"))
        } else {
            let message = reply
                .as_ref()
                .and_then(|v| v["error"].as_str().map(str::to_string))
                .unwrap_or_else(|| String::from_utf8_lossy(&bytes).into_owned());
            Verdict::Rejected(status, message)
        };
        (verdict, reply)
    }
}

fn build_request(entry: &Entry, token: &str) -> anyhow::Result<Request<Body>> {
    let method = Method::from_bytes(entry.method.as_bytes())?;
    let uri = match entry.query.as_deref().filter(|q| !q.is_empty()) {
        Some(q) => format!("{}?{q}", entry.path),
        None => entry.path.clone(),
    };
    let builder = Request::builder()
        .method(method)
        .uri(uri)
        .header(header::AUTHORIZATION, format!("Bearer {token}"))
        .header(REPLAY_HEADER, "1");
    Ok(match &entry.body {
        Some(body) => builder
            .header(header::CONTENT_TYPE, "application/json")
            .body(Body::from(body.to_string()))?,
        None => builder.body(Body::empty())?,
    })
}

fn is_idempotent_removal(entry: &Entry) -> bool {
    is_hard_forget(entry) || is_delete(entry)
}

fn is_delete(entry: &Entry) -> bool {
    entry.method.eq_ignore_ascii_case("POST") && entry.path == "/v1/delete"
}

fn is_hard_forget(entry: &Entry) -> bool {
    entry.method.eq_ignore_ascii_case("DELETE")
        && entry
            .query
            .as_deref()
            .is_some_and(|q| q.split('&').any(|pair| pair == "hard=true"))
}

/// `(client id, stored id)` when a replayed remember landed as another row
/// because its content was already stored.
fn remember_alias(entry: &Entry, reply: Option<&Value>) -> Option<(String, String)> {
    if entry.tool != "remember" {
        return None;
    }
    let sent = entry.body.as_ref()?["id"].as_str()?;
    let stored = reply?["id"].as_str()?;
    (sent != stored).then(|| (sent.to_string(), stored.to_string()))
}

/// Client ids of replayed remembers that landed as an existing row, mapped
/// to that row. Applied to each entry as it is sent rather than rewritten
/// into the files, so an entry queued while the remember was in flight
/// (after this pass listed the queue) still reaches the stored row.
#[derive(Default, Serialize, Deserialize)]
struct Aliases(BTreeMap<String, Alias>);

#[derive(Serialize, Deserialize)]
struct Alias {
    to: String,
    at: DateTime<Utc>,
}

impl Aliases {
    fn load(dir: &Path) -> Self {
        match std::fs::read(dir.join(ALIASES_FILE)) {
            Ok(bytes) => serde_json::from_slice(&bytes).unwrap_or_else(|e| {
                tracing::warn!("ignoring unreadable write queue id aliases: {e}");
                Self::default()
            }),
            Err(_) => Self::default(),
        }
    }

    fn add(&mut self, client: String, stored: String, now: DateTime<Utc>) {
        self.0.insert(
            client,
            Alias {
                to: stored,
                at: now,
            },
        );
    }

    fn apply(&self, mut entry: Entry) -> Entry {
        for (client, alias) in &self.0 {
            entry.path = entry.path.replace(client.as_str(), &alias.to);
            entry.query = entry.query.map(|q| q.replace(client.as_str(), &alias.to));
            if let Some(body) = entry.body.as_mut() {
                replace_strings(body, client, &alias.to);
            }
        }
        entry
    }

    /// With the queue empty, a write naming a client id is sent live, where
    /// a 404 for a note that landed as an older row is accepted; an hour
    /// covers a session that saw the queue non-empty just before it emptied.
    fn prune(&mut self, now: DateTime<Utc>) -> bool {
        let before = self.0.len();
        self.0.retain(|_, alias| now - alias.at < ALIAS_KEEP);
        self.0.len() != before
    }

    fn save(&self, dir: &Path) -> anyhow::Result<()> {
        let path = dir.join(ALIASES_FILE);
        if self.0.is_empty() {
            return match std::fs::remove_file(&path) {
                Err(e) if e.kind() != std::io::ErrorKind::NotFound => Err(e.into()),
                _ => Ok(()),
            };
        }
        let tmp = dir.join(format!(
            "{ALIASES_FILE}.{}.tmp",
            uuid::Uuid::new_v4().simple()
        ));
        let mut file = std::fs::OpenOptions::new()
            .write(true)
            .create_new(true)
            .mode(0o600)
            .open(&tmp)?;
        file.write_all(&serde_json::to_vec(self)?)?;
        file.sync_all()?;
        std::fs::rename(&tmp, path)?;
        Ok(())
    }
}

/// `Ok(None)` when another replayer or the MCP server's ingest collapse
/// removed it after the listing.
fn read_entry(path: &Path, identity: Option<&Identity>) -> Result<Option<Entry>, OpenError> {
    match std::fs::read(path) {
        Ok(bytes) => open(&bytes, identity).map(Some),
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(None),
        Err(e) => Err(OpenError::Unreadable(e.into())),
    }
}

/// Renamed out of the entry namespace rather than deleted, so the write it
/// held can still be read by hand.
fn set_aside(path: &Path, error: &anyhow::Error) {
    let aside = path.with_extension("unreadable");
    tracing::warn!(
        "write queue entry {} is unreadable ({error:#}); moved to {}",
        path.display(),
        aside.display()
    );
    if let Err(e) = std::fs::rename(path, &aside) {
        tracing::warn!("cannot move {} aside: {e}", path.display());
    }
}

fn remove_entry(path: &Path) {
    if let Err(e) = std::fs::remove_file(path)
        && e.kind() != std::io::ErrorKind::NotFound
    {
        tracing::warn!("cannot remove replayed entry {}: {e}", path.display());
    }
}

fn replace_strings(value: &mut Value, from: &str, to: &str) {
    match value {
        Value::String(s) if s.contains(from) => *s = s.replace(from, to),
        Value::Array(items) => items.iter_mut().for_each(|v| replace_strings(v, from, to)),
        Value::Object(map) => map.values_mut().for_each(|v| replace_strings(v, from, to)),
        _ => {}
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn the_device_identity_is_published_for_the_mcp_server() {
        let dir = tempfile::tempdir().unwrap();
        assert!(publish_device_identity(dir.path(), &KeyStorage::File).is_none());
        assert!(!dir.path().join(keys::DEVICE_PUB_FILE).exists());
        let device = keys::create_device_keys(dir.path(), &KeyStorage::File).unwrap();
        let identity = publish_device_identity(dir.path(), &KeyStorage::File).unwrap();
        assert_eq!(identity.to_public(), device.age_recipient());
        let published = std::fs::read_to_string(dir.path().join(keys::DEVICE_PUB_FILE)).unwrap();
        assert_eq!(published.trim(), device.age_recipient().to_string());
    }

    #[test]
    fn an_entry_name_dates_the_call() {
        let at = entry_time("1793505622000000000-x.json").unwrap();
        assert_eq!(at.timestamp(), 1_793_505_622);
    }

    #[test]
    fn only_a_hard_forget_treats_404_as_done() {
        let forget = |query: &str| Entry {
            tool: "forget".to_string(),
            method: "DELETE".to_string(),
            path: "/v1/memory/x".to_string(),
            query: Some(query.to_string()),
            body: None,
        };
        assert!(is_hard_forget(&forget("hard=true&reason=wrong")));
        assert!(!is_hard_forget(&forget("hard=false")));
        assert!(is_idempotent_removal(&forget("hard=true")));
        assert!(!is_idempotent_removal(&forget("hard=false")));
    }

    #[test]
    fn a_replayed_delete_treats_404_as_done_and_other_posts_do_not() {
        let post = |path: &str| Entry {
            tool: "delete".to_string(),
            method: "POST".to_string(),
            path: path.to_string(),
            query: None,
            body: Some(serde_json::json!({"session": "s1"})),
        };
        assert!(is_idempotent_removal(&post("/v1/delete")));
        assert!(!is_idempotent_removal(&post("/v1/remember")));
    }
}