π OpenHands: AI-Driven Development
Refactor LiteLLM key updates to use generic user key API (#12664)
Tim O'Farrell9fb9efd3d22e
diff --git a/enterprise/downgrade_migrated_users.py b/enterprise/downgrade_migrated_users.pyindex 8c031bb112..a9798476bc 100644--- a/enterprise/downgrade_migrated_users.py+++ b/enterprise/downgrade_migrated_users.py@@ -1,5 +1,7 @@#!/usr/bin/env python"""+This script can be removed once orgs is established - probably after Feb 15 2026+Downgrade script for migrated users.This script identifies users who have been migrated (already_migrated=True)diff --git a/enterprise/storage/lite_llm_manager.py b/enterprise/storage/lite_llm_manager.pyindex 47f83506b0..af458ef75e 100644--- a/enterprise/storage/lite_llm_manager.py+++ b/enterprise/storage/lite_llm_manager.py@@ -166,29 +166,60 @@ class LiteLlmManager:client, keycloak_user_id, org_id, credits)- if user_settings.llm_api_key:- logger.debug(- 'LiteLlmManager:migrate_lite_llm_entries:update_key',- extra={'org_id': org_id, 'user_id': keycloak_user_id},- )- await LiteLlmManager._update_key(- client,- keycloak_user_id,- user_settings.llm_api_key,- team_id=org_id,- )+ logger.debug(+ 'LiteLlmManager:migrate_lite_llm_entries:update_user_keys',+ extra={'org_id': org_id, 'user_id': keycloak_user_id},+ )+ await LiteLlmManager._update_user_keys(+ client,+ keycloak_user_id,+ team_id=org_id,+ )- if user_settings.llm_api_key_for_byor:- logger.debug(- 'LiteLlmManager:migrate_lite_llm_entries:update_byor_key',- extra={'org_id': org_id, 'user_id': keycloak_user_id},- )- await LiteLlmManager._update_key(- client,- keycloak_user_id,- user_settings.llm_api_key_for_byor,- team_id=org_id,+ # Check if the database key exists in LiteLLM+ # If not, generate a new key to prevent verification failures later+ db_key = None+ if (+ user_settings+ and user_settings.llm_api_key+ and user_settings.llm_base_url == LITE_LLM_API_URL+ ):+ db_key = user_settings.llm_api_key+ if hasattr(db_key, 'get_secret_value'):+ db_key = db_key.get_secret_value()++ if db_key:+ # Verify the database key exists in LiteLLM+ key_valid = await LiteLlmManager.verify_key(+ db_key, keycloak_user_id)+ if not key_valid:+ logger.warning(+ 'LiteLlmManager:migrate_lite_llm_entries:db_key_not_in_litellm',+ extra={+ 'org_id': org_id,+ 'user_id': keycloak_user_id,+ 'key_prefix': db_key[:10] + '...'+ if len(db_key) > 10+ else db_key,+ },+ )+ # Generate a new key for the user+ new_key = await LiteLlmManager._generate_key(+ client,+ keycloak_user_id,+ org_id,+ f'OpenHands Cloud - user {keycloak_user_id} - org {org_id}',+ None,+ )+ if new_key:+ logger.info(+ 'LiteLlmManager:migrate_lite_llm_entries:generated_new_key',+ extra={'org_id': org_id, 'user_id': keycloak_user_id},+ )+ # Update user_settings with the new key so it gets stored in org_member+ user_settings.llm_api_key = SecretStr(new_key)+ user_settings.llm_api_key_for_byor = SecretStr(new_key)logger.info('LiteLlmManager:migrate_lite_llm_entries:complete',@@ -306,30 +337,16 @@ class LiteLlmManager:client, keycloak_user_id, LITE_LLM_TEAM_ID, restored_budget)- # Step 4: Update keys to remove org team association (set team_id to default)- if user_settings.llm_api_key:- logger.debug(- 'LiteLlmManager:downgrade_entries:update_key',- extra={'org_id': org_id, 'user_id': keycloak_user_id},- )- await LiteLlmManager._update_key(- client,- keycloak_user_id,- user_settings.llm_api_key,- team_id=LITE_LLM_TEAM_ID,- )-- if user_settings.llm_api_key_for_byor:- logger.debug(- 'LiteLlmManager:downgrade_entries:update_byor_key',- extra={'org_id': org_id, 'user_id': keycloak_user_id},- )- await LiteLlmManager._update_key(- client,- keycloak_user_id,- user_settings.llm_api_key_for_byor,- team_id=LITE_LLM_TEAM_ID,- )+ # Step 4: Update all user keys to remove org team association (set team_id to default)+ logger.debug(+ 'LiteLlmManager:downgrade_entries:update_user_keys',+ extra={'org_id': org_id, 'user_id': keycloak_user_id},+ )+ await LiteLlmManager._update_user_keys(+ client,+ keycloak_user_id,+ team_id=LITE_LLM_TEAM_ID,+ )# Step 5: Remove user from their org teamlogger.debug(@@ -643,6 +660,77 @@ class LiteLlmManager:)response.raise_for_status()+ @staticmethod+ async def _get_user_keys(+ client: httpx.AsyncClient,+ keycloak_user_id: str,+ ) -> list[str]:+ """Get all keys for a user from LiteLLM.++ Args:+ client: The HTTP client to use for the request+ keycloak_user_id: The user's Keycloak ID++ Returns:+ A list of key strings belonging to the user+ """+ if LITE_LLM_API_KEY is None or LITE_LLM_API_URL is None:+ logger.warning('LiteLLM API configuration not found')+ return []++ response = await client.get(+ f'{LITE_LLM_API_URL}/key/list',+ params={'user_id': keycloak_user_id},+ )++ if not response.is_success:+ logger.error(+ 'error_getting_user_keys',+ extra={+ 'status_code': response.status_code,+ 'text': response.text,+ 'user_id': keycloak_user_id,+ },+ )+ return []++ response_json = response.json()+ keys = response_json.get('keys', [])+ logger.debug(+ 'LiteLlmManager:_get_user_keys:keys_retrieved',+ extra={+ 'user_id': keycloak_user_id,+ 'key_count': len(keys),+ },+ )+ return keys++ @staticmethod+ async def _update_user_keys(+ client: httpx.AsyncClient,+ keycloak_user_id: str,+ **kwargs,+ ):+ """Update all keys belonging to a user with the given parameters.++ Args:+ client: The HTTP client to use for the request+ keycloak_user_id: The user's Keycloak ID+ **kwargs: Parameters to update on each key (e.g., team_id)+ """+ keys = await LiteLlmManager._get_user_keys(client, keycloak_user_id)++ logger.debug(+ 'LiteLlmManager:_update_user_keys:updating_keys',+ extra={+ 'user_id': keycloak_user_id,+ 'key_count': len(keys),+ },+ )++ for key in keys:+ await LiteLlmManager._update_key(client, keycloak_user_id, key, **kwargs)+@staticmethodasync def _delete_user(client: httpx.AsyncClient,@@ -1091,3 +1179,5 @@ class LiteLlmManager:generate_key = staticmethod(with_http_client(_generate_key))get_key_info = staticmethod(with_http_client(_get_key_info))delete_key = staticmethod(with_http_client(_delete_key))+ get_user_keys = staticmethod(with_http_client(_get_user_keys))+ update_user_keys = staticmethod(with_http_client(_update_user_keys))diff --git a/enterprise/storage/saas_settings_store.py b/enterprise/storage/saas_settings_store.pyindex a1b91ca14a..f5be546be9 100644--- a/enterprise/storage/saas_settings_store.py+++ b/enterprise/storage/saas_settings_store.py@@ -230,10 +230,19 @@ class SaasSettingsStore(SettingsStore):async def _ensure_openhands_api_key(self, item: Settings, org_id: str) -> None:"""Generate and set the OpenHands API key for the given settings.- First checks if an existing key with the OpenHands alias exists,- and reuses it if found. Otherwise, generates a new key.+ First checks if an existing key exists for the user and reuses it+ if found. Otherwise, generates a new key."""- # Generate new key if none exists+ # Check if user already has keys in LiteLLM+ existing_keys = await LiteLlmManager.get_user_keys(self.user_id)+ if existing_keys:+ logger.info(+ 'saas_settings_store:store:user_already_has_keys',+ extra={'user_id': self.user_id, 'key_count': len(existing_keys)},+ )+ return++ # Generate new key only if none existsgenerated_key = await LiteLlmManager.generate_key(self.user_id,org_id,diff --git a/enterprise/storage/user_store.py b/enterprise/storage/user_store.pyindex 64df958e5b..130ffe7679 100644--- a/enterprise/storage/user_store.py+++ b/enterprise/storage/user_store.py@@ -354,7 +354,9 @@ class UserStore:@staticmethodasync def downgrade_user(user_id: str) -> UserSettings | None:- """Downgrade a migrated user back to the pre-migration state.+ """+ This method can be removed once orgs is established - probably after Feb 15 2026+ Downgrade a migrated user back to the pre-migration state.This reverses the migrate_user operation:1. Get the user's settings from user_settings table (migrated users) or@@ -408,6 +410,24 @@ class UserStore:)return None+ # Get org_members for this org - should only be one for personal orgs+ org_members = (+ session.query(OrgMember).filter(OrgMember.org_id == org.id).all()+ )++ if len(org_members) != 1:+ logger.error(+ 'user_store:downgrade_user:unexpected_org_members_count',+ extra={+ 'user_id': user_id,+ 'org_id': str(org.id),+ 'org_members_count': len(org_members),+ },+ )+ return None++ org_member = org_members[0]+# Get the user_settings (for migrated users)user_settings = (session.query(UserSettings)@@ -420,40 +440,34 @@ class UserStore:# For new sign-ups after migration, user_settings won't exist# Fall back to getting data from org_members- if not user_settings:+ if user_settings:+ if org_member.llm_api_key and org_member.llm_api_key.get_secret_value():+ user_settings.llm_api_key = encrypt_legacy_value(+ org_member.llm_api_key.get_secret_value()+ )+ if (+ org_member.llm_api_key_for_byor+ and org_member.llm_api_key_for_byor.get_secret_value()+ ):+ user_settings.llm_api_key_for_byor = encrypt_legacy_value(+ org_member.llm_api_key_for_byor.get_secret_value()+ )logger.info(- 'user_store:downgrade_user:user_settings_not_found_checking_org_members',+ 'user_store:downgrade_user:updated_user_settings_from_org_member',extra={'user_id': user_id},)- # Get org_members for this org - should only be one for personal orgs- org_members = (- session.query(OrgMember).filter(OrgMember.org_id == org.id).all()- )-- if len(org_members) != 1:- logger.error(- 'user_store:downgrade_user:unexpected_org_members_count',- extra={- 'user_id': user_id,- 'org_id': str(org.id),- 'org_members_count': len(org_members),- },- )- return None-- org_member = org_members[0]-+ else:# Create a new user_settings entry from OrgMember, User, and Org data# This is needed for new sign-ups who don't have user_settingsuser_settings = UserStore._create_user_settings_from_entities(user_id, org_member, user, org)session.add(user_settings)- session.flush()logger.info('user_store:downgrade_user:created_user_settings_from_org_member',extra={'user_id': user_id},)+ session.flush()# Call LiteLLM downgradefrom storage.lite_llm_manager import LiteLlmManagerdiff --git a/enterprise/tests/unit/test_lite_llm_manager.py b/enterprise/tests/unit/test_lite_llm_manager.pyindex 91b4770f3f..7ad9986242 100644--- a/enterprise/tests/unit/test_lite_llm_manager.py+++ b/enterprise/tests/unit/test_lite_llm_manager.py@@ -284,6 +284,16 @@ class TestLiteLlmManager:self, mock_user_settings, mock_user_response, mock_response):"""Test successful migrate_entries operation."""+ # Mock response for key list+ mock_key_list_response = MagicMock()+ mock_key_list_response.is_success = True+ mock_key_list_response.status_code = 200+ mock_key_list_response.json.return_value = {+ 'keys': ['test-key-1', 'test-key-2'],+ 'total_count': 2,+ }+ mock_key_list_response.raise_for_status = MagicMock()+with patch.dict(os.environ, {'LOCAL_DEPLOYMENT': ''}):with patch('storage.lite_llm_manager.LITE_LLM_API_KEY', 'test-key'):with patch(@@ -301,14 +311,22 @@ class TestLiteLlmManager:mock_client_class.return_value.__aenter__.return_value = (mock_client)- mock_client.get.return_value = mock_user_response+ # First GET is for _get_user, second GET is for _get_user_keys+ mock_client.get.side_effect = [+ mock_user_response,+ mock_key_list_response,+ ]mock_client.post.return_value = mock_response- result = await LiteLlmManager.migrate_entries(- 'test-org-id',- 'test-user-id',- mock_user_settings,- )+ # Mock verify_key to return True (key exists in LiteLLM)+ with patch.object(+ LiteLlmManager, 'verify_key', return_value=True+ ):+ result = await LiteLlmManager.migrate_entries(+ 'test-org-id',+ 'test-user-id',+ mock_user_settings,+ )# migrate_entries returns the user_settings unchangedassert result is not None@@ -317,10 +335,97 @@ class TestLiteLlmManager:assert result.llm_api_key.get_secret_value() == 'test-key'assert result.llm_base_url == 'http://test.com'- # Verify migration steps were called+ # Verify migration steps were called:+ # - 2 GET requests: _get_user, _get_user_keys+ # - POST requests: create_team, update_user, add_user_to_team,+ # and update_key for each key (2 keys)+ assert mock_client.get.call_count == 2+ assert (+ mock_client.post.call_count == 5+ ) # create_team, update_user, add_user_to_team, 2x update_key++ @pytest.mark.asyncio+ async def test_migrate_entries_generates_key_when_db_key_not_in_litellm(+ self, mock_user_settings, mock_user_response, mock_response+ ):+ """Test migrate_entries generates a new key when the DB key doesn't exist in LiteLLM."""+ # Mock response for key list+ mock_key_list_response = MagicMock()+ mock_key_list_response.is_success = True+ mock_key_list_response.status_code = 200+ mock_key_list_response.json.return_value = {+ 'keys': ['test-key-1', 'test-key-2'],+ 'total_count': 2,+ }+ mock_key_list_response.raise_for_status = MagicMock()++ # Mock response for key generation+ mock_generate_response = MagicMock()+ mock_generate_response.is_success = True+ mock_generate_response.status_code = 200+ mock_generate_response.json.return_value = {'key': 'new-generated-key'}+ mock_generate_response.raise_for_status = MagicMock()++ with patch.dict(os.environ, {'LOCAL_DEPLOYMENT': ''}):+ with patch('storage.lite_llm_manager.LITE_LLM_API_KEY', 'test-key'):+ with patch(+ 'storage.lite_llm_manager.LITE_LLM_API_URL', 'http://test.com'+ ):+ with patch(+ 'storage.lite_llm_manager.TokenManager'+ ) as mock_token_manager:+ mock_token_manager.return_value.get_user_info_from_user_id = (+ AsyncMock(return_value={'email': '[email protected]'})+ )++ with patch('httpx.AsyncClient') as mock_client_class:+ mock_client = AsyncMock()+ mock_client_class.return_value.__aenter__.return_value = (+ mock_client+ )+ # First GET is for _get_user, second GET is for _get_user_keys+ mock_client.get.side_effect = [+ mock_user_response,+ mock_key_list_response,+ ]+ # POST responses: create_team, update_user, add_user_to_team,+ # 2x update_key, and 1x generate_key+ mock_client.post.side_effect = [+ mock_response, # create_team+ mock_response, # update_user+ mock_response, # add_user_to_team+ mock_response, # update_key 1+ mock_response, # update_key 2+ mock_generate_response, # generate_key+ ]++ # Mock verify_key to return False (key doesn't exist in LiteLLM)+ with patch.object(+ LiteLlmManager, 'verify_key', return_value=False+ ):+ result = await LiteLlmManager.migrate_entries(+ 'test-org-id',+ 'test-user-id',+ mock_user_settings,+ )++ # migrate_entries should update user_settings with the new key+ assert result is not Noneassert (- mock_client.post.call_count == 4- ) # create_team, update_user, add_user_to_team, update_key+ result.llm_api_key.get_secret_value()+ == 'new-generated-key'+ )+ assert (+ result.llm_api_key_for_byor.get_secret_value()+ == 'new-generated-key'+ )++ # Verify migration steps were called including key generation:+ # - 2 GET requests: _get_user, _get_user_keys+ # - 6 POST requests: create_team, update_user, add_user_to_team,+ # 2x update_key, 1x generate_key+ assert mock_client.get.call_count == 2+ assert mock_client.post.call_count == 6@pytest.mark.asyncioasync def test_update_team_and_users_budget_missing_config(self):@@ -678,6 +783,133 @@ class TestLiteLlmManager:mock_http_client, 'test-user-id', 'test-api-key', team_id='test-team-id')+ @pytest.mark.asyncio+ @patch('storage.lite_llm_manager.LITE_LLM_API_URL', 'http://test.com')+ @patch('storage.lite_llm_manager.LITE_LLM_API_KEY', 'test-key')+ async def test_get_user_keys_success(self, mock_http_client):+ """Test successful _get_user_keys operation."""+ # Arrange+ mock_response = MagicMock()+ mock_response.is_success = True+ mock_response.status_code = 200+ mock_response.json.return_value = {+ 'keys': ['key-1', 'key-2', 'key-3'],+ 'total_count': 3,+ }+ mock_http_client.get.return_value = mock_response++ # Act+ keys = await LiteLlmManager._get_user_keys(mock_http_client, 'test-user-id')++ # Assert+ assert keys == ['key-1', 'key-2', 'key-3']+ mock_http_client.get.assert_called_once()+ call_args = mock_http_client.get.call_args+ assert 'http://test.com/key/list' in call_args[0]+ assert call_args[1]['params'] == {'user_id': 'test-user-id'}++ @pytest.mark.asyncio+ @patch('storage.lite_llm_manager.LITE_LLM_API_URL', 'http://test.com')+ @patch('storage.lite_llm_manager.LITE_LLM_API_KEY', 'test-key')+ async def test_get_user_keys_empty_list(self, mock_http_client):+ """Test _get_user_keys returns empty list when user has no keys."""+ # Arrange+ mock_response = MagicMock()+ mock_response.is_success = True+ mock_response.status_code = 200+ mock_response.json.return_value = {+ 'keys': [],+ 'total_count': 0,+ }+ mock_http_client.get.return_value = mock_response++ # Act+ keys = await LiteLlmManager._get_user_keys(mock_http_client, 'test-user-id')++ # Assert+ assert keys == []++ @pytest.mark.asyncio+ @patch('storage.lite_llm_manager.LITE_LLM_API_URL', 'http://test.com')+ @patch('storage.lite_llm_manager.LITE_LLM_API_KEY', 'test-key')+ async def test_get_user_keys_error_returns_empty_list(self, mock_http_client):+ """Test _get_user_keys returns empty list on error."""+ # Arrange+ mock_response = MagicMock()+ mock_response.is_success = False+ mock_response.status_code = 500+ mock_response.text = 'Internal server error'+ mock_http_client.get.return_value = mock_response++ # Act+ keys = await LiteLlmManager._get_user_keys(mock_http_client, 'test-user-id')++ # Assert+ assert keys == []++ @pytest.mark.asyncio+ async def test_get_user_keys_missing_config(self, mock_http_client):+ """Test _get_user_keys returns empty list when config is missing."""+ with patch('storage.lite_llm_manager.LITE_LLM_API_KEY', None):+ with patch('storage.lite_llm_manager.LITE_LLM_API_URL', None):+ keys = await LiteLlmManager._get_user_keys(+ mock_http_client, 'test-user-id'+ )+ assert keys == []++ @pytest.mark.asyncio+ @patch('storage.lite_llm_manager.LITE_LLM_API_URL', 'http://test.com')+ @patch('storage.lite_llm_manager.LITE_LLM_API_KEY', 'test-key')+ async def test_update_user_keys_success(self, mock_http_client, mock_response):+ """Test successful _update_user_keys operation."""+ # Arrange+ mock_key_list_response = MagicMock()+ mock_key_list_response.is_success = True+ mock_key_list_response.status_code = 200+ mock_key_list_response.json.return_value = {+ 'keys': ['key-1', 'key-2'],+ 'total_count': 2,+ }+ mock_http_client.get.return_value = mock_key_list_response+ mock_http_client.post.return_value = mock_response++ # Act+ await LiteLlmManager._update_user_keys(+ mock_http_client, 'test-user-id', team_id='test-team-id'+ )++ # Assert+ # Should call GET once for key list+ assert mock_http_client.get.call_count == 1+ # Should call POST twice (once for each key)+ assert mock_http_client.post.call_count == 2++ @pytest.mark.asyncio+ @patch('storage.lite_llm_manager.LITE_LLM_API_URL', 'http://test.com')+ @patch('storage.lite_llm_manager.LITE_LLM_API_KEY', 'test-key')+ async def test_update_user_keys_no_keys(self, mock_http_client, mock_response):+ """Test _update_user_keys when user has no keys."""+ # Arrange+ mock_key_list_response = MagicMock()+ mock_key_list_response.is_success = True+ mock_key_list_response.status_code = 200+ mock_key_list_response.json.return_value = {+ 'keys': [],+ 'total_count': 0,+ }+ mock_http_client.get.return_value = mock_key_list_response++ # Act+ await LiteLlmManager._update_user_keys(+ mock_http_client, 'test-user-id', team_id='test-team-id'+ )++ # Assert+ # Should call GET once for key list+ assert mock_http_client.get.call_count == 1+ # Should not call POST since there are no keys+ assert mock_http_client.post.call_count == 0+@pytest.mark.asyncioasync def test_generate_key_success(self, mock_http_client, mock_response):"""Test successful _generate_key operation."""@@ -1242,6 +1474,15 @@ class TestLiteLlmManager:}mock_team_info_response.raise_for_status = MagicMock()+ mock_key_list_response = MagicMock()+ mock_key_list_response.is_success = True+ mock_key_list_response.status_code = 200+ mock_key_list_response.json.return_value = {+ 'keys': ['test-key-1', 'test-key-2'],+ 'total_count': 2,+ }+ mock_key_list_response.raise_for_status = MagicMock()+with patch.dict(os.environ, {'LOCAL_DEPLOYMENT': ''}):with patch('storage.lite_llm_manager.LITE_LLM_API_KEY', 'test-key'):with patch(@@ -1255,7 +1496,12 @@ class TestLiteLlmManager:mock_client_class.return_value.__aenter__.return_value = (mock_client)- mock_client.get.return_value = mock_team_info_response+ # GET requests: get_team (x2 for team info), get_user_keys+ mock_client.get.side_effect = [+ mock_team_info_response,+ mock_team_info_response,+ mock_key_list_response,+ ]mock_client.post.return_value = mock_responseresult = await LiteLlmManager.downgrade_entries(@@ -1269,15 +1515,19 @@ class TestLiteLlmManager:assert result.agent == 'TestAgent'# Verify downgrade steps were called:+ # GET requests:# 1. get_team (GET)# 2. get_user_team_info (GET via _get_team)- # 3. update_user (POST)- # 4. add_user_to_team (POST)- # 5. update_key (POST)- # 6. remove_user_from_team (POST)- # 7. delete_team (POST)- assert mock_client.get.call_count >= 1- assert mock_client.post.call_count >= 4+ # 3. get_user_keys (GET)+ # POST requests:+ # 1. update_user (POST)+ # 2. add_user_to_team (POST)+ # 3. update_key for key 1 (POST)+ # 4. update_key for key 2 (POST)+ # 5. remove_user_from_team (POST)+ # 6. delete_team (POST)+ assert mock_client.get.call_count == 3+ assert mock_client.post.call_count == 6@pytest.mark.asyncioasync def test_downgrade_entries_local_deployment(self, mock_user_settings):