Skip to content

Commit fec4e13

Browse files
zoomote[bot]roomoteedelauna
authored
[Improve] Keep shared controls legible across IDE themes (#1333)
* test(webview): add WCAG contrast audit * test(webview): add contrast snapshot baselines * test(webview): harden contrast assertions * test(webview): refresh resting contrast baselines * test(webview): refresh focus contrast baselines * fix(webview): strengthen field focus contrast * test(webview): capture accessible focus baselines * test(webview): assign visual fixtures to CT coverage * docs(webview): document CI visual baseline fallback * test(webview): snapshot production chat and UI settings * fix(webview): scope visual test type shim * fix(webview): align contrast tests with modern themes * test(webview): add pinned production baselines * test(webview): refresh modern theme baselines * test(webview): refresh light dialog baseline * test(webview): isolate settings theme surfaces * test(webview): refresh light settings baselines * test(webview): generate themes from pinned VS Code * test(webview): refresh generated theme baselines * test(webview): align generated theme expectations * test(webview): refresh interactive theme states * test(webview): refresh focused theme baselines * test(webview): refresh dark dialog baseline * ci(webview): check generated theme drift * test(webview): stabilize generated theme fonts * test(webview): normalize fixture typography * test(webview): cover theme fixture validation * refactor(theme-fixtures): move theme probe off the public API * fix(webview): restore button mock styles lost in theme migration * test(webview): cover theme probe lifecycle --------- Co-authored-by: Roomote <[email protected]> Co-authored-by: Elliott de Launay <[email protected]>
1 parent 6ad8a6e commit fec4e13

96 files changed

Lines changed: 4716 additions & 281 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/visual-regression.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ on:
55
pull_request:
66
types: [opened, reopened, ready_for_review, synchronize]
77
paths:
8+
- "apps/vscode-e2e/package.json"
9+
- "apps/vscode-e2e/src/theme-fixtures/**"
10+
- "packages/types/src/api.ts"
11+
- "packages/types/src/vscode-extension-host.ts"
12+
- "src/core/webview/ClineProvider.ts"
13+
- "src/core/webview/webviewMessageHandler.ts"
14+
- "src/extension/api.ts"
815
- "webview-ui/**"
916
- "src/shared/**"
1017
- "package.json"
@@ -55,3 +62,32 @@ jobs:
5562
webview-ui/playwright-report
5663
webview-ui/test-results
5764
if-no-files-found: ignore
65+
66+
theme-fixtures:
67+
runs-on: ubuntu-latest
68+
timeout-minutes: 15
69+
steps:
70+
- name: Checkout code
71+
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
72+
with:
73+
persist-credentials: false
74+
- name: Setup Node.js and pnpm
75+
uses: ./.github/actions/setup-node-pnpm
76+
with:
77+
install-args: "--frozen-lockfile"
78+
- name: Install xvfb
79+
run: sudo apt-get install -y xvfb
80+
- name: Get pinned VS Code version
81+
id: vscode-version
82+
run: |
83+
VERSION=$(node -p 'require("./apps/vscode-e2e/package.json").devDependencies["@types/vscode"]')
84+
echo "version=$VERSION" >> "$GITHUB_OUTPUT"
85+
- name: Cache pinned VS Code
86+
uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
87+
with:
88+
path: apps/vscode-e2e/.vscode-test/
89+
key: vscode-theme-fixtures-${{ runner.os }}-${{ steps.vscode-version.outputs.version }}-v1
90+
- name: Test theme fixture serialization
91+
run: pnpm --filter @roo-code/vscode-e2e themes:test
92+
- name: Check generated VS Code theme fixtures
93+
run: xvfb-run -a pnpm --filter @roo-code/vscode-e2e themes:check

‎apps/vscode-e2e/package.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
"test:ci:mock": "pnpm -w bundle && pnpm --filter @roo-code/vscode-webview build && USE_MOCK=true pnpm test:run",
1010
"test:record": "AIMOCK_RECORD=true pnpm test:ci",
1111
"test:run": "rimraf out && tsc -p tsconfig.json && dotenv -e .env.local -- node ./out/runTest.js",
12+
"themes:build": "pnpm -w bundle && pnpm --filter @roo-code/vscode-webview build && rimraf out && tsc -p tsconfig.json",
13+
"themes:update": "pnpm themes:build && node ./out/theme-fixtures/generate.js update",
14+
"themes:check": "pnpm themes:build && node ./out/theme-fixtures/generate.js check",
15+
"themes:test": "pnpm --filter @roo-code/types build && rimraf out && tsc -p tsconfig.json && node --test ./out/theme-fixtures/fixtures.test.js",
1216
"clean": "rimraf out .turbo"
1317
},
1418
"devDependencies": {
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
export const themeFixtureDefinitions = [
2+
{
3+
name: "dark",
4+
themeId: "Default Dark Modern",
5+
bodyClass: "vscode-dark",
6+
colorScheme: "dark",
7+
kind: "dark",
8+
},
9+
{
10+
name: "light",
11+
themeId: "Default Light Modern",
12+
bodyClass: "vscode-light",
13+
colorScheme: "light",
14+
kind: "light",
15+
},
16+
{
17+
name: "high-contrast",
18+
themeId: "Default High Contrast",
19+
bodyClass: "vscode-high-contrast",
20+
colorScheme: "dark",
21+
kind: "high-contrast",
22+
},
23+
{
24+
name: "high-contrast-light",
25+
themeId: "Default High Contrast Light",
26+
bodyClass: "vscode-high-contrast-light",
27+
colorScheme: "light",
28+
kind: "high-contrast-light",
29+
},
30+
] as const
31+
32+
export type ThemeFixtureDefinition = (typeof themeFixtureDefinitions)[number]
33+
34+
export function getThemeFixtureFileName(theme: ThemeFixtureDefinition): string {
35+
return `vscode-theme-${theme.name}.css`
36+
}
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
import fs from "fs/promises"
2+
3+
import * as vscode from "vscode"
4+
5+
import type { RooCodeTestAPI, WebviewThemeFixture } from "@roo-code/types"
6+
7+
import { themeFixtureDefinitions, type ThemeFixtureDefinition } from "./definitions"
8+
9+
const POLL_INTERVAL_MS = 100
10+
const THEME_TIMEOUT_MS = 20_000
11+
12+
const colorThemeKinds: Record<ThemeFixtureDefinition["kind"], vscode.ColorThemeKind> = {
13+
dark: vscode.ColorThemeKind.Dark,
14+
light: vscode.ColorThemeKind.Light,
15+
"high-contrast": vscode.ColorThemeKind.HighContrast,
16+
"high-contrast-light": vscode.ColorThemeKind.HighContrastLight,
17+
}
18+
19+
async function poll<T>(capture: () => Promise<T>, matches: (value: T) => boolean, description: string): Promise<T> {
20+
const deadline = Date.now() + THEME_TIMEOUT_MS
21+
let latest: T | undefined
22+
23+
while (Date.now() < deadline) {
24+
latest = await capture()
25+
if (matches(latest)) {
26+
return latest
27+
}
28+
await new Promise((resolve) => setTimeout(resolve, POLL_INTERVAL_MS))
29+
}
30+
31+
throw new Error(`Timed out waiting for ${description}; latest value: ${JSON.stringify(latest)}`)
32+
}
33+
34+
function matchesTheme(fixture: WebviewThemeFixture, theme: ThemeFixtureDefinition): boolean {
35+
return fixture.themeId === theme.themeId && fixture.bodyClass.split(/\s+/).includes(theme.bodyClass)
36+
}
37+
38+
export async function run(): Promise<void> {
39+
if (process.env.ROO_CODE_THEME_FIXTURE_PROBE !== "1") {
40+
throw new Error("ROO_CODE_THEME_FIXTURE_PROBE must be set to 1")
41+
}
42+
43+
const outputPath = process.env.ROO_CODE_THEME_FIXTURE_CAPTURE_PATH
44+
const expectedVersion = process.env.ROO_CODE_THEME_FIXTURE_VSCODE_VERSION
45+
if (!outputPath || !expectedVersion) {
46+
throw new Error("Theme fixture output path and VS Code version are required")
47+
}
48+
if (vscode.version !== expectedVersion) {
49+
throw new Error(`Expected VS Code ${expectedVersion}, launched ${vscode.version}`)
50+
}
51+
52+
const extension = vscode.extensions.getExtension<RooCodeTestAPI>("ZooCodeOrganization.zoo-code")
53+
if (!extension) {
54+
throw new Error("Zoo Code extension not found")
55+
}
56+
const api = extension.isActive ? extension.exports : await extension.activate()
57+
58+
await vscode.commands.executeCommand("zoo-code.SidebarProvider.focus")
59+
await poll(async () => api.isReady(), Boolean, "Zoo Code webview activation")
60+
61+
const captures: Record<string, WebviewThemeFixture> = {}
62+
for (const theme of themeFixtureDefinitions) {
63+
await vscode.workspace
64+
.getConfiguration("workbench")
65+
.update("colorTheme", theme.themeId, vscode.ConfigurationTarget.Global)
66+
await poll(
67+
async () => vscode.window.activeColorTheme.kind,
68+
(kind) => kind === colorThemeKinds[theme.kind],
69+
`${theme.themeId} color theme kind`,
70+
)
71+
captures[theme.name] = await poll(
72+
() => api.captureWebviewThemeFixture(),
73+
(fixture) => matchesTheme(fixture, theme),
74+
`${theme.themeId} webview identity`,
75+
)
76+
}
77+
78+
await fs.writeFile(outputPath, `${JSON.stringify(captures, null, 2)}\n`, "utf8")
79+
}
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
import assert from "node:assert/strict"
2+
import test from "node:test"
3+
4+
import type { WebviewThemeFixture } from "@roo-code/types"
5+
6+
import { themeFixtureDefinitions } from "./definitions"
7+
import { createSerializedFixtures, findDriftedFixtures, serializeThemeFixture } from "./fixtures"
8+
9+
const validVariables = Object.fromEntries(
10+
Array.from({ length: 100 }, (_, index) => [`--vscode-test-${index}`, "#000000"]),
11+
)
12+
const validFixture: WebviewThemeFixture = {
13+
themeId: "Default Dark Modern",
14+
bodyClass: "vscode-dark",
15+
variables: {
16+
...validVariables,
17+
"--vscode-foreground": "#cccccc",
18+
"--vscode-editor-background": "#1f1f1f",
19+
"--vscode-button-foreground": "#ffffff",
20+
},
21+
}
22+
23+
test("serializeThemeFixture sorts variables and emits stable metadata", () => {
24+
const fixture: WebviewThemeFixture = {
25+
themeId: "Default Dark Modern",
26+
bodyClass: "vscode-dark",
27+
variables: {
28+
"--vscode-z-last": "rgb(2, 2, 2)",
29+
"--vscode-a-first": "#010101",
30+
"--vscode-font-family": "platform-dependent",
31+
},
32+
}
33+
34+
assert.equal(
35+
serializeThemeFixture(themeFixtureDefinitions[0], fixture, "1.100.0"),
36+
[
37+
"/* Generated from Default Dark Modern by VS Code 1.100.0. Do not edit manually. */",
38+
".vscode-dark {",
39+
"\tcolor-scheme: dark;",
40+
"\t--vscode-a-first: #010101;",
41+
"\t--vscode-z-last: rgb(2, 2, 2);",
42+
"}",
43+
"",
44+
].join("\n"),
45+
)
46+
})
47+
48+
test("findDriftedFixtures reports missing and changed files in sorted order", () => {
49+
const expected = new Map([
50+
["vscode-theme-light.css", "light"],
51+
["vscode-theme-dark.css", "dark"],
52+
])
53+
const actual = new Map<string, string | undefined>([["vscode-theme-light.css", "stale"]])
54+
55+
assert.deepEqual(findDriftedFixtures(expected, actual), ["vscode-theme-dark.css", "vscode-theme-light.css"])
56+
})
57+
58+
test("createSerializedFixtures rejects incomplete captures", () => {
59+
const fixture: WebviewThemeFixture = {
60+
...validFixture,
61+
variables: {
62+
...validVariables,
63+
"--vscode-foreground": "#cccccc",
64+
"--vscode-editor-background": "#1f1f1f",
65+
},
66+
}
67+
68+
assert.throws(
69+
() => createSerializedFixtures(new Map([["dark", fixture]]), "1.100.0", [themeFixtureDefinitions[0]]),
70+
/--vscode-button-foreground/,
71+
)
72+
})
73+
74+
test("createSerializedFixtures rejects an empty capture", () => {
75+
assert.throws(
76+
() =>
77+
createSerializedFixtures(new Map([["dark", { ...validFixture, variables: {} }]]), "1.100.0", [
78+
themeFixtureDefinitions[0],
79+
]),
80+
/fewer than 100/,
81+
)
82+
})
83+
84+
test("createSerializedFixtures rejects the wrong theme identity", () => {
85+
assert.throws(
86+
() =>
87+
createSerializedFixtures(
88+
new Map([["dark", { ...validFixture, themeId: "Default Light Modern" }]]),
89+
"1.100.0",
90+
[themeFixtureDefinitions[0]],
91+
),
92+
/Expected Default Dark Modern/,
93+
)
94+
})
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
import type { WebviewThemeFixture } from "@roo-code/types"
2+
3+
import { getThemeFixtureFileName, type ThemeFixtureDefinition } from "./definitions"
4+
5+
const requiredVariables = ["--vscode-foreground", "--vscode-editor-background", "--vscode-button-foreground"]
6+
const minimumVariableCount = 100
7+
const environmentVariables = new Set(["--vscode-font-family", "--vscode-editor-font-family"])
8+
9+
export function validateThemeFixture(theme: ThemeFixtureDefinition, fixture: WebviewThemeFixture): void {
10+
if (fixture.themeId !== theme.themeId) {
11+
throw new Error(`Expected ${theme.themeId}, captured ${fixture.themeId || "an unknown theme"}`)
12+
}
13+
if (!fixture.bodyClass.split(/\s+/).includes(theme.bodyClass)) {
14+
throw new Error(`Expected ${theme.bodyClass}, captured body classes: ${fixture.bodyClass || "none"}`)
15+
}
16+
if (Object.keys(fixture.variables).length < minimumVariableCount) {
17+
throw new Error(`${theme.themeId} exposed fewer than ${minimumVariableCount} VS Code theme variables`)
18+
}
19+
for (const property of requiredVariables) {
20+
if (!fixture.variables[property]) {
21+
throw new Error(`${theme.themeId} did not expose required variable ${property}`)
22+
}
23+
}
24+
for (const [property, value] of Object.entries(fixture.variables)) {
25+
if (!property.startsWith("--vscode-") || !value) {
26+
throw new Error(`${theme.themeId} exposed an invalid theme variable: ${property}`)
27+
}
28+
}
29+
}
30+
31+
export function serializeThemeFixture(
32+
theme: ThemeFixtureDefinition,
33+
fixture: WebviewThemeFixture,
34+
vscodeVersion: string,
35+
): string {
36+
const declarations = Object.entries(fixture.variables)
37+
.filter(([property]) => !environmentVariables.has(property))
38+
.sort(([left], [right]) => (left < right ? -1 : left > right ? 1 : 0))
39+
.map(([property, value]) => `\t${property}: ${value};`)
40+
41+
return [
42+
`/* Generated from ${theme.themeId} by VS Code ${vscodeVersion}. Do not edit manually. */`,
43+
`.${theme.bodyClass} {`,
44+
`\tcolor-scheme: ${theme.colorScheme};`,
45+
...declarations,
46+
"}",
47+
"",
48+
].join("\n")
49+
}
50+
51+
export function createSerializedFixtures(
52+
captures: ReadonlyMap<string, WebviewThemeFixture>,
53+
vscodeVersion: string,
54+
themes: readonly ThemeFixtureDefinition[],
55+
): Map<string, string> {
56+
return new Map(
57+
themes.map((theme) => {
58+
const capture = captures.get(theme.name)
59+
if (!capture) {
60+
throw new Error(`Missing captured theme fixture: ${theme.name}`)
61+
}
62+
validateThemeFixture(theme, capture)
63+
64+
return [getThemeFixtureFileName(theme), serializeThemeFixture(theme, capture, vscodeVersion)]
65+
}),
66+
)
67+
}
68+
69+
export function findDriftedFixtures(
70+
expected: ReadonlyMap<string, string>,
71+
actual: ReadonlyMap<string, string | undefined>,
72+
): string[] {
73+
return [...expected.entries()]
74+
.filter(([fileName, contents]) => actual.get(fileName) !== contents)
75+
.map(([fileName]) => fileName)
76+
.sort()
77+
}

0 commit comments

Comments
 (0)