From 4b3c01fde643b1cc35fda4c98e6af8adfd383ccb Mon Sep 17 00:00:00 2001 From: Quick104 <31828688+Quick104@users.noreply.github.com> Date: Fri, 20 Nov 2026 19:01:59 -0500 Subject: [PATCH 1/2] fix(web): stop the setup wizard saving a subtitle key for a provider switched off The Subtitles step hides a provider's credential fields while its switch is off, but Continue still sent whatever had been typed into them. The server stores any non-blank credential whatever `enabled` says, so a key typed and then switched away was saved on a disabled provider the admin could no longer see. A provider switched off now sends only `{ enabled: false }`. Blank credentials already mean "keep the stored value", so anything saved earlier stays; typed values stay in the draft and come back if the provider is switched on again before Continue. Co-Authored-By: Claude Opus 5.5 --- .../setup-wizard/steps/SubtitlesStep.test.tsx | 76 +++++++++++++++++++ .../setup-wizard/steps/SubtitlesStep.tsx | 3 + 2 files changed, 79 insertions(+) create mode 100644 web/src/pages/setup-wizard/steps/SubtitlesStep.test.tsx diff --git a/web/src/pages/setup-wizard/steps/SubtitlesStep.test.tsx b/web/src/pages/setup-wizard/steps/SubtitlesStep.test.tsx new file mode 100644 index 0000000000..8af610cd29 --- /dev/null +++ b/web/src/pages/setup-wizard/steps/SubtitlesStep.test.tsx @@ -0,0 +1,76 @@ +import { render, screen, waitFor } from "@testing-library/react"; +import userEvent from "@testing-library/user-event"; +import { beforeEach, describe, expect, it, vi } from "vitest"; + +import { SubtitlesStep } from "./SubtitlesStep"; + +const wizardMock = vi.fn(); +vi.mock("../WizardContext", () => ({ useWizardContext: () => wizardMock() })); + +const updateMock = vi.fn(); +// One object for every render, as React Query returns stable data; a new one +// each time would restart the step's editor load on every re-render. +const providersQuery = { + data: { + providers: [ + { provider_name: "subdl", enabled: false, has_api_key: false, has_credentials: false }, + ], + }, + isLoading: false, + isError: false, + scope: "scope", + refetch: vi.fn(), +}; +vi.mock("@/hooks/queries/admin/subtitles", () => ({ + useSubtitleProviders: () => providersQuery, + useUpdateSubtitleProvider: () => ({ mutateAsync: updateMock }), + useTestSubtitleProvider: () => ({ mutate: vi.fn(), isPending: false }), +})); + +vi.mock("@/api/v2/adminSubtitleProviderConfiguration", () => ({ + captureProviderEditIntent: (provider: string) => ({ provider }), + providerIntentActive: () => true, + getProviderEditor: (intent: { provider: string }) => + Promise.resolve({ + intent, + etag: '"1"', + body: { + provider_name: intent.provider, + enabled: false, + has_api_key: false, + has_credentials: false, + }, + }), +})); + +class ResizeObserverStub { + observe() {} + unobserve() {} + disconnect() {} +} +globalThis.ResizeObserver ??= ResizeObserverStub as unknown as typeof ResizeObserver; + +describe("SubtitlesStep", () => { + beforeEach(() => { + vi.clearAllMocks(); + wizardMock.mockReturnValue({ markDone: vi.fn(), setSummary: vi.fn() }); + updateMock.mockResolvedValue({ saved_revision: "2", local_apply: "not_configured" }); + }); + + it("leaves out credentials typed for a provider that was switched off again", async () => { + const user = userEvent.setup(); + render(); + + const toggle = screen.getByRole("switch", { name: "Enable SubDL" }); + await waitFor(() => expect(toggle).toBeEnabled()); + await user.click(toggle); + await user.type(screen.getByLabelText("API key"), "typed-key"); + await user.click(toggle); + expect(screen.queryByLabelText("API key")).not.toBeInTheDocument(); + + await user.click(screen.getByRole("button", { name: "Continue" })); + + await waitFor(() => expect(updateMock).toHaveBeenCalledTimes(1)); + expect(updateMock.mock.calls[0]![0].config).toStrictEqual({ enabled: false }); + }); +}); diff --git a/web/src/pages/setup-wizard/steps/SubtitlesStep.tsx b/web/src/pages/setup-wizard/steps/SubtitlesStep.tsx index 49ca5ec5e6..6cdcb75a6f 100644 --- a/web/src/pages/setup-wizard/steps/SubtitlesStep.tsx +++ b/web/src/pages/setup-wizard/steps/SubtitlesStep.tsx @@ -69,6 +69,9 @@ function draftFor(config: SubtitleProviderConfig): ProviderDraft { } function providerBody(name: string, draft: ProviderDraft) { + // Credentials show only while the provider is on, so one switched off sends + // none and the server keeps whatever it already stores. + if (!draft.enabled) return { enabled: false }; return name === "opensubtitles" ? { enabled: draft.enabled, username: draft.username, password: draft.password } : { enabled: draft.enabled, api_key: draft.apiKey }; From e532d2ff770cd014b719fddc1ec0669521eab105 Mon Sep 17 00:00:00 2001 From: Quick104 <31828688+Quick104@users.noreply.github.com> Date: Fri, 20 Nov 2026 19:37:17 -0500 Subject: [PATCH 2/2] test(web): say what an unstable providers mock breaks in SubtitlesStep.test A new `data` object re-runs the step's load effect, whose cleanup cancels an in-flight editor read and leaves the row loading. The old comment said it would restart the load instead. Co-Authored-By: Claude Opus 5.5 --- web/src/pages/setup-wizard/steps/SubtitlesStep.test.tsx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/web/src/pages/setup-wizard/steps/SubtitlesStep.test.tsx b/web/src/pages/setup-wizard/steps/SubtitlesStep.test.tsx index 8af610cd29..81e2323e56 100644 --- a/web/src/pages/setup-wizard/steps/SubtitlesStep.test.tsx +++ b/web/src/pages/setup-wizard/steps/SubtitlesStep.test.tsx @@ -8,8 +8,9 @@ const wizardMock = vi.fn(); vi.mock("../WizardContext", () => ({ useWizardContext: () => wizardMock() })); const updateMock = vi.fn(); -// One object for every render, as React Query returns stable data; a new one -// each time would restart the step's editor load on every re-render. +// Keep `data` the same object across renders, as React Query does. A new one +// re-runs the step's load effect, whose cleanup cancels an editor read still +// in flight and leaves the row loading. const providersQuery = { data: { providers: [