mirror of
https://github.com/ModernRelay/omnigraph.git
synced 2026-06-15 01:55:13 +02:00
Recovery liveness, storage fault-injection matrix, and one storage implementation over object_store (#203)
* test(engine): pin the long-lived-handle heal contract for sidecar-covered drift
A Phase B -> Phase C failure (commit_staged advanced Lance HEAD, manifest
publish did not land, recovery sidecar persists) currently wedges every
subsequent staged write on the same engine handle: the commit-time drift
guard rejects with 'run omnigraph repair', but repair itself refuses
while a recovery sidecar is pending, so a long-lived server can only
recover by restart. The documented contract (writes.md 'Long-running
servers', invariants.md invariant 5) says refresh-time roll-forward
closes this residual without restart -- but no write path runs it.
Two red tests pin the intended contract at the write entry points:
a follow-up load (the POST /ingest shape: shared handle, no reopen)
and a follow-up mutation must heal roll-forward-eligible sidecars
in-process and then succeed.
Currently failing with:
table 'node:Company' has Lance HEAD version 2 ahead of manifest
version 1; run `omnigraph repair` before writing
The fix lands in the next commit.
* fix(engine): heal pending recovery sidecars at the staged-write entry points
Close the long-lived-process gap in the recovery protocol: a Phase B ->
Phase C residual (per-table commit_staged landed, manifest publish did
not, sidecar persists) previously recovered only at the next ReadWrite
open or via an explicit refresh() that no production write path called,
so a long-lived server wedged every subsequent write on the commit-time
drift guard until restart.
New recovery::heal_pending_sidecars_roll_forward:
- one list_dir of __recovery/ at write entry (empty -> immediate
return, the steady state), so the per-write cost is one storage list;
- per sidecar, acquires the same per-(table_key, table_branch) write
queues every sidecar writer holds from before write_sidecar until
after delete_sidecar, then re-checks sidecar existence -- this
serializes the heal against live writers instead of rolling an
in-flight sidecar forward from under its writer (which would fail
that writer's publish CAS spuriously). Lock order queues ->
coordinator matches every writer's commit->publish path. This is the
queue-acquisition design recovery.rs and write_queue.rs already
documented for in-process recovery;
- processes in RollForwardOnly mode: the common residual rolls forward
in-process; rollback-eligible sidecars still defer to the next
ReadWrite open (Dataset::restore is unsafe under concurrency).
Wire it into load_as and mutate_as (before the inline delete path can
advance any HEAD), and rebase Omnigraph::refresh onto the same helper
so refresh stops racing live writers' sidecars.
The maintenance entry points (apply_schema_as, branch_merge_as,
ensure_indices) intentionally keep their strict fail-loud preconditions
for now; wiring the same heal there is a follow-up with its own tests.
Turns the previous commit's two red tests green.
* fix(engine): name the right recovery path in the commit-time drift guard
The drift guard's 'run omnigraph repair before writing' advice is a
dead end when the drift is covered by a pending recovery sidecar:
repair refuses while a sidecar is pending. With the write-entry heal in
place, reaching this guard with sidecar-covered drift means the heal
deferred it (rollback-eligible), and the actual recovery path is a
read-write reopen. Distinguish the two classes on the error path only
(one sidecar list, after the conflict is already certain); a listing
failure falls back to the uncovered-drift wording rather than masking
the conflict.
Pinned by extending refresh_defers_rollback_eligible_sidecar_to_next_open
with a write attempt against the deferred sidecar.
* docs: write-entry in-process sidecar heal — contract and coverage
Update the recovery contract docs to match the previous two commits:
invariant 5 now states that the staged-write entry points and refresh
run in-process roll-forward recovery (long-lived processes converge on
the next write, not at restart); writes.md 'Long-running servers'
describes the heal's queue-acquisition concurrency contract, the
improved drift-guard error, and the entry points that intentionally do
not heal yet; testing.md indexes the new failpoint tests; AGENTS.md
capability matrix drops the claim that in-process recovery is entirely
future work (only the rollback path remains with the background
reconciler).
* test(engine): pin the entry heal contract for schema apply and branch merge
Without the write-entry heal, the two maintenance writers do worse than
wedge on sidecar-covered drift -- they proceed and decide its fate
implicitly:
- schema apply re-plans table rewrites from the manifest pin, orphaning
the drifted Phase-B commit (its rows silently vanish from the
rewritten table) while the stale sidecar lingers to misclassify
against the post-apply pins;
- branch merge publishes over the drift, making the failed writer's
commit visible as an unattributed side effect (no recovery audit
row), and leaves the stale sidecar behind.
Two red tests pin the intended contract: both entry points heal the
sidecar first (attributed roll-forward), then run on the converged
state. Currently failing on the stale-sidecar / dropped-rows
assertions; the fix lands in the next commit.
* fix(engine): heal pending recovery sidecars at the schema-apply and branch-merge entries
Extend the write-entry heal to the remaining two write entry points.
Unlike load/mutate (which wedge on the drift guard), these proceeded
over sidecar-covered drift and decided its fate implicitly:
- schema apply re-planned table rewrites from the manifest pin,
orphaning the drifted Phase-B commit -- its rows silently vanished
from the rewritten table -- while the stale sidecar lingered to
misclassify against the post-apply pins;
- branch merge published over the drift, making the failed writer's
commit visible without a recovery audit row, and left the stale
sidecar behind.
Both now run the same queue-serialized roll-forward heal at entry,
before their own sidecar exists, so recovery is attributed (audit row)
and deterministic. ensure_indices stays heal-free: it runs inside the
load / schema-apply flows after their entry heal.
Turns the previous commit's two red tests green. Docs updated in the
same change (invariant 5, writes.md, testing.md, AGENTS.md).
* test(engine): pin Phase A sidecar-write failure semantics
Storage fault-injection matrix, row 1: a sidecar PUT failure (S3
PutObject / fs write) in Phase A. New failpoint recovery.sidecar_write
at the top of write_sidecar -- the single choke point all five sidecar
writers go through -- models the storage error backend-generically.
Also adds the other three storage-fault failpoints used by the
following commits (recovery.sidecar_delete, recovery.sidecar_list,
recovery.record_audit); each is a no-op without the failpoints feature.
Pinned contract: every writer writes its sidecar BEFORE its first
HEAD-advancing commit, so a put failure aborts with zero drift (no
sidecar, Lance HEAD == manifest pin, no rows) and a transient fault
never wedges the graph -- the same handle writes/merges normally once
it clears. Covered for load (the staging writer) and branch_merge (the
multi-table writer, forced onto the RewriteMerged path by diverging
both sides).
* test(engine): pin Phase D delete, list, and audit-append storage-fault semantics
Storage fault-injection matrix, rows 2/3/5, plus the real-backend run:
- recovery.sidecar_delete: a Phase D delete failure (S3 DeleteObject)
must NOT fail the user's write -- the manifest publish already
landed, so the caller's data is durable. The swallowed failure
leaves a stale sidecar; the next write's entry heal consumes it via
the stale-sidecar audit-recovery path (RolledForward, attributed).
- recovery.sidecar_list: a __recovery/ list failure (S3 ListObjectsV2)
is loud at every consumer -- the write-entry heal fails the write
and the open-time sweep fails the open. Silently skipping recovery
over a pending sidecar would be consumer tolerance of drift. Once
the fault clears, open recovers the pending sidecar normally.
- recovery.record_audit: an audit write failure after the
roll-forward's manifest publish aborts that recovery attempt and
keeps the sidecar; re-entry detects the already-published manifest,
records exactly ONE RolledForward audit row, and converges -- the
retry tolerance documented on record_audit, exercised end-to-end.
- s3_load_recovers_after_publisher_failure_without_reopen: the
same-handle heal scenario on a real bucket (gated on
OMNIGRAPH_S3_TEST_BUCKET, skips locally), exercising sidecar
put/list/delete through S3StorageAdapter instead of the local-FS
adapter. CI wiring lands in a follow-up commit.
* test(engine): refuse corrupt recovery sidecars loudly
Storage fault-injection matrix, row 4 (no failpoint needed -- the
corrupt file is written by hand, sibling to the unknown-schema-version
refusal test): a truncated/garbage __recovery/{ulid}.json must be
refused loudly by both the write-entry heal (the write fails naming
the parse error) and the open-time sweep (ReadWrite open fails naming
the file), with the file left on disk for operator inspection.
Read-only opens still work -- the sweep is skipped there.
* test(engine): run the S3 sidecar-lifecycle coverage in CI + document the fault matrix
- ci.yml rustfs_integration: new step running the bucket-gated
failpoints tests (name filter s3_) against the RustFS container, so
sidecar put/list/delete are exercised through S3StorageAdapter on
every storage-affecting PR.
- writes.md: sidecar I/O failure semantics -- Phase A put failure
aborts with zero drift; Phase D delete failure is swallowed (write
already durable) and healed by the next write; list failures are
loud at heal and open; corrupt sidecars are refused with the file
kept for inspection; audit-append failures are retried to exactly
one audit row.
- testing.md: index the storage-fault matrix in the failpoints.rs row
and the new RustFS CI line.
* test(engine): pin read-visibility of acknowledged local if-absent writes
The cluster lib test import_missing_state_creates_state_with_graph_-
observation flakes at ~50% under full-workspace load ('EOF while
parsing a value' reading back the state.json its own import just
acknowledged). Root cause is in the engine's local storage adapter:
write_text_if_absent writes through a buffered tokio::fs::File and
returns when write_all resolves -- which, per tokio's documented File
semantics, means the bytes reached tokio's internal buffer, not the
file. The actual write completes in a background blocking task after
drop, so a caller that acknowledges success and reads the object back
can see an empty or partial file. Under load the window widens; the
red run fails at iteration 0 with 0 of 8192 bytes on disk.
The regression test pins the contract at the adapter boundary: when
write_text_if_absent resolves, the full contents are visible to any
reader; a losing second claim leaves the winner's object untouched.
The fix lands in the next commit.
* fix(engine): publish local storage writes with atomic visibility
Close the class, not the instance. The local adapter admitted three
ways for a reader to observe a write that was acknowledged or visible
before its bytes were complete:
1. write_text_if_absent acknowledged success when the buffered
tokio::fs::File write_all resolved -- i.e. when the bytes reached
tokio's internal buffer, not the file. A caller reading back its own
acknowledged write could see an empty object (the ~50% cluster
import flake under full-workspace load; the regression test failed
at iteration 0 with 0 of 8192 bytes visible).
2. The same call published its CLAIM (create_new) before its CONTENT,
so concurrent readers saw an empty claimed file in the window.
3. write_text (plain tokio::fs::write) exposed truncated content
mid-replace -- silently falsifying write_sidecar's 'readers either
see the complete sidecar or none' contract on local FS (true on S3,
where PutObject is atomic).
A flush in write_text_if_absent would have fixed only (1). Instead,
both local write paths now publish complete temp files atomically:
rename for replace (write_text -- the idiom write_text_if_match
already used) and hard_link for no-replace (write_text_if_absent --
link fails AlreadyExists, so exactly one of N concurrent claimants
wins and the winner's object is fully readable at the instant it
becomes visible). The local adapter now honors the same object-level
atomic-visibility contract as the S3 adapter, which is what every
caller (recovery sidecar protocol, cluster state CAS) was written
against. Crash-orphaned *.tmp.* files are inert: the sidecar sweep
filters to .json, and cluster state reads address state.json by name.
fsync/durability policy is unchanged (no fsync before, none now);
this fix is about visibility ordering, not power-loss durability.
Pre-existing on main (landed with the multi-graph server mode change,
PR #119); surfaced by this branch's heal work only because one extra
list_dir per write shifted test timing. Cluster lib suite: 12/25
failures before, 0/25 after. Turns the previous commit's red test
green.
* refactor(engine): one storage implementation over object_store for every backend
Collapse LocalStorageAdapter (hand-rolled tokio::fs) and
S3StorageAdapter into a single ObjectStorageAdapter backed by
Arc<dyn object_store::ObjectStore> -- LocalFileSystem for local URIs,
the existing AmazonS3 build for s3://, plus a pub in_memory()
constructor (full contract including TRUE conditional updates; the
in-memory test backend testing.md asked for at the adapter level).
Why: the acknowledged-before-visible bug showed the two-impl shape has
no referee -- one prose contract, two independent answers. Upstream
LocalFileSystem::put_opts is byte-for-byte the staged-temp+rename/
hard_link idiom that fix converged on, and Lance's own commit protocol
is built on the same primitives (put-if-not-exists / rename-if-not-
exists), so the substrate-aligned move is to stop hand-rolling it.
The per-backend residue shrinks to a UriCodec (URI <-> object path)
and one capability flag.
Semantics preserved by construction, with three deliberate deltas:
- exists() is now object-store-semantics everywhere (head + non-empty
prefix fallback): an EMPTY local directory no longer 'exists'. The
only dir-shaped caller (_graph_commits.lance probes) self-heals via
ensure_commit_graph_initialized where it previously wedged loudly.
- A directory at an object path reads as NotFound, not as an IO error
('only objects exist'). The cluster unreadable-payload test used a
same-named directory as a portable non-NotFound trigger; it now uses
chmod 000, which still models genuine transient IO.
- write_text_if_match keeps content-token semantics on local
(PutMode::Update is NotImplemented upstream for LocalFileSystem in
0.12.5 and 0.13.2); the capability flag gates the token SOURCE in
read_text_versioned too -- an ETag token with content-compare writes
would lose every CAS.
delete_prefix keeps a local remove_dir_all branch: directories are a
local-FS concept, and list+delete would leave empty skeletons that
cluster graph_root_exists (raw Path::exists) reports as still present.
LocalStorageAdapter remains as a delegating shim so the pinned
contract tests gate this swap textually unchanged; the shim and the
test parameterization over local + in-memory land next. Cargo gains
the explicit 'fs' feature (already transitively enabled by lance).
* test(engine): one executable storage contract, run against every backend
Remove the LocalStorageAdapter delegation shim and migrate its
construction sites to ObjectStorageAdapter::local(). Replace the
per-backend duplicated tests with a single contract_suite asserting
the trait's promises (atomic replace, exists incl. the dataset-root
prefix probe, one-winner if_absent, versioned CAS with loud CAS-lost,
rename, list round-trip with no sibling-prefix bleed, idempotent
delete/delete_prefix), run against the local backend and the new
in-memory backend -- which implements true conditional updates, so the
strong-CAS path is exercised without a bucket. The bucket-gated S3
variant already exists (s3_adapter_conditional_writes_contract).
New local-specific pins for the deliberate semantic edges of the
collapse: empty directories are not objects (exists=false; the Lance
dataset-root probe shape is the non-empty case), file://-anchored and
spaces-in-path list output round-trips byte-identically into
read_text, dot-segment paths are lexically absolutized (the CLI's
./graph.omni shape), and upstream rename creating missing destination
parents. The acknowledged-write visibility regression test stays, now
documenting that the cross-API std::fs read-back is the point.
* refactor(cluster): drop put_json's per-backend atomicity branch
The local temp+rename dance predates the storage adapter guaranteeing
atomic visibility; now that write_text publishes via a staged temp +
rename on the filesystem (and a single atomic PUT on object stores) by
contract, the branch duplicated upstream behavior. One call, both
backends.
* docs: storage adapter collapse — contract, in-memory backend, local CAS gap
- testing.md: the 'no MemStorage backend' note is half-closed —
ObjectStorageAdapter::in_memory() covers the text-object layer with
the full contract (true conditional updates); Lance datasets bypass
the adapter, so the engine substrate ask stays open.
- invariants.md: truth-matrix Tests row updated; new Known Gap for
local write_text_if_match (upstream PutMode::Update is unimplemented
for LocalFileSystem; content-token emulation is safe only under the
cluster lock protocol — close before admitting a lock-free caller).
- writes.md: backend notes for the unified adapter (name#N staging
residue invisible to the sweep, backend-wrapped error text with
exists()-probing for missing-vs-error, loud permission failures).
* docs: finish renaming the storage adapters in user docs and test comments
storage.md's URI-scheme table and the S3 failpoint test's doc comment
still named the deleted LocalStorageAdapter/S3StorageAdapter; both now
describe the unified ObjectStorageAdapter over object_store, including
the relative-path absolutization note for local URIs.
* test(engine): pin branch-awareness of the drift guard's recovery advice
A pending sidecar on ANOTHER branch does not cover this branch's
drift: with a deferred feature-branch sidecar on disk and genuinely
uncovered drift on main, the main write's error must still point at
omnigraph repair -- a read-write reopen recovers the sidecar but
cannot repair main's uncovered drift. Currently red: the guard
matches sidecar pins by table_key only, so the feature sidecar flips
main's advice to the reopen path. Fix in the next commit.
Surfaced by external review of the drift-guard change.
* fix(engine): branch-aware sidecar matching in the drift guard's advice
The commit-time drift guard's sidecar-covered check matched pins by
table_key alone, so a pending sidecar on another branch flipped this
branch's uncovered-drift advice from 'run omnigraph repair' to the
reopen path -- and a reopen recovers that sidecar but cannot repair
this branch's drift. Compare the pin's table_branch too. Turns the
previous commit's red test green.
Surfaced by external review of the drift-guard change.
* test(engine): pin heal non-interference with a live schema apply
The write-entry heal's schema-staging reconcile runs before any queue
acquisition, so a load on the same handle, overlapping a schema apply
parked between its staging write and manifest commit, promotes the
apply's staging files (new catalog live against the old manifest),
classifies the LIVE apply's sidecar, and publishes its registrations
out from under it. The resumed apply then collides with its own stolen
commit. Currently red with:
Lance("Concurrent modification: table version 3 already exists for
node:Tag")
The fix (per-sidecar reconcile under the sidecar's write-queue guards,
plus a serialization key the schema-apply writer and the heal both
acquire) lands in the next commit.
Surfaced by external review of the write-entry heal.
* fix(engine): serialize the heal's schema-staging reconcile with live schema applies
The write-entry heal ran recover_schema_state_files up front, before
acquiring any queue guards. Overlapping a live schema apply parked
between its staging write and manifest commit, the heal promoted the
apply's staging files (new catalog live against the old manifest),
classified the LIVE apply's sidecar, and published its registrations —
the resumed apply then collided with its own stolen commit.
Correct by construction:
- New schema-apply serialization queue key, acquired by the schema-
apply writer (alongside its per-table keys) from before write_sidecar
until after delete_sidecar. Per-table keys alone don't cover a
registration-only migration, which pins no existing tables but has a
sidecar and staging files on disk.
- The heal reconciles schema staging lazily, PER SchemaApply sidecar,
after acquiring that sidecar's guards (including the serialization
key) and re-confirming the sidecar exists — a sidecar that survives
the queue wait belongs to a dead writer, so the reconcile can no
longer race a live apply. Recomputing per sidecar also removes the
staleness of one up-front result across a multi-sidecar pass.
- Omnigraph::refresh drops its up-front reconcile-and-pass-through
(same race, and a pre-promoted result would make the heal's guarded
reconcile see clean staging and wrongly defer the sidecar): it now
reconciles standalone only when NO sidecar exists — which cannot
race a live apply, whose sidecar always precedes its staging files —
and otherwise defers entirely to the heal.
The open-time sweep keeps its precomputed reconcile: open has no
concurrent writers. Turns the previous commit's red test green.
Surfaced by external review of the write-entry heal.
Self-audit addendum folded in: refresh's no-sidecar gate had a TOCTOU
(a live apply could write its sidecar + staging between the empty
check and the reconcile) — the standalone reconcile now holds the
serialization key across the list-then-reconcile pair. The remaining
residual is cross-process only (in-process queues cannot serialize
against a writer in another process; the open-time sweep has the same
pre-existing exposure) and is now an explicit Known Gap in
invariants.md rather than an implicit one.
* test(engine): pin catalog reload after the heal recovers a schema apply
When the write-entry heal rolls a crashed apply's SchemaApply sidecar
forward on the same handle, disk and manifest move to the new schema
(staging promoted, registrations published) but the handle's in-memory
schema_source/catalog do not. Subsequent writes then validate against
the stale catalog and reject rows of types the graph already has.
Currently red with:
record 1: unknown node type 'Tag'
refresh() reloads after its heal; the write entry points must too.
Fix in the next commit.
Surfaced by external review of the write-entry heal.
* fix(engine): reload the in-memory catalog after the heal recovers a schema apply
heal_pending_recovery_sidecars refreshed the coordinator and
invalidated the runtime cache after processing sidecars, but never
reloaded schema_source/catalog — so a write whose entry heal rolled a
crashed SchemaApply sidecar forward proceeded to validate against the
OLD schema while disk and manifest were already on the new one.
reload_schema_if_source_changed is the same post-heal step refresh()
already runs; it no-ops on the (overwhelmingly common) non-schema heal
because the on-disk source is unchanged. Turns the previous commit's
red test green.
Surfaced by external review of the write-entry heal.
* test(engine): pin that a deleted-branch sidecar cannot wedge the graph
A rollback-eligible sidecar pinned to a branch is deferred by every
roll-forward-only pass; if the branch is then deleted, the sidecar
survives, referencing a branch with no manifest tree. The heal (every
write entry) and the open-time sweep (every ReadWrite open) both fail
opening the dead branch, and repair refuses while a sidecar is pending
-- a terminal read-only state with manual sidecar surgery as the only
exit. Currently red with:
Lance("Not found: .../__manifest/tree/feature/_versions")
The branch's tree and forks are already reclaimed, so the pinned drift
is unreachable and the sidecar is provably moot; the fix classifies it
as an orphaned-branch terminal state (audit + discard) in both passes.
Surfaced by review (P1, verified by repro).
* fix(engine): classify deleted-branch sidecars as orphaned instead of wedging
A deferred (rollback-eligible) sidecar pinned to a branch survives
branch_delete; both the write-entry heal and the open-time sweep then
failed unconditionally opening the dead branch -- every write and
every ReadWrite open errored, and repair refuses while a sidecar
pends. Terminal state, manual sidecar surgery the only exit.
The branch's tree and per-table forks are already reclaimed at delete,
so the drift the sidecar pins is unreachable and the sidecar is
provably moot. Both passes now check the sidecar's branch against the
manifest's branch list (the authority -- deliberately NOT inferred
from a Not-found on open, which could be a transient storage error
masking real recovery intent) and discard orphans with an
OrphanedBranchDiscarded audit row, commit appended on main since the
sidecar's own branch no longer has a commit graph.
The open-time half is pre-existing; the write-entry heal made it hot.
Turns the previous commit's red test green.
Surfaced by review (P1, verified by repro).
* chore: harden review nits — vacuous CI filter, root-runner skip, liveness note
- ci.yml: the RustFS sidecar-lifecycle step now fails loudly if the
's3_' name filter matches zero tests (cargo passes vacuously on an
empty filter; the step exists specifically to prove S3 sidecar I/O
coverage). The pre-existing CLI smoke step has the same shape and is
left for a follow-up.
- cluster unreadable-payload test: cfg(unix) + a skip-with-log when
running as root (mode 000 is still readable to root, common in
container dev runners), so the test degrades instead of failing.
- refresh: document the one-pass-late convergence for legacy staging
residue while non-SchemaApply sidecars pend, so nobody 'fixes' it by
re-running the reconcile unserialized — the exact race the
serialization key closes.
* test(engine): pin orphan-discard idempotency across a delete fault
discard_orphaned_branch_sidecar writes its audit row and main commit
before deleting the sidecar; a Phase D delete fault leaves the sidecar
on disk with the audit already durable, and the retry repeated the
whole path -- a second OrphanedBranchDiscarded audit row (and commit)
for the same operation. Currently red: 2 rows after one fault + retry.
The retry must only finish the delete. Fix next.
Also promotes the recovery-audit kinds reader into the shared test
helpers (it was recovery.rs-local).
Surfaced by external review of the orphan-discard fix.
* fix(engine): orphan-discard idempotency + heal reports acted-vs-deferred
Two review findings on the recovery surface:
- discard_orphaned_branch_sidecar now checks the audit table for an
existing (operation_id, OrphanedBranchDiscarded) row before appending
the commit + audit pair, so a Phase D delete fault retries ONLY the
delete instead of duplicating audit rows and commit-graph entries.
Cold path: the list scan runs only when an orphaned sidecar exists.
Turns the previous commit's red test green (exactly one audit row
across fault + retry).
- process_sidecar returns whether durable state changed; the heal sets
processed_any only for sidecars that were actually rolled forward /
rolled back / audit-recovered (orphan discards count). Deferred
sidecars (rollback-eligible, invariant-violating, unpromoted
SchemaApply) no longer trigger a per-write schema reload + full
runtime-cache invalidation while they pend -- the cache is
snapshot-keyed so this was waste, not corruption, but it was paid on
every write until reopen. Acted-paths' processed=true remains pinned
by load_after_schema_apply_phase_b_failure_uses_recovered_catalog
(the reload depends on it).
Surfaced by external review.
* test(engine): pin the orphan-discard audit-append fault leg as documented tolerance
The orphan discard's commit append and audit append are two writes; a
failure between them leaves a recovery commit with no audit row, and
the retry (keyed on the audit row, the operator-facing record) appends
a second commit before the audit lands. This is the same
not-atomic-pair-write tolerance record_audit documents and the
manifest->commit-graph Known Gap covers for every publish: bounded
commit-graph noise, audit row exactly-once under clean failures.
Keying idempotency on commit rows instead would need an operation_id
column on _graph_commits, and audit-before-commit would dangle the
graph_commit_id join -- both worse than the documented residual.
Make the tolerance explicit instead of implicit: docstring names the
window, a failpoint sits inside it, and the new test pins convergence
across the fault (sidecar consumed, exactly one audit row), completing
the orphan-discard fault matrix alongside the delete-fault leg.
Surfaced by external review of the orphan-discard idempotency.
* test(engine): pin honest drift-guard advice when sidecar listing fails
The guard's unwrap_or(false) conflated 'classified as uncovered' with
'could not classify': a transient list fault on the guard's second
list (the entry heal's first list having succeeded) confidently routed
the operator to omnigraph repair even when the heal had just deferred
a rollback-eligible sidecar -- and repair refuses while a sidecar is
pending. Currently red: the error says 'run omnigraph repair' with no
mention of the reopen path. The fix names both paths plus the failure
cause when classification is impossible.
Surfaced by external review of the drift-guard fallback.
* fix(engine): admit ambiguity in the drift guard when sidecar listing fails
Replace the unwrap_or(false) fallback with a tri-state: covered ->
reopen advice; uncovered -> repair advice; listing FAILED -> say the
drift could not be classified, name the cause, and give both paths in
order ('run repair, or reopen read-write if repair reports a pending
sidecar'). The old fallback confidently routed a transient list fault
to repair, which refuses while a sidecar is pending -- a self-
correcting but pointless detour. The conflict itself is still always
raised; only the advice degrades honestly. Turns the previous commit's
red test green.
Surfaced by external review of the drift-guard fallback.
This commit is contained in:
Ragnor Comerford
GitHub
parent
e0d80c0062
commit
446b46d548
22 changed files with 2778 additions and 549 deletions
14
.github/workflows/ci.yml
vendored
14
.github/workflows/ci.yml
vendored
|
|
@ -365,6 +365,20 @@ jobs:
|
|||
- name: Run RustFS CLI smoke
|
||||
run: cargo test --locked -p omnigraph-cli --test system_local local_cli_s3_end_to_end_init_load_read_flow -- --nocapture
|
||||
|
||||
- name: Run RustFS recovery-sidecar lifecycle
|
||||
# Sidecar put/list/delete through the S3 storage backend on a
|
||||
# real bucket (the failpoint only wedges the publisher; the
|
||||
# sidecar I/O is exercised for real). Name filter `s3_` matches
|
||||
# the bucket-gated tests in the failpoints target only; the
|
||||
# grep guards against the filter going vacuous (cargo passes
|
||||
# with 0 tests matched) if those tests are ever renamed.
|
||||
run: |
|
||||
output=$(cargo test --locked -p omnigraph-engine --features failpoints --test failpoints s3_ -- --nocapture 2>&1); status=$?
|
||||
echo "$output"
|
||||
[ "$status" -eq 0 ] || exit "$status"
|
||||
echo "$output" | grep -Eq "test result: ok\. [1-9][0-9]* passed" \
|
||||
|| { echo "::error::filter 's3_' matched no tests — vacuous pass"; exit 1; }
|
||||
|
||||
- name: Dump RustFS logs on failure
|
||||
if: failure()
|
||||
run: docker logs rustfs
|
||||
|
|
|
|||
|
|
@ -240,7 +240,7 @@ omnigraph policy explain --actor act-alice --action change --branch main
|
|||
| Columnar storage on object store | ✅ Arrow/Lance | URI normalization, S3 env-var plumbing |
|
||||
| Per-dataset versioning + time travel | ✅ | `snapshot_at_version`, `entity_at`, snapshot-pinned reads across many tables |
|
||||
| Per-dataset branches | ✅ | **Graph-level** branches (atomic across all sub-tables), lazy fork, system branch filtering |
|
||||
| Atomic single-dataset commits | ✅ | **Multi-table publish via three layers**, NOT a single Lance primitive: (1) per-table Lance `commit_staged` for the data write, (2) `__manifest` row-level CAS via `ManifestBatchPublisher` for cross-table ordering, (3) the open-time recovery sweep for the residual gap between (1) and (2). All three layers ship; the five migrated writers (`MutationStaging::finalize`, `schema_apply`, `branch_merge`, `ensure_indices`, `optimize_all_tables`) write a `__recovery/{ulid}.json` sidecar before Phase B and delete it after Phase C. The next `Omnigraph::open` (gated on `OpenMode::ReadWrite`) runs the sweep in `db/manifest/recovery.rs`: classify, decide all-or-nothing per sidecar, roll forward via single `ManifestBatchPublisher::publish` or roll back via `Dataset::restore` followed by a manifest publish of the restored version (so both directions converge to `manifest == HEAD` — no residual drift), and record an audit row in `_graph_commit_recoveries.lance` (queryable via `omnigraph commit list --filter actor=omnigraph:recovery`). Continuous in-process recovery (no restart needed between Phase B failure and recovery) is the goal of a future background reconciler. Engine writes route through a sealed `TableStorage` trait (`db.storage()`) exposing only `stage_*` + `commit_staged` + reads; the inline-commit residuals (`delete_where`, `create_vector_index`) are split onto a separate sealed `InlineCommitResidual` trait reached via `db.storage_inline_residual()` (MR-854), so the default surface cannot couple a write with a HEAD advance — §1 holds by construction. `delete_where` and `create_vector_index` stay inline until upstream Lance ships a public two-phase API ([#6658](https://github.com/lance-format/lance/issues/6658), [#6666](https://github.com/lance-format/lance/issues/6666)); `LoadMode::Overwrite` uses Lance `Overwrite` staged transactions. |
|
||||
| Atomic single-dataset commits | ✅ | **Multi-table publish via three layers**, NOT a single Lance primitive: (1) per-table Lance `commit_staged` for the data write, (2) `__manifest` row-level CAS via `ManifestBatchPublisher` for cross-table ordering, (3) the open-time recovery sweep for the residual gap between (1) and (2). All three layers ship; the five migrated writers (`MutationStaging::finalize`, `schema_apply`, `branch_merge`, `ensure_indices`, `optimize_all_tables`) write a `__recovery/{ulid}.json` sidecar before Phase B and delete it after Phase C. The next `Omnigraph::open` (gated on `OpenMode::ReadWrite`) runs the sweep in `db/manifest/recovery.rs`: classify, decide all-or-nothing per sidecar, roll forward via single `ManifestBatchPublisher::publish` or roll back via `Dataset::restore` followed by a manifest publish of the restored version (so both directions converge to `manifest == HEAD` — no residual drift), and record an audit row in `_graph_commit_recoveries.lance` (queryable via `omnigraph commit list --filter actor=omnigraph:recovery`). The write entry points (`load_as`, `mutate_as`, `apply_schema_as`, `branch_merge_as`) and `refresh` additionally run an in-process roll-forward-only heal (serialized against live writers via the per-table write queues), so a long-lived server converges on its next write without restart; only rollback-eligible sidecars still defer to the next read-write open (a future background reconciler's goal). Engine writes route through a sealed `TableStorage` trait (`db.storage()`) exposing only `stage_*` + `commit_staged` + reads; the inline-commit residuals (`delete_where`, `create_vector_index`) are split onto a separate sealed `InlineCommitResidual` trait reached via `db.storage_inline_residual()` (MR-854), so the default surface cannot couple a write with a HEAD advance — §1 holds by construction. `delete_where` and `create_vector_index` stay inline until upstream Lance ships a public two-phase API ([#6658](https://github.com/lance-format/lance/issues/6658), [#6666](https://github.com/lance-format/lance/issues/6666)); `LoadMode::Overwrite` uses Lance `Overwrite` staged transactions. |
|
||||
| Compaction (`compact_files`) | ✅ | `omnigraph optimize` orchestrates over all node/edge tables, bounded concurrency; **publishes each compacted table's new version to `__manifest`** (so the manifest tracks the Lance HEAD — required for reads to observe compaction and for schema apply / strict writes to pass their HEAD-vs-manifest precondition), under the per-`(table, main)` write queue with `SidecarKind::Optimize` recovery coverage; **refuses on an unrecovered graph** (errors if a `__recovery` sidecar is pending); **skips uncovered HEAD > manifest drift** with `DriftNeedsRepair` instead of interpreting it; **skips blob-bearing tables** (reported via `TableOptimizeStats.skipped`, not silent), gated on `LANCE_SUPPORTS_BLOB_COMPACTION` until the upstream blob-v2 compaction-decode bug is fixed (see [docs/dev/invariants.md](docs/dev/invariants.md) Known Gaps) |
|
||||
| Repair uncovered drift | — | `omnigraph repair` explicitly classifies uncovered table `HEAD > manifest` drift: verified maintenance drift (`ReserveFragments`/`Rewrite`) can be published with `--confirm`; suspicious or unverifiable drift requires `--force --confirm`. Sidecar-covered crash residuals still recover automatically on open. |
|
||||
| Cleanup (`cleanup_old_versions`) | ✅ | `omnigraph cleanup` with `--keep` / `--older-than` policy |
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ base64 = "0.22"
|
|||
ariadne = "0.4"
|
||||
regex = "1"
|
||||
reqwest = { version = "0.12", default-features = false, features = ["json", "rustls-tls"] }
|
||||
object_store = { version = "0.12.5", default-features = false, features = ["aws"] }
|
||||
object_store = { version = "0.12.5", default-features = false, features = ["aws", "fs"] }
|
||||
fail = "0.5"
|
||||
time = { version = "0.3", features = ["formatting"] }
|
||||
axum = { version = "0.8", features = ["json", "macros"] }
|
||||
|
|
|
|||
|
|
@ -169,31 +169,16 @@ impl ClusterStore {
|
|||
.map_err(|err| err.to_string())
|
||||
}
|
||||
|
||||
/// JSON object write with the strongest atomicity the backend offers:
|
||||
/// temp + rename on the filesystem (no torn JSON after a crash; the
|
||||
/// pre-port behavior), a single atomic PUT on object stores (where
|
||||
/// copy+delete would be weaker, not stronger).
|
||||
/// JSON object write. Atomic visibility is the storage adapter's
|
||||
/// contract on every backend (staged temp + rename on the filesystem,
|
||||
/// a single atomic PUT on object stores) — no torn JSON after a crash,
|
||||
/// no per-backend branch needed here.
|
||||
async fn put_json(&self, relative: &str, payload: &str) -> Result<(), String> {
|
||||
let target = self.uri(relative);
|
||||
match self.kind() {
|
||||
StorageKind::Local => {
|
||||
let tmp = format!("{target}.tmp.{}", Ulid::new());
|
||||
self.adapter
|
||||
.write_text(&tmp, payload)
|
||||
.await
|
||||
.map_err(|err| err.to_string())?;
|
||||
if let Err(err) = self.adapter.rename_text(&tmp, &target).await {
|
||||
let _ = self.adapter.delete(&tmp).await;
|
||||
return Err(err.to_string());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
StorageKind::S3 => self
|
||||
.adapter
|
||||
.write_text(&target, payload)
|
||||
.await
|
||||
.map_err(|err| err.to_string()),
|
||||
}
|
||||
self.adapter
|
||||
.write_text(&target, payload)
|
||||
.await
|
||||
.map_err(|err| err.to_string())
|
||||
}
|
||||
|
||||
/// Shared list-and-parse for the sidecar/approval directories: id
|
||||
|
|
|
|||
|
|
@ -1950,13 +1950,29 @@ graphs:
|
|||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[cfg(unix)]
|
||||
async fn refresh_flags_unreadable_payload_as_error() {
|
||||
let dir = fixture();
|
||||
init_derived_graph(dir.path()).await;
|
||||
let blob = converge_fixture(dir.path()).await;
|
||||
// A same-named directory yields a non-NotFound IO error portably.
|
||||
fs::remove_file(&blob).unwrap();
|
||||
fs::create_dir(&blob).unwrap();
|
||||
// Make the payload unreadable without removing it: permission
|
||||
// denied is a genuine non-NotFound IO error. (A same-named
|
||||
// directory no longer triggers this path: object-store semantics
|
||||
// classify a directory at an object path as NotFound — "only
|
||||
// objects exist" — which is the missing-payload case, not the
|
||||
// unreadable one.)
|
||||
let mut perms = fs::metadata(&blob).unwrap().permissions();
|
||||
std::os::unix::fs::PermissionsExt::set_mode(&mut perms, 0o000);
|
||||
fs::set_permissions(&blob, perms).unwrap();
|
||||
// Root reads straight through mode 000 (container dev runners
|
||||
// commonly run as root): skip rather than fail — the contract
|
||||
// under test needs a genuine permission error.
|
||||
if fs::read(&blob).is_ok() {
|
||||
eprintln!(
|
||||
"skipping refresh_flags_unreadable_payload_as_error: running as root (mode 000 is still readable)"
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
let out = refresh_config_dir(dir.path()).await;
|
||||
assert!(!out.ok);
|
||||
|
|
|
|||
|
|
@ -36,7 +36,8 @@ use publisher::{GraphNamespacePublisher, ManifestBatchPublisher};
|
|||
pub(crate) use recovery::{
|
||||
RecoveryMode, RecoverySidecar, RecoverySidecarHandle, SidecarKind, SidecarTablePin,
|
||||
SidecarTableRegistration, SidecarTombstone, delete_sidecar, has_schema_apply_sidecar,
|
||||
list_sidecars, new_sidecar, recover_manifest_drift, write_sidecar,
|
||||
heal_pending_sidecars_roll_forward, list_sidecars, new_sidecar, recover_manifest_drift,
|
||||
schema_apply_serial_queue_key, write_sidecar,
|
||||
};
|
||||
pub use state::SubTableEntry;
|
||||
#[cfg(test)]
|
||||
|
|
|
|||
|
|
@ -28,10 +28,11 @@
|
|||
//! CreateIndex/Merge — see `check_restore_txn` at lance-6.0.1
|
||||
//! `src/io/commit/conflict_resolver.rs:986`. The hazard is documented
|
||||
//! by `tests/staged_writes.rs::lance_restore_loses_to_concurrent_append_via_orphaning`.
|
||||
//! This module sidesteps the hazard by running recovery only at
|
||||
//! `Omnigraph::open` (before any other writers can race). A future
|
||||
//! continuous in-process recovery reconciler will need to guard via
|
||||
//! per-(table_key, branch) queue acquisition.
|
||||
//! The open-time sweep sidesteps the hazard by running before any
|
||||
//! other writers can race; the in-process heal
|
||||
//! ([`heal_pending_sidecars_roll_forward`]) never restores (roll-
|
||||
//! forward only) and guards via per-(table_key, branch) queue
|
||||
//! acquisition.
|
||||
|
||||
use std::collections::HashMap;
|
||||
|
||||
|
|
@ -316,8 +317,8 @@ pub(crate) fn sidecar_uri(root_uri: &str, operation_id: &str) -> String {
|
|||
/// Write a sidecar atomically and return a handle for later deletion.
|
||||
///
|
||||
/// The atomicity contract is inherited from [`StorageAdapter::write_text`]:
|
||||
/// LocalStorageAdapter writes via `tokio::fs::write` (whole-file replace);
|
||||
/// S3StorageAdapter writes via PutObject (atomic at the object level).
|
||||
/// the local backend publishes via a staged temp file + rename (atomic on
|
||||
/// POSIX); object stores write via PutObject (atomic at the object level).
|
||||
/// Both are sufficient for sidecar semantics — readers either see the
|
||||
/// complete sidecar or none.
|
||||
pub(crate) async fn write_sidecar(
|
||||
|
|
@ -325,6 +326,9 @@ pub(crate) async fn write_sidecar(
|
|||
storage: &dyn StorageAdapter,
|
||||
sidecar: &RecoverySidecar,
|
||||
) -> Result<RecoverySidecarHandle> {
|
||||
// Failpoint: models a storage put failure (S3 PutObject / fs write)
|
||||
// in Phase A — every writer must abort before any HEAD advance.
|
||||
crate::failpoints::maybe_fail("recovery.sidecar_write")?;
|
||||
debug_assert_eq!(sidecar.schema_version, SIDECAR_SCHEMA_VERSION);
|
||||
let uri = sidecar_uri(root_uri, &sidecar.operation_id);
|
||||
let json = serde_json::to_string_pretty(sidecar).map_err(|err| {
|
||||
|
|
@ -342,6 +346,10 @@ pub(crate) async fn delete_sidecar(
|
|||
handle: &RecoverySidecarHandle,
|
||||
storage: &dyn StorageAdapter,
|
||||
) -> Result<()> {
|
||||
// Failpoint: models a storage delete failure (S3 DeleteObject) in
|
||||
// Phase D — callers swallow it (the write already published) and the
|
||||
// stale sidecar is healed by the next write or open.
|
||||
crate::failpoints::maybe_fail("recovery.sidecar_delete")?;
|
||||
storage.delete(&handle.sidecar_uri).await
|
||||
}
|
||||
|
||||
|
|
@ -356,6 +364,10 @@ pub(crate) async fn list_sidecars(
|
|||
root_uri: &str,
|
||||
storage: &dyn StorageAdapter,
|
||||
) -> Result<Vec<RecoverySidecar>> {
|
||||
// Failpoint: models a storage list failure (S3 ListObjectsV2) — every
|
||||
// consumer (open-time sweep, write-entry heal) must fail loudly
|
||||
// rather than silently skipping recovery.
|
||||
crate::failpoints::maybe_fail("recovery.sidecar_list")?;
|
||||
let dir = recovery_dir_uri(root_uri);
|
||||
let mut uris = storage.list_dir(&dir).await?;
|
||||
// Sort by URI so the sweep processes sidecars deterministically.
|
||||
|
|
@ -534,6 +546,240 @@ pub(crate) async fn restore_table_to_version(
|
|||
Ok(())
|
||||
}
|
||||
|
||||
/// In-process heal for pending recovery sidecars — the entry point for
|
||||
/// long-lived handles (`Omnigraph::refresh` and the staged-write entry
|
||||
/// points `load_as` / `mutate_as`).
|
||||
///
|
||||
/// Steady-state cost is one `list_dir` of `__recovery/` (typically
|
||||
/// empty → immediate return), so write entry points can afford to call
|
||||
/// this on every request. When sidecars exist, each is processed in
|
||||
/// `RecoveryMode::RollForwardOnly`: the common Phase B → Phase C
|
||||
/// residual (per-table `commit_staged` landed, manifest publish did
|
||||
/// not) rolls forward in-process; rollback-eligible or invariant-
|
||||
/// violating sidecars are deferred to the next ReadWrite open, exactly
|
||||
/// as `Omnigraph::refresh` documents.
|
||||
///
|
||||
/// Concurrency: unlike the open-time sweep, this runs while other
|
||||
/// writers may be in flight. Every sidecar writer (mutation/load
|
||||
/// finalize, schema_apply, branch_merge, ensure_indices, optimize)
|
||||
/// acquires its per-`(table_key, table_branch)` write queues *before*
|
||||
/// `write_sidecar` and holds them until after `delete_sidecar` — so
|
||||
/// acquiring the same queues here blocks until that writer either
|
||||
/// finished (sidecar deleted; the existence re-check skips it) or died
|
||||
/// (sidecar is genuinely orphaned; safe to process). Without this, the
|
||||
/// heal could observe a live writer's sidecar in its commit→publish
|
||||
/// window, roll it forward, and fail that writer's own publish CAS.
|
||||
/// Lock order is queues → coordinator, matching every writer's
|
||||
/// commit→publish path.
|
||||
///
|
||||
/// The schema-staging reconcile runs lazily, per SchemaApply sidecar,
|
||||
/// AFTER that sidecar's queue guards are held and its existence is
|
||||
/// re-confirmed — never up front. An up-front reconcile can promote a
|
||||
/// LIVE schema apply's staging files and steal its commit (pinned by
|
||||
/// `tests/failpoints.rs::heal_does_not_promote_live_schema_apply_staging`).
|
||||
///
|
||||
/// Returns `true` when at least one sidecar was processed (the caller
|
||||
/// should invalidate per-snapshot caches).
|
||||
pub(crate) async fn heal_pending_sidecars_roll_forward(
|
||||
root_uri: &str,
|
||||
storage: std::sync::Arc<dyn StorageAdapter>,
|
||||
coordinator: &tokio::sync::RwLock<GraphCoordinator>,
|
||||
write_queue: &crate::db::write_queue::WriteQueueManager,
|
||||
) -> Result<bool> {
|
||||
let sidecars = list_sidecars(root_uri, storage.as_ref()).await?;
|
||||
if sidecars.is_empty() {
|
||||
return Ok(false);
|
||||
}
|
||||
let mut processed_any = false;
|
||||
for sidecar in sidecars {
|
||||
// Serialize against a possibly-live writer (see fn docs). Guards
|
||||
// are scoped per sidecar so two sidecars never hold queues
|
||||
// simultaneously (no cross-sidecar lock-order surface).
|
||||
let mut queue_keys: Vec<crate::db::write_queue::TableQueueKey> = sidecar
|
||||
.tables
|
||||
.iter()
|
||||
.map(|pin| (pin.table_key.clone(), pin.table_branch.clone()))
|
||||
.collect();
|
||||
let is_schema_apply = matches!(sidecar.writer_kind, SidecarKind::SchemaApply);
|
||||
if is_schema_apply {
|
||||
// A SchemaApply sidecar's per-table pins don't cover a
|
||||
// registration-only migration (no existing tables touched,
|
||||
// but staging files + a sidecar on disk). The schema-apply
|
||||
// writer holds this serialization key from before its
|
||||
// sidecar write until after its sidecar delete, so blocking
|
||||
// on it — then re-checking sidecar existence — guarantees
|
||||
// the writer is gone before the reconcile below mutates
|
||||
// schema staging.
|
||||
queue_keys.push(schema_apply_serial_queue_key());
|
||||
}
|
||||
let _guards = write_queue.acquire_many(&queue_keys).await;
|
||||
// Re-check after the wait: the writer we blocked on may have
|
||||
// completed Phase C and deleted its sidecar.
|
||||
if !storage
|
||||
.exists(&sidecar_uri(root_uri, &sidecar.operation_id))
|
||||
.await?
|
||||
{
|
||||
continue;
|
||||
}
|
||||
// Schema-staging reconcile, per SchemaApply sidecar, UNDER the
|
||||
// sidecar's guards: a sidecar still on disk after the queue wait
|
||||
// belongs to a dead writer, so promoting its staging files can no
|
||||
// longer race the live apply's own renames or steal its commit.
|
||||
// It also re-runs per sidecar, so a multi-sidecar pass never
|
||||
// classifies against a reconcile result an earlier roll-forward
|
||||
// staled. Non-SchemaApply sidecars never consult the value.
|
||||
let schema_state_recovery = if is_schema_apply {
|
||||
let snapshot = {
|
||||
let mut coord = coordinator.write().await;
|
||||
coord.refresh().await?;
|
||||
coord.snapshot()
|
||||
};
|
||||
crate::db::schema_state::recover_schema_state_files(
|
||||
root_uri,
|
||||
std::sync::Arc::clone(&storage),
|
||||
&snapshot,
|
||||
)
|
||||
.await?
|
||||
} else {
|
||||
SchemaStateRecovery::Noop
|
||||
};
|
||||
// Fresh per-branch snapshot — same rationale as
|
||||
// `recover_manifest_drift`: classify against the branch the
|
||||
// sidecar's writer targeted, refreshed after any prior
|
||||
// sidecar's roll-forward.
|
||||
let branch_snapshot = match sidecar.branch.as_deref() {
|
||||
Some(b) => {
|
||||
// Orphan check against the manifest's branch list (the
|
||||
// authority) BEFORE opening: a deferred sidecar whose
|
||||
// branch was deleted would otherwise wedge every write
|
||||
// on the dead-branch open.
|
||||
let (branch_exists, main_version) = {
|
||||
let mut coord = coordinator.write().await;
|
||||
coord.refresh().await?;
|
||||
let exists = coord.all_branches().await?.iter().any(|name| name == b);
|
||||
(exists, coord.snapshot().version())
|
||||
};
|
||||
if !branch_exists {
|
||||
discard_orphaned_branch_sidecar(
|
||||
root_uri,
|
||||
storage.as_ref(),
|
||||
&sidecar,
|
||||
main_version,
|
||||
)
|
||||
.await?;
|
||||
processed_any = true;
|
||||
continue;
|
||||
}
|
||||
let mut branch_coord =
|
||||
GraphCoordinator::open_branch(root_uri, b, std::sync::Arc::clone(&storage))
|
||||
.await?;
|
||||
branch_coord.refresh().await?;
|
||||
branch_coord.snapshot()
|
||||
}
|
||||
None => {
|
||||
let mut coord = coordinator.write().await;
|
||||
coord.refresh().await?;
|
||||
coord.snapshot()
|
||||
}
|
||||
};
|
||||
if process_sidecar(
|
||||
root_uri,
|
||||
storage.as_ref(),
|
||||
&branch_snapshot,
|
||||
&sidecar,
|
||||
RecoveryMode::RollForwardOnly,
|
||||
schema_state_recovery,
|
||||
)
|
||||
.await?
|
||||
{
|
||||
processed_any = true;
|
||||
}
|
||||
}
|
||||
// Re-read coordinator state so the caller's handle observes the
|
||||
// post-heal manifest.
|
||||
coordinator.write().await.refresh().await?;
|
||||
Ok(processed_any)
|
||||
}
|
||||
|
||||
/// Discard a sidecar whose branch no longer exists in the manifest (the
|
||||
/// authority — callers must key the orphan classification off the branch
|
||||
/// LIST, never off a `Not found` from an open, which could be a transient
|
||||
/// storage error masking real recovery intent). The branch's tree and
|
||||
/// per-table forks are already reclaimed, so the drift the sidecar pins is
|
||||
/// unreachable and the sidecar is provably moot; leaving it would wedge
|
||||
/// every heal (write entry) and every ReadWrite open on a dead-branch
|
||||
/// open, with `repair` refusing while it pends. Records an
|
||||
/// `OrphanedBranchDiscarded` audit row (commit appended on main — the
|
||||
/// sidecar's own branch has no commit graph anymore).
|
||||
async fn discard_orphaned_branch_sidecar(
|
||||
root_uri: &str,
|
||||
storage: &dyn StorageAdapter,
|
||||
sidecar: &RecoverySidecar,
|
||||
manifest_version: u64,
|
||||
) -> Result<()> {
|
||||
warn!(
|
||||
operation_id = sidecar.operation_id.as_str(),
|
||||
writer_kind = ?sidecar.writer_kind,
|
||||
branch = sidecar.branch.as_deref().unwrap_or("<none>"),
|
||||
"recovery: discarding sidecar for a deleted branch (drift unreachable; audit recorded)"
|
||||
);
|
||||
let mut audit = RecoveryAudit::open(root_uri).await?;
|
||||
// Idempotency across a Phase D delete fault: the audit row + commit
|
||||
// land before the sidecar delete, so a failed delete re-enters here
|
||||
// with the audit already durable. Append only once per operation —
|
||||
// the retry's sole remaining job is finishing the delete. (Cold
|
||||
// path: the list scan runs only when an orphaned sidecar exists.)
|
||||
//
|
||||
// Documented residual: the commit append and the audit append are
|
||||
// two writes. A failure BETWEEN them leaves a recovery commit with
|
||||
// no audit row; the retry (keyed on the audit row, the operator-
|
||||
// facing record) appends a second commit before the audit lands —
|
||||
// bounded commit-graph noise, audit row still exactly-once. Same
|
||||
// not-atomic-pair-write tolerance as `record_audit` and the
|
||||
// manifest→commit-graph Known Gap; keying on commit rows instead
|
||||
// would need an operation_id column on `_graph_commits`, and
|
||||
// audit-before-commit would dangle the `graph_commit_id` join.
|
||||
let already_recorded = audit.list().await?.iter().any(|record| {
|
||||
record.operation_id == sidecar.operation_id
|
||||
&& record.recovery_kind == RecoveryKind::OrphanedBranchDiscarded
|
||||
});
|
||||
if !already_recorded {
|
||||
let mut graph = CommitGraph::open(root_uri).await?;
|
||||
let graph_commit_id = graph
|
||||
.append_commit(None, manifest_version, Some(RECOVERY_ACTOR))
|
||||
.await?;
|
||||
// Failpoint: the residual window above — commit appended, audit
|
||||
// not yet durable.
|
||||
crate::failpoints::maybe_fail("recovery.orphan_discard_audit_append")?;
|
||||
audit
|
||||
.append(RecoveryAuditRecord {
|
||||
graph_commit_id,
|
||||
recovery_kind: RecoveryKind::OrphanedBranchDiscarded,
|
||||
recovery_for_actor: sidecar.actor_id.clone(),
|
||||
operation_id: sidecar.operation_id.clone(),
|
||||
sidecar_writer_kind: format!("{:?}", sidecar.writer_kind),
|
||||
per_table_outcomes: Vec::new(),
|
||||
created_at: now_micros()?,
|
||||
})
|
||||
.await?;
|
||||
}
|
||||
let handle = RecoverySidecarHandle {
|
||||
operation_id: sidecar.operation_id.clone(),
|
||||
sidecar_uri: sidecar_uri(root_uri, &sidecar.operation_id),
|
||||
};
|
||||
delete_sidecar(&handle, storage).await
|
||||
}
|
||||
|
||||
/// The write-queue key serializing schema-apply's sidecar lifecycle
|
||||
/// against the write-entry heal. The schema-apply writer acquires it
|
||||
/// (alongside its per-table keys) from before `write_sidecar` until
|
||||
/// after `delete_sidecar`; the heal acquires it before reconciling
|
||||
/// schema staging or processing a SchemaApply sidecar. The name cannot
|
||||
/// collide with real table keys (those are `node:`/`edge:`-prefixed).
|
||||
pub(crate) fn schema_apply_serial_queue_key() -> crate::db::write_queue::TableQueueKey {
|
||||
("__schema_apply__".to_string(), None)
|
||||
}
|
||||
|
||||
/// Open-time recovery sweep — the entry point invoked from
|
||||
/// `Omnigraph::open` (gated on `OpenMode::ReadWrite`).
|
||||
///
|
||||
|
|
@ -549,9 +795,10 @@ pub(crate) async fn restore_table_to_version(
|
|||
///
|
||||
/// Concurrency: today recovery runs synchronously in `Omnigraph::open`
|
||||
/// *before* the engine is wrapped in the server's `Arc<RwLock<Omnigraph>>`.
|
||||
/// No request handlers can race. A future per-(table_key, branch) writer
|
||||
/// queue model (paired with a background reconciler) will need to acquire
|
||||
/// queues before the sweep restores or publishes.
|
||||
/// No request handlers can race, so this sweep does NOT acquire write
|
||||
/// queues. In-process callers (refresh, write entry points) must use
|
||||
/// [`heal_pending_sidecars_roll_forward`] instead, which serializes
|
||||
/// against live writers via per-(table_key, branch) queue acquisition.
|
||||
pub(crate) async fn recover_manifest_drift(
|
||||
root_uri: &str,
|
||||
storage: std::sync::Arc<dyn StorageAdapter>,
|
||||
|
|
@ -578,6 +825,21 @@ pub(crate) async fn recover_manifest_drift(
|
|||
for sidecar in sidecars {
|
||||
let branch_snapshot = match sidecar.branch.as_deref() {
|
||||
Some(b) => {
|
||||
// Orphan check against the manifest's branch list (the
|
||||
// authority) BEFORE opening — same classification as the
|
||||
// write-entry heal: a deferred sidecar whose branch was
|
||||
// deleted would otherwise fail every ReadWrite open.
|
||||
coordinator.refresh().await?;
|
||||
if !coordinator.all_branches().await?.iter().any(|name| name == b) {
|
||||
discard_orphaned_branch_sidecar(
|
||||
root_uri,
|
||||
storage.as_ref(),
|
||||
&sidecar,
|
||||
coordinator.snapshot().version(),
|
||||
)
|
||||
.await?;
|
||||
continue;
|
||||
}
|
||||
let mut branch_coord =
|
||||
GraphCoordinator::open_branch(root_uri, b, std::sync::Arc::clone(&storage))
|
||||
.await?;
|
||||
|
|
@ -611,7 +873,11 @@ async fn process_sidecar(
|
|||
sidecar: &RecoverySidecar,
|
||||
mode: RecoveryMode,
|
||||
schema_state_recovery: SchemaStateRecovery,
|
||||
) -> Result<()> {
|
||||
) -> Result<bool> {
|
||||
// Returns whether durable state changed (roll-forward, roll-back, or
|
||||
// stale-sidecar audit recovery). `false` = the sidecar was deferred
|
||||
// untouched -- callers must not treat that as a completed heal (no
|
||||
// schema reload / cache invalidation is warranted).
|
||||
let mut states = Vec::with_capacity(sidecar.tables.len());
|
||||
for pin in &sidecar.tables {
|
||||
let lance_head = open_lance_head(&pin.table_path, pin.table_branch.as_deref()).await?;
|
||||
|
|
@ -655,7 +921,7 @@ async fn process_sidecar(
|
|||
writer_kind = ?sidecar.writer_kind,
|
||||
"recovery: deferring sidecar with invariant violation to next ReadWrite open"
|
||||
);
|
||||
Ok(())
|
||||
Ok(false)
|
||||
}
|
||||
},
|
||||
SidecarDecision::RollBack => {
|
||||
|
|
@ -701,7 +967,8 @@ async fn process_sidecar(
|
|||
return record_audit_recovery_rollforward(
|
||||
root_uri, storage, snapshot, sidecar, &states,
|
||||
)
|
||||
.await;
|
||||
.await
|
||||
.map(|()| true);
|
||||
}
|
||||
if matches!(mode, RecoveryMode::RollForwardOnly) {
|
||||
// In-process recovery cannot run Dataset::restore safely
|
||||
|
|
@ -713,14 +980,16 @@ async fn process_sidecar(
|
|||
writer_kind = ?sidecar.writer_kind,
|
||||
"recovery: deferring rollback-eligible sidecar to next ReadWrite open"
|
||||
);
|
||||
return Ok(());
|
||||
return Ok(false);
|
||||
}
|
||||
warn!(
|
||||
operation_id = sidecar.operation_id.as_str(),
|
||||
writer_kind = ?sidecar.writer_kind,
|
||||
"recovery: rolling back sidecar (mixed or unexpected state)"
|
||||
);
|
||||
roll_back_sidecar(root_uri, storage, snapshot, sidecar, &states).await
|
||||
roll_back_sidecar(root_uri, storage, snapshot, sidecar, &states)
|
||||
.await
|
||||
.map(|()| true)
|
||||
}
|
||||
SidecarDecision::RollForward => {
|
||||
if matches!(sidecar.writer_kind, SidecarKind::SchemaApply)
|
||||
|
|
@ -733,7 +1002,9 @@ async fn process_sidecar(
|
|||
"recovery: rolling back SchemaApply sidecar because schema staging \
|
||||
files were not promoted in this recovery pass"
|
||||
);
|
||||
roll_back_sidecar(root_uri, storage, snapshot, sidecar, &states).await
|
||||
roll_back_sidecar(root_uri, storage, snapshot, sidecar, &states)
|
||||
.await
|
||||
.map(|()| true)
|
||||
}
|
||||
RecoveryMode::RollForwardOnly => {
|
||||
warn!(
|
||||
|
|
@ -741,7 +1012,7 @@ async fn process_sidecar(
|
|||
"recovery: deferring SchemaApply sidecar because schema staging files \
|
||||
were not promoted in this recovery pass"
|
||||
);
|
||||
Ok(())
|
||||
Ok(false)
|
||||
}
|
||||
};
|
||||
}
|
||||
|
|
@ -788,7 +1059,7 @@ async fn process_sidecar(
|
|||
)
|
||||
.await?;
|
||||
delete_sidecar_by_operation_id(root_uri, storage, &sidecar.operation_id).await?;
|
||||
Ok(())
|
||||
Ok(true)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1134,6 +1405,11 @@ async fn record_audit(
|
|||
kind: RecoveryKind,
|
||||
outcomes: Vec<TableOutcome>,
|
||||
) -> Result<()> {
|
||||
// Failpoint: models an audit write failure after the roll-forward /
|
||||
// roll-back publish already landed — the sweep aborts, the sidecar
|
||||
// stays, and re-entry records the audit row (see the retry note in
|
||||
// the doc comment above).
|
||||
crate::failpoints::maybe_fail("recovery.record_audit")?;
|
||||
// Non-main recovery commits must be appended on the sidecar branch's
|
||||
// commit graph, otherwise parent_commit_id comes from the global
|
||||
// main head. BranchMerge additionally records the source branch's
|
||||
|
|
@ -1260,7 +1536,7 @@ pub(crate) fn new_sidecar(
|
|||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::storage::LocalStorageAdapter;
|
||||
use crate::storage::ObjectStorageAdapter;
|
||||
use crate::table_store::TableStore;
|
||||
use arrow_array::{Int32Array, RecordBatch, StringArray};
|
||||
use arrow_schema::{DataType, Field, Schema};
|
||||
|
|
@ -1573,7 +1849,7 @@ mod tests {
|
|||
#[tokio::test]
|
||||
async fn list_sidecars_returns_empty_when_dir_missing() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let storage = LocalStorageAdapter::default();
|
||||
let storage = ObjectStorageAdapter::local();
|
||||
let result = list_sidecars(dir.path().to_str().unwrap(), &storage)
|
||||
.await
|
||||
.unwrap();
|
||||
|
|
@ -1583,10 +1859,10 @@ mod tests {
|
|||
#[tokio::test]
|
||||
async fn write_then_list_then_delete_round_trip() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
// Create the __recovery/ subdir so write_sidecar's parent exists
|
||||
// (LocalStorageAdapter::write_text doesn't mkdir parents).
|
||||
std::fs::create_dir(dir.path().join(RECOVERY_DIR_NAME)).unwrap();
|
||||
let storage = LocalStorageAdapter::default();
|
||||
// No pre-created __recovery/ subdir: the storage backend creates
|
||||
// missing parents on put, which is what the first sidecar write
|
||||
// of a fresh graph relies on.
|
||||
let storage = ObjectStorageAdapter::local();
|
||||
let root = dir.path().to_str().unwrap();
|
||||
|
||||
let sidecar = new_sidecar(
|
||||
|
|
@ -1617,7 +1893,7 @@ mod tests {
|
|||
"noise",
|
||||
)
|
||||
.unwrap();
|
||||
let storage = LocalStorageAdapter::default();
|
||||
let storage = ObjectStorageAdapter::local();
|
||||
let result = list_sidecars(dir.path().to_str().unwrap(), &storage)
|
||||
.await
|
||||
.unwrap();
|
||||
|
|
@ -1633,7 +1909,7 @@ mod tests {
|
|||
async fn list_sidecars_returns_deterministic_order() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
std::fs::create_dir(dir.path().join(RECOVERY_DIR_NAME)).unwrap();
|
||||
let storage = LocalStorageAdapter::default();
|
||||
let storage = ObjectStorageAdapter::local();
|
||||
let root = dir.path().to_str().unwrap();
|
||||
|
||||
// Write sidecars in REVERSE chronological order (newest first).
|
||||
|
|
|
|||
|
|
@ -378,10 +378,11 @@ impl Omnigraph {
|
|||
recover_schema_state_files(&root, Arc::clone(&storage), &coordinator.snapshot())
|
||||
.await?;
|
||||
// Recovery sweep: close the Phase B → Phase C residual on
|
||||
// any sidecar left over from a crashed writer. Continuous
|
||||
// in-process recovery for long-running servers (no restart
|
||||
// required between Phase B failure and recovery) is a
|
||||
// separate background-reconciler effort.
|
||||
// any sidecar left over from a crashed writer. Long-running
|
||||
// processes additionally converge in-process: the staged-
|
||||
// write entry points and `refresh` run the roll-forward-only
|
||||
// heal (`heal_pending_sidecars_roll_forward`); only
|
||||
// rollback-eligible sidecars wait for this open-time sweep.
|
||||
crate::db::manifest::recover_manifest_drift(
|
||||
&root,
|
||||
Arc::clone(&storage),
|
||||
|
|
@ -755,7 +756,7 @@ impl Omnigraph {
|
|||
///
|
||||
/// Composition mirrors `Omnigraph::open_with_storage_and_mode`'s
|
||||
/// recovery sequence, in the same order, with one restriction: the
|
||||
/// manifest-drift sweep runs in `RollForwardOnly` mode (rollback /
|
||||
/// manifest-drift heal runs in `RollForwardOnly` mode (rollback /
|
||||
/// abort cases defer to the next ReadWrite open because
|
||||
/// `Dataset::restore` is unsafe under concurrency). Each step:
|
||||
///
|
||||
|
|
@ -767,49 +768,123 @@ impl Omnigraph {
|
|||
/// SchemaApply roll-forward doesn't publish the manifest while
|
||||
/// the staging files remain unrenamed (which would corrupt the
|
||||
/// graph: data on new schema, catalog on old).
|
||||
/// 3. `recover_manifest_drift(... RollForwardOnly)` — close the
|
||||
/// 3. `heal_pending_sidecars_roll_forward` — close the
|
||||
/// finalize→publisher residual via roll-forward; defer rollback
|
||||
/// work to next ReadWrite open.
|
||||
/// work to next ReadWrite open. Serializes against live writers
|
||||
/// by acquiring each sidecar's per-(table_key, branch) write
|
||||
/// queues, so refresh never rolls forward an in-flight writer's
|
||||
/// sidecar from under it.
|
||||
/// 4. `runtime_cache.invalidate_all` — drop stale per-snapshot caches.
|
||||
///
|
||||
/// Steady state cost: one `list_dir` of `__recovery/` (typically
|
||||
/// returns empty → early return for both passes). No additional
|
||||
/// Lance reads.
|
||||
///
|
||||
/// Engine-internal callers that already hold an in-flight sidecar
|
||||
/// (e.g. `schema_apply` mid-write) MUST use
|
||||
/// The staged-write entry points (`load_as`, `mutate_as`) run the
|
||||
/// same heal via
|
||||
/// [`heal_pending_recovery_sidecars`](Self::heal_pending_recovery_sidecars),
|
||||
/// so a long-lived server converges on the next write without an
|
||||
/// explicit refresh. Engine-internal callers that already hold an
|
||||
/// in-flight sidecar (e.g. `schema_apply` mid-write) MUST use
|
||||
/// [`refresh_coordinator_only`](Self::refresh_coordinator_only) to
|
||||
/// avoid the recovery sweep racing their own sidecar.
|
||||
pub async fn refresh(&self) -> Result<()> {
|
||||
// Scope the coord write guard to the recovery section only.
|
||||
// Standalone schema-staging reconcile ONLY when no recovery
|
||||
// sidecar exists (legacy/manual staging residue). When sidecars
|
||||
// exist, the heal below owns the reconcile — per SchemaApply
|
||||
// sidecar, under that sidecar's queue guards — because an
|
||||
// unserialized reconcile can promote a LIVE schema apply's
|
||||
// staging files from under it, and a pre-promoted result would
|
||||
// make the heal's own guarded reconcile see clean staging and
|
||||
// wrongly defer the sidecar. The no-sidecar case cannot race a
|
||||
// live apply: its sidecar is on disk before its staging files.
|
||||
//
|
||||
// Scope the coord write guard to the schema-state section only.
|
||||
// `reload_schema_if_source_changed` (below) acquires
|
||||
// `self.coordinator.read().await` when the on-disk schema source
|
||||
// has drifted from the cached `schema_source`. Tokio's RwLock is
|
||||
// not reentrant, so holding the write across that call deadlocks.
|
||||
// Pinned by `composite_flow_schema_apply_then_branch_ops_no_deadlock_in_refresh`.
|
||||
// The heal also takes the lock itself (queues → coordinator
|
||||
// order), so it must run after this guard is released.
|
||||
{
|
||||
let mut coord = self.coordinator.write().await;
|
||||
coord.refresh().await?;
|
||||
let schema_state_recovery = recover_schema_state_files(
|
||||
&self.root_uri,
|
||||
Arc::clone(&self.storage),
|
||||
&coord.snapshot(),
|
||||
)
|
||||
.await?;
|
||||
crate::db::manifest::recover_manifest_drift(
|
||||
&self.root_uri,
|
||||
Arc::clone(&self.storage),
|
||||
&mut *coord,
|
||||
crate::db::manifest::RecoveryMode::RollForwardOnly,
|
||||
schema_state_recovery,
|
||||
)
|
||||
.await?;
|
||||
} // ← write guard released before reload's read acquisition
|
||||
// Hold the schema-apply serialization key across the
|
||||
// list-then-reconcile pair: without it, a live apply can
|
||||
// write its sidecar + staging between the empty check and
|
||||
// the reconcile (the same race, through a smaller window).
|
||||
// Queue before coordinator — the documented lock order.
|
||||
//
|
||||
// Liveness note: with a pending NON-SchemaApply sidecar
|
||||
// (e.g. a Mutation residual), this gate skips the standalone
|
||||
// reconcile and the heal below reconciles only per
|
||||
// SchemaApply sidecar — so pre-sidecar-era orphaned staging
|
||||
// residue waits for the NEXT refresh after the sidecars are
|
||||
// consumed. Convergence holds, one pass late. Do not "fix"
|
||||
// by re-running the reconcile unserialized here: that is
|
||||
// exactly the live-apply race this block exists to close.
|
||||
let _serial = self
|
||||
.write_queue
|
||||
.acquire(&crate::db::manifest::schema_apply_serial_queue_key())
|
||||
.await;
|
||||
if crate::db::manifest::list_sidecars(&self.root_uri, self.storage.as_ref())
|
||||
.await?
|
||||
.is_empty()
|
||||
{
|
||||
let mut coord = self.coordinator.write().await;
|
||||
coord.refresh().await?;
|
||||
recover_schema_state_files(
|
||||
&self.root_uri,
|
||||
Arc::clone(&self.storage),
|
||||
&coord.snapshot(),
|
||||
)
|
||||
.await?;
|
||||
}
|
||||
} // ← guards released before the heal's queue acquisition
|
||||
crate::db::manifest::heal_pending_sidecars_roll_forward(
|
||||
&self.root_uri,
|
||||
Arc::clone(&self.storage),
|
||||
&self.coordinator,
|
||||
&self.write_queue,
|
||||
)
|
||||
.await?;
|
||||
self.reload_schema_if_source_changed().await?;
|
||||
self.runtime_cache.invalidate_all().await;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Write-entry heal: converge any pending recovery sidecars (a
|
||||
/// previously failed writer's Phase B → Phase C residual) before
|
||||
/// starting a new staged write, so a long-lived process (the HTTP
|
||||
/// server, an embedded handle) recovers on its next write instead
|
||||
/// of wedging every write on the commit-time drift guard until
|
||||
/// restart. Roll-forward only; rollback-eligible sidecars defer to
|
||||
/// the next ReadWrite open exactly as [`refresh`](Self::refresh)
|
||||
/// does.
|
||||
///
|
||||
/// Steady-state cost: one `list_dir` of `__recovery/` (typically
|
||||
/// empty → immediate return). See
|
||||
/// `recovery::heal_pending_sidecars_roll_forward` for the
|
||||
/// concurrency contract (per-table write-queue acquisition).
|
||||
pub(crate) async fn heal_pending_recovery_sidecars(&self) -> Result<()> {
|
||||
let processed = crate::db::manifest::heal_pending_sidecars_roll_forward(
|
||||
&self.root_uri,
|
||||
Arc::clone(&self.storage),
|
||||
&self.coordinator,
|
||||
&self.write_queue,
|
||||
)
|
||||
.await?;
|
||||
if processed {
|
||||
// A rolled-forward SchemaApply sidecar moved disk + manifest
|
||||
// to the new schema (staging promoted, registrations
|
||||
// published); the in-memory catalog must follow or the very
|
||||
// write that triggered the heal validates against the stale
|
||||
// schema. Same post-heal step as `refresh`.
|
||||
self.reload_schema_if_source_changed().await?;
|
||||
self.runtime_cache.invalidate_all().await;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn reload_schema_if_source_changed(&self) -> Result<()> {
|
||||
let schema_path = schema_source_uri(&self.root_uri);
|
||||
let schema_source = self.storage.read_text(&schema_path).await?;
|
||||
|
|
@ -1951,7 +2026,7 @@ mod tests {
|
|||
use serde_json::Value;
|
||||
use std::sync::{Arc, Mutex};
|
||||
|
||||
use crate::storage::{LocalStorageAdapter, StorageAdapter, join_uri};
|
||||
use crate::storage::{ObjectStorageAdapter, StorageAdapter, join_uri};
|
||||
|
||||
const TEST_SCHEMA: &str = r#"
|
||||
node Person {
|
||||
|
|
@ -1967,9 +2042,9 @@ edge Knows: Person -> Person {
|
|||
edge WorksAt: Person -> Company
|
||||
"#;
|
||||
|
||||
#[derive(Debug, Default)]
|
||||
#[derive(Debug)]
|
||||
struct RecordingStorageAdapter {
|
||||
inner: LocalStorageAdapter,
|
||||
inner: ObjectStorageAdapter,
|
||||
reads: Mutex<Vec<String>>,
|
||||
writes: Mutex<Vec<String>>,
|
||||
exists_checks: Mutex<Vec<String>>,
|
||||
|
|
@ -1977,6 +2052,19 @@ edge WorksAt: Person -> Company
|
|||
deletes: Mutex<Vec<String>>,
|
||||
}
|
||||
|
||||
impl Default for RecordingStorageAdapter {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
inner: ObjectStorageAdapter::local(),
|
||||
reads: Mutex::default(),
|
||||
writes: Mutex::default(),
|
||||
exists_checks: Mutex::default(),
|
||||
renames: Mutex::default(),
|
||||
deletes: Mutex::default(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl RecordingStorageAdapter {
|
||||
fn reads(&self) -> Vec<String> {
|
||||
self.reads.lock().unwrap().clone()
|
||||
|
|
@ -2052,7 +2140,7 @@ edge WorksAt: Person -> Company
|
|||
|
||||
#[derive(Debug)]
|
||||
struct InitRaceStorageAdapter {
|
||||
inner: LocalStorageAdapter,
|
||||
inner: ObjectStorageAdapter,
|
||||
root: String,
|
||||
barrier: Arc<tokio::sync::Barrier>,
|
||||
}
|
||||
|
|
@ -2117,7 +2205,7 @@ edge WorksAt: Person -> Company
|
|||
let uri = dir.path().to_str().unwrap().to_string();
|
||||
let root = normalize_root_uri(&uri).unwrap();
|
||||
let storage: Arc<dyn StorageAdapter> = Arc::new(InitRaceStorageAdapter {
|
||||
inner: LocalStorageAdapter,
|
||||
inner: ObjectStorageAdapter::local(),
|
||||
root,
|
||||
barrier: Arc::new(tokio::sync::Barrier::new(2)),
|
||||
});
|
||||
|
|
|
|||
|
|
@ -144,6 +144,14 @@ where
|
|||
actor,
|
||||
)?;
|
||||
|
||||
// Converge any pending recovery sidecar before planning: a table
|
||||
// rewrite over sidecar-covered drift would otherwise re-plan from
|
||||
// the manifest pin and orphan the drifted Phase-B commit (silently
|
||||
// dropping its rows) while the stale sidecar lingers to misclassify
|
||||
// against the post-apply pins. Runs before the apply's own sidecar
|
||||
// exists, so the heal can never observe it.
|
||||
db.heal_pending_recovery_sidecars().await?;
|
||||
|
||||
acquire_schema_apply_lock(db).await?;
|
||||
let result = apply_schema_with_lock(db, desired_schema_source, options, validate_catalog).await;
|
||||
let release_result = release_schema_apply_lock(db).await;
|
||||
|
|
@ -428,19 +436,30 @@ where
|
|||
// per-table acquisitions are uncontended. They exist for symmetry
|
||||
// with future MR-870 recovery, which will need queue acquisition
|
||||
// before any `Dataset::restore` it issues for SchemaApply sidecars.
|
||||
let schema_apply_queue_keys: Vec<(String, Option<String>)> = recovery_pins
|
||||
let mut schema_apply_queue_keys: Vec<(String, Option<String>)> = recovery_pins
|
||||
.iter()
|
||||
.map(|pin| (pin.table_key.clone(), pin.table_branch.clone()))
|
||||
.collect();
|
||||
// The serialization key the write-entry heal acquires before touching
|
||||
// schema staging or a SchemaApply sidecar. Per-table keys alone don't
|
||||
// cover a registration-only migration (no pins, but a sidecar and
|
||||
// staging files on disk) — without this, a concurrent write's heal can
|
||||
// promote this apply's staging files and publish its registrations out
|
||||
// from under it. Acquired whenever a sidecar will be written, held
|
||||
// through Phase D (the guards live to the end of this function).
|
||||
let writes_sidecar = !(recovery_pins.is_empty()
|
||||
&& sidecar_registrations.is_empty()
|
||||
&& sidecar_tombstones.is_empty());
|
||||
if writes_sidecar {
|
||||
schema_apply_queue_keys
|
||||
.push(crate::db::manifest::schema_apply_serial_queue_key());
|
||||
}
|
||||
let _schema_apply_queue_guards = db
|
||||
.write_queue()
|
||||
.acquire_many(&schema_apply_queue_keys)
|
||||
.await;
|
||||
|
||||
let recovery_handle = if recovery_pins.is_empty()
|
||||
&& sidecar_registrations.is_empty()
|
||||
&& sidecar_tombstones.is_empty()
|
||||
{
|
||||
let recovery_handle = if !writes_sidecar {
|
||||
None
|
||||
} else {
|
||||
// `branch=None` because schema_apply publishes against main —
|
||||
|
|
|
|||
|
|
@ -43,6 +43,11 @@ const RECOVERIES_DIR: &str = "_graph_commit_recoveries.lance";
|
|||
pub(crate) enum RecoveryKind {
|
||||
RolledForward,
|
||||
RolledBack,
|
||||
/// The sidecar's branch no longer exists in the manifest: its tree
|
||||
/// and forks are reclaimed, the pinned drift is unreachable, and the
|
||||
/// sidecar is provably moot — discarded with this audit row instead
|
||||
/// of wedging every heal/sweep on a dead-branch open.
|
||||
OrphanedBranchDiscarded,
|
||||
}
|
||||
|
||||
impl RecoveryKind {
|
||||
|
|
@ -50,6 +55,7 @@ impl RecoveryKind {
|
|||
match self {
|
||||
RecoveryKind::RolledForward => "RolledForward",
|
||||
RecoveryKind::RolledBack => "RolledBack",
|
||||
RecoveryKind::OrphanedBranchDiscarded => "OrphanedBranchDiscarded",
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -57,6 +63,7 @@ impl RecoveryKind {
|
|||
match s {
|
||||
"RolledForward" => Ok(RecoveryKind::RolledForward),
|
||||
"RolledBack" => Ok(RecoveryKind::RolledBack),
|
||||
"OrphanedBranchDiscarded" => Ok(RecoveryKind::OrphanedBranchDiscarded),
|
||||
other => Err(OmniError::manifest_internal(format!(
|
||||
"unknown recovery_kind '{}' in _graph_commit_recoveries.lance",
|
||||
other
|
||||
|
|
|
|||
|
|
@ -1081,6 +1081,13 @@ impl Omnigraph {
|
|||
actor_id,
|
||||
)?;
|
||||
self.ensure_schema_apply_idle("branch_merge").await?;
|
||||
// Converge any pending recovery sidecar before the merge
|
||||
// captures its target snapshot: the merge's publish would
|
||||
// otherwise make the drifted Phase-B commit visible as an
|
||||
// unattributed side effect (manifest catches up to HEAD with no
|
||||
// recovery audit row) and leave the stale sidecar behind. Runs
|
||||
// before the merge's own sidecar exists.
|
||||
self.heal_pending_recovery_sidecars().await?;
|
||||
self.branch_merge_impl(source, target, actor_id).await
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -715,6 +715,14 @@ impl Omnigraph {
|
|||
actor_id: Option<&str>,
|
||||
) -> Result<MutationResult> {
|
||||
self.ensure_schema_state_valid().await?;
|
||||
// Converge any pending recovery sidecar (a previously failed
|
||||
// writer's Phase B → Phase C residual) before executing: the
|
||||
// inline delete path advances Lance HEAD during execution and
|
||||
// the staged path's commit-time drift guard refuses
|
||||
// sidecar-covered drift, so a long-lived handle must heal here
|
||||
// — not at restart. One `list_dir` when no sidecars exist (the
|
||||
// steady state).
|
||||
self.heal_pending_recovery_sidecars().await?;
|
||||
let requested = Self::normalize_branch_name(branch)?;
|
||||
// Reject internal `__run__*` / system-prefixed branches at the
|
||||
// public write boundary. Direct-publish paths assert this
|
||||
|
|
|
|||
|
|
@ -599,9 +599,53 @@ impl StagedMutation {
|
|||
)));
|
||||
}
|
||||
if head > current {
|
||||
// Error path only: tell the operator which drift class
|
||||
// this is. Uncovered drift (external raw Lance write,
|
||||
// pre-fix maintenance) goes through `omnigraph repair`.
|
||||
// Sidecar-covered drift reaching this guard means the
|
||||
// write-entry heal deferred it (rollback-eligible), and
|
||||
// `repair` refuses while a sidecar is pending — the
|
||||
// recovery path is a read-write reopen. A list failure
|
||||
// must not mask the conflict — and must not pick a
|
||||
// class confidently either: "could not classify" names
|
||||
// both paths and the cause, never routing the operator
|
||||
// to a command that will refuse.
|
||||
let action = match crate::db::manifest::list_sidecars(
|
||||
db.root_uri(),
|
||||
db.storage_adapter(),
|
||||
)
|
||||
.await
|
||||
{
|
||||
Ok(sidecars) => {
|
||||
let covered = sidecars.iter().any(|sidecar| {
|
||||
sidecar.tables.iter().any(|pin| {
|
||||
// Branch-aware: a sidecar pinning the
|
||||
// same table on ANOTHER branch does not
|
||||
// cover this branch's drift — a reopen
|
||||
// would recover that sidecar but leave
|
||||
// this drift for `repair`.
|
||||
pin.table_key == entry.table_key
|
||||
&& pin.table_branch == entry.path.table_branch
|
||||
})
|
||||
});
|
||||
if covered {
|
||||
"a pending recovery sidecar requires rollback — reopen the \
|
||||
graph read-write (e.g. restart the server) to recover"
|
||||
.to_string()
|
||||
} else {
|
||||
"run `omnigraph repair` before writing".to_string()
|
||||
}
|
||||
}
|
||||
Err(list_err) => format!(
|
||||
"could not classify the drift (sidecar listing failed: {}); \
|
||||
run `omnigraph repair`, or reopen the graph read-write if \
|
||||
repair reports a pending recovery sidecar",
|
||||
list_err
|
||||
),
|
||||
};
|
||||
return Err(OmniError::manifest_conflict(format!(
|
||||
"table '{}' has Lance HEAD version {} ahead of manifest version {}; run `omnigraph repair` before writing",
|
||||
entry.table_key, head, current
|
||||
"table '{}' has Lance HEAD version {} ahead of manifest version {}; {}",
|
||||
entry.table_key, head, current, action
|
||||
)));
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -188,6 +188,13 @@ impl Omnigraph {
|
|||
actor_id,
|
||||
)?;
|
||||
self.ensure_schema_state_valid().await?;
|
||||
// Converge any pending recovery sidecar (a previously failed
|
||||
// writer's Phase B → Phase C residual) before staging anything:
|
||||
// without this, sidecar-covered drift wedges every load on the
|
||||
// commit-time drift guard until a process restart — `repair`
|
||||
// refuses while a sidecar is pending. One `list_dir` when no
|
||||
// sidecars exist (the steady state).
|
||||
self.heal_pending_recovery_sidecars().await?;
|
||||
// Reject internal `__run__*` / system-prefixed branches at the
|
||||
// public write boundary. Direct-publish paths assert this
|
||||
// explicitly so a caller can't write to legacy or system
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
|
@ -143,6 +143,39 @@ pub fn sidecar_operation_ids(graph_root: &Path) -> Vec<String> {
|
|||
ids
|
||||
}
|
||||
|
||||
/// Recovery-audit rows' `recovery_kind` values at `graph_root`, in
|
||||
/// storage order. Empty when the audit dataset doesn't exist yet.
|
||||
pub async fn recovery_audit_kinds(graph_root: &Path) -> Vec<String> {
|
||||
let recoveries_dir = graph_root.join("_graph_commit_recoveries.lance");
|
||||
if !recoveries_dir.exists() {
|
||||
return Vec::new();
|
||||
}
|
||||
let ds = Dataset::open(recoveries_dir.to_str().unwrap())
|
||||
.await
|
||||
.expect("recoveries dataset opens");
|
||||
let batches: Vec<RecordBatch> = ds
|
||||
.scan()
|
||||
.try_into_stream()
|
||||
.await
|
||||
.unwrap()
|
||||
.try_collect()
|
||||
.await
|
||||
.unwrap();
|
||||
let mut out = Vec::new();
|
||||
for batch in batches {
|
||||
let kinds = batch
|
||||
.column_by_name("recovery_kind")
|
||||
.expect("recovery_kind column present")
|
||||
.as_any()
|
||||
.downcast_ref::<StringArray>()
|
||||
.expect("recovery_kind is Utf8");
|
||||
for i in 0..kinds.len() {
|
||||
out.push(kinds.value(i).to_string());
|
||||
}
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
pub async fn branch_head_commit_id(graph_root: &Path, branch: &str) -> Result<String> {
|
||||
let graph = match branch {
|
||||
"main" => CommitGraph::open(&graph_uri(graph_root)).await?,
|
||||
|
|
|
|||
|
|
@ -134,6 +134,218 @@ async fn recovery_refuses_unknown_schema_version_on_open() {
|
|||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn recovery_refuses_corrupt_sidecar_on_open_and_write() {
|
||||
use omnigraph::loader::{LoadMode, load_jsonl};
|
||||
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let uri = dir.path().to_str().unwrap();
|
||||
let mut db = Omnigraph::init(uri, TEST_SCHEMA).await.unwrap();
|
||||
|
||||
// A truncated/garbage sidecar — e.g. a crashed writer or a partial
|
||||
// local-FS write (S3 PutObject is atomic; local fs::write is not).
|
||||
write_sidecar_file(dir.path(), "01H000000000000000000000CC", "{not json");
|
||||
|
||||
// A live handle's write-entry heal must surface the parse failure
|
||||
// loudly instead of proceeding over a sidecar it cannot interpret.
|
||||
let err = load_jsonl(
|
||||
&mut db,
|
||||
r#"{"type":"Person","data":{"name":"Alice","age":30}}
|
||||
"#,
|
||||
LoadMode::Merge,
|
||||
)
|
||||
.await
|
||||
.err()
|
||||
.expect("expected the write to fail on the corrupt sidecar");
|
||||
assert!(
|
||||
err.to_string().contains("is not valid JSON"),
|
||||
"expected the corrupt-sidecar parse error, got: {}",
|
||||
err,
|
||||
);
|
||||
|
||||
// A fresh ReadWrite open fails the same way.
|
||||
drop(db);
|
||||
let err = Omnigraph::open(uri)
|
||||
.await
|
||||
.err()
|
||||
.expect("expected open to fail because of the corrupt sidecar");
|
||||
let msg = err.to_string();
|
||||
assert!(
|
||||
msg.contains("01H000000000000000000000CC") && msg.contains("is not valid JSON"),
|
||||
"expected the corrupt-sidecar parse error naming the file, got: {}",
|
||||
msg,
|
||||
);
|
||||
// The file must remain on disk for inspection — never auto-deleted.
|
||||
assert!(
|
||||
list_recovery_dir(dir.path()).contains(&"01H000000000000000000000CC.json".to_string()),
|
||||
"corrupt sidecar should remain on disk after refusal"
|
||||
);
|
||||
|
||||
// Read-only open still works — the sweep is skipped entirely.
|
||||
let _db = Omnigraph::open_read_only(uri).await.unwrap();
|
||||
}
|
||||
|
||||
/// The commit-time drift guard's advice must be branch-aware: a pending
|
||||
/// sidecar on ANOTHER branch does not cover this branch's drift. With a
|
||||
/// deferred feature-branch sidecar on disk and genuinely uncovered drift
|
||||
/// on main, the main write must still point at `omnigraph repair` — a
|
||||
/// read-write reopen recovers the sidecar but cannot repair main's
|
||||
/// uncovered drift.
|
||||
#[tokio::test]
|
||||
async fn drift_guard_advice_ignores_other_branch_sidecars() {
|
||||
use omnigraph::loader::{LoadMode, load_jsonl};
|
||||
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let uri = dir.path().to_str().unwrap();
|
||||
let mut db = Omnigraph::init(uri, TEST_SCHEMA).await.unwrap();
|
||||
load_jsonl(
|
||||
&mut db,
|
||||
"{\"type\":\"Person\",\"data\":{\"name\":\"Alice\",\"age\":30}}\n",
|
||||
LoadMode::Merge,
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
db.branch_create("feature").await.unwrap();
|
||||
// A real feature write forks Person's Lance dataset onto the branch
|
||||
// (the heal classifies a feature sidecar against the forked head).
|
||||
db.mutate(
|
||||
"feature",
|
||||
helpers::MUTATION_QUERIES,
|
||||
"insert_person",
|
||||
&helpers::mixed_params(&[("$name", "eve")], &[("$age", 22)]),
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
// A sidecar pinning node:Person ON FEATURE, shaped so the write-entry
|
||||
// heal defers it (head < expected_version classifies as an invariant
|
||||
// violation; roll-forward-only mode leaves it for the next ReadWrite
|
||||
// open) — it persists through the write attempt below.
|
||||
let person_uri = node_table_uri(uri, "Person");
|
||||
let sidecar_json = format!(
|
||||
r#"{{
|
||||
"schema_version": 1,
|
||||
"operation_id": "01H000000000000000000000XB",
|
||||
"started_at": "0",
|
||||
"branch": "feature",
|
||||
"actor_id": null,
|
||||
"writer_kind": "Mutation",
|
||||
"tables": [
|
||||
{{
|
||||
"table_key": "node:Person",
|
||||
"table_path": "{person_uri}",
|
||||
"expected_version": 999,
|
||||
"post_commit_pin": 1000,
|
||||
"table_branch": "feature"
|
||||
}}
|
||||
]
|
||||
}}"#
|
||||
);
|
||||
write_sidecar_file(dir.path(), "01H000000000000000000000XB", &sidecar_json);
|
||||
|
||||
// Genuinely uncovered drift on MAIN's Person (raw Lance write
|
||||
// bypassing the manifest — the `omnigraph repair` class).
|
||||
let mut ds = Dataset::open(&person_uri).await.unwrap();
|
||||
let _ = helpers::lance_delete_inline(&mut ds, "1 = 2").await;
|
||||
|
||||
let err = load_jsonl(
|
||||
&mut db,
|
||||
"{\"type\":\"Person\",\"data\":{\"name\":\"Bob\",\"age\":25}}\n",
|
||||
LoadMode::Merge,
|
||||
)
|
||||
.await
|
||||
.err()
|
||||
.expect("uncovered main drift must fail the write");
|
||||
assert!(
|
||||
err.to_string().contains("run `omnigraph repair`"),
|
||||
"a feature-branch sidecar must not flip main's uncovered-drift \
|
||||
advice to the reopen path; got: {err}"
|
||||
);
|
||||
}
|
||||
|
||||
/// A deferred sidecar pinned to a branch that is subsequently DELETED
|
||||
/// must not wedge the graph: the branch's tree and forks are reclaimed,
|
||||
/// so the pinned drift is unreachable and the sidecar is provably moot.
|
||||
/// Both the write-entry heal and the open-time sweep must classify it
|
||||
/// as orphaned (audit + discard) instead of failing to open the dead
|
||||
/// branch on every write and every ReadWrite open — a terminal state,
|
||||
/// since `repair` refuses while a sidecar is pending.
|
||||
#[tokio::test]
|
||||
async fn deleted_branch_sidecar_does_not_wedge_writes_or_open() {
|
||||
use omnigraph::loader::{LoadMode, load_jsonl};
|
||||
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let uri = dir.path().to_str().unwrap().to_string();
|
||||
let mut db = Omnigraph::init(&uri, TEST_SCHEMA).await.unwrap();
|
||||
load_jsonl(
|
||||
&mut db,
|
||||
"{\"type\":\"Person\",\"data\":{\"name\":\"Alice\",\"age\":30}}\n",
|
||||
LoadMode::Merge,
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
db.branch_create("feature").await.unwrap();
|
||||
db.mutate(
|
||||
"feature",
|
||||
helpers::MUTATION_QUERIES,
|
||||
"insert_person",
|
||||
&helpers::mixed_params(&[("$name", "eve")], &[("$age", 22)]),
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
// A rollback-eligible (deferred) sidecar pinned to feature — shaped
|
||||
// so every roll-forward-only pass leaves it on disk.
|
||||
let person_uri = node_table_uri(&uri, "Person");
|
||||
let sidecar_json = format!(
|
||||
r#"{{
|
||||
"schema_version": 1,
|
||||
"operation_id": "01H000000000000000000000DB",
|
||||
"started_at": "0",
|
||||
"branch": "feature",
|
||||
"actor_id": null,
|
||||
"writer_kind": "Mutation",
|
||||
"tables": [
|
||||
{{
|
||||
"table_key": "node:Person",
|
||||
"table_path": "{person_uri}",
|
||||
"expected_version": 999,
|
||||
"post_commit_pin": 1000,
|
||||
"table_branch": "feature"
|
||||
}}
|
||||
]
|
||||
}}"#
|
||||
);
|
||||
write_sidecar_file(dir.path(), "01H000000000000000000000DB", &sidecar_json);
|
||||
|
||||
// Branch delete defers the rollback-eligible sidecar and proceeds —
|
||||
// the sidecar now references a branch that no longer exists.
|
||||
db.branch_delete("feature").await.unwrap();
|
||||
|
||||
// The next write's heal must classify the orphan and discard it,
|
||||
// not fail opening the dead branch.
|
||||
load_jsonl(
|
||||
&mut db,
|
||||
"{\"type\":\"Person\",\"data\":{\"name\":\"Bob\",\"age\":25}}\n",
|
||||
LoadMode::Merge,
|
||||
)
|
||||
.await
|
||||
.expect("a write after deleting a sidecar-pinned branch must succeed");
|
||||
assert_eq!(
|
||||
list_recovery_dir(dir.path()).len(),
|
||||
0,
|
||||
"the orphaned sidecar must be discarded (with an audit row), not left to wedge"
|
||||
);
|
||||
|
||||
// And a fresh ReadWrite open must succeed too (the sweep shares the
|
||||
// same classification).
|
||||
drop(db);
|
||||
let db = Omnigraph::open(&uri)
|
||||
.await
|
||||
.expect("ReadWrite open after deleting a sidecar-pinned branch must succeed");
|
||||
assert_eq!(helpers::count_rows(&db, "node:Person").await, 2);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn read_only_open_skips_recovery_sweep() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
|
|
|
|||
|
|
@ -42,10 +42,12 @@ Use it this way:
|
|||
|
||||
5. **Recovery is part of the commit protocol.** Writers that can advance Lance
|
||||
HEAD before manifest publish must write `__recovery/{ulid}.json` sidecars.
|
||||
`Omnigraph::open` in read-write mode runs the all-or-nothing sweep, and
|
||||
`refresh` runs roll-forward-only recovery for long-lived processes. Do not
|
||||
add a new writer kind without sidecar coverage or an explicit proof that no
|
||||
Lance HEAD can move before manifest publish.
|
||||
`Omnigraph::open` in read-write mode runs the all-or-nothing sweep; the
|
||||
write entry points (`load_as`, `mutate_as`, `apply_schema_as`,
|
||||
`branch_merge_as`) and `refresh` run roll-forward-only recovery in-process,
|
||||
so a long-lived process converges on its next write rather than at restart. Do not add a new writer kind without
|
||||
sidecar coverage or an explicit proof that no Lance HEAD can move before
|
||||
manifest publish.
|
||||
|
||||
6. **Strong consistency is the default.** Reads are snapshot-isolated, writes
|
||||
are durable before acknowledgement, and branch reads observe the current
|
||||
|
|
@ -106,7 +108,7 @@ Use it this way:
|
|||
| Index lifecycle | `ensure_indices` is explicit today; reconciler-based convergence is roadmap | [indexes.md](../user/indexes.md), [maintenance.md](../user/maintenance.md) |
|
||||
| Traversal IDs | Runtime still builds `TypeIndex`; Lance stable row-id based graph IDs are roadmap | [architecture.md](architecture.md), [query-language.md](../user/query-language.md) |
|
||||
| Auth | Bearer token hashing and server-side actor resolution are implemented at the HTTP boundary | [server.md](../user/server.md), [policy.md](../user/policy.md) |
|
||||
| Tests | Tempdir-backed Lance tests are the current substrate; there is no `MemStorage` test backend | [testing.md](testing.md) |
|
||||
| Tests | Tempdir-backed Lance tests are the current substrate; the storage adapter has an in-memory backend for adapter-level contract tests, but Lance datasets bypass it | [testing.md](testing.md) |
|
||||
|
||||
The branch-delete reconciler is authority-derived: it reclaims orphaned forks
|
||||
today and degrades to a no-op if Lance ships an atomic multi-dataset branch
|
||||
|
|
@ -146,6 +148,29 @@ them explicit.
|
|||
Remove the skip when the upstream Lance fix lands — the
|
||||
`lance_surface_guards.rs::compact_files_still_fails_on_blob_columns` guard
|
||||
turns red on that bump to force it.
|
||||
- **Recovery is serialized against live writers in-process only:** the
|
||||
write-entry heal (and `refresh`) serialize against a live writer's sidecar
|
||||
lifetime via the per-`(table, branch)` write queues plus the schema-apply
|
||||
serialization key — all in-process primitives. A recovery pass in one
|
||||
process cannot serialize against a live writer in another (the open-time
|
||||
sweep has the same exposure, and always has): it may roll a live foreign
|
||||
writer's sidecar forward, which degrades to publisher-CAS contention for
|
||||
data writes but can race the schema-staging promotion for a foreign live
|
||||
schema apply. Multi-process writers on one graph are already documented
|
||||
one-winner-CAS territory; closing this fully needs a cross-process
|
||||
serialization primitive (e.g. lease-based use of the schema-apply lock
|
||||
branch) — design it before promoting multi-process write topologies.
|
||||
- **Local `write_text_if_match` is not a cross-process CAS:** object-store
|
||||
backends use a true conditional put (ETag If-Match; the in-memory test
|
||||
backend too), but upstream `object_store` leaves `PutMode::Update`
|
||||
unimplemented for `LocalFileSystem`, so the local path emulates CAS with
|
||||
a content-token compare followed by an atomic replace — a check-then-act
|
||||
gap plus content-token ABA. Every current caller goes through the cluster
|
||||
lock protocol first, which makes this safe. A lock-free caller would get
|
||||
S3-correct but local-racy behavior — the same divergence shape as the
|
||||
acknowledged-before-visible bug this branch fixed. Close it (local CAS
|
||||
primitive, or a trait-level lock requirement) before admitting any
|
||||
lock-free `if_match` caller.
|
||||
- **Manifest→commit-graph publish atomicity:** a graph commit advances
|
||||
`__manifest` (the visibility authority) and then appends `_graph_commits` as
|
||||
two separate writes (`commit_updates_with_actor_with_expected`, failpoint
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ The engine's `tests/` is the principal coverage surface; most graph-shaped behav
|
|||
| `validators.rs` | Schema constraint enforcement (enum, range, unique, cardinality) across JSONL, insert, update paths |
|
||||
| `policy_engine_chassis.rs` | Engine-layer Cedar enforcement (MR-722): allow + deny through every `_as` writer via the SDK directly — no HTTP — proving embedded and CLI callers hit the same gate as the server, with action × scope shapes matching `authorize_request` |
|
||||
| `maintenance.rs` | `optimize` (compaction), `repair` (explicit uncovered-drift publish), and `cleanup` (version GC): empty/idempotent/no-op edges, policy validation, head preservation; `optimize` publishes its own compaction (`optimize_publishes_compaction_to_manifest_so_schema_apply_succeeds`), skips pre-existing uncovered drift (`optimize_skips_preexisting_manifest_head_drift`), and refuses to run while a `__recovery` sidecar is pending (`optimize_defers_when_recovery_sidecar_is_pending`); `repair` previews/heals verified maintenance drift, refuses raw semantic drift without `--force`, and forced repair publishes only by explicit operator choice |
|
||||
| `failpoints.rs` | Failure-injection coverage (gated on `failpoints` feature). Includes the five per-writer Phase B → recovery integration tests (`recovery_rolls_forward_after_finalize_publisher_failure`, `schema_apply_phase_b_failure_recovered_on_next_open`, `branch_merge_phase_b_failure_recovered_on_next_open`, `ensure_indices_phase_b_failure_recovered_on_next_open`, `optimize_phase_b_failure_recovered_on_next_open`). |
|
||||
| `failpoints.rs` | Failure-injection coverage (gated on `failpoints` feature). Includes the five per-writer Phase B → recovery integration tests (`recovery_rolls_forward_after_finalize_publisher_failure`, `schema_apply_phase_b_failure_recovered_on_next_open`, `branch_merge_phase_b_failure_recovered_on_next_open`, `ensure_indices_phase_b_failure_recovered_on_next_open`, `optimize_phase_b_failure_recovered_on_next_open`) and the write-entry in-process heal contract (the four `*_after_finalize_publisher_failure_heals_without_reopen` tests — load, mutation, schema apply, branch merge: a follow-up write on the same handle rolls a sidecar-covered residual forward without reopen/refresh) and the storage-fault matrix for the sidecar lifecycle (`recovery.sidecar_{write,delete,list}` / `recovery.record_audit` failpoints: Phase A put failure aborts with zero drift, Phase D delete failure is swallowed and healed by the next write, list failures are loud at heal and open, audit-append failures are retried to exactly one audit row; plus the bucket-gated `s3_load_recovers_after_publisher_failure_without_reopen`). |
|
||||
| `recovery.rs` | Open-time recovery sweep — sidecar I/O, classifier dispatch (NoMovement / RolledPastExpected / UnexpectedAtP1 / UnexpectedMultistep / InvariantViolation), all-or-nothing decision, roll-forward via `ManifestBatchPublisher::publish`, roll-back via `Dataset::restore`, audit row in `_graph_commit_recoveries.lance`, `OpenMode::ReadOnly` skip path |
|
||||
| `composite_flow.rs` | Compositional/narrative end-to-end stories — multi-step flows that compose mechanics covered by other test files. Catches integration regressions where individual operations all pass their unit tests but their composition breaks (sequential merges, post-merge main writes, time-travel through merge DAG, reopen consistency over multi-merge histories, post-optimize and post-cleanup strict writes). |
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ The engine's `tests/` is the principal coverage surface; most graph-shaped behav
|
|||
- **CLI** — `crates/omnigraph-cli/tests/support/mod.rs`: `Command`-style wrapper for invoking `omnigraph`, server-process spawning, fixture resolution, output assertion helpers.
|
||||
- **Server** — no shared helpers; server tests call the `Omnigraph` engine API directly and exercise endpoints over the wire.
|
||||
|
||||
> Note: there is **no `MemStorage` or in-memory backend** today. Tests use `tempfile::tempdir()` for local FS. If you find yourself needing one for layer isolation, that's an architectural ask — keep it explicit in [docs/dev/invariants.md](invariants.md) under known gaps.
|
||||
> Note: the storage adapter has an in-memory backend (`ObjectStorageAdapter::in_memory()`, full contract including true conditional updates) used by the adapter contract tests in `storage.rs`. It covers only the text-object layer (sidecars, schema staging, cluster state) — **Lance datasets bypass the adapter**, so engine integration tests still use `tempfile::tempdir()`. An in-memory Lance substrate remains an architectural ask — keep it explicit in [docs/dev/invariants.md](invariants.md) under known gaps.
|
||||
|
||||
## Failpoints (fault injection)
|
||||
|
||||
|
|
@ -74,6 +74,7 @@ CI runs three S3-backed tests against a containerized RustFS server (`.github/wo
|
|||
- `cargo test -p omnigraph-server --test s3` (single-graph serving + config-free `--cluster s3://` boot)
|
||||
- `cargo test -p omnigraph-cluster --test s3_cluster` (full control-plane lifecycle on the bucket)
|
||||
- `cargo test -p omnigraph-cli --test system_local local_cli_s3_end_to_end_init_load_read_flow`
|
||||
- `cargo test -p omnigraph-engine --features failpoints --test failpoints s3_` (recovery-sidecar lifecycle on a real bucket)
|
||||
|
||||
Locally, set `OMNIGRAPH_S3_TEST_BUCKET` (and the usual `AWS_*` vars including `AWS_ENDPOINT_URL_S3` for non-AWS) before running. Without those, S3 tests skip gracefully.
|
||||
|
||||
|
|
|
|||
|
|
@ -215,19 +215,43 @@ Triggers for the residual: transient Lance write errors during finalize
|
|||
(object-store retry budget exhaustion, disk full); persistent publisher
|
||||
contention exceeding `PUBLISHER_RETRY_BUDGET = 5` retries.
|
||||
|
||||
**Long-running servers**: `Omnigraph::refresh` runs roll-forward-only
|
||||
recovery in-process — the common Phase B → Phase C residual closes
|
||||
without a restart. The next mutation on the same handle (after refresh)
|
||||
no longer surfaces `ExpectedVersionMismatch` for the failed table.
|
||||
**Long-running servers**: the write entry points (`load_as`,
|
||||
`mutate_as`, `apply_schema_as`, `branch_merge_as`) and
|
||||
`Omnigraph::refresh` run roll-forward-only recovery in-process
|
||||
(`recovery::heal_pending_sidecars_roll_forward`) — the common
|
||||
Phase B → Phase C residual closes on the next write, without a
|
||||
restart and without an explicit refresh. The heal lists `__recovery/`
|
||||
(one `list_dir`; empty in the steady state) and, per sidecar, acquires
|
||||
the same per-`(table_key, table_branch)` write queues every sidecar
|
||||
writer holds from before `write_sidecar` until after `delete_sidecar` —
|
||||
so it serializes against a live writer instead of rolling its
|
||||
in-flight sidecar forward from under it (a sidecar whose queues can be
|
||||
acquired belongs to a writer that finished or died; an existence
|
||||
re-check after the wait skips the finished case). Lock order is
|
||||
queues → coordinator, matching every writer's commit→publish path.
|
||||
Pinned by the four
|
||||
`tests/failpoints.rs::*_after_finalize_publisher_failure_heals_without_reopen`
|
||||
tests (load, mutation, schema apply, branch merge). The maintenance
|
||||
entries need the heal for more than liveness: without it, a schema
|
||||
apply re-plans rewrites from the manifest pin and orphans the drifted
|
||||
Phase-B commit (dropping its rows), and a branch merge publishes the
|
||||
drift as an unattributed side effect — both while the stale sidecar
|
||||
lingers to misclassify later.
|
||||
Sidecars that would require a `Dataset::restore` (mixed / unexpected
|
||||
state) are deferred to the next `OpenMode::ReadWrite` open: restore is
|
||||
unsafe under concurrency because Lance's `check_restore_txn` accepts
|
||||
the restore against in-flight Append/Update/Delete commits and
|
||||
silently orphans them (pinned by
|
||||
`tests/staged_writes.rs::lance_restore_loses_to_concurrent_append_via_orphaning`).
|
||||
When such a deferred sidecar blocks a write, the commit-time drift
|
||||
guard says so explicitly ("a pending recovery sidecar requires
|
||||
rollback — reopen the graph read-write") instead of pointing at
|
||||
`omnigraph repair`, which refuses while a sidecar is pending.
|
||||
Continuous in-process recovery for the rollback path is the goal of a
|
||||
future background reconciler with per-(table, branch) writer-queue
|
||||
acquisition.
|
||||
future background reconciler. `ensure_indices` does not heal at entry
|
||||
itself — it runs inside the load / schema-apply flows after their
|
||||
entry heal, and its strict preconditions still fail loudly on drift
|
||||
when invoked directly.
|
||||
|
||||
The publisher-CAS contract is unchanged: a *concurrent writer* that
|
||||
advances any of our touched tables between snapshot capture and
|
||||
|
|
@ -235,6 +259,44 @@ publisher commit produces exactly one winner. The residual above is
|
|||
about *our* abandoned commits in the failure path, not about
|
||||
concurrency races.
|
||||
|
||||
**Sidecar I/O failure semantics** (all sidecar I/O goes through the
|
||||
backend-generic `StorageAdapter`; the contracts below are pinned by the
|
||||
storage-fault failpoints `recovery.sidecar_{write,delete,list}` /
|
||||
`recovery.record_audit` and their tests in `tests/failpoints.rs` and
|
||||
`tests/recovery.rs`):
|
||||
|
||||
- **Phase A put fails** (S3 PutObject / fs write): the writer aborts
|
||||
before its first HEAD-advancing commit — no sidecar, no drift,
|
||||
nothing to recover; a transient fault never wedges later writes.
|
||||
- **Phase D delete fails** (S3 DeleteObject): swallowed with a warning —
|
||||
the write already published, so failing the caller would report an
|
||||
error for a durable write. The stale sidecar is consumed by the next
|
||||
write's entry heal (or the next open) via the stale-sidecar
|
||||
audit-recovery path, recorded as `RolledForward`.
|
||||
- **`__recovery/` list fails** (S3 ListObjectsV2): loud at every
|
||||
consumer — the write-entry heal fails the write, the open-time sweep
|
||||
fails the open. Silently skipping recovery would be consumer
|
||||
tolerance of drift.
|
||||
- **Corrupt / unparseable sidecar**: refused loudly by heal and open
|
||||
alike; the file stays on disk for operator inspection (read-only
|
||||
opens still work — the sweep is skipped there).
|
||||
- **Audit append fails after a roll-forward publish**: that recovery
|
||||
attempt errors and keeps the sidecar; re-entry sees the
|
||||
already-published manifest, records exactly one `RolledForward`
|
||||
audit row, and deletes the sidecar (the retry tolerance documented
|
||||
on `record_audit`).
|
||||
|
||||
Backend notes (the adapter is one implementation over `object_store`
|
||||
for every backend): local writes stage through `name#<digits>` temp
|
||||
files that the backend filters from listings and refuses to address —
|
||||
crash residue of that shape is invisible to the sweep, harmless, and
|
||||
reclaimed by `delete_prefix`/manual cleanup. Storage errors are
|
||||
backend-wrapped text without a typed NotFound discriminant — callers
|
||||
that need missing-vs-error (the cluster store) probe `exists()` first.
|
||||
`exists()` itself is object-store semantics everywhere: only objects
|
||||
(or non-empty prefixes) exist, and a permission failure is a loud
|
||||
error, not a silent `false`.
|
||||
|
||||
## Conflict shape
|
||||
|
||||
Concurrent writers to the same `(table, branch)` produce exactly one
|
||||
|
|
|
|||
|
|
@ -104,8 +104,8 @@ The split — L2 owns the cross-dataset catalog; L1 owns the per-dataset interna
|
|||
|
||||
| Scheme | Backend | Notes |
|
||||
|---|---|---|
|
||||
| local path / `file://` | `LocalStorageAdapter` (tokio) | Normalized to absolute paths |
|
||||
| `s3://bucket/prefix` | `S3StorageAdapter` (object_store) | Honors `AWS_ENDPOINT_URL_S3`, `AWS_ALLOW_HTTP`, `AWS_S3_FORCE_PATH_STYLE` |
|
||||
| local path / `file://` | `ObjectStorageAdapter` over `object_store::LocalFileSystem` | Normalized to absolute paths; relative and dot-segment paths are lexically absolutized |
|
||||
| `s3://bucket/prefix` | `ObjectStorageAdapter` over `object_store` S3 | Honors `AWS_ENDPOINT_URL_S3`, `AWS_ALLOW_HTTP`, `AWS_S3_FORCE_PATH_STYLE` |
|
||||
| `http(s)://host:port` | HTTP client to `omnigraph-server` | Used by CLI as a target, not a storage backend |
|
||||
|
||||
## Object-store env vars (S3-compatible)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue