memstead_base/engine/

mod.rs

//! Unified engine.
//!
//! **One [`Engine`] type, three storage backends**: the engine sits
//! above [`MemBackend`] and routes reads / writes to the backend
//! named by each mount's mem. The MCP filesystem-mem server
//! (`memstead_mcp::filesystem_server::FilesystemMcpServer`) and every CLI
//! lean subcommand reach the
//! engine through [`Engine::from_workspace_root`] (lean: folder +
//! archive backends) or `memstead_git_branch::engine_from_workspace_root`
//! (full: adds git-branch).
//!
//! ## Routing
//!
//! Each mount holds one mem. Lookup is by mem name: the first
//! mount whose `mem` field equals the requested name wins. One mount
//! per mem is enforced — duplicates are a configuration bug, not a
//! feature, and the constructor rejects them.

use std::cell::OnceCell;
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use std::sync::Arc;

use memstead_schema::Schema;

use crate::backend::{BackendError, MemBackend};
use crate::graph::LouvainOutput;
use crate::mem::MemRouterSnapshot;
use crate::ops::WarningHint;
#[cfg(not(target_arch = "wasm32"))]
use crate::search_index::MemIndex;
use crate::store::Store;
use crate::workspace::{Mount, WorkspaceSettings};

pub mod apply_commit;
pub mod archive;
pub mod boot;
pub mod check_ops;
pub mod conflicts;
pub mod drift;
pub mod due;
pub mod error;
pub mod events;
pub mod export_html;
pub mod export_llms_txt;
#[cfg(feature = "file-watcher")]
pub mod file_watcher;
pub mod gates;
pub mod history;
pub mod lifecycle;
pub mod mutation;
pub mod outcomes;
pub mod query;
pub mod review;

pub use archive::FromArchiveBytesError;
pub use error::{
    BootError, EngineError, INLINE_LIST_CAP, MissingWikiLink, ReferrerInfo, SchemaSourceDiagnostic,
    format_inline_list_overflow,
};
#[cfg(feature = "tokio")]
pub use events::DEFAULT_BROADCAST_CAPACITY;
pub use events::{EventCallback, MemChangedEvent, SubscriptionHandle};
#[cfg(feature = "file-watcher")]
pub use file_watcher::{FileWatcherError, MemRepoWatcher, watch_mem_repo};
pub use history::{
    EntityHistoryReport, EntityTouch, HISTORY_PAGE_DEFAULT, HISTORY_PAGE_MAX, StoryStart,
};
pub use mutation::delete::DeleteReferrers;
pub use mutation::{PATCH_OLD_NOT_FOUND_CONTENT_CAP, RELATIONSHIP_CYCLE_PATH_CAP};
pub use outcomes::{
    CreateEntityArgs, CreateEntityOutcome, DeleteEntityArgs, DeleteEntityOutcome, RelateAction,
    RelateEntityArgs, RelateEntityOutcome, RenameEntityArgs, RenameEntityOutcome, SetSchemaOutcome,
    SetSchemaResult, UpdateEntityArgs, UpdateEntityOutcome,
};
pub use review::{ReviewMarkStatus, SetReviewMarkOutcome};

pub use boot::{SchemaResolver, load_workspace_schemas, resolve_builtin_schema_pin_pub};
pub use lifecycle::SchemaStaging;

/// One mem attachment, paired with the backend that serves it.
/// Constructed by [`Engine::from_mounts`] and held internally.
/// `pub(crate)` only so the crate-internal `boot::build_mem_router_from_mounts`
/// can name it in its signature — never re-exported.
pub(crate) struct MountedBackend {
    mount: Mount,
    backend: Box<dyn MemBackend>,
    /// Last cursor returned by `backend.current_head()`. Seeded in
    /// [`Engine::from_mounts`]; refreshed by
    /// [`Engine::reload_if_stale`] after a successful reload.
    /// `None` means the backend doesn't track a head (folder /
    /// archive) — drift detection is a no-op for this mount.
    last_known_head: Option<String>,
    /// Per-mem `.memstead/config.json` payload — surfaces via
    /// [`Engine::mem_config_for`] for handlers that need
    /// `write_guidance` / `extra` (`memstead_health
    /// { include_config: true }`'s per-mem detail block).
    ///
    /// Loaded at construction for folder backends (read from
    /// `<path>/.memstead/config.json`). Git-branch + archive backends
    /// carry `None` for now — the read-from-storage-backend path
    /// lifts in a follow-up session.
    mem_config: Option<memstead_schema::config::MemConfig>,
    /// Per-mem authoring-provenance payload read from the archive's
    /// `.memstead/provenance.json` at construction (via
    /// [`crate::backend::MemBackend::read_archive_provenance`]). `None`
    /// when the backend carries no provenance member (a pre-provenance
    /// archive, or a backend that does not surface one) — surfaced as
    /// provenance-absent via [`Engine::archive_provenance_for`]. A
    /// malformed payload is downgraded to `None` rather than failing the
    /// mount: the member is additive.
    archive_provenance: Option<memstead_schema::ArchiveProvenance>,
    /// `true` while a [`MountLifecycle::Lazy`] mount's entities have not
    /// been loaded into the store — the mount's metadata half (config,
    /// schema pin, provenance) is resolved at boot, the entity load is
    /// deferred to the first operation that needs the mem
    /// ([`Engine::ensure_mems_loaded`]). Always `false` for eager
    /// mounts, and permanently `false` once the deferred load lands.
    /// A deferred mem is never absent: it stays on the mount roster
    /// with its schema resolved, and every read surface either triggers
    /// the load or reports the state — silence is the one forbidden
    /// rendering.
    ///
    /// [`MountLifecycle::Lazy`]: crate::workspace::MountLifecycle::Lazy
    deferred: bool,
}

