web: refactor locale handler into top-level context handler (#6022)
* web: begin refactoring the application for future development This commit: - Deletes a bit of code. - Extracts *all* of the Locale logic into a single folder, turns management of the Locale files over to Lit itself, and restricts our responsibility to setting the locale on startup and when the user changes the locale. We do this by converting a lot of internal calls into events; a request to change a locale isn't a function call, it's an event emitted asking `REQUEST_LOCALE_CHANGE`. We've even eliminated the `DETECT_LOCALE_CHANGE` event, which redrew elements with text in them, since Lit's own `@localized()` decorator does that for us automagically. - We wrap our interfaces in an `ak-locale-context` that handles the startup and listens for the `REQUEST_LOCALE_CHANGE` event. - ... and that's pretty much it. Adding `@localized()` as a default behavior to `AKElement` means no more custom localization is needed *anywhere*. * web: improve the localization experience This commit fixes the Storybook story for the localization context component, and fixes the localization initialization pass so that it is only called once per interface environment initialization. Since all our interfaces share the same environment (the Django server), this preserves functionality across all interfaces. --------- Co-authored-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
Ken Sternberg
@ -1,26 +0,0 @@
|
||||
import { getLocale, setLocale } from "./configureLocale";
|
||||
import { getBestMatchLocale, localeFromUrl } from "./helpers";
|
||||
|
||||
export function activateLocale(code: string) {
|
||||
const urlLocale = localeFromUrl("locale");
|
||||
if (urlLocale !== null && urlLocale !== "") {
|
||||
code = urlLocale;
|
||||
}
|
||||
|
||||
const locale = getBestMatchLocale(code);
|
||||
if (!locale) {
|
||||
console.warn(`authentik/locale: failed to find locale for code ${code}`);
|
||||
return;
|
||||
}
|
||||
|
||||
locale.locale().then(() => {
|
||||
console.debug(`authentik/locale: Loaded locale '${code}'`);
|
||||
if (getLocale() === code) {
|
||||
return;
|
||||
}
|
||||
console.debug(`Setting Locale to ... ${locale.label()} (${locale.code})`);
|
||||
setLocale(locale.code);
|
||||
});
|
||||
}
|
||||
|
||||
export default activateLocale;
|
||||
@ -1,38 +0,0 @@
|
||||
import { globalAK } from "@goauthentik/common/global";
|
||||
|
||||
import { activateLocale } from "./activateLocale";
|
||||
import { setLocale } from "./configureLocale";
|
||||
import { DEFAULT_FALLBACK } from "./definitions";
|
||||
import { findSupportedLocale, localeFromUrl } from "./helpers";
|
||||
|
||||
const isLocaleCandidate = (v: unknown): v is string => typeof v === "string" && v !== "";
|
||||
|
||||
export function autoDetectLanguage(defaultLanguage = "en") {
|
||||
// Always load en locale at the start so we have something and don't error
|
||||
setLocale(defaultLanguage);
|
||||
|
||||
// Get all locales we can, in order
|
||||
// - Global authentik settings (contains user settings)
|
||||
// - URL parameter
|
||||
// - Navigator
|
||||
// - Fallback (en)
|
||||
|
||||
const localeCandidates: string[] = [
|
||||
globalAK()?.locale,
|
||||
localeFromUrl("locale"),
|
||||
window.navigator.language,
|
||||
DEFAULT_FALLBACK,
|
||||
].filter(isLocaleCandidate);
|
||||
|
||||
const firstSupportedLocale = findSupportedLocale(localeCandidates);
|
||||
|
||||
if (!firstSupportedLocale) {
|
||||
console.debug(`authentik/locale: No locale for '${localeCandidates}', falling back to en`);
|
||||
activateLocale(defaultLanguage);
|
||||
return;
|
||||
}
|
||||
|
||||
activateLocale(firstSupportedLocale.code);
|
||||
}
|
||||
|
||||
export default autoDetectLanguage;
|
||||
@ -1,17 +0,0 @@
|
||||
import { configureLocalization } from "@lit/localize";
|
||||
|
||||
import { sourceLocale, targetLocales } from "../../../locale-codes";
|
||||
import { getBestMatchLocale } from "./helpers";
|
||||
|
||||
export const { getLocale, setLocale } = configureLocalization({
|
||||
sourceLocale,
|
||||
targetLocales,
|
||||
loadLocale: async (locale: string) => {
|
||||
const localeDef = getBestMatchLocale(locale);
|
||||
if (!localeDef) {
|
||||
console.warn(`Unrecognized locale: ${localeDef}`);
|
||||
return Promise.reject("");
|
||||
}
|
||||
return localeDef.locale();
|
||||
},
|
||||
});
|
||||
@ -1,61 +0,0 @@
|
||||
import * as _enLocale from "@goauthentik/locales/en";
|
||||
|
||||
import type { LocaleModule } from "@lit/localize";
|
||||
import { msg } from "@lit/localize";
|
||||
|
||||
import { AkLocale, LocaleRow } from "./types";
|
||||
|
||||
export const DEFAULT_FALLBACK = "en";
|
||||
|
||||
const enLocale: LocaleModule = _enLocale;
|
||||
|
||||
export { enLocale };
|
||||
|
||||
// NOTE: This table cannot be made any shorter, despite all the repetition of syntax. Bundlers look
|
||||
// for the `await import` string as a *string target* for doing alias substitution, so putting
|
||||
// the import in some sort of abstracting function doesn't work. The same is true for the `msg()`
|
||||
// function, which `localize` uses to find strings for extraction and translation. Likewise,
|
||||
// because this is a file-level table, the `msg()` must be thunked so that they're re-run when
|
||||
// the user changes the locale.
|
||||
|
||||
// NOTE: The matchers try to conform loosely to [RFC
|
||||
// 5646](https://www.rfc-editor.org/rfc/rfc5646.txt), "Tags for the Identification of Languages." In
|
||||
// practice, language tags have been seen using both hyphens and underscores, and the Chinese
|
||||
// language uses both "regional" and "script" suffixes. The regexes use the language and any region
|
||||
// or script.
|
||||
//
|
||||
// French is currently an oddity; the translator provided the France regional version explicitly,
|
||||
// and we fall back to that regardless of region. Sorry, Québécois.
|
||||
//
|
||||
// Chinese locales usually (but not always) use the script rather than region suffix. The default
|
||||
// (optional) fallback for Chinese (zh) is "Chinese (simplified)", which is why it has that odd
|
||||
// regex syntax at the end which means "match zh as long as it's not followed by a [:word:] token";
|
||||
// Traditional script and the Taiwanese are attempted first, and if neither matches, anything
|
||||
// beginning with that generic "zh" is mapped to "Chinese (simplified)."
|
||||
|
||||
// - Code for Lit/Locale
|
||||
// - Regex for matching user-supplied locale.
|
||||
// - Text Label
|
||||
// - Locale loader.
|
||||
|
||||
// prettier-ignore
|
||||
const LOCALE_TABLE: LocaleRow[] = [
|
||||
["en", /^en([_-]|$)/i, () => msg("English"), async () => await import("@goauthentik/locales/en")],
|
||||
["es", /^es([_-]|$)/i, () => msg("Spanish"), async () => await import("@goauthentik/locales/es")],
|
||||
["de", /^de([_-]|$)/i, () => msg("German"), async () => await import("@goauthentik/locales/de")],
|
||||
["fr_FR", /^fr([_-]|$)/i, () => msg("French"), async () => await import("@goauthentik/locales/fr_FR")],
|
||||
["pl", /^pl([_-]|$)/i, () => msg("Polish"), async () => await import("@goauthentik/locales/pl")],
|
||||
["tr", /^tr([_-]|$)/i, () => msg("Turkish"), async () => await import("@goauthentik/locales/tr")],
|
||||
["zh-Hant", /^zh[_-](HK|Hant)/i, () => msg("Chinese (traditional)"), async () => await import("@goauthentik/locales/zh-Hant")],
|
||||
["zh_TW", /^zh[_-]TW$/i, () => msg("Taiwanese Mandarin"), async () => await import("@goauthentik/locales/zh_TW")],
|
||||
["zh-Hans", /^zh(\b|_)/i, () => msg("Chinese (simplified)"), async () => await import("@goauthentik/locales/zh-Hans")],
|
||||
];
|
||||
|
||||
export const LOCALES: AkLocale[] = LOCALE_TABLE.map(([code, match, label, locale]) => ({
|
||||
code,
|
||||
match,
|
||||
label,
|
||||
locale,
|
||||
}));
|
||||
|
||||
export default LOCALES;
|
||||
@ -1,31 +0,0 @@
|
||||
import { LOCALES as RAW_LOCALES, enLocale } from "./definitions";
|
||||
import { AkLocale } from "./types";
|
||||
|
||||
// NOTE: This is the definition of the LOCALES table that most of the code uses. The 'definitions'
|
||||
// file is relatively pure, but here we establish that we want the English locale to loaded when an
|
||||
// application is first instantiated.
|
||||
|
||||
export const LOCALES = RAW_LOCALES.map((locale) =>
|
||||
locale.code === "en" ? { ...locale, locale: async () => enLocale } : locale,
|
||||
);
|
||||
|
||||
// First attempt a precise match, then see if there's a precise match on the requested locale's
|
||||
// prefix, then find the *first* locale for which that locale's prefix matches the requested prefix.
|
||||
|
||||
export function getBestMatchLocale(locale: string): AkLocale | undefined {
|
||||
return LOCALES.find((l) => l.match.test(locale));
|
||||
}
|
||||
|
||||
// This looks weird, but it's sensible: we have several candidates, and we want to find the first
|
||||
// one that has a supported locale. Then, from *that*, we have to extract that first supported
|
||||
// locale.
|
||||
|
||||
export function findSupportedLocale(candidates: string[]) {
|
||||
const candidate = candidates.find((candidate: string) => getBestMatchLocale(candidate));
|
||||
return candidate ? getBestMatchLocale(candidate) : undefined;
|
||||
}
|
||||
|
||||
export function localeFromUrl(param = "locale") {
|
||||
const url = new URL(window.location.href);
|
||||
return url.searchParams.get(param) || "";
|
||||
}
|
||||
@ -1,6 +0,0 @@
|
||||
import activateLocale from "./activateLocale";
|
||||
import autoDetectLanguage from "./autodetectLanguage";
|
||||
import { getLocale, setLocale } from "./configureLocale";
|
||||
import { LOCALES } from "./helpers";
|
||||
|
||||
export { LOCALES, getLocale, setLocale, activateLocale, autoDetectLanguage };
|
||||
Reference in New Issue
Block a user