Compare commits

...
Author SHA1 Message Date
Ahmed Allam 99c0711687 fix(config): use the Responses API whenever the model's catalog entry lists /v1/responses 2026-10-02 18:41:53 +03:00
Ahmed Allam 2635fb5307 chore(inputs): drop unused logger 2026-10-02 18:17:27 +03:00
Ahmed Allam 8ab5e39c06 fix(inputs): send reasoning_effort as configured; no route-specific handling 2026-10-02 18:17:27 +03:00
Ahmed Allam e1ec259ac2 fix(inputs): send reasoning_effort=none explicitly on chat completions; hint at the Responses API when tools+effort are rejected 2026-10-02 18:17:27 +03:00
Ahmed Allam 066bd60a03 fix(runner): pick the SDK route from the resolved model override
configure_sdk_model_defaults only sees STRIX_LLM; a model= override to
run_strix_scan re-applies the route for the model that actually runs.
2026-10-02 18:17:27 +03:00
Ahmed Allam 6ab123484d fix(config): choose Responses vs chat completions from the model, not the base URL
A base URL no longer forces chat completions. resolve_api_type() keeps an
explicit STRIX_API_TYPE, uses Responses without a base URL or for
api.openai.com, uses Responses for models whose LiteLLM catalog entry has
no /v1/chat/completions endpoint, and chat completions for other gateways.