/// One quarantined mem: the mem-level boot failure that took it out of
/// service, and the retained mount record `reload` uses to re-attempt
/// the attach after a repair. The reason code/message are plan-01
/// typed material — the message's final clause names the repair
/// command, so the roster entry is actionable as-is.
#[derive(Debug, Clone)]
pub struct QuarantinedMem {
    /// The mount that failed to attach, retained verbatim for reload.
    pub mount: crate::workspace::Mount,
    /// Typed code of the underlying failure (e.g. `SCHEMA_NOT_FOUND`,
    /// `MEM_CONFIG_INCOMPLETE`, `MEM_ERROR`).
    pub reason_code: String,
    /// Full message of the underlying failure, repair command
    /// included.
    pub reason_message: String,
}

/// Unified engine. Holds a list of mounted backends and routes
/// mem-named operations to the right one.
///
/// `Send` so the engine can sit behind a `Mutex` (today's pattern
/// in the MCP server). The trait object's `Send + Sync` bound on
/// `MemBackend` keeps the inner backends thread-safe; the engine
/// itself is single-threaded by design (the lazy memos are
/// `OnceCell`, which is `!Sync`).
///
/// `Debug` is hand-written to avoid requiring `Debug` on the
/// `dyn MemBackend` trait object — backend impls are free to
/// stay non-`Debug`.
///
/// ## Load-on-init
///
/// `Engine::from_mounts` walks each backend at construction time
/// (`list_entities` + `read_entity` + parse) and populates a single
/// shared [`Store`] with entities and edges from every mount. Each
/// mount's schema resolves from its own pin (the backend config's
/// schema, or the mount-record assertion as fallback) through the
/// `SchemaResolver`, so `schemas` holds genuinely heterogeneous
/// schemas in a multi-schema workspace. Per-file errors don't fail
/// construction; they collect into [`Engine::load_errors`] for the
/// operator to inspect.
pub struct Engine {
    mounts: Vec<MountedBackend>,
    store: Store,
    schemas: HashMap<String, Arc<Schema>>,
    /// Workspace-authored schemas loaded from
    /// `WorkspaceSettings.schemas_dir` at construction. Distinct from
    /// `schemas` (per-mem, only schemas pinned by a mount): this
    /// catalogue carries every workspace-loaded schema regardless of
    /// whether a mem pins it. Surfaced via
    /// [`Self::workspace_schemas`] for handlers that need to enumerate
    /// schemas referenced by `mem_create_rules.schemas[]` but not
    /// pinned by any mem — `memstead_overview` lists them in `## Schemas`
    /// so an agent sees what could be pinned. Empty when no
    /// `schemas_dir` was passed.
    workspace_schemas: Vec<Arc<Schema>>,
    /// Embedded built-in schemas loaded once at boot from
    /// `memstead_schema::builtins::load_builtin_schemas()`. The boot path
    /// uses this catalogue to resolve each mount's schema pin; storing
    /// it on the engine lets read handlers (MCP's `memstead_schema`,
    /// `memstead_overview`'s `## Schemas` rendering) surface every built-in
    /// without re-walking the embedded directory. Schemas declared in
    /// `workspace_schemas` shadow built-ins on `(name, version)`
    /// collision — handlers walking both lists must check workspace
    /// first.
    builtin_schemas: Vec<Arc<Schema>>,
    load_errors: Vec<(PathBuf, String)>,
    /// Lazily-computed Louvain community detection across the
    /// engine-wide store. Populated on first call to
    /// [`Self::communities`]; invalidated by
    /// [`Self::invalidate_communities`] which every mutation method
    /// calls after a successful write. `OnceCell` is `!Sync`; the
    /// engine is `Send` (it is moved into a `Mutex` by every consumer)
    /// but not `Sync`.
    /// Generation-keyed (flywheel W8/01): the memo carries the store
    /// generation it was computed at; the invalidation hook clears it
    /// only when the store has actually moved past that generation —
    /// which is what makes a rolled-back batch (store snapshot
    /// restored, generation restored with it) keep serving the memo
    /// its state was computed from, and makes it impossible for the
    /// rolled-back interim state to be served as fresh.
    community_memo: OnceCell<(DerivedKey, LouvainOutput)>,
    /// Grounded-labelling memo — one `MemLabelling` per mem whose
    /// schema declares `relationships.labelling`, computed on first
    /// access and invalidated exactly where the community memo is
    /// (the reset lives inside [`Self::invalidate_communities`], so
    /// every mutation site, drift reload, quarantine attach/detach
    /// and apply-commit invalidate both without a second call).
    /// Generation-keyed like `community_memo`.
    labelling_memo: OnceCell<(
        DerivedKey,
        HashMap<String, crate::ops::labelling::MemLabelling>,
    )>,
    /// Lazily-computed per-mem search index map. Built on first call
    /// to [`Self::search_indexes`] via [`build_all`]; invalidated by
    /// [`Self::invalidate_search_indexes`] alongside the community
    /// cache so every mutation triggers a fresh build on the next
    /// search. Absent on `wasm32` targets — search lives behind the
    /// bridge (see `EngineError::SearchUnavailable`).
    #[cfg(not(target_arch = "wasm32"))]
    /// Generation-keyed like `community_memo`.
    search_indexes_memo: OnceCell<(DerivedKey, HashMap<String, MemIndex>)>,
    /// The second half of [`DerivedKey`]: bumped whenever the
    /// `schemas` map changes (schema switch, mount register/remove).
    /// Both derived structures depend on schemas as well as the store
    /// — community weights and the index field set come from the
    /// pinned schema — so a schema change must invalidate them even
    /// though the STORE generation did not move (the schema-switch
    /// staleness the whole-map drop used to mask).
    schemas_epoch: u64,
    /// Workspace-level operator policy — mem create/delete rules,
    /// cross-mem link permissions. Defaults to empty; populated via
    /// [`Self::set_settings`] when [`Self::from_workspace_root`] (or
    /// the full counterpart) reads `.memstead/workspace.toml`. Surfaced
    /// read-only via [`Self::settings`] for MCP handlers and other
    /// consumers.
    settings: WorkspaceSettings,
    /// Lazily-compiled [`crate::mem_management::CreateRuleSet`] over
    /// `settings.mem_create_rules`. Built on first
    /// [`Self::cross_mem_link_allowed`] call that needs synthesis;
    /// invalidated by [`Self::set_settings`] (so a fresh policy
    /// re-compiles on the next call). Compilation errors are logged
    /// and the cache stays empty — synthesis is best-effort, the
    /// resolver falls back to explicit-policy resolution. Operators
    /// who want hard validation pre-compile via
    /// [`crate::mem_management::CreateRuleSet::new`] before passing
    /// settings.
    create_rule_set_memo: OnceCell<crate::mem_management::CreateRuleSet>,
    /// Per-mem data-trust origin declared by the embedding deployment
    /// (e.g. a curated hosted read tier vouching for a read-only mount as
    /// first-party). A *composition* fact set through
    /// [`Self::declare_mem_origin`] by the process that owns the engine —
    /// never persisted with the mem, never derived from mem content, and
    /// deliberately not reachable over MCP, so a publisher cannot forge
    /// first-party. Empty by default; [`Self::mem_origin_class`] falls back
    /// to the writability inference for undeclared mems.
    declared_origins: HashMap<String, crate::render::OriginClass>,
    /// Workspace root path — set when the engine boots from a
    /// workspace store ([`Self::from_workspace_root`] or the full
    /// counterpart). `None` for tests + ad-hoc consumers that build
    /// the engine directly from a mount list. Surfaced via
    /// [`Self::workspace_root`] for handlers that need filesystem
    /// context (e.g. [`Self::health`]'s outer-repo .gitignore
    /// check).
    workspace_root: Option<PathBuf>,
    /// The mount roster as this engine last read or last wrote it —
    /// the baseline [`Engine::persist_state`] diffs against so a state
    /// write publishes THIS engine's changes without republishing its
    /// whole cached view over whatever a sibling process has since
    /// registered. Interior mutability because `persist_state` takes
    /// `&self`; the engine is already `!Sync`.
    mounts_baseline: std::cell::RefCell<Vec<crate::workspace::Mount>>,
    /// Typed warnings surfaced during mem load — drift findings
    /// like [`WarningHint::SuspiciousNestedPrefix`] and
    /// [`WarningHint::DuplicateSectionHeading`] that the loader
    /// pipeline collects per entity. Empty for the V1 unified
    /// engine; the field is in place so handlers and the health
    /// surface can include them when the loader pipeline grows the
    /// warning generators.
    load_warnings: Vec<WarningHint>,
    /// Mems that failed their mem-level boot step (unresolvable or
    /// missing schema pin, backend instantiation or read failure) and
    /// are quarantined instead of failing the whole workspace —
    /// degrade, never disappear. A quarantined mem serves NOTHING:
    /// operations naming it refuse with the typed `MEM_QUARANTINED`
    /// code carrying the underlying reason (quarantine is not
    /// tolerance — no partial data from a broken mem). The retained
    /// [`Mount`] record lets `reload` re-attempt the attach after a
    /// repair, without a process restart. Surfaced on overview and
    /// health as the quarantine roster.
    quarantined: Vec<QuarantinedMem>,
    /// Workspace-level boot diagnosis carried by a diagnostic-shell
    /// engine ([`Engine::diagnostic_shell`]): the typed reason the
    /// REAL workspace could not boot at all (e.g. an unparseable
    /// workspace store). `None` on every ordinarily booted engine.
    /// Surfaced on overview and health so a session over a wholly
    /// unbootable workspace can always ask WHY the graph is gone.
    boot_diagnosis: Option<(String, String)>,
    /// Pipeline configs (Medium / Facet / Projection / Ingest) loaded
    /// from the workspace store at boot. Empty for engines built via
    /// `from_mounts*` (tests, in-memory consumers) and for any workspace
    /// that declares no pipelines; the workspace-root boot paths
    /// (`from_workspace_root` and the full counterpart) populate it via
    /// [`crate::pipeline_store::load_pipeline_configs`]. Read-only
    /// runtime surface — exposed through [`Self::pipeline_configs`]; the
    /// engine neither runs nor schedules pipelines (the ingest skill and
    /// future consumers do).
    pipeline_configs: crate::pipeline_store::BindingConfigs,
    /// Runtime snapshot of writable / visible mems. Derived from
    /// the mount list at construction: writable mounts
    /// (`MountCapability::Write`) register via `add_writable` with
    /// the storage's directory path (folder → `path`, git-branch →
    /// None, archive shouldn't be writable); read-only mounts
    /// register via `add_writable` (folder/git-branch) or
    /// `add_read_only` (archive). Used by MCP handlers that need the
    /// writable/visible roster + per-mem origin (`memstead_health
    /// include_config: true`, `memstead_overview`'s mem list,
    /// `memstead_mem_create`'s collision check).
    ///
    /// Wrapped in `Arc` so the COW-snapshot discipline — clone the
    /// snapshot, mutate the clone, swap the `Arc` — keeps writers
    /// and concurrent readers from contending on the live mount
    /// list.
    mem_router: Arc<MemRouterSnapshot>,
    /// Backend factory — function pointer used by
    /// [`crate::mem_management::create_mem`] (and future runtime
    /// mount-add paths) to materialise a [`MemBackend`] from a
    /// [`Mount`] declaration. Defaults to
    /// [`crate::workspace_store::instantiate_lean_backend`] so lean
    /// (folder + archive only) consumers work out of the box. Full
    /// consumers swap in `memstead_git_branch::storage::instantiate_full_backend`
    /// via [`Self::set_backend_factory`] after constructing the engine —
    /// `engine_from_workspace_root` does this once at boot. Function
    /// pointer (not `Box<dyn Fn>`) because the backend factory is
    /// stateless, `Send + Sync + Copy`, and one less allocation on the
    /// hot path matters for the multi-mem pattern this engine is
    /// designed around.
    backend_factory: BackendFactory,
    /// Storage discovery for UNMOUNTED mems (flywheel W7/02) — set by
    /// full boot, `None` in lean/embedded engines (which keep the
    /// forward-reference mechanic unchanged for unmounted targets).
    pub(crate) unmounted_storage_prober: Option<UnmountedStorageProber>,
    /// Git-branch ops bundle — function pointers for the per-mount
    /// operations whose implementations live in `memstead-git-branch`
    /// (and therefore can't sit on the `MemBackend` trait without
    /// inverting the crate dependency). Full boot
    /// (`memstead_git_branch::engine_from_workspace_root`) installs the
    /// bundle via [`Self::set_git_branch_ops`]; lean consumers leave
    /// it `None` and `Engine::changes_since` / `Engine::export_mem`
    /// fall through to the folder/archive-only branches.
    git_branch_ops: Option<GitBranchOps>,
    /// Per-mem subscriber registry for [`MemChangedEvent`]s. Held
    /// behind `Arc<Mutex<_>>` so [`SubscriptionHandle`]s — which own
    /// the consumer's view of the subscription lifetime — can call
    /// back into the registry on `Drop` without a self-reference cycle
    /// to the engine. The emit path (in `record_self_write`) snapshots
    /// the per-mem callback list under the lock, releases the lock,
    /// and then invokes the callbacks — so a callback that re-enters
    /// the engine for a read does not deadlock against the registry.
    event_subscribers: Arc<std::sync::Mutex<events::SubscriberRegistry>>,
    /// Reload-before-operation notices accumulated by
    /// [`Self::reload_if_stale`] when an operation triggered a mem
    /// reload. Built at reload time — when the backend's current head
    /// equals the head we reloaded to, *before* any mutation in the
    /// same operation commits — so the delta describes only the
    /// sibling's change, never the engine's own follow-on write. The
    /// response layer drains them via
    /// [`Self::take_mem_changed_notices`] and attaches the structured
    /// `mem_changed` notice to the operation's response. Every entity
    /// op that can reload drains after; an undrained accumulation would
    /// leak into the next operation's response, so callers that reload
    /// must take.
    pending_mem_changed: Vec<crate::ops::MemChangedNotice>,
    /// Timestamp source for engine-stamped mutation metadata
    /// (`created_date` on create, `last_modified` on update/relate/
    /// rename — every field the schema marks `init_timestamp` /
    /// `auto_timestamp`). Defaults to the system clock; tests that
    /// assert over canonical entity bytes pin it via
    /// [`Self::set_mutation_clock`] so two engines stamp identical
    /// values. A testability affordance, not a behaviour switch:
    /// nothing in production swaps the default, and the stamped
    /// format (second-granularity RFC 3339, see
    /// `mutation::iso_from_system_time`) is unchanged.
    mutation_clock: MutationClock,
    /// The caller-declared role for mutations in this session
    /// (agent-trust plan 13). Set by the surface before each mutation
    /// (per-call parameter wins over the surface's session default);
    /// `Unspecified` records as absence. Session state on the engine
    /// — the `mutation_clock` precedent — so the role travels into
    /// every commit context and provenance record without widening
    /// every mutation signature.
    current_role: crate::vcs::Role,
    /// The caller-declared identity for mutations and checks in this
    /// session (agent-trust plan 15). Same session-state pattern as
    /// `current_role`: set by the surface before each operation
    /// (per-call parameter wins over the surface's session default);
    /// `None` records as absence. An opaque caller-chosen string —
    /// the engine neither generates, interprets, nor enriches it.
    current_identity: Option<String>,
}

