Skip to content

Commit 502f8ca

Browse files
committed
fix(fws): type VSCodeCheckbox change events and the settings test doubles (CodeRabbit, B3b, #1375)
1 parent c48522c commit 502f8ca

3 files changed

Lines changed: 74 additions & 24 deletions

File tree

‎webview-ui/src/components/settings/CheckpointSettings.tsx‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { HTMLAttributes } from "react"
1+
import { HTMLAttributes, type FormEvent } from "react"
22
import { useAppTranslation } from "@/i18n/TranslationContext"
33
import { VSCodeCheckbox, VSCodeLink } from "@vscode/webview-ui-toolkit/react"
44
import { Trans } from "react-i18next"
@@ -18,6 +18,14 @@ import {
1818
type ChangeCardDetail,
1919
} from "@roo-code/types"
2020

21+
/**
22+
* The `checked` state of a VSCodeCheckbox change event. The real toolkit
23+
* dispatches a native `Event` whose current target is the web component;
24+
* the test mock forwards a synthetic event on the underlying input. Both
25+
* expose a boolean `checked` on the current target.
26+
*/
27+
type CheckboxEventTarget = { checked?: boolean }
28+
2129
type CheckpointSettingsProps = HTMLAttributes<HTMLDivElement> & {
2230
enableCheckpoints?: boolean
2331
checkpointTimeout?: number
@@ -49,8 +57,9 @@ export const CheckpointSettings = ({
4957
<VSCodeCheckbox
5058
data-testid="per-write-checkbox"
5159
checked={perWriteCheckpoints ?? DEFAULT_PER_WRITE_CHECKPOINTS}
52-
onChange={(e: any) => {
53-
setCachedStateField("perWriteCheckpoints", e.target.checked)
60+
onChange={(e: Event | FormEvent<HTMLElement>) => {
61+
const target = e.currentTarget as CheckboxEventTarget | null
62+
setCachedStateField("perWriteCheckpoints", target?.checked === true)
5463
}}>
5564
<span className="font-medium">{t("settings:checkpoints.perWrite.label")}</span>
5665
</VSCodeCheckbox>
@@ -65,8 +74,9 @@ export const CheckpointSettings = ({
6574
label={t("settings:checkpoints.changeCardDetail.label")}>
6675
<VSCodeCheckbox
6776
checked={(changeCardDetail ?? DEFAULT_CHANGE_CARD_DETAIL) === "full"}
68-
onChange={(e: any) => {
69-
setCachedStateField("changeCardDetail", e.target.checked ? "full" : "summary")
77+
onChange={(e: Event | FormEvent<HTMLElement>) => {
78+
const target = e.currentTarget as CheckboxEventTarget | null
79+
setCachedStateField("changeCardDetail", target?.checked === true ? "full" : "summary")
7080
}}
7181
data-testid="change-card-detail-checkbox">
7282
<span className="font-medium">{t("settings:checkpoints.changeCardDetail.label")}</span>
@@ -82,8 +92,9 @@ export const CheckpointSettings = ({
8292
label={t("settings:checkpoints.enable.label")}>
8393
<VSCodeCheckbox
8494
checked={enableCheckpoints}
85-
onChange={(e: any) => {
86-
setCachedStateField("enableCheckpoints", e.target.checked)
95+
onChange={(e: Event | FormEvent<HTMLElement>) => {
96+
const target = e.currentTarget as CheckboxEventTarget | null
97+
setCachedStateField("enableCheckpoints", target?.checked === true)
8798
}}>
8899
<span className="font-medium">{t("settings:checkpoints.enable.label")}</span>
89100
</VSCodeCheckbox>

‎webview-ui/src/components/settings/__tests__/CheckpointSettings.spec.tsx‎

Lines changed: 50 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// npx vitest src/components/settings/__tests__/CheckpointSettings.spec.tsx
22

3+
import type { ReactNode } from "react"
34
import { render, screen, fireEvent } from "@/utils/test-utils"
45
import { CheckpointSettings } from "../CheckpointSettings"
56

@@ -29,7 +30,17 @@ vi.mock("@/components/ui", async (importOriginal) => {
2930
const actual = await importOriginal<typeof import("@/components/ui")>()
3031
return {
3132
...actual,
32-
Slider: ({ defaultValue, onValueChange, "data-testid": dataTestId }: any) => (
33+
// Narrow typed double: only the props CheckpointSettings consumes, so
34+
// drift in the Slider contract is a compile error here, not `any`.
35+
Slider: ({
36+
defaultValue,
37+
onValueChange,
38+
"data-testid": dataTestId,
39+
}: {
40+
defaultValue?: number[]
41+
onValueChange?: (value: number[]) => void
42+
"data-testid"?: string
43+
}) => (
3344
<input
3445
type="range"
3546
value={defaultValue?.[0] ?? 0}
@@ -49,21 +60,44 @@ vi.mock("@/utils/vscode", () => ({
4960
}))
5061

5162
// Mock VSCode components to behave like standard HTML elements
52-
vi.mock("@vscode/webview-ui-toolkit/react", () => ({
53-
VSCodeCheckbox: ({ checked, onChange, children, ...props }: any) => (
54-
<label {...props}>
55-
<input
56-
type="checkbox"
57-
role="checkbox"
58-
checked={checked || false}
59-
aria-checked={checked || false}
60-
onChange={(e: any) => onChange?.({ target: { checked: e.target.checked } })}
61-
/>
62-
{children}
63-
</label>
64-
),
65-
VSCodeLink: ({ children, ...props }: any) => <a {...props}>{children}</a>,
66-
}))
63+
vi.mock("@vscode/webview-ui-toolkit/react", () => {
64+
// Narrow event double: the real toolkit dispatches a native Event whose
65+
// currentTarget is the web component with a boolean `checked`; the mock
66+
// forwards the input's checked state on both target and currentTarget so
67+
// handlers can be typed against either surface.
68+
type CheckboxChangeEvent = {
69+
target: { checked: boolean }
70+
currentTarget: { checked: boolean }
71+
}
72+
return {
73+
VSCodeCheckbox: ({
74+
checked,
75+
onChange,
76+
children,
77+
"data-testid": dataTestId,
78+
}: {
79+
checked?: boolean
80+
onChange?: (e: CheckboxChangeEvent) => void
81+
children?: ReactNode
82+
"data-testid"?: string
83+
}) => (
84+
<label data-testid={dataTestId}>
85+
<input
86+
type="checkbox"
87+
role="checkbox"
88+
checked={checked || false}
89+
aria-checked={checked || false}
90+
onChange={(e) => {
91+
const value = e.currentTarget.checked
92+
onChange?.({ target: { checked: value }, currentTarget: { checked: value } })
93+
}}
94+
/>
95+
{children}
96+
</label>
97+
),
98+
VSCodeLink: ({ children, href }: { children?: ReactNode; href?: string }) => <a href={href}>{children}</a>,
99+
}
100+
})
67101

68102
describe("CheckpointSettings", () => {
69103
const setCachedStateField = vi.fn()

‎webview-ui/src/components/settings/__tests__/SettingsView.spec.tsx‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,12 @@ vi.mock("@vscode/webview-ui-toolkit/react", () => ({
3939
<input
4040
type="checkbox"
4141
checked={checked}
42-
onChange={(e) => onChange({ target: { checked: e.target.checked } })}
42+
onChange={(e) => {
43+
// Mirror the real web component: the change event carries the
44+
// checked state on both target and currentTarget.
45+
const value = e.currentTarget.checked
46+
onChange({ target: { checked: value }, currentTarget: { checked: value } })
47+
}}
4348
aria-label={typeof children === "string" ? children : undefined}
4449
data-testid={dataTestId}
4550
/>

0 commit comments

Comments
 (0)