π OpenHands: AI-Driven Development
Fix dictionary changed size during iteration error in override_provider_tokens_with_custom_secret (#9728)
Graham Neubig4c10848e8db6
diff --git a/openhands/server/session/agent_session.py b/openhands/server/session/agent_session.pyindex b4212ddc39..8dff8a2924 100644--- a/openhands/server/session/agent_session.py+++ b/openhands/server/session/agent_session.py@@ -290,12 +290,16 @@ class AgentSession:custom_secrets: CUSTOM_SECRETS_TYPE | None,):if git_provider_tokens and custom_secrets:- tokens = dict(git_provider_tokens)- for provider, _ in tokens.items():- token_name = ProviderHandler.get_provider_env_key(provider)- if token_name in custom_secrets or token_name.upper() in custom_secrets:- del tokens[provider]-+ # Use dictionary comprehension to avoid modifying dictionary during iteration+ tokens = {+ provider: token+ for provider, token in git_provider_tokens.items()+ if not (+ ProviderHandler.get_provider_env_key(provider) in custom_secrets+ or ProviderHandler.get_provider_env_key(provider).upper()+ in custom_secrets+ )+ }return MappingProxyType(tokens)return git_provider_tokensdiff --git a/tests/unit/test_agent_session.py b/tests/unit/test_agent_session.pyindex 5170fe2db7..673add1da4 100644--- a/tests/unit/test_agent_session.py+++ b/tests/unit/test_agent_session.py@@ -8,6 +8,7 @@ from openhands.controller.state.state import Statefrom openhands.core.config import LLMConfig, OpenHandsConfigfrom openhands.core.config.agent_config import AgentConfigfrom openhands.events import EventStream, EventStreamSubscriber+from openhands.integrations.service_types import ProviderTypefrom openhands.llm import LLMfrom openhands.llm.metrics import Metricsfrom openhands.memory.memory import Memory@@ -402,3 +403,45 @@ async def test_budget_control_flag_syncs_with_metrics(mock_agent):# Budget control flag should still reflect the accumulated cost after resetassert session.controller.state.budget_flag.current_value == test_cost + 0.1+++def test_override_provider_tokens_with_custom_secret():+ """Test that override_provider_tokens_with_custom_secret works correctly.++ This test verifies that the method properly removes provider tokens when+ corresponding custom secrets exist, without causing the 'dictionary changed+ size during iteration' error that occurred before the fix.+ """+ # Setup+ file_store = InMemoryFileStore({})+ session = AgentSession(+ sid='test-session',+ file_store=file_store,+ )++ # Create test data+ git_provider_tokens = {+ ProviderType.GITHUB: 'github_token_123',+ ProviderType.GITLAB: 'gitlab_token_456',+ ProviderType.BITBUCKET: 'bitbucket_token_789',+ }++ # Custom secrets that will cause some providers to be removed+ # Tests both lowercase and uppercase variants to ensure comprehensive coverage+ custom_secrets = {+ 'github_token': 'custom_github_token',+ 'GITLAB_TOKEN': 'custom_gitlab_token',+ }++ # This should work without raising RuntimeError: dictionary changed size during iteration+ result = session.override_provider_tokens_with_custom_secret(+ git_provider_tokens, custom_secrets+ )++ # Verify that GitHub and GitLab tokens were removed (they have custom secrets)+ assert ProviderType.GITHUB not in result+ assert ProviderType.GITLAB not in result++ # Verify that Bitbucket token remains (no custom secret for it)+ assert ProviderType.BITBUCKET in result+ assert result[ProviderType.BITBUCKET] == 'bitbucket_token_789'