/// Clock the engine reads when stamping mutation timestamps. `Arc`'d
/// closure rather than a trait so a test can pin a constant with one
/// line: `engine.set_mutation_clock(Arc::new(|| some_time))`.
pub type MutationClock = Arc<dyn Fn() -> std::time::SystemTime + Send + Sync>;

/// Backend factory function pointer. Both flavours' existing
/// `instantiate_*_backend` functions match this signature, so the
/// type alias is what bridges the dependency direction (memstead-base
/// can't depend on memstead-git-branch) without an extra trait.
/// Stateless, `Send + Sync + Copy`.
pub type BackendFactory =
    fn(&Mount) -> Result<Box<dyn MemBackend>, crate::workspace_store::InstantiateError>;

/// Discovered storage for a mem that has NO mount record — the
/// unmounted half of flywheel W7/02's write-time cross-mem target
/// verification. The workspace layer owns the discovery convention
/// (the mem-repo's branch registry, which memstead-base cannot see
/// without inverting the crate dependency) and hands back a transient
/// backend to ask plus the mem's schema pin when its config declares
/// one, so the cross-schema edge routing can keep its authority
/// without a mount.
/// The validity key for derived-structure memos (flywheel W8/01):
/// the store generation (bumped by every store mutation, carried by
/// `Store::clone` so batch rollback restores it) plus the schemas
/// epoch (bumped by every change to the engine's schema map). A memo
/// is current exactly while both halves still match.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DerivedKey {
    pub store_generation: u64,
    pub schemas_epoch: u64,
}

