Skip to content

πŸ™Œ OpenHands: AI-Driven Development

refactor(acp): remove acp_env wholesale-replacement compat code (#14668)

simonrosenberg4327be017de5
diff --git a/enterprise/tests/unit/test_org_member_store.py b/enterprise/tests/unit/test_org_member_store.py
index 27751b4207..fc0916d5f0 100644
--- a/enterprise/tests/unit/test_org_member_store.py
+++ b/enterprise/tests/unit/test_org_member_store.py
@@ -1244,84 +1244,6 @@ async def test_update_all_members_settings_async_replaces_mcp_config(
), 'Deleted server was resurrected by deep_merge'
-async def test_update_all_members_settings_async_replaces_acp_env(
- async_session_maker,
-):
- """
- GIVEN: Organization members with existing acp_env in agent_settings_diff
- WHEN: update_all_members_settings_async is called with fewer env vars
- THEN: acp_env should be replaced (not merged), so deleted vars stay deleted
-
- acp_env has the same replacement semantics as mcp_config.
- """
- from server.routes.org_models import OrgMemberSettingsUpdate
-
- # Arrange - Create org with member that has 3 env vars
- async with async_session_maker() as session:
- org = Org(name='test-org')
- session.add(org)
- await session.flush()
-
- role = Role(name='member', rank=2)
- session.add(role)
- await session.flush()
-
- user = User(id=uuid.uuid4(), current_org_id=org.id, email='[email protected]')
- session.add(user)
- await session.flush()
-
- org_member = OrgMember(
- org_id=org.id,
- user_id=user.id,
- role_id=role.id,
- llm_api_key='test-key',
- agent_settings_diff={
- 'acp_env': {
- 'VAR1': 'value1',
- 'VAR2': 'value2',
- 'VAR3': 'value3',
- },
- },
- status='active',
- )
- session.add(org_member)
- await session.commit()
- org_id = org.id
-
- # Act - Update with only 2 vars (delete VAR3)
- member_settings = OrgMemberSettingsUpdate(
- agent_settings_diff={
- 'acp_env': {
- 'VAR1': 'value1',
- 'VAR2': 'value2',
- # VAR3 is deleted
- },
- },
- )
-
- async with async_session_maker() as session:
- await OrgMemberStore.update_all_members_settings_async(
- session, org_id, member_settings
- )
- await session.commit()
-
- # Assert - Only 2 vars should remain, VAR3 should NOT be resurrected
- async with async_session_maker() as session:
- from sqlalchemy import select
-
- result = await session.execute(
- select(OrgMember).filter(OrgMember.org_id == org_id)
- )
- member = result.scalars().first()
-
- acp_env = member.agent_settings_diff.get('acp_env', {})
- assert len(acp_env) == 2, f'Expected 2 vars, got {len(acp_env)}'
- assert 'VAR1' in acp_env
- assert 'VAR2' in acp_env
- assert 'VAR3' not in acp_env, 'Deleted var was resurrected by deep_merge'
-
-
@pytest.mark.asyncio
async def test_update_all_members_settings_async_mcp_config_not_in_payload(
async_session_maker,
@@ -1706,77 +1628,6 @@ async def test_update_all_members_settings_async_acp_env_not_in_payload(
assert 'API_TOKEN' in acp_env
-async def test_update_all_members_settings_async_empty_acp_env(
- async_session_maker,
-):
- """
- GIVEN: Organization members with existing acp_env
- WHEN: update_all_members_settings_async is called with empty acp_env
- THEN: acp_env should be cleared (all vars deleted)
-
- This tests the case where user deletes ALL env vars.
- """
- from server.routes.org_models import OrgMemberSettingsUpdate
-
- # Arrange - Create org with member that has env vars
- async with async_session_maker() as session:
- org = Org(name='test-org')
- session.add(org)
- await session.flush()
-
- role = Role(name='member', rank=2)
- session.add(role)
- await session.flush()
-
- user = User(id=uuid.uuid4(), current_org_id=org.id, email='[email protected]')
- session.add(user)
- await session.flush()
-
- org_member = OrgMember(
- org_id=org.id,
- user_id=user.id,
- role_id=role.id,
- llm_api_key='test-key',
- agent_settings_diff={
- 'acp_env': {
- 'VAR1': 'value1',
- 'VAR2': 'value2',
- 'VAR3': 'value3',
- },
- },
- status='active',
- )
- session.add(org_member)
- await session.commit()
- org_id = org.id
-
- # Act - Update with empty acp_env (delete all vars)
- member_settings = OrgMemberSettingsUpdate(
- agent_settings_diff={
- 'acp_env': {}, # Empty - all vars deleted
- },
- )
-
- async with async_session_maker() as session:
- await OrgMemberStore.update_all_members_settings_async(
- session, org_id, member_settings
- )
- await session.commit()
-
- # Assert - acp_env should be empty
- async with async_session_maker() as session:
- from sqlalchemy import select
-
- result = await session.execute(
- select(OrgMember).filter(OrgMember.org_id == org_id)
- )
- member = result.scalars().first()
-
- acp_env = member.agent_settings_diff.get('acp_env', {})
- assert len(acp_env) == 0, f'Expected 0 vars, got {len(acp_env)}'
-
-
@pytest.mark.asyncio
async def test_update_all_members_settings_async_add_first_acp_env_var(
async_session_maker,
diff --git a/openhands/app_server/app_conversation/live_status_app_conversation_service.py b/openhands/app_server/app_conversation/live_status_app_conversation_service.py
index 41f354cf7e..4a051e056a 100644
--- a/openhands/app_server/app_conversation/live_status_app_conversation_service.py
+++ b/openhands/app_server/app_conversation/live_status_app_conversation_service.py
@@ -1593,20 +1593,11 @@ class LiveStatusAppConversationService(AppConversationServiceBase):
) -> StartConversationRequest:
"""Build a StartConversationRequest for ACP agent conversations.
- Unlike the LLM path, ACP agents run as separate subprocesses; the
- provider credentials reach the subprocess as environment variables
- rather than via an injected LLM object.
-
- Both the provider credentials (the UI-saved ``llm.api_key`` /
- ``base_url``, keyed by the provider's env-var names) and user secrets
- (Secrets panel + git provider tokens) flow through the single
- ``AgentContext.secrets`` channel: their names are rendered into the
- ACP prompt as a ``<CUSTOM_SECRETS>`` block, and the SDK's
- ``ACPAgent._start_acp_server`` gap-fills the values into the subprocess
- env at launch. Routing the provider creds this way keeps them on the
- cipher-protected ``request.secrets`` boundary instead of the
- deprecated, persist-unsafe ``acp_env`` channel (software-agent-sdk
- #3464; OpenHands/agent-canvas#1039).
+ Provider creds (``llm.api_key`` / ``base_url``) and user secrets both
+ flow through ``AgentContext.secrets``. ``acp_settings.create_agent()``
+ folds the provider creds (keyed by env-var name, sdk#3464) into
+ ``agent_context.secrets``; the SDK gap-fills them into the subprocess
+ env at launch.
Args:
sandbox: Sandbox information
@@ -1644,36 +1635,13 @@ class LiveStatusAppConversationService(AppConversationServiceBase):
acp_settings = user.agent_settings # already verified to be ACPAgentSettings
assert isinstance(acp_settings, ACPAgentSettings)
- # Route the ACP provider credentials (the UI-saved ``llm.api_key`` /
- # ``base_url``) through the cipher-protected ``agent_context.secrets``
- # channel β€” keyed by the provider's expected env-var names β€” instead
- # of ``acp_env``. ``acp_env`` is a parallel, persist-unsafe credential
- # channel the SDK has deprecated (software-agent-sdk #3464). Provider
- # creds override a same-named Secrets-panel entry, preserving the prior
- # ``provider env > panel secret`` priority. See
- # OpenHands/agent-canvas#1039.
- provider_env = acp_settings.resolve_provider_env()
- for env_name, env_value in provider_env.items():
- secrets[env_name] = StaticSecret(value=SecretStr(env_value))
-
- # Pass secrets via AgentContext. The SDK renders the names as a
- # <CUSTOM_SECRETS> block in the ACP prompt and
- # ``ACPAgent._start_acp_server`` gap-fills any not already in the
- # subprocess env at launch time, delivering the provider creds. We
- # pass ``SecretSource`` objects verbatim; resolving them here (with
- # ``source.get_value()``) would eagerly hit the auth service for every
- # ``LookupSecret`` on every conversation start, from the wrong process.
+ # acp_settings.create_agent() folds provider creds into agent_context.secrets
+ # (sdk#3464). Pass SecretSource objects verbatim β€” the SDK resolves them
+ # at subprocess launch, not here, to avoid eager LookupSecret calls.
agent_context = AgentContext(secrets=secrets) if secrets else None
- settings_update: dict[str, object] = {}
- if agent_context is not None:
- settings_update['agent_context'] = agent_context
- # Strip the provider creds off the (dummy) ACP ``llm`` so
- # ``create_agent()`` does not re-fold them into ``acp_env`` via
- # ``resolve_provider_env``.
- if provider_env:
- settings_update['llm'] = acp_settings.llm.model_copy(
- update={'api_key': None, 'base_url': None}
- )
+ settings_update = (
+ {'agent_context': agent_context} if agent_context is not None else {}
+ )
acp_agent = acp_settings.model_copy(update=settings_update).create_agent()
sdk_plugins: list[PluginSource] | None = None
diff --git a/openhands/app_server/settings/settings_models.py b/openhands/app_server/settings/settings_models.py
index 9b0627e3ad..687a79438f 100644
--- a/openhands/app_server/settings/settings_models.py
+++ b/openhands/app_server/settings/settings_models.py
@@ -208,11 +208,6 @@ class Settings(BaseModel):
replace_mcp_config = 'mcp_config' in agent_update
mcp_config = coerced.pop('mcp_config', None) if replace_mcp_config else None
- # acp_env is a flat credential dict that should be replaced wholesale
- # when present; deep-merging would make removed keys persist across saves.
- replace_acp_env = 'acp_env' in agent_update
- acp_env = coerced.pop('acp_env', None) if replace_acp_env else None
-
new_kind = coerced.get('agent_kind')
current_kind = self.agent_settings.agent_kind
@@ -233,8 +228,6 @@ class Settings(BaseModel):
merged = deep_merge(base, coerced)
if replace_mcp_config:
merged['mcp_config'] = mcp_config
- if replace_acp_env:
- merged['acp_env'] = acp_env or {}
# Use object.__setattr__ to avoid validate_assignment
# side-effects on other fields.
diff --git a/openhands/app_server/utils/jsonpatch_compat.py b/openhands/app_server/utils/jsonpatch_compat.py
index 0136afc215..d1afe729ca 100644
--- a/openhands/app_server/utils/jsonpatch_compat.py
+++ b/openhands/app_server/utils/jsonpatch_compat.py
@@ -4,7 +4,7 @@ from typing import Any
# Keys that should be replaced wholesale (not deep merged) because they
# represent sets of items where merging would resurrect deleted entries.
-WHOLESALE_REPLACEMENT_KEYS: frozenset[str] = frozenset({'mcp_config', 'acp_env'})
+WHOLESALE_REPLACEMENT_KEYS: frozenset[str] = frozenset({'mcp_config'})
def deep_merge(
@@ -35,8 +35,8 @@ def deep_merge_with_wholesale_keys(
) -> dict[str, Any]:
"""Like deep_merge, but specified keys are replaced wholesale (not merged).
- Useful for keys like 'mcp_config' and 'acp_env' where the dict represents
- a set of items and deep merging would resurrect deleted items.
+ Useful for keys like 'mcp_config' where the dict represents a set of items
+ and deep merging would resurrect deleted items.
Args:
base: The base dictionary to merge into.
diff --git a/tests/unit/app_server/test_live_status_app_conversation_service.py b/tests/unit/app_server/test_live_status_app_conversation_service.py
index 7b5313a4b8..ba1e029c41 100644
--- a/tests/unit/app_server/test_live_status_app_conversation_service.py
+++ b/tests/unit/app_server/test_live_status_app_conversation_service.py
@@ -3338,25 +3338,14 @@ class TestBuildAcpStartConversationRequestSecrets:
@pytest.mark.asyncio
async def test_provider_env_in_agent_context_not_acp_env(self, service, tmp_path):
- """LLM credentials land in agent_context.secrets, never acp_env.
-
- The provider cred (from ``llm.api_key``) overrides a same-named
- Secrets-panel entry, preserving the prior ``provider env > panel``
- priority β€” now expressed within the single ``agent_context.secrets``
- channel rather than across ``acp_env`` vs ``agent_context``.
- """
+ """Provider cred lands in agent_context.secrets, not acp_env."""
user = self._make_acp_user(acp_server='claude-code', api_key='sk-ui-key')
- panel_secret = StaticSecret(value=SecretStr('sk-from-secrets-panel'))
- service._setup_secrets_for_git_providers = AsyncMock(
- return_value={'ANTHROPIC_API_KEY': panel_secret}
- )
+ service._setup_secrets_for_git_providers = AsyncMock(return_value={})
request = await self._call_build(service, user, tmp_path)
- # Provider creds no longer ride acp_env.
assert request.agent.acp_env.get('ANTHROPIC_API_KEY') is None
assert request.agent.agent_context is not None
- # Provider env wins over the same-named panel secret.
assert (
request.agent.agent_context.secrets.get('ANTHROPIC_API_KEY').get_value()
== 'sk-ui-key'
@@ -3374,14 +3363,7 @@ class TestBuildAcpStartConversationRequestSecrets:
@pytest.mark.asyncio
async def test_acp_env_overrides_provider_env(self, service, tmp_path):
- """Explicit acp_env entries take priority over the provider cred.
-
- When a user sets ANTHROPIC_API_KEY explicitly in acp_env, it must win
- over the key the SDK derives from the UI-saved LLM credentials. The
- provider cred now rides ``agent_context.secrets`` (not ``acp_env``);
- the SDK's launch-time precedence is ``acp_env > agent_context.secrets``,
- so the explicit ``acp_env`` entry still wins.
- """
+ """Explicit acp_env entry beats the provider cred (acp_env > agent_context.secrets at launch)."""
user = self._make_acp_user(
acp_server='claude-code',
acp_env={'ANTHROPIC_API_KEY': 'sk-explicit-override'},
@@ -3391,11 +3373,8 @@ class TestBuildAcpStartConversationRequestSecrets:
request = await self._call_build(service, user, tmp_path)
- # The user's explicit acp_env entry is preserved verbatim; the provider
- # cred is NOT folded into acp_env.
assert request.agent.acp_env.get('ANTHROPIC_API_KEY') == 'sk-explicit-override'
- # The provider cred lands in agent_context.secrets; the SDK gap-fill
- # then defers to the higher-precedence acp_env entry at launch.
+ # Provider cred still lands in agent_context.secrets; acp_env wins at launch.
assert request.agent.agent_context is not None
assert (
request.agent.agent_context.secrets.get('ANTHROPIC_API_KEY').get_value()
@@ -3404,15 +3383,7 @@ class TestBuildAcpStartConversationRequestSecrets:
@pytest.mark.asyncio
async def test_secrets_forwarded_via_agent_context(self, service, tmp_path):
- """Panel secrets flow through ``agent_context.secrets`` only.
-
- The SDK's ``ACPAgent._start_acp_server`` gap-fills ``agent_context.secrets``
- into the subprocess env at launch time. Pre-resolving here would
- eagerly hit external auth services (e.g. ``LookupSecret``) on every
- conversation start from the wrong process, so we forward the
- ``SecretSource`` objects untouched and let the SDK resolve them
- at the right boundary.
- """
+ """Panel secrets flow through agent_context.secrets; not pre-resolved into acp_env."""
gh_secret = StaticSecret(value=SecretStr('ghp_test123'))
user = self._make_acp_user()
service._setup_secrets_for_git_providers = AsyncMock(
@@ -3421,20 +3392,18 @@ class TestBuildAcpStartConversationRequestSecrets:
request = await self._call_build(service, user, tmp_path)
- # NOT pre-resolved into acp_env β€” the SDK does that at subprocess start.
assert request.agent.acp_env.get('GH_TOKEN') is None
- # Surfaced as a SecretSource in agent_context.
assert request.agent.agent_context is not None
assert request.agent.agent_context.secrets.get('GH_TOKEN') is gh_secret
@pytest.mark.asyncio
- async def test_panel_secret_does_not_override_provider_env(self, service, tmp_path):
- """Provider env (from ``llm.api_key``) keeps priority over panel secrets.
+ async def test_panel_secret_overrides_provider_env_when_conflicting(
+ self, service, tmp_path
+ ):
+ """Panel secret beats provider-derived cred when both name the same key.
- If a user has both a UI-saved Claude Code LLM key AND a same-named
- ``ANTHROPIC_API_KEY`` in the Secrets panel, the LLM-saved one wins.
- Both now ride ``agent_context.secrets`` (not ``acp_env``); the provider
- cred is folded in last so it overrides the panel entry of the same name.
+ SDK merge order: {**provider_secrets, **existing} β†’ existing (panel) wins.
+ Priority is now panel > provider, reversed from the old workaround.
"""
user = self._make_acp_user(acp_server='claude-code', api_key='sk-ui-key')
panel_secret = StaticSecret(value=SecretStr('sk-from-secrets-panel'))
@@ -3444,13 +3413,11 @@ class TestBuildAcpStartConversationRequestSecrets:
request = await self._call_build(service, user, tmp_path)
- # Provider creds no longer ride acp_env.
assert request.agent.acp_env.get('ANTHROPIC_API_KEY') is None
- # The provider cred overrides the same-named panel secret.
assert request.agent.agent_context is not None
assert (
request.agent.agent_context.secrets.get('ANTHROPIC_API_KEY').get_value()
- == 'sk-ui-key'
+ == 'sk-from-secrets-panel'
)
@pytest.mark.asyncio
diff --git a/tests/unit/app_server/test_settings_agent_kind_switch.py b/tests/unit/app_server/test_settings_agent_kind_switch.py
index 636eadfab7..a7ca31f771 100644
--- a/tests/unit/app_server/test_settings_agent_kind_switch.py
+++ b/tests/unit/app_server/test_settings_agent_kind_switch.py
@@ -18,8 +18,6 @@ from openhands.app_server.settings.settings_models import Settings
def _set_acp(
command: list[str] | None = None,
- *,
- acp_env: dict | None = None,
) -> dict:
return {
'agent_settings_diff': {
@@ -27,7 +25,6 @@ def _set_acp(
'acp_command': command
or ['npx', '-y', '@agentclientprotocol/claude-agent-acp'],
'acp_args': [],
- **({'acp_env': acp_env} if acp_env is not None else {}),
}
}
@@ -79,21 +76,6 @@ def test_kind_switch_resets_new_kind_to_defaults():
assert s.agent_settings.llm.model != 'anthropic/claude-sonnet-4-5'
-def test_acp_env_replaced_wholesale():
- """``acp_env`` is replaced wholesale (not deep-merged) so removed keys
- don't leak across saves.
-
- This is independent of the kind switch: any ``acp_env`` in the update
- payload replaces the stored dict in full.
- """
- s = Settings()
- s.update(_set_acp(acp_env={'FOO': '1', 'BAR': '2'}))
- assert s.agent_settings.acp_env == {'FOO': '1', 'BAR': '2'}
-
- s.update({'agent_settings_diff': {'acp_env': {'FOO': '9'}}})
- assert s.agent_settings.acp_env == {'FOO': '9'}
-
-
def test_kind_switch_with_inline_field_override():
"""An ``agent_kind`` switch alongside other fields in the same payload
must apply those fields on top of the fresh base.
diff --git a/tests/unit/app_server/utils/test_jsonpatch_compat.py b/tests/unit/app_server/utils/test_jsonpatch_compat.py
index 0afc41b4cf..680413aecf 100644
--- a/tests/unit/app_server/utils/test_jsonpatch_compat.py
+++ b/tests/unit/app_server/utils/test_jsonpatch_compat.py
@@ -39,9 +39,9 @@ class TestDeepMergeWithWholesaleKeys:
"""Tests for deep_merge_with_wholesale_keys function."""
def test_default_wholesale_keys(self):
- """Verify default wholesale keys are mcp_config and acp_env."""
+ """Verify default wholesale keys include mcp_config."""
assert 'mcp_config' in WHOLESALE_REPLACEMENT_KEYS
- assert 'acp_env' in WHOLESALE_REPLACEMENT_KEYS
+ assert 'acp_env' not in WHOLESALE_REPLACEMENT_KEYS
def test_mcp_config_replaced_wholesale(self):
"""mcp_config should be replaced, not merged."""
@@ -71,28 +71,6 @@ class TestDeepMergeWithWholesaleKeys:
assert len(result['mcp_config']['mcpServers']) == 2
assert 'server3' not in result['mcp_config']['mcpServers']
- def test_acp_env_replaced_wholesale(self):
- """acp_env should be replaced, not merged."""
- base = {
- 'acp_env': {
- 'VAR1': 'value1',
- 'VAR2': 'value2',
- 'VAR3': 'value3',
- }
- }
- updates = {
- 'acp_env': {
- 'VAR1': 'value1',
- 'VAR2': 'value2',
- # VAR3 deleted
- }
- }
-
- result = deep_merge_with_wholesale_keys(base, updates)
-
- assert len(result['acp_env']) == 2
- assert 'VAR3' not in result['acp_env']
-
def test_other_keys_still_deep_merged(self):
"""Non-wholesale keys should still be deep merged."""
base = {