arborist/aborist/ingest.py
russell@unturf.com 649aeec79a
progress reporter + structured benchmark
aborist/progress.py — stdlib-only rate-limited stderr reporter.
  Periodic lines (default every 2s) showing:
    elapsed | seen | inserted | docs/s now | docs/s avg | percent | ETA
  Wired into ingest_source via a `progress` parameter; CLI default-on
  with --quiet to suppress and --total-estimate N to enable percent/ETA.

  Demo on a 5k-doc ingest with --progress-interval 0.8:
    [    1s] |   200 seen |   200 new |  193 now | ( 193 avg) docs/s |   4.0% | ETA  24s
    [    7s] | 3,200 seen | 3,200 new |  458 now | ( 424 avg) docs/s |  64.0% | ETA   3s
    [   12s] | 5,001 seen | 5,000 new |  392 now | ( 413 avg) docs/s | 100.0% | ETA   0s

bench/run.sh + `make bench` — reproducible 5000-doc workload through
three configs:
  serial            single process, single SQLite
  parallel-shared   N shards, one shared SQLite (WAL serialized)
  attached          N shards, per-shard SQLite (true parallel writes)

Output is a one-shot table plus CSV at /tmp/aborist-bench/results.csv
so the ratchet is visible as we keep optimizing. Override via
BENCH_DOCS=N and SHARDS=N.

Latest baseline (this commit, on this machine):
  config             wall_s    docs   docs/s
  serial              11.74    5000    425.7
  parallel-shared     10.39    5000    481.1
  attached             7.99    5000    625.5

53 tests still passing.
2026-04-27 11:37:20 -04:00

411 lines
14 KiB
Python

