Feat/profile switch language by lfbraz · Pull Request #1172 · databrickslabs/dqx

lfbraz · 2026-05-11T20:39:57Z

Changes

Linked issues

Tests

Documentation and Demos

Adds in-app language switching to DQX Studio, surfaced from the user's Profile page. The studio now ships with four locales (English, Portuguese-BR, Italian, Spanish) and persists the user's choice per-browser without touching server-side state.

Frontend — i18n infrastructure

Add i18next + react-i18next + i18next-browser-languagedetector to app/package.json.
New app/src/databricks_labs_dqx_app/ui/lib/i18n/index.ts bootstraps i18next with fallbackLng: "en", supportedLngs whitelist, and a detector chain of localStorage → navigator (cached under dqx.language).
Wire the bootstrap into app/src/databricks_labs_dqx_app/ui/main.tsx so translations are initialized before the router mounts.
Add four locale files under app/src/databricks_labs_dqx_app/ui/lib/i18n/locales/ (en.json, pt-BR.json, it.json, es.json) — keys mirror the existing UI copy across header, sidebar, profile, runs, rules, profiler, discovery, config, and labels surfaces.

Frontend — UI

New app/src/databricks_labs_dqx_app/ui/components/apx/LanguageSelector.tsx: shadcn Select showing each language by native label (with English label as secondary hint); on change it calls i18n.changeLanguage and updates document.documentElement.lang.
New Preferences card on app/src/databricks_labs_dqx_app/ui/routes/_sidebar/profile.tsx hosts the selector.
Replace hard-coded strings with t(...) calls across the sidebar routes (config.tsx, discovery.tsx, home.tsx, profile.tsx, profiler.tsx, rules.active.tsx, rules.create.tsx, rules.create-sql.tsx, rules.drafts.tsx, rules.import.tsx, rules.single-table.tsx, runs.tsx, runs-history.tsx, route.tsx) and shared components (HeaderUserMenu, PageBreadcrumb, SidebarLayout, SidebarUserFooter, mode-toggle, AICheckGenerator, AuthGuard, CatalogBrowser, ColumnDiscoveryPanel, CommentThread, DryRunResults, Labels, RoleManagement, RulesReview).
Behaviour preserved: this is a string-extraction refactor — no logic, routes, RBAC, or API contracts changed.

Docs

Add a Profile preferences → Language section to docs/dqx/docs/guide/dqx_studio.mdx covering supported locales, persistence behavior, scope (per-user, UI only), and a caution note that non-English translations are AI-generated and not yet reviewed by native speakers.

Notes for reviewers

