PageIndex/pageindex/index/pipeline.py
mountain b9d021916f fix: prompt-injection delimiter escape, legacy config coercion, gather resilience, true cross-thread concurrency bound
Addresses items 4-8 from the max-effort review of PR #272 (VectifyAI/PageIndex#272).

- agent.py: wrap_with_doc_context() strips '<'/'>' from doc_name/doc_description
  (untrusted: unsanitized filename / LLM-generated from document content) before
  inserting them into the <docs>...</docs> block, so embedded content can never
  form a literal </docs> that closes the delimiter early and escapes the
  untrusted-data boundary SCOPED_SYSTEM_PROMPT relies on. Deterministic
  per-field transform, doesn't touch the (cacheable) static system prompt.

- ConfigLoader.load() (legacy 0.2.x compat) now routes merged overrides through
  IndexConfig before returning, so a legacy 'no' string gets pydantic's bool
  coercion instead of surviving as a truthy non-empty string — page_index_main's
  bare `if opt.if_add_node_summary:` checks (changed from `== 'yes'` elsewhere
  in this PR) were silently inverting caller intent and firing unwanted billed
  LLM calls.

- verify_toc, process_large_node_recursively, tree_parser,
  generate_summaries_for_structure, generate_summaries_for_structure_md: added
  return_exceptions=True to their asyncio.gather calls (llm_completion/
  llm_acompletion raise RuntimeError on retry exhaustion, added earlier in this
  PR), each with a degrade path matching the pattern already used by sibling
  hardened gathers in the same files. One transient LLM failure no longer
  aborts the whole document's indexing.

- _llm_semaphore is now a true process-wide ceiling (threading.Semaphore,
  shared across every thread/event loop) instead of one asyncio.Semaphore per
  event loop -- concurrently indexing N documents on N threads no longer
  multiplies the effective cap by N. A max_concurrency_scope() override is
  layered as a second, nested, per-loop restriction that can only tighten the
  effective cap within the ceiling, never widen past it.

- set_llm_params() mutated a bare process-wide dict with no per-call isolation,
  unlike max_concurrency which already had ContextVar scoping. Added
  llm_params_scope() (mirrors max_concurrency_scope) + IndexConfig.llm_params,
  wired into build_index() the same way max_concurrency already was, so
  concurrent indexing jobs with different llm kwargs don't leak into each
  other.

Adds regression tests for all five. Full suite: 221 passed, 2 skipped (one
pre-existing, unrelated flaky cloud-streaming test intermittently fails on
rerun; confirmed independent of this change).

Claude-Session: https://claude.ai/code/session_01Kx5DgKbhK1N8autqXH8SmS
2026-07-09 11:15:58 +08:00

147 lines
5.8 KiB
Python

