Skip to content

Commit

Permalink
Load the Intl.Segmenter and Intl.DurationFormat polyfills only if nee…
Browse files Browse the repository at this point in the history
…ded (#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
  • Loading branch information
sandhose authored Nov 14, 2024
1 parent 6e5c468 commit 137a53d
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 31 deletions.
6 changes: 6 additions & 0 deletions src/@types/global.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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;
}
}
8 changes: 4 additions & 4 deletions src/initializer.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ 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",
),
).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");
Expand Down
22 changes: 14 additions & 8 deletions src/initializer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down Expand Up @@ -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<void> {
const polyfills: Promise<unknown>[] = [];
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();
Expand All @@ -54,7 +63,7 @@ export class Initializer {
lookup: () => getUrlParams().lang ?? undefined,
});

i18n
await i18n
.use(Backend)
.use(languageDetector)
.use(initReactI18next)
Expand All @@ -74,9 +83,6 @@ export class Initializer {
order: ["urlFragment", "navigator"],
caches: [],
},
})
.catch((e) => {
logger.error("Failed to initialize i18n", e);
});

// Custom Themeing
Expand Down
23 changes: 13 additions & 10 deletions src/main.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down Expand Up @@ -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(
<StrictMode>
<App history={history} />
</StrictMode>,
);
root.render(
<StrictMode>
<App history={history} />
</StrictMode>,
);
})
.catch((e) => {
logger.error("Failed to initialize app", e);
root.render(e.message);
});
22 changes: 13 additions & 9 deletions src/reactions/RaisedHandIndicator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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<MouseEventHandler<HTMLButtonElement>>(
(event) => {
if (!onClick) {
Expand Down Expand Up @@ -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;
Expand Down
10 changes: 10 additions & 0 deletions src/vitest.setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand All @@ -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
Expand All @@ -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
},
Expand Down

0 comments on commit 137a53d

Please sign in to comment.