mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-08-08 05:48:53 +00:00
1f792d0f4b
* feat(extensions): add middleware plugin foundation * fix(extensions): stop config resolution from masking extension loading `create_app()` resolved the configured plugin list inside the fail-open guard around `load_extensions()`. CI has no `config.yaml` (gitignored and never generated by the workflow), so `get_app_config()` raised `FileNotFoundError` there and was swallowed as an extension failure -- `load_extensions()` never ran at all, and the four `create_app()` tests in `test_extension_app_loading.py` passed locally but failed on every runner. Resolve the plugin list before the guard. Only an absent `config.yaml` is tolerated, mirroring `_resolve_trace_enabled_for_app_construction()`: `create_app()` runs at import time, and lifespan still performs strict config loading before serving. A `config.yaml` that exists but fails to parse or validate now propagates instead of being reported as an extension failure -- reporting it as the latter silently dropped a `required: true` extension rather than failing the boot. Make the tests config-independent with an autouse `stub_app_config` fixture, following the existing pattern in `test_gateway_lifespan_shutdown.py`, and cover both new branches of the config-resolution boundary. * fix(extensions): bind the run's extension snapshot through subagent delegation The lead-agent path resolves one immutable loaded-extension snapshot per run and binds it through task-store allocation and graph construction, but the subagent path re-read the process-wide singleton at execution time. In production both are the same object, yet a `set_loaded_extensions()` between the lead run's start and a subagent's execution (test teardown, a future hot-reload path) would let one run mix two extension generations — exactly what the documented invariant exists to prevent. The graph-build binding is a ContextVar scoped to synchronous construction, so it has already exited by the time a tool delegates; the snapshot has to travel through runtime context instead. The run worker publishes it under the host-internal `EXTENSION_SNAPSHOT_CONTEXT_KEY` (written after the caller merge, popped when the run has none, so a caller-supplied value is never authoritative), `task_tool` reads it back through the type-checking `resolve_run_extensions()`, and `SubagentExecutor` binds it at construction. Callers outside the Gateway run path — embedded `DeerFlowClient`, standalone LangGraph Server — install no snapshot and keep the existing `get_loaded_extensions()` fallback. * refactor(extensions): defer the ordering table by call, not by a lying tuple `CORE_ORDERING_CONSTRAINTS` was a `tuple` subclass that overrode only `__iter__` and resolved into a class-level `_resolved` side channel. A tuple cannot populate its own storage after construction, so the instance stayed the empty tuple it was built as: `len()` was 0, `bool()` was False, `in` was always False, indexing raised, slicing and `reversed()` came back empty, and it compared unequal to the plain tuples tests substitute for it — all while iteration yielded the real constraints. Only `assert_ordering` consumed it, and only by iterating, so the split went unnoticed. The sibling `_AnchorTable(dict)` uses the same idea soundly because dict is mutable: `self.update()` fills the real storage, making every inherited operation correct. That trick does not survive the port to an immutable type. Replace it with `core_ordering_constraints()`, matching how `stack.py` defers the same kind of table via `_anchors()`. The deferral is kept — it is about dependency direction, not just cycles: `extensions/` is the layer the middleware layer calls into, so a module-scope `agents.middlewares` import here points the dependency backwards and closes a cycle as soon as any middleware imports something under `extensions/` at module level. Resolution stays at `assert_ordering` time, which already runs inside the middleware builder. Tests pin both halves: the returned value is a plain tuple whose len/bool/ membership/indexing/reversal/equality agree with iteration, and a subprocess probe asserts importing `extensions.ordering` does not load the middleware layer while calling the function does.
97 lines
3.2 KiB
Python
97 lines
3.2 KiB
Python
"""The extension contracts and their data types.
|
|
|
|
Compatibility rules enforced throughout this module:
|
|
* every Protocol method carries a default implementation, so adding a method
|
|
later stays additive for already-released extensions;
|
|
* every optional dataclass field carries a default, so adding a field stays
|
|
additive.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable, Mapping, Sequence
|
|
from dataclasses import dataclass
|
|
from typing import TYPE_CHECKING, Any, Protocol, TypeVar, runtime_checkable
|
|
|
|
from deerflow_extension_api.state import ExtensionData
|
|
|
|
if TYPE_CHECKING: # pragma: no cover - typing only
|
|
from deerflow_extension_api.placement import AgentBuildContext, MiddlewarePlacement
|
|
|
|
F = TypeVar("F", bound=Callable[..., Any])
|
|
|
|
|
|
# --- Host projections -------------------------------------------------------
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class HostPolicySnapshot:
|
|
"""The limits the host actually enforces, projected for extensions.
|
|
|
|
A narrow projection instead of the host's AppConfig: exposing AppConfig
|
|
would pin every extension to the harness release cadence. Every field has
|
|
a default so widening this stays additive.
|
|
"""
|
|
|
|
token_budget_enabled: bool = False
|
|
max_input_tokens: int | None = None
|
|
max_output_tokens: int | None = None
|
|
max_total_tokens: int | None = None
|
|
budget_warn_fraction: float | None = None
|
|
budget_hard_fraction: float | None = None
|
|
max_subagents_per_run: int | None = None
|
|
|
|
|
|
# --- Middleware -------------------------------------------------------------
|
|
|
|
|
|
class MiddlewareContributor(Protocol):
|
|
def contribute_middlewares(
|
|
self,
|
|
app_store: ExtensionData,
|
|
ctx: AgentBuildContext,
|
|
) -> Sequence[MiddlewarePlacement]:
|
|
return ()
|
|
|
|
|
|
# --- Registration surface ---------------------------------------------------
|
|
|
|
|
|
@runtime_checkable
|
|
class ExtensionRegistry(Protocol):
|
|
"""The write-only registration surface handed to ``install()``.
|
|
|
|
Structural and minimal on purpose. This first capability slice exposes
|
|
middleware contribution only; later slices can add defaulted registration
|
|
methods without breaking existing implementations. The host's concrete
|
|
registry additionally carries host-only machinery (attribution, positional
|
|
rollback, build) that is deliberately absent here.
|
|
"""
|
|
|
|
def middlewares(self, contributor: MiddlewareContributor) -> None:
|
|
return None
|
|
|
|
|
|
#: The install() entry point signature every extension exposes.
|
|
ExtensionInstall = Callable[[ExtensionRegistry, Mapping[str, Any]], None]
|
|
|
|
|
|
# --- Declaration decorator --------------------------------------------------
|
|
|
|
|
|
def extension(*, api: str, name: str | None = None) -> Callable[[F], F]:
|
|
"""Stamp an install function with the API version it was written against.
|
|
|
|
Optional. pip's dependency resolution is the primary compatibility
|
|
mechanism; this covers `--no-deps` installs and editable monorepo checkouts
|
|
where versions can skew, and turns a deep AttributeError into an
|
|
actionable startup diagnostic.
|
|
"""
|
|
|
|
def _decorate(func: F) -> F:
|
|
func.__deerflow_api__ = api # type: ignore[attr-defined]
|
|
func.__deerflow_name__ = name # type: ignore[attr-defined]
|
|
return func
|
|
|
|
return _decorate
|