pub struct UnmountedMemStorage {
    /// Transient backend over the discovered storage. Used for the
    /// cheap [`MemBackend::entity_exists`] probe and the one-blob
    /// type read — never registered, never loaded.
    pub backend: Box<dyn MemBackend>,
    /// The mem's pinned schema, when its stored config declares one.
    pub schema: Option<memstead_schema::SchemaRef>,
}

/// Discovery hook: mem name → its storage, when the workspace layer
/// can find any (`None` = no discoverable storage; the
/// forward-reference mechanic governs, exactly as before). Boxed
/// closure rather than a function pointer because discovery needs the
/// workspace root and gitdir captured at boot.
pub type UnmountedStorageProber = Box<dyn Fn(&str) -> Option<UnmountedMemStorage> + Send + Sync>;

/// `Engine::changes_since` dispatch for git-branch mounts.
///
/// Signature matches `memstead_git_branch::ops::changes::changes_since` after
/// adapting the `Store` parameter away (the engine performs enrichment
/// downstream) and the `head_ref` parameter (`refs/heads/<branch>` is
/// constructed inside the impl from `branch`).
pub type GitBranchChangesSinceFn = fn(
    gitdir: &Path,
    branch: &str,
    mem: &str,
    since: &str,
    rename_similarity: f32,
) -> Result<crate::ops::BackendChanges, BackendError>;

/// `Engine::export_mem` dispatch for git-branch mounts.
///
/// Signature mirrors `memstead_git_branch::ops::export::export_mem_from_branch`.
pub type GitBranchExportFn = fn(
    gitdir: &Path,
    branch: &str,
    mem: &str,
    config: &memstead_schema::MemConfig,
    output_path: &Path,
    workspace_root: Option<&Path>,
    workspace_schemas_dir: Option<&Path>,
    // Engine-sourced authoring-provenance payload bytes (from the mount's
    // `read_provenance` log) to embed at `.memstead/provenance.json`.
    // `None` when the mem carried no noted mutations.
    provenance_bytes: Option<&[u8]>,
    // Engine-sourced anchors sidecar bytes (from the mount's
    // `read_anchors_sidecar`) to embed at `.memstead/anchors.json`. `None`
    // when the mem carried no anchors. The engine reads the branch tip; the
    // hook only embeds, keeping git tree-walking out of the fn-pointer.
    anchors_bytes: Option<&[u8]>,
) -> Result<crate::ops::MemExportResult, BackendError>;

/// `Engine::export_mem_to_bytes` dispatch for git-branch mounts.
///
/// Signature mirrors `memstead_git_branch::ops::export::export_mem_from_branch_to_bytes`.
/// Symmetric to `GitBranchExportFn`: same inputs minus the output path,
/// returns archive bytes plus metadata instead of writing to disk.
pub type GitBranchExportToBytesFn = fn(
    gitdir: &Path,
    branch: &str,
    mem: &str,
    config: &memstead_schema::MemConfig,
    workspace_root: Option<&Path>,
    workspace_schemas_dir: Option<&Path>,
    // Pre-built authoring-provenance payload bytes the engine sourced from
    // the mount's `read_provenance` log, to embed at
    // `.memstead/provenance.json`. `None` when the mem carried no noted
    // mutations. The engine sources it (it holds the backend); the hook
    // only embeds, keeping git history-walking out of the fn-pointer.
    provenance_bytes: Option<&[u8]>,
    // Engine-sourced anchors sidecar bytes (from the mount's
    // `read_anchors_sidecar`) to embed at `.memstead/anchors.json`. `None`
    // when the mem carried no anchors. Symmetric with `provenance_bytes`:
    // the engine reads the branch tip, the hook only embeds.
    anchors_bytes: Option<&[u8]>,
) -> Result<crate::ops::MemExportBytes, BackendError>;