"""Ingest pipeline: Source -> normalize -> chunk -> merkle -> upsert.
Idempotent: re-ingesting the same Document is a no-op (document_root collision
is the upsert key).
Performance shape — bulk-batched writer:
Each batch collapses ALL inserts across N docs into a small set of
executemany() calls (one per table) instead of per-doc calls. Audit chain
hashes computed in pure Python via store.chain_audit_events, then inserted
in one shot. With WAL+synchronous=NORMAL, the dominant cost shifts from
Python<->C boundary crossings to actual SQLite work.
"""
from __future__ import annotations
import sqlite3
import time
from dataclasses import dataclass
from aborist import (
CANONICALIZATION_VERSION,
SCHEMA_VERSION,
)
from aborist.document import Document, canonicalize, get_chunker
from aborist.merkle import MerkleTree, hash_leaf
from aborist.progress import Progress
from aborist.source import Source
from aborist.store import (
chain_audit_events,
get_meta,
latest_event_hash,
set_meta,
transaction,
)
DEFAULT_BATCH_SIZE = 200
@dataclass
class _DocArtifacts:
document_root: str
leaves: list[bytes]
chunk_strs: list[str]
tree: MerkleTree
@dataclass
class IngestStats:
seen: int = 0
inserted: int = 0
skipped_duplicate: int = 0
chunks_total: int = 0
edges_total: int = 0
def ingest_source(
conn: sqlite3.Connection,
source: Source,
chunker_name: str | None = None,
limit: int | None = None,
batch_size: int = DEFAULT_BATCH_SIZE,
resume: bool = False,
progress: Progress | None = None,
) -> IngestStats:
"""Ingest every document the source yields. Returns counts.
`resume=True` reads the per-source high-water mark from this DB's meta
table and asks the source to fast-forward past it. After each successful
batch flush, the high-water mark is updated in meta. A killed process
can rsync forward by re-running with --resume.
`progress` (optional) gets a `tick(seen, inserted=...)` call after each
batch flush. Pass an `aborist.progress.Progress` for live stderr output.
"""
chunker = get_chunker(chunker_name)
stats = IngestStats()
batch: list[tuple[Document, _DocArtifacts]] = []
meta_key = f"source_high_water:{source.source_type}"
if resume:
prior = get_meta(conn, meta_key)
if prior is not None and hasattr(source, "start_id"):
try:
source.start_id = int(prior)
source.last_id = int(prior)
except (TypeError, ValueError):
pass
def flush() -> None:
if not batch:
return
inserted, skipped = _flush_batch(conn, batch, chunker.name)
stats.inserted += inserted
stats.skipped_duplicate += skipped
batch.clear()
if hasattr(source, "last_id") and source.last_id:
with transaction(conn):
set_meta(conn, meta_key, str(source.last_id))
if progress is not None:
progress.tick(stats.seen, inserted=stats.inserted)
for doc in source.iter_documents():
stats.seen += 1
if limit is not None and stats.seen > limit:
break
art = _compute_artifacts(doc, chunker)
if art is None:
stats.skipped_duplicate += 1
continue
batch.append((doc, art))
if len(batch) >= batch_size:
flush()
flush()
if progress is not None:
progress.done(stats.seen, inserted=stats.inserted)
stats.chunks_total = conn.execute("SELECT COUNT(*) FROM chunks").fetchone()[0]
stats.edges_total = conn.execute("SELECT COUNT(*) FROM edges").fetchone()[0]
return stats
def _compute_artifacts(doc: Document, chunker) -> _DocArtifacts | None:
"""Pure: canonicalize, chunk, hash leaves, build the tree. No DB access."""
text = canonicalize(doc.content)
chunk_strs = chunker.split(text)
if not chunk_strs:
return None
leaves = [hash_leaf(c.encode("utf-8")) for c in chunk_strs]
tree = MerkleTree.build(leaves)
return _DocArtifacts(
document_root=tree.root.hex(),
leaves=leaves,
chunk_strs=chunk_strs,
tree=tree,
)
def _flush_batch(
conn: sqlite3.Connection,
batch: list[tuple[Document, _DocArtifacts]],
chunker_name: str,
) -> tuple[int, int]:
"""Bulk-insert the whole batch. Returns (inserted, skipped_duplicate).
All collisions and prior-version lookups happen up front via batched
SELECTs. New rows accumulate into per-table mega-lists and flush via
one executemany per table. Audit-chain hashes are computed in pure
Python and inserted in one shot.
"""
inserted = 0
skipped = 0
ingest_ts = int(time.time())
with transaction(conn):
# 1) Collision check: which document_roots already exist?
roots = [art.document_root for _, art in batch]
existing: set[str] = _select_existing_roots(conn, roots)
inserted_this_batch: set[str] = set()
# 2) Batched prior-URI resolution: one IN-clause SELECT instead of
# one per-doc SELECT. Maps each URI to the most-recent existing
# document_root in the DB (pre-batch state).
new_uris = list({doc.uri for doc, art in batch
if art.document_root not in existing})
prior_db: dict[str, str] = {}
for slab_start in range(0, len(new_uris), 500):
slab = new_uris[slab_start : slab_start + 500]
placeholders = ",".join("?" * len(slab))
for row in conn.execute(
"SELECT document_uri, document_root FROM documents "
f"WHERE document_uri IN ({placeholders}) "
"ORDER BY ingest_ts DESC",
slab,
):
# First wins (most recent by ORDER BY DESC).
prior_db.setdefault(row["document_uri"], row["document_root"])
# Within-batch chain state: as we process, the "prior" for the next
# doc with the same URI becomes the doc we just inserted.
prior_for_doc: dict[str, str] = {}
documents_rows: list[tuple] = []
chunk_rows: list[tuple] = []
fts_rows: list[tuple] = []
merkle_rows: list[tuple] = []
edge_rows: list[tuple] = []
audit_events: list[dict] = []
edges_to_upsert: list[tuple[str, Document]] = []
for doc, art in batch:
if art.document_root in existing or art.document_root in inserted_this_batch:
edges_to_upsert.append((art.document_root, doc))
skipped += 1
continue
prior_root = prior_for_doc.get(doc.uri) or prior_db.get(doc.uri)
if prior_root == art.document_root:
prior_root = None # same content, not a real prior
documents_rows.append(
(
art.document_root,
doc.uri,
doc.source_type,
doc.title,
chunker_name,
CANONICALIZATION_VERSION,
SCHEMA_VERSION,
ingest_ts,
)
)
for i, c in enumerate(art.chunk_strs):
chunk_rows.append((art.document_root, i, art.leaves[i].hex(), c))
fts_rows.append((art.document_root, i, c))
for layer_idx in range(1, len(art.tree.layers)):
for node_idx, h in enumerate(art.tree.layers[layer_idx]):
merkle_rows.append(
(art.document_root, layer_idx, node_idx, h.hex())
)
if prior_root is not None:
edge_rows.append(
(art.document_root, prior_root, doc.uri, "supersedes", "")
)
edges_to_upsert.append((art.document_root, doc))
inserted_this_batch.add(art.document_root)
prior_for_doc[doc.uri] = art.document_root
audit_events.append(
{
"event_type": "ingest",
"subject_root": art.document_root,
"ts": ingest_ts,
"body": {
"document_uri": doc.uri,
"source_type": doc.source_type,
"chunks": len(art.chunk_strs),
"chunking_version": chunker_name,
"canonicalization_version": CANONICALIZATION_VERSION,
"schema_version": SCHEMA_VERSION,
"supersedes": prior_root,
},
}
)
inserted += 1
# 3) One executemany per table — minimal Python<->C boundary crossings.
if documents_rows:
conn.executemany(
"INSERT INTO documents "
"(document_root, document_uri, source_type, kind, compression_depth, "
" title, chunking_version, canonicalization_version, schema_version, "
" ingest_ts) "
"VALUES (?, ?, ?, 'surface', 0, ?, ?, ?, ?, ?)",
documents_rows,
)
if chunk_rows:
conn.executemany(
"INSERT INTO chunks (document_root, idx, leaf_hash, content) "
"VALUES (?, ?, ?, ?)",
chunk_rows,
)
conn.executemany(
"INSERT INTO chunks_fts (document_root, idx, content) "
"VALUES (?, ?, ?)",
fts_rows,
)
if merkle_rows:
conn.executemany(
"INSERT INTO merkle_nodes (document_root, layer, idx, hash) "
"VALUES (?, ?, ?, ?)",
merkle_rows,
)
# 4) Edges: collect all wikilinks across the batch and resolve in
# one SELECT. Then one executemany.
_flush_edges(conn, edges_to_upsert)
if edge_rows:
conn.executemany(
"INSERT OR IGNORE INTO edges "
"(src_root, dst_root, dst_uri, edge_type, anchor) "
"VALUES (?, ?, ?, ?, ?)",
edge_rows,
)
# 5) Audit chain — hashes computed in Python, inserted in one call.
if audit_events:
prev = latest_event_hash(conn)
audit_rows, _ = chain_audit_events(prev, audit_events)
conn.executemany(
"INSERT INTO audit_events "
"(event_hash, prev_event_hash, event_type, subject_root, body, ts) "
"VALUES (?, ?, ?, ?, ?, ?)",
audit_rows,
)
return inserted, skipped
def _select_existing_roots(
conn: sqlite3.Connection, roots: list[str]
) -> set[str]:
"""Single SELECT to find which document_roots already exist."""
if not roots:
return set()
# SQLite has a default 999-param limit; chunk just in case.
found: set[str] = set()
for i in range(0, len(roots), 500):
slab = roots[i : i + 500]
placeholders = ",".join("?" * len(slab))
for row in conn.execute(
f"SELECT document_root FROM documents WHERE document_root IN ({placeholders})",
slab,
):
found.add(row["document_root"])
return found
def _flush_edges(
conn: sqlite3.Connection,
edges_to_upsert: list[tuple[str, Document]],
) -> None:
"""Upsert all wikilink/hyperlink edges across the batch.
Resolves dst_root for previously-unresolved URIs using a single batched
SELECT (URI -> document_root) instead of N per-edge SELECTs.
"""
if not edges_to_upsert:
return
# Collect distinct dst_uris across the batch for one resolution lookup.
distinct_uris: set[str] = set()
for _, doc in edges_to_upsert:
for e in doc.edges:
if e.dst_uri:
distinct_uris.add(e.dst_uri)
uri_to_root: dict[str, str] = {}
if distinct_uris:
uris_list = list(distinct_uris)
for i in range(0, len(uris_list), 500):
slab = uris_list[i : i + 500]
placeholders = ",".join("?" * len(slab))
for row in conn.execute(
"SELECT document_uri, document_root FROM documents "
f"WHERE document_uri IN ({placeholders})",
slab,
):
# Earliest ingest wins (matches prior LIMIT 1 ASC behavior).
uri_to_root.setdefault(row["document_uri"], row["document_root"])
rows: list[tuple] = []
for src_root, doc in edges_to_upsert:
for e in doc.edges:
dst_root = e.dst_root or uri_to_root.get(e.dst_uri or "", "")
rows.append(
(
src_root,
dst_root,
e.dst_uri or "",
e.edge_type,
e.anchor or "",
)
)
if rows:
conn.executemany(
"INSERT OR IGNORE INTO edges "
"(src_root, dst_root, dst_uri, edge_type, anchor) VALUES (?, ?, ?, ?, ?)",
rows,
)
def verify_random_sample(conn: sqlite3.Connection, n: int = 10) -> dict:
"""Sample N documents, regenerate Merkle proof for chunk 0, verify."""
from aborist.merkle import hash_leaf, verify_proof
rows = conn.execute(
"SELECT document_root FROM documents ORDER BY RANDOM() LIMIT ?", (n,)
).fetchall()
if not rows:
return {"sampled": 0, "passed": 0, "failed": 0}
passed = 0
failed = 0
for row in rows:
document_root = row["document_root"]
chunk_rows = conn.execute(
"SELECT idx, leaf_hash, content FROM chunks "
"WHERE document_root = ? ORDER BY idx ASC",
(document_root,),
).fetchall()
if not chunk_rows:
failed += 1
continue
leaves = [bytes.fromhex(r["leaf_hash"]) for r in chunk_rows]
c0 = chunk_rows[0]
if c0["content"] is not None:
recomputed_leaf = hash_leaf(c0["content"].encode("utf-8"))
if recomputed_leaf != leaves[0]:
failed += 1
continue
tree = MerkleTree.build(leaves)
if tree.root.hex() != document_root:
failed += 1
continue
proof = tree.proof(0)
if verify_proof(proof) and proof.root.hex() == document_root:
passed += 1
else:
failed += 1
return {"sampled": len(rows), "passed": passed, "failed": failed}