Skip to content

πŸ™Œ OpenHands: AI-Driven Development

Refactor verification settings to use schema rendering (#13978)

Graham Neubigbaa3a7e5b795
diff --git a/.pr/gifs/13971-verification-basic-vs-advanced.gif b/.pr/gifs/13971-verification-basic-vs-advanced.gif
new file mode 100644
index 0000000000..9eca78140b
Binary files /dev/null and b/.pr/gifs/13971-verification-basic-vs-advanced.gif differ
diff --git a/frontend/__tests__/routes/verification-settings.test.tsx b/frontend/__tests__/routes/verification-settings.test.tsx
index f39a569c85..4067356007 100644
--- a/frontend/__tests__/routes/verification-settings.test.tsx
+++ b/frontend/__tests__/routes/verification-settings.test.tsx
@@ -1,5 +1,6 @@
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { render, screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
import { beforeEach, describe, expect, it, vi } from "vitest";
import SettingsService from "#/api/settings-service/settings-service.api";
import { MOCK_DEFAULT_USER_SETTINGS } from "#/mocks/handlers";
@@ -41,15 +42,47 @@ beforeEach(() => {
});
describe("VerificationSettingsScreen", () => {
- it("keeps the confirmation controls visible in the basic view", async () => {
+ it("keeps confirmation mode visible in the basic view", async () => {
vi.spyOn(SettingsService, "getSettings").mockResolvedValue(buildSettings());
renderVerificationSettingsScreen();
await screen.findByTestId("verification-settings-screen");
- expect(screen.getByTestId("confirmation-mode-toggle")).toBeInTheDocument();
+ expect(
+ screen.getByTestId("sdk-settings-confirmation_mode"),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByTestId("sdk-settings-security_analyzer"),
+ ).not.toBeInTheDocument();
});
+
+ it("shows the security analyzer only in advanced view", async () => {
+ vi.spyOn(SettingsService, "getSettings").mockResolvedValue(
+ buildSettings({
+ conversation_settings: {
+ ...MOCK_DEFAULT_USER_SETTINGS.conversation_settings,
+ confirmation_mode: true,
+ security_analyzer: "llm",
+ },
+ }),
+ );
+
+ renderVerificationSettingsScreen();
+
+ await screen.findByTestId("verification-settings-screen");
+
+ expect(
+ screen.queryByTestId("sdk-settings-security_analyzer"),
+ ).not.toBeInTheDocument();
+
+ await userEvent.click(screen.getByTestId("sdk-section-advanced-toggle"));
+
+ expect(
+ await screen.findByTestId("sdk-settings-security_analyzer"),
+ ).toBeInTheDocument();
+ });
+
});
describe("clientLoader permission checks", () => {
diff --git a/frontend/src/mocks/settings-handlers.ts b/frontend/src/mocks/settings-handlers.ts
index 76197fa960..a718925692 100644
--- a/frontend/src/mocks/settings-handlers.ts
+++ b/frontend/src/mocks/settings-handlers.ts
@@ -224,7 +224,7 @@ const MOCK_CONVERSATION_SETTINGS_SCHEMA: NonNullable<
default: false,
choices: [],
depends_on: [],
- prominence: "major",
+ prominence: "critical",
secret: false,
required: true,
},
diff --git a/frontend/src/routes/verification-settings.tsx b/frontend/src/routes/verification-settings.tsx
index 2e40acee8e..9994ce6976 100644
--- a/frontend/src/routes/verification-settings.tsx
+++ b/frontend/src/routes/verification-settings.tsx
@@ -1,97 +1,15 @@
import React from "react";
-import { useTranslation } from "react-i18next";
-import { SettingsDropdownInput } from "#/components/features/settings/settings-dropdown-input";
-import { SettingsSwitch } from "#/components/features/settings/settings-switch";
-import {
- SdkSectionHeaderProps,
- SdkSectionPage,
-} from "#/components/features/settings/sdk-settings/sdk-section-page";
-import { useSettings } from "#/hooks/query/use-settings";
-import { I18nKey } from "#/i18n/declaration";
-import { DEFAULT_SETTINGS } from "#/services/settings";
+import { SdkSectionPage } from "#/components/features/settings/sdk-settings/sdk-section-page";
import { SettingsScope } from "#/types/settings";
import { createPermissionGuard } from "#/utils/org/permission-guard";
import { requireOrgDefaultsRedirect } from "#/utils/org/saas-redirect-to-org-defaults-guard";
-const VERIFICATION_SCHEMA_EXCLUDE_KEYS = new Set([
- "confirmation_mode",
- "security_analyzer",
-]);
-
function VerificationSettingsHeader({
- confirmationMode,
- securityAnalyzer,
- isConversationSettingsDisabled,
- onConfirmationModeChange,
- onSecurityAnalyzerChange,
renderTopContent,
}: {
- confirmationMode: boolean;
- securityAnalyzer: string | null;
- isConversationSettingsDisabled: boolean;
- onConfirmationModeChange: (value: boolean) => void;
- onSecurityAnalyzerChange: (value: string | null) => void;
renderTopContent?: () => React.ReactNode;
}) {
- const { t } = useTranslation();
-
- const securityAnalyzerItems = React.useMemo(
- () => [
- {
- key: "llm",
- label: t(I18nKey.SETTINGS$SECURITY_ANALYZER_LLM_DEFAULT),
- },
- {
- key: "none",
- label: t(I18nKey.SETTINGS$SECURITY_ANALYZER_NONE),
- },
- ],
- [t],
- );
-
- const showSecurityAnalyzer = confirmationMode;
-
- return (
- <div className="flex flex-col gap-6">
- {renderTopContent?.()}
-
- <div className="flex flex-col gap-6">
- <div className="flex flex-col gap-1.5">
- <SettingsSwitch
- testId="confirmation-mode-toggle"
- isToggled={confirmationMode}
- onToggle={onConfirmationModeChange}
- isDisabled={isConversationSettingsDisabled}
- >
- {t(I18nKey.SETTINGS_FORM$ENABLE_CONFIRMATION_MODE_LABEL)}
- </SettingsSwitch>
- <p className="text-tertiary-alt text-xs leading-5">
- {t(I18nKey.SETTINGS$CONFIRMATION_MODE_TOOLTIP)}
- </p>
- </div>
-
- {showSecurityAnalyzer ? (
- <div className="flex flex-col gap-1.5">
- <SettingsDropdownInput
- testId="security-analyzer-input"
- name="security_analyzer"
- label={t(I18nKey.SETTINGS_FORM$SECURITY_ANALYZER_LABEL)}
- items={securityAnalyzerItems}
- selectedKey={securityAnalyzer ?? undefined}
- placeholder={t(I18nKey.SETTINGS$SECURITY_ANALYZER_PLACEHOLDER)}
- isDisabled={isConversationSettingsDisabled}
- onSelectionChange={(key) =>
- onSecurityAnalyzerChange(key ? String(key) : null)
- }
- />
- <p className="text-tertiary-alt text-xs leading-5 max-w-[680px] ">
- {t(I18nKey.SETTINGS$SECURITY_ANALYZER_DESCRIPTION)}
- </p>
- </div>
- ) : null}
- </div>
- </div>
- );
+ return <div className="flex flex-col gap-6">{renderTopContent?.()}</div>;
}
export function VerificationSettingsScreen({
@@ -103,72 +21,9 @@ export function VerificationSettingsScreen({
renderTopContent?: () => React.ReactNode;
testId?: string;
}) {
- const { data: settings } = useSettings(scope);
- const [confirmationMode, setConfirmationMode] = React.useState(
- DEFAULT_SETTINGS.confirmation_mode,
- );
- const [securityAnalyzer, setSecurityAnalyzer] = React.useState<string | null>(
- DEFAULT_SETTINGS.security_analyzer,
- );
- const [confirmationModeDirty, setConfirmationModeDirty] =
- React.useState(false);
- const [securityAnalyzerDirty, setSecurityAnalyzerDirty] =
- React.useState(false);
-
- React.useEffect(() => {
- setConfirmationMode(
- settings?.confirmation_mode ?? DEFAULT_SETTINGS.confirmation_mode,
- );
- setSecurityAnalyzer(
- settings?.security_analyzer ?? DEFAULT_SETTINGS.security_analyzer,
- );
- setConfirmationModeDirty(false);
- setSecurityAnalyzerDirty(false);
- }, [settings?.confirmation_mode, settings?.security_analyzer]);
-
const buildHeader = React.useCallback(
- ({ isDisabled }: SdkSectionHeaderProps) => (
- <VerificationSettingsHeader
- confirmationMode={confirmationMode}
- securityAnalyzer={securityAnalyzer}
- isConversationSettingsDisabled={isDisabled}
- onConfirmationModeChange={(value) => {
- setConfirmationMode(value);
- setConfirmationModeDirty(true);
- }}
- onSecurityAnalyzerChange={(value) => {
- setSecurityAnalyzer(value);
- setSecurityAnalyzerDirty(true);
- }}
- renderTopContent={renderTopContent}
- />
- ),
- [confirmationMode, renderTopContent, securityAnalyzer],
- );
-
- const buildPayload = React.useCallback(
- (basePayload: Record<string, unknown>) => {
- const payload = { ...basePayload };
-
- if (confirmationModeDirty) {
- payload.confirmation_mode = confirmationMode;
- }
- if (
- securityAnalyzerDirty ||
- (confirmationMode && settings?.security_analyzer !== securityAnalyzer)
- ) {
- payload.security_analyzer = securityAnalyzer;
- }
-
- return { conversation_settings_diff: payload };
- },
- [
- confirmationMode,
- confirmationModeDirty,
- securityAnalyzer,
- securityAnalyzerDirty,
- settings?.security_analyzer,
- ],
+ () => <VerificationSettingsHeader renderTopContent={renderTopContent} />,
+ [renderTopContent],
);
return (
@@ -176,14 +31,7 @@ export function VerificationSettingsScreen({
scope={scope}
settingsSource="conversation_settings"
sectionKeys={["verification"]}
- excludeKeys={VERIFICATION_SCHEMA_EXCLUDE_KEYS}
header={buildHeader}
- extraDirty={confirmationModeDirty || securityAnalyzerDirty}
- buildPayload={buildPayload}
- onSaveSuccess={() => {
- setConfirmationModeDirty(false);
- setSecurityAnalyzerDirty(false);
- }}
testId={testId}
/>
);