From 137a53dbee9b4c393c04c95a4cf20dafb3271870 Mon Sep 17 00:00:00 2001 From: Quentin Gliech Date: Thu, 14 Nov 2024 19:06:38 +0100 Subject: [PATCH 1/5] Load the Intl.Segmenter and Intl.DurationFormat polyfills only if needed (#2778) * Load the Intl.Segmenter polyfill only if needed * Also polyfill Intl.DurationFormat only if needed * Polyfill Intl.* in tests * Load the default translations in tests * Instanciate the Intl.DurationFormat in the component --- src/@types/global.d.ts | 6 ++++++ src/initializer.test.ts | 8 ++++---- src/initializer.tsx | 22 ++++++++++++++-------- src/main.tsx | 23 +++++++++++++---------- src/reactions/RaisedHandIndicator.tsx | 22 +++++++++++++--------- src/vitest.setup.ts | 10 ++++++++++ 6 files changed, 60 insertions(+), 31 deletions(-) diff --git a/src/@types/global.d.ts b/src/@types/global.d.ts index de8bb788..94a4e379 100644 --- a/src/@types/global.d.ts +++ b/src/@types/global.d.ts @@ -6,6 +6,7 @@ Please see LICENSE in the repository root for full details. */ import "matrix-js-sdk/src/@types/global"; +import type { DurationFormat as PolyfillDurationFormat } from "@formatjs/intl-durationformat"; import { Controls } from "../controls"; declare global { @@ -23,4 +24,9 @@ declare global { // Safari only supports this prefixed, so tell the type system about it webkitRequestFullscreen: () => void; } + + namespace Intl { + // Add DurationFormat as part of the Intl namespace because we polyfill it + const DurationFormat: typeof PolyfillDurationFormat; + } } diff --git a/src/initializer.test.ts b/src/initializer.test.ts index dff1651e..19f52b69 100644 --- a/src/initializer.test.ts +++ b/src/initializer.test.ts @@ -9,9 +9,9 @@ import { expect, test } from "vitest"; import { Initializer } from "../src/initializer"; -test("initBeforeReact sets font family from URL param", () => { +test("initBeforeReact sets font family from URL param", async () => { window.location.hash = "#?font=DejaVu Sans"; - Initializer.initBeforeReact(); + await Initializer.initBeforeReact(); expect( getComputedStyle(document.documentElement).getPropertyValue( "--font-family", @@ -19,9 +19,9 @@ test("initBeforeReact sets font family from URL param", () => { ).toBe('"DejaVu Sans"'); }); -test("initBeforeReact sets font scale from URL param", () => { +test("initBeforeReact sets font scale from URL param", async () => { window.location.hash = "#?fontScale=1.2"; - Initializer.initBeforeReact(); + await Initializer.initBeforeReact(); expect( getComputedStyle(document.documentElement).getPropertyValue("--font-scale"), ).toBe("1.2"); diff --git a/src/initializer.tsx b/src/initializer.tsx index 4bc1dc9f..0ac8a88a 100644 --- a/src/initializer.tsx +++ b/src/initializer.tsx @@ -11,6 +11,8 @@ import LanguageDetector from "i18next-browser-languagedetector"; import Backend from "i18next-http-backend"; import * as Sentry from "@sentry/react"; import { logger } from "matrix-js-sdk/src/logger"; +import { shouldPolyfill as shouldPolyfillSegmenter } from "@formatjs/intl-segmenter/should-polyfill"; +import { shouldPolyfill as shouldPolyfillDurationFormat } from "@formatjs/intl-durationformat/should-polyfill"; import { getUrlParams } from "./UrlParams"; import { Config } from "./config/Config"; @@ -41,10 +43,17 @@ export class Initializer { return Initializer.internalInstance?.isInitialized; } - public static initBeforeReact(): void { - // this maybe also needs to return a promise in the future, - // if we have to do async inits before showing the loading screen - // but this should be avoided if possible + public static async initBeforeReact(): Promise { + const polyfills: Promise[] = []; + if (shouldPolyfillSegmenter()) { + polyfills.push(import("@formatjs/intl-segmenter/polyfill-force")); + } + + if (shouldPolyfillDurationFormat()) { + polyfills.push(import("@formatjs/intl-durationformat/polyfill-force")); + } + + await Promise.all(polyfills); //i18n const languageDetector = new LanguageDetector(); @@ -54,7 +63,7 @@ export class Initializer { lookup: () => getUrlParams().lang ?? undefined, }); - i18n + await i18n .use(Backend) .use(languageDetector) .use(initReactI18next) @@ -74,9 +83,6 @@ export class Initializer { order: ["urlFragment", "navigator"], caches: [], }, - }) - .catch((e) => { - logger.error("Failed to initialize i18n", e); }); // Custom Themeing diff --git a/src/main.tsx b/src/main.tsx index d4a4539b..ac0440b7 100644 --- a/src/main.tsx +++ b/src/main.tsx @@ -20,8 +20,6 @@ import { setLogExtension as setLKLogExtension, setLogLevel as setLKLogLevel, } from "livekit-client"; -import "@formatjs/intl-segmenter/polyfill"; -import "@formatjs/intl-durationformat/polyfill"; import { App } from "./App"; import { init as initRageshake } from "./settings/rageshake"; @@ -57,12 +55,17 @@ if (fatalError !== null) { throw fatalError; // Stop the app early } -Initializer.initBeforeReact(); +Initializer.initBeforeReact() + .then(() => { + const history = createBrowserHistory(); -const history = createBrowserHistory(); - -root.render( - - - , -); + root.render( + + + , + ); + }) + .catch((e) => { + logger.error("Failed to initialize app", e); + root.render(e.message); + }); diff --git a/src/reactions/RaisedHandIndicator.tsx b/src/reactions/RaisedHandIndicator.tsx index cfc83ab8..8c4747b3 100644 --- a/src/reactions/RaisedHandIndicator.tsx +++ b/src/reactions/RaisedHandIndicator.tsx @@ -11,19 +11,12 @@ import { useCallback, useEffect, useState, + useMemo, } from "react"; -import { DurationFormat } from "@formatjs/intl-durationformat"; import { useTranslation } from "react-i18next"; import { ReactionIndicator } from "./ReactionIndicator"; -const durationFormatter = new DurationFormat(undefined, { - minutesDisplay: "always", - secondsDisplay: "always", - hoursDisplay: "auto", - style: "digital", -}); - export function RaisedHandIndicator({ raisedHandTime, miniature, @@ -38,6 +31,17 @@ export function RaisedHandIndicator({ const { t } = useTranslation(); const [raisedHandDuration, setRaisedHandDuration] = useState(""); + const durationFormatter = useMemo( + () => + new Intl.DurationFormat(undefined, { + minutesDisplay: "always", + secondsDisplay: "always", + hoursDisplay: "auto", + style: "digital", + }), + [], + ); + const clickCallback = useCallback>( (event) => { if (!onClick) { @@ -69,7 +73,7 @@ export function RaisedHandIndicator({ calculateTime(); const to = setInterval(calculateTime, 1000); return (): void => clearInterval(to); - }, [setRaisedHandDuration, raisedHandTime, showTimer]); + }, [setRaisedHandDuration, raisedHandTime, showTimer, durationFormatter]); if (!raisedHandTime) { return; diff --git a/src/vitest.setup.ts b/src/vitest.setup.ts index 596453ed..776a13b0 100644 --- a/src/vitest.setup.ts +++ b/src/vitest.setup.ts @@ -6,6 +6,8 @@ Please see LICENSE in the repository root for full details. */ import "global-jsdom/register"; +import "@formatjs/intl-durationformat/polyfill"; +import "@formatjs/intl-segmenter/polyfill"; import i18n from "i18next"; import posthog from "posthog-js"; import { initReactI18next } from "react-i18next"; @@ -14,6 +16,7 @@ import { cleanup } from "@testing-library/react"; import "vitest-axe/extend-expect"; import { logger } from "matrix-js-sdk/src/logger"; +import EN_GB from "../public/locales/en-GB/app.json"; import { Config } from "./config/Config"; // Bare-minimum i18n config @@ -22,6 +25,13 @@ i18n .init({ lng: "en-GB", fallbackLng: "en-GB", + supportedLngs: ["en-GB"], + // We embed the translations, so that it never needs to fetch + resources: { + "en-GB": { + app: EN_GB, + }, + }, interpolation: { escapeValue: false, // React has built-in XSS protections }, From 99d5886e32a71c821b64dc6c33b1148c51d7d520 Mon Sep 17 00:00:00 2001 From: Quentin Gliech Date: Thu, 14 Nov 2024 11:53:43 +0100 Subject: [PATCH 2/5] Handles locales as Vite assets --- .github/workflows/translations-download.yaml | 4 +- README.md | 4 +- i18next-parser.config.ts | 2 +- localazy.json | 8 +-- {public/locales => locales}/bg/app.json | 0 {public/locales => locales}/cs/app.json | 0 {public/locales => locales}/de/app.json | 0 {public/locales => locales}/el/app.json | 0 {public/locales => locales}/en-GB/app.json | 0 {public/locales => locales}/es/app.json | 0 {public/locales => locales}/et/app.json | 0 {public/locales => locales}/fa/app.json | 0 {public/locales => locales}/fr/app.json | 0 {public/locales => locales}/id/app.json | 0 {public/locales => locales}/it/app.json | 0 {public/locales => locales}/ja/app.json | 0 {public/locales => locales}/lv/app.json | 0 {public/locales => locales}/pl/app.json | 0 {public/locales => locales}/ru/app.json | 0 {public/locales => locales}/sk/app.json | 0 {public/locales => locales}/sv/app.json | 0 {public/locales => locales}/tr/app.json | 0 {public/locales => locales}/uk/app.json | 0 {public/locales => locales}/vi/app.json | 0 {public/locales => locales}/zh-Hans/app.json | 0 {public/locales => locales}/zh-Hant/app.json | 0 package.json | 1 - src/@types/i18next.d.ts | 2 +- src/initializer.tsx | 70 +++++++++++++++++++- src/vitest.setup.ts | 2 +- vite.config.js | 19 ++++++ yarn.lock | 16 +---- 32 files changed, 99 insertions(+), 29 deletions(-) rename {public/locales => locales}/bg/app.json (100%) rename {public/locales => locales}/cs/app.json (100%) rename {public/locales => locales}/de/app.json (100%) rename {public/locales => locales}/el/app.json (100%) rename {public/locales => locales}/en-GB/app.json (100%) rename {public/locales => locales}/es/app.json (100%) rename {public/locales => locales}/et/app.json (100%) rename {public/locales => locales}/fa/app.json (100%) rename {public/locales => locales}/fr/app.json (100%) rename {public/locales => locales}/id/app.json (100%) rename {public/locales => locales}/it/app.json (100%) rename {public/locales => locales}/ja/app.json (100%) rename {public/locales => locales}/lv/app.json (100%) rename {public/locales => locales}/pl/app.json (100%) rename {public/locales => locales}/ru/app.json (100%) rename {public/locales => locales}/sk/app.json (100%) rename {public/locales => locales}/sv/app.json (100%) rename {public/locales => locales}/tr/app.json (100%) rename {public/locales => locales}/uk/app.json (100%) rename {public/locales => locales}/vi/app.json (100%) rename {public/locales => locales}/zh-Hans/app.json (100%) rename {public/locales => locales}/zh-Hant/app.json (100%) diff --git a/.github/workflows/translations-download.yaml b/.github/workflows/translations-download.yaml index d03040e4..7359f781 100644 --- a/.github/workflows/translations-download.yaml +++ b/.github/workflows/translations-download.yaml @@ -24,7 +24,7 @@ jobs: run: "yarn install --frozen-lockfile" - name: Prune i18n - run: "rm -R public/locales" + run: "rm -R locales" - name: Download translation files uses: localazy/download@0a79880fb66150601e3b43606fab69c88123c087 # v1.1.0 @@ -32,7 +32,7 @@ jobs: groups: "-p includeSourceLang:true" - name: Fix the owner of the downloaded files - run: "sudo chown runner:docker -R public/locales" + run: "sudo chown runner:docker -R locales" - name: Prettier run: yarn prettier:format diff --git a/README.md b/README.md index 43a2dce0..a0af77fc 100644 --- a/README.md +++ b/README.md @@ -213,7 +213,7 @@ To add a new translation key you can do these steps: 1. Add the new key entry to the code where the new key is used: `t("some_new_key")` 1. Run `yarn i18n` to extract the new key and update the translation files. This - will add a skeleton entry to the `public/locales/en-GB/app.json` file: + will add a skeleton entry to the `locales/en-GB/app.json` file: ```jsonc { ... @@ -221,7 +221,7 @@ To add a new translation key you can do these steps: ... } ``` -1. Update the skeleton entry in the `public/locales/en-GB/app.json` file with +1. Update the skeleton entry in the `locales/en-GB/app.json` file with the English translation: ```jsonc diff --git a/i18next-parser.config.ts b/i18next-parser.config.ts index f603c37e..7d71d727 100644 --- a/i18next-parser.config.ts +++ b/i18next-parser.config.ts @@ -22,7 +22,7 @@ export default { ], }, locales: ["en-GB"], - output: "public/locales/$LOCALE/$NAMESPACE.json", + output: "locales/$LOCALE/$NAMESPACE.json", input: ["src/**/*.{ts,tsx}"], sort: true, }; diff --git a/localazy.json b/localazy.json index 41cb7656..2b9f713c 100644 --- a/localazy.json +++ b/localazy.json @@ -7,13 +7,13 @@ "features": ["plural_postfix_us", "filter_untranslated"], "files": [ { - "pattern": "public/locales/en-GB/*.json", + "pattern": "locales/en-GB/*.json", "lang": "inherited" }, { "group": "existing", - "pattern": "public/locales/*/*.json", - "excludes": ["public/locales/en-GB/*.json"], + "pattern": "locales/*/*.json", + "excludes": ["locales/en-GB/*.json"], "lang": "${autodetectLang}" } ] @@ -22,7 +22,7 @@ "download": { "files": [ { - "output": "public/locales/${langLsrDash}/${file}" + "output": "locales/${langLsrDash}/${file}" } ], "includeSourceLang": "${includeSourceLang|false}", diff --git a/public/locales/bg/app.json b/locales/bg/app.json similarity index 100% rename from public/locales/bg/app.json rename to locales/bg/app.json diff --git a/public/locales/cs/app.json b/locales/cs/app.json similarity index 100% rename from public/locales/cs/app.json rename to locales/cs/app.json diff --git a/public/locales/de/app.json b/locales/de/app.json similarity index 100% rename from public/locales/de/app.json rename to locales/de/app.json diff --git a/public/locales/el/app.json b/locales/el/app.json similarity index 100% rename from public/locales/el/app.json rename to locales/el/app.json diff --git a/public/locales/en-GB/app.json b/locales/en-GB/app.json similarity index 100% rename from public/locales/en-GB/app.json rename to locales/en-GB/app.json diff --git a/public/locales/es/app.json b/locales/es/app.json similarity index 100% rename from public/locales/es/app.json rename to locales/es/app.json diff --git a/public/locales/et/app.json b/locales/et/app.json similarity index 100% rename from public/locales/et/app.json rename to locales/et/app.json diff --git a/public/locales/fa/app.json b/locales/fa/app.json similarity index 100% rename from public/locales/fa/app.json rename to locales/fa/app.json diff --git a/public/locales/fr/app.json b/locales/fr/app.json similarity index 100% rename from public/locales/fr/app.json rename to locales/fr/app.json diff --git a/public/locales/id/app.json b/locales/id/app.json similarity index 100% rename from public/locales/id/app.json rename to locales/id/app.json diff --git a/public/locales/it/app.json b/locales/it/app.json similarity index 100% rename from public/locales/it/app.json rename to locales/it/app.json diff --git a/public/locales/ja/app.json b/locales/ja/app.json similarity index 100% rename from public/locales/ja/app.json rename to locales/ja/app.json diff --git a/public/locales/lv/app.json b/locales/lv/app.json similarity index 100% rename from public/locales/lv/app.json rename to locales/lv/app.json diff --git a/public/locales/pl/app.json b/locales/pl/app.json similarity index 100% rename from public/locales/pl/app.json rename to locales/pl/app.json diff --git a/public/locales/ru/app.json b/locales/ru/app.json similarity index 100% rename from public/locales/ru/app.json rename to locales/ru/app.json diff --git a/public/locales/sk/app.json b/locales/sk/app.json similarity index 100% rename from public/locales/sk/app.json rename to locales/sk/app.json diff --git a/public/locales/sv/app.json b/locales/sv/app.json similarity index 100% rename from public/locales/sv/app.json rename to locales/sv/app.json diff --git a/public/locales/tr/app.json b/locales/tr/app.json similarity index 100% rename from public/locales/tr/app.json rename to locales/tr/app.json diff --git a/public/locales/uk/app.json b/locales/uk/app.json similarity index 100% rename from public/locales/uk/app.json rename to locales/uk/app.json diff --git a/public/locales/vi/app.json b/locales/vi/app.json similarity index 100% rename from public/locales/vi/app.json rename to locales/vi/app.json diff --git a/public/locales/zh-Hans/app.json b/locales/zh-Hans/app.json similarity index 100% rename from public/locales/zh-Hans/app.json rename to locales/zh-Hans/app.json diff --git a/public/locales/zh-Hant/app.json b/locales/zh-Hant/app.json similarity index 100% rename from public/locales/zh-Hant/app.json rename to locales/zh-Hant/app.json diff --git a/package.json b/package.json index b1015050..0515578e 100644 --- a/package.json +++ b/package.json @@ -84,7 +84,6 @@ "history": "^4.0.0", "i18next": "^23.0.0", "i18next-browser-languagedetector": "^8.0.0", - "i18next-http-backend": "^2.0.0", "i18next-parser": "^9.0.0", "jsdom": "^25.0.0", "knip": "^5.27.2", diff --git a/src/@types/i18next.d.ts b/src/@types/i18next.d.ts index ad35f456..4a8830da 100644 --- a/src/@types/i18next.d.ts +++ b/src/@types/i18next.d.ts @@ -7,7 +7,7 @@ Please see LICENSE in the repository root for full details. import "i18next"; // import all namespaces (for the default language, only) -import app from "../../public/locales/en-GB/app.json"; +import app from "../../locales/en-GB/app.json"; declare module "i18next" { interface CustomTypeOptions { diff --git a/src/initializer.tsx b/src/initializer.tsx index 0ac8a88a..47634078 100644 --- a/src/initializer.tsx +++ b/src/initializer.tsx @@ -5,10 +5,13 @@ SPDX-License-Identifier: AGPL-3.0-only Please see LICENSE in the repository root for full details. */ -import i18n from "i18next"; +import i18n, { + type BackendModule, + type ReadCallback, + type ResourceKey, +} from "i18next"; import { initReactI18next } from "react-i18next"; import LanguageDetector from "i18next-browser-languagedetector"; -import Backend from "i18next-http-backend"; import * as Sentry from "@sentry/react"; import { logger } from "matrix-js-sdk/src/logger"; import { shouldPolyfill as shouldPolyfillSegmenter } from "@formatjs/intl-segmenter/should-polyfill"; @@ -19,6 +22,68 @@ import { Config } from "./config/Config"; import { ElementCallOpenTelemetry } from "./otel/otel"; import { platform } from "./Platform"; +// This generates a map of locale names to their URL (based on import.meta.url), which looks like this: +// { +// "../locales/en-GB/app.json": "/whatever/assets/root/locales/en-aabbcc.json", +// ... +// } +const locales = import.meta.glob("../locales/*/*.json", { + query: "?url", + import: "default", + eager: true, +}); + +const getLocaleUrl = ( + language: string, + namespace: string, +): string | undefined => locales[`../locales/${language}/${namespace}.json`]; + +const supportedLngs = [ + ...new Set( + Object.keys(locales).map((url) => { + // The URLs are of the form ../locales/en-GB/app.json + // This extracts the language code from the URL + const lang = url.match(/\/([^/]+)\/[^/]+\.json$/)?.[1]; + if (!lang) { + throw new Error(`Could not parse locale URL ${url}`); + } + return lang; + }), + ), +]; + +// A backend that fetches the locale files from the URLs generated by the glob above +const Backend = { + type: "backend", + init(): void {}, + read(language: string, namespace: string, callback: ReadCallback): void { + (async (): Promise => { + const url = getLocaleUrl(language, namespace); + if (!url) { + throw new Error( + `Namespace ${namespace} for locale ${language} not found`, + ); + } + + const response = await fetch(url, { + credentials: "omit", + headers: { + Accept: "application/json", + }, + }); + + if (!response.ok) { + throw Error(`Failed to fetch ${url}`); + } + + return await response.json(); + })().then( + (data) => callback(null, data), + (error) => callback(error, null), + ); + }, +} satisfies BackendModule; + enum LoadState { None, Loading, @@ -74,6 +139,7 @@ export class Initializer { nsSeparator: false, pluralSeparator: "_", contextSeparator: "|", + supportedLngs, interpolation: { escapeValue: false, // React has built-in XSS protections }, diff --git a/src/vitest.setup.ts b/src/vitest.setup.ts index 776a13b0..421ec663 100644 --- a/src/vitest.setup.ts +++ b/src/vitest.setup.ts @@ -16,7 +16,7 @@ import { cleanup } from "@testing-library/react"; import "vitest-axe/extend-expect"; import { logger } from "matrix-js-sdk/src/logger"; -import EN_GB from "../public/locales/en-GB/app.json"; +import EN_GB from "../locales/en-GB/app.json"; import { Config } from "./config/Config"; // Bare-minimum i18n config diff --git a/vite.config.js b/vite.config.js index b92f717b..6c714bcb 100644 --- a/vite.config.js +++ b/vite.config.js @@ -60,6 +60,25 @@ export default defineConfig(({ mode }) => { }, build: { sourcemap: true, + rollupOptions: { + output: { + assetFileNames: ({ originalFileNames }) => { + if (originalFileNames) { + for (const name of originalFileNames) { + // Custom asset name for locales to include the locale code in the filename + const match = name.match(/locales\/([^/]+)\/(.+)\.json$/); + if (match) { + const [, locale, filename] = match; + return `assets/${locale}-${filename}-[hash].json`; + } + } + } + + // Default naming fallback + return "assets/[name]-[hash][extname]"; + }, + }, + }, }, plugins, resolve: { diff --git a/yarn.lock b/yarn.lock index 5057090b..42c6e6b0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4138,13 +4138,6 @@ cosmiconfig@^8.1.3: parse-json "^5.2.0" path-type "^4.0.0" -cross-fetch@4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/cross-fetch/-/cross-fetch-4.0.0.tgz#f037aef1580bb3a1a35164ea2a848ba81b445983" - integrity sha512-e4a5N8lVvuLgAWgnCrLr2PP0YyDOTHa9H/Rj54dirp61qXnNq46m82bRhNqIA5VccJtWBvPTFRV3TtvHUKPB1g== - dependencies: - node-fetch "^2.6.12" - cross-spawn@^7.0.0, cross-spawn@^7.0.2: version "7.0.3" resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6" @@ -5469,13 +5462,6 @@ i18next-browser-languagedetector@^8.0.0: dependencies: "@babel/runtime" "^7.23.2" -i18next-http-backend@^2.0.0: - version "2.6.2" - resolved "https://registry.yarnpkg.com/i18next-http-backend/-/i18next-http-backend-2.6.2.tgz#b25516446ae6f251ce8231e70e6ffbca833d46a5" - integrity sha512-Hp/kd8/VuoxIHmxsknJXjkTYYHzivAyAF15pzliKzk2TiXC25rZCEerb1pUFoxz4IVrG3fCvQSY51/Lu4ECV4A== - dependencies: - cross-fetch "4.0.0" - i18next-parser@^9.0.0: version "9.0.2" resolved "https://registry.yarnpkg.com/i18next-parser/-/i18next-parser-9.0.2.tgz#f9d627422d33c352967556c8724975d58f1f5a95" @@ -6331,7 +6317,7 @@ node-addon-api@^7.0.0: resolved "https://registry.yarnpkg.com/node-addon-api/-/node-addon-api-7.1.1.tgz#1aba6693b0f255258a049d621329329322aad558" integrity sha512-5m3bsyrjFWE1xf7nz7YXdN4udnVtXK6/Yfgn5qnahL6bCkf2yKt4k3nuTKAtT4r3IG8JNR2ncsIMdZuAzJjHQQ== -node-fetch@^2.6.12, node-fetch@^2.6.7: +node-fetch@^2.6.7: version "2.7.0" resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.7.0.tgz#d0f0fa6e3e2dc1d27efcd8ad99d550bda94d187d" integrity sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A== From 50934a53cdaa4e3170dc7016c5a61d6ccd497598 Mon Sep 17 00:00:00 2001 From: Hugh Nimmo-Smith Date: Thu, 14 Nov 2024 21:54:02 +0000 Subject: [PATCH 3/5] Lazy load matrix-js-sdk when running as SPA (#2785) --- src/ClientContext.tsx | 59 ++++----------------------------------- src/utils/spa.ts | 64 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 54 deletions(-) create mode 100644 src/utils/spa.ts diff --git a/src/ClientContext.tsx b/src/ClientContext.tsx index 5a531c2a..8b5589d5 100644 --- a/src/ClientContext.tsx +++ b/src/ClientContext.tsx @@ -16,19 +16,13 @@ import { useMemo, } from "react"; import { useHistory } from "react-router-dom"; -import { - ClientEvent, - ICreateClientOpts, - MatrixClient, -} from "matrix-js-sdk/src/client"; import { logger } from "matrix-js-sdk/src/logger"; import { useTranslation } from "react-i18next"; import { ISyncStateData, SyncState } from "matrix-js-sdk/src/sync"; -import { MatrixError } from "matrix-js-sdk/src/matrix"; -import { WidgetApi } from "matrix-widget-api"; +import { ClientEvent, type MatrixClient } from "matrix-js-sdk/src/client"; +import type { WidgetApi } from "matrix-widget-api"; import { ErrorView } from "./FullScreenView"; -import { fallbackICEServerAllowed, initClient } from "./utils/matrix"; import { widget } from "./widget"; import { PosthogAnalytics, @@ -36,7 +30,6 @@ import { } from "./analytics/PosthogAnalytics"; import { translatedError } from "./TranslatedError"; import { useEventTarget } from "./useEvents"; -import { Config } from "./config/Config"; declare global { interface Window { @@ -359,7 +352,7 @@ export const ClientProvider: FC = ({ children }) => { ); }; -type InitResult = { +export type InitResult = { widgetApi: WidgetApi | null; client: MatrixClient; passwordlessUser: boolean; @@ -376,50 +369,8 @@ async function loadClient(): Promise { passwordlessUser: false, }; } else { - // We're running as a standalone application - try { - const session = loadSession(); - if (!session) { - logger.log("No session stored; continuing without a client"); - return null; - } - - logger.log("Using a standalone client"); - - /* eslint-disable camelcase */ - const { user_id, device_id, access_token, passwordlessUser } = session; - const initClientParams: ICreateClientOpts = { - baseUrl: Config.defaultHomeserverUrl()!, - accessToken: access_token, - userId: user_id, - deviceId: device_id, - fallbackICEServerAllowed: fallbackICEServerAllowed, - livekitServiceURL: Config.get().livekit?.livekit_service_url, - }; - - try { - const client = await initClient(initClientParams, true); - return { - widgetApi: null, - client, - passwordlessUser, - }; - } catch (err) { - if (err instanceof MatrixError && err.errcode === "M_UNKNOWN_TOKEN") { - // We can't use this session anymore, so let's log it out - logger.log( - "The session from local store is invalid; continuing without a client", - ); - clearSession(); - // returning null = "no client` pls register" (undefined = "loading" which is the current value when reaching this line) - return null; - } - throw err; - } - } catch (err) { - clearSession(); - throw err; - } + const { initSPA } = await import("./utils/spa"); + return initSPA(loadSession, clearSession); } } diff --git a/src/utils/spa.ts b/src/utils/spa.ts new file mode 100644 index 00000000..37835259 --- /dev/null +++ b/src/utils/spa.ts @@ -0,0 +1,64 @@ +/* +Copyright 2024 New Vector Ltd. + +SPDX-License-Identifier: AGPL-3.0-only +Please see LICENSE in the repository root for full details. +*/ + +import { ICreateClientOpts } from "matrix-js-sdk/src/client"; +import { MatrixError } from "matrix-js-sdk/src/http-api"; +import { logger } from "matrix-js-sdk/src/logger"; + +import { Config } from "../config/Config"; +import { fallbackICEServerAllowed, initClient } from "./matrix"; +import type { InitResult, Session } from "../ClientContext"; + +export async function initSPA( + loadSession: () => Session | undefined, + clearSession: () => void, +): Promise { + // We're running as a standalone application + try { + const session = loadSession(); + if (!session) { + logger.log("No session stored; continuing without a client"); + return null; + } + + logger.log("Using a standalone client"); + + /* eslint-disable camelcase */ + const { user_id, device_id, access_token, passwordlessUser } = session; + const initClientParams: ICreateClientOpts = { + baseUrl: Config.defaultHomeserverUrl()!, + accessToken: access_token, + userId: user_id, + deviceId: device_id, + fallbackICEServerAllowed, + livekitServiceURL: Config.get().livekit?.livekit_service_url, + }; + + try { + const client = await initClient(initClientParams, true); + return { + widgetApi: null, + client, + passwordlessUser, + }; + } catch (err) { + if (err instanceof MatrixError && err.errcode === "M_UNKNOWN_TOKEN") { + // We can't use this session anymore, so let's log it out + logger.log( + "The session from local store is invalid; continuing without a client", + ); + clearSession(); + // returning null = "no client` pls register" (undefined = "loading" which is the current value when reaching this line) + return null; + } + throw err; + } + } catch (err) { + clearSession(); + throw err; + } +} From f022eb09a237f16171280e169e53b43c9b1ec6ee Mon Sep 17 00:00:00 2001 From: Quentin Gliech Date: Fri, 15 Nov 2024 00:53:07 +0100 Subject: [PATCH 4/5] Precompress assets and set the right cache headers --- Dockerfile | 6 ------ config/nginx.conf | 13 +++---------- package.json | 1 + vite.config.js | 5 +++++ yarn.lock | 19 +++++++++++++++++-- 5 files changed, 26 insertions(+), 18 deletions(-) diff --git a/Dockerfile b/Dockerfile index 05354e3f..275ab153 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,9 +2,3 @@ FROM nginxinc/nginx-unprivileged:alpine COPY ./dist /app COPY config/nginx.conf /etc/nginx/conf.d/default.conf - -USER root - -RUN rm -rf /usr/share/nginx/html - -USER 101 diff --git a/config/nginx.conf b/config/nginx.conf index ca4ac4c6..6950eb72 100644 --- a/config/nginx.conf +++ b/config/nginx.conf @@ -3,23 +3,16 @@ server { server_name localhost; root /app; + gzip_static on; location / { - # disable cache entriely by default (apart from Etag which is accurate enough) - add_header Cache-Control 'private no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0'; - if_modified_since off; - expires off; - # also turn off last-modified since they are just the timestamps of the file in the docker image - # and may or may not bear any resemblance to when the resource changed - add_header Last-Modified ""; - try_files $uri $uri/ /index.html; + add_header Cache-Control "no-store, no-cache, must-revalidate"; } # assets can be cached because they have hashed filenames location /assets { - expires 1w; - add_header Cache-Control "public, no-transform"; + add_header Cache-Control "public, immutable, max-age=31536000"; } location /apple-app-site-association { diff --git a/package.json b/package.json index b1015050..eb65c407 100644 --- a/package.json +++ b/package.json @@ -114,6 +114,7 @@ "unique-names-generator": "^4.6.0", "vaul": "^1.0.0", "vite": "^5.0.0", + "vite-plugin-compression2": "^1.3.1", "vite-plugin-html-template": "^1.1.0", "vite-plugin-svgr": "^4.0.0", "vitest": "^2.0.0", diff --git a/vite.config.js b/vite.config.js index b92f717b..f4fa4900 100644 --- a/vite.config.js +++ b/vite.config.js @@ -6,6 +6,7 @@ Please see LICENSE in the repository root for full details. */ import { defineConfig, loadEnv } from "vite"; +import { compression } from "vite-plugin-compression2"; import svgrPlugin from "vite-plugin-svgr"; import htmlTemplate from "vite-plugin-html-template"; import { codecovVitePlugin } from "@codecov/vite-plugin"; @@ -38,6 +39,10 @@ export default defineConfig(({ mode }) => { bundleName: "element-call", uploadToken: process.env.CODECOV_TOKEN, }), + + compression({ + exclude: [/config.json/], + }), ]; if ( diff --git a/yarn.lock b/yarn.lock index 5057090b..1aa26c6f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2542,7 +2542,7 @@ "@react-spring/shared" "~9.7.5" "@react-spring/types" "~9.7.5" -"@rollup/pluginutils@^5.1.3": +"@rollup/pluginutils@^5.1.0", "@rollup/pluginutils@^5.1.3": version "5.1.3" resolved "https://registry.yarnpkg.com/@rollup/pluginutils/-/pluginutils-5.1.3.tgz#3001bf1a03f3ad24457591f2c259c8e514e0dbdf" integrity sha512-Pnsb6f32CD2W3uCaLZIzDmeFyQ2b8UWMFI7xtwUezpcGBDVDW6y9XgAWIlARiGAo6eNF5FK5aQTr0LFyNyqq5A== @@ -7927,6 +7927,11 @@ tapable@^2.2.0: resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.1.tgz#1967a73ef4060a82f12ab96af86d52fdb76eeca0" integrity sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ== +tar-mini@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/tar-mini/-/tar-mini-0.2.0.tgz#2b2cdc215f5b83b0ab8ce363dc9ded22de51849b" + integrity sha512-+qfUHz700DWnRutdUsxRRVZ38G1Qr27OetwaMYTdg8hcPxf46U0S1Zf76dQMWRBmusOt2ZCK5kbIaiLkoGO7WQ== + teex@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/teex/-/teex-1.0.1.tgz#b8fa7245ef8e8effa8078281946c85ab780a0b12" @@ -8430,6 +8435,16 @@ vite-node@2.1.4: pathe "^1.1.2" vite "^5.0.0" +vite-plugin-compression2@^1.3.1: + version "1.3.1" + resolved "https://registry.yarnpkg.com/vite-plugin-compression2/-/vite-plugin-compression2-1.3.1.tgz#ac2a512f8ca90a76687add6cf441000dd2c41485" + integrity sha512-UMr66CFu+RVPiD8E3iaX9BdZjCgO+lzzaAPAZvL5YgwH6FU4OR/MulJEyp9wq9EKoO6ErjUtPpaiDi3hvzv79Q== + dependencies: + "@rollup/pluginutils" "^5.1.0" + tar-mini "^0.2.0" + optionalDependencies: + vite "^5.3.4" + vite-plugin-html-template@^1.1.0: version "1.2.2" resolved "https://registry.yarnpkg.com/vite-plugin-html-template/-/vite-plugin-html-template-1.2.2.tgz#d263c18dcf5f5e54bc74894546fd0ed993191f2f" @@ -8446,7 +8461,7 @@ vite-plugin-svgr@^4.0.0: "@svgr/core" "^8.1.0" "@svgr/plugin-jsx" "^8.1.0" -vite@^5.0.0: +vite@^5.0.0, vite@^5.3.4: version "5.4.11" resolved "https://registry.yarnpkg.com/vite/-/vite-5.4.11.tgz#3b415cd4aed781a356c1de5a9ebafb837715f6e5" integrity sha512-c7jFQRklXua0mTzneGW9QVyxFjUgwcihC4bXEtujIo2ouWCe1Ajt/amn2PCxYnhYfd5k09JX3SB7OYWFKYqj8Q== From f7e4b79502ac1c54a47a70407dff09ad2c131067 Mon Sep 17 00:00:00 2001 From: Quentin Gliech Date: Fri, 15 Nov 2024 09:19:45 +0100 Subject: [PATCH 5/5] Send 'Vary: Content-Encoding' header from nginx --- config/nginx.conf | 1 + 1 file changed, 1 insertion(+) diff --git a/config/nginx.conf b/config/nginx.conf index 6950eb72..f3f8140e 100644 --- a/config/nginx.conf +++ b/config/nginx.conf @@ -4,6 +4,7 @@ server { root /app; gzip_static on; + gzip_vary on; location / { try_files $uri $uri/ /index.html;