/// `Engine::diff` dispatch for git-branch mounts. Walks the two refs
/// inside the workspace's mem-repo gitdir, produces a per-entity
/// [`crate::ops::Diff`]. Refs are arbitrary `gix::rev_parse_single`
/// inputs — branch names, commit SHAs, tag names. Resolves each
/// independently so cross-branch (cross-mem) diffs work uniformly.
/// `branch` is the mount's declared branch; a bare `HEAD` token in
/// either ref re-anchors onto it.
pub type GitBranchDiffFn = fn(
    gitdir: &Path,
    branch: &str,
    mem: &str,
    ref_a: &str,
    ref_b: &str,
    config: &crate::ops::DiffConfig,
) -> Result<crate::ops::Diff, BackendError>;

/// `Engine::fetch` dispatch for git-branch mounts.
pub type GitBranchFetchFn = fn(
    gitdir: &Path,
    remote: &str,
    refspecs: &[String],
) -> Result<crate::ops::FetchOutcome, BackendError>;

/// Read every `.md` blob at `ref_name` in `gitdir`, returning
/// `(relative_path, utf8_content)` pairs. Skips `.memstead/` engine-internal
/// entries and non-blob nodes. Used by the pre-merge schema-validation
/// pass `Engine::pull` and `Engine::push` run before they advance the
/// branch pointer / push to the remote.
pub type GitBranchReadTreeFn =
    fn(gitdir: &Path, ref_name: &str) -> Result<Vec<(String, String)>, BackendError>;

/// `Engine::pull` dispatch for git-branch mounts. `branch` is the
/// mount's declared branch — the single source of truth for both the
/// local ref and the remote-tracking ref; `mem` labels the outcome
/// only.
pub type GitBranchPullFn = fn(
    gitdir: &Path,
    remote: &str,
    branch: &str,
    mem: &str,
) -> Result<crate::ops::PullOutcome, BackendError>;

/// `Engine::push` dispatch for git-branch mounts. `branch` is the
/// mount's declared branch (see [`GitBranchPullFn`]); `mem` labels
/// the outcome only.
pub type GitBranchPushFn = fn(
    gitdir: &Path,
    remote: &str,
    branch: &str,
    mem: &str,
    force: bool,
) -> Result<crate::ops::PushOutcome, BackendError>;

/// `Engine::remote_add` dispatch — configures a named remote on the
/// mem-repo gitdir (upsert: add, or set-url when it already exists).
pub type GitBranchRemoteAddFn =
    fn(gitdir: &Path, name: &str, url: &str) -> Result<crate::ops::RemoteAddOutcome, BackendError>;

/// `Engine::branch_reset` dispatch for git-branch mounts. Returns the
/// outcome on success; surfaces `BackendError::Other` carrying an
/// in-band marker (`UNKNOWN_REF:<raw>` or
/// `PUSHED_COMMITS_PROTECTED:<sha,sha,...>`) the engine layer
/// un-marshals into typed `EngineError`s.
pub type GitBranchBranchResetFn = fn(
    gitdir: &Path,
    branch: &str,
    target_sha: &str,
    expected_head: Option<&str>,
) -> Result<crate::ops::BranchResetOutcome, BackendError>;

/// Residue-prune dispatch for git-branch mounts.
/// The `create_mem` orchestrator calls this when
/// `RecoveryAction::ForceOverwrite` is selected against pre-existing
/// storage residue. Drops `refs/heads/<branch_full_path>` and the
/// `__MEMSTEAD:mems/<branch_full_path>/config.json` blob in one
/// ref-edit transaction (the same call the
/// `MemBackend::delete_artifacts` impl wraps for delete-files
/// flows). Surfaces as a function pointer so `memstead-engine` can
/// drive a prune against an unmounted gitdir without depending on
/// `memstead-git-branch`.
pub type GitBranchPruneResidueFn =
    fn(gitdir: &Path, branch_full_path: &str) -> Result<(), BackendError>;

/// `rename_mem` dispatch for the git-branch backend: move the mem's
/// content branch `refs/heads/<old>` to `refs/heads/<new>` at the same
/// tip (history preserved) and relocate the `__MEMSTEAD:mems/<old>/`
/// config blob to `mems/<new>/`, all in one ref-edit transaction.
/// Refuses (no mutation) when the source branch is missing or the
/// target branch already exists.
pub type GitBranchRenameMemStorageFn =
    fn(gitdir: &Path, old_leaf: &str, new_leaf: &str) -> Result<(), BackendError>;

