Skip to content

Commit b271080

Browse files
committed
fix(ui): make UI language change consistent (Zoo-Code-Org#2185)
1 parent a4f774b commit b271080

241 files changed

Lines changed: 1383 additions & 1506 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.

‎.roo/rules-translate/001-general-rules.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@
3030
# 4. WEBVIEW UI LOCALIZATION (webview-ui/src/)
3131

3232
- Located in webview-ui/src/i18n/locales/
33-
- Uses standard React i18next patterns with the useTranslation hook
33+
- Use react-i18next's `useTranslation` and `Trans` (`import { Trans, useTranslation } from "react-i18next"`):
34+
- Always pass the component's `t` to `Trans` (`<Trans t={t} i18nKey="..." />`); `Trans` does not follow language changes on its own (ESLint enforces this)
35+
- Never use the global `t` from `i18next` (`i18next.t`); memoized output would keep showing the previous language after a switch (ESLint enforces this). Pass `t` to helpers instead, as `utils/format.ts` and `utils/validate.ts` do
36+
- `useTranslation()` takes fully qualified keys (`t("chat:about")`); `useTranslation("chat")` also takes keys relative to that namespace (`t("about")`); fully qualified keys still work
3437
- All user interface strings should be internationalized
3538
- Always use the Trans component with named components for text with embedded components
3639

@@ -40,6 +43,7 @@
4043

4144
```
4245
<Trans
46+
t={t}
4347
i18nKey="welcome:telemetry.changeSettings"
4448
components={{
4549
settingsLink: <VSCodeLink href="#" onClick={handleOpenSettings} />

‎.roo/skills/roo-translation/SKILL.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,10 @@ This guidance file is loaded at runtime and should be consulted for the latest b
7070
## WebView UI Localization (webview-ui/src/)
7171

7272
- Located in `webview-ui/src/i18n/locales/`
73-
- Uses standard React i18next patterns with the `useTranslation` hook
73+
- Use react-i18next's `useTranslation` and `Trans` (`import { Trans, useTranslation } from "react-i18next"`):
74+
- Always pass the component's `t` to `Trans` (`<Trans t={t} i18nKey="..." />`); `Trans` does not follow language changes on its own (ESLint enforces this)
75+
- Never use the global `t` from `i18next` (`i18next.t`); memoized output would keep showing the previous language after a switch (ESLint enforces this). Pass `t` to helpers instead, as `utils/format.ts` and `utils/validate.ts` do
76+
- `useTranslation()` takes fully qualified keys (`t("chat:about")`); `useTranslation("chat")` also takes keys relative to that namespace (`t("about")`); fully qualified keys still work
7477
- All user interface strings should be internationalized
7578
- Always use the `Trans` component with named components for text with embedded components
7679

@@ -86,6 +89,7 @@ React component usage:
8689

8790
```tsx
8891
<Trans
92+
t={t}
8993
i18nKey="welcome:telemetry.changeSettings"
9094
components={{
9195
settingsLink: <VSCodeLink href="#" onClick={handleOpenSettings} />,

‎packages/types/src/vscode-extension-host.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,13 @@ export type ExtensionState = Pick<
450450
* (captured during async getStateToPostToWebview) from overwriting newer messages.
451451
*/
452452
clineMessagesSeq?: number
453+
454+
/**
455+
* Monotonically increasing sequence number for every state snapshot, assigned before the
456+
* snapshot is read. Snapshots are built asynchronously and can be posted out of order, so the
457+
* frontend applies `language` only from a snapshot newer than the last one it applied.
458+
*/
459+
stateSeq?: number
453460
}
454461

455462
export interface Command {

‎webview-ui/eslint.config.mjs‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,40 @@ export default [
8080
],
8181
},
8282
},
83+
{
84+
// Translations must come from the component's `t` (react-i18next's `useTranslation`), which changes
85+
// identity on a language switch; the global `t` gives React (and React Compiler caches) nothing to
86+
// invalidate on, so memoized output would keep the previous language.
87+
files: ["src/**/*.{ts,tsx}"],
88+
ignores: ["src/i18n/**"],
89+
rules: {
90+
"no-restricted-imports": [
91+
"error",
92+
{
93+
paths: [
94+
{
95+
name: "i18next",
96+
importNames: ["t"],
97+
message:
98+
"Use t from react-i18next's useTranslation so memoized output follows language changes.",
99+
},
100+
],
101+
},
102+
],
103+
"no-restricted-syntax": [
104+
"error",
105+
{
106+
selector: "MemberExpression[object.name='i18next'][property.name='t']",
107+
message: "Use t from react-i18next's useTranslation so memoized output follows language changes.",
108+
},
109+
{
110+
selector: "JSXOpeningElement[name.name='Trans']:not(:has(JSXAttribute[name.name='t']))",
111+
message:
112+
"Pass t={t} from useTranslation: Trans does not subscribe to language changes, so a cached <Trans> keeps the previous language.",
113+
},
114+
],
115+
},
116+
},
83117
{
84118
files: ["src/__mocks__/**/*.js"],
85119
rules: {

‎webview-ui/playwright/AppProviders.tsx‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@ import { I18nextProvider } from "react-i18next"
44
import { providerIdentifiers } from "@roo-code/types"
55

66
import { ExtensionStateContextProvider } from "@/context/ExtensionStateContext"
7-
import TranslationProvider from "@/i18n/TranslationContext"
87
import i18next from "@/i18n/setup"
98
import { TooltipProvider } from "@/components/ui/tooltip"
10-
import { TranslationContext as PlaywrightTranslationContext } from "@src/i18n/TranslationContext"
119

1210
type InitialState = NonNullable<React.ComponentProps<typeof ExtensionStateContextProvider>["initialState"]>
1311

@@ -40,16 +38,11 @@ export function AppProviders({ children, initialState }: AppProvidersProps) {
4038
return (
4139
<I18nextProvider i18n={i18next}>
4240
<ExtensionStateContextProvider initialState={{ ...defaultInitialState, ...initialState }}>
43-
<TranslationProvider>
44-
<PlaywrightTranslationContext.Provider
45-
value={{ t: (key, options) => i18next.t(key, options), i18n: i18next }}>
46-
<QueryClientProvider client={queryClient}>
47-
<TooltipProvider>
48-
<div data-testid="ct-app-shell">{children}</div>
49-
</TooltipProvider>
50-
</QueryClientProvider>
51-
</PlaywrightTranslationContext.Provider>
52-
</TranslationProvider>
41+
<QueryClientProvider client={queryClient}>
42+
<TooltipProvider>
43+
<div data-testid="ct-app-shell">{children}</div>
44+
</TooltipProvider>
45+
</QueryClientProvider>
5346
</ExtensionStateContextProvider>
5447
</I18nextProvider>
5548
)

‎webview-ui/playwright/TranslationContext.ts‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎webview-ui/playwright/vite.config.ts‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,6 @@ export default defineConfig({
4848
find: "@src/context/ExtensionStateContext",
4949
replacement: path.resolve(dirname, "ExtensionStateContext.tsx"),
5050
},
51-
{
52-
find: "@src/i18n/TranslationContext",
53-
replacement: path.resolve(dirname, "TranslationContext.ts"),
54-
},
5551
{ find: "@", replacement: path.resolve(webviewRoot, "src") },
5652
{ find: "@src", replacement: path.resolve(webviewRoot, "src") },
5753
{ find: "@roo", replacement: path.resolve(webviewRoot, "../src/shared") },

‎webview-ui/src/App.tsx‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { QueryClient, QueryClientProvider } from "@tanstack/react-query"
44

55
import { type ExtensionMessage, TelemetryEventName } from "@roo-code/types"
66

7-
import TranslationProvider from "./i18n/TranslationContext"
7+
import "./i18n/setup"
88
import { MarketplaceViewStateManager } from "./components/marketplace/MarketplaceViewStateManager"
99

1010
import { vscode } from "./utils/vscode"
@@ -356,13 +356,11 @@ const queryClient = new QueryClient()
356356
const AppWithProviders = () => (
357357
<ErrorBoundary>
358358
<ExtensionStateContextProvider>
359-
<TranslationProvider>
360-
<QueryClientProvider client={queryClient}>
361-
<TooltipProvider delayDuration={STANDARD_TOOLTIP_DELAY}>
362-
<App />
363-
</TooltipProvider>
364-
</QueryClientProvider>
365-
</TranslationProvider>
359+
<QueryClientProvider client={queryClient}>
360+
<TooltipProvider delayDuration={STANDARD_TOOLTIP_DELAY}>
361+
<App />
362+
</TooltipProvider>
363+
</QueryClientProvider>
366364
</ExtensionStateContextProvider>
367365
</ErrorBoundary>
368366
)

‎webview-ui/src/__tests__/App.spec.tsx‎

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -117,36 +117,18 @@ vi.mock("react-i18next", () => {
117117
MockedComponent.displayName = `withTranslation(${Component.displayName || Component.name || "Component"})`
118118
return MockedComponent
119119
},
120-
Trans: ({ children }: { children: React.ReactNode }) => <>{children}</>,
121-
useTranslation: () => {
122-
return {
123-
t: tFunction,
124-
i18n: {
125-
t: tFunction,
126-
changeLanguage: vi.fn(() => Promise.resolve()),
127-
},
128-
}
129-
},
130-
initReactI18next: {
131-
type: "3rdParty",
132-
init: vi.fn(),
133-
},
134-
}
135-
})
136-
137-
// Mock TranslationProvider to pass through children
138-
vi.mock("@src/i18n/TranslationContext", () => {
139-
const tFunction = (key: string) => key
140-
return {
141-
__esModule: true,
142-
default: ({ children }: { children: React.ReactNode }) => <>{children}</>,
143-
useAppTranslation: () => ({
120+
useTranslation: () => ({
144121
t: tFunction,
145122
i18n: {
146123
t: tFunction,
147124
changeLanguage: vi.fn(() => Promise.resolve()),
148125
},
149126
}),
127+
Trans: ({ children }: { children: React.ReactNode }) => <>{children}</>,
128+
initReactI18next: {
129+
type: "3rdParty",
130+
init: vi.fn(),
131+
},
150132
}
151133
})
152134

‎webview-ui/src/__tests__/FileChangesPanel.spec.tsx‎

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import React from "react"
22
import { act } from "@testing-library/react"
33
import { fireEvent, render, screen } from "@/utils/test-utils"
44
import type { ClineMessage } from "@roo-code/types"
5-
import { TranslationProvider } from "@/i18n/__mocks__/TranslationContext"
65
import FileChangesPanel from "../components/chat/FileChangesPanel"
76

87
const mockPostMessage = vi.fn()
@@ -69,11 +68,7 @@ function createFileEditMessage(
6968
}
7069

7170
function renderPanel(messages: ClineMessage[] | undefined, taskId?: string) {
72-
return render(
73-
<TranslationProvider>
74-
<FileChangesPanel clineMessages={messages} taskId={taskId} />
75-
</TranslationProvider>,
76-
)
71+
return render(<FileChangesPanel clineMessages={messages} taskId={taskId} />)
7772
}
7873

7974
describe("FileChangesPanel", () => {
@@ -333,11 +328,7 @@ describe("FileChangesPanel", () => {
333328
expandRow()
334329
expect(requestsOfType("readOriginalContent")).toHaveLength(1)
335330

336-
rerender(
337-
<TranslationProvider>
338-
<FileChangesPanel clineMessages={messages} taskId="task-1" />
339-
</TranslationProvider>,
340-
)
331+
rerender(<FileChangesPanel clineMessages={messages} taskId="task-1" />)
341332
fireEvent.click(screen.getByTestId("accordian-toggle"))
342333

343334
const requests = requestsOfType("readOriginalContent")
@@ -347,11 +338,7 @@ describe("FileChangesPanel", () => {
347338

348339
it("does not send a duplicate request when switching A -> B -> A before the first response arrives", () => {
349340
const messages = [createEditWithOriginal({ originalContentLength: 5000 })]
350-
const panel = (taskId: string) => (
351-
<TranslationProvider>
352-
<FileChangesPanel clineMessages={messages} taskId={taskId} />
353-
</TranslationProvider>
354-
)
341+
const panel = (taskId: string) => <FileChangesPanel clineMessages={messages} taskId={taskId} />
355342
const { rerender } = renderPanel(messages, "task-A")
356343
expandRow()
357344
expect(requestsOfType("readOriginalContent")).toHaveLength(1)
@@ -372,11 +359,7 @@ describe("FileChangesPanel", () => {
372359

373360
it("requests again after a response that arrived for a task that is no longer current", () => {
374361
const messages = [createEditWithOriginal({ originalContentLength: 5000 })]
375-
const panel = (taskId: string) => (
376-
<TranslationProvider>
377-
<FileChangesPanel clineMessages={messages} taskId={taskId} />
378-
</TranslationProvider>
379-
)
362+
const panel = (taskId: string) => <FileChangesPanel clineMessages={messages} taskId={taskId} />
380363
const { rerender } = renderPanel(messages, "task-A")
381364
expandRow()
382365

@@ -397,11 +380,7 @@ describe("FileChangesPanel", () => {
397380
expandRow()
398381
mockPostMessage.mockClear()
399382

400-
rerender(
401-
<TranslationProvider>
402-
<FileChangesPanel clineMessages={messages} taskId="task-B" />
403-
</TranslationProvider>,
404-
)
383+
rerender(<FileChangesPanel clineMessages={messages} taskId="task-B" />)
405384

406385
expect(mockPostMessage).not.toHaveBeenCalled()
407386
})
@@ -417,11 +396,7 @@ describe("FileChangesPanel", () => {
417396
})
418397
expect(requestsOfType("readOriginalContent")).toHaveLength(1)
419398

420-
rerender(
421-
<TranslationProvider>
422-
<FileChangesPanel clineMessages={[...first]} taskId="task-A" />
423-
</TranslationProvider>,
424-
)
399+
rerender(<FileChangesPanel clineMessages={[...first]} taskId="task-A" />)
425400
fireEvent.click(screen.getByTestId("accordian-toggle"))
426401
respond({ type: "fileContent", fileContent: { path: "src/foo.ts", content: "new line\n" } })
427402

0 commit comments

Comments
 (0)