On the chat completions route, reasoning_effort is omitted for models
whose LiteLLM parameter map does not list it there instead of failing the
request with function tools. STRIX_REASONING_EFFORT and STRIX_API_TYPE
are matched case-insensitively.
2026-10-02 18:17:27 +03:00
alex s 007ed1a94e fix(reporting): restore create_vulnerability_report parameter descrip… (#1391)
* fix(reporting): restore create_vulnerability_report parameter descriptions

A docstring line beginning with a backtick fence example opened a markdown
code block that griffe's Google-style parser never saw closed, so the Args
section was parsed as plain text and the generated tool schema carried no
per-parameter descriptions. Reword the example, move Args after the trailing
notes so nothing after it is dropped from the tool description, and add a
test asserting every scan-agent tool parameter has a description.

* test(reporting): cover respond_to_user and reject null parameter descriptions
2026-09-30 13:26:48 -04:00
Ahmed Allam ef272b8e0d chore(models): remove the model quality warning and its allowlists 2026-09-30 10:04:28 +03:00
Ian 9b72488c92 docs + unit test fix 2026-09-30 04:46:01 +03:00
Ian c77bdd2c2a Disable by default 2026-09-30 04:46:01 +03:00
Ian c814f6bf30 Made session IDs optional 2026-09-30 04:46:01 +03:00
Ian a1658fe59b Scarf support 2026-09-30 04:46:01 +03:00
Ian 3fbccc6b1d Non-streaming path 2026-09-30 04:46:01 +03:00
Ian c9aebc6c87 larger default block size 2026-09-30 04:46:01 +03:00
Ian 95fbd8d687 Openrouter sticky sessions for caching, with telemetry 2026-09-30 04:46:01 +03:00
Ahmed Allam 463b149bdb fix(budget): parked agents count as active; park never overwrites a stop
active_agents_except (finish_scan, wait_for_message) treats budget_paused as
active, so a root cannot finish the scan over a parked child. park_for_budget
only transitions a running agent, and the wake back to running happens under
the coordinator lock.
2026-09-30 03:13:40 +03:00
Ahmed Allam d355838ea0 feat(budget): budget_policy=pause parks every agent at the limit until the operator resumes
Adds budget_policy: stop | pause to run_strix_scan / ReportUsageHooks /
AgentCoordinator, independent of interactive mode. Under pause the agents
get no budget warnings and no sub-agent reserve; each agent parks before
its next LLM call once spent >= limit or the scan is paused, sessions and
sandbox stay alive, and coordinator.resume_budget(max_budget_usd=...)
replaces the limit and wakes every parked agent without adding anything
to any session. coordinator.pause_budget() parks a running scan the same
way. In-flight calls are never cancelled, so spent may end above the
limit. Parked agents count as active for stop_agent.
2026-09-30 03:13:40 +03:00
26 changed files with 1354 additions and 387 deletions

No files matched your search

+8
View File
@@ -49,6 +49,14 @@ Configure Strix using environment variables or a config file.
Timeout in seconds for memory compression operations (context summarization).
</ParamField>
<ParamField path="STRIX_OPENROUTER_STICKY_SESSIONS" default="false" type="boolean">
Send a per-agent `session_id` on OpenRouter requests, so each agent's calls stay on one upstream provider and its prompt cache carries over between turns. When unset, OpenRouter routes every request freely.
</ParamField>
<ParamField path="STRIX_CACHE_BLOCK_TOKENS" default="128" type="integer">
Token block size that providers cache prompts in. A turn counts as a cache miss in the run report only when the cached tokens fall at least this many tokens short of the previous prompt and the prompt did not shrink. Lower it for providers with smaller blocks (DeepSeek and GLM use 64; vLLM defaults to 16).
</ParamField>
### Dedicated deduplication model
Finding deduplication is a cheap, structured classification task. By default it
+77 -109
View File
@@ -8,6 +8,7 @@ import inspect
import logging
import os
import time
import uuid
from collections.abc import AsyncGenerator
from typing import TYPE_CHECKING, Any, cast
@@ -57,7 +58,7 @@ if TYPE_CHECKING:
from openai import AsyncOpenAI
from openai.types.responses.response_prompt_param import ResponsePromptParam
from strix.config.settings import LlmSettings, ReasoningEffort, Settings
from strix.config.settings import ApiType, LlmSettings, ReasoningEffort, Settings
logger = logging.getLogger(__name__)
@@ -631,61 +632,6 @@ DEFAULT_MODEL_RETRY = ModelRetrySettings(
),
)
RECOMMENDED_MODEL_NAMES = (
"zai/glm-5.3",
"zai/glm-5.3-flash",
"openai/gpt-5.6-sol",
"openai/gpt-5.6-terra",
"openai/gpt-5.6-luna",
"openai/gpt-5.6",
"openai/gpt-5.5-pro",
"openai/gpt-5.5",
"openai/gpt-5.4",
"openai/gpt-5.3-codex",
"anthropic/claude-fable-5-1",
"anthropic/claude-fable-5",
"anthropic/claude-opus-5",
"anthropic/claude-opus-4-8",
"anthropic/claude-sonnet-5",
"anthropic/claude-sonnet-4-6",
"vertex_ai/gemini-3.1-pro-preview",
"gemini/gemini-3.1-pro-preview",
"vertex_ai/gemini-3.7-flash",
"gemini/gemini-3.7-flash",
"gemini/gemini-3.6-flash",
"deepseek/deepseek-v4-pro",
"deepseek/deepseek-v4-flash",
"dashscope/qwen3.8-max",
"dashscope/qwen3.7-max-2026-06-08",
"moonshot/kimi-k3",
"moonshot/kimi-k2.7-code",
)
_RECOMMENDED_MODEL_NAME_SET = frozenset(name.lower() for name in RECOMMENDED_MODEL_NAMES)
# Matched against the bare model name only: the route (``openai/``, ``openrouter/``,
# a local gateway, ...) says nothing about the model's quality.
FRONTIER_MODEL_PREFIXES = (
"gpt-5",
"claude-fable-5",
"claude-opus-5",
"claude-opus-4",
"claude-sonnet-5",
"claude-sonnet-4",
"gemini-3",
"deepseek-v4",
"deepseek-r1",
"deepseek-reasoner",
"qwen3.8",
"qwen3.7",
"qwen3-max",
"kimi-k3",
"kimi-k2.7",
"kimi-k2.6",
"glm-5.3",
"glm-5.2",
)
def configure_sdk_model_defaults(settings: Settings) -> None:
"""Apply Strix config to SDK-native defaults."""
@@ -703,14 +649,40 @@ def configure_sdk_model_defaults(settings: Settings) -> None:
if llm.api_base:
os.environ["OPENAI_BASE_URL"] = llm.api_base
_configure_litellm_default("api_base", llm.api_base)
api_type = llm.api_type
if api_type is None:
api_type = "chat_completions" if llm.api_base else "responses"
set_default_openai_api(api_type)
configure_sdk_api_route(llm.model or "", settings)
_configure_extra_headers(llm)
def configure_sdk_api_route(model_name: str, settings: Settings) -> None:
"""Point SDK-native OpenAI requests for ``model_name`` at Responses or chat completions."""
api_type = resolve_api_type(model_name, settings)
logger.info("OpenAI API route for %s: %s", model_name, api_type)
set_default_openai_api(api_type)
_RESPONSES_ENDPOINT = "/v1/responses"
def resolve_api_type(model_name: str, settings: Settings) -> ApiType:
"""The SDK-native OpenAI route for ``model_name``: Responses or chat completions.
An explicit ``STRIX_API_TYPE`` wins. Otherwise the model decides: Responses
when LiteLLM's catalog lists ``/v1/responses`` for it, chat completions for
everything else.
"""
if settings.llm.api_type is not None:
return settings.llm.api_type
if _RESPONSES_ENDPOINT in _catalog_supported_endpoints(model_name):
return "responses"
return "chat_completions"
def _catalog_supported_endpoints(model_name: str) -> list[str]:
entry = _catalog_entry(model_name)
endpoints = entry.get("supported_endpoints") if entry else None
return [str(e) for e in endpoints] if isinstance(endpoints, list) else []
def _mirror_api_key_to_provider_env(model_name: str | None, api_key: str) -> None:
if not model_name:
return
@@ -746,6 +718,11 @@ def _configure_litellm_compatibility() -> None:
_install_openrouter_stream_cost_capture()
# Agent ids are 8 hex characters and can repeat across runs; the session id
# OpenRouter pins a provider to must not, so each agent gets its own UUID.
_OPENROUTER_SESSION_IDS: dict[str, str] = {}
def _install_openrouter_stream_cost_capture() -> None:
"""Preserve OpenRouter's per-stream cost, which LiteLLM drops when streaming.
@@ -764,14 +741,16 @@ def _install_openrouter_stream_cost_capture() -> None:
OpenrouterConfig,
)
from strix.report.state import streamed_openrouter_costs
from strix.report.state import record_openrouter_provider, streamed_openrouter_costs
class _StrixOpenRouterStreamingHandler(OpenRouterChatCompletionStreamingHandler):
def chunk_parser(self, chunk: dict[str, Any]) -> Any:
stream = super().chunk_parser(chunk)
streamed_openrouter_costs.remember(
chunk.get("id") or getattr(stream, "id", None), chunk.get("usage")
)
usage = chunk.get("usage")
response_id = chunk.get("id") or getattr(stream, "id", None)
streamed_openrouter_costs.remember(response_id, usage)
if usage:
record_openrouter_provider(chunk.get("provider"), usage)
return stream
class _StrixOpenrouterConfig(OpenrouterConfig):
@@ -784,6 +763,26 @@ def _install_openrouter_stream_cost_capture() -> None:
json_mode=json_mode,
)
def transform_response(self, *args: Any, **kwargs: Any) -> Any:
# Non-streamed replies (LLM_DISABLE_STREAMING) skip the chunk parser.
response = super().transform_response(*args, **kwargs)
raw_response = kwargs.get("raw_response", args[1] if len(args) > 1 else None)
with contextlib.suppress(Exception):
body = raw_response.json() # type: ignore[union-attr]
if body.get("usage"):
record_openrouter_provider(body.get("provider"), body["usage"])
return response
def transform_request(self, *args: Any, **kwargs: Any) -> dict[str, Any]:
# Pin each agent's calls to one upstream provider so its prompt cache
# survives between turns.
body = super().transform_request(*args, **kwargs)
agent_id = request_log.current_call_context().agent_id
if agent_id and load_settings().llm.openrouter_sticky_sessions:
session_id = _OPENROUTER_SESSION_IDS.setdefault(agent_id, str(uuid.uuid4()))
body.setdefault("session_id", session_id)
return body
# LiteLLM's provider-config factory reads litellm.OpenrouterConfig at call
# time, so overriding the attribute is enough for the subclass to take
# effect. (type: ignore — mypy rejects reassigning a class attribute.)
@@ -886,11 +885,7 @@ def uses_chat_completions_tool_schema(model_name: str, settings: Settings) -> bo
model = model_name.strip().lower()
if "/" in model and not model.startswith("openai/"):
return True
if settings.llm.api_type is not None:
return settings.llm.api_type == "chat_completions"
if settings.llm.api_base:
return True
return not model_supports_reasoning(model_name)
return resolve_api_type(model_name, settings) == "chat_completions"
def supports_strict_tool_schemas(model_name: str) -> bool:
@@ -906,54 +901,27 @@ def supports_strict_tool_schemas(model_name: str) -> bool:
def model_supports_reasoning(model_name: str) -> bool:
import litellm
name = model_name.strip().lower()
for prefix in ("litellm/", "any-llm/", "openai/"):
if name.startswith(prefix):
name = name[len(prefix) :]
break
entry = litellm.model_cost.get(name)
if entry is None and "/" in name:
entry = litellm.model_cost.get(name.rsplit("/", 1)[1])
entry = _catalog_entry(model_name)
return bool(entry and entry.get("supports_reasoning"))
def is_recommended_or_frontier_model(model_name: str) -> bool:
"""Return whether a model is recommended or in a frontier model family."""
name = _normalized_model_name(model_name)
if not name:
return False
if name in _RECOMMENDED_MODEL_NAME_SET:
return True
bare_model_name = name.rsplit("/", 1)[-1]
return _matches_model_prefix(bare_model_name, FRONTIER_MODEL_PREFIXES)
def _normalized_model_name(model_name: str) -> str:
def _bare_openai_name(model_name: str) -> str:
name = model_name.strip().lower()
for prefix in ("litellm/", "any-llm/"):
for prefix in ("litellm/", "any-llm/", "openai/"):
if name.startswith(prefix):
name = name[len(prefix) :]
break
return name[len(prefix) :]
return name
def _matches_model_prefix(model_name: str, model_prefixes: tuple[str, ...]) -> bool:
return any(
candidate.startswith(prefix)
for candidate in _model_name_candidates(model_name)
for prefix in model_prefixes
)
def _catalog_entry(model_name: str) -> dict[str, Any] | None:
"""LiteLLM's cost-map entry for the model, looked up as it would route it."""
import litellm
def _model_name_candidates(model_name: str) -> tuple[str, ...]:
if "." not in model_name:
return (model_name,)
suffixes = tuple(
model_name.split(".", index)[-1] for index in range(1, model_name.count(".") + 1)
)
return (model_name, *suffixes)
name = _bare_openai_name(model_name)
entry = litellm.model_cost.get(name)
if entry is None and "/" in name:
entry = litellm.model_cost.get(name.rsplit("/", 1)[1])
return entry if isinstance(entry, dict) else None
def is_known_openai_bare_model(model_name: str) -> bool:
+25 -1
View File
@@ -4,7 +4,7 @@ from __future__ import annotations
from typing import Literal
from pydantic import AliasChoices, Field
from pydantic import AliasChoices, Field, field_validator
from pydantic_settings import BaseSettings, SettingsConfigDict
@@ -13,6 +13,12 @@ ApiType = Literal["responses", "chat_completions"]
DEFAULT_MAX_TURNS = 500
def _lowercase(value: object) -> object:
"""Enum-like env values are matched case-insensitively (``None`` is ``none``)."""
return value.strip().lower() if isinstance(value, str) else value
_BASE_CONFIG = SettingsConfigDict(
case_sensitive=False,
populate_by_name=True,
@@ -58,6 +64,14 @@ class LlmSettings(BaseSettings):
default=True,
alias="STRIX_PROMPT_CACHE",
)
# Providers cache prompts in fixed-size token blocks, so a fully cached prompt
# can read back up to a block short. 128 covers the largest common size
# (OpenAI; DeepSeek and GLM use 64, vLLM defaults to 16).
cache_block_tokens: int = Field(default=128, ge=1, alias="STRIX_CACHE_BLOCK_TOKENS")
openrouter_sticky_sessions: bool = Field(
default=False,
alias="STRIX_OPENROUTER_STICKY_SESSIONS",
)
disable_streaming: bool = Field(
default=False,
alias="LLM_DISABLE_STREAMING",
@@ -70,6 +84,11 @@ class LlmSettings(BaseSettings):
alias="LLM_MAX_TOOL_CALLS_PER_TURN",
)
@field_validator("api_type", "reasoning_effort", mode="before")
@classmethod
def _normalize_case(cls, value: object) -> object:
return _lowercase(value)
class DedupeSettings(BaseSettings):
model_config = _BASE_CONFIG
@@ -87,6 +106,11 @@ class DedupeSettings(BaseSettings):
repr=False,
)
@field_validator("reasoning_effort", mode="before")
@classmethod
def _normalize_case(cls, value: object) -> object:
return _lowercase(value)
class ContextSettings(BaseSettings):
"""Context-window management: per-tool-output caps and history compaction."""
+112 -13
View File
@@ -24,8 +24,14 @@ logger = logging.getLogger(__name__)
Status = Literal["running", "waiting", "completed", "stopped", "crashed", "failed", "budget_paused"]
BudgetPolicy = Literal["stop", "pause"]
TERMINAL_STATUSES: frozenset[str] = frozenset({"completed", "stopped", "crashed", "failed"})
# Agents that still have work to do or to wake up for. A parked agent is mid-task:
# a scan is not finished while one exists, and it can be stopped like any other.
ACTIVE_STATUSES: frozenset[str] = frozenset({"running", "waiting", "budget_paused"})
# Why an agent parked. The user can message any agent, so this - not the agent's
# position in the tree - decides whether waiting is bounded: only an agent waiting
# on other agents is re-checked on a timer.
@@ -68,7 +74,10 @@ class AgentCoordinator:
self._budget_stopped = False
self._reserve_stopped = False
self._budget_paused = False
self._resume_epoch = 0
self._budget_policy: BudgetPolicy = "stop"
self._extend_budget: Callable[[], None] | None = None
self._set_budget_limit: Callable[[float | None], None] | None = None
def set_snapshot_path(self, path: Path) -> None:
self._snapshot_path = path
@@ -95,15 +104,100 @@ class AgentCoordinator:
def budget_paused(self) -> bool:
return self._budget_paused
@property
def resume_epoch(self) -> int:
"""Bumped by every ``resume_budget``; an agent parks against the value it read."""
return self._resume_epoch
@property
def budget_policy(self) -> BudgetPolicy:
return self._budget_policy
def set_budget_policy(self, policy: BudgetPolicy) -> None:
self._budget_policy = policy
def set_budget_extender(self, extend: Callable[[], None]) -> None:
self._extend_budget = extend
def set_budget_limit_setter(self, setter: Callable[[float | None], None]) -> None:
self._set_budget_limit = setter
async def pause_for_budget(self, agent_id: str) -> None:
async with self._lock:
self._budget_paused = True
await self.set_status(agent_id, "budget_paused")
async def park_for_budget(self, agent_id: str) -> bool:
"""Park ``agent_id`` before an LLM call (pause policy).
Only a ``running`` agent parks; returns False when it was stopped in the
meantime, so the stop is not overwritten.
"""
async with self._lock:
if self.statuses.get(agent_id) != "running":
return False
self._set_status_locked(agent_id, "budget_paused")
logger.info("agent.status %s=budget_paused", agent_id)
await self._maybe_snapshot()
return True
async def pause_budget(self) -> None:
"""Operator pause: every agent parks before its next LLM call.
Agents mid-call or mid-tool finish that step first, so their spend still
lands; nothing is cancelled.
"""
async with self._lock:
self._budget_paused = True
logger.info("scan paused by the operator")
await self._maybe_snapshot()
async def resume_budget(self, *, max_budget_usd: float | None = None) -> list[str]:
"""Lift the pause and wake every parked agent; returns the woken agent ids.
With ``max_budget_usd`` the scan's limit is replaced first (``None`` keeps
the current one). Agents continue with the LLM call they parked on; no
message is added to any session. An agent that parks again on its next
call (the new limit is already spent) is not an error.
"""
if max_budget_usd is not None and self._set_budget_limit is not None:
self._set_budget_limit(max_budget_usd)
async with self._lock:
self._budget_paused = False
self._resume_epoch += 1
woken = [aid for aid, status in self.statuses.items() if status == "budget_paused"]
for aid in woken:
self.runtimes.setdefault(aid, AgentRuntime()).wake.set()
logger.info("scan resumed; woke %d parked agent(s)", len(woken))
await self._maybe_snapshot()
return woken
async def wait_for_budget_resume(self, agent_id: str, *, parked_epoch: int) -> None:
"""Block until a resume newer than ``parked_epoch``, a scan-wide stop, or
the agent itself being stopped while parked.
``parked_epoch`` is the ``resume_epoch`` the agent read when it decided to
park, so a resume that lands between that decision and this wait is not
missed. The switch back to ``running`` happens under the lock, so a stop
can never be overwritten by it; on return the agent is ``running`` unless
it was stopped.
"""
while True:
async with self._lock:
runtime = self.runtimes.setdefault(agent_id, AgentRuntime())
if self._budget_stopped or self.statuses.get(agent_id) != "budget_paused":
return
if self._resume_epoch != parked_epoch:
self._set_status_locked(agent_id, "running")
break
wake = runtime.wake
wake.clear()
await wake.wait()
logger.info("agent.status %s=running", agent_id)
await self._maybe_snapshot()
async def resume_from_budget_pause(self, *, exclude: str | None = None) -> None:
"""Legacy interactive resume: extend by the original budget and nudge agents."""
async with self._lock:
if not self._budget_paused:
return
@@ -258,20 +352,25 @@ class AgentCoordinator:
async with self._lock:
if agent_id not in self.statuses:
return
self.statuses[agent_id] = status # type: ignore[assignment]
if error is not None:
self.errors[agent_id] = error
elif status == "running":
self.errors.pop(agent_id, None)
if status == "running":
# Running again means a fresh stint that owes its parent its own notice.
self._parent_notified.discard(agent_id)
runtime = self.runtimes.setdefault(agent_id, AgentRuntime())
runtime.user_wake_required = status in {"failed", "crashed"}
runtime.wake.set()
self._set_status_locked(agent_id, status, error=error)
logger.info("agent.status %s=%s", agent_id, status)
await self._maybe_snapshot()
def _set_status_locked(
self, agent_id: str, status: Status | str, *, error: str | None = None
) -> None:
self.statuses[agent_id] = status # type: ignore[assignment]
if error is not None:
self.errors[agent_id] = error
elif status == "running":
self.errors.pop(agent_id, None)
if status == "running":
# Running again means a fresh stint that owes its parent its own notice.
self._parent_notified.discard(agent_id)
runtime = self.runtimes.setdefault(agent_id, AgentRuntime())
runtime.user_wake_required = status in {"failed", "crashed"}
runtime.wake.set()
async def claim_parent_notice(self, agent_id: str) -> bool:
"""Reserve the one notice a child owes its parent when it stops running.
@@ -308,7 +407,7 @@ class AgentCoordinator:
unknown, or it is terminal and its loop does not park for wake-ups.
"""
from_user = message.get("from") == "user"
if from_user and self._budget_paused:
if from_user and self._budget_paused and self._budget_policy != "pause":
await self.resume_from_budget_pause(exclude=target_agent_id)
async with self._lock:
if target_agent_id not in self.statuses:
@@ -462,7 +561,7 @@ class AgentCoordinator:
"parent_id": self.parent_of.get(aid),
}
for aid, status in self.statuses.items()
if aid != agent_id and status in {"running", "waiting"}
if aid != agent_id and status in ACTIVE_STATUSES
]
async def graph_snapshot(
+49 -28
View File
@@ -522,33 +522,51 @@ async def _run_until_lifecycle(
await coordinator.set_status(agent_id, "stopped")
raise SubagentBudgetReservedError("scan reached the sub-agent budget reserve")
if interactive:
result = await _run_cycle_parked(
agent,
coordinator,
agent_id,
input_data=input_data,
run_config=run_config,
context=context,
max_turns=max_turns,
session=session,
event_sink=event_sink,
hooks=hooks,
)
else:
result = await _run_cycle(
agent,
coordinator,
agent_id,
input_data=input_data,
run_config=run_config,
context=context,
max_turns=max_turns,
session=session,
interactive=False,
event_sink=event_sink,
hooks=hooks,
)
try:
if interactive:
result = await _run_cycle_parked(
agent,
coordinator,
agent_id,
input_data=input_data,
run_config=run_config,
context=context,
max_turns=max_turns,
session=session,
event_sink=event_sink,
hooks=hooks,
)
else:
result = await _run_cycle(
agent,
coordinator,
agent_id,
input_data=input_data,
run_config=run_config,
context=context,
max_turns=max_turns,
session=session,
interactive=False,
event_sink=event_sink,
hooks=hooks,
)
except BudgetPausedError as exc:
if coordinator.budget_policy != "pause":
raise
# The agent parked right before an LLM call; everything up to that
# point is already in its session. Once resumed, the same call goes
# out with nothing added to the conversation.
await coordinator.wait_for_budget_resume(agent_id, parked_epoch=exc.resume_epoch)
if (
not coordinator.budget_stopped
and await _agent_status(coordinator, agent_id) != "running"
):
# Stopped while parked (operator stop or a parent's stop_agent).
await coordinator.reset_recovery(agent_id)
return result
if session is not None:
input_data = []
continue
status = await _agent_status(coordinator, agent_id)
if status != "running":
@@ -759,7 +777,10 @@ async def _run_cycle( # noqa: PLR0912, PLR0915
await coordinator.detach_stream(agent_id, stream)
except BudgetPausedError as exc:
logger.info("agent %s paused at the scan budget limit: %s", agent_id, exc)
await coordinator.pause_for_budget(agent_id)
if coordinator.budget_policy == "pause":
await coordinator.park_for_budget(agent_id)
else:
await coordinator.pause_for_budget(agent_id)
raise
except SubagentBudgetReservedError as exc:
logger.info("sub-agent %s stopped at the budget reserve: %s", agent_id, exc)
+89 -7
View File
@@ -8,6 +8,7 @@ from typing import TYPE_CHECKING, Any
from agents.lifecycle import RunHooks
from strix.core.agents import BudgetPolicy, coordinator_from_context
from strix.report.state import get_global_report_state
@@ -22,6 +23,26 @@ logger = logging.getLogger(__name__)
LLM_TURN_KEY = "llm_turn"
# ``BudgetPolicy`` decides what happens when the accumulated LLM cost reaches
# ``max_budget_usd``.
#
# ``stop``: the agents are warned as the limit approaches, sub-agents are cut at
# a reserve so the root can write its report, and the scan ends at the limit.
#
# ``pause``: the agents are never told a limit exists. Every agent parks right
# before its next LLM call once the limit is reached (or an operator pauses the
# scan), keeping its session, context and sandbox alive, and continues with that
# same call when the operator raises the limit or resumes.
__all__ = [
"LLM_TURN_KEY",
"BudgetExceededError",
"BudgetPausedError",
"BudgetPolicy",
"ReportUsageHooks",
"SubagentBudgetReservedError",
"recomputed_budget_flags",
]
_STAGE_LABELS: tuple[str, ...] = ("NOTICE", "URGENT", "CRITICAL")
_TURN_WARN_BANDS: tuple[float, ...] = (0.70, 0.85, 0.95)
_ROOT_BUDGET_WARN_BANDS: tuple[float, ...] = (0.70, 0.85, 0.95)
@@ -38,7 +59,20 @@ class SubagentBudgetReservedError(RuntimeError):
class BudgetPausedError(RuntimeError):
"""Raised to park one agent when an interactive scan reaches its budget."""
"""Raised to park one agent until the scan budget is raised or the pause lifted.
``resume_epoch`` is the coordinator's ``resume_epoch`` at the moment the agent
decided to park; the agent waits for a resume newer than that.
"""
def __init__(self, message: str, *, resume_epoch: int = 0) -> None:
super().__init__(message)
self.resume_epoch = resume_epoch
def _validate_budget(max_budget_usd: float | None) -> None:
if max_budget_usd is not None and (not math.isfinite(max_budget_usd) or max_budget_usd <= 0):
raise ValueError("max_budget_usd must be a finite number greater than 0")
def recomputed_budget_flags(
@@ -46,11 +80,12 @@ def recomputed_budget_flags(
max_budget_usd: float | None,
*,
interactive: bool,
budget_policy: BudgetPolicy = "stop",
) -> tuple[bool, bool]:
"""Return the (budget_stopped, reserve_stopped) flags a resumed scan should carry."""
if max_budget_usd is None:
return False, False
if interactive:
if interactive or budget_policy == "pause":
return False, False
budget_stopped = cost >= max_budget_usd
reserve_stopped = cost >= max_budget_usd * _SUBAGENT_BUDGET_RESERVE
@@ -121,18 +156,32 @@ class ReportUsageHooks(RunHooks[dict[str, Any]]):
max_budget_usd: float | None = None,
max_turns: int | None = None,
interactive: bool = False,
budget_policy: BudgetPolicy = "stop",
) -> None:
if max_budget_usd is not None and (
not math.isfinite(max_budget_usd) or max_budget_usd <= 0
):
raise ValueError("max_budget_usd must be a finite number greater than 0")
_validate_budget(max_budget_usd)
if max_turns is not None and max_turns <= 0:
raise ValueError("max_turns must be a positive integer")
if budget_policy not in ("stop", "pause"):
raise ValueError(f"unknown budget_policy: {budget_policy!r}")
self._model = model
self._max_budget_usd = max_budget_usd
self._budget_increment = max_budget_usd
self._max_turns = max_turns
self._interactive = interactive
self._budget_policy: BudgetPolicy = budget_policy
@property
def max_budget_usd(self) -> float | None:
return self._max_budget_usd
@property
def budget_policy(self) -> BudgetPolicy:
return self._budget_policy
def set_max_budget_usd(self, max_budget_usd: float | None) -> None:
"""Replace the scan's cost limit; ``None`` removes it."""
_validate_budget(max_budget_usd)
self._max_budget_usd = max_budget_usd
def extend_budget(self) -> None:
if self._max_budget_usd is None or self._budget_increment is None:
@@ -146,6 +195,8 @@ class ReportUsageHooks(RunHooks[dict[str, Any]]):
system_prompt: str | None, # noqa: ARG002
input_items: list[TResponseInputItem],
) -> None:
if self._budget_policy == "pause":
self._pause_if_limited(context)
context.context[LLM_TURN_KEY] = int(context.context.get(LLM_TURN_KEY, 0)) + 1
try:
self._maybe_warn_turns(context, input_items)
@@ -153,6 +204,32 @@ class ReportUsageHooks(RunHooks[dict[str, Any]]):
except Exception:
logger.exception("budget/turn warning injection failed")
def _pause_if_limited(self, context: RunContextWrapper[dict[str, Any]]) -> None:
"""Park the agent before a paid call when the scan is at its limit or paused.
Only calls that have already returned are counted, so calls in flight on
other agents still land and are paid for: ``spent`` may end up above the
limit, which is expected and never an error under this policy.
"""
coordinator = coordinator_from_context(context.context)
epoch = coordinator.resume_epoch if coordinator is not None else 0
if coordinator is not None and coordinator.budget_paused:
raise BudgetPausedError(
"scan paused; waiting for the operator to resume", resume_epoch=epoch
)
if self._max_budget_usd is None:
return
report_state = get_global_report_state()
if report_state is None:
return
cost = report_state.get_total_llm_cost()
if cost >= self._max_budget_usd:
raise BudgetPausedError(
f"Scan budget of ${self._max_budget_usd:.2f} reached (spent ${cost:.4f}); "
"pausing until the operator raises the limit",
resume_epoch=epoch,
)
def _maybe_warn_turns(
self,
context: RunContextWrapper[dict[str, Any]],
@@ -182,7 +259,7 @@ class ReportUsageHooks(RunHooks[dict[str, Any]]):
context: RunContextWrapper[dict[str, Any]],
input_items: list[TResponseInputItem],
) -> None:
if self._max_budget_usd is None:
if self._max_budget_usd is None or self._budget_policy == "pause":
return
report_state = get_global_report_state()
if report_state is None:
@@ -250,6 +327,11 @@ class ReportUsageHooks(RunHooks[dict[str, Any]]):
except Exception:
logger.exception("failed to record SDK usage for agent %s", agent_id)
if self._budget_policy == "pause":
# The finished call is paid for and its tool calls still run for free;
# the agent parks before its next call, in ``on_llm_start``.
return
if self._max_budget_usd is not None:
cost = report_state.get_total_llm_cost()
if cost >= self._max_budget_usd:
+1 -3
View File
@@ -267,9 +267,7 @@ def make_model_settings(
and reasoning_effort != "none"
and model_supports_reasoning(model_name)
):
model_settings = model_settings.resolve(
_reasoning_settings(reasoning_effort),
)
model_settings = model_settings.resolve(_reasoning_settings(reasoning_effort))
if force_required_tool_choice and _accepts_required_tool_choice(model_name):
model_settings = model_settings.resolve(ModelSettings(tool_choice="required"))
+27 -4
View File
@@ -18,15 +18,16 @@ from openai import RateLimitError
from strix.agents.factory import build_strix_agent, make_child_factory
from strix.agents.prompt import render_scope_prompt, render_system_prompt
from strix.config import load_settings
from strix.config import codex, load_settings
from strix.config.models import (
StrixProvider,
configure_sdk_api_route,
configure_sdk_model_defaults,
supports_strict_tool_schemas,
uses_chat_completions_tool_schema,
)
from strix.config.settings import DEFAULT_MAX_TURNS
from strix.core.agents import AgentCoordinator
from strix.core.agents import AgentCoordinator, BudgetPolicy
from strix.core.execution import (
respawn_subagents,
run_agent_loop,
@@ -189,6 +190,7 @@ async def run_strix_scan(
interactive: bool = False,
max_turns: int = DEFAULT_MAX_TURNS,
max_budget_usd: float | None = None,
budget_policy: BudgetPolicy = "stop",
model: str | None = None,
cleanup_on_exit: bool = True,
event_sink: StreamEventSink | None = None,
@@ -208,6 +210,12 @@ async def run_strix_scan(
``extra_system_prompt_context`` is merged into the root agent's scan
context before prompt rendering. Child agents keep the standard scan prompt
and context.
``budget_policy`` decides what happens when the LLM spend reaches
``max_budget_usd``: ``"stop"`` warns the agents as the limit approaches and
ends the scan at it; ``"pause"`` tells the agents nothing and parks every
agent before its next LLM call until the caller resumes the scan through
``coordinator.resume_budget()`` (optionally with a higher limit) or cancels
it. ``coordinator.pause_budget()`` parks a running scan the same way.
``mcp_connection_requests`` supplies the run's MCP connections from any
source: when given, the engine connects those requests; when ``None`` (the
command-line default) it reads ``~/.strix/mcp-servers.json`` itself. Either
@@ -250,15 +258,22 @@ async def run_strix_scan(
raise RuntimeError(
"No LLM model configured. Set STRIX_LLM env or pass model= to run_strix_scan().",
)
if resolved_model != (settings.llm.model or "").strip() and not codex.subscription_model(
resolved_model
):
configure_sdk_api_route(resolved_model, settings)
logger.info("LLM model resolved: %s", resolved_model)
chat_completions_tools = uses_chat_completions_tool_schema(resolved_model, settings)
strict_tool_schemas = supports_strict_tool_schemas(resolved_model)
if not strict_tool_schemas:
logger.info("Sending non-strict tool schemas: %s caps strict tools", resolved_model)
if budget_policy not in ("stop", "pause"):
raise ValueError(f"unknown budget_policy: {budget_policy!r}")
if coordinator is None:
coordinator = AgentCoordinator()
coordinator.set_snapshot_path(agents_path)
coordinator.set_budget_policy(budget_policy)
from strix.tools.coverage.tools import hydrate_coverage_from_disk
from strix.tools.notes.tools import hydrate_notes_from_disk
@@ -289,11 +304,17 @@ async def run_strix_scan(
report_state.get_total_llm_cost(),
max_budget_usd,
interactive=interactive,
budget_policy=budget_policy,
)
# Under the pause policy the hooks re-park at the first call if the
# spend is still at the limit, so a restored pause flag would only
# hold agents back after the limit was raised.
await coordinator.reset_budget_stops(
budget_stopped=budget_stopped,
reserve_stopped=reserve_stopped,
budget_paused=interactive and coordinator.budget_paused,
budget_paused=(
interactive and budget_policy != "pause" and coordinator.budget_paused
),
)
for aid, parent in coordinator.parent_of.items():
if parent is None:
@@ -372,8 +393,10 @@ async def run_strix_scan(
max_budget_usd=max_budget_usd,
max_turns=max_turns,
interactive=interactive,
budget_policy=budget_policy,
)
if interactive:
coordinator.set_budget_limit_setter(hooks.set_max_budget_usd)
if interactive and budget_policy != "pause":
coordinator.set_budget_extender(hooks.extend_budget)
scope_context = build_scope_context(scan_config)
+2 -30
View File
@@ -135,14 +135,12 @@ def _subscription_error_hint(exc: BaseException) -> str | None:
return None
async def warm_up_llm(show_model_warning: bool = True) -> None:
async def warm_up_llm() -> None:
from agents.models.interface import ModelTracing
from strix.config.models import (
RECOMMENDED_MODEL_NAMES,
configure_sdk_model_defaults,
is_known_openai_bare_model,
is_recommended_or_frontier_model,
)
from strix.core.inputs import make_model_settings
@@ -186,32 +184,6 @@ async def warm_up_llm(show_model_warning: bool = True) -> None:
)
sys.exit(1)
if show_model_warning and raw_model and not is_recommended_or_frontier_model(raw_model):
warn_text = Text()
warn_text.append("MODEL QUALITY WARNING", style="bold yellow")
warn_text.append("\n\n", style="white")
warn_text.append(f"'{raw_model}'", style="bold cyan")
warn_text.append(
" is not a recommended frontier model for Strix.\nSecurity scans work best with:\n",
style="white",
)
for recommended_model in RECOMMENDED_MODEL_NAMES:
warn_text.append(f"• {recommended_model}\n", style="bold cyan")
warn_text.append(
"\nYou can continue, but weaker models may miss vulnerabilities "
"or produce lower-quality findings.",
style="white",
)
console.print(
Panel(
warn_text,
title="[bold white]STRIX",
title_align="left",
border_style="yellow",
padding=(1, 2),
),
)
await preflight_model_connection(raw_model, settings=settings)
logger.info("LLM warm-up succeeded for model %s", (llm.model or "").strip())
@@ -403,7 +375,7 @@ def _bootstrap_scan(args: argparse.Namespace) -> None:
"""
set_scan_phase("preflight")
try:
asyncio.run(warm_up_llm(show_model_warning=True))
asyncio.run(warm_up_llm())
except ModelConnectionError as exc:
report_error("model_connection_failed", exc)
_print_model_connection_error(exc, exc.model_name)
@@ -11,7 +11,6 @@ from pathlib import Path
from typing import TYPE_CHECKING, Any
from strix.config import load_settings
from strix.config.models import is_recommended_or_frontier_model
from strix.config.settings import DEFAULT_MAX_TURNS
from strix.interface.tui.backend.live_view import TuiLiveView
from strix.interface.tui.backend.projection import (
@@ -189,11 +188,6 @@ class TuiController:
subscription = False
with contextlib.suppress(Exception):
subscription = is_subscription_run(self.report_state)
model_warning = ""
if model and not is_recommended_or_frontier_model(model):
model_warning = (
f"{model} is not a recommended frontier model. Pentest quality could be degraded."
)
state = {
"setup_mode": self.setup_mode,
"scan_started": self.scan_started,
@@ -211,7 +205,6 @@ class TuiController:
"scope_mode": self.scope_mode,
"diff_base": terminal_projection(self.diff_base, max_string=256),
"model": terminal_projection(model, max_string=256),
"model_warning": terminal_projection(model_warning, max_string=512),
"caido_url": terminal_projection(
getattr(self.report_state, "caido_url", None), max_string=1024
),
@@ -150,7 +150,6 @@ def bounded_state_projection(state: dict[str, Any]) -> dict[str, Any]:
key: state["usage"][key] for key in ("total_tokens", "cost") if key in state["usage"]
}
state["error"] = terminal_projection(state["error"], max_string=512)
state["model_warning"] = terminal_projection(state["model_warning"], max_string=256)
state["caido_url"] = terminal_projection(state["caido_url"], max_string=256)
state["viewer_url"] = terminal_projection(state["viewer_url"], max_string=256)
if encoded_size(state) <= STATE_TARGET_BYTES:
@@ -173,7 +172,6 @@ def bounded_state_projection(state: dict[str, Any]) -> dict[str, Any]:
"scope_mode": state["scope_mode"],
"diff_base": state["diff_base"],
"model": state["model"],
"model_warning": "",
"caido_url": None,
"messages": [],
"usage": state["usage"],
@@ -370,17 +370,6 @@ func TestStartedSnapshotTransitionsToLiveView(t *testing.T) {
}
}
func TestSplashModelWarningRendersTheBackendSentenceOnce(t *testing.T) {
warning := "openai/glm-5.3 is not a recommended frontier model. Pentest quality could be degraded."
got := ansi.Strip(splashModelWarning("openai/glm-5.3", warning))
if got != "⚠ "+warning {
t.Fatalf("splash warning = %q, want %q", got, "⚠ "+warning)
}
if got := ansi.Strip(splashModelWarning("other/model", warning)); got != "⚠ "+warning {
t.Fatalf("splash warning with unrelated model = %q", got)
}
}
func TestSetupStartScreenFitsNarrowTerminal(t *testing.T) {
model := New(nil)
model.width, model.height = 40, 18
-15
View File
@@ -423,27 +423,12 @@ func (m Model) splashView() string {
content := wordmark() + "\n\n" +
welcome + "\n" + version + "\n" + tagline + "\n\n" +
start.String() + "\n\n" + url
if warn := m.snapshot.ModelWarning; warn != "" {
content += "\n\n" + splashModelWarning(m.snapshot.Model, warn)
}
panel := lipgloss.NewStyle().Border(lipgloss.RoundedBorder()).BorderForeground(green).Padding(1, 6).Align(lipgloss.Center).Render(content)
// #splash_screen background is solid black.
return lipgloss.Place(m.width, m.height, lipgloss.Center, lipgloss.Center, panel,
lipgloss.WithWhitespaceBackground(black))
}
// splashModelWarning renders the backend's full warning sentence, with the
// model name highlighted when the sentence leads with it.
func splashModelWarning(model, warning string) string {
yellow := lipgloss.Color("#eab308")
out := lipgloss.NewStyle().Bold(true).Foreground(yellow).Render("⚠ ")
if model != "" && strings.HasPrefix(warning, model) {
out += lipgloss.NewStyle().Bold(true).Foreground(render.Cyan).Render(model)
warning = strings.TrimPrefix(warning, model)
}
return out + lipgloss.NewStyle().Foreground(yellow).Render(warning)
}
// chatPaneKey identifies everything the bordered trace depends on.
type chatPaneKey struct {
offset int
@@ -71,7 +71,6 @@ type Snapshot struct {
ScopeMode string `json:"scope_mode"`
DiffBase string `json:"diff_base"`
Model string `json:"model"`
ModelWarning string `json:"model_warning"`
CaidoURL string `json:"caido_url"`
Messages []Message `json:"messages"`
Agents []Agent `json:"-"`
+53
View File
@@ -657,6 +657,35 @@ class ReportState:
def record_observed_llm_cost(self, cost: float) -> None:
self._llm_usage.record_observed_cost(cost)
def record_llm_provider(
self,
provider: str,
*,
agent_id: str | None,
input_tokens: int,
cached_tokens: int,
cost: float,
) -> None:
self._llm_usage.record_provider(
provider,
agent_id=agent_id,
input_tokens=input_tokens,
cached_tokens=cached_tokens,
cost=cost,
cache_block_tokens=load_settings().llm.cache_block_tokens,
)
def get_process_llm_providers(self) -> dict[str, dict[str, float]]:
"""Per-provider usage since this process started, like get_process_llm_usage."""
baseline = self._telemetry_llm_usage_baseline.get("providers") or {}
providers: dict[str, dict[str, float]] = {}
for name, tally in (self._llm_usage.to_record().get("providers") or {}).items():
before = baseline.get(name) or {}
delta = {key: max(0, value - _number(before.get(key))) for key, value in tally.items()}
if delta["requests"]:
providers[name] = delta
return providers
def get_total_llm_usage(self) -> dict[str, Any]:
return dict(self.run_record.get("llm_usage") or self._build_llm_usage_record())
@@ -990,6 +1019,30 @@ class StreamedOpenRouterCosts:
streamed_openrouter_costs = StreamedOpenRouterCosts()
def record_openrouter_provider(provider: Any, usage: Any) -> None:
"""Tally which upstream provider served a stream, from its final usage chunk.
OpenRouter spreads one model across many providers whose prices, quantization
and prompt caching differ, so this is what shows where a scan's tokens went.
"""
# Deferred: request_log pulls in the agents SDK, which strix.report must not import.
from strix.llm.request_log import current_call_context
report_state = get_global_report_state()
if report_state is None or not isinstance(usage, dict):
return
details = usage.get("prompt_tokens_details")
report_state.record_llm_provider(
provider if isinstance(provider, str) and provider else "unknown",
agent_id=current_call_context().agent_id,
input_tokens=int(_number(usage.get("prompt_tokens"))),
cached_tokens=int(_number(details.get("cached_tokens")))
if isinstance(details, dict)
else 0,
cost=openrouter_stream_cost(usage) or 0.0,
)
def litellm_cost_callback(
kwargs: Any,
completion_response: Any,
+55
View File
@@ -6,6 +6,7 @@ import logging
from typing import Any
from agents.usage import Usage, deserialize_usage, serialize_usage
from pydantic import BaseModel, TypeAdapter, ValidationError
from strix.report.pricing import resolve_litellm_model
@@ -13,6 +14,22 @@ from strix.report.pricing import resolve_litellm_model
logger = logging.getLogger(__name__)
class ProviderUsage(BaseModel):
"""Running totals for one upstream provider OpenRouter routed calls to."""
requests: int = 0
input_tokens: int = 0
cached_tokens: int = 0
cost: float = 0.0
# Calls that didn't find the agent's whole previous prompt cached, and the
# previous-prompt tokens they had to pay for again.
cache_misses: int = 0
missed_tokens: int = 0
_PROVIDER_USAGE = TypeAdapter(dict[str, ProviderUsage])
class LLMUsageLedger:
"""Aggregate SDK ``Usage`` objects and attach best-effort cost estimates."""
@@ -23,6 +40,10 @@ class LLMUsageLedger:
self._observed_cost = 0.0
self._estimated_cost = 0.0
self._has_observed_cost = False
# Keyed by upstream provider name, e.g. "Z.AI" or "DeepInfra".
self._providers: dict[str, ProviderUsage] = {}
# Each agent's last prompt size, which its next call should find cached.
self._last_input_tokens: dict[str, int] = {}
# When True, tokens are still tracked but cost stays $0 — the run is on a
# model subscription, so there is no metered per-token charge to report.
self.zero_cost = False
@@ -62,6 +83,33 @@ class LLMUsageLedger:
self._observed_cost += float(cost)
self._has_observed_cost = True
def record_provider(
self,
provider: str,
*,
agent_id: str | None,
input_tokens: int,
cached_tokens: int,
cost: float,
cache_block_tokens: int,
) -> None:
tally = self._providers.setdefault(provider, ProviderUsage())
tally.requests += 1
tally.input_tokens += input_tokens
tally.cached_tokens += cached_tokens
if agent_id:
previous = self._last_input_tokens.get(agent_id, 0)
# The previous prompt is a prefix of this one, so all of it but a
# partial last block should read back cached. A shrinking prompt means
# compaction rewrote it, so a miss is expected.
missed = previous - cached_tokens
if input_tokens >= previous and missed >= cache_block_tokens:
tally.cache_misses += 1
tally.missed_tokens += missed
self._last_input_tokens[agent_id] = input_tokens
if not self.zero_cost:
tally.cost = _round_cost(tally.cost + cost)
@property
def total_cost(self) -> float:
if self.zero_cost:
@@ -71,6 +119,7 @@ class LLMUsageLedger:
def to_record(self) -> dict[str, Any]:
record = serialize_usage(self._total_usage)
record["cost"] = self.total_cost
record["providers"] = {name: tally.model_dump() for name, tally in self._providers.items()}
record["agents"] = []
agent_tokens = {aid: _resolve_total_tokens(u) for aid, u in self._agent_usage.items()}
@@ -102,10 +151,16 @@ class LLMUsageLedger:
self._observed_cost = 0.0
self._estimated_cost = 0.0
self._has_observed_cost = False
self._providers = {}
if not isinstance(raw_usage, dict):
return
try:
self._providers = _PROVIDER_USAGE.validate_python(raw_usage.get("providers") or {})
except ValidationError:
logger.exception("Failed to hydrate llm_usage providers from run.json")
try:
self._total_usage = deserialize_usage(raw_usage)
except Exception:
+2
View File
@@ -118,6 +118,7 @@ def end(report_state: "ReportState", exit_reason: str = "completed") -> None:
}
except (TypeError, ValueError, AttributeError):
pass
providers = report_state.get_process_llm_providers()
report_state.posthog_scan_ended_sent = _send(
"scan_ended",
@@ -129,6 +130,7 @@ def end(report_state: "ReportState", exit_reason: str = "completed") -> None:
"vulnerabilities_total": len(report_state.vulnerability_reports),
**{f"vulnerabilities_{k}": v for k, v in vulnerabilities_counts.items()},
**llm_props,
**({"llm_providers": providers} if providers else {}),
"skills": get_loaded_skill_names(),
},
)
+4
View File
@@ -1,5 +1,6 @@
from __future__ import annotations
import json
import logging
import urllib.parse
from typing import TYPE_CHECKING, Any
@@ -120,6 +121,7 @@ def end(report_state: ReportState, exit_reason: str = "completed") -> None:
}
except (TypeError, ValueError, AttributeError):
pass
providers = report_state.get_process_llm_providers()
report_state.scarf_scan_ended_sent = _send(
"scan_ended",
@@ -132,6 +134,8 @@ def end(report_state: ReportState, exit_reason: str = "completed") -> None:
"vulnerabilities_total": len(report_state.vulnerability_reports),
**{f"vulnerabilities_{k}": v for k, v in vulnerabilities_counts.items()},
**llm_props,
# Query params are flat, so the per-provider tally travels as JSON.
**({"llm_providers": json.dumps(providers)} if providers else {}),
"skills": ",".join(get_loaded_skill_names()),
},
)
+3 -6
View File
@@ -12,16 +12,13 @@ from typing import Any, Literal, get_args
from agents import RunContextWrapper, function_tool
from strix.core.agents import Status, coordinator_from_context
from strix.core.agents import ACTIVE_STATUSES, Status, coordinator_from_context
from strix.core.execution import notify_parent_on_terminal
from strix.core.hooks import LLM_TURN_KEY
from strix.report.state import get_global_report_state
from strix.skills import validate_requested_skills
_ACTIVE_STATUSES: frozenset[str] = frozenset({"running", "waiting"})
logger = logging.getLogger(__name__)
@@ -810,13 +807,13 @@ async def stop_agent(
)
current_status = statuses[target_agent_id]
if current_status not in _ACTIVE_STATUSES:
if current_status not in ACTIVE_STATUSES:
return json.dumps(
{
"success": False,
"error": (
f"Agent {target_agent_id} is already '{current_status}'; "
"stop_agent only acts on running/waiting agents — use "
"stop_agent only acts on running/waiting/paused agents — use "
"view_agent_graph to find still-active descendants and "
"stop them individually, or send_message_to_agent if you "
"want to wake this one with new instructions"
+55 -55
View File
@@ -1075,11 +1075,11 @@ async def create_vulnerability_report(
"Techniques" that read like an engineering runbook rather than a
client deliverable.
- **Use markdown in every text field**: ``**bold**`` for emphasis,
``inline code`` for identifiers/values/parameters, and fenced
code blocks (```` ```language ````) for any code/payload/HTTP
``inline code`` for identifiers/values/parameters, and
language-tagged fenced code blocks for any code/payload/HTTP
excerpt. Never leave code bare/unformatted. When referencing a
file, annotate the fence, e.g.
```` ```python title=app.py startLineNumber=42 endLineNumber=50 ````.
file, annotate the opening fence with
``title=app.py startLineNumber=42 endLineNumber=50`` after the language.
- Field discipline: ``poc_description`` is steps only — NO code (all
code goes in ``poc_script_code``); ``remediation_steps`` is prose
only — NO code/diffs (code fixes go in ``code_locations``).
@@ -1191,6 +1191,57 @@ async def create_vulnerability_report(
Broken / Risky Crypto, CWE-311 Missing Encryption, CWE-916 Weak
Password Hashing.
Example (abbreviated — mirror this structure)::
title: "Reflected XSS in /search q parameter"
description:
The **`q`** parameter of `/search` reflects user input into
the HTML response without encoding, allowing script
injection.
technical_analysis:
The handler interpolates `q` directly into the page body:
```python title=views.py startLineNumber=42 endLineNumber=44
html = f"<h2>Results for {q}</h2>"
return HttpResponse(html)
```
No output encoding is applied, so `<script>` executes.
poc_description:
1. Navigate to `/search?q=<payload>`.
2. Observe the payload executes in the victim's browser.
poc_script_code:
```
GET /search?q=<script>alert(document.domain)</script>
```
evidence:
Response echoes the payload verbatim:
```html
<h2>Results for <script>alert(document.domain)</script></h2>
```
assumptions:
Assumes a victim can be induced to open a crafted link.
remediation_steps:
Context-encode all user input rendered into HTML; prefer the
template engine's auto-escaping over string interpolation.
counterevidence:
No output encoding, CSP, or WAF observed on this response;
payload executed in a current browser. The parameter is
reflected on an unauthenticated route, so no privileged
position is required.
confidence: "high"
severity_change_conditions:
A restrictive CSP that blocks inline script execution would
reduce impact and lower the severity.
fix_effort: "low"
Nice to have: for code findings, if the checkout has git history, a quick
``git blame`` (quote the paths) on the vulnerable line is worth weaving into
``technical_analysis`` — who last touched it, when, and in which commit, as
part of the prose, not a separate section. Skip it if the line is
uncommitted or the command fails.
Args:
title: Specific finding title (e.g.
``"SQL Injection in /api/users login parameter"``). Don't
@@ -1359,57 +1410,6 @@ async def create_vulnerability_report(
fix (summary + rationale). Prose/markdown only — the code
change itself belongs in ``code_locations``. Omit for
black-box findings.
Example (abbreviated — mirror this structure)::
title: "Reflected XSS in /search q parameter"
description:
The **`q`** parameter of `/search` reflects user input into
the HTML response without encoding, allowing script
injection.
technical_analysis:
The handler interpolates `q` directly into the page body:
```python title=views.py startLineNumber=42 endLineNumber=44
html = f"<h2>Results for {q}</h2>"
return HttpResponse(html)
```
No output encoding is applied, so `<script>` executes.
poc_description:
1. Navigate to `/search?q=<payload>`.
2. Observe the payload executes in the victim's browser.
poc_script_code:
```
GET /search?q=<script>alert(document.domain)</script>
```
evidence:
Response echoes the payload verbatim:
```html
<h2>Results for <script>alert(document.domain)</script></h2>
```
assumptions:
Assumes a victim can be induced to open a crafted link.
remediation_steps:
Context-encode all user input rendered into HTML; prefer the
template engine's auto-escaping over string interpolation.
counterevidence:
No output encoding, CSP, or WAF observed on this response;
payload executed in a current browser. The parameter is
reflected on an unauthenticated route, so no privileged
position is required.
confidence: "high"
severity_change_conditions:
A restrictive CSP that blocks inline script execution would
reduce impact and lower the severity.
fix_effort: "low"
Nice to have: for code findings, if the checkout has git history, a quick
``git blame`` (quote the paths) on the vulnerable line is worth weaving into
``technical_analysis`` — who last touched it, when, and in which commit, as
part of the prose, not a separate section. Skip it if the line is
uncommitted or the command fails.
"""
(
http_exchange_ids,
+540
View File
@@ -0,0 +1,540 @@
"""``budget_policy="pause"``: agents park before a paid call and never hear about budgets."""
from __future__ import annotations
import asyncio
from typing import TYPE_CHECKING, Any
from unittest.mock import MagicMock, patch
import pytest
from strix.core import execution
from strix.core.agents import AgentCoordinator
from strix.core.execution import _start_child_runner, run_agent_loop
from strix.core.hooks import (
BudgetExceededError,
BudgetPausedError,
ReportUsageHooks,
recomputed_budget_flags,
)
from strix.core.sessions import open_agent_session
if TYPE_CHECKING:
from collections.abc import AsyncIterator, Callable
from pathlib import Path
COST_PER_CALL = 1.0
_CALL_LATENCY_S = 0.005
class _FakeLedger:
def __init__(self) -> None:
self.cost = 0.0
self.calls: list[str] = []
self.remaining: dict[str, int] = {}
self.warned_inputs: list[list[Any]] = []
self.gate: asyncio.Event | None = None
self.in_flight = 0
def record_sdk_usage(self, **_kwargs: Any) -> None:
return
def get_total_llm_cost(self) -> float:
return self.cost
class _FakeStream:
"""One ``Runner.run_streamed`` call: several LLM turns, each guarded by the hooks.
Mirrors the SDK's ordering: ``on_llm_start`` runs before the paid request,
``on_llm_end`` after it. A ``BudgetPausedError`` from ``on_llm_start`` ends
the stream without spending, exactly like the SDK surfacing a hook error.
"""
def __init__(
self,
*,
ledger: _FakeLedger,
hooks: ReportUsageHooks,
context: dict[str, Any],
agent: Any,
coordinator: AgentCoordinator,
) -> None:
self._ledger = ledger
self._hooks = hooks
self._context = context
self._agent = agent
self._coordinator = coordinator
self.run_loop_exception: BaseException | None = None
self.final_output = None
async def stream_events(self) -> AsyncIterator[Any]:
agent_id = str(self._context.get("agent_id"))
ctx_wrapper = MagicMock()
ctx_wrapper.context = self._context
while self._ledger.remaining.get(agent_id, 0) > 0:
input_items: list[Any] = []
try:
await self._hooks.on_llm_start(ctx_wrapper, self._agent, None, input_items)
except BudgetPausedError as exc:
self.run_loop_exception = exc
return
self._ledger.warned_inputs.append(input_items)
if self._ledger.gate is not None:
self._ledger.in_flight += 1
await self._ledger.gate.wait()
self._ledger.in_flight -= 1
self._ledger.cost += COST_PER_CALL
self._ledger.calls.append(agent_id)
self._ledger.remaining[agent_id] -= 1
await self._hooks.on_llm_end(ctx_wrapper, self._agent, MagicMock())
await asyncio.sleep(_CALL_LATENCY_S)
if self._coordinator.statuses.get(agent_id) == "running":
await self._coordinator.set_status(agent_id, "completed")
items: tuple[Any, ...] = ()
for item in items:
yield item
def cancel(self, mode: str = "immediate") -> None: # noqa: ARG002
return
def _fake_runner(ledger: _FakeLedger, coordinator: AgentCoordinator) -> Any:
class _FakeRunner:
@staticmethod
def run_streamed(
agent: Any,
input: Any, # noqa: A002, ARG004
*,
run_config: Any, # noqa: ARG004
context: dict[str, Any],
max_turns: int, # noqa: ARG004
session: Any, # noqa: ARG004
hooks: ReportUsageHooks,
) -> _FakeStream:
return _FakeStream(
ledger=ledger,
hooks=hooks,
context=context,
agent=agent,
coordinator=coordinator,
)
return _FakeRunner
async def _noop_compact(*_args: Any, **_kwargs: Any) -> bool:
return False
async def _wait_until(predicate: Callable[[], bool], *, timeout: float = 5.0) -> None:
async def _poll() -> None:
while not predicate():
await asyncio.sleep(0.001)
await asyncio.wait_for(_poll(), timeout=timeout)
def _all_parked(coordinator: AgentCoordinator, *agent_ids: str) -> bool:
return all(coordinator.statuses.get(aid) == "budget_paused" for aid in agent_ids)
class _Scan:
"""Root + children driven through the real non-interactive loops."""
def __init__(
self,
tmp_path: Path,
monkeypatch: pytest.MonkeyPatch,
*,
max_budget_usd: float | None,
) -> None:
self.ledger = _FakeLedger()
self.hooks = ReportUsageHooks(
model="test-model", max_budget_usd=max_budget_usd, budget_policy="pause"
)
self.coordinator = AgentCoordinator()
self.coordinator.set_budget_policy("pause")
self.coordinator.set_budget_limit_setter(self.hooks.set_max_budget_usd)
monkeypatch.setattr(execution, "Runner", _fake_runner(self.ledger, self.coordinator))
monkeypatch.setattr(execution, "_compact_session", _noop_compact)
self.db_path = tmp_path / "agents.sqlite"
self.sessions: list[Any] = []
self.run_config = MagicMock()
self.root_ctx: dict[str, Any] = {
"agent_id": "root",
"parent_id": None,
"coordinator": self.coordinator,
}
self.root_task: asyncio.Task[Any] | None = None
async def start_root(self, *, calls: int) -> None:
self.ledger.remaining["root"] = calls
await self.coordinator.register("root", "strix", parent_id=None)
session = open_agent_session("root", self.db_path)
self.sessions.append(session)
self.root_task = asyncio.create_task(
run_agent_loop(
agent=MagicMock(),
initial_input=[],
run_config=self.run_config,
context=self.root_ctx,
max_turns=500,
coordinator=self.coordinator,
agent_id="root",
interactive=False,
session=session,
hooks=self.hooks,
)
)
async def start_child(self, child_id: str, *, calls: int) -> None:
self.ledger.remaining[child_id] = calls
await self.coordinator.register(child_id, "recon", parent_id="root")
await _start_child_runner(
parent_ctx=self.root_ctx,
coordinator=self.coordinator,
agents_db_path=self.db_path,
sessions_to_close=self.sessions,
run_config=self.run_config,
max_turns=500,
interactive=False,
child_agent=MagicMock(),
child_id=child_id,
name=f"recon-{child_id}",
parent_id="root",
task="probe things",
initial_input=[],
hooks=self.hooks,
)
def tasks(self) -> list[asyncio.Task[Any]]:
tasks = [self.root_task] if self.root_task is not None else []
tasks.extend(rt.task for rt in self.coordinator.runtimes.values() if rt.task is not None)
return tasks
async def teardown(self) -> None:
for task in self.tasks():
task.cancel()
await asyncio.gather(*self.tasks(), return_exceptions=True)
for session in self.sessions:
session.close()
@pytest.mark.asyncio
async def test_pause_policy_parks_every_agent_at_the_limit_and_resumes_in_place(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
scan = _Scan(tmp_path, monkeypatch, max_budget_usd=5.0)
agents = ("root", "child-a", "child-b")
with patch("strix.core.hooks.get_global_report_state", return_value=scan.ledger):
await scan.start_root(calls=100)
await scan.start_child("child-a", calls=100)
await scan.start_child("child-b", calls=100)
await _wait_until(lambda: _all_parked(scan.coordinator, *agents))
assert scan.ledger.cost == pytest.approx(5.0)
assert len(scan.ledger.calls) == 5
assert scan.coordinator.budget_paused is False
assert scan.coordinator.budget_stopped is False
assert scan.coordinator.reserve_stopped is False
assert all(not task.done() for task in scan.tasks())
woken = await scan.coordinator.resume_budget(max_budget_usd=8.0)
assert sorted(woken) == sorted(agents)
assert scan.hooks.max_budget_usd == 8.0
await _wait_until(lambda: scan.ledger.cost >= 8.0)
await _wait_until(lambda: _all_parked(scan.coordinator, *agents))
assert scan.ledger.cost == pytest.approx(8.0)
await scan.coordinator.resume_budget(max_budget_usd=9.0)
await _wait_until(lambda: scan.ledger.cost >= 9.0)
await _wait_until(lambda: _all_parked(scan.coordinator, *agents))
assert scan.ledger.cost == pytest.approx(9.0)
assert len(scan.ledger.calls) == 9
assert all(not task.done() for task in scan.tasks())
# The model never saw a budget message: no warning band, no resume note.
assert scan.ledger.warned_inputs
assert all(items == [] for items in scan.ledger.warned_inputs)
for session in scan.sessions:
assert await session.get_items() == []
# Stop while parked: an individual stop wakes that loop and it exits.
child_a_task = scan.coordinator.runtimes["child-a"].task
assert child_a_task is not None
await scan.coordinator.request_stop("child-a")
await asyncio.wait_for(child_a_task, timeout=5.0)
assert scan.coordinator.statuses["child-a"] == "stopped"
assert scan.coordinator.statuses["root"] == "budget_paused"
assert scan.coordinator.statuses["child-b"] == "budget_paused"
# A scan-wide cancel while parked tears the rest down cleanly.
await scan.teardown()
assert all(task.done() for task in scan.tasks())
assert scan.ledger.cost == pytest.approx(9.0)
@pytest.mark.asyncio
async def test_pause_policy_operator_pause_and_resume_without_a_limit(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
scan = _Scan(tmp_path, monkeypatch, max_budget_usd=None)
agents = ("root", "child-a", "child-b")
with patch("strix.core.hooks.get_global_report_state", return_value=scan.ledger):
await scan.start_root(calls=6)
await scan.start_child("child-a", calls=6)
await scan.start_child("child-b", calls=6)
await _wait_until(lambda: scan.ledger.cost >= 3.0)
await scan.coordinator.pause_budget()
spent_at_pause = scan.ledger.cost
await _wait_until(lambda: _all_parked(scan.coordinator, *agents))
await _wait_until(lambda: scan.coordinator.budget_paused, timeout=0.1)
assert scan.ledger.cost == pytest.approx(spent_at_pause)
assert all(not task.done() for task in scan.tasks())
await asyncio.sleep(0.05)
assert scan.ledger.cost == pytest.approx(spent_at_pause)
woken = await scan.coordinator.resume_budget()
assert sorted(woken) == sorted(agents)
await _wait_until(lambda: not scan.coordinator.budget_paused, timeout=0.1)
await asyncio.wait_for(asyncio.gather(*scan.tasks(), return_exceptions=True), timeout=5.0)
assert scan.ledger.cost == pytest.approx(18.0)
assert {aid: str(s) for aid, s in scan.coordinator.statuses.items()} == {
"root": "completed",
"child-a": "completed",
"child-b": "completed",
}
assert all(items == [] for items in scan.ledger.warned_inputs)
for session in scan.sessions:
session.close()
@pytest.mark.asyncio
async def test_pause_policy_keeps_in_flight_overshoot(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
scan = _Scan(tmp_path, monkeypatch, max_budget_usd=1.0)
scan.ledger.gate = asyncio.Event()
await scan.coordinator.register("root", "strix", parent_id=None)
with patch("strix.core.hooks.get_global_report_state", return_value=scan.ledger):
await scan.start_child("child-a", calls=100)
await scan.start_child("child-b", calls=100)
# Both calls were dispatched under the limit; neither is cancelled.
await _wait_until(lambda: scan.ledger.in_flight == 2)
assert scan.ledger.cost == 0.0
scan.ledger.gate.set()
await _wait_until(lambda: _all_parked(scan.coordinator, "child-a", "child-b"))
assert scan.ledger.cost == pytest.approx(2.0)
assert scan.hooks.max_budget_usd is not None
assert scan.ledger.cost > scan.hooks.max_budget_usd
assert scan.coordinator.budget_stopped is False
assert all(not task.done() for task in scan.tasks())
# Resuming at a limit that is already spent parks again without a call.
await scan.coordinator.resume_budget(max_budget_usd=1.5)
await asyncio.sleep(0.05)
await _wait_until(lambda: _all_parked(scan.coordinator, "child-a", "child-b"))
assert scan.ledger.cost == pytest.approx(2.0)
await scan.teardown()
@pytest.mark.asyncio
async def test_resume_between_park_decision_and_wait_is_not_missed() -> None:
coordinator = AgentCoordinator()
coordinator.set_budget_policy("pause")
await coordinator.register("a", "strix", parent_id=None)
parked_epoch = coordinator.resume_epoch
await coordinator.park_for_budget("a")
assert _all_parked(coordinator, "a")
await coordinator.resume_budget()
await asyncio.wait_for(
coordinator.wait_for_budget_resume("a", parked_epoch=parked_epoch), timeout=1.0
)
assert coordinator.statuses["a"] == "running"
@pytest.mark.asyncio
async def test_parked_wait_returns_on_stop_signals() -> None:
coordinator = AgentCoordinator()
coordinator.set_budget_policy("pause")
await coordinator.register("a", "strix", parent_id=None)
await coordinator.register("b", "recon", parent_id="a")
await coordinator.park_for_budget("a")
await coordinator.park_for_budget("b")
wait_a = asyncio.create_task(
coordinator.wait_for_budget_resume("a", parked_epoch=coordinator.resume_epoch)
)
wait_b = asyncio.create_task(
coordinator.wait_for_budget_resume("b", parked_epoch=coordinator.resume_epoch)
)
await asyncio.sleep(0.02)
assert not wait_a.done()
assert not wait_b.done()
await coordinator.request_stop("b")
await asyncio.wait_for(wait_b, timeout=1.0)
assert coordinator.statuses["b"] == "stopped"
assert not wait_a.done()
await coordinator.trigger_budget_stop()
await asyncio.wait_for(wait_a, timeout=1.0)
assert coordinator.statuses["a"] == "budget_paused"
@pytest.mark.asyncio
async def test_park_never_overwrites_a_stop_that_landed_first() -> None:
coordinator = AgentCoordinator()
coordinator.set_budget_policy("pause")
await coordinator.register("a", "strix", parent_id=None)
parked_epoch = coordinator.resume_epoch
await coordinator.request_stop("a")
assert await coordinator.park_for_budget("a") is False
assert coordinator.statuses["a"] == "stopped"
await asyncio.wait_for(
coordinator.wait_for_budget_resume("a", parked_epoch=parked_epoch), timeout=1.0
)
assert coordinator.statuses["a"] == "stopped"
@pytest.mark.asyncio
async def test_parked_children_keep_the_scan_open() -> None:
coordinator = AgentCoordinator()
coordinator.set_budget_policy("pause")
await coordinator.register("root", "strix", parent_id=None)
await coordinator.register("child", "recon", parent_id="root")
assert await coordinator.park_for_budget("child") is True
active = await coordinator.active_agents_except("root")
assert [a["agent_id"] for a in active] == ["child"]
assert active[0]["status"] == "budget_paused"
@pytest.mark.asyncio
async def test_resume_budget_replaces_the_limit_and_validates_it() -> None:
hooks = ReportUsageHooks(model="m", max_budget_usd=10.0, budget_policy="pause")
coordinator = AgentCoordinator()
coordinator.set_budget_policy("pause")
coordinator.set_budget_limit_setter(hooks.set_max_budget_usd)
await coordinator.resume_budget(max_budget_usd=25.0)
assert hooks.max_budget_usd == 25.0
await coordinator.resume_budget()
assert hooks.max_budget_usd == 25.0
with pytest.raises(ValueError, match="greater than 0"):
await coordinator.resume_budget(max_budget_usd=0.0)
with pytest.raises(ValueError, match="finite"):
await coordinator.resume_budget(max_budget_usd=float("inf"))
assert hooks.max_budget_usd == 25.0
def _ctx(coordinator: AgentCoordinator | None, *, parent_id: str | None = None) -> MagicMock:
wrapper = MagicMock()
wrapper.context = {"agent_id": "x", "parent_id": parent_id}
if coordinator is not None:
wrapper.context["coordinator"] = coordinator
return wrapper
@pytest.mark.asyncio
async def test_pause_hooks_never_warn_and_park_only_at_the_limit() -> None:
ledger = _FakeLedger()
hooks = ReportUsageHooks(model="m", max_budget_usd=10.0, budget_policy="pause")
coordinator = AgentCoordinator()
coordinator.set_budget_policy("pause")
with patch("strix.core.hooks.get_global_report_state", return_value=ledger):
for cost in (7.0, 8.5, 9.5, 9.99):
ledger.cost = cost
for parent_id in (None, "root"):
items: list[Any] = []
await hooks.on_llm_start(
_ctx(coordinator, parent_id=parent_id), MagicMock(), None, items
)
assert items == []
await hooks.on_llm_end(
_ctx(coordinator, parent_id=parent_id), MagicMock(), MagicMock()
)
ledger.cost = 10.0
await hooks.on_llm_end(_ctx(coordinator, parent_id="root"), MagicMock(), MagicMock())
with pytest.raises(BudgetPausedError) as at_limit:
await hooks.on_llm_start(_ctx(coordinator), MagicMock(), None, [])
assert at_limit.value.resume_epoch == coordinator.resume_epoch
ledger.cost = 13.7
with pytest.raises(BudgetPausedError):
await hooks.on_llm_start(_ctx(coordinator, parent_id="root"), MagicMock(), None, [])
hooks.set_max_budget_usd(20.0)
items = []
await hooks.on_llm_start(_ctx(coordinator), MagicMock(), None, items)
assert items == []
await coordinator.pause_budget()
with pytest.raises(BudgetPausedError, match="paused"):
await hooks.on_llm_start(_ctx(coordinator), MagicMock(), None, [])
@pytest.mark.asyncio
async def test_pause_hooks_do_not_count_a_parked_turn() -> None:
ledger = _FakeLedger()
ledger.cost = 10.0
hooks = ReportUsageHooks(model="m", max_budget_usd=10.0, budget_policy="pause")
coordinator = AgentCoordinator()
ctx = _ctx(coordinator)
with patch("strix.core.hooks.get_global_report_state", return_value=ledger):
with pytest.raises(BudgetPausedError):
await hooks.on_llm_start(ctx, MagicMock(), None, [])
assert "llm_turn" not in ctx.context
hooks.set_max_budget_usd(11.0)
await hooks.on_llm_start(ctx, MagicMock(), None, [])
assert ctx.context["llm_turn"] == 1
@pytest.mark.asyncio
async def test_stop_policy_is_unchanged() -> None:
ledger = _FakeLedger()
hooks = ReportUsageHooks(model="m", max_budget_usd=10.0)
assert hooks.budget_policy == "stop"
with patch("strix.core.hooks.get_global_report_state", return_value=ledger):
ledger.cost = 7.0
items: list[Any] = []
await hooks.on_llm_start(_ctx(None), MagicMock(), None, items)
assert len(items) == 1
assert "Scan cost budget" in str(items[0])
ledger.cost = 10.0
with pytest.raises(BudgetExceededError):
await hooks.on_llm_end(_ctx(None), MagicMock(), MagicMock())
assert recomputed_budget_flags(10.0, 10.0, interactive=False, budget_policy="stop") == (
True,
True,
)
assert recomputed_budget_flags(10.0, 10.0, interactive=False, budget_policy="pause") == (
False,
False,
)
def test_budget_policy_is_validated() -> None:
with pytest.raises(ValueError, match="budget_policy"):
ReportUsageHooks(model="m", budget_policy="later") # type: ignore[arg-type]
+133 -1
View File
@@ -2,9 +2,12 @@
from __future__ import annotations
import uuid
from types import SimpleNamespace
from unittest.mock import MagicMock, patch
from typing import TYPE_CHECKING, Any
from unittest.mock import MagicMock, call, patch
import httpx
import litellm
import pytest
from litellm.types.utils import LlmProviders
@@ -14,6 +17,7 @@ from strix.config.models import (
_configure_litellm_compatibility,
_install_openrouter_stream_cost_capture,
)
from strix.llm import request_log
from strix.report.state import (
ReportState,
litellm_cost_callback,
@@ -21,6 +25,11 @@ from strix.report.state import (
set_global_report_state,
streamed_openrouter_costs,
)
from strix.report.usage import LLMUsageLedger
if TYPE_CHECKING:
from litellm.types.llms.openai import AllMessageValues
@pytest.fixture(autouse=True)
@@ -257,3 +266,126 @@ def test_openrouter_stream_handler_records_cost() -> None:
assert streamed_openrouter_costs.take(SimpleNamespace(id="gen-stream")) == pytest.approx(
0.0035055
)
def test_openrouter_tallies_provider() -> None:
_install_openrouter_stream_cost_capture()
config = ProviderConfigManager.get_provider_chat_config(
model="z-ai/glm-5.3", provider=LlmProviders.OPENROUTER
)
assert config is not None
handler = config.get_model_response_iterator(streaming_response=iter([]), sync_stream=True)
report_state = MagicMock()
usage = {
"prompt_tokens": 1000,
"completion_tokens": 10,
"cost": 0.002,
"prompt_tokens_details": {"cached_tokens": 900},
}
with patch("strix.report.state.get_global_report_state", return_value=report_state):
handler.chunk_parser(
{
"id": "gen-a",
"created": 1,
"model": "z-ai/glm-5.3",
"provider": "Together",
"choices": [{"index": 0, "delta": {"content": None}}],
"usage": usage,
}
)
# Non-streamed replies (LLM_DISABLE_STREAMING) carry the same fields.
reply = {
"choices": [{"message": {"role": "assistant"}}],
"provider": "Together",
"usage": usage,
}
config.transform_response(
"z-ai/glm-5.3",
httpx.Response(200, json=reply),
litellm.ModelResponse(),
MagicMock(),
{},
[],
{},
{},
None,
)
tally = call("Together", agent_id=None, input_tokens=1000, cached_tokens=900, cost=0.002)
assert report_state.record_llm_provider.call_args_list == [tally, tally]
def test_provider_tally_survives_run_record_round_trip() -> None:
ledger = LLMUsageLedger()
for input_tokens, cached_tokens, cost in [(1000, 900, 0.002), (500, 0, 0.001)]:
ledger.record_provider(
"Together",
agent_id=None,
input_tokens=input_tokens,
cached_tokens=cached_tokens,
cost=cost,
cache_block_tokens=128,
)
restored = LLMUsageLedger()
restored.hydrate(ledger.to_record())
assert restored.to_record()["providers"] == {
"Together": {
"requests": 2,
"input_tokens": 1500,
"cached_tokens": 900,
"cost": 0.003,
"cache_misses": 0,
"missed_tokens": 0,
}
}
def test_provider_tally_counts_cache_misses_per_agent() -> None:
ledger = LLMUsageLedger()
calls = [
("Z.AI", "a1", 1000, 0), # first call: nothing to miss
("Z.AI", "a1", 1200, 960), # 40 short of the previous 1000: within a block
("DeepInfra", "a1", 1500, 200), # 1000 of the previous 1200 lost
("Z.AI", "a2", 800, 0), # another agent's first call
("Z.AI", "a1", 600, 0), # prompt shrank: compaction, not a miss
]
for provider, agent_id, input_tokens, cached_tokens in calls:
ledger.record_provider(
provider,
agent_id=agent_id,
input_tokens=input_tokens,
cached_tokens=cached_tokens,
cost=0.0,
cache_block_tokens=128,
)
providers = ledger.to_record()["providers"]
assert providers["DeepInfra"]["cache_misses"] == 1
assert providers["DeepInfra"]["missed_tokens"] == 1000
assert providers["Z.AI"]["cache_misses"] == 0
def test_openrouter_request_carries_agent_session_id() -> None:
_install_openrouter_stream_cost_capture()
config = ProviderConfigManager.get_provider_chat_config(
model="moonshotai/kimi-k3", provider=LlmProviders.OPENROUTER
)
assert config is not None
messages: list[AllMessageValues] = [{"role": "user", "content": "hi"}]
def body() -> dict[str, Any]:
return config.transform_request("moonshotai/kimi-k3", messages, {}, {}, {})
assert "session_id" not in body()
token = request_log.bind_call_context("a1b2c3d4", "root")
try:
assert "session_id" not in body()
with patch("strix.config.models.load_settings") as settings:
settings.return_value.llm.openrouter_sticky_sessions = True
session_id = body()["session_id"]
assert str(uuid.UUID(session_id)) == session_id
assert body()["session_id"] == session_id
finally:
request_log.reset_call_context(token)
+7
View File
@@ -430,3 +430,10 @@ def test_user_headers_override_openrouter_attribution() -> None:
assert headers["X-Title"] == "Custom"
assert headers["X-Tenant"] == "acme"
assert headers["HTTP-Referer"] == "https://strix.ai"
def test_reasoning_effort_sent_as_configured_and_none_omitted() -> None:
assert make_model_settings("none", model_name="gpt-5.6-sol").reasoning is None
settings = make_model_settings("high", model_name="gpt-daybreak-blue-latest")
assert settings.reasoning is not None
assert settings.reasoning.effort == "high"
+67 -84
View File
@@ -1,4 +1,4 @@
"""Tests for LLM model recommendation helpers."""
"""Tests for LLM model configuration helpers."""
from __future__ import annotations
@@ -10,14 +10,14 @@ from agents.models import _openai_shared
from agents.models.openai_chatcompletions import OpenAIChatCompletionsModel
from agents.models.openai_responses import OpenAIResponsesModel
from strix.config import models
from strix.config.models import (
RECOMMENDED_MODEL_NAMES,
StrixProvider,
_NonStreamingModel,
_TurnGuardModel,
configure_sdk_model_defaults,
is_recommended_or_frontier_model,
request_timeout_extra_args,
resolve_api_type,
routes_through_litellm,
supports_strict_tool_schemas,
uses_chat_completions_tool_schema,
@@ -26,11 +26,6 @@ from strix.config.settings import Settings
from strix.llm.request_log import RequestLoggingModel
@pytest.mark.parametrize("model_name", RECOMMENDED_MODEL_NAMES)
def test_recommended_models_are_accepted(model_name: str) -> None:
assert is_recommended_or_frontier_model(model_name)
def test_request_timeout_extra_args_positive() -> None:
assert request_timeout_extra_args(300) == {"timeout": 300}
assert request_timeout_extra_args(10) == {"timeout": 10}
@@ -48,80 +43,6 @@ def test_request_timeout_extra_args_disabled(value: float | None) -> None:
assert request_timeout_extra_args(value) is None
def test_recommended_models_are_matched_case_insensitively() -> None:
assert is_recommended_or_frontier_model("Vertex_AI/Gemini-3-Pro-Preview")
@pytest.mark.parametrize(
"model_name",
[
"gpt-5.5",
"chatgpt/gpt-5.4",
"litellm/openai/gpt-5.4-pro",
"azure_ai/gpt-5.5-pro",
"bedrock_mantle/openai.gpt-5.5",
"anthropic/claude-opus-5",
"anthropic/claude-opus-4-8",
"anthropic.claude-opus-4-8",
"anthropic/claude-opus-4-7",
"anthropic/claude-fable-5",
"anthropic/claude-sonnet-5",
"vertex_ai/claude-sonnet-5@default",
"vertex_ai/claude-sonnet-4-6@default",
"any-llm/anthropic/claude-sonnet-4-6",
"vertex_ai/gemini-3.1-pro-preview",
"openrouter/google/gemini-3.1-pro-preview",
"deepseek/deepseek-v4-pro",
"deepseek/deepseek-r1-0528",
"deepseek/deepseek-reasoner",
"dashscope/qwen3-max-2026-01-23",
"qwen3.7-max",
"dashscope/qwen3.8-max",
"moonshot/kimi-k2.6",
"kimi-k2.7-code",
"moonshot/kimi-k3",
"anthropic/claude-fable-5-1",
"vertex_ai/claude-fable-5-1@default",
"gemini/gemini-3.7-flash",
"glm-5.3",
"zai/glm-5.3-flash",
"openrouter/z-ai/glm-5.3",
"novita/zai-org/glm-5.2",
"openai/glm-5.3",
"openai/zai-org/glm-5.3",
"hosted_vllm/glm-5.3",
"openai/claude-opus-4-8",
"openai/deepseek-v4-pro",
"custom-ollama/gpt-5-mini-local",
"custom-provider/claude-opus-4-local",
"custom-provider/glm-5.3-local",
],
)
def test_frontier_model_families_are_accepted(model_name: str) -> None:
assert is_recommended_or_frontier_model(model_name)
@pytest.mark.parametrize(
"model_name",
[
"",
"openai/gpt-4.1",
"anthropic/claude-3-5-sonnet-latest",
"ollama/llama3.1",
"deepseek/deepseek-chat",
"xai/grok-4.5",
"openrouter/x-ai/grok-4",
"mistral/mistral-medium-3-5",
"mistral/magistral-medium-latest",
"zai/glm-4.7",
"openai/glm-4.7",
"openrouter/z-ai/glm-5",
],
)
def test_non_frontier_models_are_rejected(model_name: str) -> None:
assert not is_recommended_or_frontier_model(model_name)
@pytest.mark.parametrize(
"model_name",
[
@@ -192,7 +113,7 @@ def test_api_type_override_settings(monkeypatch: pytest.MonkeyPatch) -> None:
@pytest.mark.parametrize(
("api_type", "expected"),
[
(None, OpenAIChatCompletionsModel),
(None, OpenAIResponsesModel),
("chat_completions", OpenAIChatCompletionsModel),
("responses", OpenAIResponsesModel),
],
@@ -200,7 +121,7 @@ def test_api_type_override_settings(monkeypatch: pytest.MonkeyPatch) -> None:
def test_api_type_overrides_the_api_base_route(
monkeypatch: pytest.MonkeyPatch, api_type: str | None, expected: type
) -> None:
"""``LLM_API_BASE`` defaults to chat completions. ``STRIX_API_TYPE`` must win."""
"""gpt-5 is catalogued on /v1/responses, so a base URL alone changes nothing."""
monkeypatch.setattr(_openai_shared, "_use_responses_by_default", True)
monkeypatch.setattr(_openai_shared, "_default_openai_client", None)
monkeypatch.setattr(_openai_shared, "_default_openai_key", None)
@@ -219,3 +140,65 @@ def test_api_type_overrides_the_api_base_route(
while isinstance(model, _NonStreamingModel | _TurnGuardModel | RequestLoggingModel):
model = model._inner
assert isinstance(model, expected)
def _settings(monkeypatch: pytest.MonkeyPatch, model: str, api_base: str | None) -> Settings:
monkeypatch.setenv("STRIX_LLM", model)
monkeypatch.delenv("STRIX_API_TYPE", raising=False)
for name in ("LLM_API_BASE", "OPENAI_API_BASE", "OPENAI_BASE_URL"):
monkeypatch.delenv(name, raising=False)
if api_base is not None:
monkeypatch.setenv("LLM_API_BASE", api_base)
return Settings()
@pytest.mark.parametrize(
"api_base", [None, "https://api.openai.com/v1", "https://gateway.example/v1"]
)
def test_resolve_api_type_follows_the_catalog_not_the_base_url(
monkeypatch: pytest.MonkeyPatch, api_base: str | None
) -> None:
"""Responses when LiteLLM lists /v1/responses for the model, chat completions otherwise."""
settings = _settings(monkeypatch, "gpt-5", api_base)
for model in ("gpt-5", "gpt-5.6-sol", "openai/gpt-5.4", "gpt-daybreak-blue-latest"):
assert resolve_api_type(model, settings) == "responses", model
assert uses_chat_completions_tool_schema(model, settings) is False, model
for model in ("gpt-4o", "my-private-model"):
assert resolve_api_type(model, settings) == "chat_completions", model
assert uses_chat_completions_tool_schema(model, settings) is True, model
def test_resolve_api_type_explicit_override_wins(monkeypatch: pytest.MonkeyPatch) -> None:
_settings(monkeypatch, "gpt-daybreak-blue-latest", "https://gateway.example/v1")
monkeypatch.setenv("STRIX_API_TYPE", "chat_completions")
assert resolve_api_type("gpt-daybreak-blue-latest", Settings()) == "chat_completions"
monkeypatch.setenv("STRIX_API_TYPE", "Responses")
assert resolve_api_type("gpt-5", Settings()) == "responses"
@pytest.mark.parametrize(
("raw", "expected"),
[("None", "none"), ("HIGH", "high"), (" xhigh ", "xhigh"), ("Max", "max")],
)
def test_reasoning_effort_is_case_insensitive(
monkeypatch: pytest.MonkeyPatch, raw: str, expected: str
) -> None:
monkeypatch.setenv("STRIX_REASONING_EFFORT", raw)
monkeypatch.setenv("STRIX_DEDUPE_REASONING_EFFORT", raw)
settings = Settings()
assert settings.llm.reasoning_effort == expected
assert settings.dedupe.reasoning_effort == expected
def test_configure_sdk_api_route_follows_the_given_model(
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""A ``model=`` override picks its own route, not ``STRIX_LLM``'s."""
routes: list[str] = []
monkeypatch.setattr(models, "set_default_openai_api", routes.append)
settings = _settings(monkeypatch, "gpt-5", "https://gateway.example/v1")
models.configure_sdk_api_route("gpt-5", settings)
models.configure_sdk_api_route("my-private-model", settings)
assert routes == ["responses", "chat_completions"]
+45
View File
@@ -0,0 +1,45 @@
"""Every parameter of every scan-agent tool carries a description in its JSON schema.
The model only sees a parameter's docstring text through the schema. An ``Args:``
section that the docstring parser fails to recognise (for example because an
earlier line opens a markdown code fence it never closes) silently drops every
parameter description, so optional-but-conditionally-required fields such as
``confidence_rationale`` become anonymous nullable strings the model never fills.
"""
from __future__ import annotations
import pytest
from agents.tool import FunctionTool
from strix.agents import factory
from strix.tools.agents_graph.tools import agent_finish
from strix.tools.finish.tool import finish_scan
from strix.tools.reporting.tool import create_vulnerability_report
from strix.tools.respond.tool import respond_to_user
_SCAN_AGENT_TOOLS = [
tool
for tool in (*factory._BASE_TOOLS, finish_scan, agent_finish, respond_to_user)
if isinstance(tool, FunctionTool)
]
@pytest.mark.parametrize("tool", _SCAN_AGENT_TOOLS, ids=lambda tool: tool.name)
def test_every_parameter_has_a_description(tool: FunctionTool) -> None:
properties = tool.params_json_schema.get("properties", {})
missing = sorted(
name
for name, schema in properties.items()
if not (isinstance(schema.get("description"), str) and schema["description"].strip())
)
assert not missing, f"{tool.name}: parameters without a description: {missing}"
def test_create_vulnerability_report_explains_confidence_rationale() -> None:
schema = create_vulnerability_report.params_json_schema["properties"]
assert "confidence" in create_vulnerability_report.params_json_schema["required"]
rationale = schema["confidence_rationale"]["description"]
assert "Required when" in rationale
assert "high" in rationale
-10
View File
@@ -129,16 +129,6 @@ async def test_large_target_list_reports_truncated_snapshot_count() -> None:
assert len(snapshot["targets"]) == 16
def test_state_populates_model_warning_for_non_frontier_model() -> None:
os.environ["STRIX_LLM"] = "openai/gpt-3.5-turbo"
loader._cached = None
warning = TuiController(args()).snapshot()["model_warning"]
assert "openai/gpt-3.5-turbo" in warning
assert "not a recommended frontier model" in warning
def test_setup_restores_prepared_cli_targets() -> None:
setup_args = args()
setup_args.targets_info = [