/// `Engine::install_schema` dispatch for the git-branch backend: write a
/// schema package (`(relative-path, bytes)` pairs) onto the workspace's
/// unified `__MEMSTEAD:schemas/<name>@<version>/` ref and return the
/// resulting commit sha. Mirrors
/// `memstead_git_branch::storage_memstead::write_schema_to_memstead_ref`.
pub type GitBranchWriteSchemaFn = fn(
    gitdir: &Path,
    name: &str,
    version: &str,
    files: &[(String, Vec<u8>)],
) -> Result<String, BackendError>;

/// Read one file from a sealed schema package on the workspace's
/// `__MEMSTEAD:schemas/<name>@<version>/` ref. `Ok(None)` when the
/// ref, package, or file is absent — absence is a normal state (the
/// install-provenance stamp only exists for path-sourced installs).
/// Read-only; the authoring-drift health axis is the consumer.
pub type GitBranchReadSchemaFileFn = fn(
    gitdir: &Path,
    name: &str,
    version: &str,
    rel: &str,
) -> Result<Option<Vec<u8>>, BackendError>;

/// Re-read every schema sealed on the workspace's
/// `__MEMSTEAD:schemas/` ref (empty when the ref or subtree is
/// absent). Read-only; `Engine::full_refresh` is the consumer — the
/// warm-server path that makes an out-of-band `memstead schema
/// install` resolvable without a process restart.
pub type GitBranchReadRefSchemasFn =
    fn(workspace_root: &Path) -> Result<Vec<Arc<memstead_schema::Schema>>, BackendError>;

/// Bundle of git-branch-specific op dispatchers. Installed on the
/// engine at full boot. Each field is one ops-method that previously
/// lived on the `MemBackend` trait; moving them off the trait keeps
/// the bytes-level primitive surface clean.
#[derive(Clone, Copy)]
pub struct GitBranchOps {
    pub changes_since: GitBranchChangesSinceFn,
    pub diff: GitBranchDiffFn,
    pub branch_reset: GitBranchBranchResetFn,
    pub fetch: GitBranchFetchFn,
    pub pull: GitBranchPullFn,
    pub push: GitBranchPushFn,
    pub remote_add: GitBranchRemoteAddFn,
    pub read_tree: GitBranchReadTreeFn,
    pub export: GitBranchExportFn,
    pub export_to_bytes: GitBranchExportToBytesFn,
    pub prune_residue: GitBranchPruneResidueFn,
    pub rename_mem_storage: GitBranchRenameMemStorageFn,
    pub write_schema: GitBranchWriteSchemaFn,
    pub read_schema_file: GitBranchReadSchemaFileFn,
    pub read_ref_schemas: GitBranchReadRefSchemasFn,
}

impl std::fmt::Debug for Engine {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Engine")
            .field(
                "mems",
                &self
                    .mounts
                    .iter()
                    .map(|m| m.mount.mem.as_str())
                    .collect::<Vec<_>>(),
            )
            .finish()
    }
}

#[cfg(test)]
mod in_memory_mem;

#[cfg(test)]
pub(super) mod test_helpers {
    use std::io::Write as _;
    use std::path::{Path, PathBuf};

    use memstead_schema::SchemaRef;

    use crate::backend::MemBackend;
    use crate::storage::FilesystemMemWriter;
    use crate::vcs::{Actor, ClientId};
    use crate::workspace::{Mount, MountCapability, MountLifecycle, MountStorage};

    use super::{CreateEntityArgs, CreateEntityOutcome, Engine, RelateEntityArgs};

    use indexmap::IndexMap;
    use tempfile::TempDir;

    pub(crate) fn pin(name: &str) -> SchemaRef {
        let version = match name {
            "default" => semver::Version::new(1, 0, 0),
            _ => semver::Version::new(0, 1, 0),
        };
        SchemaRef::new(name, version)
    }

    pub(crate) fn folder_mount(mem: &str, path: PathBuf) -> Mount {
        Mount {
            mem: mem.to_string(),
            schema: Some(pin("default")),
            storage: MountStorage::Folder { path },
            capability: MountCapability::Write,
            lifecycle: MountLifecycle::Eager,
            cross_linkable: true,
            migration_target: None,
        }
    }

    pub(crate) fn in_memory_mount(mem: &str) -> Mount {
        Mount {
            mem: mem.to_string(),
            schema: Some(pin("default")),
            storage: MountStorage::InMemory,
            capability: MountCapability::Write,
            lifecycle: MountLifecycle::Eager,
            cross_linkable: true,
            migration_target: None,
        }
    }

    pub(crate) fn archive_mount(mem: &str, path: PathBuf) -> Mount {
        Mount {
            mem: mem.to_string(),
            schema: Some(pin("default")),
            storage: MountStorage::Archive { path },
            capability: MountCapability::ReadOnly,
            // Eager, matching every production archive-mount site: these
            // tests pin archive READ semantics over a loaded store. The
            // lifecycle slot became real (flywheel W7/01) — a `Lazy`
            // value here would defer the load these tests read through.
            // The lazy behaviour has its own tests in `boot.rs`.
            lifecycle: MountLifecycle::Eager,
            cross_linkable: false,
            migration_target: None,
        }
    }

