fix(speech): keep provider secrets server-side

2026-03-25 13:39:36 +00:00
parent c064cea4cc
commit 6c27d4d1c4
12 changed files with 154 additions and 17 deletions
--- a/packages/ui/src/components/settings/speech-settings-card.tsx
+++ b/packages/ui/src/components/settings/speech-settings-card.tsx
@@ -1,4 +1,4 @@
-import { createEffect, createMemo, createSignal, type Component } from "solid-js"
+import { Show, createEffect, createMemo, createSignal, type Component } from "solid-js"
 import { Mic, Volume2 } from "lucide-solid"
 import { useConfig, type SpeechSettings } from "../../stores/preferences"
 import { useI18n } from "../../lib/i18n"
@@ -17,7 +17,7 @@ type DraftFields = {

 function createDraftFields(speech: SpeechSettings): DraftFields {
  return {
-    apiKey: speech.apiKey ?? "",
+    apiKey: "",
    baseUrl: speech.baseUrl ?? "",
    sttModel: speech.sttModel,
    ttsModel: speech.ttsModel,
@@ -36,6 +36,8 @@ export const SpeechSettingsCard: Component = () => {
  const [isSaving, setIsSaving] = createSignal(false)
  const [saveStatus, setSaveStatus] = createSignal<"idle" | "saved" | "error">("saved")
  const [drafts, setDrafts] = createSignal<DraftFields>(initialDrafts)
+  const [apiKeyTouched, setApiKeyTouched] = createSignal(false)
+  const [clearStoredApiKey, setClearStoredApiKey] = createSignal(false)

  createEffect(() => {
    const speech = serverSettings().speech
@@ -44,6 +46,12 @@ export const SpeechSettingsCard: Component = () => {
      if (!isDraftEqual(drafts(), nextDrafts)) {
        setDrafts(nextDrafts)
      }
+      if (apiKeyTouched()) {
+        setApiKeyTouched(false)
+      }
+      if (clearStoredApiKey()) {
+        setClearStoredApiKey(false)
+      }
    }
  })

@@ -59,14 +67,20 @@ export const SpeechSettingsCard: Component = () => {

  const updateDraft = (key: keyof DraftFields, value: string) => {
    setSaveStatus("idle")
+    if (key === "apiKey") {
+      setApiKeyTouched(true)
+      setClearStoredApiKey(false)
+    }
    setDrafts((current) => ({ ...current, [key]: value }))
  }

+  const apiKeyDirty = createMemo(() => clearStoredApiKey() || drafts().apiKey.trim().length > 0)
+
  const isDirty = createMemo(() => {
    const speech = serverSettings().speech
    const current = drafts()
    return (
-      (current.apiKey || "") !== (speech.apiKey || "") ||
+      apiKeyDirty() ||
      (current.baseUrl || "") !== (speech.baseUrl || "") ||
      current.sttModel !== speech.sttModel ||
      current.ttsModel !== speech.ttsModel ||
@@ -87,8 +101,9 @@ export const SpeechSettingsCard: Component = () => {
    setIsSaving(true)
    setSaveStatus("idle")
    try {
+      const trimmedApiKey = current.apiKey.trim()
      await updateSpeechSettings({
-        apiKey: current.apiKey.trim() || undefined,
+        ...(clearStoredApiKey() ? { apiKey: null } : trimmedApiKey ? { apiKey: trimmedApiKey } : {}),
        baseUrl: current.baseUrl.trim() || undefined,
        sttModel: current.sttModel.trim() || undefined,
        ttsModel: current.ttsModel.trim() || undefined,
@@ -96,12 +111,14 @@ export const SpeechSettingsCard: Component = () => {
      })
      await loadSpeechCapabilities(true)
      setDrafts({
-        apiKey: current.apiKey.trim(),
+        apiKey: "",
        baseUrl: current.baseUrl.trim(),
        sttModel: current.sttModel.trim() || serverSettings().speech.sttModel,
        ttsModel: current.ttsModel.trim() || serverSettings().speech.ttsModel,
        ttsVoice: current.ttsVoice.trim() || serverSettings().speech.ttsVoice,
      })
+      setApiKeyTouched(false)
+      setClearStoredApiKey(false)
      setSaveStatus("saved")
    } catch (error) {
      log.error("Failed to save speech settings", error)
@@ -151,7 +168,25 @@ export const SpeechSettingsCard: Component = () => {
          value={drafts().apiKey}
          onInput={(value) => updateDraft("apiKey", value)}
          type="password"
+          placeholder={serverSettings().speech.hasApiKey ? t("settings.speech.apiKey.placeholder") : undefined}
        />
+        <Show when={serverSettings().speech.hasApiKey && !apiKeyTouched() && drafts().apiKey.length === 0}>
+          <div class="settings-inline-note">
+            {clearStoredApiKey() ? t("settings.speech.apiKey.clearPending") : t("settings.speech.apiKey.storedNote")}{" "}
+            <Show when={!clearStoredApiKey()}>
+              <button
+                type="button"
+                class="selector-button selector-button-secondary w-auto whitespace-nowrap"
+                onClick={() => {
+                  setClearStoredApiKey(true)
+                  setSaveStatus("idle")
+                }}
+              >
+                {t("settings.speech.apiKey.clearAction")}
+              </button>
+            </Show>
+          </div>
+        </Show>
        <Field
          label={t("settings.speech.baseUrl.title")}
          caption={t("settings.speech.baseUrl.subtitle")}
--- a/packages/ui/src/lib/i18n/messages/en/settings.ts
+++ b/packages/ui/src/lib/i18n/messages/en/settings.ts
@@ -153,6 +153,10 @@ export const settingsMessages = {
  "settings.speech.status.error": "Speech service unavailable",
  "settings.speech.apiKey.title": "API key",
  "settings.speech.apiKey.subtitle": "Used for CodeNomad-managed speech requests.",
+  "settings.speech.apiKey.placeholder": "Enter a new API key",
+  "settings.speech.apiKey.storedNote": "A saved API key is hidden. Enter a new value to replace it, or leave the field blank to keep it.",
+  "settings.speech.apiKey.clearAction": "Clear saved key",
+  "settings.speech.apiKey.clearPending": "The saved API key will be removed when you save.",
  "settings.speech.baseUrl.title": "Base URL",
  "settings.speech.baseUrl.subtitle": "Optional override for OpenAI-compatible speech endpoints.",
  "settings.speech.baseUrl.placeholder": "https://api.openai.com/v1",
--- a/packages/ui/src/lib/i18n/messages/es/settings.ts
+++ b/packages/ui/src/lib/i18n/messages/es/settings.ts
@@ -153,6 +153,10 @@ export const settingsMessages = {
  "settings.speech.status.error": "Speech service unavailable",
  "settings.speech.apiKey.title": "API key",
  "settings.speech.apiKey.subtitle": "Used for CodeNomad-managed speech requests.",
+  "settings.speech.apiKey.placeholder": "Enter a new API key",
+  "settings.speech.apiKey.storedNote": "A saved API key is hidden. Enter a new value to replace it, or leave the field blank to keep it.",
+  "settings.speech.apiKey.clearAction": "Clear saved key",
+  "settings.speech.apiKey.clearPending": "The saved API key will be removed when you save.",
  "settings.speech.baseUrl.title": "Base URL",
  "settings.speech.baseUrl.subtitle": "Optional override for OpenAI-compatible speech endpoints.",
  "settings.speech.baseUrl.placeholder": "https://api.openai.com/v1",
--- a/packages/ui/src/lib/i18n/messages/fr/settings.ts
+++ b/packages/ui/src/lib/i18n/messages/fr/settings.ts
@@ -153,6 +153,10 @@ export const settingsMessages = {
  "settings.speech.status.error": "Speech service unavailable",
  "settings.speech.apiKey.title": "API key",
  "settings.speech.apiKey.subtitle": "Used for CodeNomad-managed speech requests.",
+  "settings.speech.apiKey.placeholder": "Enter a new API key",
+  "settings.speech.apiKey.storedNote": "A saved API key is hidden. Enter a new value to replace it, or leave the field blank to keep it.",
+  "settings.speech.apiKey.clearAction": "Clear saved key",
+  "settings.speech.apiKey.clearPending": "The saved API key will be removed when you save.",
  "settings.speech.baseUrl.title": "Base URL",
  "settings.speech.baseUrl.subtitle": "Optional override for OpenAI-compatible speech endpoints.",
  "settings.speech.baseUrl.placeholder": "https://api.openai.com/v1",
--- a/packages/ui/src/lib/i18n/messages/ja/settings.ts
+++ b/packages/ui/src/lib/i18n/messages/ja/settings.ts
@@ -153,6 +153,10 @@ export const settingsMessages = {
  "settings.speech.status.error": "Speech service unavailable",
  "settings.speech.apiKey.title": "API key",
  "settings.speech.apiKey.subtitle": "Used for CodeNomad-managed speech requests.",
+  "settings.speech.apiKey.placeholder": "Enter a new API key",
+  "settings.speech.apiKey.storedNote": "A saved API key is hidden. Enter a new value to replace it, or leave the field blank to keep it.",
+  "settings.speech.apiKey.clearAction": "Clear saved key",
+  "settings.speech.apiKey.clearPending": "The saved API key will be removed when you save.",
  "settings.speech.baseUrl.title": "Base URL",
  "settings.speech.baseUrl.subtitle": "Optional override for OpenAI-compatible speech endpoints.",
  "settings.speech.baseUrl.placeholder": "https://api.openai.com/v1",
--- a/packages/ui/src/lib/i18n/messages/ru/settings.ts
+++ b/packages/ui/src/lib/i18n/messages/ru/settings.ts
@@ -153,6 +153,10 @@ export const settingsMessages = {
  "settings.speech.status.error": "Speech service unavailable",
  "settings.speech.apiKey.title": "API key",
  "settings.speech.apiKey.subtitle": "Used for CodeNomad-managed speech requests.",
+  "settings.speech.apiKey.placeholder": "Enter a new API key",
+  "settings.speech.apiKey.storedNote": "A saved API key is hidden. Enter a new value to replace it, or leave the field blank to keep it.",
+  "settings.speech.apiKey.clearAction": "Clear saved key",
+  "settings.speech.apiKey.clearPending": "The saved API key will be removed when you save.",
  "settings.speech.baseUrl.title": "Base URL",
  "settings.speech.baseUrl.subtitle": "Optional override for OpenAI-compatible speech endpoints.",
  "settings.speech.baseUrl.placeholder": "https://api.openai.com/v1",
--- a/packages/ui/src/lib/i18n/messages/zh-Hans/settings.ts
+++ b/packages/ui/src/lib/i18n/messages/zh-Hans/settings.ts
@@ -153,6 +153,10 @@ export const settingsMessages = {
  "settings.speech.status.error": "Speech service unavailable",
  "settings.speech.apiKey.title": "API key",
  "settings.speech.apiKey.subtitle": "Used for CodeNomad-managed speech requests.",
+  "settings.speech.apiKey.placeholder": "Enter a new API key",
+  "settings.speech.apiKey.storedNote": "A saved API key is hidden. Enter a new value to replace it, or leave the field blank to keep it.",
+  "settings.speech.apiKey.clearAction": "Clear saved key",
+  "settings.speech.apiKey.clearPending": "The saved API key will be removed when you save.",
  "settings.speech.baseUrl.title": "Base URL",
  "settings.speech.baseUrl.subtitle": "Optional override for OpenAI-compatible speech endpoints.",
  "settings.speech.baseUrl.placeholder": "https://api.openai.com/v1",
--- a/packages/ui/src/stores/preferences.tsx
+++ b/packages/ui/src/stores/preferences.tsx
@@ -33,12 +33,17 @@ export type SpeechProviderPreference = "openai-compatible"
 export interface SpeechSettings {
  provider: SpeechProviderPreference
  apiKey?: string
+  hasApiKey: boolean
  baseUrl?: string
  sttModel: string
  ttsModel: string
  ttsVoice: string
 }

+export type SpeechSettingsUpdate = Partial<Omit<SpeechSettings, "apiKey">> & {
+  apiKey?: string | null
+}
+
 export interface UiSettings {
  showThinkingBlocks: boolean
  showKeyboardShortcutHints: boolean
@@ -136,6 +141,7 @@ const defaultUiSettings: UiSettings = {

 const defaultSpeechSettings: SpeechSettings = {
  provider: "openai-compatible",
+  hasApiKey: false,
  sttModel: "gpt-4o-mini-transcribe",
  ttsModel: "gpt-4o-mini-tts",
  ttsVoice: "alloy",
@@ -183,6 +189,7 @@ function normalizeSpeechSettings(input?: Partial<SpeechSettings> | null): Speech
  return {
    provider: sanitized.provider === "openai-compatible" ? sanitized.provider : defaultSpeechSettings.provider,
    apiKey: typeof sanitized.apiKey === "string" && sanitized.apiKey.trim() ? sanitized.apiKey.trim() : undefined,
+    hasApiKey: sanitized.hasApiKey === true || (typeof sanitized.apiKey === "string" && sanitized.apiKey.trim().length > 0),
    baseUrl: typeof sanitized.baseUrl === "string" && sanitized.baseUrl.trim() ? sanitized.baseUrl.trim() : undefined,
    sttModel:
      typeof sanitized.sttModel === "string" && sanitized.sttModel.trim()
@@ -388,10 +395,21 @@ function updateLastUsedBinary(path: string): void {
  void patchStateOwner("ui", { opencodeBinaries: nextList }).catch((error) => log.error("Failed to update binary list", error))
 }

-async function updateSpeechSettings(updates: Partial<SpeechSettings>): Promise<void> {
-  const next = normalizeSpeechSettings({ ...serverSettings().speech, ...updates })
+async function updateSpeechSettings(updates: SpeechSettingsUpdate): Promise<void> {
+  const apiKeyPatch = updates.apiKey
+  const { apiKey: _apiKey, ...restUpdates } = updates
+  const next = normalizeSpeechSettings({
+    ...serverSettings().speech,
+    ...restUpdates,
+    ...(apiKeyPatch === null ? {} : { apiKey: apiKeyPatch }),
+  })
+  const { hasApiKey: _hasApiKey, ...persistedSpeech } = next
+  const patch = {
+    ...persistedSpeech,
+    ...(apiKeyPatch === null ? { apiKey: null } : {}),
+  }
  try {
-    await patchConfigOwner("server", { speech: next })
+    await patchConfigOwner("server", { speech: patch })
  } catch (error) {
    log.error("Failed to update speech settings", error)
    throw error