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
//! Hank configuration.
//!
//! Hank shares the stack's `.bobbin/config.toml` under a `[hank]` table, with
//! the same resolution order Quipu uses: compiled defaults are overlaid by the
//! user config (`~/.config/bobbin/config.toml`) and then the project config
//! (`.bobbin/config.toml`). CLI flags win over all of them (applied by the
//! caller). See `docs/hank-spec.md` §11.
use serde::{Deserialize, Serialize};
use std::path::{Path, PathBuf};
use crate::errors::{Error, Result};
/// Top-level Hank configuration (the `[hank]` table).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct HankConfig {
/// Baseline ref the shared read-only graph is built at.
pub base_ref: String,
/// Run the LSP tier for precise facts where a build resolves.
pub enable_lsp: bool,
/// Run the CPG/dataflow tier (Phase 2).
pub enable_cpg: bool,
/// Languages to extract (defaults to Bobbin's grammar set).
pub languages: Vec<String>,
/// Freshness / debounce settings.
pub freshness: FreshnessConfig,
/// Multi-tenancy limits.
pub tenancy: TenancyConfig,
/// Serving surface (MCP/HTTP) settings.
pub serve: ServeConfig,
/// Quipu promotion settings (Phase 4).
pub quipu: QuipuConfig,
/// Capability-scoped edit policy for the pre-edit guard (§5.8/FR-25).
pub policy: crate::policy::PolicyConfig,
/// What the usage spool records about a guard decision (hank #77).
pub metrics: crate::audit::MetricsConfig,
}
impl Default for HankConfig {
fn default() -> Self {
Self {
base_ref: "main".to_string(),
enable_lsp: true,
enable_cpg: false,
languages: ["rust", "typescript", "python", "go", "java", "cpp"]
.iter()
.map(|s| (*s).to_string())
.collect(),
freshness: FreshnessConfig::default(),
tenancy: TenancyConfig::default(),
serve: ServeConfig::default(),
quipu: QuipuConfig::default(),
policy: crate::policy::PolicyConfig::default(),
metrics: crate::audit::MetricsConfig::default(),
}
}
}
/// Freshness / debounce settings.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct FreshnessConfig {
/// Debounce for keystroke-driven tree-sitter updates, in milliseconds.
pub debounce_ms: u64,
/// Debounce for the deferred heavy tier (graph/frontier recompute, and later
/// LSP/CPG), in milliseconds. Longer than `debounce_ms` so a burst of edits
/// does not thrash the expensive recompute (FR-17).
pub heavy_debounce_ms: u64,
/// When to compute LSP facts: `"save"` or `"on_demand"`.
pub lsp_on: String,
}
impl Default for FreshnessConfig {
fn default() -> Self {
Self {
debounce_ms: 300,
heavy_debounce_ms: 1500,
lsp_on: "save".to_string(),
}
}
}
/// Multi-tenancy limits.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct TenancyConfig {
/// Maximum concurrent per-tenant overlays over one base.
pub max_overlays: usize,
/// Symbols with fan-in above this get special frontier handling.
pub high_fanin_threshold: usize,
/// Overlay eviction policy: `"on_session_close"` or `"lru"`.
pub overlay_eviction: String,
}
impl Default for TenancyConfig {
fn default() -> Self {
Self {
max_overlays: 32,
high_fanin_threshold: 200,
overlay_eviction: "on_session_close".to_string(),
}
}
}
/// Serving surface settings.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct ServeConfig {
/// Bind address for the HTTP / streamable-HTTP MCP surface.
pub bind_address: String,
/// Port for the streamable-HTTP MCP + HTTP API (distinct from Bobbin/Quipu).
pub mcp_http_port: u16,
/// Write guard for the broker / promotion endpoints.
pub read_only: bool,
/// Whether the pre-edit guard should EXPECT a resident daemon at
/// `bind_address:mcp_http_port` and use it to size edits (FR-31).
///
/// This flag is what makes "daemon not running" LOUD rather than noisy. When
/// false (the default, and true everywhere today since no daemon runs), the
/// guard builds the graph transiently and says nothing — absence is normal. When
/// true, the guard asks the daemon and, if it cannot, warns ONCE per session that
/// the resident guard is down while still guarding via a transient rebuild. Only
/// an operator who has actually started a daemon sets this, so the warning fires
/// exactly when a daemon was expected and isn't there — the cheapest-bypass case.
pub use_daemon: bool,
}
impl Default for ServeConfig {
fn default() -> Self {
Self {
bind_address: "127.0.0.1".to_string(),
mcp_http_port: 3040,
read_only: false,
use_daemon: false,
}
}
}
/// Quipu promotion settings (Phase 4).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct QuipuConfig {
/// Whether promotion into Quipu is enabled.
pub enabled: bool,
/// When to promote: `"commit"`, `"merge"`, or `"manual"`.
pub promote_on: String,
/// Branch model: `"named_graph"` (preferred, needs Quipu quads) or
/// `"qualifier"` (fallback). See `docs/hank-spec.md` §9.4.
pub branch_model: String,
/// Directory holding the SHACL shapes promotion validates against.
pub shapes_path: String,
/// Base URL of the Quipu to promote into (e.g. `http://localhost:8080`).
/// Deployment config, NOT a per-call parameter: the graph a promotion writes
/// into is data identity, not a caller's choice. Empty by default so a
/// misconfigured deployment refuses rather than guessing a graph. The CLI
/// `--to` overrides it for one-off promotions.
pub endpoint: String,
}
impl Default for QuipuConfig {
fn default() -> Self {
Self {
enabled: false,
promote_on: "merge".to_string(),
branch_model: "named_graph".to_string(),
shapes_path: "shapes/".to_string(),
endpoint: String::new(),
}
}
}
impl HankConfig {
/// Refuse a mutating operation when `serve.read_only` is set.
///
/// The write guard the docs promise (config.md: "Write guard for the broker /
/// promotion endpoints"). Before this it was documented, settable, and INERT —
/// an operator who set `read_only = true` before exposing `hank serve` to a
/// broker got no guard and no warning, which is strictly worse than an absent
/// switch: a safety control that does nothing invites the trust it cannot
/// honour (aegis-ltjo). Now the one write hank performs — promotion — calls
/// this and REFUSES with a distinguishable error naming the key, so the guard
/// is real and any future served write is one `write_guard` call from being
/// covered too.
pub fn write_guard(&self, operation: &str) -> Result<()> {
if self.serve.read_only {
return Err(Error::Config(format!(
"refused: `serve.read_only = true` — this hank instance is \
configured read-only, so {operation} (a write) is refused. \
Unset serve.read_only to allow writes."
)));
}
Ok(())
}
/// Load the merged configuration for a project rooted at `root`.
///
/// Starts from defaults, overlays the user config if present, then the
/// project's `.bobbin/config.toml` `[hank]` table. Missing files are not an
/// error; a malformed file is.
///
/// "Overlay" is per-key, not per-file. Replacing the whole table would mean
/// a project config that sets one unrelated key silently discards every
/// other setting the user config established — and when the discarded
/// setting is `[hank.policy]`, the capability guard goes inert while
/// looking exactly like a clean run. A fleet keeps its scopes in one
/// user-level file precisely so they cannot drift, so that file has to
/// survive a workspace defining `base_ref`.
pub fn load(root: &Path) -> Result<Self> {
Self::load_layered(user_config_path().as_deref(), root)
}
/// Resolve configuration honouring an explicit `--config` override.
///
/// `Some(path)` **replaces** discovery: FR-29 ranks a flag above project and
/// user config, so the override loads exactly that file over defaults and
/// the ambient `.bobbin/config.toml` is never consulted. `None` runs the
/// normal [`load`](Self::load) discovery rooted at `root`.
///
/// A `--config` path that cannot be read is an ERROR, never a silent
/// fall-back to discovery. That fall-back is the whole defect this override
/// closes (aegis-ll3p): an operator who points the guard at a scope file and
/// mistypes the path must get a loud failure, not the ambient scope wearing
/// the success of the command they meant to scope.
pub fn resolve(override_path: Option<&Path>, root: &Path) -> Result<Self> {
match override_path {
Some(path) => Self::load_from(path),
None => Self::load(root),
}
}
/// Load configuration from exactly one file, over defaults — no discovery.
///
/// The file must exist: [`read_hank_table`] returns `None` both for an
/// absent file and for a present file with no `[hank]` table, and only the
/// first is an error, so existence is checked explicitly. A present file
/// with no `[hank]` table is a valid (if unusual) request for defaults.
pub fn load_from(path: &Path) -> Result<Self> {
if !path.exists() {
return Err(Error::Config(format!(
"--config path does not exist: {}",
path.display()
)));
}
match read_hank_table(path)? {
Some(value) => value
.try_into()
.map_err(|e| Error::Config(format!("{}: [hank]: {e}", path.display()))),
None => Ok(Self::default()),
}
}
/// The layering itself, with the user-config path injected.
///
/// Taking it as an argument keeps this testable without reassigning
/// `$HOME`: that variable is process-global, and Cargo runs tests in
/// threads, so a test that moved it would race every other test reading it.
fn load_layered(user: Option<&Path>, root: &Path) -> Result<Self> {
let project = root.join(".bobbin").join("config.toml");
let sources = [user, Some(project.as_path())];
let mut merged: Option<toml::Value> = None;
for path in sources.into_iter().flatten() {
let Some(table) = read_hank_table(path)? else {
continue;
};
merged = Some(match merged {
Some(base) => merge(base, table),
None => table,
});
}
match merged {
None => Ok(Self::default()),
Some(value) => value
.try_into()
.map_err(|e| Error::Config(format!("[hank]: {e}"))),
}
}
}
/// Deep-merge `overlay` onto `base`: tables merge key-by-key, everything else
/// is replaced outright.
///
/// Arrays replace rather than concatenate. Accumulating them would let a
/// workspace's `allow_paths` silently *widen* a scope the user config narrowed,
/// which inverts the direction a capability scope is allowed to move.
fn merge(base: toml::Value, overlay: toml::Value) -> toml::Value {
match (base, overlay) {
(toml::Value::Table(mut base), toml::Value::Table(overlay)) => {
for (key, value) in overlay {
let merged = match base.remove(&key) {
Some(existing) => merge(existing, value),
None => value,
};
base.insert(key, merged);
}
toml::Value::Table(base)
}
(_, overlay) => overlay,
}
}
/// Path to the per-user config, if a home directory is resolvable.
fn user_config_path() -> Option<PathBuf> {
std::env::var_os("HOME").map(|home| {
PathBuf::from(home)
.join(".config")
.join("bobbin")
.join("config.toml")
})
}
/// Read the raw `[hank]` table from a config file, if the file exists.
///
/// Returns the un-deserialized [`toml::Value`] so callers can merge tables
/// before building the struct — deserializing each file separately would bake
/// in defaults for its absent keys, and those defaults would then overwrite
/// real values from a lower-precedence file.
///
/// Each file is still type-checked here, even though the result is discarded,
/// so a malformed `[hank]` is reported against the file that actually contains
/// it rather than surfacing later as an error about the merged whole.
fn read_hank_table(path: &Path) -> Result<Option<toml::Value>> {
if !path.exists() {
return Ok(None);
}
let text = std::fs::read_to_string(path)?;
let root: toml::Value =
toml::from_str(&text).map_err(|e| Error::Config(format!("{}: {e}", path.display())))?;
match root.get("hank") {
Some(section) => {
let _: HankConfig = section
.clone()
.try_into()
.map_err(|e| Error::Config(format!("{}: [hank]: {e}", path.display())))?;
Ok(Some(section.clone()))
}
None => Ok(None),
}
}
#[cfg(test)]
#[path = "config_test.rs"]
mod config_test;