diff --git a/Cargo.lock b/Cargo.lock index 3371c27..80552d9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -72,7 +72,7 @@ dependencies = [ [[package]] name = "anwesen" -version = "0.2.0" +version = "0.4.0" dependencies = [ "anyhow", "axum", diff --git a/Cargo.toml b/Cargo.toml index a20fc1d..077aa42 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "anwesen" description = "Read-only HTTP daemon over a markdown vault, querying YAML frontmatter." -version = "0.2.0" +version = "0.4.0" edition = "2024" rust-version = "1.95" license = "BSD-3-Clause" diff --git a/README.md b/README.md index d4e2fc0..f51daa3 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Anwesen answers three kinds of question over HTTP: The frontmatter index is built once at startup and kept current by watching the vault directory. The index lives in memory; a restart rebuilds it, and there is nothing on disk to corrupt or migrate. -The same query-and-merge engine also runs offline, with no server: `anwesen merge` walks a directory, evaluates a query, and writes the merged markdown to stdout (see [Local generation](#local-generation)). +The same query-and-merge engine also runs offline, with no server. `anwesen merge` walks a directory, evaluates a query, and writes the merged markdown to stdout; `anwesen query` writes the same JSON document `GET /query` returns (see [Local generation](#local-generation)). ## Quick start @@ -52,14 +52,20 @@ Build one file out of many notes, without starting the daemon: anwesen merge --vault /path/to/vault --query 'tags=adr&__anw-order=title' > ADRs.md ``` +Ask which notes match, and what their frontmatter holds, without starting the daemon: + +``` +anwesen query --vault /path/to/vault --query 'tags=adr' | jq -r '.results[].path' +``` + ## CLI ``` anwesen serve --vault [--bind ] [--log-level ] - [--uptrace-dsn | --otlp-endpoint ] - [--otlp-header ]... [--otlp-slow-request-ms ] + [--otlp-slow-request-ms ] anwesen doctor --vault anwesen merge --vault --query +anwesen query --vault --query anwesen version ``` @@ -68,25 +74,64 @@ anwesen version | `--vault ` | `ANWESEN_VAULT` | _required_ | Path to the vault root. | | `--bind ` | `ANWESEN_BIND` | `127.0.0.1:8080` | Listen address for `serve`. | | `--log-level ` | `ANWESEN_LOG_LEVEL` | `info` | `error`, `warn`, `info`, `debug`, or `trace`. | -| `--query ` | -- | _required for `merge`_ | A `/query` query string: frontmatter predicates plus `__anw-` controls. | -| `--uptrace-dsn ` | `ANWESEN_UPTRACE_DSN` | unset | uptrace DSN (`https://@api.uptrace.dev`). Excludes `--otlp-endpoint`. | -| `--otlp-endpoint ` | `ANWESEN_OTLP_ENDPOINT` | unset | OTLP/HTTP base URL. Excludes `--uptrace-dsn`. | -| `--otlp-header ` | `ANWESEN_OTLP_HEADERS` | none | Extra export header, repeatable. The env var takes a comma-separated list. | +| `--query ` | `ANWESEN_QUERY` | empty (match all) | A `/query` query string: frontmatter predicates plus `__anw-` controls. `merge` and `query` only. | | `--otlp-slow-request-ms` | `ANWESEN_OTLP_SLOW_REQUEST_MS` | `500` | Requests at or over this duration, or answering 5xx, also export a span. | -Every flag has a matching `ANWESEN_` environment variable, except -`--otlp-header`, whose env var is the plural `ANWESEN_OTLP_HEADERS` because it -takes a list. CLI flags win over env vars. +Every flag has a matching `ANWESEN_` environment variable. CLI flags win +over env vars. -Telemetry is off unless `--uptrace-dsn` or `--otlp-endpoint` is set. With -neither, nothing is exported and no exporter is built. The four telemetry -flags apply to `serve` only. +`--bind` and `--otlp-slow-request-ms` apply to `serve` only. Where telemetry is +exported is configured entirely through the standard `OTEL_` variables below. - **`serve`** -- run the daemon: walk the vault, build the index, watch for changes, serve the API. - **`doctor`** -- walk the vault once and report what would stop clean ingestion: unreadable files, unparseable YAML, path collisions on the HTTP surface, and frontmatter type drift (the same key carrying incompatible types across notes). Read-only; non-zero exit if any issue is found. - **`merge`** -- one-shot local generation: walk the vault, evaluate `--query`, and write the merged markdown document to stdout. No server, no HTTP. See [Local generation](#local-generation). +- **`query`** -- the same one-shot walk, writing the JSON document `GET /query` returns: which notes match, and what their frontmatter, `last_modified`, `etag` and `size` hold. No server, no HTTP. See [Local generation](#local-generation). - **`version`** -- print version and exit. +## Telemetry + +anwesen exports OTLP metrics for every request, and a span for requests at or +over `--otlp-slow-request-ms` or answering a 5xx. Export is configured through +the standard OpenTelemetry environment variables, which the SDK reads directly: + +| Variable | Meaning | +| -------------------------------------- | ---------------------------------------------------------------- | +| `OTEL_EXPORTER_OTLP_ENDPOINT` | Base URL. The SDK appends `/v1/metrics` and `/v1/traces`. | +| `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` | Full metrics URL, used as given. Overrides the base for metrics. | +| `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | Full traces URL, used as given. Overrides the base for traces. | +| `OTEL_EXPORTER_OTLP_HEADERS` | Export headers, `key=value` comma-separated. | +| `OTEL_EXPORTER_OTLP_PROTOCOL` | `http/protobuf`, the default and the only value this build speaks. | +| `OTEL_SERVICE_NAME`, `OTEL_RESOURCE_ATTRIBUTES` | Override the `anwesen` service identity. | + +The per-signal `OTEL_EXPORTER_OTLP_METRICS_PROTOCOL` and +`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` are read the same way. + +With none of the three endpoint variables set, telemetry is off: no exporter is +built and the request middleware is not installed. + +Two settings fail at startup rather than export nowhere in silence: + +- A query or a fragment on `OTEL_EXPORTER_OTLP_ENDPOINT`. The base URL must be + a base URL; the SDK appends the signal path after whatever it is given. +- A protocol other than `http/protobuf`. The binary ships the OTLP/HTTP + transport alone, so `grpc` would keep exporting over HTTP with nothing in the + log. Point the endpoint at the collector's HTTP port, not its gRPC one. + +uptrace: + +``` +OTEL_EXPORTER_OTLP_ENDPOINT=https://api.uptrace.dev +OTEL_EXPORTER_OTLP_HEADERS=uptrace-dsn=https://TOKEN@api.uptrace.dev?grpc=4317 +``` + +Paste the DSN from Project Settings into the header verbatim, tail and all -- +it is a credential there, not an address. The endpoint is the host alone. + +Removed in 0.3.0: `--uptrace-dsn`, `--otlp-endpoint`, `--otlp-header` and their +`ANWESEN_` variables. Passing any of them fails at startup with the `OTEL_` +replacement to use. + ## HTTP API All endpoints are `GET` and return JSON unless noted. @@ -136,7 +181,7 @@ ISO-8601 dates and RFC 3339 datetimes are coerced to typed dates at read time, s | `__anw-order=[:asc\|:desc]` | path order | Order fragments (merge mode only). | | `__anw-kind=` | off | Refuse a mixed merge unless every matched note shares one value for the key (merge mode only). | -By default `/query` returns metadata only; fetch bodies with `/notes/`. +By default `/query` returns metadata only; fetch bodies with `/notes/`. The same JSON document is available offline, without the daemon, via `anwesen query` (see [Local generation](#local-generation)). #### Markdown-merge mode @@ -164,7 +209,11 @@ Returns vault path, note count, last index/event timestamps, watcher state, an i ## Local generation -`anwesen merge` produces the markdown-merge document on the command line, with no server and no HTTP round-trip. It walks the vault, evaluates the query, and writes the merged document to stdout: +Two subcommands answer a query on the command line, with no server and no HTTP round-trip: `merge` writes the merged markdown document, `query` writes the JSON projection. Both take the same `--vault` and `--query` flags, both walk the vault once, and both run the engine the endpoint runs -- so the output matches what the daemon would have returned for the same vault and query. + +### `merge` + +`anwesen merge` walks the vault, evaluates the query, and writes the merged document to stdout: ``` anwesen merge --vault /path/to/vault --query 'tags=adr&__anw-order=title&__anw-kind=kind' @@ -174,6 +223,24 @@ The `--query` string is the exact `/query` grammar: frontmatter predicates plus This is the materialization path: build a `CLAUDE.md`, a skill bundle, or any single file assembled from many notes, driven from a script or a one-off shell. +### `query` + +`anwesen query` answers the other half: which notes match, and what their frontmatter holds. It writes the same JSON document `GET /query` returns -- `results`, `total`, `truncated`, with `path`, `frontmatter`, `last_modified`, `etag` and `size` per row -- on one line, ready for `jq`: + +``` +anwesen query --vault /path/to/vault --query 'kind=PDR&__anw-limit=1' +``` + +```json +{"results":[{"path":"Projects/PDR-001-intro.md","frontmatter":{"kind":"PDR","num":1,"title":"PDR-001 Intro"},"last_modified":"2026-05-14T17:05:08Z","etag":"\"f657eab5...\"","size":57}],"total":2,"truncated":true} +``` + +`total` counts the full match set; `truncated` says the cap cut it. + +Bodies are elided here as they are on the endpoint; `merge` is the way to get them offline. `__anw-order` and `__anw-kind` are merge-mode controls and do not affect this output. A malformed query or an unreadable vault exits non-zero with the reason on stderr; an empty match set is an empty `results` list and exit `0`. + +A script can therefore move between the daemon and the CLI without a second parser: same shape, same field names, same timestamp dialect. + ## Design notes - **In place, read-only.** Anwesen reads the same directory Obsidian writes to and never writes back. The vault stays editable in Obsidian with no coordination, and there is no write API by design. diff --git a/src/app.rs b/src/app.rs index f3ee5fc..cc4bcf6 100644 --- a/src/app.rs +++ b/src/app.rs @@ -121,6 +121,12 @@ pub struct Anwesen { /// Request-level telemetry handle ([ANW-37]). `None` disables export and /// the request middleware entirely. pub telemetry: Option>, + /// Set once the supervisor tree is up. Hydra's `Application::run` logs a + /// start failure and returns normally, so `serve` cannot tell a clean + /// shutdown from a tree that never came up. `main` reads this after `run` + /// and exits nonzero when it is still false, which is what lets systemd + /// retry ([ANW-45](https://crvrs.youtrack.cloud/issue/ANW-45)). + pub started: Arc, } impl Anwesen { @@ -133,6 +139,7 @@ impl Anwesen { store: NoteStore::new(), health: HealthState::new(), telemetry, + started: Arc::new(AtomicBool::new(false)), } } } @@ -187,10 +194,12 @@ impl Application for Anwesen { .child_spec(), ]; - Supervisor::with_children(children) + let pid = Supervisor::with_children(children) .strategy(SupervisionStrategy::OneForOne) .start_link(SupervisorOptions::new().name("anwesen_root")) - .await + .await?; + self.started.store(true, Ordering::Release); + Ok(pid) } } diff --git a/src/cli.rs b/src/cli.rs index 155ab5b..32bbced 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -4,18 +4,27 @@ //! //! ```text //! anwesen serve --vault [--bind ] [--log-level ] -//! [--uptrace-dsn | --otlp-endpoint ] -//! [--otlp-header ]... [--otlp-slow-request-ms ] +//! [--otlp-slow-request-ms ] //! anwesen doctor --vault [--log-level ] //! anwesen merge --vault [--query ] [--log-level ] +//! anwesen query --vault [--query ] [--log-level ] //! anwesen version //! ``` //! -//! `--bind` and the OTLP telemetry flags are `serve`-only ([ANW-37]); +//! `merge` and `query` differ only in what they write -- the merged markdown +//! document or the `/query` JSON projection ([ANW-43]) -- so they share one +//! [`VaultQueryArgs`] flag set and cannot drift. +//! +//! `--bind` and `--otlp-slow-request-ms` are `serve`-only ([ANW-37]); //! `doctor` and `merge` do not bind a port; `version` takes no flags. Each //! flag has a matching `ANWESEN_` environment variable and CLI wins -//! over env per the manual. With no `--otlp-endpoint`/`--uptrace-dsn`, -//! telemetry is off and the server behaves exactly as without these flags. +//! over env per the manual. +//! +//! Telemetry export is configured through the standard `OTEL_EXPORTER_OTLP_*` +//! environment variables ([ANW-42](https://crvrs.youtrack.cloud/issue/ANW-42)). +//! With none of them set, telemetry is off and the server behaves as it did +//! before telemetry existed. The removed flags below are still parsed so an +//! upgrade fails loudly instead of dropping export config in silence. use std::net::SocketAddr; use std::path::PathBuf; @@ -37,7 +46,11 @@ pub enum Command { Doctor(DoctorArgs), /// Walk the vault once, evaluate the query, and write the merged markdown /// document to stdout. One-shot; no server. Read-only. - Merge(MergeArgs), + Merge(VaultQueryArgs), + /// Walk the vault once, evaluate the query, and write the same JSON + /// document `GET /query` returns to stdout. One-shot; no server. + /// Read-only. + Query(VaultQueryArgs), /// Print the version and exit. Version, } @@ -56,25 +69,22 @@ pub struct ServeArgs { #[arg(long, env = "ANWESEN_LOG_LEVEL", default_value = "info")] pub log_level: LogLevel, - /// uptrace DSN shorthand (`https://@api.uptrace.dev`), parsed - /// into the OTLP endpoint plus an `uptrace-dsn` header. Mutually - /// exclusive with --otlp-endpoint. When this and --otlp-endpoint are - /// both unset, telemetry is fully off (ANW-37). - #[arg(long, env = "ANWESEN_UPTRACE_DSN")] + /// Removed (ANW-42): use `OTEL_EXPORTER_OTLP_ENDPOINT` plus + /// `OTEL_EXPORTER_OTLP_HEADERS=uptrace-dsn=`. Still accepted so + /// startup fails with that message rather than exporting nowhere. + #[arg(long, env = "ANWESEN_UPTRACE_DSN", hide = true)] pub uptrace_dsn: Option, - /// Generic OTLP/HTTP endpoint base URL for telemetry export. The - /// per-signal path (`/v1/metrics`, `/v1/traces`) is appended by the - /// exporter. Mutually exclusive with --uptrace-dsn. - #[arg(long, env = "ANWESEN_OTLP_ENDPOINT")] + /// Removed (ANW-42): use `OTEL_EXPORTER_OTLP_ENDPOINT`. + #[arg(long, env = "ANWESEN_OTLP_ENDPOINT", hide = true)] pub otlp_endpoint: Option, - /// Extra OTLP export header as `key=value`, repeatable. On the env var - /// (`ANWESEN_OTLP_HEADERS`) pass a comma-separated `key=value` list. + /// Removed (ANW-42): use `OTEL_EXPORTER_OTLP_HEADERS`. #[arg( long = "otlp-header", env = "ANWESEN_OTLP_HEADERS", - value_delimiter = ',' + value_delimiter = ',', + hide = true )] pub otlp_headers: Vec, @@ -96,8 +106,9 @@ pub struct DoctorArgs { pub log_level: LogLevel, } +/// Flags shared by the two one-shot subcommands, `merge` and `query`. #[derive(Debug, clap::Args)] -pub struct MergeArgs { +pub struct VaultQueryArgs { /// Path to the vault root. #[arg(long, env = "ANWESEN_VAULT")] pub vault: PathBuf, @@ -105,12 +116,12 @@ pub struct MergeArgs { /// Query in the `/query` query-string grammar, for example /// `tags=anwesen&__anw-kind=skill&__anw-order=order`. The `__anw-kind` /// homogeneity guard and `__anw-order` fragment ordering ride inside this - /// string -- there are no separate flags. Empty merges every note under - /// the vault root. + /// string -- there are no separate flags. `__anw-kind` and `__anw-order` + /// apply to `merge` only. Empty matches every note under the vault root. #[arg(long, env = "ANWESEN_QUERY", default_value = "")] pub query: String, - /// Log verbosity. Logs go to stderr; the merged document goes to stdout. + /// Log verbosity. Logs go to stderr; the document goes to stdout. #[arg(long, env = "ANWESEN_LOG_LEVEL", default_value = "info")] pub log_level: LogLevel, } @@ -172,6 +183,34 @@ mod tests { } } + /// The removed telemetry flags still parse, hidden from `--help`. Clap + /// rejecting them as unknown would say nothing about the `OTEL_` + /// replacement; the migration error in `telemetry::TelemetryConfig` + /// needs the values to reach it (ANW-42). + #[test] + fn serve_still_parses_the_removed_telemetry_flags() { + let cli = parse(&[ + "serve", + "--vault", + "/tmp/v", + "--uptrace-dsn", + "https://tok@api.uptrace.dev", + "--otlp-endpoint", + "https://collector.example.com", + "--otlp-header", + "authorization=Bearer xyz", + ]) + .expect("parse"); + match cli.command { + Command::Serve(a) => { + assert!(a.uptrace_dsn.is_some()); + assert!(a.otlp_endpoint.is_some()); + assert_eq!(a.otlp_headers, vec!["authorization=Bearer xyz".to_string()]); + } + _ => panic!("expected serve"), + } + } + #[test] fn serve_rejects_malformed_bind_at_parse_time() { let err = parse(&["serve", "--vault", "/tmp/v", "--bind", "not-an-addr"]).unwrap_err(); @@ -242,6 +281,47 @@ mod tests { assert_eq!(err.kind(), clap::error::ErrorKind::UnknownArgument); } + #[test] + fn query_takes_the_same_flags_as_merge() { + let cli = parse(&[ + "query", + "--vault", + "/tmp/v", + "--query", + "tags=anwesen&__anw-limit=5", + "--log-level", + "warn", + ]) + .expect("parse"); + match cli.command { + Command::Query(a) => { + assert_eq!(a.vault, PathBuf::from("/tmp/v")); + assert_eq!(a.query, "tags=anwesen&__anw-limit=5"); + assert!(matches!(a.log_level, LogLevel::Warn)); + } + _ => panic!("expected query"), + } + } + + #[test] + fn query_requires_vault_and_defaults_the_query() { + assert!(parse(&["query"]).is_err()); + match parse(&["query", "--vault", "/tmp/v"]) + .expect("parse") + .command + { + Command::Query(a) => assert_eq!(a.query, ""), + _ => panic!("expected query"), + } + } + + #[test] + fn query_rejects_bind() { + // --bind is serve-only; query does not listen. + let err = parse(&["query", "--vault", "/tmp/v", "--bind", "0.0.0.0:9000"]).unwrap_err(); + assert_eq!(err.kind(), clap::error::ErrorKind::UnknownArgument); + } + #[test] fn version_takes_no_flags() { assert!(matches!( diff --git a/src/doctor.rs b/src/doctor.rs index 58f3e8d..f53f09f 100644 --- a/src/doctor.rs +++ b/src/doctor.rs @@ -46,7 +46,7 @@ pub struct DriftShape { /// `"bool"`, `"number"`, `"string"`, `"date"`, `"list"`, `"mapping"`. pub shape: &'static str, pub count: usize, - /// Up to [`DRIFT_SAMPLES_PER_SHAPE`] vault-relative paths exhibiting + /// Up to `DRIFT_SAMPLES_PER_SHAPE` vault-relative paths exhibiting /// this shape, in the order they were scanned. pub samples: Vec, } diff --git a/src/http.rs b/src/http.rs index 48ec78e..1d847a9 100644 --- a/src/http.rs +++ b/src/http.rs @@ -22,7 +22,7 @@ use axum::http::{HeaderMap, HeaderValue, StatusCode}; use axum::middleware::{Next, from_fn, from_fn_with_state}; use axum::response::{IntoResponse, Response}; use axum::routing::get; -use chrono::{DateTime, SecondsFormat, Utc}; +use chrono::{DateTime, Utc}; use http_body::Body as _; use hydra::Process; use serde::Serialize; @@ -32,17 +32,11 @@ use std::path::PathBuf; use crate::app::RestartCounters; use crate::health::HealthState; +use crate::query::rfc3339_z; use crate::store::NoteStore; use crate::telemetry::{self, Telemetry, TraceHeaders}; use crate::vault::{Note, frontmatter_to_json}; -/// Canonical RFC 3339 form with a `Z` suffix -- the shape the User Manual -/// example uses for `last_modified`. Centralized here so every HTTP -/// `last_modified` field stays in the same dialect. -fn rfc3339_z(dt: DateTime) -> String { - dt.to_rfc3339_opts(SecondsFormat::Secs, true) -} - /// Shared state injected into every handler. #[derive(Clone)] pub struct HttpState { @@ -819,18 +813,23 @@ mod tests { } /// With telemetry installed, a normal request is answered byte-for-byte - /// as without it. The exporter points at an unreachable local port, so - /// export fails instantly in the background and never touches the - /// response path. + /// as without it. The test process sets no `OTEL_EXPORTER_OTLP_*` + /// variables, so the exporter aims at the SDK default and fails in the + /// background without ever touching the response path. #[tokio::test] async fn telemetry_layer_does_not_alter_responses() { - use crate::telemetry::{self, RawTelemetryArgs, TelemetryConfig}; + use crate::telemetry::{self, OtelEnv, RawTelemetryArgs, TelemetryConfig}; - let cfg = TelemetryConfig::resolve(RawTelemetryArgs { - otlp_endpoint: Some("http://127.0.0.1:9".into()), - slow_request_ms: 500, - ..Default::default() - }) + let cfg = TelemetryConfig::resolve( + &RawTelemetryArgs { + slow_request_ms: 500, + ..Default::default() + }, + OtelEnv { + endpoint: Some("http://127.0.0.1:9".into()), + ..OtelEnv::default() + }, + ) .unwrap() .expect("telemetry on"); let tel = Arc::new(telemetry::init(cfg).expect("telemetry init")); diff --git a/src/lib.rs b/src/lib.rs index 59f1689..818b23e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -10,7 +10,7 @@ pub mod app; pub mod doctor; pub mod health; pub mod http; -pub mod merge; +pub mod oneshot; pub mod query; pub mod store; pub mod telemetry; diff --git a/src/main.rs b/src/main.rs index f573e3f..05027d9 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,16 +1,17 @@ //! Anwesen: read-only HTTP daemon over a markdown vault. //! -//! This module wires the CLI to the `serve`, `doctor`, `merge`, and +//! This module wires the CLI to the `serve`, `doctor`, `merge`, `query`, and //! `version` subcommands. mod cli; use std::sync::Arc; +use std::sync::atomic::Ordering; use anwesen::app::Anwesen; use anwesen::doctor; -use anwesen::merge; -use anwesen::telemetry::{self, RawTelemetryArgs, TelemetryConfig}; +use anwesen::oneshot; +use anwesen::telemetry::{self, OtelEnv, RawTelemetryArgs, TelemetryConfig}; use anyhow::Result; use clap::Parser; use hydra::Application; @@ -25,14 +26,18 @@ fn main() -> Result<()> { match cli.command { Command::Serve(args) => { init_logging(args.log_level); - // Resolve telemetry config before the supervisor starts; an - // unset endpoint leaves it `None` (export off, behaves as today). - let telemetry = match TelemetryConfig::resolve(RawTelemetryArgs { - uptrace_dsn: args.uptrace_dsn, - otlp_endpoint: args.otlp_endpoint, - otlp_headers: args.otlp_headers, - slow_request_ms: args.otlp_slow_request_ms, - })? { + // Resolve telemetry config before the supervisor starts; no + // OTEL_EXPORTER_OTLP_* endpoint leaves it `None` (export off, + // no middleware). A removed flag is a startup error (ANW-42). + let telemetry = match TelemetryConfig::resolve( + &RawTelemetryArgs { + uptrace_dsn: args.uptrace_dsn, + otlp_endpoint: args.otlp_endpoint, + otlp_headers: args.otlp_headers, + slow_request_ms: args.otlp_slow_request_ms, + }, + OtelEnv::from_env(), + )? { Some(cfg) => Some(Arc::new(telemetry::init(cfg)?)), None => None, }; @@ -42,12 +47,22 @@ fn main() -> Result<()> { telemetry = telemetry.is_some(), "anwesen serve: starting supervisor tree" ); + let app = Anwesen::new(args.vault, args.bind, telemetry.clone()); + let started = app.started.clone(); // Blocks until the supervisor exits (SIGTERM / SIGINT / crash). - Anwesen::new(args.vault, args.bind, telemetry.clone()).run(); + app.run(); // Flush and shut down exporters after the server loop returns. if let Some(telemetry) = telemetry { telemetry.shutdown(); } + // `run` returns normally whether the tree came up or never + // started, so a failed start would otherwise look like a clean + // exit and systemd's `Restart=on-failure` would not retry + // (ANW-45). Exit nonzero when the tree never came up. + if !started.load(Ordering::Acquire) { + tracing::error!("anwesen serve: supervisor tree failed to start"); + std::process::exit(1); + } } Command::Doctor(args) => { init_logging(args.log_level); @@ -59,13 +74,26 @@ fn main() -> Result<()> { } Command::Merge(args) => { init_logging(args.log_level); - match merge::run(&args.vault, &args.query) { + match oneshot::merge(&args.vault, &args.query) { // `print!`, not `println!`: the merged document is byte-stable // and byte-identical to the HTTP merge body, which carries no // trailing newline. An empty match set prints nothing, exit 0. Ok(doc) => print!("{doc}"), Err(e) => { - eprint!("{}", e.render()); + eprint!("{}", e.render("merge")); + std::process::exit(1); + } + } + } + Command::Query(args) => { + init_logging(args.log_level); + match oneshot::query_json(&args.vault, &args.query) { + // `println!` here, unlike `merge`: the JSON body carries no + // trailing newline either, but stdout is one document per + // line for the shells and `jq` pipelines this exists for. + Ok(doc) => println!("{doc}"), + Err(e) => { + eprint!("{}", e.render("query")); std::process::exit(1); } } diff --git a/src/merge.rs b/src/merge.rs deleted file mode 100644 index a9b6d2b..0000000 --- a/src/merge.rs +++ /dev/null @@ -1,205 +0,0 @@ -//! One-shot local markdown-merge for the `anwesen merge` subcommand ([ANW-27]). -//! -//! Walks a vault directory once (the same [`vault::scan`] as `doctor`), -//! evaluates the `--query` string, and assembles the merged markdown document -//! with [`query::execute_merge`] -- the very engine the HTTP `/query` merge -//! mode ([ANW-26]) uses. CLI and HTTP output are therefore byte-identical for -//! the same vault and query. No HTTP, no watcher, no persistent index. - -use std::fmt::Write as _; -use std::path::Path; - -use crate::query::{self, MergeError, QueryError}; -use crate::store::NoteStore; -use crate::vault::{self, ScanIssue}; - -/// Why a one-shot merge could not produce a document. -#[derive(Debug)] -pub enum MergeCliError { - /// The `--query` string did not parse. Same grammar, same message as the - /// HTTP `/query` `400`. - Query(QueryError), - /// One or more files could not be read, or their frontmatter did not - /// parse. Same hard-failure posture as `doctor`; soft warnings (e.g. a - /// non-mapping frontmatter root) are ignored, matching what `serve` - /// ingests. - Scan(Vec), - /// The `__anw-kind` homogeneity guard rejected the matched set. The - /// `String` is the same naming message the HTTP path returns as `400`, - /// surfaced here on stderr instead. - Kind(String), -} - -impl MergeCliError { - /// Render the error for stderr. One concern per line, deterministic so the - /// stderr surface is golden-testable. - #[must_use] - pub fn render(&self) -> String { - match self { - Self::Query(e) => format!("{e}\n"), - Self::Scan(issues) => { - let mut s = String::from("merge: cannot read vault\n"); - for issue in issues { - let _ = writeln!(s, " {}: {}", issue.path.display(), issue.kind); - } - s - } - Self::Kind(msg) => msg.clone(), - } - } -} - -/// Walk `vault_root`, evaluate `raw_query`, and return the merged document. -/// -/// On success the returned `String` is byte-identical to the HTTP merge body -/// for the same vault and query. An empty match set yields an empty string. -/// -/// # Errors -/// - [`MergeCliError::Query`] when `raw_query` is malformed; -/// - [`MergeCliError::Scan`] when the directory is unreadable or any file's -/// frontmatter fails to parse; -/// - [`MergeCliError::Kind`] when the `__anw-kind` homogeneity guard fails. -pub fn run(vault_root: &Path, raw_query: &str) -> Result { - let parsed = query::parse(raw_query).map_err(MergeCliError::Query)?; - - let scan = vault::scan(vault_root); - if !scan.issues.is_empty() { - return Err(MergeCliError::Scan(scan.issues)); - } - - // The merge engine reads from a NoteStore exactly as the HTTP path does; - // a one-shot `replace` is the whole "index" this subcommand needs. - let store = NoteStore::new(); - store.replace(scan.notes); - - query::execute_merge(&store, &parsed) - .map_err(|MergeError::KindGuard(msg)| MergeCliError::Kind(msg)) -} - -#[cfg(test)] -mod tests { - use super::*; - use std::fs; - use std::path::Path; - use tempfile::TempDir; - - fn write(root: &Path, rel: &str, body: &str) { - let p = root.join(rel); - if let Some(parent) = p.parent() { - fs::create_dir_all(parent).unwrap(); - } - fs::write(p, body).unwrap(); - } - - #[test] - fn merges_bodies_with_source_markers() { - let tmp = TempDir::new().unwrap(); - write(tmp.path(), "a.md", "---\nnum: 1\n---\nalpha\n"); - write(tmp.path(), "b.md", "---\nnum: 2\n---\nbeta\n"); - let out = run(tmp.path(), "").unwrap(); - // Body is frontmatter-stripped; fragments join with a blank line and - // there is no trailing newline -- byte-identical to the HTTP body. - assert_eq!( - out, - "\nalpha\n\n\n\nbeta\n" - ); - } - - #[test] - fn order_desc_then_path_tiebreak() { - let tmp = TempDir::new().unwrap(); - write(tmp.path(), "a.md", "---\nnum: 1\n---\nlow\n"); - write(tmp.path(), "b.md", "---\nnum: 3\n---\nhigh\n"); - write(tmp.path(), "c.md", "---\nnum: 2\n---\nmid\n"); - let out = run(tmp.path(), "__anw-order=num:desc").unwrap(); - let bodies: Vec<&str> = out - .lines() - .filter(|l| !l.starts_with("\nalpha\n\n\n\nbeta\n" + ); + } + + #[test] + fn order_desc_then_path_tiebreak() { + let tmp = TempDir::new().unwrap(); + write(tmp.path(), "a.md", "---\nnum: 1\n---\nlow\n"); + write(tmp.path(), "b.md", "---\nnum: 3\n---\nhigh\n"); + write(tmp.path(), "c.md", "---\nnum: 2\n---\nmid\n"); + let out = merge(tmp.path(), "__anw-order=num:desc").unwrap(); + let bodies: Vec<&str> = out + .lines() + .filter(|l| !l.starts_with("