# pageindex/index/pipeline.py
from __future__ import annotations
from ..parser.protocol import ContentNode, ParsedDocument
def detect_strategy(nodes: list[ContentNode]) -> str:
"""Determine which indexing strategy to use based on node data."""
if any(n.level is not None for n in nodes):
return "level_based"
return "content_based"
def build_tree_from_levels(nodes: list[ContentNode]) -> list[dict]:
"""Strategy 0: Build tree from explicit level information.
Adapted from pageindex/page_index_md.py:build_tree_from_nodes."""
stack = []
root_nodes = []
for node in nodes:
tree_node = {
"title": node.title or "",
"text": node.content,
"line_num": node.index,
"nodes": [],
}
current_level = node.level or 1
while stack and stack[-1][1] >= current_level:
stack.pop()
if not stack:
root_nodes.append(tree_node)
else:
parent_node, _ = stack[-1]
parent_node["nodes"].append(tree_node)
stack.append((tree_node, current_level))
return root_nodes
def _run_async(coro):
"""Run an async coroutine, handling the case where an event loop is already running."""
import asyncio
import concurrent.futures
import contextvars
# Only the detection is guarded — NOT the run. If the coroutine's own work
# raises RuntimeError, letting it fall into `except RuntimeError` here would
# misfire the "no running loop" branch and mask the real error behind a
# bogus "asyncio.run() cannot be called from a running event loop".
try:
asyncio.get_running_loop()
except RuntimeError:
# No running loop -- drive the coroutine directly.
return asyncio.run(coro)
# Already inside an event loop -- run in a separate thread so we don't nest
# asyncio.run. Copy the current context so ContextVar-based settings (e.g.
# the max_concurrency_scope override set by build_index) propagate into the
# worker thread; .result() re-raises the worker's real exception unchanged.
ctx = contextvars.copy_context()
with concurrent.futures.ThreadPoolExecutor(max_workers=1) as pool:
return pool.submit(ctx.run, asyncio.run, coro).result()
def build_index(parsed: ParsedDocument, model: str = None, opt=None) -> dict:
"""Main entry point: ParsedDocument -> tree structure dict.
Routes to the appropriate strategy and runs enhancement."""
from .utils import (write_node_id, add_node_text, remove_structure_text,
generate_summaries_for_structure, generate_doc_description,
create_clean_structure_for_description)
from ..config import IndexConfig, max_concurrency_scope, llm_params_scope
if opt is None:
opt = IndexConfig(model=model) if model else IndexConfig()
# Scope the per-index concurrency cap AND llm kwargs to THIS call only (per
# thread/async context), so concurrent indexing of other documents isn't
# affected and a one-off value never sticks as the process default.
with max_concurrency_scope(getattr(opt, "max_concurrency", None)), \
llm_params_scope(getattr(opt, "llm_params", None)):
nodes = parsed.nodes
strategy = detect_strategy(nodes)
if strategy == "level_based":
structure = build_tree_from_levels(nodes)
# For level-based, text is already in the tree nodes
else:
# Strategies 1-3: convert ContentNode list to page_list format for existing pipeline
page_list = [(n.content, n.tokens) for n in nodes]
structure = _run_async(_content_based_pipeline(page_list, opt))
# Unified enhancement
if opt.if_add_node_id:
write_node_id(structure)
if strategy != "level_based":
if opt.if_add_node_text or opt.if_add_node_summary:
add_node_text(structure, page_list)
if opt.if_add_node_summary:
_run_async(generate_summaries_for_structure(structure, model=opt.model))
result = {
"doc_name": parsed.doc_name,
"structure": structure,
}
if opt.if_add_doc_description:
clean_structure = create_clean_structure_for_description(structure)
result["doc_description"] = generate_doc_description(
clean_structure, model=opt.model
)
# 'text' is populated for level_based (Markdown, always) or for
# content_based when if_add_node_text/if_add_node_summary requested it.
# Strip it LAST, for BOTH strategies, unless explicitly requested —
# otherwise a default index leaks each node's full text into
# get_document_structure / storage, inconsistent with
# if_add_node_text=False, the README, and the legacy md_to_tree. Skip
# the walk entirely when text was never added in the first place
# (content_based with if_add_node_text=if_add_node_summary=False) —
# there's nothing to strip.
text_present = strategy == "level_based" or opt.if_add_node_text or opt.if_add_node_summary
if text_present and not opt.if_add_node_text:
remove_structure_text(structure)
return result
class _NullLogger:
"""Minimal logger that satisfies the tree_parser interface without writing files."""
def info(self, message, **kwargs): pass
def error(self, message, **kwargs): pass
def debug(self, message, **kwargs): pass
async def _content_based_pipeline(page_list, opt):
"""Strategies 1-3: delegates to the existing PDF pipeline from pageindex/page_index.py.
The page_list is already in the format expected by tree_parser:
[(page_text, token_count), ...]
"""
from .page_index import tree_parser
logger = _NullLogger()
structure = await tree_parser(page_list, opt, doc=None, logger=logger)
return structure