    /// Build a sealed archive at `tmp/<name>.mem` from
    /// `(relative_path, bytes)` pairs and return the path.
    pub(crate) fn build_archive(tmp: &Path, name: &str, entries: &[(&str, &[u8])]) -> PathBuf {
        let path = tmp.join(format!("{name}.mem"));
        let file = std::fs::File::create(&path).unwrap();
        let mut writer = zip::ZipWriter::new(file);
        let opts = zip::write::SimpleFileOptions::default();
        for (rel, bytes) in entries {
            writer.start_file(*rel, opts).unwrap();
            writer.write_all(bytes).unwrap();
        }
        writer.finish().unwrap();
        path
    }

    /// Write a schema manifest + minimal type bodies under
    /// `<root>/<name>/`. Each type gets a body with a single
    /// `body` section and `_default` hierarchy/no-self-loop lists — enough
    /// to load and parse markdown that uses that type. Used by tests
    /// that need a custom schema with shape or vocabulary constraints.
    pub(crate) fn write_schema_files_with_default_type(
        root: &Path,
        name: &str,
        manifest: &str,
        types: &[&str],
    ) {
        const TYPE_BODY: &str = r#"description: t
when_to_use: Here
sections:
  - key: body
    heading: Body
    required: true
    search_weight: 10.0
    catch_all: true
    write_rules: []
metadata_fields: []
title_weight: 100.0
text_fields:
  - body
hierarchy_relationship: _default
no_self_loop_relationships: []
updatable_fields:
  - title
  - body
health_required_fields:
  - body
staleness_threshold_days: 90
write_rules: []
"#;
        let dir = root.join(name);
        std::fs::create_dir_all(dir.join("types")).unwrap();
        std::fs::write(dir.join("schema.yaml"), manifest).unwrap();
        for type_name in types {
            let body = format!("name: {type_name}\n{TYPE_BODY}");
            std::fs::write(dir.join("types").join(format!("{type_name}.yaml")), body).unwrap();
        }
    }

    pub(crate) fn empty_create_args(mem: &str, title: &str) -> CreateEntityArgs {
        // The
        // create path refuses on missing required sections. The
        // default `spec` type requires `identity` + `purpose`. Seed
        // both with a single space so the test fixture remains a
        // valid creation request — every test that uses this helper
        // as a fixture builder continues to work, and tests that
        // specifically exercise the refusal supply an explicit
        // empty-sections payload (see the dedicated refusal tests).
        let mut sections = IndexMap::new();
        sections.insert("identity".to_string(), "fixture identity body".to_string());
        sections.insert("purpose".to_string(), "fixture purpose body".to_string());
        CreateEntityArgs {
            anchors: Vec::new(),
            mem: mem.to_string(),
            title: title.to_string(),
            entity_type: "spec".to_string(),
            sections,
            metadata: IndexMap::new(),
            relations: Vec::new(),
            dry_run: false,
        }
    }

    pub(crate) fn cli_actor() -> (Actor, ClientId) {
        (
            Actor::Cli,
            ClientId {
                name: "claude-code".to_string(),
                version: "2.1.0".to_string(),
            },
        )
    }

    pub(crate) fn engine_with_seed(tmp: &TempDir, title: &str) -> (Engine, CreateEntityOutcome) {
        let mem_dir = tmp.path().to_path_buf();
        let writer = FilesystemMemWriter::new(mem_dir.clone());
        let mut engine = Engine::from_mounts(vec![(
            folder_mount("specs", mem_dir),
            Box::new(writer) as Box<dyn MemBackend>,
        )])
        .unwrap();
        let (actor, client) = cli_actor();
        let outcome = engine
            .create_entity(
                empty_create_args("specs", title),
                actor,
                Some(&client),
                None,
            )
            .unwrap();
        (engine, outcome)
    }
    pub(crate) fn build_demo_engine(tmp: &TempDir) -> Engine {
        let mem_dir = tmp.path().to_path_buf();
        let writer = FilesystemMemWriter::new(mem_dir.clone());
        let mut engine = Engine::from_mounts(vec![(
            folder_mount("specs", mem_dir),
            Box::new(writer) as Box<dyn MemBackend>,
        )])
        .unwrap();
        let (actor, client) = cli_actor();
        let source = engine
            .create_entity(
                empty_create_args("specs", "Source One"),
                actor,
                Some(&client),
                None,
            )
            .unwrap();
        let target = engine
            .create_entity(
                empty_create_args("specs", "Target Two"),
                actor,
                Some(&client),
                None,
            )
            .unwrap();
        engine
            .create_entity(
                empty_create_args("specs", "Lonely Three"),
                actor,
                Some(&client),
                None,
            )
            .unwrap();
        engine
            .relate_entity(
                RelateEntityArgs {
                    source: source.id.clone(),
                    expected_hash: Some(source.content_hash.clone()),
                    rel_type: "USES".to_string(),
                    target: target.id.clone(),
                    remove: false,
                    description: None,
                    dry_run: false,
                },
                actor,
                Some(&client),
                None,
            )
            .unwrap();
        engine
    }
}