Persistence is browser-local (localStorage); no backend or table changes.
No new dependencies in the Python wheel — frontend-only.
Non-English copy was AI-assisted; native-speaker review welcome (as I'm a Portuguese native speaker, I already reviewed all the PT-BR sections).

Images

added/updated demos
added/updated docs
added/updated agent skills

ghanse

Solid i18n landing — clean key parity across en/es/it/pt-BR, JSON validates, and every route I spot-checked routes user-facing strings through t(). Two functional gotchas to address before merge: (1) <html lang> is never synchronized when LanguageDetector picks a non-English locale on first load (a11y / screen-reader regression), and (2) rulesSingleTable.summary / duplicateChecksExist_* interpolate a hard-coded English "s" via {{tablesPlural}}/{{checksPlural}}/{{rulesPlural}} placeholders, which the non-English translators correctly dropped — producing a placeholder-count divergence and defeating proper pluralization.

Smaller items addressed inline: t in AuthGuard's effect deps, all four locales bundled eagerly (~262 KB raw), ~50 unused common.* keys. Recommend adding a make app-check script that asserts placeholder-set parity across locales to prevent this class of bug going forward.

Two follow-ups on pre-existing code that this PR makes newly relevant (not anchorable to the diff, hence here in the summary):

app/src/databricks_labs_dqx_app/ui/routes/_sidebar/config.tsx ~ lines 60 and 66 — Intl.DateTimeFormat("en-US", …) is hard-coded for two timezone-label formatters. Every user (including pt-BR / es / it) sees timezone short names (PST, CET) and offset formatting in English. Pass undefined (browser default) or i18n.language so this matches the rest of the UI. format-utils.ts already uses undefined, so this is the only outlier.
app/src/databricks_labs_dqx_app/ui/routes/_sidebar/rules.drafts.tsx:7 (also rules.active.tsx:54,148, runs-history.tsx:243) — the synthetic catalog label "Cross-table rules" is used both as an internal filter id and rendered to the user. With i18n in this PR, it should be translated at render time while keeping the internal id stable, e.g. cat === CROSS_TABLE_CATALOG ? t("common.crossTableRules") : cat. Most visible untranslated remnant.

Co-authored-by: Greg Hansen <163584195+ghanse@users.noreply.github.com>

CLAassistant · 2026-05-22T16:03:57Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
3 out of 4 committers have signed the CLA.

✅ lfbraz
✅ mwojtyczka
✅ ghanse
❌ berrybluecode
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

lfbraz · 2026-05-22T19:14:20Z

Hi @ghanse . Thanks for your review. I've tried to apply all the suggestions. Please let me know if they are OK or if there are any missing issues. I really appreciate your support!

mwojtyczka · 2026-06-02T16:54:10Z

Hi @ghanse . Thanks for your review. I've tried to apply all the suggestions. Please let me know if they are OK or if there are any missing issues. I really appreciate your support!

@lfbraz thank you for the PR. I posted additional comments.

mwojtyczka · 2026-06-05T21:51:22Z

Hi @lfbraz , could you please give me permission to push code to your folk as I would like to resolve the conflicts. Also, are there only three language added? We need to add more languages for the next step

I think this is fine. We can have follow up PRs to add more languages

mwojtyczka

Re-reviewed after the latest round — thanks for the thorough fixes. Verified and resolved 13 of the 14 threads (a11y <html lang> sync, AuthGuard t ref, lazy-loading, useId/aria-label, locale-switch .catch, the blank-page .catch, the common.* cleanup, the Italian discovery translation, and the CLAUDE.md i18n section all check out; locale key sets are now at full parity — 1142 keys in each of the 4 files). Left the CI placeholder-parity-check thread open since that's a pending follow-up rather than a code fix.

One residual instance of the same plural anti-pattern from the (now-fixed) rules.single-table.tsx thread — flagged inline.

berrybluecode · 2026-06-07T09:20:01Z

resolved the conflicts

Replace the {{tablesPlural}}/{{checksPlural}} placeholders in rulesActive.tablesAndChecks and checksAcrossTables with native i18next _one/_other fragment keys (tablesCount/checksCount) composed via nested t() calls, matching the existing rulesSingleTable.summary pattern. This fixes broken plurals in es/it/pt-BR (e.g. 'verificacións' -> proper 'verificaciones'). Keys added to all four locales; parity preserved. Co-authored-by: Isaac

New pytest (runs under `make app-test`, no JS toolchain needed) asserts, with en.json as source of truth, that every locale has: - the same key set (catches keys that silently fall back to English), and - the same {{placeholder}} set per key (catches missing/extra interpolation that triggers i18next missingInterpolation), and that no locale uses a hard-coded {{*Plural}} placeholder (use native _one/_other + {{count}} instead) — the anti-pattern fixed in 9830447, which placeholder-set parity alone would not catch since all locales shared it. Co-authored-by: Isaac

mwojtyczka

LGTM

lfbraz · 2026-06-08T13:38:02Z

Thanks for the reviews, guys. Please let me know if you need anything else from my side at this time.

Fixes TS6133 'formatLabel is declared but its value is never read' that broke the Build and Check App TypeScript compilation in CI. Co-authored-by: Isaac

lfbraz added 3 commits May 11, 2026 15:21

Add Switch language to the user's profile

efc1783

Add yarn.lock

67add8a

Add switch language feature to the doc

797d653

lfbraz requested a review from a team as a code owner May 11, 2026 20:39

lfbraz requested review from grusin-db and removed request for a team May 11, 2026 20:39

ghanse reviewed May 21, 2026

View reviewed changes

Merge branch 'main' into feat/profile_switch_language

390b648

ghanse added the under-review This PR is currently being reviewed by one of DQX maintainers. label May 21, 2026

lfbraz and others added 4 commits May 22, 2026 11:07

Update app/src/databricks_labs_dqx_app/ui/lib/i18n/index.ts

d361a4c

Co-authored-by: Greg Hansen <163584195+ghanse@users.noreply.github.com>

Remove redundant line in the LanguageSelector

0eb4b45

Fix the i18n anti-pattern

e1a1602

Fix unstable -t in AuthGuard polling-effect deps — read t via useRef

59025ce

lfbraz added 3 commits May 22, 2026 13:21

Fall back by primary language tag

941dca5

i18n lazy-load non-default locale bundles

a935c1a

drop 52 unreferenced common.* keys from all locales

450d692

lfbraz requested a review from ghanse May 26, 2026 14:08

mwojtyczka requested review from laurencewells and removed request for grusin-db June 2, 2026 16:26

mwojtyczka requested changes Jun 2, 2026

View reviewed changes

lfbraz added 2 commits June 3, 2026 16:38

Fix the issue: Init failure produces a blank page.

ea7e06b

Normalize region-tagged locales without breaking pt-BR

0a4521d

laurencewells reviewed Jun 4, 2026

View reviewed changes

Comment thread app/package.json

mwojtyczka added the needs-changes Changes required after review label Jun 5, 2026

lfbraz added 3 commits June 5, 2026 10:14

Fix LanguageSelector a11y: label hidden trigger, unique id

da09af7

Handle failed language switch in LanguageSelector

a0a9093

Translate untranslated Discovery strings in it.json

7c0204f

mwojtyczka reviewed Jun 5, 2026

View reviewed changes

Comment thread app/src/databricks_labs_dqx_app/ui/lib/i18n/locales/en.json Outdated

Merge branch 'main' into feat/profile_switch_language

76aaf29

berrybluecode closed this Jun 7, 2026

berrybluecode reopened this Jun 7, 2026

mwojtyczka added 2 commits June 8, 2026 11:16

mwojtyczka approved these changes Jun 8, 2026

View reviewed changes

mwojtyczka added Approved to Merge When PR is reviewed and approved. To be merged once all tests pass and removed under-review This PR is currently being reviewed by one of DQX maintainers. needs-changes Changes required after review labels Jun 8, 2026

Merge branch 'main' into feat/profile_switch_language

d638396

mwojtyczka mentioned this pull request Jun 9, 2026

Fork test: PR #1172 - Feat/profile switch language #1231

Closed

mwojtyczka temporarily deployed to tool June 9, 2026 08:22 — with GitHub Actions Inactive

mwojtyczka temporarily deployed to tool June 9, 2026 08:24 — with GitHub Actions Inactive

fix(app): remove unused formatLabel import in runs.tsx

80f1eaa

Fixes TS6133 'formatLabel is declared but its value is never read' that broke the Build and Check App TypeScript compilation in CI. Co-authored-by: Isaac

mwojtyczka temporarily deployed to tool June 9, 2026 09:03 — with GitHub Actions Inactive

mwojtyczka temporarily deployed to tool June 9, 2026 09:26 — with GitHub Actions Inactive

mwojtyczka merged commit 0ef9589 into databrickslabs:main Jun 9, 2026
36 checks passed

mwojtyczka mentioned this pull request Jun 12, 2026

[FEATURE]: DQX Studio UI with per-user language switcher #1171

Closed

1 task

Uh oh!

Conversation

lfbraz commented May 11, 2026

Changes

Linked issues

Tests

Documentation and Demos

Uh oh!

ghanse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CLAassistant commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lfbraz commented May 22, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mwojtyczka commented Jun 2, 2026

Uh oh!

Uh oh!

mwojtyczka commented Jun 5, 2026

Uh oh!

mwojtyczka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

berrybluecode commented Jun 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mwojtyczka left a comment

Choose a reason for hiding this comment

Uh oh!

lfbraz commented Jun 8, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

CLAassistant commented May 22, 2026 •

edited

Loading

berrybluecode commented Jun 7, 2026 •

edited

Loading