From c2bc7720cdc23e80339acf71ef4aa8def994f9a1 Mon Sep 17 00:00:00 2001 From: "seahaven-openswe[bot]" <296972425+seahaven-openswe[bot]@users.noreply.github.com> Date: Thu, 9 Jul 2026 14:44:15 -0400 Subject: [PATCH 1/2] feat: port LangSmith LLM Gateway routing from upstream (#1671, #1673, #1674, #1678) (#155) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: port LangSmith LLM Gateway routing from upstream (#1671, #1673, #1674, #1678) Ports four upstream commits that add opt-in LLM call routing through the LangSmith Gateway, preserving fork conventions (Bedrock/Fireworks model IDs, no-agent-attribution, bun toolchain). - #1671 (e9dc6e01): opt-in gateway routing — new gateway.py, team-settings toggle, admin UI section, wired into make_model for all graph entrypoints - #1673 (702ef908): dedicated LANGSMITH_GATEWAY_API_KEY precedence over platform LANGSMITH_API_KEY - #1674 (5f7c2f46): fix Fireworks gateway base URL to /fireworks (bare host, SDK appends /v1/chat/completions) + SanitizeFireworksMessagesMiddleware - #1678 (73b7d1c0): fix OpenAI Responses reasoning replay — SanitizeOpenAIResponsesMiddleware, store/include config for encrypted reasoning content, reasoning_effort coercion for Chat Completions fallback Refs #134 * fix: downgrade gateway not-routed log to debug, add Bedrock UI note, add sanitizer parity - Downgrade logger.warning to logger.debug in gateway_overrides for not-routed providers and missing API key (Bedrock is the default provider in this fork, so these are expected steady states) - Add Bedrock to the LLMGatewaySection route-toggle description so admins know it is not routed through the gateway - Add SanitizeOpenAIResponsesMiddleware to chat.py for parity with server.py and reviewer.py - Restore the Bedrock region comment in model.py that explains the AWS_REGION / AWS_DEFAULT_REGION precedence Refs #138 --------- Co-authored-by: amoussa1229 <166072409+amoussa1229@users.noreply.github.com> --- CUSTOMIZATION.md | 19 + agent/analyzer.py | 4 +- agent/chat.py | 9 +- agent/dashboard/team_settings.py | 18 + agent/middleware/__init__.py | 4 + .../middleware/sanitize_fireworks_messages.py | 79 ++++ agent/middleware/sanitize_openai_responses.py | 85 ++++ agent/reviewer.py | 22 +- agent/server.py | 29 +- agent/utils/gateway.py | 126 +++++ agent/utils/model.py | 51 +- docs/upstream-sync/triage.jsonl | 8 +- docs/upstream-sync/triage.md | 8 +- tests/test_gateway.py | 437 ++++++++++++++++++ tests/test_sanitize_fireworks_messages.py | 118 +++++ tests/test_sanitize_openai_responses.py | 55 +++ ui/src/lib/api.ts | 2 + ui/src/routes/admin.tsx | 73 +++ 18 files changed, 1123 insertions(+), 24 deletions(-) create mode 100644 agent/middleware/sanitize_fireworks_messages.py create mode 100644 agent/middleware/sanitize_openai_responses.py create mode 100644 agent/utils/gateway.py create mode 100644 tests/test_gateway.py create mode 100644 tests/test_sanitize_fireworks_messages.py create mode 100644 tests/test_sanitize_openai_responses.py diff --git a/CUSTOMIZATION.md b/CUSTOMIZATION.md index 33037489..6f2ca79f 100644 --- a/CUSTOMIZATION.md +++ b/CUSTOMIZATION.md @@ -193,6 +193,25 @@ async def get_agent(config: RunnableConfig) -> Pregel: return create_deep_agent(model=model, ...) ``` +### Routing through the LangSmith LLM Gateway + +Model calls can be proxied through the [LangSmith LLM Gateway](https://docs.langchain.com/langsmith/llm-gateway) (private beta) instead of hitting providers directly. The gateway authenticates with a **LangSmith API key** that has the `gateway:invoke` permission and resolves the real provider key from workspace Provider Secrets, so no provider API keys are needed at runtime — and it adds central spend limits, PII/secrets redaction, and tracing. Your org must have the gateway enabled with Provider Secrets configured. + +Routing is opt-in and off by default. Enable it either way: + +| Env var | Default | Purpose | +|---|---|---| +| `LANGSMITH_GATEWAY_ENABLED` | `false` | Deployment-level default for gateway routing. | +| `LANGSMITH_GATEWAY_API_KEY` | unset | Optional dedicated LangSmith key for Gateway calls. Prefer this in LangGraph Cloud if the platform-provided `LANGSMITH_API_KEY` lacks `gateway:invoke`. Falls back to `LANGSMITH_API_KEY_PROD`, then `LANGSMITH_API_KEY`. | +| `LANGSMITH_GATEWAY_BASE_URL` | `https://gateway.smith.langchain.com` | Override for a regional or self-hosted gateway host. | +| `LANGSMITH_GATEWAY_OPENAI_USE_RESPONSES` | `true` | Use the OpenAI Responses API through the gateway. Set to `false` only to force Chat Completions for OpenAI models. | + +The admin panel (**Admin → LLM Gateway**) exposes a per-workspace toggle stored in team settings; when set it overrides the `LANGSMITH_GATEWAY_ENABLED` env default (a `None`/unset team value inherits the env default). + +Routing is applied centrally in `make_model` (`agent/utils/model.py`), which resolves the effective on/off and delegates URL/key wiring to `agent/utils/gateway.py`. **OpenAI, Anthropic, Fireworks, and Google Gemini** are routed (their LangChain integrations accept `base_url` + `api_key`); Google Vertex (service-account auth) and any other provider call the provider directly with a logged warning. + +**Caveat — OpenAI endpoint:** open-swe uses the OpenAI Responses API by default because OpenAI reasoning models with function tools reject `reasoning_effort` on Chat Completions. Direct OpenAI calls use a `wss://` base URL; gateway-routed OpenAI uses the HTTPS gateway base URL with Responses enabled. Set `LANGSMITH_GATEWAY_OPENAI_USE_RESPONSES=false` only if you need to force Chat Completions. Anthropic and Fireworks are unaffected. + --- ## 3. Tools diff --git a/agent/analyzer.py b/agent/analyzer.py index 0f8cc1da..13680de8 100644 --- a/agent/analyzer.py +++ b/agent/analyzer.py @@ -29,6 +29,7 @@ from deepagents.backends.protocol import SandboxBackendProtocol from deepagents.backends.state import StateBackend from langchain.agents.middleware import ModelCallLimitMiddleware +from .dashboard.team_settings import get_effective_gateway_enabled from .integrations.langsmith import _configure_github_proxy from .middleware import SanitizeToolInputsMiddleware, ToolErrorMiddleware from .review_style_guidance import REVIEWER_STYLE_THEMES @@ -116,6 +117,7 @@ async def get_analyzer(config: RunnableConfig) -> Pregel: backend = CompositeBackend(default=sandbox_backend, routes={SKILLS_ROUTE: StateBackend()}) model_id = DEFAULT_LLM_MODEL_ID + use_gateway = await get_effective_gateway_enabled() model_kwargs = provider_model_kwargs( model_id, None, @@ -135,7 +137,7 @@ async def get_analyzer(config: RunnableConfig) -> Pregel: system_prompt = f"{system_prompt}\n\n{user_context}" return create_deep_agent( - model=make_model(model_id, **model_kwargs), + model=make_model(model_id, use_gateway=use_gateway, **model_kwargs), system_prompt=system_prompt, tools=[save_review_style_prompt, read_finding_outcomes], backend=backend, diff --git a/agent/chat.py b/agent/chat.py index efdba398..132f83d8 100644 --- a/agent/chat.py +++ b/agent/chat.py @@ -29,9 +29,11 @@ from deepagents import create_deep_agent from langchain.agents.middleware import ModelCallLimitMiddleware from .dashboard.options import SUPPORTED_MODEL_IDS, model_supports_effort -from .dashboard.team_settings import get_team_default_model +from .dashboard.team_settings import get_effective_gateway_enabled, get_team_default_model from .middleware import ( ExcludeToolsMiddleware, + SanitizeFireworksMessagesMiddleware, + SanitizeOpenAIResponsesMiddleware, SanitizeThinkingBlocksMiddleware, SanitizeToolInputsMiddleware, ToolErrorMiddleware, @@ -123,6 +125,7 @@ async def get_chat_agent(config: RunnableConfig) -> Pregel: configurable["chat_github_token"] = token model_id, effort = await _resolve_chat_model(configurable) + use_gateway = await get_effective_gateway_enabled() model_kwargs = provider_model_kwargs( model_id, effort, @@ -137,7 +140,7 @@ async def get_chat_agent(config: RunnableConfig) -> Pregel: ) return create_deep_agent( - model=make_model(model_id, **model_kwargs), + model=make_model(model_id, use_gateway=use_gateway, **model_kwargs), system_prompt=system_prompt, tools=[ read_repo_file, @@ -151,6 +154,8 @@ async def get_chat_agent(config: RunnableConfig) -> Pregel: ModelCallLimitMiddleware(run_limit=CHAT_MODEL_CALL_LIMIT, exit_behavior="end"), ToolErrorMiddleware(), ExcludeToolsMiddleware(excluded=_EXCLUDED_TOOLS), + SanitizeOpenAIResponsesMiddleware(), + SanitizeFireworksMessagesMiddleware(), SanitizeThinkingBlocksMiddleware(), ], ).with_config(config) diff --git a/agent/dashboard/team_settings.py b/agent/dashboard/team_settings.py index e81ff4b8..98299ed5 100644 --- a/agent/dashboard/team_settings.py +++ b/agent/dashboard/team_settings.py @@ -15,6 +15,7 @@ from typing import Any, Literal from langgraph_sdk import get_client from pydantic import BaseModel, field_validator, model_validator +from ..utils.gateway import resolve_gateway_enabled from .options import ( SUPPORTED_MODEL_IDS, default_model_pair, @@ -52,6 +53,9 @@ class TeamSettingsUpdate(BaseModel): review_draft_prs: bool = False pr_summaries: bool = True review_trace_links: bool = True + # Tri-state LLM Gateway toggle: True/False is authoritative, None inherits the + # LANGSMITH_GATEWAY_ENABLED deployment default. + gateway_enabled: bool | None = None review_tracing_project: str | None = None org_guidelines: str | None = None default_agent_model: str | None = None @@ -166,6 +170,7 @@ def _default_settings() -> dict[str, Any]: "review_draft_prs": False, "pr_summaries": True, "review_trace_links": True, + "gateway_enabled": None, "review_tracing_project": None, "org_guidelines": DEFAULT_ORG_REVIEW_GUIDELINES, "default_agent_model": fallback_model, @@ -220,6 +225,7 @@ async def upsert_team_settings(update: TeamSettingsUpdate) -> dict[str, Any]: "review_draft_prs": update.review_draft_prs, "pr_summaries": update.pr_summaries, "review_trace_links": update.review_trace_links, + "gateway_enabled": update.gateway_enabled, "review_tracing_project": update.review_tracing_project, "org_guidelines": update.org_guidelines, "default_agent_model": update.default_agent_model, @@ -340,6 +346,18 @@ async def get_team_review_trace_links_enabled() -> bool: return bool(settings.get("review_trace_links", True)) +async def get_team_gateway_enabled() -> bool | None: + """Return the stored LLM Gateway toggle (``None`` means inherit the env default).""" + settings = await get_team_settings() + value = settings.get("gateway_enabled") + return value if isinstance(value, bool) else None + + +async def get_effective_gateway_enabled() -> bool: + """Resolve whether LLM Gateway routing is on: team setting, else env default.""" + return resolve_gateway_enabled(await get_team_gateway_enabled()) + + async def get_team_review_tracing_project() -> str | None: """Return the LangSmith tracing project used for PR trace resolution.""" settings = await get_team_settings() diff --git a/agent/middleware/__init__.py b/agent/middleware/__init__.py index c40ce67b..d6d94403 100644 --- a/agent/middleware/__init__.py +++ b/agent/middleware/__init__.py @@ -8,6 +8,8 @@ from .refresh_github_proxy import refresh_github_proxy_before_model from .refresh_slack_status import SlackAssistantStatusMiddleware from .repair_orphaned_tool_calls import RepairOrphanedToolCallsMiddleware from .sandbox_circuit_breaker import SandboxCircuitBreakerMiddleware +from .sanitize_fireworks_messages import SanitizeFireworksMessagesMiddleware +from .sanitize_openai_responses import SanitizeOpenAIResponsesMiddleware from .sanitize_thinking_blocks import SanitizeThinkingBlocksMiddleware from .sanitize_tool_inputs import SanitizeToolInputsMiddleware from .settle_review_check import settle_review_check_on_exit @@ -21,6 +23,8 @@ __all__ = [ "ModelFallbackMiddleware", "PlanModeMiddleware", "RepairOrphanedToolCallsMiddleware", + "SanitizeFireworksMessagesMiddleware", + "SanitizeOpenAIResponsesMiddleware", "SanitizeThinkingBlocksMiddleware", "SanitizeToolInputsMiddleware", "SubdirAgentsReadMiddleware", diff --git a/agent/middleware/sanitize_fireworks_messages.py b/agent/middleware/sanitize_fireworks_messages.py new file mode 100644 index 00000000..79c4d0d3 --- /dev/null +++ b/agent/middleware/sanitize_fireworks_messages.py @@ -0,0 +1,79 @@ +"""Strip legacy ``function_call`` fields before Fireworks provider calls. + +The LangSmith LLM Gateway enforces strict request-schema validation and rejects +messages carrying the legacy OpenAI ``function_call`` field +(``Extra inputs are not permitted, field: 'messages[N].function_call'``). +``langchain_fireworks`` forwards ``function_call`` from +``AIMessage.additional_kwargs`` whenever it is present — even when the message +also carries modern ``tool_calls`` — so a message that was originally produced +by (or deserialized from) a provider that populated the legacy field will break +every subsequent Fireworks turn once routed through the gateway. + +This middleware drops the redundant legacy field from assistant messages before +they reach the Fireworks serializer, mirroring the thinking-block sanitizer. +""" + +from __future__ import annotations + +from collections.abc import Awaitable, Callable +from typing import Any + +from langchain.agents.middleware import AgentMiddleware +from langchain.agents.middleware.types import ModelCallResult, ModelRequest, ModelResponse +from langchain_core.messages import AIMessage + +try: + from langchain_fireworks.chat_models import ChatFireworks +except ImportError: # pragma: no cover + ChatFireworks = None # type: ignore[assignment, misc] + + +def _is_chat_fireworks(model: object) -> bool: + if ChatFireworks is None: + return False + seen: set[int] = set() + current = model + for _ in range(10): + if isinstance(current, ChatFireworks): + return True + current_id = id(current) + if current_id in seen: + return False + seen.add(current_id) + bound = getattr(current, "bound", None) + if bound is None or bound is current: + return False + current = bound + return False + + +def _sanitize_messages(messages: list[Any]) -> None: + for message in messages: + if not isinstance(message, AIMessage): + continue + additional_kwargs = message.additional_kwargs + if not isinstance(additional_kwargs, dict) or "function_call" not in additional_kwargs: + continue + additional_kwargs.pop("function_call", None) + + +class SanitizeFireworksMessagesMiddleware(AgentMiddleware): + """Drop legacy ``function_call`` fields before Fireworks provider calls.""" + + def wrap_model_call( + self, + request: ModelRequest, + handler: Callable[[ModelRequest], ModelResponse], + ) -> ModelCallResult: + if _is_chat_fireworks(request.model): + _sanitize_messages(request.messages) + return handler(request) + + async def awrap_model_call( + self, + request: ModelRequest, + handler: Callable[[ModelRequest], Awaitable[ModelResponse]], + ) -> Any: + if _is_chat_fireworks(request.model): + _sanitize_messages(request.messages) + return await handler(request) diff --git a/agent/middleware/sanitize_openai_responses.py b/agent/middleware/sanitize_openai_responses.py new file mode 100644 index 00000000..a68104b0 --- /dev/null +++ b/agent/middleware/sanitize_openai_responses.py @@ -0,0 +1,85 @@ +"""Middleware that removes stale OpenAI Responses reasoning references.""" + +from __future__ import annotations + +import logging +from collections.abc import Awaitable, Callable +from typing import Any + +from langchain.agents.middleware import AgentMiddleware +from langchain.agents.middleware.types import ModelCallResult, ModelRequest, ModelResponse +from langchain_core.messages import AIMessage + +try: + from langchain_openai import ChatOpenAI +except ImportError: # pragma: no cover + ChatOpenAI = None # type: ignore[assignment, misc] + +logger = logging.getLogger(__name__) + + +def _is_chat_openai(model: object) -> bool: + if ChatOpenAI is None: + return False + seen: set[int] = set() + current = model + for _ in range(10): + if isinstance(current, ChatOpenAI): + return True + current_id = id(current) + if current_id in seen: + return False + seen.add(current_id) + bound = getattr(current, "bound", None) + if bound is None or bound is current: + return False + current = bound + return False + + +def _is_stale_reasoning_reference(block: dict[str, Any]) -> bool: + if block.get("type") != "reasoning": + return False + if block.get("encrypted_content"): + return False + block_id = block.get("id") + return isinstance(block_id, str) and block_id.startswith("rs_") + + +def _sanitize_messages(messages: list[Any]) -> None: + removed = 0 + for message in messages: + if not isinstance(message, AIMessage) or not isinstance(message.content, list): + continue + content = [] + for block in message.content: + if isinstance(block, dict) and _is_stale_reasoning_reference(block): + removed += 1 + continue + content.append(block) + if len(content) != len(message.content): + message.content = content + if removed: + logger.warning("Removed %d stale OpenAI Responses reasoning reference(s)", removed) + + +class SanitizeOpenAIResponsesMiddleware(AgentMiddleware): + """Drop non-replayable OpenAI Responses reasoning item references.""" + + def wrap_model_call( + self, + request: ModelRequest, + handler: Callable[[ModelRequest], ModelResponse], + ) -> ModelCallResult: + if _is_chat_openai(request.model): + _sanitize_messages(request.messages) + return handler(request) + + async def awrap_model_call( + self, + request: ModelRequest, + handler: Callable[[ModelRequest], Awaitable[ModelResponse]], + ) -> Any: + if _is_chat_openai(request.model): + _sanitize_messages(request.messages) + return await handler(request) diff --git a/agent/reviewer.py b/agent/reviewer.py index 7704ef98..2bafe7ba 100644 --- a/agent/reviewer.py +++ b/agent/reviewer.py @@ -34,12 +34,15 @@ from langchain.agents.middleware import ModelCallLimitMiddleware from langchain_core.language_models.chat_models import BaseChatModel from .dashboard.team_settings import ( + get_effective_gateway_enabled, get_org_review_guidelines, get_team_default_grouping_model, get_team_default_model_pair, ) from .middleware import ( RepairOrphanedToolCallsMiddleware, + SanitizeFireworksMessagesMiddleware, + SanitizeOpenAIResponsesMiddleware, SanitizeThinkingBlocksMiddleware, SanitizeToolInputsMiddleware, SlackAssistantStatusMiddleware, @@ -801,7 +804,9 @@ def _on_background_task_done(task: asyncio.Task[None]) -> None: logger.warning("Background reviewer task failed: %s", exc) -async def _resolve_grouping_model(configurable: dict[str, object]) -> BaseChatModel: +async def _resolve_grouping_model( + configurable: dict[str, object], *, use_gateway: bool +) -> BaseChatModel: """Resolve the model for the diff-grouping pass. Per-run override (``grouping_model_id``/``grouping_reasoning_effort``) wins; @@ -821,7 +826,7 @@ async def _resolve_grouping_model(configurable: dict[str, object]) -> BaseChatMo max_tokens=DEFAULT_LLM_MAX_TOKENS, openai_reasoning_default=DEFAULT_LLM_REASONING, ) - return make_model(model_id, **model_kwargs) + return make_model(model_id, use_gateway=use_gateway, **model_kwargs) async def get_reviewer_agent(config: RunnableConfig) -> Pregel: @@ -1156,8 +1161,11 @@ async def get_reviewer_agent(config: RunnableConfig) -> Pregel: if review_context: system_prompt = f"{system_prompt}\n\n{review_context}" - reviewer_model = make_model(model_id, **model_kwargs) - reviewer_subagent_model = make_model(subagent_model_id, **subagent_model_kwargs) + use_gateway = await get_effective_gateway_enabled() + reviewer_model = make_model(model_id, use_gateway=use_gateway, **model_kwargs) + reviewer_subagent_model = make_model( + subagent_model_id, use_gateway=use_gateway, **subagent_model_kwargs + ) # Kick off the AI-sorted diff grouping pass at run start, concurrently with # the review, so it adds ~0 latency. First-review and re-review only — a @@ -1165,7 +1173,9 @@ async def get_reviewer_agent(config: RunnableConfig) -> Pregel: # its own errors and the UI falls back to the folder view when groups are # absent. if reviewer_event != "finding_reply" and pr_diff_text and thread_id: - grouping_model = await _resolve_grouping_model(config["configurable"]) + grouping_model = await _resolve_grouping_model( + config["configurable"], use_gateway=use_gateway + ) grouping_task = asyncio.create_task( maybe_generate_and_store_diff_groups( thread_id=thread_id, @@ -1201,6 +1211,8 @@ async def get_reviewer_agent(config: RunnableConfig) -> Pregel: refresh_github_proxy_before_model, check_message_queue_before_model, SlackAssistantStatusMiddleware(), + SanitizeOpenAIResponsesMiddleware(), + SanitizeFireworksMessagesMiddleware(), SanitizeThinkingBlocksMiddleware(), RepairOrphanedToolCallsMiddleware(), settle_review_check_on_exit, diff --git a/agent/server.py b/agent/server.py index 48afa4d0..5e8af637 100644 --- a/agent/server.py +++ b/agent/server.py @@ -44,6 +44,7 @@ from .dashboard.agent_usage import record_agent_thread_usage from .dashboard.options import DEFAULT_MODEL_ID, SUPPORTED_MODEL_IDS, model_supports_effort from .dashboard.repo_snapshots import resolve_repo_snapshot_id from .dashboard.team_settings import ( + get_effective_gateway_enabled, get_team_default_model_pair, get_team_default_repo, ) @@ -58,6 +59,8 @@ from .middleware import ( ModelFallbackMiddleware, PlanModeMiddleware, SandboxCircuitBreakerMiddleware, + SanitizeFireworksMessagesMiddleware, + SanitizeOpenAIResponsesMiddleware, SanitizeThinkingBlocksMiddleware, SanitizeToolInputsMiddleware, SlackAssistantStatusMiddleware, @@ -758,19 +761,31 @@ async def get_agent(config: RunnableConfig) -> Pregel: ensure_sandbox_for_thread(thread_id, repo=prompt_default_repo) ) team_defaults_task = asyncio.create_task(get_team_default_model_pair("agent")) + gateway_task = asyncio.create_task(get_effective_gateway_enabled()) profile_task = asyncio.create_task(load_profile(profile_login)) if profile_login else None try: - triggering_user_identity, sandbox_backend, team_defaults = await asyncio.gather( + ( + triggering_user_identity, + sandbox_backend, + team_defaults, + use_gateway, + ) = await asyncio.gather( triggering_user_identity_task, sandbox_task, team_defaults_task, + gateway_task, ) except SandboxRepoMismatchError as exc: # Repo-binding refusal at the run boundary: log for alarming and surface the # already-sanitized terminal error (no sandbox/token internals) to the caller, # rather than letting an opaque deep-stack exception crash-loop the worker. logger.error("Refusing agent run for thread %s: %s", thread_id, exc) - for pending in (triggering_user_identity_task, team_defaults_task, profile_task): + for pending in ( + triggering_user_identity_task, + team_defaults_task, + gateway_task, + profile_task, + ): if pending is not None and not pending.done(): pending.cancel() raise RuntimeError(str(exc)) from exc @@ -860,7 +875,9 @@ async def get_agent(config: RunnableConfig) -> Pregel: fallback_model_id, None, max_tokens=DEFAULT_LLM_MAX_TOKENS ) fallback_middleware.append( - ModelFallbackMiddleware(make_model(fallback_model_id, **fallback_kwargs)) + ModelFallbackMiddleware( + make_model(fallback_model_id, use_gateway=use_gateway, **fallback_kwargs) + ) ) logger.info("Configured model fallback %s -> %s", model_id, fallback_model_id) @@ -926,8 +943,8 @@ async def get_agent(config: RunnableConfig) -> Pregel: notion_tools = [] logger.info("Returning agent with sandbox for thread %s", thread_id) - main_model = make_model(model_id, **model_kwargs) - subagent_model = make_model(subagent_model_id, **subagent_model_kwargs) + main_model = make_model(model_id, use_gateway=use_gateway, **model_kwargs) + subagent_model = make_model(subagent_model_id, use_gateway=use_gateway, **subagent_model_kwargs) return create_deep_agent( model=main_model, system_prompt=construct_system_prompt( @@ -987,6 +1004,8 @@ async def get_agent(config: RunnableConfig) -> Pregel: SandboxCircuitBreakerMiddleware(), *fallback_middleware, *plan_mode_middleware, + SanitizeOpenAIResponsesMiddleware(), + SanitizeFireworksMessagesMiddleware(), SanitizeThinkingBlocksMiddleware(), ], ).with_config(config) diff --git a/agent/utils/gateway.py b/agent/utils/gateway.py new file mode 100644 index 00000000..065e6edb --- /dev/null +++ b/agent/utils/gateway.py @@ -0,0 +1,126 @@ +"""LangSmith LLM Gateway routing for model construction. + +The LLM Gateway (https://docs.langchain.com/langsmith/llm-gateway) proxies +provider calls through LangSmith: the client authenticates with a LangSmith API +key and the gateway resolves the real provider key from workspace Provider +Secrets, enforcing spend/PII/secrets policies and tracing every call. Routing is +opt-in via ``LANGSMITH_GATEWAY_ENABLED`` (deployment default) or the +``gateway_enabled`` team setting, and is applied centrally in +:func:`agent.utils.model.make_model`. +""" + +from __future__ import annotations + +import logging +import os + +logger = logging.getLogger(__name__) + +DEFAULT_GATEWAY_BASE_URL = "https://gateway.smith.langchain.com" + +# Provider prefix -> base-URL suffix appended to the gateway host. Each suffix +# matches the SDK's own path handling: the OpenAI SDK appends +# ``/chat/completions`` to a ``/v1`` base, Fireworks appends +# ``/v1/chat/completions`` to a bare provider host, Anthropic appends +# ``/v1/messages`` to a bare host, and google-genai appends +# ``//models/...`` to a bare host. Vertex (``google_vertexai``, which +# uses service-account auth rather than a bearer key) and any other provider are +# not routed and call the provider directly. +_GATEWAY_PROVIDER_PATHS: dict[str, str] = { + "openai": "/openai/v1", + "anthropic": "/anthropic", + "fireworks": "/fireworks", + "google_genai": "/gemini", +} + + +def _env_bool(value: str | None) -> bool: + return (value or "").strip().lower() in {"1", "true", "yes", "on"} + + +def _langsmith_api_key() -> str | None: + """LangSmith API key used to authenticate gateway calls. + + Prefer a gateway-specific key, then the prod LangSmith key. LangGraph Cloud + may inject ``LANGSMITH_API_KEY`` for tracing/platform APIs, and that key can + lack the ``gateway:invoke`` permission required by the LLM Gateway. + """ + return ( + os.environ.get("LANGSMITH_GATEWAY_API_KEY") + or os.environ.get("LANGSMITH_API_KEY_PROD") + or os.environ.get("LANGSMITH_API_KEY") + ) + + +def gateway_base_url() -> str: + """Gateway host, overridable via ``LANGSMITH_GATEWAY_BASE_URL`` (regional/self-hosted).""" + return (os.environ.get("LANGSMITH_GATEWAY_BASE_URL") or DEFAULT_GATEWAY_BASE_URL).rstrip("/") + + +def gateway_env_default() -> bool: + """Deployment-level default for gateway routing (``LANGSMITH_GATEWAY_ENABLED``).""" + return _env_bool(os.environ.get("LANGSMITH_GATEWAY_ENABLED")) + + +def gateway_openai_use_responses() -> bool: + """Whether gateway-routed OpenAI keeps the Responses API. + + Defaults to ``True`` because OpenAI reasoning models with tool calls reject + ``reasoning_effort`` on Chat Completions. Set + ``LANGSMITH_GATEWAY_OPENAI_USE_RESPONSES=false`` only for deployments that + need to force Chat Completions through the gateway. + """ + raw = os.environ.get("LANGSMITH_GATEWAY_OPENAI_USE_RESPONSES") + if raw is None: + return True + return _env_bool(raw) + + +def resolve_gateway_enabled(team_value: bool | None) -> bool: + """Combine the team-settings toggle with the env default. + + A team value of ``True``/``False`` is authoritative; ``None`` inherits the + ``LANGSMITH_GATEWAY_ENABLED`` deployment default. + """ + if team_value is None: + return gateway_env_default() + return team_value + + +def _provider_of(model_id: str) -> str: + return model_id.split(":", 1)[0] + + +def gateway_overrides(model_id: str) -> dict[str, object] | None: + """``init_chat_model`` kwargs that route ``model_id`` through the gateway. + + Returns ``None`` (so the caller keeps talking to the provider directly) when + the provider isn't routable through the gateway or no LangSmith API key is + available — both cases are logged rather than raised, so a run never fails + just because gateway routing couldn't be applied. + """ + provider = _provider_of(model_id) + path = _GATEWAY_PROVIDER_PATHS.get(provider) + if path is None: + logger.debug( + "LangSmith gateway enabled but provider %r is not routed; calling it directly", + provider, + ) + return None + api_key = _langsmith_api_key() + if not api_key: + logger.debug( + "LangSmith gateway enabled but no LANGSMITH_GATEWAY_API_KEY or " + "LANGSMITH_API_KEY(_PROD) is set; " + "calling the provider directly" + ) + return None + overrides: dict[str, object] = { + "base_url": f"{gateway_base_url()}{path}", + "api_key": api_key, + } + if provider == "openai": + # Use HTTPS Responses through the gateway by default; tool-calling OpenAI + # reasoning models reject reasoning_effort on Chat Completions. + overrides["use_responses_api"] = gateway_openai_use_responses() + return overrides diff --git a/agent/utils/model.py b/agent/utils/model.py index cadf1dbd..1313663c 100644 --- a/agent/utils/model.py +++ b/agent/utils/model.py @@ -4,6 +4,7 @@ from typing import Literal, TypedDict, Unpack from langchain.chat_models import init_chat_model from ..dashboard.options import DEFAULT_MODEL_ID +from .gateway import gateway_env_default, gateway_overrides OPENAI_RESPONSES_WS_BASE_URL = "wss://api.openai.com/v1" @@ -39,11 +40,14 @@ class AnthropicThinking(TypedDict, total=False): class ModelKwargs(TypedDict, total=False): max_tokens: int | None reasoning: OpenAIReasoning | None + reasoning_effort: OpenAIReasoningEffort | None thinking: AnthropicThinking | None effort: AnthropicEffort | None thinking_level: GoogleThinkingLevel | None temperature: float | None max_retries: int | None + store: bool | None + include: list[str] | None model_kwargs: dict[str, object] | None additional_model_request_fields: dict[str, object] | None region_name: str | None @@ -52,21 +56,62 @@ class ModelKwargs(TypedDict, total=False): _ANTHROPIC_EFFORTS: set[AnthropicEffort] = {"low", "medium", "high", "xhigh", "max"} -def make_model(model_id: str, **kwargs: Unpack[ModelKwargs]): +def _coerce_openai_chat_completions_kwargs(model_kwargs: dict[str, object]) -> None: + if model_kwargs.get("use_responses_api") is not False: + return + reasoning = model_kwargs.pop("reasoning", None) + if isinstance(reasoning, dict): + effort = reasoning.get("effort") + if isinstance(effort, str): + model_kwargs.setdefault("reasoning_effort", effort) + + +def _configure_openai_responses_kwargs(model_kwargs: dict[str, object]) -> None: + if model_kwargs.get("use_responses_api") is False: + return + model_kwargs.setdefault("store", False) + include = model_kwargs.get("include") + if include is None: + model_kwargs["include"] = ["reasoning.encrypted_content"] + elif isinstance(include, list) and "reasoning.encrypted_content" not in include: + include.append("reasoning.encrypted_content") + + +def make_model(model_id: str, *, use_gateway: bool | None = None, **kwargs: Unpack[ModelKwargs]): + """Build a chat model, optionally routed through the LangSmith LLM Gateway. + + ``use_gateway`` resolves the deployment default (``LANGSMITH_GATEWAY_ENABLED``) + when ``None``; async callers pass the team-settings-resolved value. When on, + gateway ``base_url``/``api_key``/``use_responses_api`` override the direct + provider defaults below (see :mod:`agent.utils.gateway`). + """ model_kwargs: dict[str, object] = kwargs.copy() model_kwargs.setdefault("max_retries", DEFAULT_MAX_RETRIES) if model_id.startswith("openai:"): + # Direct-provider default: Responses API over the OpenAI websocket base. + # Gateway routing overrides this below (an HTTP(S) proxy can't carry wss). model_kwargs["base_url"] = OPENAI_RESPONSES_WS_BASE_URL model_kwargs["use_responses_api"] = True elif model_id.startswith("bedrock_converse:"): - # Resolve region with the same precedence validate_local_dev_llm_config accepts - # (AWS_REGION or AWS_DEFAULT_REGION), so the validated value is the one actually used. + # Resolve region with the same precedence validate_local_dev_llm_config + # accepts (AWS_REGION or AWS_DEFAULT_REGION), so the validated value + # is the one actually used. model_kwargs.setdefault( "region_name", os.environ.get("AWS_REGION") or os.environ.get("AWS_DEFAULT_REGION") or "us-east-1", ) + enabled = gateway_env_default() if use_gateway is None else use_gateway + if enabled: + overrides = gateway_overrides(model_id) + if overrides is not None: + model_kwargs.update(overrides) + + if model_id.startswith("openai:"): + _configure_openai_responses_kwargs(model_kwargs) + _coerce_openai_chat_completions_kwargs(model_kwargs) + return init_chat_model(model=model_id, **model_kwargs) diff --git a/docs/upstream-sync/triage.jsonl b/docs/upstream-sync/triage.jsonl index 226e4b58..1f390645 100644 --- a/docs/upstream-sync/triage.jsonl +++ b/docs/upstream-sync/triage.jsonl @@ -32,10 +32,10 @@ {"sha": "4cd5fa5c", "pr": 1629, "subject": "avoid recapping Slack replies", "disposition": "deferred", "reason": "", "branch": "slack-tooling", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} {"sha": "92dbf6f9", "pr": 1630, "subject": "update Slack trace reply on web handoff", "disposition": "landed", "reason": "ported in #128 (trace_message_ts on first-mention run mapping)", "branch": "slack-tooling", "local_sha": null, "updated": "2026-07-08T22:58:21Z"} {"sha": "bb36448b", "pr": 1627, "subject": "surface Slack thread errors", "disposition": "landed", "reason": "", "branch": "slack-tooling", "local_sha": "e8b6fb70508861e5742d31aaa722e79f4a9a320a", "updated": "2026-07-03T19:50:30Z"} -{"sha": "73b7d1c0", "pr": 1678, "subject": "fix OpenAI Responses reasoning replay", "disposition": "deferred", "reason": "", "branch": "gateway-routing", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} -{"sha": "5f7c2f46", "pr": 1674, "subject": "fix Fireworks Gateway base URL", "disposition": "deferred", "reason": "", "branch": "gateway-routing", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} -{"sha": "702ef908", "pr": 1673, "subject": "dedicated LangSmith gateway API key", "disposition": "deferred", "reason": "", "branch": "gateway-routing", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} -{"sha": "e9dc6e01", "pr": 1671, "subject": "opt-in LangSmith LLM Gateway routing", "disposition": "deferred", "reason": "", "branch": "gateway-routing", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} +{"sha": "73b7d1c0", "pr": 1678, "subject": "fix OpenAI Responses reasoning replay", "disposition": "landed", "reason": "", "branch": "gateway-routing", "local_sha": null, "updated": "2026-07-09T16:22:05Z"} +{"sha": "5f7c2f46", "pr": 1674, "subject": "fix Fireworks Gateway base URL", "disposition": "landed", "reason": "", "branch": "gateway-routing", "local_sha": null, "updated": "2026-07-09T16:22:05Z"} +{"sha": "702ef908", "pr": 1673, "subject": "dedicated LangSmith gateway API key", "disposition": "landed", "reason": "", "branch": "gateway-routing", "local_sha": null, "updated": "2026-07-09T16:22:05Z"} +{"sha": "e9dc6e01", "pr": 1671, "subject": "opt-in LangSmith LLM Gateway routing", "disposition": "landed", "reason": "", "branch": "gateway-routing", "local_sha": null, "updated": "2026-07-09T16:22:04Z"} {"sha": "289f5e3a", "pr": 1651, "subject": "add Sonnet 5 to model picker", "disposition": "landed", "reason": "already in dev; added Bedrock family fallback fix (c16fb915)", "branch": "gateway-routing", "local_sha": null, "updated": "2026-07-03T00:19:50Z"} {"sha": "5da3d0c6", "pr": 1624, "subject": "post reviewer resolution notes verbatim", "disposition": "landed", "reason": "cherry-picked (-x) in #127", "branch": "reviewer-misc", "local_sha": null, "updated": "2026-07-08T22:58:20Z"} {"sha": "69148f54", "pr": 1612, "subject": "add PR trace resolution", "disposition": "landed", "reason": "cherry-picked (-x) in #127", "branch": "reviewer-misc", "local_sha": null, "updated": "2026-07-08T22:58:20Z"} diff --git a/docs/upstream-sync/triage.md b/docs/upstream-sync/triage.md index 72c47736..ef9267de 100644 --- a/docs/upstream-sync/triage.md +++ b/docs/upstream-sync/triage.md @@ -29,6 +29,10 @@ Rows key on the **upstream SHA** (stable across local cherry-picks). Deferred ro | `27d90ef1` | #1633 | include Slack channel context in prompts | Landed | | slack-tooling | | `92dbf6f9` | #1630 | update Slack trace reply on web handoff | Landed | ported in #128 (trace_message_ts on first-mention run mapping) | slack-tooling | | `bb36448b` | #1627 | surface Slack thread errors | Landed | | slack-tooling | +| `73b7d1c0` | #1678 | fix OpenAI Responses reasoning replay | Landed | | gateway-routing | +| `5f7c2f46` | #1674 | fix Fireworks Gateway base URL | Landed | | gateway-routing | +| `702ef908` | #1673 | dedicated LangSmith gateway API key | Landed | | gateway-routing | +| `e9dc6e01` | #1671 | opt-in LangSmith LLM Gateway routing | Landed | | gateway-routing | | `289f5e3a` | #1651 | add Sonnet 5 to model picker | Landed | already in dev; added Bedrock family fallback fix (c16fb915) | gateway-routing | | `5da3d0c6` | #1624 | post reviewer resolution notes verbatim | Landed | cherry-picked (-x) in #127 | reviewer-misc | | `69148f54` | #1612 | add PR trace resolution | Landed | cherry-picked (-x) in #127 | reviewer-misc | @@ -63,10 +67,6 @@ Rows key on the **upstream SHA** (stable across local cherry-picks). Deferred ro | `546042a4` | #1652 | add workflow approval UI | Deferred | | plan-approval | | `c03a6be7` | #1634 | keep plan guidance high-level | Deferred | | plan-approval | | `4cd5fa5c` | #1629 | avoid recapping Slack replies | Deferred | | slack-tooling | -| `73b7d1c0` | #1678 | fix OpenAI Responses reasoning replay | Deferred | | gateway-routing | -| `5f7c2f46` | #1674 | fix Fireworks Gateway base URL | Deferred | | gateway-routing | -| `702ef908` | #1673 | dedicated LangSmith gateway API key | Deferred | | gateway-routing | -| `e9dc6e01` | #1671 | opt-in LangSmith LLM Gateway routing | Deferred | | gateway-routing | | `baf0c248` | #1617 | filter & grouping menu in threads sidebar | Deferred | ~998 LOC | own branch | | `f29868ff` | #1615 | recover thread work as patch | Deferred | ~495 LOC | own branch | | `8e0788dc` | #1631 | show queued dashboard follow-ups | Deferred | | own branch | diff --git a/tests/test_gateway.py b/tests/test_gateway.py new file mode 100644 index 00000000..1c9cb980 --- /dev/null +++ b/tests/test_gateway.py @@ -0,0 +1,437 @@ +"""Unit tests for LangSmith LLM Gateway routing (agent/utils/gateway.py + make_model).""" + +from __future__ import annotations + +from typing import Any +from unittest.mock import patch + +import httpx +import pytest +from fireworks import AsyncFireworks +from langchain_core.messages import AIMessage, HumanMessage +from langchain_openai import ChatOpenAI + +from agent.utils import gateway, model + +_GATEWAY_ENV_VARS = ( + "LANGSMITH_API_KEY", + "LANGSMITH_API_KEY_PROD", + "LANGSMITH_GATEWAY_API_KEY", + "LANGSMITH_GATEWAY_ENABLED", + "LANGSMITH_GATEWAY_BASE_URL", + "LANGSMITH_GATEWAY_OPENAI_USE_RESPONSES", +) + + +@pytest.fixture(autouse=True) +def _clean_gateway_env(monkeypatch: pytest.MonkeyPatch) -> None: + """Start each test from a known env: no key, gateway off, default base URL.""" + for name in _GATEWAY_ENV_VARS: + monkeypatch.delenv(name, raising=False) + + +# --- gateway_overrides -------------------------------------------------------- + + +def test_openai_overrides_use_responses_by_default( + monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + overrides = gateway.gateway_overrides("openai:gpt-5.5") + assert overrides == { + "base_url": "https://gateway.smith.langchain.com/openai/v1", + "api_key": "ls-key", + "use_responses_api": True, + } + + +def test_openai_overrides_chat_completions_optout(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + monkeypatch.setenv("LANGSMITH_GATEWAY_OPENAI_USE_RESPONSES", "false") + overrides = gateway.gateway_overrides("openai:gpt-5.5") + assert overrides is not None + assert overrides["use_responses_api"] is False + + +async def test_openai_sdk_uses_gateway_responses_path() -> None: + requests: list[httpx.Request] = [] + + def handler(request: httpx.Request) -> httpx.Response: + requests.append(request) + return httpx.Response( + 200, + json={ + "id": "resp_test", + "object": "response", + "created_at": 0, + "status": "completed", + "model": "gpt-5.5", + "output": [ + { + "id": "msg_test", + "type": "message", + "role": "assistant", + "status": "completed", + "content": [{"type": "output_text", "text": "ok", "annotations": []}], + } + ], + "usage": {"input_tokens": 1, "output_tokens": 1, "total_tokens": 2}, + }, + ) + + http_client = httpx.AsyncClient(transport=httpx.MockTransport(handler)) + try: + chat_model = ChatOpenAI( + model="gpt-5.5", + api_key="dummy", + base_url="https://gateway.smith.langchain.com/openai/v1", + use_responses_api=True, + http_async_client=http_client, + max_retries=0, + ) + await chat_model.ainvoke([HumanMessage(content="hi")]) + finally: + await http_client.aclose() + + assert len(requests) == 1 + assert requests[0].url.path == "/openai/v1/responses" + + +def test_anthropic_overrides_have_no_responses_flag( + monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + overrides = gateway.gateway_overrides("anthropic:claude-opus-4-8") + assert overrides == { + "base_url": "https://gateway.smith.langchain.com/anthropic", + "api_key": "ls-key", + } + + +def test_fireworks_overrides(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + overrides = gateway.gateway_overrides("fireworks:accounts/fireworks/models/glm-5p2") + assert overrides is not None + assert overrides["base_url"] == "https://gateway.smith.langchain.com/fireworks" + + +async def test_fireworks_sdk_uses_allowlisted_gateway_path() -> None: + requests: list[httpx.Request] = [] + + def handler(request: httpx.Request) -> httpx.Response: + requests.append(request) + return httpx.Response( + 200, + json={ + "id": "chatcmpl-test", + "object": "chat.completion", + "created": 0, + "model": "accounts/fireworks/models/glm-5p2", + "choices": [ + { + "index": 0, + "message": {"role": "assistant", "content": "ok"}, + "finish_reason": "stop", + } + ], + "usage": {"prompt_tokens": 1, "completion_tokens": 1, "total_tokens": 2}, + }, + ) + + http_client = httpx.AsyncClient(transport=httpx.MockTransport(handler)) + try: + client = AsyncFireworks( + api_key="dummy", + base_url="https://gateway.smith.langchain.com/fireworks", + http_client=http_client, + max_retries=0, + ) + await client.chat.completions.create( + model="accounts/fireworks/models/glm-5p2", + messages=[{"role": "user", "content": "hi"}], + ) + finally: + await http_client.aclose() + + assert len(requests) == 1 + assert requests[0].url.path == "/fireworks/v1/chat/completions" + + +async def test_fireworks_gateway_strips_legacy_function_call() -> None: + """The serializer must not emit ``function_call`` after sanitization. + + Reproduces the production 400 — ``Extra inputs are not permitted, field: + 'messages[N].function_call'`` — by routing an ``AIMessage`` that carries the + legacy ``function_call`` (alongside modern ``tool_calls``) through the + Fireworks serializer toward the gateway. Without the sanitizer middleware + the request body contains ``function_call``; with it, only ``tool_calls`` + survives. + """ + import json + + from fireworks import AsyncFireworks + from langchain_fireworks.chat_models import ChatFireworks + + from agent.middleware.sanitize_fireworks_messages import _sanitize_messages + + captured_bodies: list[dict] = [] + + def handler(request: httpx.Request) -> httpx.Response: + captured_bodies.append(json.loads(request.content)) + return httpx.Response( + 200, + json={ + "id": "chatcmpl-test", + "object": "chat.completion", + "created": 0, + "model": "accounts/fireworks/models/glm-5p2", + "choices": [ + { + "index": 0, + "message": {"role": "assistant", "content": "ok"}, + "finish_reason": "stop", + } + ], + "usage": {"prompt_tokens": 1, "completion_tokens": 1, "total_tokens": 2}, + }, + ) + + http_client = httpx.AsyncClient(transport=httpx.MockTransport(handler)) + try: + chat_model = ChatFireworks( + model="accounts/fireworks/models/glm-5p2", + api_key="dummy", + base_url="https://gateway.smith.langchain.com/fireworks", + max_retries=0, + ) + # Inject a mock-transport client so no real network call is made. + mock_sdk = AsyncFireworks( + api_key="dummy", + base_url="https://gateway.smith.langchain.com/fireworks", + http_client=http_client, + max_retries=0, + ) + chat_model._async_sdk_client = mock_sdk # type: ignore[attr-defined] + chat_model.async_client = mock_sdk.chat.completions # type: ignore[attr-defined] + + ai_message = AIMessage( + content="", + tool_calls=[{"name": "read_file", "args": {"file_path": "/x"}, "id": "tc1"}], + additional_kwargs={"function_call": {"name": "read_file", "arguments": "{}"}}, + ) + messages = [HumanMessage(content="hi"), ai_message] + + # Apply the sanitizer the same way the middleware stack does. + _sanitize_messages(messages) + + await chat_model.ainvoke(messages) + await mock_sdk.close() + finally: + await http_client.aclose() + + assert len(captured_bodies) == 1 + body = captured_bodies[0] + for msg in body["messages"]: + assert "function_call" not in msg, msg + # The assistant message still carries tool_calls. + assistant_msgs = [m for m in body["messages"] if m["role"] == "assistant"] + assert assistant_msgs and "tool_calls" in assistant_msgs[0] + + +def test_google_genai_routes_to_gemini(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + overrides = gateway.gateway_overrides("google_genai:gemini-3.5-flash") + assert overrides == { + "base_url": "https://gateway.smith.langchain.com/gemini", + "api_key": "ls-key", + } + + +def test_unsupported_provider_passes_through(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + # Vertex authenticates with a service account, not a bearer key, so it isn't routed. + assert gateway.gateway_overrides("google_vertexai:gemini-2.5-pro") is None + + +def test_missing_api_key_passes_through(monkeypatch: pytest.MonkeyPatch) -> None: + assert gateway.gateway_overrides("openai:gpt-5.5") is None + + +def test_prod_key_used_as_fallback(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY_PROD", "ls-prod-key") + overrides = gateway.gateway_overrides("anthropic:claude-opus-4-8") + assert overrides is not None + assert overrides["api_key"] == "ls-prod-key" + + +def test_prod_key_preferred_over_platform_key(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-platform-key") + monkeypatch.setenv("LANGSMITH_API_KEY_PROD", "ls-prod-key") + overrides = gateway.gateway_overrides("anthropic:claude-opus-4-8") + assert overrides is not None + assert overrides["api_key"] == "ls-prod-key" + + +def test_gateway_key_preferred_over_prod_key(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-platform-key") + monkeypatch.setenv("LANGSMITH_API_KEY_PROD", "ls-prod-key") + monkeypatch.setenv("LANGSMITH_GATEWAY_API_KEY", "ls-gateway-key") + overrides = gateway.gateway_overrides("anthropic:claude-opus-4-8") + assert overrides is not None + assert overrides["api_key"] == "ls-gateway-key" + + +def test_base_url_env_override(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + monkeypatch.setenv("LANGSMITH_GATEWAY_BASE_URL", "https://gw.internal.example.com/") + overrides = gateway.gateway_overrides("anthropic:claude-opus-4-8") + assert overrides is not None + # Trailing slash is stripped, then the provider path is appended. + assert overrides["base_url"] == "https://gw.internal.example.com/anthropic" + + +# --- resolve_gateway_enabled -------------------------------------------------- + + +@pytest.mark.parametrize( + ("team_value", "env_enabled", "expected"), + [ + (True, False, True), # team True wins over env off + (False, True, False), # team False wins over env on + (None, True, True), # unset inherits env on + (None, False, False), # unset inherits env off + ], +) +def test_resolve_gateway_enabled_precedence( + monkeypatch: pytest.MonkeyPatch, + team_value: bool | None, + env_enabled: bool, + expected: bool, +) -> None: + if env_enabled: + monkeypatch.setenv("LANGSMITH_GATEWAY_ENABLED", "true") + assert gateway.resolve_gateway_enabled(team_value) is expected + + +# --- make_model integration --------------------------------------------------- + + +def _capture_init_chat_model() -> tuple[dict[str, Any], Any]: + """Patch init_chat_model to record the kwargs make_model builds.""" + captured: dict[str, Any] = {} + + def _fake(model: str, **kwargs: Any) -> str: + captured["model"] = model + captured.update(kwargs) + return "MODEL" + + return captured, _fake + + +def test_make_model_direct_openai_uses_responses_websocket() -> None: + captured, fake = _capture_init_chat_model() + with patch.object(model, "init_chat_model", fake): + model.make_model("openai:gpt-5.5", use_gateway=False) + assert captured["base_url"] == model.OPENAI_RESPONSES_WS_BASE_URL + assert captured["use_responses_api"] is True + assert captured["store"] is False + assert captured["include"] == ["reasoning.encrypted_content"] + + +def test_make_model_gateway_openai_replaces_websocket( + monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + captured, fake = _capture_init_chat_model() + with patch.object(model, "init_chat_model", fake): + model.make_model("openai:gpt-5.5", use_gateway=True) + assert captured["base_url"] == "https://gateway.smith.langchain.com/openai/v1" + assert captured["use_responses_api"] is True + assert captured["store"] is False + assert captured["include"] == ["reasoning.encrypted_content"] + assert captured["api_key"] == "ls-key" + + +def test_make_model_gateway_openai_chat_completions_optout_converts_reasoning( + monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + monkeypatch.setenv("LANGSMITH_GATEWAY_OPENAI_USE_RESPONSES", "false") + captured, fake = _capture_init_chat_model() + with patch.object(model, "init_chat_model", fake): + model.make_model( + "openai:gpt-5.5", + use_gateway=True, + reasoning={"effort": "high", "summary": "auto"}, + ) + assert captured["use_responses_api"] is False + assert captured["reasoning_effort"] == "high" + assert "reasoning" not in captured + assert "include" not in captured + assert "store" not in captured + + +def test_make_model_gateway_openai_preserves_reasoning_none( + monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + captured, fake = _capture_init_chat_model() + with patch.object(model, "init_chat_model", fake): + model.make_model( + "openai:gpt-5.5", + use_gateway=True, + reasoning={"effort": "none"}, + ) + assert captured["use_responses_api"] is True + assert captured["store"] is False + assert captured["include"] == ["reasoning.encrypted_content"] + assert captured["reasoning"] == {"effort": "none"} + assert "reasoning_effort" not in captured + + +def test_make_model_gateway_openai_responses_keeps_reasoning( + monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + reasoning = {"effort": "high", "summary": "auto"} + captured, fake = _capture_init_chat_model() + with patch.object(model, "init_chat_model", fake): + model.make_model("openai:gpt-5.5", use_gateway=True, reasoning=reasoning) + assert captured["use_responses_api"] is True + assert captured["store"] is False + assert captured["include"] == ["reasoning.encrypted_content"] + assert captured["reasoning"] == reasoning + assert "reasoning_effort" not in captured + + +def test_make_model_gateway_follows_env_default(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + monkeypatch.setenv("LANGSMITH_GATEWAY_ENABLED", "true") + captured, fake = _capture_init_chat_model() + with patch.object(model, "init_chat_model", fake): + model.make_model("anthropic:claude-opus-4-8") # use_gateway=None -> env default + assert captured["base_url"] == "https://gateway.smith.langchain.com/anthropic" + assert captured["api_key"] == "ls-key" + + +def test_make_model_gateway_google_genai(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("LANGSMITH_API_KEY", "ls-key") + captured, fake = _capture_init_chat_model() + with patch.object(model, "init_chat_model", fake): + model.make_model("google_genai:gemini-3.5-flash", use_gateway=True) + assert captured["base_url"] == "https://gateway.smith.langchain.com/gemini" + assert captured["api_key"] == "ls-key" + + +def test_make_model_gateway_without_key_falls_back_direct( + monkeypatch: pytest.MonkeyPatch, +) -> None: + captured, fake = _capture_init_chat_model() + with patch.object(model, "init_chat_model", fake): + model.make_model("openai:gpt-5.5", use_gateway=True) # no LangSmith key + # No key -> overrides skipped -> the direct-provider websocket base stands. + assert captured["base_url"] == model.OPENAI_RESPONSES_WS_BASE_URL + assert captured["use_responses_api"] is True + assert captured["store"] is False + assert captured["include"] == ["reasoning.encrypted_content"] + assert "api_key" not in captured diff --git a/tests/test_sanitize_fireworks_messages.py b/tests/test_sanitize_fireworks_messages.py new file mode 100644 index 00000000..9f0fb68e --- /dev/null +++ b/tests/test_sanitize_fireworks_messages.py @@ -0,0 +1,118 @@ +from __future__ import annotations + +from unittest.mock import MagicMock + +import pytest +from langchain_core.messages import AIMessage, HumanMessage, ToolMessage + +from agent.middleware.sanitize_fireworks_messages import SanitizeFireworksMessagesMiddleware + + +def _make_request(messages: list[object], model: object | None = None) -> MagicMock: + request = MagicMock() + request.model = model + request.messages = messages + return request + + +def _fireworks_model() -> MagicMock: + """A mock that satisfies ``_is_chat_fireworks`` via spec'd ``ChatFireworks``.""" + try: + from langchain_fireworks.chat_models import ChatFireworks + except ImportError: # pragma: no cover + pytest.skip("langchain-fireworks not installed") + return MagicMock(spec=ChatFireworks) + + +class TestSanitizeFireworksMessagesMiddleware: + def test_drops_legacy_function_call(self) -> None: + message = AIMessage( + content="", + tool_calls=[{"name": "read_file", "args": {"file_path": "/x"}, "id": "tc1"}], + additional_kwargs={"function_call": {"name": "read_file", "arguments": "{}"}}, + ) + request = _make_request([message], model=_fireworks_model()) + response = MagicMock() + + def handler(req: object) -> object: + assert req is request + return response + + result = SanitizeFireworksMessagesMiddleware().wrap_model_call(request, handler) + + assert result is response + assert "function_call" not in message.additional_kwargs + # tool_calls are untouched + assert len(message.tool_calls) == 1 + + def test_preserves_message_without_function_call(self) -> None: + message = AIMessage( + content="ok", + tool_calls=[{"name": "read_file", "args": {"file_path": "/x"}, "id": "tc1"}], + ) + request = _make_request([message], model=_fireworks_model()) + + SanitizeFireworksMessagesMiddleware().wrap_model_call(request, lambda req: MagicMock()) + + assert "function_call" not in message.additional_kwargs + assert len(message.tool_calls) == 1 + + def test_drops_function_call_with_no_tool_calls(self) -> None: + message = AIMessage( + content="", + additional_kwargs={"function_call": {"name": "search", "arguments": "{}"}}, + ) + request = _make_request([message], model=_fireworks_model()) + + SanitizeFireworksMessagesMiddleware().wrap_model_call(request, lambda req: MagicMock()) + + assert "function_call" not in message.additional_kwargs + + @pytest.mark.asyncio + async def test_async_drops_legacy_function_call(self) -> None: + tool_result = ToolMessage(content="result", tool_call_id="tc1") + message = AIMessage( + content="", + tool_calls=[{"name": "read_file", "args": {"file_path": "/x"}, "id": "tc1"}], + additional_kwargs={"function_call": {"name": "read_file", "arguments": "{}"}}, + ) + request = _make_request( + [HumanMessage(content="hi"), message, tool_result], + model=_fireworks_model(), + ) + response = MagicMock() + + async def handler(req: object) -> object: + assert req is request + return response + + result = await SanitizeFireworksMessagesMiddleware().awrap_model_call(request, handler) + + assert result is response + assert "function_call" not in message.additional_kwargs + + def test_ignores_non_fireworks_models(self) -> None: + message = AIMessage( + content="", + tool_calls=[{"name": "read_file", "args": {"file_path": "/x"}, "id": "tc1"}], + additional_kwargs={"function_call": {"name": "read_file", "arguments": "{}"}}, + ) + # Non-Fireworks model (plain MagicMock, no ChatFireworks in its spec chain) + request = _make_request([message], model=MagicMock()) + + SanitizeFireworksMessagesMiddleware().wrap_model_call(request, lambda req: MagicMock()) + + # function_call preserved for non-Fireworks providers + assert "function_call" in message.additional_kwargs + + def test_skips_non_ai_messages(self) -> None: + messages = [ + HumanMessage(content="hi"), + ToolMessage(content="result", tool_call_id="tc1"), + ] + request = _make_request(messages, model=_fireworks_model()) + + SanitizeFireworksMessagesMiddleware().wrap_model_call(request, lambda req: MagicMock()) + + # No AIMessages to mutate — handler still called + assert all(not isinstance(m, AIMessage) for m in messages) diff --git a/tests/test_sanitize_openai_responses.py b/tests/test_sanitize_openai_responses.py new file mode 100644 index 00000000..6185431c --- /dev/null +++ b/tests/test_sanitize_openai_responses.py @@ -0,0 +1,55 @@ +from langchain_core.messages import AIMessage, HumanMessage + +from agent.middleware.sanitize_openai_responses import _sanitize_messages + + +def test_sanitize_messages_drops_stale_reasoning_references() -> None: + messages = [ + HumanMessage(content="review this"), + AIMessage( + content=[ + { + "type": "reasoning", + "id": "rs_123", + "summary": [], + "content": [], + }, + { + "type": "function_call", + "id": "fc_123", + "call_id": "call_123", + "name": "read_file", + "arguments": "{}", + }, + ], + tool_calls=[ + { + "name": "read_file", + "args": {}, + "id": "call_123", + } + ], + ), + ] + + _sanitize_messages(messages) + + content = messages[1].content + assert isinstance(content, list) + assert [block["type"] for block in content] == ["function_call"] + assert messages[1].tool_calls[0]["id"] == "call_123" + + +def test_sanitize_messages_preserves_encrypted_reasoning() -> None: + reasoning = { + "type": "reasoning", + "id": "rs_123", + "encrypted_content": "encrypted", + "summary": [], + "content": [], + } + messages = [AIMessage(content=[reasoning])] + + _sanitize_messages(messages) + + assert messages[0].content == [reasoning] diff --git a/ui/src/lib/api.ts b/ui/src/lib/api.ts index e9fd7705..569f7abe 100644 --- a/ui/src/lib/api.ts +++ b/ui/src/lib/api.ts @@ -164,6 +164,8 @@ export interface TeamSettings { review_draft_prs: boolean pr_summaries: boolean review_trace_links: boolean + /** Tri-state LLM Gateway toggle; null inherits the LANGSMITH_GATEWAY_ENABLED default. */ + gateway_enabled?: boolean | null review_tracing_project?: string | null org_guidelines?: string | null default_agent_model?: string | null diff --git a/ui/src/routes/admin.tsx b/ui/src/routes/admin.tsx index 69b99d13..7ec9b2b4 100644 --- a/ui/src/routes/admin.tsx +++ b/ui/src/routes/admin.tsx @@ -55,6 +55,8 @@ function AdminPage() { > + + @@ -552,6 +554,77 @@ function ObservabilityCredentialsSection() { ) } +type GatewayMode = "inherit" | "enabled" | "disabled" + +function gatewayMode(value: boolean | null | undefined): GatewayMode { + if (value === true) return "enabled" + if (value === false) return "disabled" + return "inherit" +} + +function gatewayModeValue(mode: GatewayMode): boolean | null { + if (mode === "enabled") return true + if (mode === "disabled") return false + return null +} + +function LLMGatewaySection() { + const qc = useQueryClient() + const settings = useQuery({ + queryKey: ["teamSettings"], + queryFn: api.getTeamSettings, + }) + const [error, setError] = useState(null) + + const save = useMutation({ + mutationFn: (body: TeamSettings) => api.saveTeamSettings(body), + onSuccess: (saved) => { + qc.setQueryData(["teamSettings"], saved) + setError(null) + }, + onError: (e: Error) => setError(e.message), + }) + + const mode = gatewayMode(settings.data?.gateway_enabled) + + return ( + +
+ + settings.data && + save.mutate({ + ...settings.data, + gateway_enabled: gatewayModeValue(next as GatewayMode), + }) + } + disabled={!settings.data || save.isPending} + > + + + + + Inherit deployment default + Enabled + Disabled + + + } + /> +
+ {error &&

{error}

} +
+ ) +} + function PRTraceResolutionSection() { const qc = useQueryClient() const settings = useQuery({ From f87847baa4f46d7cca53a5ad29ba589e6900edb0 Mon Sep 17 00:00:00 2001 From: "seahaven-openswe[bot]" <296972425+seahaven-openswe[bot]@users.noreply.github.com> Date: Thu, 9 Jul 2026 16:03:13 -0400 Subject: [PATCH 2/2] feat: port plan-review & workflow-approval UX (#159) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: port plan-review & workflow-approval UX (#135) Port six upstream commits onto dev: - c03a6be7 (already ported): keep plan guidance high-level - 546042a4: add workflow approval UI with diff preview, approval URLs, web review links, and polling for approval status during active runs - 216cf181: remove workflow token elevation; approved pushes pass through directly without proxy token rewriting - 3dbc0282: preserve plan redirects after login by accepting relative same-origin redirect_to values and rejecting blocked paths - bb104d93: submit plan comments with cmd+enter - 90cb6caa: terse Slack replies, shared content via save_plan outside plan mode (PLAN_STATUS_SHARED), reject shared-content mutations Refs: #135 * fix: restore login page render and clear CI lint/format The plan-review port removed the authRedirectUrl import from login.tsx but left its call site, crashing the login page at runtime (blank page, no 'Sign in to open-swe'). Pass the relative path straight to loginUrl, matching the plan route and the backend relative-redirect handling. Also drop an unused os import in the guard test and reformat workflow_push_guard.py to satisfy ruff. * fix: carry workflows:write on the standing proxy token Complete the half-ported upstream 216cf181 cascade. The port dropped _run_with_workflow_token from the guard but missed the paired github_app change, so an approved .github/workflows push ran with the base token (no workflows:write) and GitHub 403'd it. Add workflows:write to BASE_RUNTIME_PROXY_TOKEN_PERMISSIONS and delete the now-orphaned WORKFLOW_RUNTIME_PROXY_TOKEN_PERMISSIONS constant; update the github_app and proxy_auth tests to match. The HITL approval gate in workflow_push_guard.py is unchanged — this only lets the standing token push once a human approves. * fix: restore transient workflow-token elevation (revert standing workflows:write) The standing GitHub-App proxy token (BASE_RUNTIME_PROXY_TOKEN_PERMISSIONS) is ALWAYS-ON, so carrying workflows:write on it made the fork's HITL workflow-push guard the sole control over unapproved workflow pushes. The guard's git-push parser has gaps (obfuscated-expansion push, `gh api` REST contents PUT, fully-qualified cross-branch refspecs); with a permanently workflows-scoped token those gaps become live unapproved-workflow-push exploits (1 critical, 2 high — security review BLOCK on #159). Restore dev's transient-elevation model: - Drop workflows:write from BASE_RUNTIME_PROXY_TOKEN_PERMISSIONS; re-add the WORKFLOW_RUNTIME_PROXY_TOKEN_PERMISSIONS constant (base + workflows:write). - Re-introduce _run_with_workflow_token in the guard: it mints the workflows-scoped token via refresh_proxy_token around the approved, guard-normalized fixed_command, then downscopes to RUNTIME then BASE in a finally. Route the approval branch through it. - Restore the dev token/elevation tests. The standing token no longer carries workflows:write, so the three parser bypasses hit GitHub 403 again; an approved push still succeeds because the elevation grants workflows:write only around the normalized command. Keeps all of #159's diff-preview / approval-URL / Slack-card guard additions. * fix: reject protocol-relative path from sanitizeAuthRedirect (open redirect) sanitizeAuthRedirect returned parsed.pathname+search+hash, which `new URL` can resolve to a protocol-relative `//host` (e.g. input `/..//evil.com` normalizes same-origin, passing the origin check, but yields a path starting with `//`). ClientRedirect / login.tsx feed that path to window.location.replace, so it navigates cross-origin — an open redirect. Reject any resolved path that is not a single-leading-slash path (`^/[^/]`), falling back to the default. Adds coverage for `/..//evil.com`, `/.//evil.com`, and `//evil.com`. * fix: log SECURITY error when workflow-token downscope fails The elevate->push->downscope finally block was silent on failure. If both refresh_proxy_token calls fail, the sandbox retains workflows:write for the rest of the run with no signal. Log a SECURITY error on the partial and full downscope-failure paths so the retention is observable. Addresses the GPT-4.1 cross-family review of the token-scope remediation. --------- Co-authored-by: amoussa1229 <166072409+amoussa1229@users.noreply.github.com> Co-authored-by: Adam Moussa --- agent/dashboard/oauth.py | 31 +- agent/dashboard/plan_api.py | 21 +- agent/dashboard/plan_store.py | 21 +- agent/dashboard/workflow_approval.py | 84 ++++- agent/dashboard/workflow_approval_api.py | 33 +- agent/middleware/workflow_push_guard.py | 125 +++++++- agent/prompt.py | 5 +- agent/tools/save_plan.py | 59 ++-- agent/utils/dashboard_links.py | 8 + docs/upstream-sync/triage.jsonl | 12 +- docs/upstream-sync/triage.md | 12 +- tests/test_plan_review.py | 16 +- ui/src/components/agents/AgentThreadView.tsx | 64 +--- ui/src/components/agents/PlanReview.tsx | 36 ++- .../agents/WorkflowApprovalCard.tsx | 287 ++++++++++-------- ui/src/lib/agents/api.ts | 44 ++- ui/src/lib/agents/queries.ts | 75 ++--- ui/src/lib/api.ts | 5 +- ui/src/lib/auth-redirect-core.ts | 7 +- ui/src/lib/auth-redirect.test.ts | 8 + ui/src/lib/plan.ts | 6 +- ui/src/routes/agents/$threadId_.plan.tsx | 4 +- ui/src/routes/login.tsx | 3 +- 23 files changed, 619 insertions(+), 347 deletions(-) diff --git a/agent/dashboard/oauth.py b/agent/dashboard/oauth.py index ec434b31..2cd5e953 100644 --- a/agent/dashboard/oauth.py +++ b/agent/dashboard/oauth.py @@ -80,21 +80,36 @@ def _origin_of(url: str) -> str: return f"{scheme}://{host}:{port}" -def sanitize_redirect_to(redirect_to: str | None) -> str: - """Return a safe post-login redirect URL. +def _is_blocked_redirect_path(path: str) -> bool: + return path in {"/login", "/dashboard/api", "/_serverFn"} or path.startswith( + ("/login/", "/login?", "/login#", "/dashboard/api/", "/_serverFn/") + ) - Falls back to DASHBOARD_BASE_URL when the supplied URL's origin isn't - explicitly allowed. This blocks the open-redirect / phishing primitive - where an attacker drops their own URL into `?redirect_to=`. - """ + +def sanitize_redirect_to(redirect_to: str | None) -> str: + """Return a safe post-login redirect URL.""" fallback = os.environ.get("DASHBOARD_BASE_URL", "").strip() if not redirect_to: return fallback - candidate_origin = _origin_of(redirect_to) + trimmed = redirect_to.strip() + parsed = urlparse(trimmed) + if ( + trimmed.startswith("/") + and not trimmed.startswith("//") + and not parsed.scheme + and not parsed.netloc + and not _is_blocked_redirect_path(parsed.path) + ): + if fallback: + return f"{fallback.rstrip('/')}{trimmed}" + return trimmed + if _is_blocked_redirect_path(parsed.path): + return fallback + candidate_origin = _origin_of(trimmed) if not candidate_origin: return fallback if candidate_origin in allowed_dashboard_origins(): - return redirect_to + return trimmed logger.warning("Rejected redirect_to=%r — origin not in allowlist", redirect_to) return fallback diff --git a/agent/dashboard/plan_api.py b/agent/dashboard/plan_api.py index c5a9c2e4..991bef09 100644 --- a/agent/dashboard/plan_api.py +++ b/agent/dashboard/plan_api.py @@ -29,6 +29,7 @@ from .plan_store import ( PLAN_STATUS_CANCELLED, PLAN_STATUS_READY, PLAN_STATUS_REVISING, + PLAN_STATUS_SHARED, add_plan_comment, delete_plan_comment, get_plan_content, @@ -112,6 +113,7 @@ async def update_plan( if not markdown: raise HTTPException(422, "plan markdown cannot be empty") content = await get_plan_content(thread_id) or {} + _reject_shared_content(content) status = content.get("status") or metadata.get("plan_status") or "planning" if status in (PLAN_STATUS_APPROVED, PLAN_STATUS_CANCELLED): raise HTTPException(409, f"cannot edit a {status} plan") @@ -139,6 +141,7 @@ async def post_plan_comment( metadata = await _thread_metadata(thread_id) if not _thread_is_readable(metadata): raise HTTPException(404, "thread not found") + _reject_shared_content(await get_plan_content(thread_id) or {}) text = body.body.strip() if not text: raise HTTPException(422, "comment body cannot be empty") @@ -155,6 +158,7 @@ async def remove_plan_comment( metadata = await _thread_metadata(thread_id) if not _thread_is_readable(metadata): raise HTTPException(404, "thread not found") + _reject_shared_content(await get_plan_content(thread_id) or {}) comments = await list_plan_comments(thread_id) target = next((c for c in comments if c.get("id") == comment_id), None) if target is None: @@ -175,14 +179,16 @@ async def approve_plan(thread_id: str, session: dict[str, Any] = _SESSION_DEP) - # Read the published plan + comments BEFORE mutating state: a store failure # here aborts the decision (500) rather than dispatching without them. The # published markdown may have been edited by the owner, so it is the - # source of truth handed to the agent (not its own stale history). - content = await get_plan_content(thread_id, raise_on_error=True) - status = (content or {}).get("status") or metadata.get("plan_status") or "planning" + # source of truth handed to the agent (not its own stale history) — read it + # strictly so a transient failure can't silently drop the edit. + content = await get_plan_content(thread_id, raise_on_error=True) or {} + _reject_shared_content(content) + status = content.get("status") or metadata.get("plan_status") or "planning" if status == PLAN_STATUS_APPROVED: # Idempotent: a repeat approve (double-click / retry) must not dispatch a # second implementation run or post a duplicate Slack notice. raise HTTPException(409, "plan is already approved") - plan_markdown = (content or {}).get("markdown", "") + plan_markdown = str(content.get("markdown", "")).strip() comments = await list_plan_comments(thread_id, raise_on_error=True) feedback = _format_comments(comments) if plan_markdown: @@ -215,6 +221,8 @@ async def reject_plan(thread_id: str, session: dict[str, Any] = _SESSION_DEP) -> metadata = await _thread_metadata(thread_id) if not _thread_is_readable(metadata): raise HTTPException(404, "thread not found") + content = await get_plan_content(thread_id, raise_on_error=True) or {} + _reject_shared_content(content) feedback = _format_comments(await list_plan_comments(thread_id, raise_on_error=True)) await set_plan_status(thread_id, PLAN_STATUS_REVISING, plan_mode=True) text = ( @@ -227,6 +235,11 @@ async def reject_plan(thread_id: str, session: dict[str, Any] = _SESSION_DEP) -> return {"status": PLAN_STATUS_REVISING} +def _reject_shared_content(content: dict[str, Any]) -> None: + if content.get("status") == PLAN_STATUS_SHARED: + raise HTTPException(409, "shared content is not an implementation plan") + + def _format_comments(comments: list[dict[str, Any]]) -> str: lines: list[str] = [] index = 1 diff --git a/agent/dashboard/plan_store.py b/agent/dashboard/plan_store.py index 9ceef9c6..512de7a3 100644 --- a/agent/dashboard/plan_store.py +++ b/agent/dashboard/plan_store.py @@ -27,9 +27,10 @@ PLAN_COMMENTS_NAMESPACE = ["plan", "comments"] # Plans are mirrored into the sandbox outside cloned repositories. PLAN_FILE_DIRECTORY = "/workspace/plans" -# Plan lifecycle, stored on both the content record and the thread metadata. +# Plan/share lifecycle, stored on both the content record and the thread metadata. PLAN_STATUS_PLANNING = "planning" PLAN_STATUS_READY = "ready" +PLAN_STATUS_SHARED = "shared" PLAN_STATUS_REVISING = "revising" PLAN_STATUS_APPROVED = "approved" PLAN_STATUS_CANCELLED = "cancelled" @@ -68,8 +69,9 @@ async def save_plan_content( status: str = PLAN_STATUS_READY, clear_comments: bool = True, plan_file_path: str | None = None, + plan_mode: bool | None = True, ) -> None: - """Publish the plan markdown + status for the dashboard to render. + """Publish markdown + status for the dashboard to render. A republished (revised) plan supersedes the prior revision, so comments left on it are cleared — otherwise stale feedback would resurface on the new plan @@ -92,7 +94,10 @@ async def save_plan_content( except Exception: # Best-effort: a failed cleanup must not block publishing the new plan. pass - await _merge_thread_metadata(thread_id, {"plan_status": status, "plan_mode": True}) + metadata: dict[str, Any] = {"plan_status": status} + if plan_mode is not None: + metadata["plan_mode"] = plan_mode + await _merge_thread_metadata(thread_id, metadata) async def write_plan_to_sandbox( @@ -136,10 +141,16 @@ async def get_plan_content( async def set_plan_status(thread_id: str, status: str, *, plan_mode: bool | None = None) -> None: """Update the plan lifecycle status on both the content record and metadata.""" existing = await get_plan_content(thread_id) or {} + entering_plan_after_share = ( + existing.get("status") == PLAN_STATUS_SHARED and status == PLAN_STATUS_PLANNING + ) client = _client() - record: dict[str, Any] = {"markdown": existing.get("markdown", ""), "status": status} + record: dict[str, Any] = { + "markdown": "" if entering_plan_after_share else existing.get("markdown", ""), + "status": status, + } plan_file_path = existing.get("plan_file_path") - if isinstance(plan_file_path, str) and plan_file_path: + if not entering_plan_after_share and isinstance(plan_file_path, str) and plan_file_path: record["plan_file_path"] = plan_file_path await client.store.put_item( PLAN_CONTENT_NAMESPACE, diff --git a/agent/dashboard/workflow_approval.py b/agent/dashboard/workflow_approval.py index 0db6e22c..fbc23b74 100644 --- a/agent/dashboard/workflow_approval.py +++ b/agent/dashboard/workflow_approval.py @@ -13,6 +13,7 @@ WORKFLOW_APPROVAL_PENDING = "pending" WORKFLOW_APPROVAL_APPROVED = "approved" WORKFLOW_APPROVAL_REJECTED = "rejected" _MAX_APPROVAL_RECORDS = 20 +_TERMINAL_STATUSES = {WORKFLOW_APPROVAL_APPROVED, WORKFLOW_APPROVAL_REJECTED} def _now() -> str: @@ -80,25 +81,38 @@ async def ensure_workflow_push_pending( base_sha: str, head_sha: str, files: list[str], + diff_stats: Mapping[str, Any] | None = None, + diff_preview: str | None = None, + diff_preview_truncated: bool = False, + approval_url: str | None = None, ) -> tuple[dict[str, Any], bool]: """Store a pending approval unless a terminal record already exists.""" approvals = await get_workflow_push_approvals(thread_id) existing = approvals.get(fingerprint) - if existing and existing.get("status") in { - WORKFLOW_APPROVAL_PENDING, - WORKFLOW_APPROVAL_APPROVED, - WORKFLOW_APPROVAL_REJECTED, - }: + if existing and existing.get("status") in _TERMINAL_STATUSES: return existing, False - record = { - "fingerprint": fingerprint, - "status": WORKFLOW_APPROVAL_PENDING, + review_fields = { "repo": repo, "branch": branch, "base_sha": base_sha, "head_sha": head_sha, - "files": files, + "files": list(files), + "diff_stats": _normalize_diff_stats(diff_stats, len(files)), + "diff_preview": diff_preview or "", + "diff_preview_truncated": diff_preview_truncated, + "approval_url": approval_url, + } + if existing and existing.get("status") == WORKFLOW_APPROVAL_PENDING: + record = {**existing, **review_fields} + approvals[fingerprint] = record + await _save_approvals(thread_id, approvals) + return record, False + + record = { + "fingerprint": fingerprint, + "status": WORKFLOW_APPROVAL_PENDING, + **review_fields, "requested_at": _now(), "notified": False, } @@ -107,6 +121,58 @@ async def ensure_workflow_push_pending( return record, True +def _safe_int(value: Any, default: int = 0) -> int: + try: + return max(0, int(value)) + except (TypeError, ValueError): + return default + + +def _normalize_diff_stats(value: Mapping[str, Any] | None, file_count: int) -> dict[str, int]: + if not isinstance(value, Mapping): + return {"files": file_count, "additions": 0, "deletions": 0} + return { + "files": _safe_int(value.get("files"), file_count), + "additions": _safe_int(value.get("additions")), + "deletions": _safe_int(value.get("deletions")), + } + + +def workflow_push_approval_response(record: Mapping[str, Any]) -> dict[str, Any]: + files = record.get("files") + diff_stats = record.get("diff_stats") + requested_at = record.get("requested_at") + decided_at = record.get("decided_at") + decided_by = record.get("decided_by") + approval_url = record.get("approval_url") + return { + "fingerprint": str(record.get("fingerprint") or ""), + "status": str(record.get("status") or WORKFLOW_APPROVAL_PENDING), + "repo": str(record.get("repo") or ""), + "branch": str(record.get("branch") or ""), + "baseSha": str(record.get("base_sha") or ""), + "headSha": str(record.get("head_sha") or ""), + "files": [str(path) for path in files] if isinstance(files, list) else [], + "diffStats": _normalize_diff_stats( + diff_stats if isinstance(diff_stats, Mapping) else None, + len(files) if isinstance(files, list) else 0, + ), + "diffPreview": str(record.get("diff_preview") or ""), + "diffPreviewTruncated": record.get("diff_preview_truncated") is True, + "approvalUrl": approval_url if isinstance(approval_url, str) and approval_url else None, + "requestedAt": requested_at if isinstance(requested_at, str) else None, + "decidedAt": decided_at if isinstance(decided_at, str) else None, + "decidedBy": decided_by if isinstance(decided_by, str) else None, + } + + +def workflow_push_approval_responses( + approvals: Mapping[str, Mapping[str, Any]], +) -> list[dict[str, Any]]: + ordered = sorted(approvals.values(), key=lambda r: str(r.get("requested_at", "")), reverse=True) + return [workflow_push_approval_response(record) for record in ordered] + + async def mark_workflow_push_notified(thread_id: str, fingerprint: str) -> None: approvals = await get_workflow_push_approvals(thread_id) record = approvals.get(fingerprint) diff --git a/agent/dashboard/workflow_approval_api.py b/agent/dashboard/workflow_approval_api.py index 40396226..4d1b5f11 100644 --- a/agent/dashboard/workflow_approval_api.py +++ b/agent/dashboard/workflow_approval_api.py @@ -8,11 +8,11 @@ from fastapi import APIRouter, Depends, HTTPException from .oauth import require_same_origin_for_mutations, require_session from .plan_api import _dispatch_followup, _thread_metadata -from .thread_api import _user_owns_thread +from .thread_api import _thread_is_readable, _user_owns_thread from .workflow_approval import ( - WORKFLOW_APPROVAL_PENDING, decide_workflow_push_approval, get_workflow_push_approvals, + workflow_push_approval_responses, ) workflow_approval_router = APIRouter( @@ -23,31 +23,20 @@ workflow_approval_router = APIRouter( _SESSION_DEP = Depends(require_session) -def _approval_record_response(record: dict[str, Any]) -> dict[str, Any]: - return { - "fingerprint": record.get("fingerprint"), - "status": record.get("status"), - "repo": record.get("repo"), - "branch": record.get("branch"), - "files": record.get("files"), - "requested_at": record.get("requested_at"), - } - - @workflow_approval_router.get("/{thread_id}") -async def list_workflow_approvals_for_thread( +async def list_workflow_push_approvals( thread_id: str, session: dict[str, Any] = _SESSION_DEP ) -> dict[str, Any]: metadata = await _thread_metadata(thread_id) - if not _user_owns_thread(metadata, session["sub"], session.get("email")): - raise HTTPException(403, "only the thread owner can view workflow push approvals") + if not _thread_is_readable(metadata): + raise HTTPException(404, "thread not found") + is_owner = _user_owns_thread(metadata, session["sub"], session.get("email")) approvals = await get_workflow_push_approvals(thread_id) - pending = [ - _approval_record_response(record) - for record in approvals.values() - if record.get("status") == WORKFLOW_APPROVAL_PENDING - ] - return {"approvals": pending} + return { + "threadId": thread_id, + "isOwner": is_owner, + "approvals": workflow_push_approval_responses(approvals), + } @workflow_approval_router.post("/{thread_id}/{fingerprint}/approve") diff --git a/agent/middleware/workflow_push_guard.py b/agent/middleware/workflow_push_guard.py index e5994d9a..c0124b83 100644 --- a/agent/middleware/workflow_push_guard.py +++ b/agent/middleware/workflow_push_guard.py @@ -29,6 +29,7 @@ from ..dashboard.workflow_approval import ( workflow_push_rejected, ) from ..tools.slack_thread_reply import build_workflow_approval_blocks +from ..utils.dashboard_links import dashboard_workflow_approval_url from ..utils.github_app import ( BASE_RUNTIME_PROXY_TOKEN_PERMISSIONS, RUNTIME_PROXY_TOKEN_PERMISSIONS, @@ -58,6 +59,8 @@ _GIT_WRAPPERS = {"command", "env", "nice", "sudo", "stdbuf", "nohup", "time", "i # Git global options that consume the following token as a separate value; skipped when # locating the git subcommand so `git -c k=v push` is still recognized as a push. _GIT_VALUE_OPTIONS = {"-C", "-c", "--namespace", "--git-dir", "--work-tree", "--exec-path"} +_DIFF_PREVIEW_MAX_CHARS = 20_000 +_DIFF_PREVIEW_MAX_LINES = 400 class _BlockedGitPush: @@ -90,6 +93,9 @@ class WorkflowPushChange: remote_ref: str fixed_command: str base_sha: str = "" + diff_stats: dict[str, int] | None = None + diff_preview: str = "" + diff_preview_truncated: bool = False blocked: bool = False blocked_reason: str = "" @@ -445,6 +451,44 @@ def _fingerprint(payload: Mapping[str, Any]) -> str: return hashlib.sha256(encoded).hexdigest() +def _diff_preview(diff: str) -> tuple[str, bool]: + if len(diff) <= _DIFF_PREVIEW_MAX_CHARS: + lines = diff.splitlines() + if len(lines) <= _DIFF_PREVIEW_MAX_LINES: + return diff, False + preview_lines: list[str] = [] + char_count = 0 + truncated = False + for line in diff.splitlines(): + next_count = char_count + len(line) + 1 + if len(preview_lines) >= _DIFF_PREVIEW_MAX_LINES or next_count > _DIFF_PREVIEW_MAX_CHARS: + truncated = True + break + preview_lines.append(line) + char_count = next_count + return "\n".join(preview_lines), truncated + + +def _diff_stats(files: list[str], numstat: str) -> dict[str, int]: + additions = 0 + deletions = 0 + for line in numstat.splitlines(): + parts = line.split("\t") + if len(parts) < 3: + continue + if parts[0].isdigit(): + additions += int(parts[0]) + if parts[1].isdigit(): + deletions += int(parts[1]) + return {"files": len(files), "additions": additions, "deletions": deletions} + + +def _approval_url(thread_id: str | None, fingerprint: str) -> str | None: + if not thread_id: + return None + return dashboard_workflow_approval_url(thread_id, fingerprint) + + def _run_coroutine_sync(coro: Awaitable[ToolMessage | Command]) -> ToolMessage | Command: try: asyncio.get_running_loop() @@ -614,6 +658,29 @@ def _workflow_change_for_push(backend: Any, parsed: ParsedGitPush) -> WorkflowPu fixed_args.append("--set-upstream") fixed_args.extend([parsed.remote, fixed_refspec]) fixed_command = _git_command(root, " ".join(shlex.quote(arg) for arg in fixed_args)) + + # Fetch diff preview for the workflow approval card. + diff_range = f"{shlex.quote(base_ref)}...{shlex.quote(head)}" if base_ref else shlex.quote(head) + diff = _run_git(backend, root, f"diff --binary --full-index {diff_range} -- .github/workflows") + numstat = None + diff_preview = "" + diff_preview_truncated = False + diff_stats_val: dict[str, int] = {"files": len(files), "additions": 0, "deletions": 0} + base_sha_actual = base_ref if base_ref else "" + if diff.ok and diff.output: + diff_preview, diff_preview_truncated = _diff_preview(diff.output) + numstat = _run_git(backend, root, f"diff --numstat {diff_range} -- .github/workflows") + if numstat.ok: + diff_stats_val = _diff_stats(files, numstat.output) + elif base_ref and not diff.ok: + diff_only_head = _run_git( + backend, + root, + f"diff --binary --full-index --root {shlex.quote(head)} -- .github/workflows", + ) + if diff_only_head.ok and diff_only_head.output: + diff_preview, diff_preview_truncated = _diff_preview(diff_only_head.output) + content_payload = { "repo": repo, "branch": branch_name, @@ -626,16 +693,21 @@ def _workflow_change_for_push(backend: Any, parsed: ParsedGitPush) -> WorkflowPu branch=branch_name, files=files, head_sha=head, + base_sha=base_sha_actual, remote=parsed.remote, local_ref=parsed.local_ref, remote_ref=parsed.remote_ref, fixed_command=fixed_command, + diff_stats=diff_stats_val, + diff_preview=diff_preview, + diff_preview_truncated=diff_preview_truncated, ) def _blocked_message( change: WorkflowPushChange, *, + approval_url: str | None = None, already_rejected: bool = False, stale: bool = False, blocked: bool = False, @@ -657,7 +729,7 @@ def _blocked_message( error = ( "This git push includes GitHub workflow file changes and requires human " "approval before Open SWE can push it. Retry the same standalone git push " - "after the thread owner approves the workflow files." + "after the thread owner approves the workflow diff in Slack or the web UI." ) error_type = "WorkflowPushApprovalRequired" content = { @@ -669,6 +741,11 @@ def _blocked_message( "files": change.files, "repo": change.repo, "branch": change.branch, + "base_sha": change.base_sha, + "head_sha": change.head_sha, + "diff_stats": change.diff_stats, + "diff_preview_truncated": change.diff_preview_truncated, + "approval_url": approval_url, } return ToolMessage(content=json.dumps(content), tool_call_id="", status="error") @@ -687,20 +764,22 @@ def _override_execute_command(request: ToolCallRequest, command: str) -> ToolCal return request.override(tool_call={**dict(tool_call), "args": args}) -def _approval_slack_message(change: WorkflowPushChange) -> str: +def _approval_slack_message(change: WorkflowPushChange, approval_url: str | None = None) -> str: files = "\n".join(f"• `{path}`" for path in change.files[:10]) if len(change.files) > 10: files += f"\n• …and {len(change.files) - 10} more" repo = change.repo or "the repository" branch = change.branch or "the current branch" + stats = change.diff_stats or {"files": len(change.files), "additions": 0, "deletions": 0} + web_review = f"\n\n*Review diff:* <{approval_url}|Open in Web>" if approval_url else "" return ( "*Workflow file approval required*\n" - f"Open SWE is trying to push the workflow files below to `{repo}` on `{branch}`.\n\n" - f"*Files at the pushed head:*\n{files}\n\n" - f"*Fingerprint:* `{change.fingerprint}`\n\n" - "Approval covers the exact workflow files and content listed above at the pushed head, " - "including future rebases or amends that replay the same workflow tree. If the set of " - "workflow files, the branch, or the workflow-file content at the pushed head changes, " + f"Open SWE is trying to push changes to GitHub workflow files in `{repo}` on `{branch}`.\n\n" + f"*Files:*\n{files}\n\n" + f"*Diff stat:* {stats.get('files', len(change.files))} files, " + f"+{stats.get('additions', 0)} / -{stats.get('deletions', 0)}\n" + f"*Fingerprint:* `{change.fingerprint}`{web_review}\n\n" + "Approve only if this exact workflow diff is expected. If the workflow files change, " "a new fingerprint will be required." ) @@ -718,7 +797,9 @@ async def _post_slack_approval_if_needed( thread_ts = slack_thread.get("thread_ts") if not isinstance(channel_id, str) or not isinstance(thread_ts, str): return - message = _approval_slack_message(change) + message = _approval_slack_message( + change, _approval_url(_thread_id(request), change.fingerprint) + ) message_ts, error = await post_slack_thread_reply_with_ts( channel_id, thread_ts, @@ -736,6 +817,7 @@ async def _approval_state(request: ToolCallRequest, change: WorkflowPushChange) if not thread_id: return "missing_thread" try: + approval_url = _approval_url(thread_id, change.fingerprint) if await workflow_push_approved(thread_id, change.fingerprint): return "approved" if await workflow_push_rejected(thread_id, change.fingerprint): @@ -763,6 +845,10 @@ async def _approval_state(request: ToolCallRequest, change: WorkflowPushChange) base_sha=change.base_sha, head_sha=change.head_sha, files=change.files, + diff_stats=change.diff_stats, + diff_preview=change.diff_preview, + diff_preview_truncated=change.diff_preview_truncated, + approval_url=approval_url, ) await _post_slack_approval_if_needed(request, change, record) return str(record.get("status") or "pending") @@ -810,7 +896,19 @@ async def _run_with_workflow_token( finally: restored = await refresh_proxy_token(thread_id, permissions=RUNTIME_PROXY_TOKEN_PERMISSIONS) if not restored: - await refresh_proxy_token(thread_id, permissions=BASE_RUNTIME_PROXY_TOKEN_PERMISSIONS) + logger.error( + "SECURITY: failed to downscope proxy token for thread %s after an approved " + "workflow push; retrying without actions:read.", + thread_id, + ) + if not await refresh_proxy_token( + thread_id, permissions=BASE_RUNTIME_PROXY_TOKEN_PERMISSIONS + ): + logger.error( + "SECURITY: proxy token downscope fully failed for thread %s; the sandbox " + "may retain workflows:write for the remainder of this run.", + thread_id, + ) class WorkflowPushGuardMiddleware(AgentMiddleware): @@ -859,7 +957,7 @@ class WorkflowPushGuardMiddleware(AgentMiddleware): if state == "approved" and thread_id: safe_request = _override_execute_command(request, change.fixed_command) return await _run_with_workflow_token(thread_id, request, lambda: handler(safe_request)) - if state == "stale_approval": + if state == "stale_approval" and thread_id: record, _created = await ensure_workflow_push_pending( thread_id, fingerprint=change.fingerprint, @@ -868,11 +966,16 @@ class WorkflowPushGuardMiddleware(AgentMiddleware): base_sha=change.base_sha, head_sha=change.head_sha, files=change.files, + diff_stats=change.diff_stats, + diff_preview=change.diff_preview, + diff_preview_truncated=change.diff_preview_truncated, + approval_url=_approval_url(thread_id, change.fingerprint), ) await _post_slack_approval_if_needed(request, change, record) return _tool_message_for_request( _blocked_message( change, + approval_url=_approval_url(thread_id, change.fingerprint), already_rejected=state == "rejected", stale=state == "stale_approval", ), diff --git a/agent/prompt.py b/agent/prompt.py index 83f3c2ea..61826685 100644 --- a/agent/prompt.py +++ b/agent/prompt.py @@ -83,9 +83,10 @@ OPEN_SWE_SHARED_BASE = """You are **Open SWE**, an open-source agent built on La ### Communication - Focus on the substance and keep summaries brief. Use light markdown (`###`/`####` headings, bold, code) — avoid `#`/`##` titles. +- In Slack, keep every reply terse — a few sentences at most. Lead with the answer or outcome; skip preamble, restating the request, and step-by-step recaps. Do not paste long output, diffs, file listings, or multi-section write-ups into a Slack reply. When the response would genuinely be long — a detailed report, a design/analysis write-up, a large code or log excerpt — write that content to a Markdown file under `/workspace/plans/` and publish it with the `save_plan` tool, then post a terse Slack reply with a one-line summary and the plan-review link so the user can read the full version there. This non-plan share path does not enter plan mode; use it instead of splitting a long answer across multiple Slack messages. - In Slack, when a user asks to “break out,” “split out,” or “start a separate thread” for part of the work, summarize the requested aspect and relevant context into self-contained instructions, then call `slack_start_new_thread` instead of only replying in the current thread. - In Slack, when acknowledging a user follow-up while you continue working, prefer `slack_add_reaction` with the default `eyes` reaction over posting a perfunctory “Updating…” / “I’ll check…” confirmation reply. -- When you post to Slack with `slack_thread_reply`, do not repeat that text in a later assistant message; the user can already see the Slack message. +- For Slack-triggered information-only answers, post only a concise summary in the associated Slack thread with `slack_thread_reply`, then provide the complete answer inline in your final assistant response. For other Slack updates, keep thread replies brief and avoid duplicating the same text later. - When delegated work to a subagent: the calling agent only sees your final message, so make it the complete answer. IMPORTANT: You must ALWAYS call a tool in EVERY SINGLE TURN. If you don't call a tool, the session will end and you won't be able to resume without the user manually restarting you. @@ -310,7 +311,7 @@ Steps, in order: **IMPORTANT: If `git push` or `gh` returns "403", "Permission denied", or another permanent authorization failure, do not retry. Report the error to the user immediately and stop.** -**IMPORTANT: Workflow files (`.github/workflows/`) may be changed only when explicitly requested. Any push that includes workflow files at the pushed head requires human approval before it can proceed. Approval is keyed to the repo, branch, and the exact workflow files and content present at the pushed head, so rebases or amends that replay the same workflow tree do not require a fresh approval; changing the branch, the set of workflow files, or the workflow-file content at the pushed head does require a new approval. Do not attempt to bypass it.** +**IMPORTANT: Workflow files (`.github/workflows/`) may be changed only when explicitly requested. Workflow-file pushes are approved by `WorkflowPushGuardMiddleware`: after committing, run the push as a standalone `git push origin ` (or `git -C push origin `), never as part of a compound command. Do not manually ask for freeform fingerprint approval. If the push tool returns `WorkflowPushApprovalRequired`, stop retrying and wait for the generated Slack/Web approval; after approval, retry the same standalone push without changing workflow files. Approval is keyed to the repo, branch, and the exact workflow files and content present at the pushed head, so rebases or amends that replay the same workflow tree do not require a fresh approval; changing the branch, the set of workflow files, or the workflow-file content at the pushed head does require a new approval. Do not attempt to bypass it.** 4. **Notify the source** immediately after pushing and, when applicable, PR creation/update succeeds. Include a brief summary plus the PR link or branch URL: - Linear-triggered: use `linear_comment` with an `@mention` of the user who triggered the task diff --git a/agent/tools/save_plan.py b/agent/tools/save_plan.py index e8fde295..ac7f4cbb 100644 --- a/agent/tools/save_plan.py +++ b/agent/tools/save_plan.py @@ -1,20 +1,25 @@ -"""Tool: ``save_plan``. Publish the sandbox plan file for review. +"""Tool: ``save_plan``. Publish sandbox Markdown for review or sharing. -Reads the Markdown plan file the agent created in the sandbox and publishes it to -the plan-review page, where the user and collaborators read it, comment inline, -and approve or request changes. Available in plan mode (it does not modify the -repository under review). +Reads the Markdown file the agent created in the sandbox and publishes it to the +plan-review page. In plan mode it is an approvable implementation plan; outside +plan mode it is read-only shared content. """ from __future__ import annotations import logging from collections.abc import Mapping -from typing import Any +from typing import Annotated, Any from langgraph.config import get_config +from langgraph.prebuilt import InjectedState -from ..dashboard.plan_store import PLAN_FILE_DIRECTORY, PLAN_STATUS_READY, save_plan_content +from ..dashboard.plan_store import ( + PLAN_FILE_DIRECTORY, + PLAN_STATUS_READY, + PLAN_STATUS_SHARED, + save_plan_content, +) from ..utils.sandbox_state import get_sandbox_backend logger = logging.getLogger(__name__) @@ -23,20 +28,22 @@ _MAX_PLAN_LINES = 20_000 _MARKDOWN_EXTENSIONS = (".md", ".markdown") -async def save_plan(plan_file_path: str) -> dict[str, Any]: +async def save_plan( + plan_file_path: str, + state: Annotated[dict[str, Any] | None, InjectedState] = None, +) -> dict[str, Any]: """Publish a Markdown plan file from the sandbox for review. - Use this in plan mode once your plan is ready. First create a Markdown file - under ``/workspace/plans/`` using a dated, descriptive filename, then pass - that file path here. The file contents are published to the plan-review page - linked in the conversation, where the user (the owner) and any collaborators - can read it, leave inline comments, and then approve it or request changes. - Call it again to publish a revised file when addressing feedback. + Use this in plan mode once your plan is ready. Outside plan mode, use it to + share long Slack responses without switching the thread into plan mode. First + create a Markdown file under ``/workspace/plans/`` using a dated, descriptive + filename, then pass that file path here. The file contents are published to + the plan-review page linked in the conversation. In plan mode, the user can + comment, approve, or request changes; outside plan mode, the page is read-only + shared content. - Write the plan in standard Markdown — headings, bullet/numbered lists, and - fenced code blocks all render. Keep it concise and high level, focusing on - approach, decisions/tradeoffs, risks, and verification; avoid file/function - details unless they are unusually tricky or controversial. + Write the content in standard Markdown — headings, bullet/numbered lists, and + fenced code blocks all render. Args: plan_file_path: Path to the Markdown plan file in the sandbox. @@ -68,19 +75,29 @@ async def save_plan(plan_file_path: str) -> dict[str, Any]: content = (await _read_plan_file(str(thread_id), path)).strip() if not content: return {"success": False, "error": "plan file cannot be empty"} - await _save(str(thread_id), content, path) + await _save(str(thread_id), content, path, plan_mode=_active_plan_mode(state, configurable)) except Exception as exc: # noqa: BLE001 logger.exception("save_plan failed for thread %s", thread_id) return {"success": False, "error": f"failed to save plan: {exc}"} return {"success": True, "path": path} -async def _save(thread_id: str, content: str, path: str) -> None: +async def _save(thread_id: str, content: str, path: str, *, plan_mode: bool) -> None: await save_plan_content( - thread_id, markdown=content, status=PLAN_STATUS_READY, plan_file_path=path + thread_id, + markdown=content, + status=PLAN_STATUS_READY if plan_mode else PLAN_STATUS_SHARED, + plan_file_path=path, + plan_mode=plan_mode or None, ) +def _active_plan_mode(state: dict[str, Any] | None, configurable: Any) -> bool: + if isinstance(state, dict) and state.get("plan_mode") is True: + return True + return isinstance(configurable, dict) and configurable.get("plan_mode") is True + + async def _read_plan_file(thread_id: str, path: str) -> str: backend = await get_sandbox_backend(thread_id) result = await backend.aread(path, offset=0, limit=_MAX_PLAN_LINES) diff --git a/agent/utils/dashboard_links.py b/agent/utils/dashboard_links.py index 5bfab9bc..aecee2bf 100644 --- a/agent/utils/dashboard_links.py +++ b/agent/utils/dashboard_links.py @@ -26,6 +26,14 @@ def dashboard_plan_url(thread_id: str) -> str | None: return f"{base_url}/agents/{quote(thread_id, safe='')}/plan" +def dashboard_workflow_approval_url(thread_id: str, fingerprint: str) -> str | None: + """Build the dashboard workflow approval URL for a thread/fingerprint.""" + thread_url = dashboard_thread_url(thread_id) + if not thread_url or not fingerprint: + return thread_url + return f"{thread_url}?workflowApproval={quote(fingerprint, safe='')}" + + def dashboard_review_url(owner: str, repo: str, pr_number: int) -> str | None: """Build the dashboard review-detail URL for a PR.""" base_url = _dashboard_base_url() diff --git a/docs/upstream-sync/triage.jsonl b/docs/upstream-sync/triage.jsonl index 1f390645..4d340b8a 100644 --- a/docs/upstream-sync/triage.jsonl +++ b/docs/upstream-sync/triage.jsonl @@ -21,9 +21,9 @@ {"sha": "209132d3", "pr": 1621, "subject": "durable interrupt dispatch + completion webhook", "disposition": "deferred", "reason": "investigate first — may be applied", "branch": "durable-dispatch", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} {"sha": "02bb4dfd", "pr": 1658, "subject": "don't attach loopback run-complete webhooks", "disposition": "deferred", "reason": "", "branch": "durable-dispatch", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} {"sha": "29015fad", "pr": 1614, "subject": "gate workflow pushes with approval", "disposition": "deferred", "reason": "", "branch": "durable-dispatch", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} -{"sha": "546042a4", "pr": 1652, "subject": "add workflow approval UI", "disposition": "deferred", "reason": "", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} +{"sha": "546042a4", "pr": 1652, "subject": "add workflow approval UI", "disposition": "landed", "reason": "", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-09T17:10:22Z"} {"sha": "ae04b72b", "pr": 1635, "subject": "publish plans from sandbox files", "disposition": "landed", "reason": "ported (adapted) in #128 (save_plan reads sandbox file)", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-08T22:58:21Z"} -{"sha": "c03a6be7", "pr": 1634, "subject": "keep plan guidance high-level", "disposition": "deferred", "reason": "", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-02T00:00:00Z"} +{"sha": "c03a6be7", "pr": 1634, "subject": "keep plan guidance high-level", "disposition": "landed", "reason": "", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-09T17:10:22Z"} {"sha": "96cceb74", "pr": 1632, "subject": "notify Slack on plan approval", "disposition": "landed", "reason": "ported (adapted) in #128", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-08T22:58:21Z"} {"sha": "2f56d754", "pr": 1618, "subject": "omit plan link when no plan exists", "disposition": "landed", "reason": "already in dev via #81 (upstream-sync); ledger was stale (was: likely regression)", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-08T23:25:48Z"} {"sha": "ee224d3e", "pr": 1650, "subject": "add Slack reaction tool", "disposition": "landed", "reason": "", "branch": "slack-tooling", "local_sha": "3c6077c418e4017acf1f04ebeb81846770f934c9", "updated": "2026-07-03T19:38:56Z"} @@ -67,17 +67,17 @@ {"sha": "e5dbc788", "pr": 1696, "subject": "fix: Harden durable agent runs (#1696)", "disposition": "deferred", "reason": "large durable-run hardening; 3 new modules dev lacks; rewrites fork dispatch/completion", "branch": "durable-dispatch", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} {"sha": "52fe2916", "pr": 1698, "subject": "feat: add PR review link route (#1698)", "disposition": "landed", "reason": "cherry-picked (-x) in #127 (PR review link route)", "branch": "reviewer-misc", "local_sha": null, "updated": "2026-07-08T22:58:21Z"} {"sha": "5f7f5fbd", "pr": 1697, "subject": "fix: Reduce graph import and loader startup latency (#1697)", "disposition": "deferred", "reason": "import-hygiene refactor; cross-cutting, references many deferred upstream-only modules", "branch": "durable-dispatch", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} -{"sha": "216cf181", "pr": 1699, "subject": "fix: keep workflow HITL without token downscoping (#1699)", "disposition": "deferred", "reason": "FLAG-HUMAN: removes token downscoping — conflicts w/ fork PR#100 workflow-token elevation (auth surface)", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} +{"sha": "216cf181", "pr": 1699, "subject": "fix: keep workflow HITL without token downscoping (#1699)", "disposition": "landed", "reason": "DIVERGES-FROM-UPSTREAM: fork deliberately does NOT adopt #1699's standing-token workflows:write broadening. Security review (#159) BLOCKed it — the standing ALWAYS-ON proxy token carrying workflows:write turns the HITL guard's git-push-parser gaps (obfuscated-expansion push, `gh api` REST contents PUT, cross-branch refspecs) into live unapproved-workflow-push exploits. Fork keeps BASE without workflows:write and restores the transient per-approval elevation (_run_with_workflow_token mints WORKFLOW_RUNTIME_PROXY_TOKEN_PERMISSIONS around the approved, guard-normalized fixed_command, then downscopes to RUNTIME then BASE): the token scope is the backstop the parser relies on, so a bypass hits GitHub 403. HITL diff-preview/approval-URL/Slack-card additions from #159 retained; token-model divergence only.", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-09T20:00:00Z"} {"sha": "67abf5b0", "pr": 1659, "subject": "fix: surface attributed PR creation failures (#1659)", "disposition": "deferred", "reason": "PR-attribution-failure guard (new mw, safe imports); heavy conflict on diverged open_pull_request.py", "branch": "pr-attribution", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} -{"sha": "3dbc0282", "pr": 1676, "subject": "fix: preserve plan redirects after login (#1676)", "disposition": "deferred", "reason": "FLAG-HUMAN: follow-on to landed #1668 refining sanitize_redirect_to (open-redirect auth surface); not a dup", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} +{"sha": "3dbc0282", "pr": 1676, "subject": "fix: preserve plan redirects after login (#1676)", "disposition": "landed", "reason": "FLAG-HUMAN: follow-on to landed #1668 refining sanitize_redirect_to (open-redirect auth surface); not a dup", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-09T17:10:22Z"} {"sha": "c75cbb1f", "pr": 1677, "subject": "feat: re-add Fable 5 with an admin toggle to disable it (#1677)", "disposition": "deferred", "reason": "FLAG-HUMAN: re-adds Fable 5 via anthropic: — contradicts dev's deliberate hide (#1483) + Bedrock migration (#62); wont-merge candidate", "branch": "fable-admin-toggle", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} -{"sha": "bb104d93", "pr": 1679, "subject": "fix: submit plan comments with cmd enter (#1679)", "disposition": "deferred", "reason": "applies clean but edits fork-diverged PlanReview.tsx (#130); needs UI/e2e validation — separate PR", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-08T23:17:35Z"} +{"sha": "bb104d93", "pr": 1679, "subject": "fix: submit plan comments with cmd enter (#1679)", "disposition": "landed", "reason": "applies clean but edits fork-diverged PlanReview.tsx (#130); needs UI/e2e validation — separate PR", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-09T17:10:22Z"} {"sha": "304032fa", "pr": 1680, "subject": "chore: clarify question answering prompt (#1680)", "disposition": "deferred", "reason": "reword Slack info-only answer guidance; conflicts w/ fork's customized Slack prompt", "branch": "prompt-tweaks", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} {"sha": "5003c953", "pr": 1683, "subject": "feat: open Linear-triggered PRs as the triggering user (#1683)", "disposition": "deferred", "reason": "FLAG-HUMAN: adds linear to resolve_github_token per-user OAuth branch (auth surface); depends on #1626 linear.py", "branch": "linear-pr-as-user", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} {"sha": "feb7ac98", "pr": 1689, "subject": "feat(web): surface thread sandbox ID with touch-friendly menu (#1689)", "disposition": "deferred", "reason": "applies clean but frontend<->backend contract (thread_api->queries->types->sidebar); needs UI build + e2e validation — separate PR", "branch": "dashboard-ui", "local_sha": null, "updated": "2026-07-08T23:17:35Z"} {"sha": "7f7af715", "pr": 1684, "subject": "feat: auto-load scoped AGENTS on reads (#1684)", "disposition": "landed", "reason": "ported in #129 (SubdirAgentsReadMiddleware)", "branch": "subdir-agents", "local_sha": null, "updated": "2026-07-08T22:58:22Z"} {"sha": "88b62322", "pr": 1685, "subject": "feat: add platform issue reporting tool (#1685)", "disposition": "landed", "reason": "ported in #129 (report_platform_issue tool)", "branch": "small-tools", "local_sha": null, "updated": "2026-07-08T22:58:22Z"} -{"sha": "90cb6caa", "pr": 1681, "subject": "feat: terse Slack replies, share long content via plan-review page (#1681)", "disposition": "deferred", "reason": "terse Slack + long-content-via-plan-page; conflicts w/ fork prompt + diverged plan stack", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} +{"sha": "90cb6caa", "pr": 1681, "subject": "feat: terse Slack replies, share long content via plan-review page (#1681)", "disposition": "landed", "reason": "terse Slack + long-content-via-plan-page; conflicts w/ fork prompt + diverged plan stack", "branch": "plan-approval", "local_sha": null, "updated": "2026-07-09T17:10:22Z"} {"sha": "f53caff1", "pr": 1701, "subject": "fix: fall back to core GitHub App scope when optional grants missing (#1701)", "disposition": "deferred", "reason": "FLAG-HUMAN: GitHub-App permission-ladder degrade (auth surface); heavy conflict on diverged github_app.py/_resolve_proxy_token", "branch": "github-app-scope", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} {"sha": "73a9e8b5", "pr": 1693, "subject": "chore(deps): bump the minor-and-patch group across 1 directory with 19 updates (#1693)", "disposition": "wont-merge", "reason": "dev at-or-ahead on 17/19; group fights dev's pinned langsmith==0.9.7 (#115) and carries an upstream plan-route test", "branch": "", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} {"sha": "9cd7e464", "pr": 1700, "subject": "Fix workflow approval visibility (#1700)", "disposition": "wont-merge", "reason": "superseded — dev's list_workflow_approvals_for_thread already enforces owner-only 403", "branch": "", "local_sha": null, "updated": "2026-07-08T20:14:42Z"} diff --git a/docs/upstream-sync/triage.md b/docs/upstream-sync/triage.md index ef9267de..337184e6 100644 --- a/docs/upstream-sync/triage.md +++ b/docs/upstream-sync/triage.md @@ -21,7 +21,9 @@ Rows key on the **upstream SHA** (stable across local cherry-picks). Deferred ro | `6575c327` | #1654 | disable React StrictMode | Landed | kept fork's `PwaUpdateProvider` | cherry-pick-upstream | | `00906401` | #1610 | editable plan mode | Landed | re-implemented in fork via #130 (editable plan mode) | | | `f5670f24` | #1639 | require bun for ui agent work | Landed | cherry-picked (-x) in this PR (#132) | PR1 | +| `546042a4` | #1652 | add workflow approval UI | Landed | | plan-approval | | `ae04b72b` | #1635 | publish plans from sandbox files | Landed | ported (adapted) in #128 (save_plan reads sandbox file) | plan-approval | +| `c03a6be7` | #1634 | keep plan guidance high-level | Landed | | plan-approval | | `96cceb74` | #1632 | notify Slack on plan approval | Landed | ported (adapted) in #128 | plan-approval | | `2f56d754` | #1618 | omit plan link when no plan exists | Landed | already in dev via #81 (upstream-sync); ledger was stale (was: likely regression) | plan-approval | | `ee224d3e` | #1650 | add Slack reaction tool | Landed | | slack-tooling | @@ -42,8 +44,12 @@ Rows key on the **upstream SHA** (stable across local cherry-picks). Deferred ro | `20f63e8c` | #1646 | install missing deps before verification | Landed | already in dev via #81 (upstream-sync); ledger was stale | prompt-tweaks | | `2f237b53` | #1626 | fall back to vision model for image threads | Landed | ported (adapted to Bedrock/Fireworks vision) in #128 | gateway-routing | | `52fe2916` | #1698 | feat: add PR review link route (#1698) | Landed | cherry-picked (-x) in #127 (PR review link route) | reviewer-misc | +| `216cf181` | #1699 | fix: keep workflow HITL without token downscoping (#1699) | Landed | DIVERGES-FROM-UPSTREAM: fork deliberately does NOT adopt #1699's standing-token workflows:write broadening. Security review (#159) BLOCKed it — the standing ALWAYS-ON proxy token carrying workflows:write turns the HITL guard's git-push-parser gaps (obfuscated-expansion push, `gh api` REST contents PUT, cross-branch refspecs) into live unapproved-workflow-push exploits. Fork keeps BASE without workflows:write and restores the transient per-approval elevation (_run_with_workflow_token mints WORKFLOW_RUNTIME_PROXY_TOKEN_PERMISSIONS around the approved, guard-normalized fixed_command, then downscopes to RUNTIME then BASE): the token scope is the backstop the parser relies on, so a bypass hits GitHub 403. HITL diff-preview/approval-URL/Slack-card additions from #159 retained; token-model divergence only. | plan-approval | +| `3dbc0282` | #1676 | fix: preserve plan redirects after login (#1676) | Landed | FLAG-HUMAN: follow-on to landed #1668 refining sanitize_redirect_to (open-redirect auth surface); not a dup | plan-approval | +| `bb104d93` | #1679 | fix: submit plan comments with cmd enter (#1679) | Landed | applies clean but edits fork-diverged PlanReview.tsx (#130); needs UI/e2e validation — separate PR | plan-approval | | `7f7af715` | #1684 | feat: auto-load scoped AGENTS on reads (#1684) | Landed | ported in #129 (SubdirAgentsReadMiddleware) | subdir-agents | | `88b62322` | #1685 | feat: add platform issue reporting tool (#1685) | Landed | ported in #129 (report_platform_issue tool) | small-tools | +| `90cb6caa` | #1681 | feat: terse Slack replies, share long content via plan-review page (#1681) | Landed | terse Slack + long-content-via-plan-page; conflicts w/ fork prompt + diverged plan stack | plan-approval | | `c3292d82` | #1611 | bake sfw binary into sandbox image | Won't merge | already in dev | | | `48bf712b` | #1609 | show message timestamps | Won't merge | already in dev | | | `85c0f63e` | #1620 | clickable shared PR header | Won't merge | already in dev | | @@ -64,8 +70,6 @@ Rows key on the **upstream SHA** (stable across local cherry-picks). Deferred ro | `209132d3` | #1621 | durable interrupt dispatch + completion webhook | Deferred | investigate first — may be applied | durable-dispatch | | `02bb4dfd` | #1658 | don't attach loopback run-complete webhooks | Deferred | | durable-dispatch | | `29015fad` | #1614 | gate workflow pushes with approval | Deferred | | durable-dispatch | -| `546042a4` | #1652 | add workflow approval UI | Deferred | | plan-approval | -| `c03a6be7` | #1634 | keep plan guidance high-level | Deferred | | plan-approval | | `4cd5fa5c` | #1629 | avoid recapping Slack replies | Deferred | | slack-tooling | | `baf0c248` | #1617 | filter & grouping menu in threads sidebar | Deferred | ~998 LOC | own branch | | `f29868ff` | #1615 | recover thread work as patch | Deferred | ~495 LOC | own branch | @@ -83,15 +87,11 @@ Rows key on the **upstream SHA** (stable across local cherry-picks). Deferred ro | `c9a9a7cd` | #1695 | fix: retry model fallback exhaustion (#1695) | Deferred | alternating retry+backoff rewrite; reconcile by hand w/ dev's Bedrock + sync wrap path | model-fallback | | `e5dbc788` | #1696 | fix: Harden durable agent runs (#1696) | Deferred | large durable-run hardening; 3 new modules dev lacks; rewrites fork dispatch/completion | durable-dispatch | | `5f7f5fbd` | #1697 | fix: Reduce graph import and loader startup latency (#1697) | Deferred | import-hygiene refactor; cross-cutting, references many deferred upstream-only modules | durable-dispatch | -| `216cf181` | #1699 | fix: keep workflow HITL without token downscoping (#1699) | Deferred | FLAG-HUMAN: removes token downscoping — conflicts w/ fork PR#100 workflow-token elevation (auth surface) | plan-approval | | `67abf5b0` | #1659 | fix: surface attributed PR creation failures (#1659) | Deferred | PR-attribution-failure guard (new mw, safe imports); heavy conflict on diverged open_pull_request.py | pr-attribution | -| `3dbc0282` | #1676 | fix: preserve plan redirects after login (#1676) | Deferred | FLAG-HUMAN: follow-on to landed #1668 refining sanitize_redirect_to (open-redirect auth surface); not a dup | plan-approval | | `c75cbb1f` | #1677 | feat: re-add Fable 5 with an admin toggle to disable it (#1677) | Deferred | FLAG-HUMAN: re-adds Fable 5 via anthropic: — contradicts dev's deliberate hide (#1483) + Bedrock migration (#62); wont-merge candidate | fable-admin-toggle | -| `bb104d93` | #1679 | fix: submit plan comments with cmd enter (#1679) | Deferred | applies clean but edits fork-diverged PlanReview.tsx (#130); needs UI/e2e validation — separate PR | plan-approval | | `304032fa` | #1680 | chore: clarify question answering prompt (#1680) | Deferred | reword Slack info-only answer guidance; conflicts w/ fork's customized Slack prompt | prompt-tweaks | | `5003c953` | #1683 | feat: open Linear-triggered PRs as the triggering user (#1683) | Deferred | FLAG-HUMAN: adds linear to resolve_github_token per-user OAuth branch (auth surface); depends on #1626 linear.py | linear-pr-as-user | | `feb7ac98` | #1689 | feat(web): surface thread sandbox ID with touch-friendly menu (#1689) | Deferred | applies clean but frontend<->backend contract (thread_api->queries->types->sidebar); needs UI build + e2e validation — separate PR | dashboard-ui | -| `90cb6caa` | #1681 | feat: terse Slack replies, share long content via plan-review page (#1681) | Deferred | terse Slack + long-content-via-plan-page; conflicts w/ fork prompt + diverged plan stack | plan-approval | | `f53caff1` | #1701 | fix: fall back to core GitHub App scope when optional grants missing (#1701) | Deferred | FLAG-HUMAN: GitHub-App permission-ladder degrade (auth surface); heavy conflict on diverged github_app.py/_resolve_proxy_token | github-app-scope | | `22e024cb` | #1704 | fix: link issue PRs and prompt repo conventions (#1704) | Deferred | issue/PR linking + repo-convention prompt; clean but prompt-conflict risk vs #113 | webhook-issue-linking | diff --git a/tests/test_plan_review.py b/tests/test_plan_review.py index 98d73d06..f1bdb227 100644 --- a/tests/test_plan_review.py +++ b/tests/test_plan_review.py @@ -152,10 +152,19 @@ async def test_save_plan_reads_markdown_file_from_sandbox( return _Backend() async def fake_save_content( - thread_id: str, *, markdown: str, status: str, plan_file_path: str | None = None + thread_id: str, + *, + markdown: str, + status: str, + plan_file_path: str | None = None, + plan_mode: bool | None = True, ) -> None: saved.update( - thread_id=thread_id, markdown=markdown, status=status, plan_file_path=plan_file_path + thread_id=thread_id, + markdown=markdown, + status=status, + plan_file_path=plan_file_path, + plan_mode=plan_mode, ) monkeypatch.setattr( @@ -175,8 +184,9 @@ async def test_save_plan_reads_markdown_file_from_sandbox( assert saved == { "thread_id": "thread-1", "markdown": "# Plan\n\nDo it.", - "status": "ready", + "status": "shared", "plan_file_path": "/workspace/plans/2026-07-08-test-plan.md", + "plan_mode": None, } diff --git a/ui/src/components/agents/AgentThreadView.tsx b/ui/src/components/agents/AgentThreadView.tsx index 0080e8da..0a804015 100644 --- a/ui/src/components/agents/AgentThreadView.tsx +++ b/ui/src/components/agents/AgentThreadView.tsx @@ -23,11 +23,6 @@ import { useSubmitAgentMessage } from "@/lib/agents/provider/useSubmitAgentMessa import { useModelOptions } from "@/lib/agents/provider/useModelOptions" import { useIsMobile } from "@/lib/useIsMobile" import { cn } from "@/lib/utils" -import { - useApproveWorkflowPush, - useRejectWorkflowPush, - useWorkflowApprovals, -} from "@/lib/agents/queries" import { WorkflowApprovalCard } from "@/components/agents/WorkflowApprovalCard" interface AgentThreadViewProps { @@ -132,31 +127,6 @@ export function AgentThreadView({ thread }: AgentThreadViewProps) { // Show a loading state during that one-time fetch instead of the empty state. const isHydrating = stream.isThreadLoading && !hasMessages - const approvalsQuery = useWorkflowApprovals(thread.id) - const approveMutation = useApproveWorkflowPush(thread.id) - const rejectMutation = useRejectWorkflowPush(thread.id) - - const approvals = approvalsQuery.data - const isApprovalOwner = thread.isOwner ?? false - - const hasWorkflowApprovalError = useMemo( - () => - baseMessages.some((message) => - message.chunks.some( - (chunk) => - chunk.kind === "tool-execution" && - chunk.output?.includes("WorkflowPushApprovalRequired") - ) - ), - [baseMessages] - ) - - useEffect(() => { - if (hasWorkflowApprovalError) { - void approvalsQuery.refetch() - } - }, [hasWorkflowApprovalError]) - return (
{thread.planStatus === "ready" ? "A plan is ready for your review." - : thread.planStatus === "revising" - ? "The agent is revising the plan." - : "The agent is writing a plan."} + : thread.planStatus === "shared" + ? "The agent shared a longer response." + : thread.planStatus === "revising" + ? "The agent is revising the plan." + : "The agent is writing a plan."} - Review plan → + {thread.planStatus === "shared" + ? "Open response →" + : "Review plan →"} )} + {hasConversation ? (
- {approvals && approvals.length > 0 && ( -
- {approvals.map((approval) => ( - - approveMutation.mutate(approval.fingerprint) - } - onReject={() => rejectMutation.mutate(approval.fingerprint)} - /> - ))} -
- )} (null) const [copied, setCopied] = useState(false) // Locally track the displayed markdown so a manual edit shows immediately; the - // route's query stops polling once a plan exists, so the prop won't refetch. + // route's query stops polling once content exists, so the prop won't refetch. const [markdown, setMarkdown] = useState(plan.markdown) const [editing, setEditing] = useState(false) const [editDraft, setEditDraft] = useState(plan.markdown) @@ -70,8 +70,12 @@ export function PlanReview({ plan }: { plan: PlanData }) { if (!editing) setMarkdown(plan.markdown) }, [plan.markdown, editing]) + const isShared = plan.status === "shared" const canEdit = - plan.isOwner && plan.status !== "approved" && plan.status !== "cancelled" + plan.isOwner && + !isShared && + plan.status !== "approved" && + plan.status !== "cancelled" const startEditing = useCallback(() => { setEditDraft(markdown) @@ -114,13 +118,14 @@ export function PlanReview({ plan }: { plan: PlanData }) { /* transient; next tick retries */ } } + if (isShared) return void load() const timer = setInterval(load, POLL_MS) return () => { cancelled = true clearInterval(timer) } - }, [plan.threadId]) + }, [isShared, plan.threadId]) const submitComment = useCallback(async () => { const body = draft.trim() @@ -138,6 +143,16 @@ export function PlanReview({ plan }: { plan: PlanData }) { } }, [draft, plan.threadId]) + const handleCommentKeyDown = useCallback( + (event: KeyboardEvent) => { + if (event.key !== "Enter" || (!event.metaKey && !event.ctrlKey)) return + event.preventDefault() + if (posting || !draft.trim()) return + void submitComment() + }, + [draft, posting, submitComment] + ) + const removeComment = useCallback( async (id: string) => { try { @@ -192,10 +207,10 @@ export function PlanReview({ plan }: { plan: PlanData }) {

- Implementation plan + {isShared ? "Shared response" : "Implementation plan"}

- Reviewing as {plan.user.name} + {isShared ? "Viewing" : "Reviewing"} as {plan.user.name} {plan.isOwner ? " (owner)" : ""} · status:{" "} {plan.status}

@@ -227,7 +242,7 @@ export function PlanReview({ plan }: { plan: PlanData }) { Edit )} - {plan.isOwner && ( + {!isShared && plan.isOwner && ( + )}
@@ -296,7 +313,7 @@ export function PlanReview({ plan }: { plan: PlanData }) { )}
-
- + )}
) diff --git a/ui/src/components/agents/WorkflowApprovalCard.tsx b/ui/src/components/agents/WorkflowApprovalCard.tsx index 73140f51..cdd150f9 100644 --- a/ui/src/components/agents/WorkflowApprovalCard.tsx +++ b/ui/src/components/agents/WorkflowApprovalCard.tsx @@ -1,138 +1,177 @@ -import { Check, FileCode2, ShieldAlert, X } from "lucide-react" +import { useMemo, useState } from "react" +import { ShieldCheck } from "lucide-react" -import type { WorkflowApproval } from "@/lib/agents/api" - -import { Button } from "@/components/ui/button" +import type { WorkflowPushApproval } from "@/lib/agents/api" import { - Card, - CardContent, - CardDescription, - CardFooter, - CardHeader, - CardTitle, -} from "@/components/ui/card" + useWorkflowApprovalDecision, + useWorkflowApprovals, +} from "@/lib/agents/queries" +import { Button } from "@/components/ui/button" +import { cn } from "@/lib/utils" -type ApprovalStatus = "pending" | "approved" | "rejected" | string - -interface WorkflowApprovalCardProps { - approval: WorkflowApproval - isOwner: boolean - isPending: boolean - onApprove: (fingerprint: string) => void - onReject: (fingerprint: string) => void +function shortSha(value: string): string { + return value ? value.slice(0, 7) : "unknown" } -function statusBadgeClass(status: ApprovalStatus) { - switch (status) { - case "approved": - return "bg-green-500/10 text-green-600 dark:text-green-400" - case "rejected": - return "bg-red-500/10 text-red-600 dark:text-red-400" - default: - return "bg-amber-500/10 text-amber-600 dark:text-amber-400" - } +function pendingApprovals( + approvals: Array | undefined +): Array { + return (approvals ?? []).filter((approval) => approval.status === "pending") } -function statusLabel(status: ApprovalStatus) { - switch (status) { - case "approved": - return "Approved" - case "rejected": - return "Rejected" - default: - return "Pending approval" - } +function fileLabel(count: number): string { + return count === 1 ? "1 file" : `${count} files` } export function WorkflowApprovalCard({ - approval, - isOwner, - isPending, - onApprove, - onReject, -}: WorkflowApprovalCardProps) { - const actionable = isOwner && approval.status === "pending" && !isPending - const decided = approval.status !== "pending" + threadId, + pollWhileActive = false, +}: { + threadId: string + pollWhileActive?: boolean +}) { + const query = useWorkflowApprovals(threadId, { pollWhileActive }) + const decision = useWorkflowApprovalDecision(threadId) + const [error, setError] = useState(null) + const approvals = useMemo( + () => pendingApprovals(query.data?.approvals), + [query.data?.approvals] + ) + + if (approvals.length === 0) return null + + const isOwner = query.data?.isOwner === true + const decide = async ( + approval: WorkflowPushApproval, + kind: "approve" | "reject" + ) => { + setError(null) + try { + await decision.mutateAsync({ + fingerprint: approval.fingerprint, + decision: kind, + }) + } catch (e) { + setError((e as Error).message) + } + } return ( - - -
-
- - - Workflow push approval required - -
- - {statusLabel(approval.status)} - -
- - Open SWE is trying to push GitHub workflow file changes in{" "} - {approval.repo} on {approval.branch} - . Approve only if this exact workflow diff is expected. - -
- -
-
- - Changed workflow files -
-
    - {approval.files.map((file) => ( -
  • - {file} -
  • - ))} -
-
- Fingerprint:{" "} - - {approval.fingerprint} - -
-
-
- {actionable ? ( - - - - - ) : decided ? ( - - This workflow push has been {approval.status}. If the workflow files - change, a new fingerprint will be required. - - ) : null} - {!isOwner && approval.status === "pending" && ( - - Only the thread owner can approve or reject this workflow push. - - )} -
+
+
+ {approvals.map((approval) => { + const busy = decision.isPending + return ( +
+
+
+
+ + Workflow file approval required +
+

+ {approval.repo || "Repository"} on{" "} + {approval.branch || "current branch"} ·{" "} + {shortSha(approval.baseSha)} → {shortSha(approval.headSha)} +

+

+ fingerprint: {approval.fingerprint} +

+
+
+ {approval.approvalUrl && ( + + )} + + +
+
+ + {!isOwner && ( +

+ Only the thread owner can approve or reject this workflow + push. +

+ )} + {error && ( +

+ {error} +

+ )} + +
+
+

+ {fileLabel(approval.files.length)} changed +

+
    + {approval.files.slice(0, 8).map((file) => ( +
  • + {file} +
  • + ))} + {approval.files.length > 8 && ( +
  • …and {approval.files.length - 8} more
  • + )} +
+
+
+ {approval.diffStats.files} files + + +{approval.diffStats.additions} + + + -{approval.diffStats.deletions} + +
+
+ + {approval.diffPreview && ( +
+ + Diff preview + {approval.diffPreviewTruncated ? " (truncated)" : ""} + +
+                    {approval.diffPreview}
+                  
+
+ )} +
+ ) + })} +
+
) } diff --git a/ui/src/lib/agents/api.ts b/ui/src/lib/agents/api.ts index 886bf896..bd93beef 100644 --- a/ui/src/lib/agents/api.ts +++ b/ui/src/lib/agents/api.ts @@ -65,17 +65,35 @@ export interface ThreadRecoveryPatch { filename: string } -export interface WorkflowApproval { - fingerprint: string - status: string - repo: string - branch: string - files: Array - requested_at: string +export type WorkflowApprovalStatus = "pending" | "approved" | "rejected" + +export interface WorkflowDiffStats { + files: number + additions: number + deletions: number } -export interface WorkflowApprovalsPayload { - approvals: Array +export interface WorkflowPushApproval { + fingerprint: string + status: WorkflowApprovalStatus + repo: string + branch: string + baseSha: string + headSha: string + files: Array + diffStats: WorkflowDiffStats + diffPreview: string + diffPreviewTruncated: boolean + approvalUrl: string | null + requestedAt: string | null + decidedAt: string | null + decidedBy: string | null +} + +export interface WorkflowPushApprovalsResponse { + threadId: string + isOwner: boolean + approvals: Array } export interface WorkflowApprovalDecision { @@ -83,6 +101,12 @@ export interface WorkflowApprovalDecision { fingerprint: string } +// Legacy alias kept for backward-compatible prop typing. +export type WorkflowApproval = WorkflowPushApproval +export interface WorkflowApprovalsPayload { + approvals: Array +} + export interface ThreadsPageParams { limit?: number offset?: number @@ -284,7 +308,7 @@ export const agentsApi = { streamUrl: (threadId: string) => `${API_BASE}/dashboard/api/threads/${encodeURIComponent(threadId)}/stream`, listWorkflowApprovals: (threadId: string) => - agentsRequest( + agentsRequest( `/workflow-approval/${encodeURIComponent(threadId)}` ), approveWorkflowPush: (threadId: string, fingerprint: string) => diff --git a/ui/src/lib/agents/queries.ts b/ui/src/lib/agents/queries.ts index 0f60bf2b..36033c55 100644 --- a/ui/src/lib/agents/queries.ts +++ b/ui/src/lib/agents/queries.ts @@ -8,7 +8,8 @@ import type { ScheduleUpdateRequest, SidebarThreads, ThreadsPageParams, - WorkflowApproval, + WorkflowPushApproval, + WorkflowPushApprovalsResponse, } from "./api" import type { AgentThread, Chunk, ImageChunk, Message } from "./types" @@ -128,57 +129,43 @@ export function useAgentThreadPrDiff(threadId: string, enabled: boolean) { }) } -export function useWorkflowApprovals(threadId: string) { +export function useWorkflowApprovals( + threadId: string, + options: { pollWhileActive?: boolean } = {} +) { return useQuery({ queryKey: agentThreadKeys.workflowApprovals(threadId), - queryFn: async () => { - const { approvals } = await agentsApi.listWorkflowApprovals(threadId) - return approvals - }, - refetchInterval: (query) => { - const data = query.state.data - return data?.some((a) => a.status === "pending") ? 3000 : false - }, + queryFn: () => agentsApi.listWorkflowApprovals(threadId), + enabled: Boolean(threadId), + refetchInterval: (query) => + options.pollWhileActive || + query.state.data?.approvals?.some( + (approval) => approval.status === "pending" + ) + ? 3000 + : false, retry: false, }) } -export function useApproveWorkflowPush(threadId: string) { +export function useWorkflowApprovalDecision(threadId: string) { const queryClient = useQueryClient() - return useMutation({ - mutationFn: (fingerprint: string) => - agentsApi.approveWorkflowPush(threadId, fingerprint), - onSuccess: (_, fingerprint) => { - queryClient.setQueryData | undefined>( - agentThreadKeys.workflowApprovals(threadId), - (prev) => - prev?.map((record) => - record.fingerprint === fingerprint - ? { ...record, status: "approved" } - : record - ) - ) - }, - }) -} - -export function useRejectWorkflowPush(threadId: string) { - const queryClient = useQueryClient() - - return useMutation({ - mutationFn: (fingerprint: string) => - agentsApi.rejectWorkflowPush(threadId, fingerprint), - onSuccess: (_, fingerprint) => { - queryClient.setQueryData | undefined>( - agentThreadKeys.workflowApprovals(threadId), - (prev) => - prev?.map((record) => - record.fingerprint === fingerprint - ? { ...record, status: "rejected" } - : record - ) - ) + mutationFn: (vars: { + fingerprint: string + decision: "approve" | "reject" + }) => + vars.decision === "approve" + ? agentsApi.approveWorkflowPush(threadId, vars.fingerprint) + : agentsApi.rejectWorkflowPush(threadId, vars.fingerprint), + onSuccess: () => { + void queryClient.invalidateQueries({ + queryKey: agentThreadKeys.workflowApprovals(threadId), + }) + void queryClient.invalidateQueries({ + queryKey: agentThreadKeys.detail(threadId), + }) + invalidateAgentThreadLists(queryClient) }, }) } diff --git a/ui/src/lib/api.ts b/ui/src/lib/api.ts index 569f7abe..d3321176 100644 --- a/ui/src/lib/api.ts +++ b/ui/src/lib/api.ts @@ -825,7 +825,10 @@ export const api = { export function loginUrl(redirectTo?: string): string { const target = - redirectTo ?? (typeof window !== "undefined" ? window.location.href : "") + redirectTo ?? + (typeof window !== "undefined" + ? `${window.location.pathname}${window.location.search}${window.location.hash}` + : "") const qs = target ? `?redirect_to=${encodeURIComponent(target)}` : "" return `${API_BASE}/dashboard/api/auth/login${qs}` } diff --git a/ui/src/lib/auth-redirect-core.ts b/ui/src/lib/auth-redirect-core.ts index 91cc0e99..0a138612 100644 --- a/ui/src/lib/auth-redirect-core.ts +++ b/ui/src/lib/auth-redirect-core.ts @@ -50,7 +50,12 @@ export function sanitizeAuthRedirect( } const path = `${parsed.pathname}${parsed.search}${parsed.hash}` - if (!path.startsWith("/") || isBlockedRedirectPath(path)) return fallback + // Reject anything that is not a single-leading-slash path. `new URL` can resolve inputs + // like `/..//evil.com` to a protocol-relative `//evil.com` that still matches the origin + // check above but, when handed to `window.location.replace`, navigates cross-origin. + if (path.startsWith("//") || !/^\/[^/]/.test(path) || isBlockedRedirectPath(path)) { + return fallback + } return path } diff --git a/ui/src/lib/auth-redirect.test.ts b/ui/src/lib/auth-redirect.test.ts index eacc5063..15ae6870 100644 --- a/ui/src/lib/auth-redirect.test.ts +++ b/ui/src/lib/auth-redirect.test.ts @@ -63,6 +63,14 @@ describe("auth redirect helpers", () => { ) }) + it("rejects inputs that resolve to a protocol-relative path", () => { + // These resolve same-origin (passing the origin check) but yield a `//host` + // path that would navigate cross-origin via window.location.replace. + expect(sanitizeAuthRedirect("/..//evil.com")).toBe(DEFAULT_AUTH_REDIRECT) + expect(sanitizeAuthRedirect("/.//evil.com")).toBe(DEFAULT_AUTH_REDIRECT) + expect(sanitizeAuthRedirect("//evil.com")).toBe(DEFAULT_AUTH_REDIRECT) + }) + it("builds a plan sign-in target for the current plan URL", () => { window.history.pushState({}, "", "/agents/thread-1/plan?from=slack") diff --git a/ui/src/lib/plan.ts b/ui/src/lib/plan.ts index 8a0e849a..4c16e3f5 100644 --- a/ui/src/lib/plan.ts +++ b/ui/src/lib/plan.ts @@ -24,11 +24,7 @@ export interface PlanUser { } export type PlanStatus = - | "planning" - | "ready" - | "revising" - | "approved" - | "cancelled" + "planning" | "ready" | "shared" | "revising" | "approved" | "cancelled" export interface PlanData { threadId: string diff --git a/ui/src/routes/agents/$threadId_.plan.tsx b/ui/src/routes/agents/$threadId_.plan.tsx index 5eeb0198..3b408059 100644 --- a/ui/src/routes/agents/$threadId_.plan.tsx +++ b/ui/src/routes/agents/$threadId_.plan.tsx @@ -7,7 +7,7 @@ import { PlanReview } from "@/components/agents/PlanReview" import { buttonVariants } from "@/components/ui/button" import { Skeleton } from "@/components/ui/skeleton" import { loginUrl } from "@/lib/api" -import { authRedirectUrl, currentAuthRedirectPath } from "@/lib/auth-redirect" +import { currentAuthRedirectPath } from "@/lib/auth-redirect" import { PlanApiError, getPlan } from "@/lib/plan" export const Route = createFileRoute("/agents/$threadId_/plan")({ @@ -36,7 +36,7 @@ function BackLink({ threadId }: { threadId: string }) { } export function planSignInHref(): string { - return loginUrl(authRedirectUrl(currentAuthRedirectPath())) + return loginUrl(currentAuthRedirectPath()) } export function PlanSignInButton() { diff --git a/ui/src/routes/login.tsx b/ui/src/routes/login.tsx index c3505bfc..ade6620f 100644 --- a/ui/src/routes/login.tsx +++ b/ui/src/routes/login.tsx @@ -7,7 +7,6 @@ import { Skeleton } from "@/components/ui/skeleton"; import { loginUrl } from "@/lib/api"; import { DEFAULT_AUTH_REDIRECT, - authRedirectUrl, consumeAuthRedirect, getRememberedAuthRedirect, rememberAuthRedirect, @@ -64,7 +63,7 @@ function Login() { Continue with GitHub