Skip to content

πŸ™Œ OpenHands: AI-Driven Development

feat(settings): select supported LLM providers (#16772)

KeelTrace4bf8dd3aaf12
diff --git a/src/components/features/settings/llm-profiles/provider-connection-modal.tsx b/src/components/features/settings/llm-profiles/provider-connection-modal.tsx
index 606697e23a..5f8847b6b7 100644
--- a/src/components/features/settings/llm-profiles/provider-connection-modal.tsx
+++ b/src/components/features/settings/llm-profiles/provider-connection-modal.tsx
@@ -1,4 +1,9 @@
import { useEffect, useRef, useState } from "react";
+import {
+ Autocomplete,
+ AutocompleteItem,
+ AutocompleteSection,
+} from "@heroui/react";
import { useTranslation } from "react-i18next";
import { BrandButton } from "#/components/features/settings/brand-button";
import { SettingsInput } from "#/components/features/settings/settings-input";
@@ -14,6 +19,10 @@ import {
} from "#/utils/custom-toast-handlers";
import { getApiErrorMessage } from "#/utils/api-error-message";
import { I18nKey } from "#/i18n/declaration";
+import { useSearchProviders } from "#/hooks/query/use-search-providers";
+import { mapProvider } from "#/utils/map-provider";
+import { formControlSettingsFieldClassName } from "#/utils/form-control-classes";
+import { heroUiAutocompleteSelectorButtonClassName } from "#/ui/combobox-caret";
const DEFAULT_PROVIDER = "custom";
@@ -43,10 +52,11 @@ export function ProviderConnectionModal({
const { t } = useTranslation("openhands");
const createConnection = useCreateProviderConnection();
const updateConnection = useUpdateProviderConnection();
+ const { data: providers = [] } = useSearchProviders();
const firstFieldRef = useRef<HTMLInputElement>(null);
const [displayName, setDisplayName] = useState("");
- const [provider, setProvider] = useState(DEFAULT_PROVIDER);
+ const [provider, setProvider] = useState<string | null>(null);
const [apiKey, setApiKey] = useState("");
const [baseUrl, setBaseUrl] = useState("");
@@ -55,7 +65,7 @@ export function ProviderConnectionModal({
useEffect(() => {
setDisplayName(connection?.display_name ?? "");
- setProvider(connection?.provider ?? DEFAULT_PROVIDER);
+ setProvider(connection?.provider ?? (isCreate ? null : DEFAULT_PROVIDER));
setBaseUrl(connection?.base_url ?? "");
setApiKey("");
}, [connection, isCreate]);
@@ -64,7 +74,15 @@ export function ProviderConnectionModal({
const trimmedName = displayName.trim();
const trimmedKey = apiKey.trim();
// On create the key is required; on edit an empty key means "leave unchanged".
- const isValid = Boolean(trimmedName) && (!isCreate || Boolean(trimmedKey));
+ const isValid =
+ Boolean(trimmedName) &&
+ Boolean(provider?.trim()) &&
+ (!isCreate || Boolean(trimmedKey));
+
+ const verifiedProviders = providers.filter((candidate) => candidate.verified);
+ const unverifiedProviders = providers.filter(
+ (candidate) => !candidate.verified,
+ );
if (!isOpen) return null;
@@ -80,7 +98,7 @@ export function ProviderConnectionModal({
if (isCreate) {
const created = await createConnection.mutateAsync({
display_name: trimmedName,
- provider: provider.trim() || DEFAULT_PROVIDER,
+ provider: provider?.trim() || DEFAULT_PROVIDER,
api_key: trimmedKey,
base_url: trimmedBaseUrl || null,
});
@@ -95,7 +113,7 @@ export function ProviderConnectionModal({
id: connection.id,
request: {
display_name: trimmedName,
- provider: provider.trim() || DEFAULT_PROVIDER,
+ provider: provider?.trim() || DEFAULT_PROVIDER,
base_url: trimmedBaseUrl || null,
// Omit the key entirely when left blank so the stored key is kept.
...(trimmedKey ? { api_key: trimmedKey } : {}),
@@ -163,14 +181,73 @@ export function ProviderConnectionModal({
onChange={setDisplayName}
required
/>
- <SettingsInput
- testId="provider-connection-provider-input"
- label={t(I18nKey.SETTINGS$PROVIDER_CONNECTION_PROVIDER)}
- type="text"
- className="w-full"
- value={provider}
- onChange={setProvider}
- />
+ {isCreate ? (
+ <fieldset className="flex flex-col gap-2.5 w-full">
+ <label className="text-sm">
+ {t(I18nKey.SETTINGS$PROVIDER_CONNECTION_PROVIDER)}
+ </label>
+ <Autocomplete
+ data-testid="provider-connection-provider-input"
+ isRequired
+ isVirtualized={false}
+ name="provider-connection-provider-input"
+ aria-label={t(I18nKey.SETTINGS$PROVIDER_CONNECTION_PROVIDER)}
+ isClearable={false}
+ selectedKey={provider}
+ onSelectionChange={(key) => setProvider(key?.toString() ?? null)}
+ classNames={{
+ popoverContent:
+ "bg-content1 rounded-xl border border-[var(--oh-border)]",
+ selectorButton: heroUiAutocompleteSelectorButtonClassName,
+ }}
+ selectorButtonProps={{ disableRipple: true }}
+ inputProps={{
+ classNames: {
+ inputWrapper: formControlSettingsFieldClassName,
+ },
+ }}
+ >
+ <AutocompleteSection
+ title={t(I18nKey.MODEL_SELECTOR$VERIFIED)}
+ classNames={{ heading: "text-[var(--oh-muted)]" }}
+ >
+ {verifiedProviders.map((candidate) => (
+ <AutocompleteItem
+ data-testid={`provider-item-${candidate.name}`}
+ key={candidate.name}
+ textValue={mapProvider(candidate.name)}
+ >
+ {mapProvider(candidate.name)}
+ </AutocompleteItem>
+ ))}
+ </AutocompleteSection>
+ {unverifiedProviders.length > 0 ? (
+ <AutocompleteSection
+ title={t(I18nKey.MODEL_SELECTOR$OTHERS)}
+ classNames={{ heading: "text-[var(--oh-muted)]" }}
+ >
+ {unverifiedProviders.map((candidate) => (
+ <AutocompleteItem
+ key={candidate.name}
+ textValue={mapProvider(candidate.name)}
+ >
+ {mapProvider(candidate.name)}
+ </AutocompleteItem>
+ ))}
+ </AutocompleteSection>
+ ) : null}
+ </Autocomplete>
+ </fieldset>
+ ) : (
+ <SettingsInput
+ testId="provider-connection-provider-input"
+ label={t(I18nKey.SETTINGS$PROVIDER_CONNECTION_PROVIDER)}
+ type="text"
+ className="w-full"
+ value={provider ?? ""}
+ onChange={setProvider}
+ />
+ )}
<SettingsInput
testId="provider-connection-api-key-input"
label={t(I18nKey.SETTINGS_FORM$API_KEY)}
diff --git a/src/components/features/settings/llm-profiles/provider-connections-manager.test.tsx b/src/components/features/settings/llm-profiles/provider-connections-manager.test.tsx
index 9761382ec5..a43c1e4568 100644
--- a/src/components/features/settings/llm-profiles/provider-connections-manager.test.tsx
+++ b/src/components/features/settings/llm-profiles/provider-connections-manager.test.tsx
@@ -1,4 +1,5 @@
import { screen, fireEvent, waitFor } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { renderWithProviders } from "test-utils";
import ProviderConnectionsService, {
@@ -14,6 +15,17 @@ vi.mock("#/utils/custom-toast-handlers", () => ({
displaySuccessToast,
}));
+vi.mock("#/hooks/query/use-search-providers", () => ({
+ useSearchProviders: () => ({
+ data: [
+ { name: "openai", verified: true },
+ { name: "anthropic", verified: true },
+ { name: "openhands", verified: true },
+ { name: "azure", verified: false },
+ ],
+ }),
+}));
+
const renderWith = (ui: React.ReactElement) => renderWithProviders(ui);
const connection: ProviderConnection = {
@@ -51,6 +63,79 @@ describe("ProviderConnectionsManager", () => {
).toBeInTheDocument();
});
+ it("shows supported providers in the create-connection selector", async () => {
+ const user = userEvent.setup();
+
+ renderWith(
+ <ProviderConnectionsManager
+ connections={[]}
+ linkedCountById={{}}
+ isLoading={false}
+ loadError={null}
+ />,
+ );
+
+ await user.click(screen.getByTestId("add-provider-connection"));
+
+ const providerSelector = screen.getByRole("combobox", {
+ name: /provider/i,
+ });
+ await user.click(providerSelector);
+
+ expect(screen.getByText("OpenAI")).toBeInTheDocument();
+ expect(screen.getByText("Anthropic")).toBeInTheDocument();
+ expect(screen.getByText("OpenHands")).toBeInTheDocument();
+ expect(screen.getByText("Azure")).toBeInTheDocument();
+
+ await user.click(screen.getByText("Anthropic"));
+ expect(providerSelector).toHaveValue("Anthropic");
+ });
+
+ it("submits the raw provider id when creating a connection", async () => {
+ const user = userEvent.setup();
+ const createSpy = vi
+ .spyOn(ProviderConnectionsService, "create")
+ .mockResolvedValue({
+ ...connection,
+ id: "conn-anthropic",
+ display_name: "My Anthropic",
+ provider: "anthropic",
+ });
+
+ renderWith(
+ <ProviderConnectionsManager
+ connections={[]}
+ linkedCountById={{}}
+ isLoading={false}
+ loadError={null}
+ />,
+ );
+
+ await user.click(screen.getByTestId("add-provider-connection"));
+ await user.type(
+ screen.getByTestId("provider-connection-name-input"),
+ "My Anthropic",
+ );
+
+ const providerSelector = screen.getByRole("combobox", {
+ name: /provider/i,
+ });
+ await user.click(providerSelector);
+ await user.click(screen.getByTestId("provider-item-anthropic"));
+
+ await user.type(
+ screen.getByTestId("provider-connection-api-key-input"),
+ "test-key",
+ );
+ await user.click(screen.getByTestId("provider-connection-submit"));
+
+ await waitFor(() => {
+ expect(createSpy).toHaveBeenCalledWith(
+ expect.objectContaining({ provider: "anthropic" }),
+ );
+ });
+ });
+
it("lists a row per connection with its display name and provider", () => {
renderWith(
<ProviderConnectionsManager
diff --git a/tests/e2e/mock-llm/settings/mock-llm-provider-connection-selector.spec.ts b/tests/e2e/mock-llm/settings/mock-llm-provider-connection-selector.spec.ts
new file mode 100644
index 0000000000..6a4c0cc654
--- /dev/null
+++ b/tests/e2e/mock-llm/settings/mock-llm-provider-connection-selector.spec.ts
@@ -0,0 +1,49 @@
+import { test, expect } from "@playwright/test";
+import {
+ seedLocalStorage,
+ routeSessionApiKey,
+ dismissAnalyticsModal,
+ waitForTestId,
+} from "../utils/mock-llm-helpers";
+
+test.describe.configure({ mode: "serial" });
+
+test.describe("provider connection selector", () => {
+ test.beforeEach(async ({ page }) => {
+ await seedLocalStorage(page);
+ });
+
+ test("selects a supported provider in Add provider", async ({ page }) => {
+ test.setTimeout(120_000);
+
+ await routeSessionApiKey(page);
+ await page.goto("/settings/llm", { waitUntil: "domcontentloaded" });
+ await dismissAnalyticsModal(page);
+ await waitForTestId(page, "add-provider-connection");
+
+ await page.getByTestId("add-provider-connection").click();
+
+ const modal = page.getByTestId("provider-connection-modal");
+ await expect(modal).toBeVisible();
+
+ const providerSelector = modal.getByRole("combobox", {
+ name: /provider/i,
+ });
+ await expect(providerSelector).toBeVisible();
+
+ await providerSelector.click();
+
+ const openAI = page.getByTestId("provider-item-openai");
+ await expect(openAI).toBeVisible();
+
+ // Leave the dropdown open long enough for the recorded animation
+ // to clearly demonstrate supported-provider choices.
+ await page.waitForTimeout(1_200);
+
+ await openAI.click();
+ await expect(providerSelector).toHaveValue("OpenAI");
+
+ // Hold the selected state for the final frames of the evidence.
+ await page.waitForTimeout(1_200);
+ });
+});