Skip to content

πŸ™Œ OpenHands: AI-Driven Development

[Refactor]: Add typing expectation in FE for provider tokens (#8203)

Rohit Malhotrae39d904a1fcf
diff --git a/frontend/__tests__/routes/git-settings.test.tsx b/frontend/__tests__/routes/git-settings.test.tsx
index aeb70cb870..b288acc70c 100644
--- a/frontend/__tests__/routes/git-settings.test.tsx
+++ b/frontend/__tests__/routes/git-settings.test.tsx
@@ -245,8 +245,8 @@ describe("Form submission", () => {
expect(saveSettingsSpy).toHaveBeenCalledWith(
expect.objectContaining({
provider_tokens: {
- github: "test-token",
- gitlab: "",
+ github: { token: "test-token" },
+ gitlab: { token: "" },
},
}),
);
@@ -258,8 +258,8 @@ describe("Form submission", () => {
expect(saveSettingsSpy).toHaveBeenCalledWith(
expect.objectContaining({
provider_tokens: {
- github: "",
- gitlab: "test-token",
+ github: { token: "" },
+ gitlab: { token: "test-token" },
},
}),
);
diff --git a/frontend/src/routes/git-settings.tsx b/frontend/src/routes/git-settings.tsx
index 3bcf764f70..8c83ce7071 100644
--- a/frontend/src/routes/git-settings.tsx
+++ b/frontend/src/routes/git-settings.tsx
@@ -51,8 +51,8 @@ function GitSettingsScreen() {
saveSettings(
{
provider_tokens: {
- github: githubToken,
- gitlab: gitlabToken,
+ github: { token: githubToken },
+ gitlab: { token: gitlabToken },
},
},
{
diff --git a/frontend/src/services/settings.ts b/frontend/src/services/settings.ts
index 4121f7e268..7c9592d6cb 100644
--- a/frontend/src/services/settings.ts
+++ b/frontend/src/services/settings.ts
@@ -16,8 +16,8 @@ export const DEFAULT_SETTINGS: Settings = {
ENABLE_SOUND_NOTIFICATIONS: false,
USER_CONSENTS_TO_ANALYTICS: false,
PROVIDER_TOKENS: {
- github: "",
- gitlab: "",
+ github: { token: "" },
+ gitlab: { token: "" },
},
IS_NEW_USER: true,
};
diff --git a/frontend/src/types/settings.ts b/frontend/src/types/settings.ts
index 2464e86743..0c49c56c4a 100644
--- a/frontend/src/types/settings.ts
+++ b/frontend/src/types/settings.ts
@@ -5,6 +5,10 @@ export const ProviderOptions = {
export type Provider = keyof typeof ProviderOptions;
+export type ProviderToken = {
+ token: string;
+};
+
export type Settings = {
LLM_MODEL: string;
LLM_BASE_URL: string;
@@ -18,7 +22,7 @@ export type Settings = {
ENABLE_DEFAULT_CONDENSER: boolean;
ENABLE_SOUND_NOTIFICATIONS: boolean;
USER_CONSENTS_TO_ANALYTICS: boolean | null;
- PROVIDER_TOKENS: Record<Provider, string>;
+ PROVIDER_TOKENS: Record<Provider, ProviderToken>;
IS_NEW_USER?: boolean;
};
@@ -35,17 +39,17 @@ export type ApiSettings = {
enable_default_condenser: boolean;
enable_sound_notifications: boolean;
user_consents_to_analytics: boolean | null;
- provider_tokens: Record<Provider, string>;
+ provider_tokens: Record<Provider, ProviderToken>;
provider_tokens_set: Partial<Record<Provider, string | null>>;
};
export type PostSettings = Settings & {
- provider_tokens: Record<Provider, string>;
+ provider_tokens: Record<Provider, ProviderToken>;
user_consents_to_analytics: boolean | null;
llm_api_key?: string | null;
};
export type PostApiSettings = ApiSettings & {
- provider_tokens: Record<Provider, string>;
+ provider_tokens: Record<Provider, ProviderToken>;
user_consents_to_analytics: boolean | null;
};
diff --git a/frontend/src/utils/settings-utils.ts b/frontend/src/utils/settings-utils.ts
index 70bbb5e43c..b536051810 100644
--- a/frontend/src/utils/settings-utils.ts
+++ b/frontend/src/utils/settings-utils.ts
@@ -1,4 +1,4 @@
-import { Settings } from "#/types/settings";
+import { Provider, ProviderToken, Settings } from "#/types/settings";
const extractBasicFormData = (formData: FormData) => {
const provider = formData.get("llm-provider-input")?.toString();
@@ -64,14 +64,14 @@ export const extractSettings = (
// Extract provider tokens
const githubToken = formData.get("github-token")?.toString();
const gitlabToken = formData.get("gitlab-token")?.toString();
- const providerTokens: Record<string, string> = {};
-
- if (githubToken) {
- providerTokens.github = githubToken;
- }
- if (gitlabToken) {
- providerTokens.gitlab = gitlabToken;
- }
+ const providerTokens: Record<Provider, ProviderToken> = {
+ github: {
+ token: githubToken || "",
+ },
+ gitlab: {
+ token: gitlabToken || "",
+ },
+ };
return {
LLM_MODEL: CUSTOM_LLM_MODEL || LLM_MODEL,
diff --git a/openhands/server/routes/settings.py b/openhands/server/routes/settings.py
index abdf77974f..7b80c60dd7 100644
--- a/openhands/server/routes/settings.py
+++ b/openhands/server/routes/settings.py
@@ -1,11 +1,9 @@
from fastapi import APIRouter, Depends, status
from fastapi.responses import JSONResponse
-from pydantic import SecretStr
from openhands.core.logger import openhands_logger as logger
from openhands.integrations.provider import (
PROVIDER_TOKEN_TYPE,
- ProviderToken,
ProviderType,
SecretStore,
)
@@ -210,20 +208,14 @@ async def reset_settings() -> JSONResponse:
async def check_provider_tokens(settings: POSTSettingsModel) -> str:
if settings.provider_tokens:
- # Remove extraneous token types
- provider_types = [provider.value for provider in ProviderType]
- settings.provider_tokens = {
- k: v for k, v in settings.provider_tokens.items() if k in provider_types
- }
-
# Determine whether tokens are valid
- for token_type, token_value in settings.provider_tokens.items():
- if token_value:
+ for provider_type, provider_token in settings.provider_tokens.items():
+ if provider_token.token:
confirmed_token_type = await validate_provider_token(
- SecretStr(token_value)
+ provider_token.token
)
- if not confirmed_token_type or confirmed_token_type.value != token_type:
- return f'Invalid token. Please make sure it is a valid {token_type} token.'
+ if not confirmed_token_type or confirmed_token_type != provider_type:
+ return f'Invalid token. Please make sure it is a valid {provider_type.value} token.'
return ''
@@ -233,33 +225,27 @@ async def store_provider_tokens(
):
existing_settings = await settings_store.load()
if existing_settings:
- if settings.provider_tokens:
- if existing_settings.secrets_store:
- existing_providers = [
- provider.value
- for provider in existing_settings.secrets_store.provider_tokens
- ]
-
- # Merge incoming settings store with the existing one
- for provider, token_value in list(settings.provider_tokens.items()):
- if provider in existing_providers and not token_value:
- provider_type = ProviderType(provider)
- existing_token = (
- existing_settings.secrets_store.provider_tokens.get(
- provider_type
- )
+ if existing_settings.secrets_store:
+ existing_providers = [
+ provider
+ for provider in existing_settings.secrets_store.provider_tokens
+ ]
+
+ # Merge incoming settings store with the existing one
+ for provider_type, provider_value in list(settings.provider_tokens.items()):
+ if provider_type in existing_providers and not provider_value.token:
+ existing_token = (
+ existing_settings.secrets_store.provider_tokens.get(
+ provider_type
)
- if existing_token and existing_token.token:
- settings.provider_tokens[provider] = (
- existing_token.token.get_secret_value()
- )
- else: # nothing passed in means keep current settings
- provider_tokens = existing_settings.secrets_store.provider_tokens
- settings.provider_tokens = {
- provider.value: data.token.get_secret_value() if data.token else None
- for provider, data in provider_tokens.items()
- }
+ )
+ if existing_token and existing_token.token:
+ settings.provider_tokens[provider_type] = existing_token
+ else: # nothing passed in means keep current settings
+ provider_tokens = dict(existing_settings.secrets_store.provider_tokens)
+ settings.provider_tokens = provider_tokens
+
return settings
@@ -347,17 +333,8 @@ def convert_to_settings(settings_with_token_data: POSTSettingsModel) -> Settings
# Create new provider tokens immutably
if settings_with_token_data.provider_tokens:
- tokens = {}
- for token_type, token_value in settings_with_token_data.provider_tokens.items():
- if token_value:
- provider = ProviderType(token_type)
- tokens[provider] = ProviderToken(
- token=SecretStr(token_value), user_id=None
- )
-
- # Create new SecretStore with tokens
settings = settings.model_copy(
- update={'secrets_store': SecretStore(provider_tokens=tokens)}
+ update={'secrets_store': SecretStore(provider_tokens=settings_with_token_data.provider_tokens)}
)
return settings
diff --git a/openhands/server/settings.py b/openhands/server/settings.py
index bc2151fc56..ef86b415e8 100644
--- a/openhands/server/settings.py
+++ b/openhands/server/settings.py
@@ -5,6 +5,7 @@ from pydantic import (
SecretStr,
)
+from openhands.integrations.provider import ProviderToken
from openhands.integrations.service_types import ProviderType
from openhands.storage.data_models.settings import Settings
@@ -14,7 +15,7 @@ class POSTSettingsModel(Settings):
Settings for POST requests
"""
- provider_tokens: dict[str, str] = {}
+ provider_tokens: dict[ProviderType, ProviderToken] = {}
class POSTSettingsCustomSecrets(BaseModel):
diff --git a/tests/unit/test_provider_immutability.py b/tests/unit/test_provider_immutability.py
index 7689e0f6a8..0b0e626e3e 100644
--- a/tests/unit/test_provider_immutability.py
+++ b/tests/unit/test_provider_immutability.py
@@ -119,8 +119,13 @@ def test_settings_immutability():
def test_post_settings_conversion():
"""Test that POSTSettingsModel correctly converts to Settings"""
# Create POST model with token data
+ github_token = ProviderToken(token=SecretStr('test_token'))
+ gitlab_token = ProviderToken(token=SecretStr('gitlab_token'))
post_data = POSTSettingsModel(
- provider_tokens={'github': 'test_token', 'gitlab': 'gitlab_token'}
+ provider_tokens={
+ ProviderType.GITHUB: github_token,
+ ProviderType.GITLAB: gitlab_token,
+ }
)
# Convert to settings using convert_to_settings function
diff --git a/tests/unit/test_settings.py b/tests/unit/test_settings.py
index 50c7f4aedc..84b0e3d08f 100644
--- a/tests/unit/test_settings.py
+++ b/tests/unit/test_settings.py
@@ -110,10 +110,11 @@ def test_settings_handles_sensitive_data():
def test_convert_to_settings():
+ github_token = ProviderToken(token=SecretStr('test-token'))
settings_with_token_data = POSTSettingsModel(
llm_api_key='test-key',
provider_tokens={
- 'github': 'test-token',
+ ProviderType.GITHUB: github_token,
},
)
diff --git a/tests/unit/test_settings_api.py b/tests/unit/test_settings_api.py
index 25e5b81676..c9d1ec5c3f 100644
--- a/tests/unit/test_settings_api.py
+++ b/tests/unit/test_settings_api.py
@@ -75,7 +75,7 @@ async def test_settings_api_endpoints(test_client):
'llm_api_key': 'test-key',
'llm_base_url': 'https://test.com',
'remote_runtime_resource_factor': 2,
- 'provider_tokens': {'github': 'test-token'},
+ 'provider_tokens': {'github': {'token': 'test-token'}},
}
# Make the POST request to store settings
diff --git a/tests/unit/test_settings_store_functions.py b/tests/unit/test_settings_store_functions.py
index a10d66fb22..3e2b866045 100644
--- a/tests/unit/test_settings_store_functions.py
+++ b/tests/unit/test_settings_store_functions.py
@@ -24,7 +24,8 @@ async def get_settings_store(request):
@pytest.mark.asyncio
async def test_check_provider_tokens_valid():
"""Test check_provider_tokens with valid tokens."""
- settings = POSTSettingsModel(provider_tokens={'github': 'valid-token'})
+ provider_token = ProviderToken(token=SecretStr('valid-token'))
+ settings = POSTSettingsModel(provider_tokens={ProviderType.GITHUB: provider_token})
# Mock the validate_provider_token function to return GITHUB for valid tokens
with patch(
@@ -42,7 +43,8 @@ async def test_check_provider_tokens_valid():
@pytest.mark.asyncio
async def test_check_provider_tokens_invalid():
"""Test check_provider_tokens with invalid tokens."""
- settings = POSTSettingsModel(provider_tokens={'github': 'invalid-token'})
+ provider_token = ProviderToken(token=SecretStr('invalid-token'))
+ settings = POSTSettingsModel(provider_tokens={ProviderType.GITHUB: provider_token})
# Mock the validate_provider_token function to return None for invalid tokens
with patch(
@@ -60,11 +62,13 @@ async def test_check_provider_tokens_invalid():
@pytest.mark.asyncio
async def test_check_provider_tokens_wrong_type():
"""Test check_provider_tokens with unsupported provider type."""
- settings = POSTSettingsModel(provider_tokens={'unsupported': 'some-token'})
+ # We can't test with an unsupported provider type directly since the model enforces valid types
+ # Instead, we'll test with an empty provider_tokens dictionary
+ settings = POSTSettingsModel(provider_tokens={})
result = await check_provider_tokens(settings)
- # Should return empty string for unsupported provider
+ # Should return empty string for no providers
assert result == ''
@@ -162,7 +166,8 @@ async def test_store_llm_settings_partial_update():
@pytest.mark.asyncio
async def test_store_provider_tokens_new_tokens():
"""Test store_provider_tokens with new tokens."""
- settings = POSTSettingsModel(provider_tokens={'github': 'new-token'})
+ provider_token = ProviderToken(token=SecretStr('new-token'))
+ settings = POSTSettingsModel(provider_tokens={ProviderType.GITHUB: provider_token})
# Mock the settings store
mock_store = MagicMock()
@@ -171,13 +176,17 @@ async def test_store_provider_tokens_new_tokens():
result = await store_provider_tokens(settings, mock_store)
# Should return settings with the provided tokens
- assert result.provider_tokens == {'github': 'new-token'}
+ assert (
+ result.provider_tokens[ProviderType.GITHUB].token.get_secret_value()
+ == 'new-token'
+ )
@pytest.mark.asyncio
async def test_store_provider_tokens_update_existing():
"""Test store_provider_tokens updates existing tokens."""
- settings = POSTSettingsModel(provider_tokens={'github': 'updated-token'})
+ provider_token = ProviderToken(token=SecretStr('updated-token'))
+ settings = POSTSettingsModel(provider_tokens={ProviderType.GITHUB: provider_token})
# Mock the settings store
mock_store = MagicMock()
@@ -197,14 +206,19 @@ async def test_store_provider_tokens_update_existing():
result = await store_provider_tokens(settings, mock_store)
# Should return settings with the updated tokens
- assert result.provider_tokens == {'github': 'updated-token'}
+ assert (
+ result.provider_tokens[ProviderType.GITHUB].token.get_secret_value()
+ == 'updated-token'
+ )
@pytest.mark.asyncio
async def test_store_provider_tokens_keep_existing():
"""Test store_provider_tokens keeps existing tokens when empty string provided."""
settings = POSTSettingsModel(
- provider_tokens={'github': ''} # Empty string should keep existing token
+ provider_tokens={
+ 'github': {'token': ''}
+ } # Empty string should keep existing token
)
# Mock the settings store
@@ -225,4 +239,7 @@ async def test_store_provider_tokens_keep_existing():
result = await store_provider_tokens(settings, mock_store)
# Should return settings with the existing token preserved
- assert result.provider_tokens == {'github': 'existing-token'}
+ assert (
+ result.provider_tokens[ProviderType.GITHUB].token.get_secret_value()
+ == 'existing-token'
+ )